community.general.ipa_sudocmdgroup module – Manage FreeIPA sudo command group
Note
This module is part of the community.general collection (version 8.6.4).
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_sudocmdgroup
.
Synopsis
Add, modify or delete sudo command group within IPA server using IPA API.
Aliases: identity.ipa.ipa_sudocmdgroup
Parameters
Parameter |
Comments |
---|---|
Sudo Command Group. |
|
Group description. |
|
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 If neither the DNS entry, nor the environment Default: |
|
Password of administrative user. If the value is not specified in the task, the value of environment variable Note that if the If the environment variable If the environment variable If GSSAPI is not available, the usage of |
|
Port of FreeIPA / IPA server. If the value is not specified in the task, the value of environment variable If both the environment variable 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 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 Default: |
|
State to ensure. Choices:
|
|
List of sudo commands to assign to the group. If an empty list is passed all assigned commands will be removed from the group. If option is omitted sudo commands will not be checked or changed. |
|
This only applies if If set to This should only set to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Ensure sudo command group exists
community.general.ipa_sudocmdgroup:
name: group01
description: Group of important commands
sudocmd:
- su
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure sudo command group does not exist
community.general.ipa_sudocmdgroup:
name: group01
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 |
---|---|
Sudo command group as returned by IPA API Returned: always |