Blame utils/templates/README-module.md.in

Packit Service a166ed
${name^} module
Packit Service a166ed
============
Packit Service a166ed
Packit Service a166ed
Description
Packit Service a166ed
-----------
Packit Service a166ed
Packit Service a166ed
The $name module allows to ensure presence and absence of ${name}s.
Packit Service a166ed
Packit Service a166ed
Features
Packit Service a166ed
--------
Packit Service a166ed
Packit Service a166ed
* ${name^} 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 ipa$name 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 $name "NAME" is present:
Packit Service a166ed
Packit Service a166ed
```yaml
Packit Service a166ed
---
Packit Service a166ed
- name: Playbook to manage IPA $name.
Packit Service a166ed
  hosts: ipaserver
Packit Service a166ed
  become: yes
Packit Service a166ed
Packit Service a166ed
  tasks:
Packit Service a166ed
  - ipa$name:
Packit Service a166ed
      ipaadmin_password: SomeADMINpassword
Packit Service a166ed
      name: NAME
Packit Service a166ed
      # Add needed parameters here
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Example playbook to make sure $name "NAME" is absent:
Packit Service a166ed
Packit Service a166ed
```yaml
Packit Service a166ed
---
Packit Service a166ed
- name: Playbook to manage IPA $name.
Packit Service a166ed
  hosts: ipaserver
Packit Service a166ed
  become: yes
Packit Service a166ed
Packit Service a166ed
  tasks:
Packit Service a166ed
  - ipa$name:
Packit Service a166ed
      ipaadmin_password: SomeADMINpassword
Packit Service a166ed
      name: NAME
Packit Service a166ed
      state: absent
Packit Service a166ed
```
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
MORE EXAMPLE PLAYBOOKS HERE
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Variables
Packit Service a166ed
---------
Packit Service a166ed
Packit Service a166ed
ipa$name
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` \| `ALIAS` | The list of $name name strings. | yes
Packit Service a166ed
`PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL
Packit Service a166ed
`PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL
Packit Service a166ed
`state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no
Packit Service a166ed
Packit Service a166ed
Packit Service a166ed
Authors
Packit Service a166ed
=======
Packit Service a166ed
Packit Service a166ed
$author