community.general.utm_proxy_location module – Create, update or destroy reverse_proxy location 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_location
.
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.
Aliases: web_infrastructure.sophos_utm.utm_proxy_location
Parameters
Parameter |
Comments |
---|---|
whether to activate the access control for the location Choices:
|
|
A list of allowed networks Default: |
|
The reference name of the auth profile Default: |
|
A list of backends that are connected with this location declaration Default: |
|
The path of the backend Default: |
|
The optional comment string Default: |
|
A list of denied network references Default: |
|
A dictionary of additional headers to be sent to POST and PUT requests. Is needed for some modules. Default: |
|
Activate hot standby mode Choices:
|
|
The name of the object. Will be used to identify the entry |
|
The path of the location Default: |
|
The desired state of the object.
Choices:
|
|
Whether the location is active or not Choices:
|
|
The stickysession id Default: |
|
Enable the stickysession 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:
|
|
Enable the websocket passthrough 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_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:
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 use access control state Returned: success |
|
List of allowed network reference names Returned: success |
|
The auth profile reference name Returned: success |
|
The backend reference name Returned: success |
|
The backend path Returned: success |
|
The comment string Returned: success |
|
The list of the denied network names Returned: success |
|
Use hot standby Returned: success |
|
The name of the object Returned: success |
|
Path name Returned: success |
|
Whether the object is active or not Returned: success |
|
The identifier of the stickysession Returned: success |
|
Whether to use stickysession or not Returned: success |
|
Whether websocket passthrough will be used or not Returned: success |