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

lib/ansible/modules/cloud/univention/udm_share.py

@@ -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.

lib/ansible/modules/cloud/univention/udm_user.py

@@ -28,7 +28,6 @@ requirements:
     - Python >= 2.6
 options:
     state:
-        required: false
         default: "present"
         choices: [ present, absent ]
         description:
@@ -39,263 +38,191 @@ options:
             - User name
         aliases: ['name']
     firstname:
-        required: false
         description:
             - First name. Required if C(state=present).
     lastname:
-        required: false
         description:
             - Last name. Required if C(state=present).
     password:
-        required: false
-        default: None
         description:
             - Password. Required if C(state=present).
     birthday:
-        required: false
-        default: None
         description:
             - Birthday
     city:
-        required: false
-        default: None
         description:
             - City of users business address.
     country:
-        required: false
-        default: None
         description:
             - Country of users business address.
     department_number:
-        required: false
-        default: None
         description:
             - Department number of users business address.
         aliases: [ departmentNumber ]
     description:
-        required: false
-        default: None
         description:
             - Description (not gecos)
     display_name:
-        required: false
-        default: None
         description:
             - Display name (not gecos)
         aliases: [ displayName ]
     email:
-        required: false
-        default: ['']
+        default: []
         description:
             - A list of e-mail addresses.
     employee_number:
-        required: false
-        default: None
         description:
             - Employee number
         aliases: [ employeeNumber ]
     employee_type:
-        required: false
-        default: None
         description:
             - Employee type
         aliases: [ employeeType ]
     gecos:
-        required: false
-        default: None
         description:
             - GECOS
     groups:
-        required: false
         default: []
         description:
             - "POSIX groups, the LDAP DNs of the groups will be found with the
                LDAP filter for each group as $GROUP:
                C((&(objectClass=posixGroup)(cn=$GROUP)))."
     home_share:
-        required: false
-        default: None
         description:
             - "Home NFS share. Must be a LDAP DN, e.g.
                C(cn=home,cn=shares,ou=school,dc=example,dc=com)."
         aliases: [ homeShare ]
     home_share_path:
-        required: false
-        default: None
         description:
             - Path to home NFS share, inside the homeShare.
         aliases: [ homeSharePath ]
     home_telephone_number:
-        required: false
         default: []
         description:
             - List of private telephone numbers.
         aliases: [ homeTelephoneNumber ]
     homedrive:
-        required: false
-        default: None
         description:
             - Windows home drive, e.g. C("H:").
     mail_alternative_address:
-        required: false
         default: []
         description:
             - List of alternative e-mail addresses.
         aliases: [ mailAlternativeAddress ]
     mail_home_server:
-        required: false
-        default: None
         description:
             - FQDN of mail server
         aliases: [ mailHomeServer ]
     mail_primary_address:
-        required: false
-        default: None
         description:
             - Primary e-mail address
         aliases: [ mailPrimaryAddress ]
     mobile_telephone_number:
-        required: false
         default: []
         description:
             - Mobile phone number
         aliases: [ mobileTelephoneNumber ]
     organisation:
-        required: false
-        default: None
         description:
             - Organisation
     override_pw_history:
-        required: false
-        default: False
+        type: bool
+        default: 'no'
         description:
             - Override password history
         aliases: [ overridePWHistory ]
     override_pw_length:
-        required: false
-        default: False
+        type: bool
+        default: 'no'
         description:
             - Override password check
         aliases: [ overridePWLength ]
     pager_telephonenumber:
-        required: false
         default: []
         description:
             - List of pager telephone numbers.
         aliases: [ pagerTelephonenumber ]
     phone:
-        required: false
-        default: []
         description:
             - List of telephone numbers.
     postcode:
-        required: false
-        default: None
         description:
             - Postal code of users business address.
     primary_group:
-        required: false
         default: cn=Domain Users,cn=groups,$LDAP_BASE_DN
         description:
             - Primary group. This must be the group LDAP DN.
         aliases: [ primaryGroup ]
     profilepath:
-        required: false
-        default: None
         description:
             - Windows profile directory
     pwd_change_next_login:
-        required: false
-        default: None
         choices: [ '0', '1' ]
         description:
             - Change password on next login.
         aliases: [ pwdChangeNextLogin ]
     room_number:
-        required: false
-        default: None
         description:
             - Room number of users business address.
         aliases: [ roomNumber ]
     samba_privileges:
-        required: false
-        default: []
         description:
             - "Samba privilege, like allow printer administration, do domain
                join."
         aliases: [ sambaPrivileges ]
     samba_user_workstations:
-        required: false
-        default: []
         description:
             - Allow the authentication only on this Microsoft Windows host.
         aliases: [ sambaUserWorkstations ]
     sambahome:
-        required: false
-        default: None
         description:
             - Windows home path, e.g. C('\\\\$FQDN\\$USERNAME').
     scriptpath:
-        required: false
-        default: None
         description:
             - Windows logon script.
     secretary:
-        required: false
         default: []
         description:
             - A list of superiors as LDAP DNs.
     serviceprovider:
-        required: false
-        default: ['']
+        default: []
         description:
             - Enable user for the following service providers.
     shell:
-        required: false
         default: '/bin/bash'
         description:
             - Login shell
     street:
-        required: false
-        default: None
         description:
             - Street of users business address.
     title:
-        required: false
-        default: None
         description:
             - Title, e.g. C(Prof.).
     unixhome:
-        required: false
         default: '/home/$USERNAME'
         description:
             - Unix home directory
     userexpiry:
-        required: false
         default: Today + 1 year
         description:
             - Account expiry date, e.g. C(1999-12-31).
     position:
-        required: false
         default: ''
         description:
             - "Define the whole position of users object inside the LDAP tree,
                e.g. C(cn=employee,cn=users,ou=school,dc=example,dc=com)."
     update_password:
-        required: false
         default: always
         description:
             - "C(always) will update passwords if they differ.
                C(on_create) will only set the password for newly created users."
         version_added: "2.3"
     ou:
-        required: false
         default: ''
         description:
             - "Organizational Unit inside the LDAP Base DN, e.g. C(school) for
                LDAP OU C(ou=school,dc=example,dc=com)."
     subpath:
-        required: false
         default: 'cn=users'
         description:
             - "LDAP subpath inside the organizational unit, e.g.