Documentation

ipa_sudorule - Manage FreeIPA sudo rule

New in version 2.3.

Synopsis

  • Add, modify or delete sudo rule within IPA server using IPA API.

Parameters

Parameter
Choices/Defaults
Comments
cmd
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
    Choices:
  • all
Command category the rule applies to.
cn
required
Canonical name.
Can not be changed as it is the unique identifier.

aliases: name
host
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
    Choices:
  • all
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'.
hostgroup
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
Default:
ipa.example.com
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 default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_pass
required
Password of administrative user.
If the value is not specified in the task, the value of environment variable IPA_PASS will be used instead.
If both the environment variable IPA_PASS and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_port
Default:
443
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.
Environment variable fallback mechanism is added in version 2.5.
ipa_prot
    Choices:
  • http
  • https ←
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.
Environment variable fallback mechanism is added in version 2.5.
ipa_user
Default:
admin
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.
Environment variable fallback mechanism is added in version 2.5.
runasgroupcategory
(added in 2.5)
    Choices:
  • all
RunAs Group category the rule applies to.
runasusercategory
(added in 2.5)
    Choices:
  • all
RunAs User category the rule applies to.
state
    Choices:
  • present ←
  • absent
  • enabled
  • disabled
State to ensure
user
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
    Choices:
  • all
User category the rule applies to.
usergroup
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
Default:
yes
This only applies if ipa_prot is https.
If set to no, the SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Examples

# Ensure sudo rule is present that's allows all every body to execute any command on any host without being asked for a password.
- 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
# Ensure user group developers can run every command on host group db-server as well as on host db01.example.com.
- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key
Returned
Description
sudorule
dict
always
Sudorule as returned by IPA


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Thomas Krahn (@Nosmoht)

Hint

If you notice any issues in this documentation you can edit this document to improve it.