Documentation

udm_share - Manage samba shares on a univention corporate server

New in version 2.2.

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.

Options

parameter required default choices comments
directorymode
 no 00755
Permissions for the share's root directory.
group
 no 0
Directory owner group of the share's root directory.
host
 no None
Host FQDN (server which provides the share), e.g. {{ ansible_fqdn }}. Required if state=present.
name
 yes
Name
nfs_custom_settings
 no
Option name in exports file.

aliases: nfsCustomSettings
nfs_hosts
 no
Only allow access for this host, IP address or network.
ou
 yes
Organisational unit, inside the LDAP Base DN.
owner
 no
Directory owner of the share's root directory.
path
 no None
Directory on the providing server, e.g. /home. Required if state=present.
root_squash
 no 1
  • 0
  • 1
Modify user ID for root user (root squashing).
samba_block_size
 no None
Blocking size.

aliases: sambaBlockSize
samba_blocking_locks
 no 1
  • 0
  • 1
Blocking locks.

aliases: sambaBlockingLocks
samba_browseable
 no 1
  • 0
  • 1
Show in Windows network environment.

aliases: sambaBrowseable
samba_create_mode
 no 0744
File mode.

aliases: sambaCreateMode
samba_csc_policy
 no manual
Client-side caching policy.

aliases: sambaCscPolicy
samba_custom_settings
 no
Option name in smb.conf and its value.

aliases: sambaCustomSettings
samba_directory_mode
 no 0755
Directory mode.

aliases: sambaDirectoryMode
samba_directory_security_mode
 no 0777
Directory security mode.

aliases: sambaDirectorySecurityMode
samba_dos_filemode
 no 0
  • 0
  • 1
Users with write access may modify permissions.

aliases: sambaDosFilemode
samba_fake_oplocks
 no 0
  • 0
  • 1
Fake oplocks.

aliases: sambaFakeOplocks
samba_force_create_mode
 no 0
  • 0
  • 1
Force file mode.

aliases: sambaForceCreateMode
samba_force_directory_mode
 no 0
  • 0
  • 1
Force directory mode.

aliases: sambaForceDirectoryMode
samba_force_directory_security_mode
 no 0
  • 0
  • 1
Force directory security mode.

aliases: sambaForceDirectorySecurityMode
samba_force_group
 no None
Force group.

aliases: sambaForceGroup
samba_force_security_mode
 no 0
  • 0
  • 1
Force security mode.

aliases: sambaForceSecurityMode
samba_force_user
 no None
Force user.

aliases: sambaForceUser
samba_hide_files
 no None
Hide files.

aliases: sambaHideFiles
samba_hide_unreadable
 no 0
  • 0
  • 1
Hide unreadable files/directories.

aliases: sambaHideUnreadable
samba_hosts_allow
 no
Allowed host/network.

aliases: sambaHostsAllow
samba_hosts_deny
 no
Denied host/network.

aliases: sambaHostsDeny
samba_inherit_acls
 no 1
  • 0
  • 1
Inherit ACLs.

aliases: sambaInheritAcls
samba_inherit_owner
 no 0
  • 0
  • 1
Create files/directories with the owner of the parent directory.

aliases: sambaInheritOwner
samba_inherit_permissions
 no 0
  • 0
  • 1
Create files/directories with permissions of the parent directory.

aliases: sambaInheritPermissions
samba_invalid_users
 no None
Invalid users or groups.

aliases: sambaInvalidUsers
samba_level_2_oplocks
 no 1
  • 0
  • 1
Level 2 oplocks.

aliases: sambaLevel2Oplocks
samba_locking
 no 1
  • 0
  • 1
Locking.

aliases: sambaLocking
samba_msdfs_root
 no 0
  • 0
  • 1
MSDFS root.

aliases: sambaMSDFSRoot
samba_name
 no None
Windows name. Required if state=present.

aliases: sambaName
samba_nt_acl_support
 no 1
  • 0
  • 1
NT ACL support.

aliases: sambaNtAclSupport
samba_oplocks
 no 1
  • 0
  • 1
Oplocks.

aliases: sambaOplocks
samba_postexec
 no None
Postexec script.

aliases: sambaPostexec
samba_preexec
 no None
Preexec script.

aliases: sambaPreexec
samba_public
 no 0
  • 0
  • 1
Allow anonymous read-only access with a guest user.

aliases: sambaPublic
samba_security_mode
 no 0777
Security mode.

aliases: sambaSecurityMode
samba_strict_locking
 no Auto
Strict locking.

aliases: sambaStrictLocking
samba_valid_users
 no None
Valid users or groups.

aliases: sambaValidUsers
samba_vfs_objects
 no None
VFS objects.

aliases: sambaVFSObjects
samba_write_list
 no None
Restrict write access to these users/groups.

aliases: sambaWriteList
samba_writeable
 no 1
  • 0
  • 1
Samba write access.

aliases: sambaWriteable
state
 no present
  • present
  • absent
Whether the share is present or not.
subtree_checking
 no 1
  • 0
  • 1
Subtree checking.
sync
 no sync
NFS synchronisation.
writeable
 no 1
  • 0
  • 1
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 flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.