W3cubDocs

/Ansible 2.9

ipa_hostgroup – Manage FreeIPA host-group

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.

aliases: name
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
string
Default:
"ipa.example.com"
IP or hostname of IPA server.
If the value is not specified in the task, the value of environment variable IPA_HOST will be used instead.
If both the environment variable IPA_HOST and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.
The relevant entry needed in FreeIPA is the 'ipa-ca' entry.
If neither the DNS entry, nor the environment IPA_HOST, nor the value are available in the task, then the default value will be used.
Environment variable fallback mechanism is added in Ansible 2.5.
ipa_pass
string / required
Password of administrative user.
If the value is not specified in the task, the value of environment variable IPA_PASS will be used instead.
Note that if the 'urllib_gssapi' library is available, it is possible to use GSSAPI to authenticate to FreeIPA.
If the environment variable KRB5CCNAME is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.
If the environment variable KRB5_CLIENT_KTNAME is available, and KRB5CCNAME is not; the module will use this kerberos keytab to authenticate.
If GSSAPI is not available, the usage of 'ipa_pass' is required.
Environment variable fallback mechanism is added in Ansible 2.5.
ipa_port
integer
Default:
443
Port of FreeIPA / IPA server.
If the value is not specified in the task, the value of environment variable IPA_PORT will be used instead.
If both the environment variable IPA_PORT and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in Ansible 2.5.
ipa_prot
string
    Choices:
  • http
  • https ←
Protocol used by IPA server.
If the value is not specified in the task, the value of environment variable IPA_PROT will be used instead.
If both the environment variable IPA_PROT and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in Ansible 2.5.
ipa_timeout
integer
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 IPA_TIMEOUT will be used instead.
If both the environment variable IPA_TIMEOUT and the value are not specified in the task, then default value is set.
ipa_user
string
Default:
"admin"
Administrative account used on IPA server.
If the value is not specified in the task, the value of environment variable IPA_USER will be used instead.
If both the environment variable IPA_USER and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in Ansible 2.5.
state
-
    Choices:
  • present ←
  • absent
  • enabled
  • disabled
State to ensure.
validate_certs
boolean
    Choices:
  • no
  • yes ←
This only applies if ipa_prot is https.
If set to no, the SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

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

Authors

  • Thomas Krahn (@Nosmoht)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ipa_hostgroup_module.html