New in version 2.2.
The below requirements are needed on the host that executes this module.
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.
{{ ansible_fqdn }}. Required if state=present. |
|
name
required |
|
Name
|
|
nfs_custom_settings
|
Default:
[]
|
Option name in exports file.
aliases: nfsCustomSettings |
|
nfs_hosts
|
Default:
[]
|
Only allow access for this host, IP address or network.
|
|
ou
required |
|
Organisational unit, inside the LDAP Base DN.
|
|
owner
|
Default:
no
|
Directory owner of the share's root directory.
|
|
path
|
|
Directory on the providing server, e.g.
/home. Required if state=present. |
|
root_squash
|
|
Modify user ID for root user (root squashing).
|
|
samba_block_size
|
|
Blocking size.
aliases: sambaBlockSize |
|
samba_blocking_locks
|
|
Blocking locks.
aliases: sambaBlockingLocks |
|
samba_browseable
|
|
Show in Windows network environment.
aliases: sambaBrowseable |
|
samba_create_mode
|
Default:
0744
|
File mode.
aliases: sambaCreateMode |
|
samba_csc_policy
|
Default:
manual
|
Client-side caching policy.
aliases: sambaCscPolicy |
|
samba_custom_settings
|
Default:
[]
|
Option name in smb.conf and its value.
aliases: sambaCustomSettings |
|
samba_directory_mode
|
Default:
0755
|
Directory mode.
aliases: sambaDirectoryMode |
|
samba_directory_security_mode
|
Default:
0777
|
Directory security mode.
aliases: sambaDirectorySecurityMode |
|
samba_dos_filemode
|
|
Users with write access may modify permissions.
aliases: sambaDosFilemode |
|
samba_fake_oplocks
|
|
Fake oplocks.
aliases: sambaFakeOplocks |
|
samba_force_create_mode
|
|
Force file mode.
aliases: sambaForceCreateMode |
|
samba_force_directory_mode
|
|
Force directory mode.
aliases: sambaForceDirectoryMode |
|
samba_force_directory_security_mode
|
|
Force directory security mode.
aliases: sambaForceDirectorySecurityMode |
|
samba_force_group
|
|
Force group.
aliases: sambaForceGroup |
|
samba_force_security_mode
|
|
Force security mode.
aliases: sambaForceSecurityMode |
|
samba_force_user
|
|
Force user.
aliases: sambaForceUser |
|
samba_hide_files
|
|
Hide files.
aliases: sambaHideFiles |
|
samba_hide_unreadable
|
|
Hide unreadable files/directories.
aliases: sambaHideUnreadable |
|
samba_hosts_allow
|
Default:
[]
|
Allowed host/network.
aliases: sambaHostsAllow |
|
samba_hosts_deny
|
Default:
[]
|
Denied host/network.
aliases: sambaHostsDeny |
|
samba_inherit_acls
|
|
Inherit ACLs.
aliases: sambaInheritAcls |
|
samba_inherit_owner
|
|
Create files/directories with the owner of the parent directory.
aliases: sambaInheritOwner |
|
samba_inherit_permissions
|
|
Create files/directories with permissions of the parent directory.
aliases: sambaInheritPermissions |
|
samba_invalid_users
|
|
Invalid users or groups.
aliases: sambaInvalidUsers |
|
samba_level_2_oplocks
|
|
Level 2 oplocks.
aliases: sambaLevel2Oplocks |
|
samba_locking
|
|
Locking.
aliases: sambaLocking |
|
samba_msdfs_root
|
|
MSDFS root.
aliases: sambaMSDFSRoot |
|
samba_name
|
|
Windows name. Required if
state=present.aliases: sambaName |
|
samba_nt_acl_support
|
|
NT ACL support.
aliases: sambaNtAclSupport |
|
samba_oplocks
|
|
Oplocks.
aliases: sambaOplocks |
|
samba_postexec
|
|
Postexec script.
aliases: sambaPostexec |
|
samba_preexec
|
|
Preexec script.
aliases: sambaPreexec |
|
samba_public
|
|
Allow anonymous read-only access with a guest user.
aliases: sambaPublic |
|
samba_security_mode
|
Default:
0777
|
Security mode.
aliases: sambaSecurityMode |
|
samba_strict_locking
|
Default:
Auto
|
Strict locking.
aliases: sambaStrictLocking |
|
samba_valid_users
|
|
Valid users or groups.
aliases: sambaValidUsers |
|
samba_vfs_objects
|
|
VFS objects.
aliases: sambaVFSObjects |
|
samba_write_list
|
|
Restrict write access to these users/groups.
aliases: sambaWriteList |
|
samba_writeable
|
|
Samba write access.
aliases: sambaWriteable |
|
state
|
|
Whether the share is present or not.
|
|
subtree_checking
|
|
Subtree checking.
|
|
sync
|
Default:
sync
|
NFS synchronisation.
|
|
writeable
|
|
NFS write access.
|
# 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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.