community.general.utm_proxy_frontend_info module – Create, update or destroy 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_proxy_frontend_info
.
Synopsis
Create, update or destroy a reverse_proxy frontend entry in SOPHOS UTM.
This module needs to have the REST Ability of the UTM to be activated.
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: Get utm proxy_frontend
community.general.utm_proxy_frontend_info:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestBackendEntry
host: REF_OBJECT_STRING
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 |
|
Whether to add the content type header Returned: success |
|
The reference name of the address Returned: success |
|
List of reference names of networks associated Returned: success |
|
Reference name of certificate (ca/host_key_cert) Returned: success |
|
The comment string Returned: success |
|
State of compression support Returned: success |
|
List of hostnames Returned: success |
|
List of associated proxy exceptions Returned: success |
|
State of html rewrite Returned: success |
|
whether the html rewrite cookie will be set Returned: success |
|
whether to use implicit redirection Returned: success |
|
The method of loadbalancer to use Returned: success |
|
The reference names of reverse_proxy/locations associated with the object Returned: success |
|
The name of the object Returned: success |
|
The port of the frontend connection Returned: success |
|
Preserve host header Returned: success |
|
The associated reverse_proxy/profile Returned: success |
|
Whether the frontend object is active or not Returned: success |
|
The connection type Returned: success |
|
The xheaders state Returned: success |