community.general.utm_proxy_frontend_info – create, update or destroy reverse_proxy frontend 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_frontend_info.

Synopsis
Parameters
Examples
Return Values

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
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		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	Choices: no yes ←	Whether the REST interface's ssl certificate should be verified or not.

Examples

- name: Get utm proxy_frontend
  community.general.utm_proxy_frontend_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestBackendEntry
    host: REF_OBJECT_STRING

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
	add_content_type_header boolean	success	Whether to add the content type header
	address string	success	The reference name of the address
	allowed_networks list / elements=string	success	List of reference names of networks associated
	certificate string	success	Reference name of certificate (ca/host_key_cert)
	comment string	success	The comment string
	disable_compression boolean	success	State of compression support
	domain list / elements=string	success	List of hostnames
	exceptions list / elements=string	success	List of associated proxy exceptions
	htmlrewrite boolean	success	State of html rewrite
	htmlrewrite_cookies boolean	success	whether the html rewrite cookie will be set
	implicitredirect boolean	success	whether to use implicit redirection
	lbmethod string	success	The method of loadbalancer to use
	locations list / elements=string	success	The reference names of reverse_proxy/locations associated with the object
	name string	success	The name of the object
	port integer	success	The port of the frontend connection
	preservehost boolean	success	Preserve host header
	profile string	success	The associated reverse_proxy/profile
	status boolean	success	Whether the frontend object is active or not
	type string	success	The connection type
	xheaders boolean	success	The xheaders state

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_frontend_info_module.html