You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ipa_sudocmd - Manage FreeIPA sudo command¶

New in version 2.3.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Add, modify or delete sudo command within FreeIPA server using FreeIPA API.

Options ¶

parameter	required	default	choices	comments
description	no			A description of this command.
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	yes			Sudo Command. aliases: name
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 ¶

# Ensure sudo command exists
- ipa_sudocmd:
    name: su
    description: Allow to run su via sudo
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

# Ensure sudo command does not exist
- ipa_sudocmd:
    name: su
    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
sudocmd	Sudo command as return from 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.