community.general.ipa_hbacrule – Manage FreeIPA HBAC rule

Note

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

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

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

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
cn
string / required
Canonical name.
Can not be changed as it is the unique identifier.

aliases: name
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
    Choices:
  • all
Host category
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
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.
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
    Choices:
  • all
Service category
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
    Choices:
  • all
Source host category
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
    Choices:
  • absent
  • disabled
  • enabled
  • present ←
State to ensure
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
    Choices:
  • all
User category
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
    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 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 Returned Description
hbacrule
dictionary
always
HBAC rule as returned by IPA API.


Authors

  • Thomas Krahn (@Nosmoht)