mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-31 21:39:10 -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
|
|
@ -8,120 +8,117 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: utm_aaa_group
|
||||
|
||||
author:
|
||||
- Johannes Brunswicker (@MatrixCrawler)
|
||||
- Johannes Brunswicker (@MatrixCrawler)
|
||||
|
||||
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.
|
||||
|
||||
- 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
|
||||
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.
|
||||
type: str
|
||||
required: true
|
||||
adirectory_groups:
|
||||
description:
|
||||
- List of adirectory group strings.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
adirectory_groups_sids:
|
||||
description:
|
||||
- Dictionary of group sids.
|
||||
type: dict
|
||||
default: {}
|
||||
backend_match:
|
||||
description:
|
||||
- The backend for the group.
|
||||
type: str
|
||||
choices:
|
||||
- none
|
||||
- adirectory
|
||||
- edirectory
|
||||
- radius
|
||||
- tacacs
|
||||
- ldap
|
||||
default: none
|
||||
comment:
|
||||
description:
|
||||
- Comment that describes the AAA group.
|
||||
type: str
|
||||
default: ''
|
||||
dynamic:
|
||||
description:
|
||||
- Group type. Is static if none is selected.
|
||||
type: str
|
||||
default: none
|
||||
choices:
|
||||
- none
|
||||
- ipsec_dn
|
||||
- directory_groups
|
||||
edirectory_groups:
|
||||
description:
|
||||
- List of edirectory group strings.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
ipsec_dn:
|
||||
description:
|
||||
- The ipsec dn string.
|
||||
type: str
|
||||
default: ''
|
||||
ldap_attribute:
|
||||
description:
|
||||
- The ldap attribute to check against.
|
||||
type: str
|
||||
default: ''
|
||||
ldap_attribute_value:
|
||||
description:
|
||||
- The ldap attribute value to check against.
|
||||
type: str
|
||||
default: ''
|
||||
members:
|
||||
description:
|
||||
- A list of user ref names (aaa/user).
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
network:
|
||||
description:
|
||||
- The network reference name. The objects contains the known ip addresses for the authentication object (network/aaa).
|
||||
type: str
|
||||
default: ""
|
||||
radius_groups:
|
||||
description:
|
||||
- A list of radius group strings.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
tacacs_groups:
|
||||
description:
|
||||
- A list of tacacs group strings.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
name:
|
||||
description:
|
||||
- The name of the object. Will be used to identify the entry.
|
||||
type: str
|
||||
required: true
|
||||
adirectory_groups:
|
||||
description:
|
||||
- List of adirectory group strings.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
adirectory_groups_sids:
|
||||
description:
|
||||
- Dictionary of group sids.
|
||||
type: dict
|
||||
default: {}
|
||||
backend_match:
|
||||
description:
|
||||
- The backend for the group.
|
||||
type: str
|
||||
choices:
|
||||
- none
|
||||
- adirectory
|
||||
- edirectory
|
||||
- radius
|
||||
- tacacs
|
||||
- ldap
|
||||
default: none
|
||||
comment:
|
||||
description:
|
||||
- Comment that describes the AAA group.
|
||||
type: str
|
||||
default: ''
|
||||
dynamic:
|
||||
description:
|
||||
- Group type. Is static if none is selected.
|
||||
type: str
|
||||
default: none
|
||||
choices:
|
||||
- none
|
||||
- ipsec_dn
|
||||
- directory_groups
|
||||
edirectory_groups:
|
||||
description:
|
||||
- List of edirectory group strings.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
ipsec_dn:
|
||||
description:
|
||||
- The ipsec dn string.
|
||||
type: str
|
||||
default: ''
|
||||
ldap_attribute:
|
||||
description:
|
||||
- The ldap attribute to check against.
|
||||
type: str
|
||||
default: ''
|
||||
ldap_attribute_value:
|
||||
description:
|
||||
- The ldap attribute value to check against.
|
||||
type: str
|
||||
default: ''
|
||||
members:
|
||||
description:
|
||||
- A list of user ref names (aaa/user).
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
network:
|
||||
description:
|
||||
- The network reference name. The objects contains the known IP addresses for the authentication object (network/aaa).
|
||||
type: str
|
||||
default: ""
|
||||
radius_groups:
|
||||
description:
|
||||
- A list of radius group strings.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
tacacs_groups:
|
||||
description:
|
||||
- A list of tacacs group strings.
|
||||
type: list
|
||||
elements: str
|
||||
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,63 +139,63 @@ 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
|
||||
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