Blame README-pwpolicy.md

Packit 8cb997
Pwpolicy module
Packit 8cb997
===============
Packit 8cb997
Packit 8cb997
Description
Packit 8cb997
-----------
Packit 8cb997
Packit 8cb997
The pwpolicy module allows to ensure presence and absence of pwpolicies.
Packit 8cb997
Packit 8cb997
Packit 8cb997
Features
Packit 8cb997
--------
Packit 8cb997
* Pwpolicy management
Packit 8cb997
Packit 8cb997
Packit 8cb997
Supported FreeIPA Versions
Packit 8cb997
--------------------------
Packit 8cb997
Packit 8cb997
FreeIPA versions 4.4.0 and up are supported by the ipapwpolicy module.
Packit 8cb997
Packit 8cb997
Packit 8cb997
Requirements
Packit 8cb997
------------
Packit 8cb997
Packit 8cb997
**Controller**
Packit 8cb997
* Ansible version: 2.8+
Packit 8cb997
Packit 8cb997
**Node**
Packit 8cb997
* Supported FreeIPA version (see above)
Packit 8cb997
Packit 8cb997
Packit 8cb997
Usage
Packit 8cb997
=====
Packit 8cb997
Packit 8cb997
Example inventory file
Packit 8cb997
Packit 8cb997
```ini
Packit 8cb997
[ipaserver]
Packit 8cb997
ipaserver.test.local
Packit 8cb997
```
Packit 8cb997
Packit 8cb997
Packit 8cb997
Example playbook to ensure presence of pwpolicies for exisiting group ops:
Packit 8cb997
Packit 8cb997
```yaml
Packit 8cb997
  tasks:
Packit 8cb997
  - name: Ensure presence of pwpolicies for group ops
Packit 8cb997
    ipapwpolicy:
Packit 8cb997
      ipaadmin_password: MyPassword123
Packit 8cb997
      name: ops
Packit 8cb997
      minlife: 7
Packit 8cb997
      maxlife: 49
Packit 8cb997
      history: 5
Packit 8cb997
      priority: 1
Packit 8cb997
      lockouttime: 300
Packit 8cb997
      minlength: 8
Packit 8cb997
      maxfail: 3
Packit 8cb997
```
Packit 8cb997
Packit 8cb997
Example playbook to ensure absence of pwpolicies for group ops
Packit 8cb997
Packit 8cb997
```yaml
Packit 8cb997
---
Packit 8cb997
- name: Playbook to handle pwpolicies
Packit 8cb997
  hosts: ipaserver
Packit 8cb997
  become: true
Packit 8cb997
Packit 8cb997
  tasks:
Packit 8cb997
  # Ensure absence of pwpolicies for group ops
Packit 8cb997
  - ipapwpolicy:
Packit 8cb997
      ipaadmin_password: MyPassword123
Packit 8cb997
      name: ops
Packit 8cb997
      state: absent
Packit 8cb997
```
Packit 8cb997
Packit 8cb997
Packit 8cb997
Variables
Packit 8cb997
=========
Packit 8cb997
Packit 8cb997
ipapwpolicy
Packit 8cb997
-------
Packit 8cb997
Packit 8cb997
Variable | Description | Required
Packit 8cb997
-------- | ----------- | --------
Packit 8cb997
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
Packit 8cb997
`ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no
Packit 8cb997
`name` \| `cn` | The list of pwpolicy name strings. | no
Packit 8cb997
`maxlife` \| `krbmaxpwdlife` | Maximum password lifetime in days. (int) | no
Packit 8cb997
`minlife` \| `krbminpwdlife` | Minimum password lifetime in hours. (int) | no
Packit 8cb997
`history` \| `krbpwdhistorylength` | Password history size. (int) | no
Packit 8cb997
`minclasses` \| `krbpwdmindiffchars` | Minimum number of character classes. (int) | no
Packit 8cb997
`minlength` \| `krbpwdminlength` | Minimum length of password. (int) | no
Packit 8cb997
`priority` \| `cospriority` | Priority of the policy, higher number means lower priority. (int) | no
Packit 8cb997
`maxfail` \| `krbpwdmaxfailure` | Consecutive failures before lockout. (int) | no
Packit 8cb997
`failinterval` \| `krbpwdfailurecountinterval` | Period after which failure count will be reset in seconds. (int) | no
Packit 8cb997
`lockouttime` \| `krbpwdlockoutduration` | Period for which lockout is enforced in seconds. (int) | no
Packit 8cb997
`state` | The state to ensure. It can be one of `present` or `absent`, default: `present`. | yes
Packit 8cb997
Packit 8cb997
Packit 8cb997
Authors
Packit 8cb997
=======
Packit 8cb997
Packit 8cb997
Thomas Woerner