ansible-core 2.17.6__py3-none-any.whl → 2.18.0__py3-none-any.whl

ansible/modules/user.py

@@ -37,19 +37,19 @@ options:
         version_added: "2.6"
     non_unique:
         description:
-            - Optionally when used with the -u option, this option allows to change the user ID to a non-unique value.
+            - Optionally when used with the C(-u) option, this option allows to change the user ID to a non-unique value.
         type: bool
         default: no
         version_added: "1.1"
     seuser:
         description:
-            - Optionally sets the seuser type (user_u) on selinux enabled systems.
+            - Optionally sets the C(seuser) type C(user_u) on SELinux enabled systems.
         type: str
         version_added: "2.1"
     group:
         description:
             - Optionally sets the user's primary group (takes a group name).
-            - On macOS, this defaults to V('staff')
+            - On macOS, this defaults to V(staff).
         type: str
     groups:
         description:
@@ -74,7 +74,8 @@ options:
               Since Ansible 2.5, the default shell for non-system users on macOS is V(/bin/bash).
             - On other operating systems, the default shell is determined by the underlying tool
               invoked by this module. See Notes for a per platform list of invoked tools.
-        type: str
+            - From Ansible 2.18, the type is changed to I(path) from I(str).
+        type: path
     home:
         description:
             - Optionally set the user's home directory.
@@ -95,7 +96,7 @@ options:
             - To create an account with a locked/disabled password on OpenBSD, set this to V('*************').
             - B(OS X/macOS:) Enter the cleartext password as the value. Be sure to take relevant security precautions.
             - On macOS, the password specified in the C(password) option will always be set, regardless of whether the user account already exists or not.
-            - When the password is passed as an argument, the C(user) module will always return changed to C(true) for macOS systems.
+            - When the password is passed as an argument, the M(ansible.builtin.user) module will always return changed to C(true) for macOS systems.
               Since macOS no longer provides access to the hashed passwords directly.
         type: str
     state:
@@ -153,7 +154,7 @@ options:
     ssh_key_bits:
         description:
             - Optionally specify number of bits in SSH key to create.
-            - The default value depends on ssh-keygen.
+            - The default value depends on C(ssh-keygen).
         type: int
         version_added: "0.9"
     ssh_key_type:
@@ -204,7 +205,7 @@ options:
             - Lock the password (C(usermod -L), C(usermod -U), C(pw lock)).
             - Implementation differs by platform. This option does not always mean the user cannot login using other methods.
             - This option does not disable the user, only lock the password.
-            - This must be set to V(False) in order to unlock a currently locked password. The absence of this parameter will not unlock a password.
+            - This must be set to V(false) in order to unlock a currently locked password. The absence of this parameter will not unlock a password.
             - Currently supported on Linux, FreeBSD, DragonFlyBSD, NetBSD, OpenBSD.
         type: bool
         version_added: "2.6"
@@ -265,9 +266,32 @@ options:
         description:
             - Sets the umask of the user.
             - Currently supported on Linux. Does nothing when used with other platforms.
-            - Requires O(local) is omitted or V(False).
+            - Requires O(local) is omitted or V(false).
         type: str
         version_added: "2.12"
+    password_expire_account_disable:
+        description:
+            - Number of days after a password expires until the account is disabled.
+            - Currently supported on AIX, Linux, NetBSD, OpenBSD.
+        type: int
+        version_added: "2.18"
+    uid_min:
+        description:
+            - Sets the UID_MIN value for user creation.
+            - Overwrites /etc/login.defs default value.
+            - Currently supported on Linux. Does nothing when used with other platforms.
+            - Requires O(local) is omitted or V(False).
+        type: int
+        version_added: "2.18"
+    uid_max:
+        description:
+            - Sets the UID_MAX value for user creation.
+            - Overwrites /etc/login.defs default value.
+            - Currently supported on Linux. Does nothing when used with other platforms.
+            - Requires O(local) is omitted or V(False).
+        type: int
+        version_added: "2.18"
+
 extends_documentation_fragment: action_common_attributes
 attributes:
     check_mode:
