utm_proxy_exception – Create, update or destroy reverse_proxy exception entry in Sophos UTM¶
New in version 2.8.
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.
Parameters¶
| Parameter | Choices/Defaults | 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 | |
| op 
                    string
                                                                 | 
 | The operand to be used with the entries of the path parameter | 
| path 
                    list
                                                                 | Default: [] | The paths the exception in the reverse proxy is defined for | 
| skip_custom_threats_filters 
                    list
                                                                 | Default: [] | A list of threats to be skipped | 
| skip_threats_filter_categories 
                    list
                                                                 | Default: [] | Define which categories of threats are skipped | 
| skipav 
                    boolean
                                                                 | 
 | Skip the Antivirus Scanning | 
| skipbadclients 
                    boolean
                                                                 | 
 | Block clients with bad reputation | 
| skipcookie 
                    boolean
                                                                 | 
 | Skip the Cookie Signing check | 
| skipform 
                    boolean
                                                                 | 
 | Enable form hardening | 
| skipform_missingtoken 
                    boolean
                                                                 | 
 | Enable form hardening with missing tokens | 
| skiphtmlrewrite 
                    boolean
                                                                 | 
 | Protection against SQL | 
| skiptft 
                    boolean
                                                                 | 
 | Enable true file type control | 
| skipurl 
                    boolean
                                                                 | 
 | Enable static URL hardening | 
| source 
                    list
                                                                 | Default: [] | Define which categories of threats are skipped | 
| state 
                    string
                                                                 | 
 | The desired state of the object. presentwill create or update an objectabsentwill delete an object if it was present | 
| status 
                    boolean
                                                                 | 
 | Status of the exception rule set | 
| utm_host 
                    string
                                             / required                     | The REST Endpoint of the Sophos UTM. | |
| utm_port 
                    integer
                                                                 | Default: 4444 | The port of the REST interface. | 
| utm_protocol 
                    string
                                                                 | 
 | The protocol of the REST Endpoint. | 
| 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=en, Chapter 2.4.2. | |
| validate_certs 
                    boolean
                                                                 | 
 | Whether the REST interface's ssl certificate should be verified or not. | 
Examples¶
- name: Create UTM proxy_exception
  utm_proxy_exception:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestExceptionEntry
    backend: REF_OBJECT_STRING
    state: present
- name: Remove UTM proxy_exception
  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:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Sebastian Schenzel (@RickS-C137)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
