community.general.utm_proxy_frontend module – Create, update or destroy reverse_proxy frontend entry in Sophos UTM
Note
This module is part of the community.general collection (version 5.8.3).
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
.
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 |
---|---|
Whether to add the content type header or not Choices:
|
|
The reference name of the network/interface_address object. Default: |
|
A list of reference names for the allowed networks. Default: |
|
The reference name of the ca/host_key_cert object. Default: |
|
An optional comment to add to the object Default: |
|
Whether to enable the compression Choices:
|
|
A list of domain names for the frontend object |
|
A list of exception ref names (reverse_proxy/exception) Default: |
|
A dictionary of additional headers to be sent to POST and PUT requests. Is needed for some modules Default: |
|
Whether to enable html rewrite or not Choices:
|
|
Whether to enable html rewrite cookie or not Choices:
|
|
Whether to enable implicit redirection or not Choices:
|
|
Which loadbalancer method should be used Choices:
|
|
A list of location ref names (reverse_proxy/location) Default: |
|
The name of the object. Will be used to identify the entry |
|
The frontend http port Default: |
|
Whether to preserve host header Choices:
|
|
The reference string of the reverse_proxy/profile Default: |
|
The desired state of the object.
Choices:
|
|
Whether to activate the frontend entry or not Choices:
|
|
Which protocol should be used 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%3Den, Chapter 2.4.2. |
|
Whether the REST interface’s ssl certificate should be verified or not. Choices:
|
|
Whether to pass the host header or not Choices:
|
Examples
- name: Create utm proxy_frontend
community.general.utm_proxy_frontend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestFrontendEntry
host: REF_OBJECT_STRING
state: present
- name: Remove utm proxy_frontend
community.general.utm_proxy_frontend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestFrontendEntry
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 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 |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication