a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
pull/9322/head
Alexei Znamensky 2024-12-24 09:30:11 +13:00 committed by GitHub
parent d5237ee486
commit c141f86883
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 1487 additions and 1525 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
plugins/modules/utm_aaa_group.py
View File

@ -8,8 +8,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_aaa_group
author:
@ -20,7 +19,6 @@ short_description: Create, update or destroy an aaa group object in Sophos UTM
description:
- Create, update or destroy an aaa group object in Sophos UTM.
- This module needs to have the REST Ability of the UTM to be activated.
attributes:
check_mode:
support: none
@ -99,7 +97,7 @@ options:
default: []
network:
description:
- The network reference name. The objects contains the known ip addresses for the authentication object (network/aaa).
- The network reference name. The objects contains the known IP addresses for the authentication object (network/aaa).
type: str
default: ""
radius_groups:
@ -116,12 +114,11 @@ options:
default: []
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.utm
- community.general.attributes
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Create UTM aaa_group
community.general.utm_aaa_group:
utm_host: sophos.host.name
@ -142,7 +139,7 @@ EXAMPLES = """
state: absent
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created.
returned: success
@ -179,7 +176,7 @@ result:
description: List of eDirectory Groups.
type: str
ipsec_dn:
description: ipsec_dn identifier to match.
description: Ipsec_dn identifier to match.
type: str
ldap_attribute:
description: The LDAP Attribute to match against.

51
plugins/modules/utm_aaa_group_info.py
View File

@ -10,8 +10,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_aaa_group_info
author:
@ -20,8 +19,7 @@ author:
short_description: Get info for reverse_proxy frontend entry in Sophos UTM
description:
- get info for a reverse_proxy frontend entry in SOPHOS UTM.
- Get info for a reverse_proxy frontend entry in SOPHOS UTM.
attributes:
check_mode:
version_added: 3.3.0
@ -31,17 +29,16 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.attributes.info_module
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Remove UTM aaa_group
community.general.utm_aaa_group_info:
utm_host: sophos.host.name
@ -49,62 +46,62 @@ EXAMPLES = """
name: TestAAAGroupEntry
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
adirectory_groups:
description: List of Active Directory Groups
description: List of Active Directory Groups.
type: str
adirectory_groups_sids:
description: List of Active Directory Groups SIDS
description: List of Active Directory Groups SIDS.
type: list
backend_match:
description: The backend to use
description: The backend to use.
type: str
comment:
description: The comment string
description: The comment string.
type: str
dynamic:
description: Whether the group match is ipsec_dn or directory_group
description: Whether the group match is ipsec_dn or directory_group.
type: str
edirectory_groups:
description: List of eDirectory Groups
description: List of eDirectory Groups.
type: str
ipsec_dn:
description: ipsec_dn identifier to match
description: Ipsec_dn identifier to match.
type: str
ldap_attribute:
description: The LDAP Attribute to match against
description: The LDAP Attribute to match against.
type: str
ldap_attribute_value:
description: The LDAP Attribute Value to match against
description: The LDAP Attribute Value to match against.
type: str
members:
description: List of member identifiers of the group
description: List of member identifiers of the group.
type: list
network:
description: The identifier of the network (network/aaa)
description: The identifier of the network (network/aaa).
type: str
radius_group:
description: The radius group identifier
description: The radius group identifier.
type: str
tacacs_group:
description: The tacacs group identifier
description: The tacacs group identifier.
type: str
"""

34
plugins/modules/utm_ca_host_key_cert.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_ca_host_key_cert
author:
@ -21,7 +20,6 @@ short_description: Create, update or destroy ca host_key_cert entry in Sophos UT
description:
- Create, update or destroy a ca host_key_cert entry in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
attributes:
check_mode:
support: none
@ -64,12 +62,11 @@ options:
type: str
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.utm
- community.general.attributes
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Create a ca_host_key_cert entry
community.general.utm_ca_host_key_cert:
utm_host: sophos.host.name
@ -98,26 +95,25 @@ EXAMPLES = """
utm_token: abcdefghijklmno1234
name: TestHostKeyCertEntry
state: info
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
ca:
description: A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object.
@ -126,16 +122,16 @@ result:
description: A reference to an existing utm_ca_meta_x509 object.
type: str
certificate:
description: The certificate in PEM format
description: The certificate in PEM format.
type: str
comment:
description: Comment string (may be empty string)
description: Comment string (may be empty string).
type: str
encrypted:
description: If encryption is enabled
description: If encryption is enabled.
type: bool
key:
description: Private key in PEM format (may be empty string)
description: Private key in PEM format (may be empty string).
type: str
"""

30
plugins/modules/utm_ca_host_key_cert_info.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_ca_host_key_cert_info
author:
@ -20,7 +19,6 @@ short_description: Get info for a ca host_key_cert entry in Sophos UTM
description:
- Get info for a ca host_key_cert entry in SOPHOS UTM.
attributes:
check_mode:
version_added: 3.3.0
@ -30,16 +28,16 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.attributes.info_module
'''
"""
EXAMPLES = """
EXAMPLES = r"""
- name: Get info for a ca host_key_cert entry
community.general.utm_ca_host_key_cert_info:
utm_host: sophos.host.name
@ -47,23 +45,23 @@ EXAMPLES = """
name: TestHostKeyCertEntry
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
ca:
description: A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object.
@ -72,16 +70,16 @@ result:
description: A reference to an existing utm_ca_meta_x509 object.
type: str
certificate:
description: The certificate in PEM format
description: The certificate in PEM format.
type: str
comment:
description: Comment string (may be empty string)
description: Comment string (may be empty string).
type: str
encrypted:
description: If encryption is enabled
description: If encryption is enabled.
type: bool
key:
description: Private key in PEM format (may be empty string)
description: Private key in PEM format (may be empty string).
type: str
"""

