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

Note

This module is part of the community.general collection (version 10.2.0).

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_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

Comments

headers

dictionary

A dictionary of additional headers to be sent to POST and PUT requests.

Is needed for some modules.

Default: {}

name

string / required

The name of the object. Will be used to identify the entry.

state

string

The desired state of the object.

present will create or update an object.

absent will delete an object if it was present.

Choices:

  • "absent"

  • "present" ← (default)

utm_host

string / required

The REST Endpoint of the Sophos UTM.

utm_port

integer

The port of the REST interface.

Default: 4444

utm_protocol

string

The protocol of the REST Endpoint.

Choices:

  • "http"

  • "https" ← (default)

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.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

added in community.general 3.3.0

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

Description

result

complex

The utm object that was created.

Returned: success

_locked

boolean

Whether or not the object is currently locked.

Returned: success

_ref

string

The reference name of the object.

Returned: success

_type

string

The type of the object.

Returned: success

access_control

string

Whether to use access control state.

Returned: success

allowed_networks

list / elements=string

List of allowed network reference names.

Returned: success

auth_profile

string

The auth profile reference name.

Returned: success

backend

string

The backend reference name.

Returned: success

be_path

string

The backend path.

Returned: success

comment

string

The comment string.

Returned: success

denied_networks

list / elements=string

The list of the denied network names.

Returned: success

hot_standby

boolean

Use hot standby.

Returned: success

name

string

The name of the object.

Returned: success

path

string

Path name.

Returned: success

status

boolean

Whether the object is active or not.

Returned: success

stickysession_id

string

The identifier of the stickysession.

Returned: success

stickysession_status

boolean

Whether to use stickysession or not.

Returned: success

websocket_passthrough

boolean

Whether websocket passthrough will be used or not.

Returned: success

Authors

  • Johannes Brunswicker (@MatrixCrawler)