mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-25 06:10:22 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -28,7 +28,6 @@ requirements:
|
|||
- Python >= 2.6
|
||||
options:
|
||||
state:
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ present, absent ]
|
||||
description:
|
||||
|
@ -39,18 +38,15 @@ options:
|
|||
- Name
|
||||
host:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Host FQDN (server which provides the share), e.g. C({{
|
||||
ansible_fqdn }}). Required if C(state=present).
|
||||
path:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Directory on the providing server, e.g. C(/home). Required if C(state=present).
|
||||
samba_name:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Windows name. Required if C(state=present).
|
||||
aliases: [ sambaName ]
|
||||
|
@ -59,297 +55,240 @@ options:
|
|||
description:
|
||||
- Organisational unit, inside the LDAP Base DN.
|
||||
owner:
|
||||
required: false
|
||||
default: 0
|
||||
description:
|
||||
- Directory owner of the share's root directory.
|
||||
group:
|
||||
required: false
|
||||
default: '0'
|
||||
description:
|
||||
- Directory owner group of the share's root directory.
|
||||
directorymode:
|
||||
required: false
|
||||
default: '00755'
|
||||
description:
|
||||
- Permissions for the share's root directory.
|
||||
root_squash:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Modify user ID for root user (root squashing).
|
||||
subtree_checking:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Subtree checking.
|
||||
sync:
|
||||
required: false
|
||||
default: 'sync'
|
||||
description:
|
||||
- NFS synchronisation.
|
||||
writeable:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- NFS write access.
|
||||
samba_block_size:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Blocking size.
|
||||
aliases: [ sambaBlockSize ]
|
||||
samba_blocking_locks:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Blocking locks.
|
||||
aliases: [ sambaBlockingLocks ]
|
||||
samba_browseable:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Show in Windows network environment.
|
||||
aliases: [ sambaBrowseable ]
|
||||
samba_create_mode:
|
||||
required: false
|
||||
default: '0744'
|
||||
description:
|
||||
- File mode.
|
||||
aliases: [ sambaCreateMode ]
|
||||
samba_csc_policy:
|
||||
required: false
|
||||
default: 'manual'
|
||||
description:
|
||||
- Client-side caching policy.
|
||||
aliases: [ sambaCscPolicy ]
|
||||
samba_custom_settings:
|
||||
required: false
|
||||
default: []
|
||||
description:
|
||||
- Option name in smb.conf and its value.
|
||||
aliases: [ sambaCustomSettings ]
|
||||
samba_directory_mode:
|
||||
required: false
|
||||
default: '0755'
|
||||
description:
|
||||
- Directory mode.
|
||||
aliases: [ sambaDirectoryMode ]
|
||||
samba_directory_security_mode:
|
||||
required: false
|
||||
default: '0777'
|
||||
description:
|
||||
- Directory security mode.
|
||||
aliases: [ sambaDirectorySecurityMode ]
|
||||
samba_dos_filemode:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Users with write access may modify permissions.
|
||||
aliases: [ sambaDosFilemode ]
|
||||
samba_fake_oplocks:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Fake oplocks.
|
||||
aliases: [ sambaFakeOplocks ]
|
||||
samba_force_create_mode:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Force file mode.
|
||||
aliases: [ sambaForceCreateMode ]
|
||||
samba_force_directory_mode:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Force directory mode.
|
||||
aliases: [ sambaForceDirectoryMode ]
|
||||
samba_force_directory_security_mode:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Force directory security mode.
|
||||
aliases: [ sambaForceDirectorySecurityMode ]
|
||||
samba_force_group:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Force group.
|
||||
aliases: [ sambaForceGroup ]
|
||||
samba_force_security_mode:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Force security mode.
|
||||
aliases: [ sambaForceSecurityMode ]
|
||||
samba_force_user:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Force user.
|
||||
aliases: [ sambaForceUser ]
|
||||
samba_hide_files:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Hide files.
|
||||
aliases: [ sambaHideFiles ]
|
||||
samba_hide_unreadable:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Hide unreadable files/directories.
|
||||
aliases: [ sambaHideUnreadable ]
|
||||
samba_hosts_allow:
|
||||
required: false
|
||||
default: []
|
||||
description:
|
||||
- Allowed host/network.
|
||||
aliases: [ sambaHostsAllow ]
|
||||
samba_hosts_deny:
|
||||
required: false
|
||||
default: []
|
||||
description:
|
||||
- Denied host/network.
|
||||
aliases: [ sambaHostsDeny ]
|
||||
samba_inherit_acls:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Inherit ACLs.
|
||||
aliases: [ sambaInheritAcls ]
|
||||
samba_inherit_owner:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Create files/directories with the owner of the parent directory.
|
||||
aliases: [ sambaInheritOwner ]
|
||||
samba_inherit_permissions:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Create files/directories with permissions of the parent directory.
|
||||
aliases: [ sambaInheritPermissions ]
|
||||
samba_invalid_users:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Invalid users or groups.
|
||||
aliases: [ sambaInvalidUsers ]
|
||||
samba_level_2_oplocks:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Level 2 oplocks.
|
||||
aliases: [ sambaLevel2Oplocks ]
|
||||
samba_locking:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Locking.
|
||||
aliases: [ sambaLocking ]
|
||||
samba_msdfs_root:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- MSDFS root.
|
||||
aliases: [ sambaMSDFSRoot ]
|
||||
samba_nt_acl_support:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- NT ACL support.
|
||||
aliases: [ sambaNtAclSupport ]
|
||||
samba_oplocks:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Oplocks.
|
||||
aliases: [ sambaOplocks ]
|
||||
samba_postexec:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Postexec script.
|
||||
aliases: [ sambaPostexec ]
|
||||
samba_preexec:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Preexec script.
|
||||
aliases: [ sambaPreexec ]
|
||||
samba_public:
|
||||
required: false
|
||||
default: '0'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Allow anonymous read-only access with a guest user.
|
||||
aliases: [ sambaPublic ]
|
||||
samba_security_mode:
|
||||
required: false
|
||||
default: '0777'
|
||||
description:
|
||||
- Security mode.
|
||||
aliases: [ sambaSecurityMode ]
|
||||
samba_strict_locking:
|
||||
required: false
|
||||
default: 'Auto'
|
||||
description:
|
||||
- Strict locking.
|
||||
aliases: [ sambaStrictLocking ]
|
||||
samba_vfs_objects:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- VFS objects.
|
||||
aliases: [ sambaVFSObjects ]
|
||||
samba_valid_users:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Valid users or groups.
|
||||
aliases: [ sambaValidUsers ]
|
||||
samba_write_list:
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
- Restrict write access to these users/groups.
|
||||
aliases: [ sambaWriteList ]
|
||||
samba_writeable:
|
||||
required: false
|
||||
default: '1'
|
||||
choices: [ '0', '1' ]
|
||||
description:
|
||||
- Samba write access.
|
||||
aliases: [ sambaWriteable ]
|
||||
nfs_hosts:
|
||||
required: false
|
||||
default: []
|
||||
description:
|
||||
- Only allow access for this host, IP address or network.
|
||||
nfs_custom_settings:
|
||||
required: false
|
||||
default: []
|
||||
description:
|
||||
- Option name in exports file.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue