utm_proxy_frontend_info – create, update or destroy reverse_proxy frontend entry in Sophos UTM
New in version 2.8.
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 - / 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 objectabsent 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 |
| 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. |
Examples
- name: Get utm proxy_frontend 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 | Whether or not the object is currently locked | ||
_ref string | The reference name of the object | ||
_type string | The type of the object | ||
add_content_type_header boolean | Whether to add the content type header | ||
address string | The reference name of the address | ||
allowed_networks list | List of reference names of networks associated | ||
certificate string | Reference name of certificate (ca/host_key_cert) | ||
comment string | The comment string | ||
disable_compression boolean | State of compression support | ||
domain list | List of hostnames | ||
exceptions list | List of associated proxy exceptions | ||
htmlrewrite boolean | State of html rewrite | ||
htmlrewrite_cookies boolean | whether the html rewrite cookie will be set | ||
implicitredirect boolean | whether to use implicit redirection | ||
lbmethod string | The method of loadbalancer to use | ||
locations list | The reference names of reverse_proxy/locations associated with the object | ||
name string | The name of the object | ||
port integer | The port of the frontend connection | ||
preservehost boolean | Preserve host header | ||
profile string | The associated reverse_proxy/profile | ||
status boolean | Whether the frontend object is active or not | ||
type string | The connection type | ||
xheaders boolean | The xheaders state |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Johannes Brunswicker (@MatrixCrawler)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/utm_proxy_frontend_info_module.html