53
plugins/modules/utm_dns_host.py
View File

@ -8,8 +8,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_dns_host
author:
@ -20,7 +19,6 @@ short_description: Create, update or destroy dns entry in Sophos UTM
description:
- Create, update or destroy a dns entry in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
attributes:
check_mode:
support: none
@ -31,7 +29,7 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
address:
type: str
@ -46,40 +44,39 @@ options:
comment:
type: str
description:
- An optional comment to add to the dns host object
- An optional comment to add to the dns host object.
default: ''
hostname:
type: str
description:
- The hostname for the dns host object
- The hostname for the dns host object.
interface:
type: str
description:
- The reference name of the interface to use. If not provided the default interface will be used
- The reference name of the interface to use. If not provided the default interface will be used.
default: ''
resolved:
description:
- whether the hostname's ipv4 address is already resolved or not
- Whether the hostname's ipv4 address is already resolved or not.
default: false
type: bool
resolved6:
description:
- whether the hostname's ipv6 address is already resolved or not
- Whether the hostname's ipv6 address is already resolved or not.
default: false
type: bool
timeout:
type: int
description:
- the timeout for the utm to resolve the ip address for the hostname again
- The timeout for the utm to resolve the ip address for the hostname again.
default: 0
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.utm
- community.general.attributes
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Create UTM dns host entry
community.general.utm_dns_host:
utm_host: sophos.host.name
@ -96,44 +93,44 @@ EXAMPLES = """
state: absent
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
name:
description: The name of the object
description: The name of the object.
type: str
address:
description: The ipv4 address of the object
description: The ipv4 address of the object.
type: str
address6:
description: The ipv6 address of the object
description: The ipv6 address of the object.
type: str
comment:
description: The comment string
description: The comment string.
type: str
hostname:
description: The hostname of the object
description: The hostname of the object.
type: str
interface:
description: The reference name of the interface the object is associated with
description: The reference name of the interface the object is associated with.
type: str
resolved:
description: Whether the ipv4 address is resolved or not
description: Whether the ipv4 address is resolved or not.
type: bool
resolved6:
description: Whether the ipv6 address is resolved or not
description: Whether the ipv6 address is resolved or not.
type: bool
timeout:
description: The timeout until a new resolving will be attempted
description: The timeout until a new resolving will be attempted.
type: int
"""

44
plugins/modules/utm_network_interface_address.py
View File

