mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 10:51:24 -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,183 +9,180 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: utm_proxy_auth_profile
|
||||
|
||||
author:
|
||||
- Stephan Schwarz (@stearz)
|
||||
- Stephan Schwarz (@stearz)
|
||||
|
||||
short_description: Create, update or destroy reverse_proxy auth_profile entry in Sophos UTM
|
||||
|
||||
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.
|
||||
|
||||
- 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
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- 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)
|
||||
required: true
|
||||
basic_prompt:
|
||||
type: str
|
||||
description:
|
||||
- The message in the basic authentication prompt
|
||||
required: true
|
||||
backend_mode:
|
||||
type: str
|
||||
description:
|
||||
- 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
|
||||
type: bool
|
||||
default: true
|
||||
backend_user_prefix:
|
||||
type: str
|
||||
description:
|
||||
- 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
|
||||
default: ""
|
||||
comment:
|
||||
type: str
|
||||
description:
|
||||
- Optional comment string
|
||||
default: ""
|
||||
frontend_cookie:
|
||||
type: str
|
||||
description:
|
||||
- Frontend cookie name
|
||||
frontend_cookie_secret:
|
||||
type: str
|
||||
description:
|
||||
- Frontend cookie secret
|
||||
frontend_form:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication form name
|
||||
frontend_form_template:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication form template
|
||||
default: ""
|
||||
frontend_login:
|
||||
type: str
|
||||
description:
|
||||
- Frontend login name
|
||||
frontend_logout:
|
||||
type: str
|
||||
description:
|
||||
- Frontend logout name
|
||||
frontend_mode:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication mode (Form|Basic)
|
||||
default: Basic
|
||||
choices:
|
||||
- Basic
|
||||
- Form
|
||||
frontend_realm:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication realm
|
||||
frontend_session_allow_persistency:
|
||||
description:
|
||||
- Allow session persistency
|
||||
type: bool
|
||||
default: false
|
||||
frontend_session_lifetime:
|
||||
type: int
|
||||
description:
|
||||
- session lifetime
|
||||
required: true
|
||||
frontend_session_lifetime_limited:
|
||||
description:
|
||||
- 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)
|
||||
default: hours
|
||||
choices:
|
||||
- days
|
||||
- hours
|
||||
- minutes
|
||||
frontend_session_timeout:
|
||||
type: int
|
||||
description:
|
||||
- session timeout
|
||||
required: true
|
||||
frontend_session_timeout_enabled:
|
||||
description:
|
||||
- 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)
|
||||
default: minutes
|
||||
choices:
|
||||
- days
|
||||
- hours
|
||||
- minutes
|
||||
logout_delegation_urls:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- List of logout URLs that logouts are delegated to
|
||||
default: []
|
||||
logout_mode:
|
||||
type: str
|
||||
description:
|
||||
- Mode of logout (None|Delegation)
|
||||
default: None
|
||||
choices:
|
||||
- None
|
||||
- Delegation
|
||||
redirect_to_requested_url:
|
||||
description:
|
||||
- Should a redirect to the requested URL be made
|
||||
type: bool
|
||||
default: false
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- 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).
|
||||
required: true
|
||||
basic_prompt:
|
||||
type: str
|
||||
description:
|
||||
- The message in the basic authentication prompt.
|
||||
required: true
|
||||
backend_mode:
|
||||
type: str
|
||||
description:
|
||||
- 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.
|
||||
type: bool
|
||||
default: true
|
||||
backend_user_prefix:
|
||||
type: str
|
||||
description:
|
||||
- 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.
|
||||
default: ""
|
||||
comment:
|
||||
type: str
|
||||
description:
|
||||
- Optional comment string.
|
||||
default: ""
|
||||
frontend_cookie:
|
||||
type: str
|
||||
description:
|
||||
- Frontend cookie name.
|
||||
frontend_cookie_secret:
|
||||
type: str
|
||||
description:
|
||||
- Frontend cookie secret.
|
||||
frontend_form:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication form name.
|
||||
frontend_form_template:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication form template.
|
||||
default: ""
|
||||
frontend_login:
|
||||
type: str
|
||||
description:
|
||||
- Frontend login name.
|
||||
frontend_logout:
|
||||
type: str
|
||||
description:
|
||||
- Frontend logout name.
|
||||
frontend_mode:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication mode (Form|Basic).
|
||||
default: Basic
|
||||
choices:
|
||||
- Basic
|
||||
- Form
|
||||
frontend_realm:
|
||||
type: str
|
||||
description:
|
||||
- Frontend authentication realm.
|
||||
frontend_session_allow_persistency:
|
||||
description:
|
||||
- Allow session persistency.
|
||||
type: bool
|
||||
default: false
|
||||
frontend_session_lifetime:
|
||||
type: int
|
||||
description:
|
||||
- Session lifetime.
|
||||
required: true
|
||||
frontend_session_lifetime_limited:
|
||||
description:
|
||||
- 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).
|
||||
default: hours
|
||||
choices:
|
||||
- days
|
||||
- hours
|
||||
- minutes
|
||||
frontend_session_timeout:
|
||||
type: int
|
||||
description:
|
||||
- Session timeout.
|
||||
required: true
|
||||
frontend_session_timeout_enabled:
|
||||
description:
|
||||
- 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).
|
||||
default: minutes
|
||||
choices:
|
||||
- days
|
||||
- hours
|
||||
- minutes
|
||||
logout_delegation_urls:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- List of logout URLs that logouts are delegated to.
|
||||
default: []
|
||||
logout_mode:
|
||||
type: str
|
||||
description:
|
||||
- Mode of logout (None|Delegation).
|
||||
default: None
|
||||
choices:
|
||||
- None
|
||||
- Delegation
|
||||
redirect_to_requested_url:
|
||||
description:
|
||||
- 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,99 +201,98 @@ EXAMPLES = """
|
|||
utm_token: abcdefghijklmno1234
|
||||
name: TestAuthProfileEntry
|
||||
state: info
|
||||
|
||||
"""
|
||||
|
||||
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
|
||||
aaa:
|
||||
description: List of references to utm_aaa objects (allowed users or groups)
|
||||
type: list
|
||||
basic_prompt:
|
||||
description: The message in the basic authentication prompt
|
||||
type: str
|
||||
backend_mode:
|
||||
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
|
||||
type: bool
|
||||
backend_user_prefix:
|
||||
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
|
||||
type: str
|
||||
comment:
|
||||
description: Optional comment string
|
||||
type: str
|
||||
frontend_cookie:
|
||||
description: Frontend cookie name
|
||||
type: str
|
||||
frontend_form:
|
||||
description: Frontend authentication form name
|
||||
type: str
|
||||
frontend_form_template:
|
||||
description: Frontend authentication form template
|
||||
type: str
|
||||
frontend_login:
|
||||
description: Frontend login name
|
||||
type: str
|
||||
frontend_logout:
|
||||
description: Frontend logout name
|
||||
type: str
|
||||
frontend_mode:
|
||||
description: Frontend authentication mode (Form|Basic)
|
||||
type: str
|
||||
frontend_realm:
|
||||
description: Frontend authentication realm
|
||||
type: str
|
||||
frontend_session_allow_persistency:
|
||||
description: Allow session persistency
|
||||
type: bool
|
||||
frontend_session_lifetime:
|
||||
description: session lifetime
|
||||
type: int
|
||||
frontend_session_lifetime_limited:
|
||||
description: Specifies if limitation of session lifetime is active
|
||||
type: bool
|
||||
frontend_session_lifetime_scope:
|
||||
description: scope for frontend_session_lifetime (days|hours|minutes)
|
||||
type: str
|
||||
frontend_session_timeout:
|
||||
description: session timeout
|
||||
type: int
|
||||
frontend_session_timeout_enabled:
|
||||
description: Specifies if session timeout is active
|
||||
type: bool
|
||||
frontend_session_timeout_scope:
|
||||
description: scope for frontend_session_timeout (days|hours|minutes)
|
||||
type: str
|
||||
logout_delegation_urls:
|
||||
description: List of logout URLs that logouts are delegated to
|
||||
type: list
|
||||
logout_mode:
|
||||
description: Mode of logout (None|Delegation)
|
||||
type: str
|
||||
redirect_to_requested_url:
|
||||
description: Should a redirect to the requested URL be made
|
||||
type: bool
|
||||
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
|
||||
aaa:
|
||||
description: List of references to utm_aaa objects (allowed users or groups).
|
||||
type: list
|
||||
basic_prompt:
|
||||
description: The message in the basic authentication prompt.
|
||||
type: str
|
||||
backend_mode:
|
||||
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.
|
||||
type: bool
|
||||
backend_user_prefix:
|
||||
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.
|
||||
type: str
|
||||
comment:
|
||||
description: Optional comment string.
|
||||
type: str
|
||||
frontend_cookie:
|
||||
description: Frontend cookie name.
|
||||
type: str
|
||||
frontend_form:
|
||||
description: Frontend authentication form name.
|
||||
type: str
|
||||
frontend_form_template:
|
||||
description: Frontend authentication form template.
|
||||
type: str
|
||||
frontend_login:
|
||||
description: Frontend login name.
|
||||
type: str
|
||||
frontend_logout:
|
||||
description: Frontend logout name.
|
||||
type: str
|
||||
frontend_mode:
|
||||
description: Frontend authentication mode (Form|Basic).
|
||||
type: str
|
||||
frontend_realm:
|
||||
description: Frontend authentication realm.
|
||||
type: str
|
||||
frontend_session_allow_persistency:
|
||||
description: Allow session persistency.
|
||||
type: bool
|
||||
frontend_session_lifetime:
|
||||
description: Session lifetime.
|
||||
type: int
|
||||
frontend_session_lifetime_limited:
|
||||
description: Specifies if limitation of session lifetime is active.
|
||||
type: bool
|
||||
frontend_session_lifetime_scope:
|
||||
description: Scope for frontend_session_lifetime (days|hours|minutes).
|
||||
type: str
|
||||
frontend_session_timeout:
|
||||
description: Session timeout.
|
||||
type: int
|
||||
frontend_session_timeout_enabled:
|
||||
description: Specifies if session timeout is active.
|
||||
type: bool
|
||||
frontend_session_timeout_scope:
|
||||
description: Scope for frontend_session_timeout (days|hours|minutes).
|
||||
type: str
|
||||
logout_delegation_urls:
|
||||
description: List of logout URLs that logouts are delegated to.
|
||||
type: list
|
||||
logout_mode:
|
||||
description: Mode of logout (None|Delegation).
|
||||
type: str
|
||||
redirect_to_requested_url:
|
||||
description: Should a redirect to the requested URL be made.
|
||||
type: bool
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue