community.general.ipa_config – Manage Global FreeIPA Configuration Settings

Note

This plugin is part of the community.general collection (version 2.5.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.ipa_config.

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 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		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	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.
ipaconfigstring list / elements=string added in 2.5.0 of community.general	Choices: AllowNThash KDC:Disable Last Success KDC:Disable Lockout KDC:Disable Default Preauth for SPNs	Extra hashes to generate in password plug-in. aliases: configstring
ipadefaultemaildomain string		Default e-mail domain for new users. aliases: emaildomain
ipadefaultloginshell string		Default shell for new users. aliases: loginshell
ipadefaultprimarygroup string added in 2.5.0 of community.general		Default group for new users. aliases: primarygroup
ipagroupsearchfields list / elements=string added in 2.5.0 of community.general		A list of fields to search in when searching for groups. aliases: groupsearchfields
ipahomesrootdir string added in 2.5.0 of community.general		Default location of home directories. aliases: homesrootdir
ipakrbauthzdata list / elements=string added in 2.5.0 of community.general	Choices: MS-PAC PAD nfs:NONE	Default types of PAC supported for services. aliases: krbauthzdata
ipamaxusernamelength integer added in 2.5.0 of community.general		Maximum length of usernames. aliases: maxusernamelength
ipapwdexpadvnotify integer added in 2.5.0 of community.general		Notice of impending password expiration, in days. aliases: pwdexpadvnotify
ipasearchrecordslimit integer added in 2.5.0 of community.general		Maximum number of records to search (-1 or 0 is unlimited). aliases: searchrecordslimit
ipasearchtimelimit integer added in 2.5.0 of community.general		Maximum amount of time (seconds) for a search (-1 or 0 is unlimited). aliases: searchtimelimit
ipauserauthtype list / elements=string added in 2.5.0 of community.general	Choices: password radius otp pkinit hardened disabled	The authentication type to use by default. aliases: userauthtype
ipausersearchfields list / elements=string added in 2.5.0 of community.general		A list of fields to search in when searching for users. aliases: usersearchfields
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

- name: Ensure password plugin features DC:Disable Last Success and KDC:Disable Lockout are enabled
  community.general.ipa_config:
    ipaconfigstring: ["KDC:Disable Last Success", "KDC:Disable Lockout"]
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the default login shell is bash
  community.general.ipa_config:
    ipadefaultloginshell: /bin/bash
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the default e-mail domain is ansible.com
  community.general.ipa_config:
    ipadefaultemaildomain: ansible.com
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the default primary group is set to ipausers
  community.general.ipa_config:
    ipadefaultprimarygroup: ipausers
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the group search fields are set to 'cn,description'
  community.general.ipa_config:
    ipagroupsearchfields: ['cn', 'description']
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the home directory location is set to /home
  community.general.ipa_config:
    ipahomesrootdir: /home
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the default types of PAC supported for services is set to MS-PAC and PAD
  community.general.ipa_config:
    ipakrbauthzdata: ["MS-PAC", "PAD"]
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the maximum user name length is set to 32
  community.general.ipa_config:
    ipamaxusernamelength: 32
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the password expiration notice is set to 4 days
  community.general.ipa_config:
    ipapwdexpadvnotify: 4
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the search record limit is set to 100
  community.general.ipa_config:
    ipasearchrecordslimit: 100
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the search time limit is set to 2 seconds
  community.general.ipa_config:
    ipasearchtimelimit: 2
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the default user auth type is password
  community.general.ipa_config:
    ipauserauthtype: ['password']
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: supersecret

- name: Ensure the user search fields is set to 'uid,givenname,sn,ou,title'
  community.general.ipa_config:
    ipausersearchfields: ['uid', 'givenname', 'sn', 'ou', 'title']
    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.

Authors

• Fran Fitzpatrick (@fxfitz)