@ -8,8 +8,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_network_interface_address
author:
@ -20,7 +19,6 @@ short_description: Create, update or destroy network/interface_address object
description:
- Create, update or destroy a network/interface_address object in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
attributes:
check_mode:
support: none
@ -31,7 +29,7 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
address:
type: str
@ -46,24 +44,22 @@ options:
comment:
type: str
description:
- An optional comment to add to the object
- An optional comment to add to the object.
default: ''
resolved:
type: bool
description:
- Whether or not the object is resolved
- Whether or not the object is resolved.
resolved6:
type: bool
description:
- Whether or not the object is resolved
- Whether or not the object is resolved.
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.utm
- community.general.attributes
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Create a network interface address
utm_proxy_backend:
utm_host: sophos.host.name
@ -81,38 +77,38 @@ EXAMPLES = """
state: absent
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
address:
description: The ip4 address of the network/interface_address object
description: The ip4 address of the network/interface_address object.
type: str
address6:
description: The ip6 address of the network/interface_address object
description: The ip6 address of the network/interface_address object.
type: str
comment:
description: The comment string
description: The comment string.
type: str
resolved:
description: Whether or not the object is resolved
description: Whether or not the object is resolved.
type: bool
resolved6:
description: Whether or not the object is resolved
description: Whether or not the object is resolved.
type: bool
"""

32
plugins/modules/utm_network_interface_address_info.py
View File