@@ -356,6 +380,11 @@ EXAMPLES = r'''
   ansible.builtin.user:
     name: jane157
     password_expire_warn: 30
+
+- name: Set number of days after password expires until account is disabled
+  ansible.builtin.user:
+    name: jimholden2016
+    password_expire_account_disable: 15
 '''
 
 RETURN = r'''
@@ -582,9 +611,17 @@ class User(object):
         self.password_expire_min = module.params['password_expire_min']
         self.password_expire_warn = module.params['password_expire_warn']
         self.umask = module.params['umask']
+        self.inactive = module.params['password_expire_account_disable']
+        self.uid_min = module.params['uid_min']
+        self.uid_max = module.params['uid_max']
 
-        if self.umask is not None and self.local:
-            module.fail_json(msg="'umask' can not be used with 'local'")
+        if self.local:
+            if self.umask is not None:
+                module.fail_json(msg="'umask' can not be used with 'local'")
+            if self.uid_min is not None:
+                module.fail_json(msg="'uid_min' can not be used with 'local'")
+            if self.uid_max is not None:
+                module.fail_json(msg="'uid_max' can not be used with 'local'")
 
         if module.params['groups'] is not None:
             self.groups = ','.join(module.params['groups'])
@@ -757,6 +794,10 @@ class User(object):
             else:
                 cmd.append(time.strftime(self.DATE_FORMAT, self.expires))
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(int(self.inactive))
+
         if self.password is not None:
             cmd.append('-p')
             if self.password_lock:
@@ -781,6 +822,14 @@ class User(object):
         if self.system:
             cmd.append('-r')
 
+        if self.uid_min is not None:
+            cmd.append('-K')
+            cmd.append('UID_MIN=' + str(self.uid_min))
+
+        if self.uid_max is not None:
+            cmd.append('-K')
+            cmd.append('UID_MAX=' + str(self.uid_max))
+
         cmd.append(self.name)
         (rc, out, err) = self.execute_command(cmd)
         if not self.local or rc != 0:
@@ -946,6 +995,10 @@ class User(object):
                         cmd.append('-e')
                         cmd.append(time.strftime(self.DATE_FORMAT, self.expires))
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+
         # Lock if no password or unlocked, unlock only if locked
         if self.password_lock and not info[1].startswith('!'):
             cmd.append('-L')
@@ -1459,6 +1512,14 @@ class FreeBsdUser(User):
             else:
                 cmd.append(str(calendar.timegm(self.expires)))
 
+        if self.uid_min is not None:
+            cmd.append('-K')
+            cmd.append('UID_MIN=' + str(self.uid_min))
+
+        if self.uid_max is not None:
+            cmd.append('-K')
+            cmd.append('UID_MAX=' + str(self.uid_max))
+
         # system cannot be handled currently - should we error if its requested?
         # create the user
         (rc, out, err) = self.execute_command(cmd)
@@ -1709,6 +1770,17 @@ class OpenBSDUser(User):
                 cmd.append('-K')
                 cmd.append('UMASK=' + self.umask)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+        if self.uid_min is not None:
+            cmd.append('-K')
+            cmd.append('UID_MIN=' + str(self.uid_min))
+
+        if self.uid_max is not None:
+            cmd.append('-K')
+            cmd.append('UID_MAX=' + str(self.uid_max))
+
         cmd.append(self.name)
         return self.execute_command(cmd)
 
@@ -1779,6 +1851,10 @@ class OpenBSDUser(User):
             cmd.append('-s')
             cmd.append(self.shell)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+
         if self.login_class is not None:
             # find current login class
             user_login_class = None
@@ -1875,6 +1951,10 @@ class NetBSDUser(User):
             cmd.append('-p')
             cmd.append(self.password)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+
         if self.create_home:
             cmd.append('-m')
 
@@ -1886,6 +1966,14 @@ class NetBSDUser(User):
                 cmd.append('-K')
                 cmd.append('UMASK=' + self.umask)
 
+        if self.uid_min is not None:
+            cmd.append('-K')
+            cmd.append('UID_MIN=' + str(self.uid_min))
+
+        if self.uid_max is not None:
+            cmd.append('-K')
+            cmd.append('UID_MAX=' + str(self.uid_max))
+
         cmd.append(self.name)
         return self.execute_command(cmd)
 
@@ -1961,6 +2049,10 @@ class NetBSDUser(User):
             cmd.append('-L')
             cmd.append(self.login_class)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+
         if self.update_password == 'always' and self.password is not None and info[1] != self.password:
             cmd.append('-p')
             cmd.append(self.password)
@@ -2087,6 +2179,17 @@ class SunOS(User):
             cmd.append('-R')
             cmd.append(self.role)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+        if self.uid_min is not None:
+            cmd.append('-K')
+            cmd.append('UID_MIN=' + str(self.uid_min))
+
+        if self.uid_max is not None:
+            cmd.append('-K')
+            cmd.append('UID_MAX=' + str(self.uid_max))
+
         cmd.append(self.name)
 
         (rc, out, err) = self.execute_command(cmd)
@@ -2204,6 +2307,10 @@ class SunOS(User):
             cmd.append('-R')
             cmd.append(self.role)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+
         # modify the user if cmd will do anything
         if cmd_len != len(cmd):
             cmd.append(self.name)
@@ -2301,7 +2408,7 @@ class DarwinUser(User):
 
         super(DarwinUser, self).__init__(module)
 
-        # make the user hidden if option is set or deffer to system option
+        # make the user hidden if option is set or defer to system option
         if self.hidden is None:
             if self.system:
                 self.hidden = 1
@@ -2689,6 +2796,17 @@ class AIX(User):
                 cmd.append('-K')
                 cmd.append('UMASK=' + self.umask)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+        if self.uid_min is not None:
+            cmd.append('-K')
+            cmd.append('UID_MIN=' + str(self.uid_min))
+
+        if self.uid_max is not None:
+            cmd.append('-K')
+            cmd.append('UID_MAX=' + str(self.uid_max))
+
         cmd.append(self.name)
         (rc, out, err) = self.execute_command(cmd)
 
@@ -2757,6 +2875,10 @@ class AIX(User):
             cmd.append('-s')
             cmd.append(self.shell)
 
+        if self.inactive is not None:
+            cmd.append('-f')
+            cmd.append(self.inactive)
+
         # skip if no changes to be made
         if len(cmd) == 1:
             (rc, out, err) = (None, '', '')
@@ -3021,6 +3143,14 @@ class BusyBox(User):
         if self.system:
             cmd.append('-S')
 
+        if self.uid_min is not None:
+            cmd.append('-K')
+            cmd.append('UID_MIN=' + str(self.uid_min))
+
+        if self.uid_max is not None:
+            cmd.append('-K')
+            cmd.append('UID_MAX=' + str(self.uid_max))
+
         cmd.append(self.name)
 
         rc, out, err = self.execute_command(cmd)
@@ -3130,7 +3260,7 @@ def main():
             groups=dict(type='list', elements='str'),
             comment=dict(type='str'),
             home=dict(type='path'),
-            shell=dict(type='str'),
+            shell=dict(type='path'),
             password=dict(type='str', no_log=True),
             login_class=dict(type='str'),
             password_expire_max=dict(type='int', no_log=False),
@@ -3165,6 +3295,9 @@ def main():
             authorization=dict(type='str'),
             role=dict(type='str'),
             umask=dict(type='str'),
+            password_expire_account_disable=dict(type='int', no_log=False),
+            uid_min=dict(type='int'),
+            uid_max=dict(type='int'),
         ),
         supports_check_mode=True,
     )

ansible/modules/validate_argument_spec.py

@@ -16,11 +16,11 @@ version_added: "2.11"
 options:
   argument_spec:
     description:
-        - A dictionary like AnsibleModule argument_spec. See R(argument spec definition,argument_spec)
+        - A dictionary like AnsibleModule argument_spec. See R(argument spec definition,argument_spec).
     required: true
   provided_arguments:
     description:
-        - A dictionary of the arguments that will be validated according to argument_spec
+        - A dictionary of the arguments that will be validated according to argument_spec.
 author:
     - Ansible Core Team
 extends_documentation_fragment:
@@ -51,7 +51,7 @@ attributes:
 EXAMPLES = r'''
 - name: verify vars needed for this task file are present when included
   ansible.builtin.validate_argument_spec:
-        argument_spec: '{{ required_data }}'
+    argument_spec: '{{ required_data }}'
   vars:
     required_data:
       # unlike spec file, just put the options in directly

ansible/modules/wait_for_connection.py

@@ -14,7 +14,8 @@ description:
 - Waits for a total of O(timeout) seconds.
 - Retries the transport connection after a timeout of O(connect_timeout).
 - Tests the transport connection every O(sleep) seconds.
-- This module makes use of internal ansible transport (and configuration) and the ping/win_ping module to guarantee correct end-to-end functioning.
+- This module makes use of internal ansible transport (and configuration) and the M(ansible.builtin.ping)/M(ansible.windows.win_ping)
+  modules to guarantee correct end-to-end functioning.
 - This module is also supported for Windows targets.
 version_added: '2.3'
 options: