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.

community.general.utm_aaa_group_info – get info for reverse_proxy frontend entry in Sophos UTM

Note

This plugin is part of the community.general collection (version 3.8.3).

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.utm_aaa_group_info.

Synopsis

• get info for a reverse_proxy frontend entry in SOPHOS UTM.

Parameters

Parameter	Comments
headers dictionary	A dictionary of additional headers to be sent to POST and PUT requests. Is needed for some modules
name string / required	The name of the object. Will be used to identify the entry
state string	The desired state of the object. present will create or update an object absent will delete an object if it was present Choices: absent present ← (default)
utm_host string / required	The REST Endpoint of the Sophos UTM.
utm_port integer	The port of the REST interface. Default: 4444
utm_protocol string	The protocol of the REST Endpoint. Choices: http https ← (default)
utm_token string / required	The token used to identify at the REST-API. See https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la%3Den, Chapter 2.4.2.
validate_certs boolean	Whether the REST interface’s ssl certificate should be verified or not. Choices: no yes ← (default)

Examples

- name: Remove UTM aaa_group
  community.general.utm_aaa_group_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestAAAGroupEntry

Return Values

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

Key	Description
result complex	The utm object that was created Returned: success
_locked boolean	Whether or not the object is currently locked Returned: success
_ref string	The reference name of the object Returned: success
_type string	The type of the object Returned: success
adirectory_groups string	List of Active Directory Groups Returned: success
adirectory_groups_sids list / elements=string	List of Active Directory Groups SIDS Returned: success
backend_match string	The backend to use Returned: success
comment string	The comment string Returned: success
dynamic string	Whether the group match is ipsec_dn or directory_group Returned: success
edirectory_groups string	List of eDirectory Groups Returned: success
ipsec_dn string	ipsec_dn identifier to match Returned: success
ldap_attribute string	The LDAP Attribute to match against Returned: success
ldap_attribute_value string	The LDAP Attribute Value to match against Returned: success
members list / elements=string	List of member identifiers of the group Returned: success
name string	The name of the object Returned: success
network string	The identifier of the network (network/aaa) Returned: success
radius_group string	The radius group identifier Returned: success
tacacs_group string	The tacacs group identifier Returned: success

Authors

• Johannes Brunswicker (@MatrixCrawler)