W3cubDocs

/Ansible

ipa_sudocmdgroup - Manage FreeIPA sudo command group

New in version 2.3.

Synopsis

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

Options

parameter required default choices comments
cn
yes
Sudo Command Group.
aliases: name
description
no
Group description.
ipa_host
no ipa.example.com
IP or hostname of IPA server
ipa_pass
yes
Password of administrative user
ipa_port
no 443
Port of IPA server
ipa_prot
no https
  • http
  • https
Protocol used by IPA server
ipa_user
no admin
Administrative account used on IPA server
state
no present
  • present
  • absent
State to ensure
sudocmd
no
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.
validate_certs
no True
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

- name: Ensure sudo command group exists
  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 exists
  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 Return Values, the following are the fields unique to this module:

name description returned type sample
sudocmdgroup
Sudo command group as returned by IPA API
always dict

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ipa_sudocmdgroup_module.html