community.general.utm_proxy_location – create, update or destroy reverse_proxy location 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_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.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
access_control
string
|
|
whether to activate the access control for the location
|
allowed_networks
list
/ elements=string
|
Default: "REF_NetworkAny"
|
A list of allowed networks
|
auth_profile
string
|
The reference name of the auth profile
|
|
backend
list
/ elements=string
|
Default: []
|
A list of backends that are connected with this location declaration
|
be_path
string
|
The path of the backend
|
|
comment
string
|
The optional comment string
|
|
denied_networks
list
/ elements=string
|
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
string
/ required
|
The name of the object. Will be used to identify the entry
|
|
path
string
|
Default: "/"
|
The path of the location
|
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 the location is active or not
|
stickysession_id
string
|
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:
Authors¶
Johannes Brunswicker (@MatrixCrawler)