community.general.udm_share (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

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.

Usage examples

Scanned by Steampunk Spotter

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

- 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

Inputs

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

host:
    description:
    - Host FQDN (server which provides the share), for example V({{ ansible_fqdn }}).
      Required if O(state=present).
    required: false
    type: str

name:
    description:
    - Name
    required: true
    type: str

path:
    description:
    - Directory on the providing server, for example V(/home). Required if O(state=present).
    required: false
    type: path

sync:
    default: sync
    description:
    - NFS synchronisation.
    type: str

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

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

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

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

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

writeable:
    default: true
    description:
    - NFS write access.
    type: bool

root_squash:
    default: true
    description:
    - Modify user ID for root user (root squashing).
    type: bool

sambaPublic:
    aliases:
    - samba_public
    default: false
    description:
    - Allow anonymous read-only access with a guest user.
    type: bool

sambaLocking:
    aliases:
    - samba_locking
    default: true
    description:
    - Locking.
    type: bool

sambaOplocks:
    aliases:
    - samba_oplocks
    default: true
    description:
    - Oplocks.
    type: bool

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

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

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

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

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

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

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

sambaHostsDeny:
    aliases:
    - samba_hosts_deny
    default: []
    description:
    - Denied host/network.
    elements: str
    type: list

sambaMSDFSRoot:
    aliases:
    - samba_msdfs_root
    default: false
    description:
    - MSDFS root.
    type: bool

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

sambaWriteable:
    aliases:
    - samba_writeable
    default: true
    description:
    - Samba write access.
    type: bool

sambaBrowseable:
    aliases:
    - samba_browsable
    default: true
    description:
    - Show in Windows network environment.
    type: bool

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

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

sambaHostsAllow:
    aliases:
    - samba_hosts_allow
    default: []
    description:
    - Allowed host/network.
    elements: str
    type: list

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

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

sambaDosFilemode:
    aliases:
    - samba_dos_filemode
    default: false
    description:
    - Users with write access may modify permissions.
    type: bool

sambaFakeOplocks:
    aliases:
    - samba_fake_oplocks
    default: false
    description:
    - Fake oplocks.
    type: bool

sambaInheritAcls:
    aliases:
    - samba_inherit_acls
    default: true
    description:
    - Inherit ACLs.
    type: bool

subtree_checking:
    default: true
    description:
    - Subtree checking.
    type: bool

nfsCustomSettings:
    aliases:
    - nfs_custom_settings
    default: []
    description:
    - Option name in exports file.
    elements: str
    type: list

sambaInheritOwner:
    aliases:
    - samba_inherit_owner
    default: false
    description:
    - Create files/directories with the owner of the parent directory.
    type: bool

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

sambaNtAclSupport:
    aliases:
    - samba_nt_acl_support
    default: true
    description:
    - NT ACL support.
    type: bool

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

sambaBlockingLocks:
    aliases:
    - samba_blocking_locks
    default: true
    description:
    - Blocking locks.
    type: bool

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

sambaLevel2Oplocks:
    aliases:
    - samba_level_2_oplocks
    default: true
    description:
    - Level 2 oplocks.
    type: bool

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

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

sambaHideUnreadable:
    aliases:
    - samba_hide_unreadable
    default: false
    description:
    - Hide unreadable files/directories.
    type: bool

sambaForceCreateMode:
    aliases:
    - samba_force_create_mode
    default: false
    description:
    - Force file mode.
    type: bool

sambaForceSecurityMode:
    aliases:
    - samba_force_security_mode
    default: false
    description:
    - Force security mode.
    type: bool

sambaForceDirectoryMode:
    aliases:
    - samba_force_directory_mode
    default: false
    description:
    - Force directory mode.
    type: bool

sambaInheritPermissions:
    aliases:
    - samba_inherit_permissions
    default: false
    description:
    - Create files/directories with permissions of the parent directory.
    type: bool

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

sambaForceDirectorySecurityMode:
    aliases:
    - samba_force_directory_security_mode
    default: false
    description:
    - Force directory security mode.
    type: bool