ipa_config – Manage Global FreeIPA Configuration Settings
ipa_config – Manage Global FreeIPA Configuration Settings
New in version 2.7.
Synopsis
- Modify global configuration settings of a FreeIPA Server.
Parameters
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 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. |
ipa_pass string / required |
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. | |
ipa_port integer |
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 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 If both the environment variable 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 If both the environment variable |
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 If both the environment variable Environment variable fallback mechanism is added in Ansible 2.5. |
ipadefaultemaildomain - |
Default e-mail domain for new users.
| |
ipadefaultloginshell - |
Default shell for new users.
| |
validate_certs boolean |
|
This only applies if If set to This should only set to |
Examples
# 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
Return Values
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.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Fran Fitzpatrick (@fxfitz)
© 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