utm_proxy_location – create, update or destroy reverse_proxy location entry in Sophos UTM¶
New in version 2.8.
Synopsis¶
- Create, update or destroy a reverse_proxy location entry in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
Parameters¶
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| access_control 
                    string
                                                                 | 
 | whether to activate the access control for the location | 
| allowed_networks 
                    list
                                                                 | Default: "REF_NetworkAny" | A list of allowed networks | 
| auth_profile 
                    -
                                                                 | The reference name of the auth profile | |
| backend 
                    -
                                                                 | Default: [] | A list of backends that are connected with this location declaration | 
| be_path 
                    -
                                                                 | The path of the backend | |
| comment 
                    -
                                                                 | The optional comment string | |
| denied_networks 
                    -
                                                                 | Default: [] | A list of denied network references | 
| headers 
                    dictionary
                                                                 | A dictionary of additional headers to be sent to POST and PUT requests. Is needed for some modules | |
| hot_standby 
                    boolean
                                                                 | 
 | Activate hot standby mode | 
| name 
                    -
                                             / required                     | The name of the object. Will be used to identify the entry | |
| path 
                    -
                                                                 | Default: "/" | The path of the location | 
| state 
                    string
                                                                 | 
 | The desired state of the object. presentwill create or update an objectabsentwill delete an object if it was present | 
| status 
                    boolean
                                                                 | 
 | Whether the location is active or not | 
| stickysession_id 
                    -
                                                                 | Default: "ROUTEID" | The stickysession id | 
| stickysession_status 
                    boolean
                                                                 | 
 | Enable the stickysession | 
| 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. | 
| websocket_passthrough 
                    boolean
                                                                 | 
 | Enable the websocket passthrough | 
Examples¶
- name: Create UTM proxy_location
  utm_proxy_backend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry
    backend: REF_OBJECT_STRING
    state: present
- name: Remove UTM proxy_location
  utm_proxy_backend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry
    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¶
- Johannes Brunswicker (@MatrixCrawler)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
