W3cubDocs

/Ansible

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 3.8.1).

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.

Parameters

Parameter Choices/Defaults Comments
access_control
string
    Choices:
  • 0 ←
  • 1
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
    Choices:
  • no ←
  • yes
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
    Choices:
  • absent
  • present ←
The desired state of the object.
present will create or update an object
absent will delete an object if it was present
status
boolean
    Choices:
  • no
  • yes ←
Whether the location is active or not
stickysession_id
string
Default:
"ROUTEID"
The stickysession id
stickysession_status
boolean
    Choices:
  • no ←
  • yes
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
    Choices:
  • http
  • https ←
The protocol of the REST Endpoint.
utm_token
string / required
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether the REST interface's ssl certificate should be verified or not.
websocket_passthrough
boolean
    Choices:
  • no ←
  • yes
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:

Key Returned Description
result
complex
success
The utm object that was created
_locked
boolean
success
Whether or not the object is currently locked
_ref
string
success
The reference name of the object
_type
string
success
The type of the object
access_control
string
success
Whether to use access control state
allowed_networks
list / elements=string
success
List of allowed network reference names
auth_profile
string
success
The auth profile reference name
backend
string
success
The backend reference name
be_path
string
success
The backend path
comment
string
success
The comment string
denied_networks
list / elements=string
success
The list of the denied network names
hot_standby
boolean
success
Use hot standy
name
string
success
The name of the object
path
string
success
Path name
status
boolean
success
Whether the object is active or not
stickysession_id
string
success
The identifier of the stickysession
stickysession_status
boolean
success
Whether to use stickysession or not
websocket_passthrough
boolean
success
Whether websocket passthrough will be used or not


Authors

  • Johannes Brunswicker (@MatrixCrawler)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/utm_proxy_location_module.html