Note
This plugin is part of the community.general collection (version 3.8.1).
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.
To use it in a playbook, specify: community.general.ipa_pwpolicy.
New in version 2.0.0: of community.general
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| failinterval string | Period (in seconds) after which the number of failed login attempts is reset. | |
| group string | Name of the group that the policy applies to. If omitted, the global policy is used. aliases: name | |
| historylength string | Number of previous passwords that are remembered. Users cannot reuse remembered passwords. | |
| ipa_host string | Default: "ipa.example.com" | IP or hostname of IPA server. If the value is not specified in the task, the value of environment variable IPA_HOST will be used instead.If both the environment variable IPA_HOST and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.The relevant entry needed in FreeIPA is the 'ipa-ca' entry. If neither the DNS entry, nor the environment IPA_HOST, nor the value are available in the task, then the default value will be used.Environment variable fallback mechanism is added in Ansible 2.5. |
| ipa_pass string | Password of administrative user. If the value is not specified in the task, the value of environment variable IPA_PASS will be used instead.Note that if the 'urllib_gssapi' library is available, it is possible to use GSSAPI to authenticate to FreeIPA. If the environment variable KRB5CCNAME is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.If the environment variable KRB5_CLIENT_KTNAME is available, and KRB5CCNAME is not; the module will use this kerberos keytab to authenticate.If GSSAPI is not available, the usage of 'ipa_pass' is required. Environment variable fallback mechanism is added in Ansible 2.5. | |
| ipa_port integer | Default: 443 | Port of FreeIPA / IPA server. If the value is not specified in the task, the value of environment variable IPA_PORT will be used instead.If both the environment variable IPA_PORT and the value are not specified in the task, then default value is set.Environment variable fallback mechanism is added in Ansible 2.5. |
| ipa_prot string |
| Protocol used by IPA server. If the value is not specified in the task, the value of environment variable IPA_PROT will be used instead.If both the environment variable IPA_PROT and the value are not specified in the task, then default value is set.Environment variable fallback mechanism is added in Ansible 2.5. |
| ipa_timeout integer | Default: 10 | Specifies idle timeout (in seconds) for the connection. For bulk operations, you may want to increase this in order to avoid timeout from IPA server. If the value is not specified in the task, the value of environment variable IPA_TIMEOUT will be used instead.If both the environment variable IPA_TIMEOUT and the value are not specified in the task, then default value is set. |
| ipa_user string | Default: "admin" | Administrative account used on IPA server. If the value is not specified in the task, the value of environment variable IPA_USER will be used instead.If both the environment variable IPA_USER and the value are not specified in the task, then default value is set.Environment variable fallback mechanism is added in Ansible 2.5. |
| lockouttime string | Period (in seconds) for which users are locked out. | |
| maxfailcount string | Maximum number of consecutive failures before lockout. | |
| maxpwdlife string | Maximum password lifetime (in days). | |
| minclasses string | Minimum number of character classes. | |
| minlength string | Minimum password length. | |
| minpwdlife string | Minimum password lifetime (in hours). | |
| priority string | Priority of the policy. High number means lower priority. Required when cn is not the global policy. | |
| state string |
| State to ensure. |
| validate_certs boolean |
| This only applies if ipa_prot is https.If set to no, the SSL certificates will not be validated.This should only set to no used on personally controlled sites using self-signed certificates. |
Note
check_mode.- name: Modify the global password policy
community.general.ipa_pwpolicy:
maxpwdlife: '90'
minpwdlife: '1'
historylength: '8'
minclasses: '3'
minlength: '16'
maxfailcount: '6'
failinterval: '60'
lockouttime: '600'
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure the password policy for the group admins is present
community.general.ipa_pwpolicy:
group: admins
state: present
maxpwdlife: '60'
minpwdlife: '24'
historylength: '16'
minclasses: '4'
priority: '10'
maxfailcount: '4'
failinterval: '600'
lockouttime: '1200'
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure that the group sysops does not have a unique password policy
community.general.ipa_pwpolicy:
group: sysops
state: absent
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| pwpolicy dictionary | always | Password policy as returned by IPA API. Sample: {'cn': ['admins'], 'cospriority': ['10'], 'dn': 'cn=admins,cn=EXAMPLE.COM,cn=kerberos,dc=example,dc=com', 'krbmaxpwdlife': ['60'], 'krbminpwdlife': ['24'], 'krbpwdfailurecountinterval': ['600'], 'krbpwdhistorylength': ['16'], 'krbpwdlockoutduration': ['1200'], 'krbpwdmaxfailure': ['4'], 'krbpwdmindiffchars': ['4'], 'objectclass': ['top', 'nscontainer', 'krbpwdpolicy']} |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipa_pwpolicy_module.html