mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-05 07:49:10 -07:00
[PR #9335/c141f868 backport][stable-10] utm*: normalize docs (#9346)
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:
parent
429b4b14a8
commit
e3f72bca4f
13 changed files with 1487 additions and 1525 deletions
|
@ -10,38 +10,35 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: utm_aaa_group_info
|
||||
|
||||
author:
|
||||
- Johannes Brunswicker (@MatrixCrawler)
|
||||
- Johannes Brunswicker (@MatrixCrawler)
|
||||
|
||||
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
|
||||
# This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix
|
||||
check_mode:
|
||||
version_added: 3.3.0
|
||||
# This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix
|
||||
|
||||
options:
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- The name of the object. Will be used to identify the entry
|
||||
required: true
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- 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
|
||||
- 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,63 +46,63 @@ EXAMPLES = """
|
|||
name: TestAAAGroupEntry
|
||||
"""
|
||||
|
||||
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
|
||||
adirectory_groups:
|
||||
description: List of Active Directory Groups
|
||||
type: str
|
||||
adirectory_groups_sids:
|
||||
description: List of Active Directory Groups SIDS
|
||||
type: list
|
||||
backend_match:
|
||||
description: The backend to use
|
||||
type: str
|
||||
comment:
|
||||
description: The comment string
|
||||
type: str
|
||||
dynamic:
|
||||
description: Whether the group match is ipsec_dn or directory_group
|
||||
type: str
|
||||
edirectory_groups:
|
||||
description: List of eDirectory Groups
|
||||
type: str
|
||||
ipsec_dn:
|
||||
description: ipsec_dn identifier to match
|
||||
type: str
|
||||
ldap_attribute:
|
||||
description: The LDAP Attribute to match against
|
||||
type: str
|
||||
ldap_attribute_value:
|
||||
description: The LDAP Attribute Value to match against
|
||||
type: str
|
||||
members:
|
||||
description: List of member identifiers of the group
|
||||
type: list
|
||||
network:
|
||||
description: The identifier of the network (network/aaa)
|
||||
type: str
|
||||
radius_group:
|
||||
description: The radius group identifier
|
||||
type: str
|
||||
tacacs_group:
|
||||
description: The tacacs group identifier
|
||||
type: str
|
||||
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
|
||||
adirectory_groups:
|
||||
description: List of Active Directory Groups.
|
||||
type: str
|
||||
adirectory_groups_sids:
|
||||
description: List of Active Directory Groups SIDS.
|
||||
type: list
|
||||
backend_match:
|
||||
description: The backend to use.
|
||||
type: str
|
||||
comment:
|
||||
description: The comment string.
|
||||
type: str
|
||||
dynamic:
|
||||
description: Whether the group match is ipsec_dn or directory_group.
|
||||
type: str
|
||||
edirectory_groups:
|
||||
description: List of eDirectory Groups.
|
||||
type: str
|
||||
ipsec_dn:
|
||||
description: Ipsec_dn identifier to match.
|
||||
type: str
|
||||
ldap_attribute:
|
||||
description: The LDAP Attribute to match against.
|
||||
type: str
|
||||
ldap_attribute_value:
|
||||
description: The LDAP Attribute Value to match against.
|
||||
type: str
|
||||
members:
|
||||
description: List of member identifiers of the group.
|
||||
type: list
|
||||
network:
|
||||
description: The identifier of the network (network/aaa).
|
||||
type: str
|
||||
radius_group:
|
||||
description: The radius group identifier.
|
||||
type: str
|
||||
tacacs_group:
|
||||
description: The tacacs group identifier.
|
||||
type: str
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue