community.general.utm_aaa_group_info module – Get info for reverse_proxy frontend entry in Sophos UTM
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.utm_aaa_group_info
.
Synopsis
get info for a reverse_proxy frontend entry in SOPHOS UTM.
Parameters
Parameter |
Comments |
---|---|
A dictionary of additional headers to be sent to POST and PUT requests. Is needed for some modules. Default: |
|
The name of the object. Will be used to identify the entry |
|
The desired state of the object.
Choices:
|
|
The REST Endpoint of the Sophos UTM. |
|
The port of the REST interface. Default: |
|
The protocol of the REST Endpoint. Choices:
|
|
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=en, Chapter 2.4.2. |
|
Whether the REST interface’s ssl certificate should be verified or not. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full added in community.general 3.3.0 This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
The utm object that was created Returned: success |
|
Whether or not the object is currently locked Returned: success |
|
The reference name of the object Returned: success |
|
The type of the object Returned: success |
|
List of Active Directory Groups Returned: success |
|
List of Active Directory Groups SIDS Returned: success |
|
The backend to use Returned: success |
|
The comment string Returned: success |
|
Whether the group match is ipsec_dn or directory_group Returned: success |
|
List of eDirectory Groups Returned: success |
|
ipsec_dn identifier to match Returned: success |
|
The LDAP Attribute to match against Returned: success |
|
The LDAP Attribute Value to match against Returned: success |
|
List of member identifiers of the group Returned: success |
|
The name of the object Returned: success |
|
The identifier of the network (network/aaa) Returned: success |
|
The radius group identifier Returned: success |
|
The tacacs group identifier Returned: success |