community.general.ipa_group module – Manage FreeIPA group
Note
This module is part of the community.general collection (version 5.8.3).
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_group
.
Synopsis
Add, modify and delete group within IPA server
Parameters
Parameter |
Comments |
---|---|
If If Choices:
|
|
Canonical name. Can not be changed as it is the unique identifier. |
|
Description of the group. |
|
Allow adding external non-IPA members from trusted domains. Choices:
|
|
GID (use this option to set it manually). |
|
List of group names assigned to this group. If append=false and an empty list is passed all groups will be removed from this group. Groups that are already assigned but not passed will be removed. If append=true the listed groups will be assigned without removing other groups. If option is omitted assigned groups will not be checked or changed. |
|
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. Default: |
|
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. |
|
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. Default: |
|
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. Choices:
|
|
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 Default: |
|
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. Default: |
|
Create as a non-POSIX group. Choices:
|
|
State to ensure Choices:
|
|
List of user names assigned to this group. If append=false and an empty list is passed all users will be removed from this group. Users that are already assigned but not passed will be removed. If append=true the listed users will be assigned without removing other users. If option is omitted assigned users will not be checked or changed. |
|
This only applies if If set to This should only set to Choices:
|
Examples
- name: Ensure group is present
community.general.ipa_group:
name: oinstall
gidnumber: '54321'
state: present
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure that groups sysops and appops are assigned to ops but no other group
community.general.ipa_group:
name: ops
group:
- sysops
- appops
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure that users linus and larry are assign to the group, but no other user
community.general.ipa_group:
name: sysops
user:
- linus
- larry
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure that new starter named john is member of the group, without removing other members
community.general.ipa_group:
name: developers
user:
- john
append: true
state: present
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure group is absent
community.general.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 |
Description |
---|---|
Group as returned by IPA API Returned: always |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication