W3cubDocs

/Ansible

community.general.ipa_role – Manage FreeIPA role

Note

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

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

Synopsis

  • Add, modify and delete a role within FreeIPA server using FreeIPA API.

Parameters

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

aliases: name
description
string
A description of this role-group.
group
list / elements=string
List of group names assign to this role.
If an empty list is passed all assigned groups will be unassigned from the role.
If option is omitted groups will not be checked or changed.
If option is passed all assigned groups that are not passed will be unassigned from the role.
host
list / elements=string
List of host names to assign.
If an empty list is passed all assigned hosts will be unassigned from the role.
If option is omitted hosts will not be checked or changed.
If option is passed all assigned hosts that are not passed will be unassigned from the role.
hostgroup
list / elements=string
List of host group names to assign.
If an empty list is passed all assigned host groups will be removed from the role.
If option is omitted host groups will not be checked or changed.
If option is passed all assigned hostgroups that are not passed will be unassigned from the role.
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.
privilege
list / elements=string
List of privileges granted to the role.
If an empty list is passed all assigned privileges will be removed.
If option is omitted privileges will not be checked or changed.
If option is passed all assigned privileges that are not passed will be removed.
service
list / elements=string
List of service names to assign.
If an empty list is passed all assigned services will be removed from the role.
If option is omitted services will not be checked or changed.
If option is passed all assigned services that are not passed will be removed from the role.
state
string
    Choices:
  • absent
  • present ←
State to ensure.
user
list / elements=string
List of user names to assign.
If an empty list is passed all assigned users will be removed from the role.
If option is omitted users 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 role is present
  community.general.ipa_role:
    name: dba
    description: Database Administrators
    state: present
    user:
    - pinky
    - brain
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure role with certain details
  community.general.ipa_role:
    name: another-role
    description: Just another role
    group:
    - editors
    host:
    - host01.example.com
    hostgroup:
    - hostgroup01
    privilege:
    - Group Administrators
    - User Administrators
    service:
    - service01

- name: Ensure role is absent
  community.general.ipa_role:
    name: dba
    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
role
dictionary
always
Role as returned by IPA API.


Authors

  • Thomas Krahn (@Nosmoht)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipa_role_module.html