You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.ipa_hbacrule module – Manage FreeIPA HBAC rule

Note

This module is part of the community.general collection (version 6.6.2).

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_hbacrule.

Synopsis
Parameters
Attributes
Examples
Return Values

Synopsis 

Add, modify or delete an IPA HBAC rule using IPA API.

Parameters 

Parameter	Comments
cn aliases: name string / required	Canonical name. Can not be changed as it is the unique identifier.
description string	Description
host list / elements=string	List of host names to assign. If an empty list is passed all hosts will be removed from the rule. If option is omitted hosts will not be checked or changed.
hostcategory string	Host category Choices: `"all"`
hostgroup list / elements=string	List of hostgroup names to assign. If an empty list is passed all hostgroups will be removed. from the rule If option is omitted hostgroups will not be checked or changed.
ipa_host string	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. Default: `"ipa.example.com"`
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	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. Default: `443`
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. Choices: `"http"` `"https"` ← (default)
ipa_timeout integer	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. Default: `10`
ipa_user string	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. Default: `"admin"`
service list / elements=string	List of service names to assign. If an empty list is passed all services will be removed from the rule. If option is omitted services will not be checked or changed.
servicecategory string	Service category Choices: `"all"`
servicegroup list / elements=string	List of service group names to assign. If an empty list is passed all assigned service groups will be removed from the rule. If option is omitted service groups will not be checked or changed.
sourcehost list / elements=string	List of source host names to assign. If an empty list if passed all assigned source hosts will be removed from the rule. If option is omitted source hosts will not be checked or changed.
sourcehostcategory string	Source host category Choices: `"all"`
sourcehostgroup list / elements=string	List of source host group names to assign. If an empty list if passed all assigned source host groups will be removed from the rule. If option is omitted source host groups will not be checked or changed.
state string	State to ensure Choices: `"absent"` `"disabled"` `"enabled"` `"present"` ← (default)
user list / elements=string	List of user names to assign. If an empty list if passed all assigned users will be removed from the rule. If option is omitted users will not be checked or changed.
usercategory string	User category Choices: `"all"`
usergroup list / elements=string	List of user group names to assign. If an empty list if passed all assigned user groups will be removed from the rule. If option is omitted user groups will not be checked or changed.
validate_certs boolean	This only applies if `ipa_prot` is https. If set to `false`, the SSL certificates will not be validated. This should only set to `false` used on personally controlled sites using self-signed certificates. Choices: `false` `true` ← (default)

Attributes 

Attribute	Support	Description
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Examples 

- name: Ensure rule to allow all users to access any host from any host
  community.general.ipa_hbacrule:
    name: allow_all
    description: Allow all users to access any host from any host
    hostcategory: all
    servicecategory: all
    usercategory: all
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure rule with certain limitations
  community.general.ipa_hbacrule:
    name: allow_all_developers_access_to_db
    description: Allow all developers to access any database from any host
    hostgroup:
    - db-server
    usergroup:
    - developers
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure rule is absent
  community.general.ipa_hbacrule:
    name: rule_to_be_deleted
    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
hbacrule dictionary	HBAC rule as returned by IPA API. Returned: always

Authors

Thomas Krahn (@Nosmoht)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication

community.general.ipa_hbacrule module – Manage FreeIPA HBAC rule

Synopsis

Parameters

Attributes

Examples

Return Values