udm_share – Manage samba shares on a univention corporate server
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 - |
Default: "00755" |
Permissions for the share's root directory. |
group - |
Default: "0" |
Directory owner group of the share's root directory. |
host - |
Host FQDN (server which provides the share), e.g. | |
name - / required |
Name | |
nfs_custom_settings - |
Default: [] |
Option name in exports file.
|
nfs_hosts - |
Default: [] |
Only allow access for this host, IP address or network. |
ou - / required |
Organisational unit, inside the LDAP Base DN. | |
owner - |
Default: 0 |
Directory owner of the share's root directory. |
path - |
Directory on the providing server, e.g. | |
root_squash - |
|
Modify user ID for root user (root squashing). |
samba_block_size - |
Blocking size.
| |
samba_blocking_locks - |
|
Blocking locks.
|
samba_browseable - |
|
Show in Windows network environment.
|
samba_create_mode - |
Default: "0744" |
File mode.
|
samba_csc_policy - |
Default: "manual" |
Client-side caching policy.
|
samba_custom_settings - |
Default: [] |
Option name in smb.conf and its value.
|
samba_directory_mode - |
Default: "0755" |
Directory mode.
|
samba_directory_security_mode - |
Default: "0777" |
Directory security mode.
|
samba_dos_filemode - |
|
Users with write access may modify permissions.
|
samba_fake_oplocks - |
|
Fake oplocks.
|
samba_force_create_mode - |
|
Force file mode.
|
samba_force_directory_mode - |
|
Force directory mode.
|
samba_force_directory_security_mode - |
|
Force directory security mode.
|
samba_force_group - |
Force group.
| |
samba_force_security_mode - |
|
Force security mode.
|
samba_force_user - |
Force user.
| |
samba_hide_files - |
Hide files.
| |
samba_hide_unreadable - |
|
Hide unreadable files/directories.
|
samba_hosts_allow - |
Default: [] |
Allowed host/network.
|
samba_hosts_deny - |
Default: [] |
Denied host/network.
|
samba_inherit_acls - |
|
Inherit ACLs.
|
samba_inherit_owner - |
|
Create files/directories with the owner of the parent directory.
|
samba_inherit_permissions - |
|
Create files/directories with permissions of the parent directory.
|
samba_invalid_users - |
Invalid users or groups.
| |
samba_level_2_oplocks - |
|
Level 2 oplocks.
|
samba_locking - |
|
Locking.
|
samba_msdfs_root - |
|
MSDFS root.
|
samba_name - |
Windows name. Required if
| |
samba_nt_acl_support - |
|
NT ACL support.
|
samba_oplocks - |
|
Oplocks.
|
samba_postexec - |
Postexec script.
| |
samba_preexec - |
Preexec script.
| |
samba_public - |
|
Allow anonymous read-only access with a guest user.
|
samba_security_mode - |
Default: "0777" |
Security mode.
|
samba_strict_locking - |
Default: "Auto" |
Strict locking.
|
samba_valid_users - |
Valid users or groups.
| |
samba_vfs_objects - |
VFS objects.
| |
samba_write_list - |
Restrict write access to these users/groups.
| |
samba_writeable - |
|
Samba write access.
|
state - |
|
Whether the share is present or not. |
subtree_checking - |
|
Subtree checking. |
sync - |
Default: "sync" |
NFS synchronisation. |
writeable - |
|
NFS write access. |
Examples
# Create a share named home on the server ucs.example.com with the path /home.
- udm_share:
name: home
path: /home
host: ucs.example.com
sambaName: Home
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Tobias Rueetschi (@2-B)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/udm_share_module.html