community.general.utm_proxy_location_info – create, update or destroy reverse_proxy location entry in Sophos UTM

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.utm_proxy_location_info.

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
headers
dictionary
A dictionary of additional headers to be sent to POST and PUT requests.
Is needed for some modules
name
string / required
The name of the object. Will be used to identify the entry
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
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.

Examples

- name: Remove UTM proxy_location
  community.general.utm_proxy_location_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry

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)