community.general.ipa_hostgroup module – Manage FreeIPA host-group
Note
This module is part of the community.general collection (version 5.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.ipa_hostgroup
.
Synopsis
Add, modify and delete an IPA host-group using IPA API.
Parameters
Parameter |
Comments |
---|---|
Name of host-group. Can not be changed as it is the unique identifier. |
|
Description. |
|
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. |
|
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. |
|
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 The relevant entry needed in FreeIPA is the ‘ipa-ca’ entry. If neither the DNS entry, nor the environment Environment variable fallback mechanism is added in Ansible 2.5. Default: |
|
Password of administrative user. If the value is not specified in the task, the value of environment variable Note that if the ‘urllib_gssapi’ library is available, it is possible to use GSSAPI to authenticate to FreeIPA. If the environment variable If the environment variable If GSSAPI is not available, the usage of ‘ipa_pass’ is required. Environment variable fallback mechanism is added in Ansible 2.5. |
|
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 Ansible 2.5. Default: |
|
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 Ansible 2.5. Choices:
|
|
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 Default: |
|
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 Ansible 2.5. Default: |
|
State to ensure. Choices:
|
|
This only applies if If set to This should only set to Choices:
|
Examples
- name: Ensure host-group databases is present
community.general.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
- name: Ensure host-group databases is absent
community.general.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 |
Description |
---|---|
Hostgroup as returned by IPA API. Returned: always |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication