ipa_hostgroup – Manage FreeIPA host-group
ipa_hostgroup – Manage FreeIPA host-group
New in version 2.3.
Synopsis
- Add, modify and delete an IPA host-group using IPA API
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cn - / required |
Name of host-group. Can not be changed as it is the unique identifier.
| |
description - |
Description | |
host - |
List of hosts that belong to the host-group. If an empty list is passed all hosts will be removed from the group. If option is omitted hosts will not be checked or changed. If option is passed all assigned hosts that are not passed will be unassigned from the group. | |
hostgroup - |
List of host-groups than belong to that host-group. If an empty list is passed all host-groups will be removed from the group. If option is omitted host-groups will not be checked or changed. If option is passed all assigned hostgroups that are not passed will be unassigned from the group. | |
ipa_host - |
Default: "ipa.example.com" |
IP or hostname of IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in version 2.5. |
ipa_pass - / required |
Password of administrative user. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in version 2.5. | |
ipa_port - |
Default: 443 |
Port of FreeIPA / IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in version 2.5. |
ipa_prot - |
|
Protocol used by IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in version 2.5. |
ipa_timeout - added in 2.7 |
Default: 10 |
Specifies idle timeout (in seconds) for the connection. For bulk operations, you may want to increase this in order to avoid timeout from IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable |
ipa_user - |
Default: "admin" |
Administrative account used on IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable Environment variable fallback mechanism is added in version 2.5. |
state - |
|
State to ensure. |
validate_certs boolean |
|
This only applies if If set to This should only set to |
Examples
# Ensure host-group databases is present
- ipa_hostgroup:
name: databases
state: present
host:
- db.example.com
hostgroup:
- mysql-server
- oracle-server
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
# Ensure host-group databases is absent
- ipa_hostgroup:
name: databases
state: absent
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
hostgroup dictionary |
always |
Hostgroup as returned by IPA API.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Thomas Krahn (@Nosmoht)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ipa_hostgroup_module.html