Documentation

ipa_role - Manage FreeIPA role

New in version 2.3.

Synopsis

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

Parameters

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

aliases: name
description
A description of this role-group.
group
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 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 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 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 default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_pass
required
Password of administrative user.
If the value is not specified in the task, the value of environment variable IPA_PASS will be used instead.
If both the environment variable IPA_PASS and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_port 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 version 2.5.
ipa_prot
    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 version 2.5.
ipa_user 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 version 2.5.
privilege
(added in 2.4)
Default:
None
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 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
    Choices:
  • present ←
  • absent
State to ensure
user
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 Default:
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

# Ensure role is present
- ipa_role:
    name: dba
    description: Database Administrators
    state: present
    user:
    - pinky
    - brain
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

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

# Ensure role is absent
- 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
dict
always
Role as returned by IPA API.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Thomas Krahn (@Nosmoht)

Hint

If you notice any issues in this documentation you can edit this document to improve it.