community.general.utm_proxy_exception module – Create, update or destroy reverse_proxy exception entry in Sophos UTM
Note
This module is part of the community.general collection (version 8.6.4).
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_exception
.
Synopsis
Create, update or destroy a reverse_proxy exception entry in SOPHOS UTM.
This module needs to have the REST Ability of the UTM to be activated.
Aliases: web_infrastructure.sophos_utm.utm_proxy_exception
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 operand to be used with the entries of the path parameter Choices:
|
|
The paths the exception in the reverse proxy is defined for Default: |
|
A list of threats to be skipped Default: |
|
Define which categories of threats are skipped Default: |
|
Skip the Antivirus Scanning Choices:
|
|
Block clients with bad reputation Choices:
|
|
Skip the Cookie Signing check Choices:
|
|
Enable form hardening Choices:
|
|
Enable form hardening with missing tokens Choices:
|
|
Protection against SQL Choices:
|
|
Enable true file type control Choices:
|
|
Enable static URL hardening Choices:
|
|
Define which categories of threats are skipped Default: |
|
The desired state of the object.
Choices:
|
|
Status of the exception rule set 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: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create UTM proxy_exception
community.general.utm_proxy_exception:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestExceptionEntry
backend: REF_OBJECT_STRING
state: present
- name: Remove UTM proxy_exception
community.general.utm_proxy_exception:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestExceptionEntry
state: absent
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 |
|
The optional comment string Returned: success |
|
The name of the object Returned: success |
|
The operand to be used with the entries of the path parameter Returned: success |
|
The paths the exception in the reverse proxy is defined for Returned: success |
|
A list of threats to be skipped Returned: success |
|
Define which categories of threats are skipped Returned: success |
|
Skip the Antivirus Scanning Returned: success |
|
Block clients with bad reputation Returned: success |
|
Skip the Cookie Signing check Returned: success |
|
Enable form hardening Returned: success |
|
Enable form hardening with missing tokens Returned: success |
|
Protection against SQL Returned: success |
|
Enable true file type control Returned: success |
|
Enable static URL hardening Returned: success |
|
Define which categories of threats are skipped Returned: success |