mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-03-26 21:33:05 +00:00
New hbacsvcgroup (HBAC Service Group) management module
There is a new hbacsvcgroup (HBAC Service Group) management module placed in the plugins folder: plugins/modules/ipahbacsvcgroup.py The hbacsvc module allows to ensure presence and absence of HBAC Service Groups. Here is the documentation for the module: README-hbacsvcgroup.md New example playbooks have been added: playbooks/hbacsvcgroup/ensure-hbacsvcgroup-absent.yml playbooks/hbacsvcgroup/ensure-hbacsvcgroup-member-absent.yml playbooks/hbacsvcgroup/ensure-hbacsvcgroup-member-present.yml playbooks/hbacsvcgroup/ensure-hbacsvcgroup-present.yml New tests added for the module: tests/hbacsvcgroup/test_hbacsvcgroup.yml
This commit is contained in:
150
README-hbacsvcgroup.md
Normal file
150
README-hbacsvcgroup.md
Normal file
@@ -0,0 +1,150 @@
|
||||
HBACsvcgroup module
|
||||
===================
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
The hbacsvcgroup (HBAC Service Group) module allows to ensure presence and absence of HBAP Service Groups and members of the groups.
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
* HBAC Service Group management
|
||||
|
||||
|
||||
Supported FreeIPA Versions
|
||||
--------------------------
|
||||
|
||||
FreeIPA versions 4.4.0 and up are supported by the ipahbacsvcgroup module.
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
**Controller**
|
||||
* Ansible version: 2.8+
|
||||
|
||||
**Node**
|
||||
* Supported FreeIPA version (see above)
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Example inventory file
|
||||
|
||||
```ini
|
||||
[ipaserver]
|
||||
ipaserver.test.local
|
||||
```
|
||||
|
||||
|
||||
Example playbook to make sure HBAC Service Group login exists:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Playbook to handle hbacsvcgroups
|
||||
hbacsvcs: ipaserver
|
||||
become: true
|
||||
|
||||
tasks:
|
||||
# Ensure HBAC Service Group login is present
|
||||
- ipahbacsvcgroup:
|
||||
ipaadmin_password: MyPassword123
|
||||
name: login
|
||||
```
|
||||
|
||||
|
||||
Example playbook to make sure HBAC Service Group login exists with the only HBAC Service sshd:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Playbook to handle hbacsvcgroups
|
||||
hbacsvcs: ipaserver
|
||||
become: true
|
||||
|
||||
tasks:
|
||||
# Ensure HBAC Service Group login is present with the only HBAC Service sshd
|
||||
- ipahbacsvcgroup:
|
||||
ipaadmin_password: MyPassword123
|
||||
name: login
|
||||
hbacsvc:
|
||||
- sshd
|
||||
```
|
||||
|
||||
Example playbook to make sure HBAC Service sshd is present in HBAC Service Group login:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Playbook to handle hbacsvcgroups
|
||||
hbacsvcs: ipaserver
|
||||
become: true
|
||||
|
||||
tasks:
|
||||
# Ensure HBAC Service sshd is present in HBAC Service Group login
|
||||
- ipahbacsvcgroup:
|
||||
ipaadmin_password: MyPassword123
|
||||
name: login
|
||||
hbacsvc:
|
||||
- sshd
|
||||
action: member
|
||||
```
|
||||
|
||||
Example playbook to make sure HBAC Service sshd is absent in HBAC Service Group login:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Playbook to handle hbacsvcgroups
|
||||
hbacsvcs: ipaserver
|
||||
become: true
|
||||
|
||||
tasks:
|
||||
# Ensure HBAC Service sshd is present in HBAC Service Group login
|
||||
- ipahbacsvcgroup:
|
||||
ipaadmin_password: MyPassword123
|
||||
name: login
|
||||
hbacsvc:
|
||||
- sshd
|
||||
action: member
|
||||
state: absent
|
||||
```
|
||||
|
||||
Example playbook to make sure HBAC Service Group login is absent:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Playbook to handle hbacsvcgroups
|
||||
hbacsvcs: ipaserver
|
||||
become: true
|
||||
|
||||
tasks:
|
||||
# Ensure HBAC Service Group login is present
|
||||
- ipahbacsvcgroup:
|
||||
ipaadmin_password: MyPassword123
|
||||
name: login
|
||||
state: absent
|
||||
```
|
||||
|
||||
|
||||
Variables
|
||||
=========
|
||||
|
||||
ipahbacsvcgroup
|
||||
---------------
|
||||
|
||||
Variable | Description | Required
|
||||
-------- | ----------- | --------
|
||||
`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
|
||||
`ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no
|
||||
`name` \| `cn` | The list of hbacsvcgroup name strings. | no
|
||||
`description` | The hbacsvcgroup description string. | no
|
||||
`nomembers` | Suppress processing of membership attributes. (bool) | no
|
||||
`hbacsvc` | List of hbacsvc name strings assigned to this hbacsvcgroup. | no
|
||||
`action` | Work on hbacsvcgroup or member level. It can be on of `member` or `hbacsvcgroup` and defaults to `hbacsvcgroup`. | no
|
||||
`state` | The state to ensure. It can be one of `present` or `absent`, default: `present`. | no
|
||||
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
Thomas Woerner
|
||||
Reference in New Issue
Block a user