community.general.utm_proxy_frontend – create, update or destroy reverse_proxy frontend entry in Sophos UTM¶
Note
This plugin is part of the community.general collection (version 2.5.1).
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 | Choices/Defaults | Comments |
---|---|---|
add_content_type_header
boolean
|
|
Whether to add the content type header or not
|
address
string
|
Default: "REF_DefaultInternalAddress"
|
The reference name of the network/interface_address object.
|
allowed_networks
list
/ elements=string
|
Default: ["REF_NetworkAny"]
|
A list of reference names for the allowed networks.
|
certificate
string
|
Default: ""
|
The reference name of the ca/host_key_cert object.
|
comment
string
|
Default: ""
|
An optional comment to add to the object
|
disable_compression
boolean
|
|
Whether to enable the compression
|
domain
list
/ elements=string
|
A list of domain names for the frontend object
|
|
exceptions
list
/ elements=string
|
Default: []
|
A list of exception ref names (reverse_proxy/exception)
|
headers
dictionary
|
A dictionary of additional headers to be sent to POST and PUT requests.
Is needed for some modules
|
|
htmlrewrite
boolean
|
|
Whether to enable html rewrite or not
|
htmlrewrite_cookies
boolean
|
|
Whether to enable html rewrite cookie or not
|
implicitredirect
boolean
|
|
Whether to enable implicit redirection or not
|
lbmethod
string
|
|
Which loadbalancer method should be used
|
locations
list
/ elements=string
|
Default: []
|
A list of location ref names (reverse_proxy/location)
|
name
string
/ required
|
The name of the object. Will be used to identify the entry
|
|
port
integer
|
Default: 80
|
The frontend http port
|
preservehost
boolean
|
|
Whether to preserve host header
|
profile
string
|
Default: ""
|
The reference string of the reverse_proxy/profile
|
state
string
|
|
The desired state of the object.
present will create or update an objectabsent will delete an object if it was present |
status
boolean
|
|
Whether to activate the frontend entry or not
|
type
string
|
|
Which protocol should be used
|
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.
|
xheaders
boolean
|
|
Whether to pass the host header or not
|
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:
Authors¶
Johannes Brunswicker (@MatrixCrawler)