ipa_group – Manage FreeIPA group
ipa_group – Manage FreeIPA group
Synopsis
- Add, modify and delete group within IPA server
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cn - / required |
Canonical name. Can not be changed as it is the unique identifier.
| |
description - |
Description of the group. | |
external boolean |
|
Allow adding external non-IPA members from trusted domains. |
gidnumber - |
GID (use this option to set it manually).
| |
group - |
List of group names assigned to this group. If an empty list is passed all groups will be removed from this group. If option is omitted assigned groups will not be checked or changed. Groups that are already assigned but not passed will be removed. | |
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 / required |
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 added in 2.7 |
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. |
nonposix boolean |
|
Create as a non-POSIX group. |
state - |
|
State to ensure |
user - |
List of user names assigned to this group. If an empty list is passed all users will be removed from this group. If option is omitted assigned users will not be checked or changed. Users that are already assigned but not passed will be removed. | |
validate_certs boolean |
|
This only applies if If set to This should only set to |
Examples
# Ensure group is present
- ipa_group:
name: oinstall
gidnumber: 54321
state: present
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
# Ensure that groups sysops and appops are assigned to ops but no other group
- ipa_group:
name: ops
group:
- sysops
- appops
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
# Ensure that users linus and larry are assign to the group, but no other user
- ipa_group:
name: sysops
user:
- linus
- larry
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
# Ensure group is absent
- ipa_group:
name: sysops
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 |
---|---|---|
group dictionary |
always |
Group as returned by IPA API
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
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.9/modules/ipa_group_module.html