Blame README-privilege.md

Packit Service a166ed
Privilege module
Packit Service a166ed
================
Packit Service a166ed
Packit Service a166ed
Description
Packit Service a166ed
-----------
Packit Service a166ed
Packit Service a166ed
The privilege module allows to ensure presence and absence of privileges and privilege members.
Packit Service a166ed
Packit Service a166ed
Features
Packit Service a166ed
--------
Packit Service a166ed
Packit Service a166ed
* Privilege management
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Supported FreeIPA Versions
Packit Service a166ed
--------------------------
Packit Service a166ed
Packit Service a166ed
FreeIPA versions 4.4.0 and up are supported by the ipaprivilege module.
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Requirements
Packit Service a166ed
------------
Packit Service a166ed
Packit Service a166ed
**Controller**
Packit Service a166ed
* Ansible version: 2.8+
Packit Service a166ed
Packit Service a166ed
**Node**
Packit Service a166ed
* Supported FreeIPA version (see above)
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Usage
Packit Service a166ed
=====
Packit Service a166ed
Packit Service a166ed
Example inventory file
Packit Service a166ed
Packit Service a166ed
```ini
Packit Service a166ed
[ipaserver]
Packit Service a166ed
ipaserver.test.local
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Example playbook to make sure privilege "Broad Privilege" is present:
Packit Service a166ed
Packit Service a166ed
```yaml
Packit Service a166ed
---
Packit Service a166ed
- name: Playbook to manage IPA privilege.
Packit Service a166ed
  hosts: ipaserver
Packit Service a166ed
  become: yes
Packit Service a166ed
Packit Service a166ed
  tasks:
Packit Service a166ed
  - ipaprivilege:
Packit Service a166ed
      ipaadmin_password: SomeADMINpassword
Packit Service a166ed
      name: Broad Privilege
Packit Service a166ed
      description: Broad Privilege
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Example playbook to make sure privilege "Broad Privilege" member permission has multiple values:
Packit Service a166ed
Packit Service a166ed
```yaml
Packit Service a166ed
---
Packit Service a166ed
- name: Playbook to manage IPA privilege permission member.
Packit Service a166ed
  hosts: ipaserver
Packit Service a166ed
  become: yes
Packit Service a166ed
Packit Service a166ed
  tasks:
Packit Service a166ed
  - ipaprivilege:
Packit Service a166ed
      ipaadmin_password: SomeADMINpassword
Packit Service a166ed
      name: Broad Privilege
Packit Service a166ed
      permission:
Packit Service a166ed
      - "Write IPA Configuration"
Packit Service a166ed
      - "System: Write DNS Configuration"
Packit Service a166ed
      - "System: Update DNS Entries"
Packit Service a166ed
      action: member
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Example playbook to make sure privilege "Broad Privilege" member permission 'Write IPA Configuration' is absent:
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
```yaml
Packit Service a166ed
---
Packit Service a166ed
- name: Playbook to manage IPA privilege permission member.
Packit Service a166ed
  hosts: ipaserver
Packit Service a166ed
  become: yes
Packit Service a166ed
Packit Service a166ed
  tasks:
Packit Service a166ed
  - ipaprivilege:
Packit Service a166ed
      ipaadmin_password: SomeADMINpassword
Packit Service a166ed
      name: Broad Privilege
Packit Service a166ed
      permission:
Packit Service a166ed
      - "Write IPA Configuration"
Packit Service a166ed
      action: member
Packit Service a166ed
      state: absent
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Example playbook to rename privilege "Broad Privilege" to "DNS Special Privilege":
Packit Service a166ed
Packit Service a166ed
```yaml
Packit Service a166ed
---
Packit Service a166ed
- name: Playbook to manage IPA privilege.
Packit Service a166ed
  hosts: ipaserver
Packit Service a166ed
  become: yes
Packit Service a166ed
Packit Service a166ed
  tasks:
Packit Service a166ed
  - ipaprivilege:
Packit Service a166ed
      ipaadmin_password: SomeADMINpassword
Packit Service a166ed
      name: Broad Privilege
Packit Service a166ed
      rename: DNS Special Privilege
Packit Service a166ed
      state: renamed
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Example playbook to make sure privilege "DNS Special Privilege" is absent:
Packit Service a166ed
Packit Service a166ed
```yaml
Packit Service a166ed
---
Packit Service a166ed
- name: Playbook to manage IPA privilege.
Packit Service a166ed
  hosts: ipaserver
Packit Service a166ed
  become: yes
Packit Service a166ed
  - name: Ensure privilege Broad Privilege is absent
Packit Service a166ed
      ipaadmin_password: SomeADMINpassword
Packit Service a166ed
      name: DNS Special Privilege
Packit Service a166ed
      state: absent
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Variables
Packit Service a166ed
---------
Packit Service a166ed
Packit Service a166ed
ipaprivilege
Packit Service a166ed
------------
Packit Service a166ed
Packit Service a166ed
Variable | Description | Required
Packit Service a166ed
-------- | ----------- | --------
Packit Service a166ed
`ipaadmin_principal` | The admin principal is a string and defaults to `admin`. | no
Packit Service a166ed
`ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node. | no
Packit Service a166ed
`name` \| `cn` | The list of privilege name strings. | yes
Packit Service a166ed
`description` | Privilege description. | no
Packit Service a166ed
`rename` \| `new_name` | Rename the privilege object. | no
Packit Service a166ed
`permission` | Permissions to be added to the privilege. | no
Packit Service a166ed
`action` | Work on privilege or member level. It can be one of `member` or `privilege` and defaults to `privilege`. | no
Packit Service a166ed
`state` | The state to ensure. It can be one of `present`, `absent` or `renamed`, default: `present`. | no
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Authors
Packit Service a166ed
=======
Packit Service a166ed
Packit Service a166ed
Rafael Guterres Jeffman