community.general.utm_proxy_exception (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 exception 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: Create UTM proxy_exception
  community.general.utm_proxy_exception:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestExceptionEntry
    backend: REF_OBJECT_STRING
    state: present

Scanned by Steampunk Spotter

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

- name: Remove UTM proxy_exception
  community.general.utm_proxy_exception:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestExceptionEntry
    state: absent

Inputs

    
op:
    choices:
    - AND
    - OR
    default: AND
    description:
    - The operand to be used with the entries of the path parameter
    required: false
    type: str

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

path:
    default: []
    description:
    - The paths the exception in the reverse proxy is defined for
    elements: str
    required: false
    type: list

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

skipav:
    default: false
    description:
    - Skip the Antivirus Scanning
    required: false
    type: bool

source:
    default: []
    description:
    - Define which categories of threats are skipped
    elements: str
    required: false
    type: list

status:
    default: true
    description:
    - Status of the exception rule set
    required: false
    type: bool

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

skiptft:
    default: false
    description:
    - Enable true file type control
    required: false
    type: bool

skipurl:
    default: false
    description:
    - Enable static URL hardening
    required: false
    type: bool

skipform:
    default: false
    description:
    - Enable form hardening
    required: false
    type: bool

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

skipcookie:
    default: false
    description:
    - Skip the Cookie Signing check
    required: false
    type: bool

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

skipbadclients:
    default: false
    description:
    - Block clients with bad reputation
    required: false
    type: bool

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

skiphtmlrewrite:
    default: false
    description:
    - Protection against SQL
    required: false
    type: bool

skipform_missingtoken:
    default: false
    description:
    - Enable form hardening with missing tokens
    required: false
    type: bool

skip_custom_threats_filters:
    default: []
    description:
    - A list of threats to be skipped
    elements: str
    required: false
    type: list

skip_threats_filter_categories:
    default: []
    description:
    - Define which categories of threats are skipped
    elements: str
    required: false
    type: list

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
    comment:
      description: The optional comment string
      type: str
    name:
      description: The name of the object
      type: str
    op:
      description: The operand to be used with the entries of the path parameter
      type: str
    path:
      description: The paths the exception in the reverse proxy is defined for
      type: list
    skip_custom_threats_filters:
      description: A list of threats to be skipped
      type: list
    skip_threats_filter_categories:
      description: Define which categories of threats are skipped
      type: list
    skipav:
      description: Skip the Antivirus Scanning
      type: bool
    skipbadclients:
      description: Block clients with bad reputation
      type: bool
    skipcookie:
      description: Skip the Cookie Signing check
      type: bool
    skipform:
      description: Enable form hardening
      type: bool
    skipform_missingtoken:
      description: Enable form hardening with missing tokens
      type: bool
    skiphtmlrewrite:
      description: Protection against SQL
      type: bool
    skiptft:
      description: Enable true file type control
      type: bool
    skipurl:
      description: Enable static URL hardening
      type: bool
    source:
      description: Define which categories of threats are skipped
      type: list
  description: The utm object that was created
  returned: success
  type: complex