community.general.udm_share module – Manage samba shares on a univention corporate server
Note
This module is part of the community.general collection (version 5.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.udm_share
.
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 |
Comments |
---|---|
Permissions for the share’s root directory. Default: |
|
Directory owner group of the share’s root directory. Default: |
|
Host FQDN (server which provides the share), e.g. |
|
Name |
|
Only allow access for this host, IP address or network. Default: |
|
Option name in exports file. Default: |
|
Organisational unit, inside the LDAP Base DN. |
|
Directory owner of the share’s root directory. Default: |
|
Directory on the providing server, e.g. |
|
Modify user ID for root user (root squashing). Choices:
|
|
Blocking locks. Choices:
|
|
Blocking size. |
|
Show in Windows network environment. Choices:
|
|
File mode. Default: |
|
Client-side caching policy. Default: |
|
Option name in smb.conf and its value. Default: |
|
Directory mode. Default: |
|
Directory security mode. Default: |
|
Users with write access may modify permissions. Choices:
|
|
Fake oplocks. Choices:
|
|
Force file mode. Choices:
|
|
Force directory mode. Choices:
|
|
Force directory security mode. Choices:
|
|
Force group. |
|
Force security mode. Choices:
|
|
Force user. |
|
Hide files. |
|
Hide unreadable files/directories. Choices:
|
|
Allowed host/network. Default: |
|
Denied host/network. Default: |
|
Inherit ACLs. Choices:
|
|
Create files/directories with the owner of the parent directory. Choices:
|
|
Create files/directories with permissions of the parent directory. Choices:
|
|
Invalid users or groups. |
|
Level 2 oplocks. Choices:
|
|
Locking. Choices:
|
|
MSDFS root. Choices:
|
|
Windows name. Required if state=present. |
|
NT ACL support. Choices:
|
|
Oplocks. Choices:
|
|
Postexec script. |
|
Preexec script. |
|
Allow anonymous read-only access with a guest user. Choices:
|
|
Security mode. Default: |
|
Strict locking. Default: |
|
Valid users or groups. |
|
VFS objects. |
|
Samba write access. Choices:
|
|
Restrict write access to these users/groups. |
|
Whether the share is present or not. Choices:
|
|
Subtree checking. Choices:
|
|
NFS synchronisation. Default: |
|
NFS write access. Choices:
|
Examples
- 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
Authors
Tobias Rüetschi (@keachi)
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication