community.general.ipa_sudorule module – Manage FreeIPA sudo rule

Note

This module is part of the community.general collection (version 9.5.1).

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

cmd

list / elements=string

List of commands assigned to the rule.

If an empty list is passed all commands will be removed from the rule.

If option is omitted commands will not be checked or changed.

cmdcategory

string

Command category the rule applies to.

Choices:

  • "all"

cmdgroup

list / elements=string

added in community.general 2.0.0

List of command groups assigned to the rule.

If an empty list is passed all command groups will be removed from the rule.

If option is omitted command groups will not be checked or changed.

cn

aliases: name

string / required

Canonical name.

Can not be changed as it is the unique identifier.

deny_cmd

list / elements=string

added in community.general 8.1.0

List of denied commands assigned to the rule.

If an empty list is passed all commands will be removed from the rule.

If option is omitted commands will not be checked or changed.

deny_cmdgroup

list / elements=string

added in community.general 8.1.0

List of denied command groups assigned to the rule.

If an empty list is passed all command groups will be removed from the rule.

If option is omitted command groups will not be checked or changed.

description

string

Description of the sudo rule.

host

list / elements=string

List of hosts assigned to the rule.

If an empty list is passed all hosts will be removed from the rule.

If option is omitted hosts will not be checked or changed.

Option hostcategory must be omitted to assign hosts.

hostcategory

string

Host category the rule applies to.

If all is passed one must omit host and hostgroup.

Option host and hostgroup must be omitted to assign all.

Choices:

  • "all"

hostgroup

list / elements=string

List of host groups assigned to the rule.

If an empty list is passed all host groups will be removed from the rule.

If option is omitted host groups will not be checked or changed.

Option hostcategory must be omitted to assign host groups.

ipa_host

string

IP or hostname of IPA server.

If the value is not specified in the task, the value of environment variable IPA_HOST will be used instead.

If both the environment variable IPA_HOST and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.

The relevant entry needed in FreeIPA is the ipa-ca entry.

If neither the DNS entry, nor the environment IPA_HOST, nor the value are available in the task, then the default value will be used.

Default: "ipa.example.com"

ipa_pass

string

Password of administrative user.

If the value is not specified in the task, the value of environment variable IPA_PASS will be used instead.

Note that if the urllib_gssapi library is available, it is possible to use GSSAPI to authenticate to FreeIPA.

If the environment variable KRB5CCNAME is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.

If the environment variable KRB5_CLIENT_KTNAME is available, and KRB5CCNAME is not; the module will use this kerberos keytab to authenticate.

If GSSAPI is not available, the usage of ipa_pass is required.

ipa_port

integer

Port of FreeIPA / IPA server.

If the value is not specified in the task, the value of environment variable IPA_PORT will be used instead.

If both the environment variable IPA_PORT and the value are not specified in the task, then default value is set.

Default: 443

ipa_prot

string

Protocol used by IPA server.

If the value is not specified in the task, the value of environment variable IPA_PROT will be used instead.

If both the environment variable IPA_PROT and the value are not specified in the task, then default value is set.

Choices:

  • "http"

  • "https" ← (default)

ipa_timeout

integer

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 IPA_TIMEOUT will be used instead.

If both the environment variable IPA_TIMEOUT and the value are not specified in the task, then default value is set.

Default: 10

ipa_user

string

Administrative account used on IPA server.

If the value is not specified in the task, the value of environment variable IPA_USER will be used instead.

If both the environment variable IPA_USER and the value are not specified in the task, then default value is set.

Default: "admin"

runasextusers

list / elements=string

added in community.general 2.3.0

List of external RunAs users

runasgroupcategory

string

RunAs Group category the rule applies to.

Choices:

  • "all"

runasusercategory

string

RunAs User category the rule applies to.

Choices:

  • "all"

state

string

State to ensure.

Choices:

  • "absent"

  • "disabled"

  • "enabled"

  • "present" ← (default)

sudoopt

list / elements=string

List of options to add to the sudo rule.

user

list / elements=string

List of users assigned to the rule.

If an empty list is passed all users will be removed from the rule.

If option is omitted users will not be checked or changed.

usercategory

string

User category the rule applies to.

Choices:

  • "all"

usergroup

list / elements=string

List of user groups assigned to the rule.

If an empty list is passed all user groups will be removed from the rule.

If option is omitted user groups will not be checked or changed.

validate_certs

boolean

This only applies if ipa_prot is https.

If set to false, the SSL certificates will not be validated.

This should only set to false used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

dictionary

Sudorule as returned by IPA

Returned: always

Authors

  • Thomas Krahn (@Nosmoht)