mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-05-07 05:43:26 +00:00
65937ed8c3
The Variables and also the Return Variables sections contained an extra header with the module name. This is only needed if there are more than one module in the README.
96 lines
1.9 KiB
Markdown
96 lines
1.9 KiB
Markdown
${name^} module
|
|
============
|
|
|
|
Description
|
|
-----------
|
|
|
|
The $name module allows to ensure presence and absence of ${name}s.
|
|
|
|
Features
|
|
--------
|
|
|
|
* ${name^} management
|
|
|
|
|
|
Supported FreeIPA Versions
|
|
--------------------------
|
|
|
|
FreeIPA versions 4.4.0 and up are supported by the ipa$name 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 $name "NAME" is present:
|
|
|
|
```yaml
|
|
---
|
|
- name: Playbook to manage IPA $name.
|
|
hosts: ipaserver
|
|
become: no
|
|
|
|
tasks:
|
|
- ipa$name:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: NAME
|
|
# Add needed parameters here
|
|
```
|
|
|
|
|
|
Example playbook to make sure $name "NAME" is absent:
|
|
|
|
```yaml
|
|
---
|
|
- name: Playbook to manage IPA $name.
|
|
hosts: ipaserver
|
|
become: no
|
|
|
|
tasks:
|
|
- ipa$name:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: NAME
|
|
state: absent
|
|
```
|
|
|
|
|
|
MORE EXAMPLE PLAYBOOKS HERE
|
|
|
|
|
|
Variables
|
|
---------
|
|
|
|
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
|
|
`ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no
|
|
`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no
|
|
`name` \| `ALIAS` | The list of $name name strings. | yes
|
|
`PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL
|
|
`PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL
|
|
`state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no
|
|
|
|
|
|
Authors
|
|
=======
|
|
|
|
$author
|