Blame README-hbacsvc.md

Packit 8cb997
HBACsvc module
Packit 8cb997
==============
Packit 8cb997
Packit 8cb997
Description
Packit 8cb997
-----------
Packit 8cb997
Packit 8cb997
The hbacsvc (HBAC Service) module allows to ensure presence and absence of HBAC Services.
Packit 8cb997
Packit 8cb997
Packit 8cb997
Features
Packit 8cb997
--------
Packit 8cb997
* HBACsvc 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 ipahbacsvc 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 make sure HBAC Service for http is present
Packit 8cb997
Packit 8cb997
```yaml
Packit 8cb997
---
Packit 8cb997
- name: Playbook to handle HBAC Services
Packit 8cb997
  hosts: ipaserver
Packit 8cb997
  become: true
Packit 8cb997
Packit 8cb997
  tasks:
Packit 8cb997
  # Ensure HBAC Service for http is present
Packit 8cb997
  - ipahbacsvc:
Packit 8cb997
      ipaadmin_password: MyPassword123
Packit 8cb997
      name: http
Packit 8cb997
      description: Web service
Packit 8cb997
```
Packit 8cb997
Packit 8cb997
Example playbook to make sure HBAC Service for tftp is present
Packit 8cb997
Packit 8cb997
```yaml
Packit 8cb997
---
Packit 8cb997
- name: Playbook to handle HBAC Services
Packit 8cb997
  hosts: ipaserver
Packit 8cb997
  become: true
Packit 8cb997
Packit 8cb997
  tasks:
Packit 8cb997
  # Ensure HBAC Service for tftp is present
Packit 8cb997
  - ipahbacsvc:
Packit 8cb997
      ipaadmin_password: MyPassword123
Packit 8cb997
      name: tftp
Packit 8cb997
      description: TFTPWeb service
Packit 8cb997
```
Packit 8cb997
Packit 8cb997
Example playbook to make sure HBAC Services for http and tftp are absent
Packit 8cb997
Packit 8cb997
```yaml
Packit 8cb997
---
Packit 8cb997
- name: Playbook to handle HBAC Services
Packit 8cb997
  hosts: ipaserver
Packit 8cb997
  become: true
Packit 8cb997
Packit 8cb997
  tasks:
Packit 8cb997
  # Ensure HBAC Service for http and tftp are absent
Packit 8cb997
  - ipahbacsvc:
Packit 8cb997
      ipaadmin_password: MyPassword123
Packit 8cb997
      name: http,tftp
Packit 8cb997
      state: absent
Packit 8cb997
```
Packit 8cb997
Packit 8cb997
Packit 8cb997
Variables
Packit 8cb997
=========
Packit 8cb997
Packit 8cb997
ipahbacsvc
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` \| `service` | The list of hbacsvc name strings. | no
Packit 8cb997
`description` | The hbacsvc description string. | no
Packit 8cb997
`state` | The state to ensure. It can be one of `present` or `absent`, default: `present`. | no
Packit 8cb997
Packit 8cb997
Packit 8cb997
Authors
Packit 8cb997
=======
Packit 8cb997
Packit 8cb997
Thomas Woerner