community.general.ipa_sudorule module – Manage FreeIPA sudo rule
Note
This module is part of the community.general collection (version 10.7.5).
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_sudorule.
Synopsis
Add, modify or delete sudo rule within IPA server using IPA API.
Parameters
Parameter |
Comments |
|---|---|
List of commands assigned to the rule. If an empty list is passed all commands are removed from the rule. If option is omitted commands are not checked nor changed. |
|
Command category the rule applies to. Choices:
|
|
List of command groups assigned to the rule. If an empty list is passed all command groups are removed from the rule. If option is omitted command groups are not checked nor changed. |
|
Canonical name. Can not be changed as it is the unique identifier. |
|
List of denied commands assigned to the rule. If an empty list is passed all commands are removed from the rule. If option is omitted commands are not checked nor changed. |
|
List of denied command groups assigned to the rule. If an empty list is passed all command groups are removed from the rule. If option is omitted command groups are not checked nor changed. |
|
Description of the sudo rule. |
|
List of hosts assigned to the rule. If an empty list is passed all hosts are removed from the rule. If option is omitted hosts are not checked nor changed. Option |
|
List of host groups assigned to the rule. If an empty list is passed all host groups are removed from the rule. If option is omitted host groups are not checked nor changed. Option |
|
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: |
|
List of external RunAs users. |
|
RunAs Group category the rule applies to. Choices:
|
|
RunAs User category the rule applies to. Choices:
|
|
State to ensure. Choices:
|
|
List of options to add to the sudo rule. |
|
List of users assigned to the rule. If an empty list is passed all users are removed from the rule. If option is omitted users are not checked nor changed. |
|
User category the rule applies to. Choices:
|
|
List of user groups assigned to the rule. If an empty list is passed all user groups are removed from the rule. If option is omitted user groups are not checked nor 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 |
Notes
Note
This module uses JSON-RPC over HTTP(S) to communicate with the FreeIPA server. If you need to enroll the managed node into FreeIPA realm, you might want to consider using the collection freeipa.ansible_freeipa, but shell access to one node from the realm is required to manage the deployment.
Examples
- name: Ensure sudo rule is present that's allows all every body to execute any command on any host without being asked
for a password.
community.general.ipa_sudorule:
name: sudo_all_nopasswd
cmdcategory: all
description: Allow to run every command with sudo without password
hostcategory: all
sudoopt:
- '!authenticate'
usercategory: all
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure user group developers can run every command on host group db-server as well as on host db01.example.com.
community.general.ipa_sudorule:
name: sudo_dev_dbserver
description: Allow developers to run every command with sudo on all database server
cmdcategory: all
host:
- db01.example.com
hostgroup:
- db-server
sudoopt:
- '!authenticate'
usergroup:
- developers
ipa_host: ipa.example.com
ipa_user: admin
ipa_pass: topsecret
- name: Ensure user group operations can run any commands that is part of operations-cmdgroup on any host as user root.
community.general.ipa_sudorule:
name: sudo_operations_all
description: Allow operators to run any commands that is part of operations-cmdgroup on any host as user root.
cmdgroup:
- operations-cmdgroup
hostcategory: all
runasextusers:
- root
sudoopt:
- '!authenticate'
usergroup:
- operators
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 |
|---|---|
Sudorule as returned by IPA. Returned: always |