community.general.ipa_role – Manage FreeIPA role
community.general.ipa_role – Manage FreeIPA role
Note
This plugin is part of the community.general collection (version 1.3.2).
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.
| |
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 If both the environment variable The relevant entry needed in FreeIPA is the 'ipa-ca' entry. If neither the DNS entry, nor the environment 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 Note that if the 'urllib_gssapi' library is available, it is possible to use GSSAPI to authenticate to FreeIPA. If the environment variable If the environment variable 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 If both the environment variable Environment variable fallback mechanism is added in Ansible 2.5. |
ipa_prot string |
|
Protocol used by IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable 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 If both the environment variable |
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 If both the environment variable 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 |
|
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 |
|
This only applies if If set to This should only set to |
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ipa_role_module.html