ansible.builtin.udm_share (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

• Python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Inputs

    
ou:
    description:
    - Organisational unit, inside the LDAP Base DN.
    required: true

host:
    description:
    - Host FQDN (server which provides the share), e.g. C({{ ansible_fqdn }}). Required
      if C(state=present).
    required: false

name:
    description:
    - Name
    required: true

path:
    description:
    - Directory on the providing server, e.g. C(/home). Required if C(state=present).
    required: false

sync:
    default: sync
    description:
    - NFS synchronisation.

group:
    default: '0'
    description:
    - Directory owner group of the share's root directory.

owner:
    default: 0
    description:
    - Directory owner of the share's root directory.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the share is present or not.

nfs_hosts:
    default: []
    description:
    - Only allow access for this host, IP address or network.

writeable:
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - NFS write access.

samba_name:
    aliases:
    - sambaName
    description:
    - Windows name. Required if C(state=present).
    required: false

root_squash:
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Modify user ID for root user (root squashing).

samba_public:
    aliases:
    - sambaPublic
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Allow anonymous read-only access with a guest user.

directorymode:
    default: '00755'
    description:
    - Permissions for the share's root directory.

samba_locking:
    aliases:
    - sambaLocking
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Locking.

samba_oplocks:
    aliases:
    - sambaOplocks
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Oplocks.

samba_preexec:
    aliases:
    - sambaPreexec
    description:
    - Preexec script.

samba_postexec:
    aliases:
    - sambaPostexec
    description:
    - Postexec script.

samba_writeable:
    aliases:
    - sambaWriteable
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Samba write access.

samba_block_size:
    aliases:
    - sambaBlockSize
    description:
    - Blocking size.

samba_browseable:
    aliases:
    - sambaBrowseable
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Show in Windows network environment.

samba_csc_policy:
    aliases:
    - sambaCscPolicy
    default: manual
    description:
    - Client-side caching policy.

samba_force_user:
    aliases:
    - sambaForceUser
    description:
    - Force user.

samba_hide_files:
    aliases:
    - sambaHideFiles
    description:
    - Hide files.

samba_hosts_deny:
    aliases:
    - sambaHostsDeny
    default: []
    description:
    - Denied host/network.

samba_msdfs_root:
    aliases:
    - sambaMSDFSRoot
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - MSDFS root.

samba_write_list:
    aliases:
    - sambaWriteList
    description:
    - Restrict write access to these users/groups.

subtree_checking:
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Subtree checking.

samba_create_mode:
    aliases:
    - sambaCreateMode
    default: '0744'
    description:
    - File mode.

samba_force_group:
    aliases:
    - sambaForceGroup
    description:
    - Force group.

samba_hosts_allow:
    aliases:
    - sambaHostsAllow
    default: []
    description:
    - Allowed host/network.

samba_valid_users:
    aliases:
    - sambaValidUsers
    description:
    - Valid users or groups.

samba_vfs_objects:
    aliases:
    - sambaVFSObjects
    description:
    - VFS objects.

samba_dos_filemode:
    aliases:
    - sambaDosFilemode
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Users with write access may modify permissions.

samba_fake_oplocks:
    aliases:
    - sambaFakeOplocks
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Fake oplocks.

samba_inherit_acls:
    aliases:
    - sambaInheritAcls
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Inherit ACLs.

nfs_custom_settings:
    aliases:
    - nfsCustomSettings
    default: []
    description:
    - Option name in exports file.

samba_inherit_owner:
    aliases:
    - sambaInheritOwner
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Create files/directories with the owner of the parent directory.

samba_invalid_users:
    aliases:
    - sambaInvalidUsers
    description:
    - Invalid users or groups.

samba_security_mode:
    aliases:
    - sambaSecurityMode
    default: '0777'
    description:
    - Security mode.

samba_blocking_locks:
    aliases:
    - sambaBlockingLocks
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Blocking locks.

samba_directory_mode:
    aliases:
    - sambaDirectoryMode
    default: '0755'
    description:
    - Directory mode.

samba_nt_acl_support:
    aliases:
    - sambaNtAclSupport
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - NT ACL support.

samba_strict_locking:
    aliases:
    - sambaStrictLocking
    default: Auto
    description:
    - Strict locking.

samba_custom_settings:
    aliases:
    - sambaCustomSettings
    default: []
    description:
    - Option name in smb.conf and its value.

samba_hide_unreadable:
    aliases:
    - sambaHideUnreadable
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Hide unreadable files/directories.

samba_level_2_oplocks:
    aliases:
    - sambaLevel2Oplocks
    choices:
    - '0'
    - '1'
    default: '1'
    description:
    - Level 2 oplocks.

samba_force_create_mode:
    aliases:
    - sambaForceCreateMode
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Force file mode.

samba_force_security_mode:
    aliases:
    - sambaForceSecurityMode
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Force security mode.

samba_inherit_permissions:
    aliases:
    - sambaInheritPermissions
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Create files/directories with permissions of the parent directory.

samba_force_directory_mode:
    aliases:
    - sambaForceDirectoryMode
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Force directory mode.

samba_directory_security_mode:
    aliases:
    - sambaDirectorySecurityMode
    default: '0777'
    description:
    - Directory security mode.

samba_force_directory_security_mode:
    aliases:
    - sambaForceDirectorySecurityMode
    choices:
    - '0'
    - '1'
    default: '0'
    description:
    - Force directory security mode.