community.general.udm_share – Manage samba shares on a univention corporate server
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.udm_share
.
Synopsis
- This module allows to manage samba shares on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.
Requirements
The below requirements are needed on the host that executes this module.
- Python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
directorymode string |
Default: "00755" |
Permissions for the share's root directory. |
group string |
Default: "0" |
Directory owner group of the share's root directory. |
host string |
Host FQDN (server which provides the share), e.g. | |
name string / required |
Name | |
nfs_hosts list / elements=string |
Default: [] |
Only allow access for this host, IP address or network. |
nfsCustomSettings list / elements=string |
Default: [] |
Option name in exports file.
|
ou string / required |
Organisational unit, inside the LDAP Base DN. | |
owner string |
Default: "0" |
Directory owner of the share's root directory. |
path path |
Directory on the providing server, e.g. | |
root_squash boolean |
|
Modify user ID for root user (root squashing). |
sambaBlockingLocks boolean |
|
Blocking locks.
|
sambaBlockSize string |
Blocking size.
| |
sambaBrowseable boolean |
|
Show in Windows network environment.
|
sambaCreateMode string |
Default: "0744" |
File mode.
|
sambaCscPolicy string |
Default: "manual" |
Client-side caching policy.
|
sambaCustomSettings list / elements=string |
Default: [] |
Option name in smb.conf and its value.
|
sambaDirectoryMode string |
Default: "0755" |
Directory mode.
|
sambaDirectorySecurityMode string |
Default: "0777" |
Directory security mode.
|
sambaDosFilemode boolean |
|
Users with write access may modify permissions.
|
sambaFakeOplocks boolean |
|
Fake oplocks.
|
sambaForceCreateMode boolean |
|
Force file mode.
|
sambaForceDirectoryMode boolean |
|
Force directory mode.
|
sambaForceDirectorySecurityMode boolean |
|
Force directory security mode.
|
sambaForceGroup string |
Force group.
| |
sambaForceSecurityMode boolean |
|
Force security mode.
|
sambaForceUser string |
Force user.
| |
sambaHideFiles string |
Hide files.
| |
sambaHideUnreadable boolean |
|
Hide unreadable files/directories.
|
sambaHostsAllow list / elements=string |
Default: [] |
Allowed host/network.
|
sambaHostsDeny list / elements=string |
Default: [] |
Denied host/network.
|
sambaInheritAcls boolean |
|
Inherit ACLs.
|
sambaInheritOwner boolean |
|
Create files/directories with the owner of the parent directory.
|
sambaInheritPermissions boolean |
|
Create files/directories with permissions of the parent directory.
|
sambaInvalidUsers string |
Invalid users or groups.
| |
sambaLevel2Oplocks boolean |
|
Level 2 oplocks.
|
sambaLocking boolean |
|
Locking.
|
sambaMSDFSRoot boolean |
|
MSDFS root.
|
sambaName string |
Windows name. Required if
| |
sambaNtAclSupport boolean |
|
NT ACL support.
|
sambaOplocks boolean |
|
Oplocks.
|
sambaPostexec string |
Postexec script.
| |
sambaPreexec string |
Preexec script.
| |
sambaPublic boolean |
|
Allow anonymous read-only access with a guest user.
|
sambaSecurityMode string |
Default: "0777" |
Security mode.
|
sambaStrictLocking string |
Default: "Auto" |
Strict locking.
|
sambaValidUsers string |
Valid users or groups.
| |
sambaVFSObjects string |
VFS objects.
| |
sambaWriteable boolean |
|
Samba write access.
|
sambaWriteList string |
Restrict write access to these users/groups.
| |
state string |
|
Whether the share is present or not. |
subtree_checking boolean |
|
Subtree checking. |
sync string |
Default: "sync" |
NFS synchronisation. |
writeable boolean |
|
NFS write access. |
Examples
- name: Create a share named home on the server ucs.example.com with the path /home
community.general.udm_share:
name: home
path: /home
host: ucs.example.com
sambaName: Home
Authors
- Tobias Rüetschi (@keachi)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/udm_share_module.html