@ -8,8 +8,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_network_interface_address_info
author:
@ -19,7 +18,6 @@ short_description: Get info for a network/interface_address object
description:
- Get info for a network/interface_address object in SOPHOS UTM.
attributes:
check_mode:
version_added: 3.3.0
@ -29,16 +27,16 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.attributes.info_module
'''
"""
EXAMPLES = """
EXAMPLES = r"""
- name: Get network interface address info
utm_proxy_interface_address_info:
utm_host: sophos.host.name
@ -46,38 +44,38 @@ EXAMPLES = """
name: TestNetworkInterfaceAddress
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
address:
description: The ip4 address of the network/interface_address object
description: The ip4 address of the network/interface_address object.
type: str
address6:
description: The ip6 address of the network/interface_address object
description: The ip6 address of the network/interface_address object.
type: str
comment:
description: The comment string
description: The comment string.
type: str
resolved:
description: Whether or not the object is resolved
description: Whether or not the object is resolved.
type: bool
resolved6:
description: Whether or not the object is resolved
description: Whether or not the object is resolved.
type: bool
"""

128
plugins/modules/utm_proxy_auth_profile.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_proxy_auth_profile
author:
@ -21,7 +20,6 @@ short_description: Create, update or destroy reverse_proxy auth_profile entry in
description:
- Create, update or destroy a reverse_proxy auth_profile entry in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
attributes:
check_mode:
support: none
@ -32,76 +30,76 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
aaa:
type: list
elements: str
description:
- List of references to utm_aaa objects (allowed users or groups)
- List of references to utm_aaa objects (allowed users or groups).
required: true
basic_prompt:
type: str
description:
- The message in the basic authentication prompt
- The message in the basic authentication prompt.
required: true
backend_mode:
type: str
description:
- Specifies if the backend server needs authentication ([Basic|None])
- Specifies if the backend server needs authentication ([Basic|None]).
default: None
choices:
- Basic
- None
backend_strip_basic_auth:
description:
- Should the login data be stripped when proxying the request to the backend host
- Should the login data be stripped when proxying the request to the backend host.
type: bool
default: true
backend_user_prefix:
type: str
description:
- Prefix string to prepend to the username for backend authentication
- Prefix string to prepend to the username for backend authentication.
default: ""
backend_user_suffix:
type: str
description:
- Suffix string to append to the username for backend authentication
- Suffix string to append to the username for backend authentication.
default: ""
comment:
type: str
description:
- Optional comment string
- Optional comment string.
default: ""
frontend_cookie:
type: str
description:
- Frontend cookie name
- Frontend cookie name.
frontend_cookie_secret:
type: str
description:
- Frontend cookie secret
- Frontend cookie secret.
frontend_form:
type: str
description:
- Frontend authentication form name
- Frontend authentication form name.
frontend_form_template:
type: str
description:
- Frontend authentication form template
- Frontend authentication form template.
default: ""
frontend_login:
type: str
description:
- Frontend login name
- Frontend login name.
frontend_logout:
type: str
description:
- Frontend logout name
- Frontend logout name.
frontend_mode:
type: str
description:
- Frontend authentication mode (Form|Basic)
- Frontend authentication mode (Form|Basic).
default: Basic
choices:
- Basic
@ -109,26 +107,26 @@ options:
frontend_realm:
type: str
description:
- Frontend authentication realm
- Frontend authentication realm.
frontend_session_allow_persistency:
description:
- Allow session persistency
- Allow session persistency.
type: bool
default: false
frontend_session_lifetime:
type: int
description:
- session lifetime
- Session lifetime.
required: true
frontend_session_lifetime_limited:
description:
- Specifies if limitation of session lifetime is active
- Specifies if limitation of session lifetime is active.
type: bool
default: true
frontend_session_lifetime_scope:
type: str
description:
- scope for frontend_session_lifetime (days|hours|minutes)
- Scope for frontend_session_lifetime (days|hours|minutes).
default: hours
choices:
- days
@ -137,17 +135,17 @@ options:
frontend_session_timeout:
type: int
description:
- session timeout
- Session timeout.
required: true
frontend_session_timeout_enabled:
description:
- Specifies if session timeout is active
- Specifies if session timeout is active.
type: bool
default: true
frontend_session_timeout_scope:
type: str
description:
- scope for frontend_session_timeout (days|hours|minutes)
- Scope for frontend_session_timeout (days|hours|minutes).
default: minutes
choices:
- days
@ -157,35 +155,34 @@ options:
type: list
elements: str
description:
- List of logout URLs that logouts are delegated to
- List of logout URLs that logouts are delegated to.
default: []
logout_mode:
type: str
description:
- Mode of logout (None|Delegation)
- Mode of logout (None|Delegation).
default: None
choices:
- None
- Delegation
redirect_to_requested_url:
description:
- Should a redirect to the requested URL be made
- Should a redirect to the requested URL be made.
type: bool
default: false
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.utm
- community.general.attributes
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Create UTM proxy_auth_profile
community.general.utm_proxy_auth_profile:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAuthProfileEntry
aaa: [REF_OBJECT_STRING,REF_ANOTHEROBJECT_STRING]
aaa: [REF_OBJECT_STRING, REF_ANOTHEROBJECT_STRING]
basic_prompt: "Authentication required: Please login"
frontend_session_lifetime: 1
frontend_session_timeout: 1
@ -204,98 +201,97 @@ EXAMPLES = """
utm_token: abcdefghijklmno1234
name: TestAuthProfileEntry
state: info
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
aaa:
description: List of references to utm_aaa objects (allowed users or groups)
description: List of references to utm_aaa objects (allowed users or groups).
type: list
basic_prompt:
description: The message in the basic authentication prompt
description: The message in the basic authentication prompt.
type: str
backend_mode:
description: Specifies if the backend server needs authentication ([Basic|None])
description: Specifies if the backend server needs authentication ([Basic|None]).
type: str
backend_strip_basic_auth:
description: Should the login data be stripped when proxying the request to the backend host
description: Should the login data be stripped when proxying the request to the backend host.
type: bool
backend_user_prefix:
description: Prefix string to prepend to the username for backend authentication
description: Prefix string to prepend to the username for backend authentication.
type: str
backend_user_suffix:
description: Suffix string to append to the username for backend authentication
description: Suffix string to append to the username for backend authentication.
type: str
comment:
description: Optional comment string
description: Optional comment string.
type: str
frontend_cookie:
description: Frontend cookie name
description: Frontend cookie name.
type: str
frontend_form:
description: Frontend authentication form name
description: Frontend authentication form name.
type: str
frontend_form_template:
description: Frontend authentication form template
description: Frontend authentication form template.
type: str
frontend_login:
description: Frontend login name
description: Frontend login name.
type: str
frontend_logout:
description: Frontend logout name
description: Frontend logout name.
type: str
frontend_mode:
description: Frontend authentication mode (Form|Basic)
description: Frontend authentication mode (Form|Basic).
type: str
frontend_realm:
description: Frontend authentication realm
description: Frontend authentication realm.
type: str
frontend_session_allow_persistency:
description: Allow session persistency
description: Allow session persistency.
type: bool
frontend_session_lifetime:
description: session lifetime
description: Session lifetime.
type: int
frontend_session_lifetime_limited:
description: Specifies if limitation of session lifetime is active
description: Specifies if limitation of session lifetime is active.
type: bool
frontend_session_lifetime_scope:
description: scope for frontend_session_lifetime (days|hours|minutes)
description: Scope for frontend_session_lifetime (days|hours|minutes).
type: str
frontend_session_timeout:
description: session timeout
description: Session timeout.
type: int
frontend_session_timeout_enabled:
description: Specifies if session timeout is active
description: Specifies if session timeout is active.
type: bool
frontend_session_timeout_scope:
description: scope for frontend_session_timeout (days|hours|minutes)
description: Scope for frontend_session_timeout (days|hours|minutes).
type: str
logout_delegation_urls:
description: List of logout URLs that logouts are delegated to
description: List of logout URLs that logouts are delegated to.
type: list
logout_mode:
description: Mode of logout (None|Delegation)
description: Mode of logout (None|Delegation).
type: str
redirect_to_requested_url:
description: Should a redirect to the requested URL be made
description: Should a redirect to the requested URL be made.
type: bool
"""

83
plugins/modules/utm_proxy_exception.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_proxy_exception
author:
@ -21,7 +20,6 @@ short_description: Create, update or destroy reverse_proxy exception entry in So
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.
attributes:
check_mode:
support: none
@ -31,12 +29,12 @@ attributes:
options:
name:
description:
- The name of the object. Will be used to identify the entry
- 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
- The operand to be used with the entries of the path parameter.
default: 'AND'
choices:
- 'AND'
@ -45,94 +43,93 @@ options:
type: str
path:
description:
- The paths the exception in the reverse proxy is defined for
- 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
- 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
- Define which categories of threats are skipped.
type: list
elements: str
default: []
required: false
skipav:
description:
- Skip the Antivirus Scanning
- Skip the Antivirus Scanning.
default: false
type: bool
required: false
skipbadclients:
description:
- Block clients with bad reputation
- Block clients with bad reputation.
default: false
type: bool
required: false
skipcookie:
description:
- Skip the Cookie Signing check
- Skip the Cookie Signing check.
default: false
type: bool
required: false
skipform:
description:
- Enable form hardening
- Enable form hardening.
default: false
type: bool
required: false
skipform_missingtoken:
description:
- Enable form hardening with missing tokens
- Enable form hardening with missing tokens.
default: false
type: bool
required: false
skiphtmlrewrite:
description:
- Protection against SQL
- Protection against SQL.
default: false
type: bool
required: false
skiptft:
description:
- Enable true file type control
- Enable true file type control.
default: false
type: bool
required: false
skipurl:
description:
- Enable static URL hardening
- Enable static URL hardening.
default: false
type: bool
required: false
source:
description:
- Define which categories of threats are skipped
- Define which categories of threats are skipped.
type: list
elements: str
default: []
required: false
status:
description:
- Status of the exception rule set
- 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,65 +146,65 @@ EXAMPLES = """
state: absent
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
comment:
description: The optional comment string
description: The optional comment string.
type: str
op:
description: The operand to be used with the entries of the path parameter
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
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
description: A list of threats to be skipped.
type: list
skip_threats_filter_categories:
description: Define which categories of threats are skipped
description: Define which categories of threats are skipped.
type: list
skipav:
description: Skip the Antivirus Scanning
description: Skip the Antivirus Scanning.
type: bool
skipbadclients:
description: Block clients with bad reputation
description: Block clients with bad reputation.
type: bool
skipcookie:
description: Skip the Cookie Signing check
description: Skip the Cookie Signing check.
type: bool
skipform:
description: Enable form hardening
description: Enable form hardening.
type: bool
skipform_missingtoken:
description: Enable form hardening with missing tokens
description: Enable form hardening with missing tokens.
type: bool
skiphtmlrewrite:
description: Protection against SQL
description: Protection against SQL.
type: bool
skiptft:
description: Enable true file type control
description: Enable true file type control.
type: bool
skipurl:
description: Enable static URL hardening
description: Enable static URL hardening.
type: bool
source:
description: Define which categories of threats are skipped
description: Define which categories of threats are skipped.
type: list
"""

99
plugins/modules/utm_proxy_frontend.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_proxy_frontend
author:
@ -21,7 +20,6 @@ short_description: Create, update or destroy reverse_proxy frontend entry in Sop
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.
attributes:
check_mode:
support: none
@ -32,11 +30,11 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
add_content_type_header :
add_content_type_header:
description:
- Whether to add the content type header or not
- Whether to add the content type header or not.
type: bool
default: false
address:
@ -58,43 +56,43 @@ options:
comment:
type: str
description:
- An optional comment to add to the object
- An optional comment to add to the object.
default: ""
disable_compression:
description:
- Whether to enable the compression
- Whether to enable the compression.
type: bool
default: false
domain:
type: list
elements: str
description:
- A list of domain names for the frontend object
- A list of domain names for the frontend object.
exceptions:
type: list
elements: str
description:
- A list of exception ref names (reverse_proxy/exception)
- A list of exception ref names (reverse_proxy/exception).
default: []
htmlrewrite:
description:
- Whether to enable html rewrite or not
- Whether to enable html rewrite or not.
type: bool
default: false
htmlrewrite_cookies:
description:
- Whether to enable html rewrite cookie or not
- Whether to enable html rewrite cookie or not.
type: bool
default: false
implicitredirect:
description:
- Whether to enable implicit redirection or not
- Whether to enable implicit redirection or not.
type: bool
default: false
lbmethod:
type: str
description:
- Which loadbalancer method should be used
- Which loadbalancer method should be used.
choices:
- ""
- bybusyness
@ -105,49 +103,48 @@ options:
type: list
elements: str
description:
- A list of location ref names (reverse_proxy/location)
- A list of location ref names (reverse_proxy/location).
default: []
port:
type: int
description:
- The frontend http port
- The frontend http port.
default: 80
preservehost:
description:
- Whether to preserve host header
- Whether to preserve host header.
type: bool
default: false
profile:
type: str
description:
- The reference string of the reverse_proxy/profile
- The reference string of the reverse_proxy/profile.
default: ""
status:
description:
- Whether to activate the frontend entry or not
- Whether to activate the frontend entry or not.
type: bool
default: true
type:
type: str
description:
- Which protocol should be used
- Which protocol should be used.
choices:
- http
- https
default: http
xheaders:
description:
- Whether to pass the host header or not
- Whether to pass the host header or not.
type: bool
default: false
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.utm
- community.general.attributes
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Create utm proxy_frontend
community.general.utm_proxy_frontend:
utm_host: sophos.host.name
@ -164,80 +161,80 @@ EXAMPLES = """
state: absent
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
add_content_type_header:
description: Whether to add the content type header
description: Whether to add the content type header.
type: bool
address:
description: The reference name of the address
description: The reference name of the address.
type: str
allowed_networks:
description: List of reference names of networks associated
description: List of reference names of networks associated.
type: list
certificate:
description: Reference name of certificate (ca/host_key_cert)
description: Reference name of certificate (ca/host_key_cert).
type: str
comment:
description: The comment string
description: The comment string.
type: str
disable_compression:
description: State of compression support
description: State of compression support.
type: bool
domain:
description: List of hostnames
description: List of hostnames.
type: list
exceptions:
description: List of associated proxy exceptions
description: List of associated proxy exceptions.
type: list
htmlrewrite:
description: State of html rewrite
description: State of html rewrite.
type: bool
htmlrewrite_cookies:
description: Whether the html rewrite cookie will be set
description: Whether the html rewrite cookie will be set.
type: bool
implicitredirect:
description: Whether to use implicit redirection
description: Whether to use implicit redirection.
type: bool
lbmethod:
description: The method of loadbalancer to use
description: The method of loadbalancer to use.
type: str
locations:
description: The reference names of reverse_proxy/locations associated with the object
description: The reference names of reverse_proxy/locations associated with the object.
type: list
port:
description: The port of the frontend connection
description: The port of the frontend connection.
type: int
preservehost:
description: Preserve host header
description: Preserve host header.
type: bool
profile:
description: The associated reverse_proxy/profile
description: The associated reverse_proxy/profile.
type: str
status:
description: Whether the frontend object is active or not
description: Whether the frontend object is active or not.
type: bool
type:
description: The connection type
description: The connection type.
type: str
xheaders:
description: The xheaders state
description: The xheaders state.
type: bool
"""

60
plugins/modules/utm_proxy_frontend_info.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_proxy_frontend_info
author:
@ -21,7 +20,6 @@ short_description: Create, update or destroy reverse_proxy frontend entry in Sop
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.
attributes:
check_mode:
version_added: 3.3.0
@ -31,16 +29,16 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.attributes.info_module
'''
"""
EXAMPLES = """
EXAMPLES = r"""
- name: Get utm proxy_frontend
community.general.utm_proxy_frontend_info:
utm_host: sophos.host.name
@ -49,80 +47,80 @@ EXAMPLES = """
host: REF_OBJECT_STRING
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
add_content_type_header:
description: Whether to add the content type header
description: Whether to add the content type header.
type: bool
address:
description: The reference name of the address
description: The reference name of the address.
type: str
allowed_networks:
description: List of reference names of networks associated
description: List of reference names of networks associated.
type: list
certificate:
description: Reference name of certificate (ca/host_key_cert)
description: Reference name of certificate (ca/host_key_cert).
type: str
comment:
description: The comment string
description: The comment string.
type: str
disable_compression:
description: State of compression support
description: State of compression support.
type: bool
domain:
description: List of hostnames
description: List of hostnames.
type: list
exceptions:
description: List of associated proxy exceptions
description: List of associated proxy exceptions.
type: list
htmlrewrite:
description: State of html rewrite
description: State of html rewrite.
type: bool
htmlrewrite_cookies:
description: whether the html rewrite cookie will be set
description: Whether the html rewrite cookie will be set.
type: bool
implicitredirect:
description: whether to use implicit redirection
description: Whether to use implicit redirection.
type: bool
lbmethod:
description: The method of loadbalancer to use
description: The method of loadbalancer to use.
type: str
locations:
description: The reference names of reverse_proxy/locations associated with the object
description: The reference names of reverse_proxy/locations associated with the object.
type: list
port:
description: The port of the frontend connection
description: The port of the frontend connection.
type: int
preservehost:
description: Preserve host header
description: Preserve host header.
type: bool
profile:
description: The associated reverse_proxy/profile
description: The associated reverse_proxy/profile.
type: str
status:
description: Whether the frontend object is active or not
description: Whether the frontend object is active or not.
type: bool
type:
description: The connection type
description: The connection type.
type: str
xheaders:
description: The xheaders state
description: The xheaders state.
type: bool
"""

79
plugins/modules/utm_proxy_location.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_proxy_location
author:
@ -21,7 +20,6 @@ short_description: Create, update or destroy reverse_proxy location entry in Sop
description:
- Create, update or destroy a reverse_proxy location entry in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
attributes:
check_mode:
support: none
@ -32,11 +30,11 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
access_control:
description:
- whether to activate the access control for the location
- Whether to activate the access control for the location.
type: str
default: '0'
choices:
@ -44,7 +42,7 @@ options:
- '1'
allowed_networks:
description:
- A list of allowed networks
- A list of allowed networks.
type: list
elements: str
default:
@ -52,68 +50,67 @@ options:
auth_profile:
type: str
description:
- The reference name of the auth profile
- The reference name of the auth profile.
default: ''
backend:
type: list
elements: str
description:
- A list of backends that are connected with this location declaration
- A list of backends that are connected with this location declaration.
default: []
be_path:
type: str
description:
- The path of the backend
- The path of the backend.
default: ''
comment:
type: str
description:
- The optional comment string
- The optional comment string.
default: ''
denied_networks:
type: list
elements: str
description:
- A list of denied network references
- A list of denied network references.
default: []
hot_standby:
description:
- Activate hot standby mode
- Activate hot standby mode.
type: bool
default: false
path:
type: str
description:
- The path of the location
- The path of the location.
default: "/"
status:
description:
- Whether the location is active or not
- Whether the location is active or not.
type: bool
default: true
stickysession_id:
type: str
description:
- The stickysession id
- The stickysession id.
default: ROUTEID
stickysession_status:
description:
- Enable the stickysession
- Enable the stickysession.
type: bool
default: false
websocket_passthrough:
description:
- Enable the websocket passthrough
- Enable the websocket passthrough.
type: bool
default: false
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.utm
- community.general.attributes
"""
'''
EXAMPLES = """
EXAMPLES = r"""
- name: Create UTM proxy_location
utm_proxy_backend:
utm_host: sophos.host.name
@ -130,62 +127,62 @@ EXAMPLES = """
state: absent
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
access_control:
description: Whether to use access control state
description: Whether to use access control state.
type: str
allowed_networks:
description: List of allowed network reference names
description: List of allowed network reference names.
type: list
auth_profile:
description: The auth profile reference name
description: The auth profile reference name.
type: str
backend:
description: The backend reference name
description: The backend reference name.
type: str
be_path:
description: The backend path
description: The backend path.
type: str
comment:
description: The comment string
description: The comment string.
type: str
denied_networks:
description: The list of the denied network names
description: The list of the denied network names.
type: list
hot_standby:
description: Use hot standby
description: Use hot standby.
type: bool
path:
description: Path name
description: Path name.
type: str
status:
description: Whether the object is active or not
description: Whether the object is active or not.
type: bool
stickysession_id:
description: The identifier of the stickysession
description: The identifier of the stickysession.
type: str
stickysession_status:
description: Whether to use stickysession or not
description: Whether to use stickysession or not.
type: bool
websocket_passthrough:
description: Whether websocket passthrough will be used or not
description: Whether websocket passthrough will be used or not.
type: bool
"""

48
plugins/modules/utm_proxy_location_info.py
View File

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: utm_proxy_location_info
author:
@ -21,7 +20,6 @@ short_description: Create, update or destroy reverse_proxy location entry in Sop
description:
- Create, update or destroy a reverse_proxy location entry in SOPHOS UTM.
- This module needs to have the REST Ability of the UTM to be activated.
attributes:
check_mode:
version_added: 3.3.0
@ -31,16 +29,16 @@ options:
name:
type: str
description:
- The name of the object. Will be used to identify the entry
- The name of the object. Will be used to identify the entry.
required: true
extends_documentation_fragment:
- community.general.utm
- community.general.attributes
- community.general.attributes.info_module
'''
"""
EXAMPLES = """
EXAMPLES = r"""
- name: Remove UTM proxy_location
community.general.utm_proxy_location_info:
utm_host: sophos.host.name
@ -48,62 +46,62 @@ EXAMPLES = """
name: TestLocationEntry
"""
RETURN = """
RETURN = r"""
result:
description: The utm object that was created
description: The utm object that was created.
returned: success
type: complex
contains:
_ref:
description: The reference name of the object
description: The reference name of the object.
type: str
_locked:
description: Whether or not the object is currently locked
description: Whether or not the object is currently locked.
type: bool
_type:
description: The type of the object
description: The type of the object.
type: str
name:
description: The name of the object
description: The name of the object.
type: str
access_control:
description: Whether to use access control state
description: Whether to use access control state.
type: str
allowed_networks:
description: List of allowed network reference names
description: List of allowed network reference names.
type: list
auth_profile:
description: The auth profile reference name
description: The auth profile reference name.
type: str
backend:
description: The backend reference name
description: The backend reference name.
type: str
be_path:
description: The backend path
description: The backend path.
type: str
comment:
description: The comment string
description: The comment string.
type: str
denied_networks:
description: The list of the denied network names
description: The list of the denied network names.
type: list
hot_standby:
description: Use hot standby
description: Use hot standby.
type: bool
path:
description: Path name
description: Path name.
type: str
status:
description: Whether the object is active or not
description: Whether the object is active or not.
type: bool
stickysession_id:
description: The identifier of the stickysession
description: The identifier of the stickysession.
type: str
stickysession_status:
description: Whether to use stickysession or not
description: Whether to use stickysession or not.
type: bool
websocket_passthrough:
description: Whether websocket passthrough will be used or not
description: Whether websocket passthrough will be used or not.
type: bool
"""