community.general.utm_proxy_frontend_info (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - The name of the object. Will be used to identify the entry
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The desired state of the object.
    - V(present) will create or update an object.
    - V(absent) will delete an object if it was present.
    type: str

headers:
    default: {}
    description:
    - A dictionary of additional headers to be sent to POST and PUT requests.
    - Is needed for some modules.
    required: false
    type: dict

utm_host:
    description:
    - The REST Endpoint of the Sophos UTM.
    required: true
    type: str

utm_port:
    default: 4444
    description:
    - The port of the REST interface.
    type: int

utm_token:
    description:
    - The token used to identify at the REST-API. See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en),
      Chapter 2.4.2.
    required: true
    type: str

utm_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - The protocol of the REST Endpoint.
    type: str

validate_certs:
    default: true
    description:
    - Whether the REST interface's ssl certificate should be verified or not.
    type: bool

Outputs

result:
  contains:
    _locked:
      description: Whether or not the object is currently locked
      type: bool
    _ref:
      description: The reference name of the object
      type: str
    _type:
      description: The type of the object
      type: str
    add_content_type_header:
      description: Whether to add the content type header
      type: bool
    address:
      description: The reference name of the address
      type: str
    allowed_networks:
      description: List of reference names of networks associated
      type: list
    certificate:
      description: Reference name of certificate (ca/host_key_cert)
      type: str
    comment:
      description: The comment string
      type: str
    disable_compression:
      description: State of compression support
      type: bool
    domain:
      description: List of hostnames
      type: list
    exceptions:
      description: List of associated proxy exceptions
      type: list
    htmlrewrite:
      description: State of html rewrite
      type: bool
    htmlrewrite_cookies:
      description: whether the html rewrite cookie will be set
      type: bool
    implicitredirect:
      description: whether to use implicit redirection
      type: bool
    lbmethod:
      description: The method of loadbalancer to use
      type: str
    locations:
      description: The reference names of reverse_proxy/locations associated with
        the object
      type: list
    name:
      description: The name of the object
      type: str
    port:
      description: The port of the frontend connection
      type: int
    preservehost:
      description: Preserve host header
      type: bool
    profile:
      description: The associated reverse_proxy/profile
      type: str
    status:
      description: Whether the frontend object is active or not
      type: bool
    type:
      description: The connection type
      type: str
    xheaders:
      description: The xheaders state
      type: bool
  description: The utm object that was created
  returned: success
  type: complex