mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-20 01:11:26 -07:00
[PR #9335/c141f868 backport][stable-9] utm*: normalize docs (#9345)
utm*: normalize docs (#9335)
* utm*: normalize docs
* Update plugins/modules/utm_aaa_group.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit c141f86883)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot]
GitHub
parent
5d094c3bf3
commit
961ba0ddcc
13 changed files with 1487 additions and 1525 deletions
|
|
@ -9,130 +9,127 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: utm_proxy_exception
|
||||
|
||||
author:
|
||||
- Sebastian Schenzel (@RickS-C137)
|
||||
- Sebastian Schenzel (@RickS-C137)
|
||||
|
||||
short_description: Create, update or destroy reverse_proxy exception entry in Sophos UTM
|
||||
|
||||
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.
|
||||
|
||||
- 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.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- The name of the object. Will be used to identify the entry
|
||||
required: true
|
||||
type: str
|
||||
op:
|
||||
description:
|
||||
- The operand to be used with the entries of the path parameter
|
||||
default: 'AND'
|
||||
choices:
|
||||
- 'AND'
|
||||
- 'OR'
|
||||
required: false
|
||||
type: str
|
||||
path:
|
||||
description:
|
||||
- The paths the exception in the reverse proxy is defined for
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
skip_custom_threats_filters:
|
||||
description:
|
||||
- A list of threats to be skipped
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
skip_threats_filter_categories:
|
||||
description:
|
||||
- Define which categories of threats are skipped
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
skipav:
|
||||
description:
|
||||
- Skip the Antivirus Scanning
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipbadclients:
|
||||
description:
|
||||
- Block clients with bad reputation
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipcookie:
|
||||
description:
|
||||
- Skip the Cookie Signing check
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipform:
|
||||
description:
|
||||
- Enable form hardening
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipform_missingtoken:
|
||||
description:
|
||||
- Enable form hardening with missing tokens
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skiphtmlrewrite:
|
||||
description:
|
||||
- Protection against SQL
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skiptft:
|
||||
description:
|
||||
- Enable true file type control
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipurl:
|
||||
description:
|
||||
- Enable static URL hardening
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
source:
|
||||
description:
|
||||
- Define which categories of threats are skipped
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
status:
|
||||
description:
|
||||
- Status of the exception rule set
|
||||
default: true
|
||||
type: bool
|
||||
required: false
|
||||
name:
|
||||
description:
|
||||
- The name of the object. Will be used to identify the entry.
|
||||
required: true
|
||||
type: str
|
||||
op:
|
||||
description:
|
||||
- The operand to be used with the entries of the path parameter.
|
||||
default: 'AND'
|
||||
choices:
|
||||
- 'AND'
|
||||
- 'OR'
|
||||
required: false
|
||||
type: str
|
||||
path:
|
||||
description:
|
||||
- The paths the exception in the reverse proxy is defined for.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
skip_custom_threats_filters:
|
||||
description:
|
||||
- A list of threats to be skipped.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
skip_threats_filter_categories:
|
||||
description:
|
||||
- Define which categories of threats are skipped.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
skipav:
|
||||
description:
|
||||
- Skip the Antivirus Scanning.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipbadclients:
|
||||
description:
|
||||
- Block clients with bad reputation.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipcookie:
|
||||
description:
|
||||
- Skip the Cookie Signing check.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipform:
|
||||
description:
|
||||
- Enable form hardening.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipform_missingtoken:
|
||||
description:
|
||||
- Enable form hardening with missing tokens.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skiphtmlrewrite:
|
||||
description:
|
||||
- Protection against SQL.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skiptft:
|
||||
description:
|
||||
- Enable true file type control.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
skipurl:
|
||||
description:
|
||||
- Enable static URL hardening.
|
||||
default: false
|
||||
type: bool
|
||||
required: false
|
||||
source:
|
||||
description:
|
||||
- Define which categories of threats are skipped.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
required: false
|
||||
status:
|
||||
description:
|
||||
- Status of the exception rule set.
|
||||
default: true
|
||||
type: bool
|
||||
required: false
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.utm
|
||||
- community.general.attributes
|
||||
- community.general.utm
|
||||
- community.general.attributes
|
||||
"""
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
EXAMPLES = r"""
|
||||
- name: Create UTM proxy_exception
|
||||
community.general.utm_proxy_exception:
|
||||
utm_host: sophos.host.name
|
||||
|
|
@ -149,66 +146,66 @@ EXAMPLES = """
|
|||
state: absent
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
RETURN = r"""
|
||||
result:
|
||||
description: The utm object that was created
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
_ref:
|
||||
description: The reference name of the object
|
||||
type: str
|
||||
_locked:
|
||||
description: Whether or not the object is currently locked
|
||||
type: bool
|
||||
_type:
|
||||
description: The type of the object
|
||||
type: str
|
||||
name:
|
||||
description: The name of the object
|
||||
type: str
|
||||
comment:
|
||||
description: The optional comment string
|
||||
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
|
||||
contains:
|
||||
_ref:
|
||||
description: The reference name of the object.
|
||||
type: str
|
||||
_locked:
|
||||
description: Whether or not the object is currently locked.
|
||||
type: bool
|
||||
_type:
|
||||
description: The type of the object.
|
||||
type: str
|
||||
name:
|
||||
description: The name of the object.
|
||||
type: str
|
||||
comment:
|
||||
description: The optional comment string.
|
||||
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
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue