community.general.ipa_pwpolicy module – Manage FreeIPA password policies
Note
This module is part of the community.general collection (version 9.5.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 community.general 2.0.0
Synopsis
Add, modify, or delete a password policy using the IPA API.
Parameters
Parameter |
Comments |
---|---|
Check whether the password (with possible modifications) matches a word in a dictionary (using cracklib). Choices:
|
|
Period (in seconds) after which the number of failed login attempts is reset. |
|
Maximum number of LDAP logins after password expiration. |
|
Name of the group that the policy applies to. If omitted, the global policy is used. |
|
Number of previous passwords that are remembered. Users cannot reuse remembered passwords. |
|
IP or hostname of IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable The relevant entry needed in FreeIPA is the If neither the DNS entry, nor the environment Default: |
|
Password of administrative user. If the value is not specified in the task, the value of environment variable Note that if the If the environment variable If the environment variable If GSSAPI is not available, the usage of |
|
Port of FreeIPA / IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Default: |
|
Protocol used by IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Choices:
|
|
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 If both the environment variable Default: |
|
Administrative account used on IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Default: |
|
Period (in seconds) for which users are locked out. |
|
Maximum number of consecutive failures before lockout. |
|
Maximum password lifetime (in days). |
|
Maximum number of allowed same consecutive characters in the new password. |
|
Maximum length of monotonic character sequences in the new password. An example of a monotonic sequence of length 5 is |
|
Minimum number of character classes. |
|
Minimum password length. |
|
Minimum password lifetime (in hours). |
|
Priority of the policy. High number means lower priority. Required when |
|
State to ensure. Choices:
|
|
Check whether the password (with possible modifications) contains the user name in some form (if the name has > 3 characters). Choices:
|
|
This only applies if If set to This should only set to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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'
minlength: '6'
maxfailcount: '4'
failinterval: '600'
lockouttime: '1200'
gracelimit: 3
maxrepeat: 3
maxsequence: 3
dictcheck: true
usercheck: true
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Password policy as returned by IPA API. Returned: always Sample: |