New in version 2.7.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| 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 |
| 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. |
| ipadefaultemaildomain - | Default e-mail domain for new users. aliases: emaildomain | |
| ipadefaultloginshell - | Default shell for new users. aliases: loginshell | |
| validate_certs boolean |
| 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. |
# Ensure the default login shell is bash.
- ipa_config:
ipadefaultloginshell: /bin/bash
ipa_host: localhost
ipa_user: admin
ipa_pass: supersecret
# Ensure the default e-mail domain is ansible.com.
- ipa_config:
ipadefaultemaildomain: ansible.com
ipa_host: localhost
ipa_user: admin
ipa_pass: supersecret
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| config dictionary | always | Configuration as returned by IPA API. |
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_config_module.html