mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-25 06:10:22 -07:00
- Fix sanity checks
- Fixed documentation trailing whitespaces - Added missing/broken documentation
This commit is contained in:
parent
deba5f0e54
commit
e2f6598e3f
1 changed files with 15 additions and 10 deletions
|
@ -17,7 +17,7 @@ DOCUMENTATION = """
|
||||||
---
|
---
|
||||||
module: utm_proxy_auth_profile
|
module: utm_proxy_auth_profile
|
||||||
|
|
||||||
author:
|
author:
|
||||||
- Stephan Schwarz (@stearz)
|
- Stephan Schwarz (@stearz)
|
||||||
|
|
||||||
short_description: create, update or destroy reverse_proxy auth_profile entry in Sophos UTM
|
short_description: create, update or destroy reverse_proxy auth_profile entry in Sophos UTM
|
||||||
|
@ -26,7 +26,7 @@ description:
|
||||||
- Create, update or destroy a reverse_proxy auth_profile entry in SOPHOS UTM.
|
- 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.
|
- This module needs to have the REST Ability of the UTM to be activated.
|
||||||
|
|
||||||
version_added: "2.7"
|
version_added: "2.8"
|
||||||
|
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
|
@ -51,6 +51,7 @@ options:
|
||||||
backend_strip_basic_auth:
|
backend_strip_basic_auth:
|
||||||
description:
|
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
|
default: True
|
||||||
choices:
|
choices:
|
||||||
- True
|
- True
|
||||||
|
@ -99,6 +100,7 @@ options:
|
||||||
frontend_session_allow_persistency:
|
frontend_session_allow_persistency:
|
||||||
description:
|
description:
|
||||||
- Allow session persistency
|
- Allow session persistency
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
choices:
|
choices:
|
||||||
- True
|
- True
|
||||||
|
@ -109,7 +111,8 @@ options:
|
||||||
required: true
|
required: true
|
||||||
frontend_session_lifetime_limited:
|
frontend_session_lifetime_limited:
|
||||||
description:
|
description:
|
||||||
- Specifies if limitation of session lifetime is active
|
- Specifies if limitation of session lifetime is active
|
||||||
|
type: bool
|
||||||
default: True
|
default: True
|
||||||
choices:
|
choices:
|
||||||
- True
|
- True
|
||||||
|
@ -129,6 +132,7 @@ options:
|
||||||
frontend_session_timeout_enabled:
|
frontend_session_timeout_enabled:
|
||||||
description:
|
description:
|
||||||
- Specifies if session timeout is active
|
- Specifies if session timeout is active
|
||||||
|
type: bool
|
||||||
default: True
|
default: True
|
||||||
choices:
|
choices:
|
||||||
- True
|
- True
|
||||||
|
@ -155,6 +159,7 @@ options:
|
||||||
redirect_to_requested_url:
|
redirect_to_requested_url:
|
||||||
description:
|
description:
|
||||||
- Should a redirect to the requested URL be made
|
- Should a redirect to the requested URL be made
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
choices:
|
choices:
|
||||||
- True
|
- True
|
||||||
|
@ -262,7 +267,7 @@ result:
|
||||||
description: session lifetime
|
description: session lifetime
|
||||||
type: integer
|
type: integer
|
||||||
frontend_session_lifetime_limited:
|
frontend_session_lifetime_limited:
|
||||||
description: Specifies if limitation of session lifetime is active
|
description: Specifies if limitation of session lifetime is active
|
||||||
type: boolean
|
type: boolean
|
||||||
frontend_session_lifetime_scope:
|
frontend_session_lifetime_scope:
|
||||||
description: scope for frontend_session_lifetime (days|hours|minutes)
|
description: scope for frontend_session_lifetime (days|hours|minutes)
|
||||||
|
@ -285,7 +290,6 @@ result:
|
||||||
redirect_to_requested_url:
|
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: boolean
|
type: boolean
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from ansible.module_utils.utm_utils import UTM, UTMModule
|
from ansible.module_utils.utm_utils import UTM, UTMModule
|
||||||
|
@ -310,7 +314,7 @@ def main():
|
||||||
aaa=dict(type='list', elements='str', required=True),
|
aaa=dict(type='list', elements='str', required=True),
|
||||||
basic_prompt=dict(type='str', required=True),
|
basic_prompt=dict(type='str', required=True),
|
||||||
backend_mode=dict(type='str', required=False, default="None", choices=['Basic', 'None']),
|
backend_mode=dict(type='str', required=False, default="None", choices=['Basic', 'None']),
|
||||||
backend_strip_basic_auth=dict(type='bool', required=False, default=True),
|
backend_strip_basic_auth=dict(type='bool', required=False, default=True, choices=[True, False]),
|
||||||
backend_user_prefix=dict(type='str', required=False, default=""),
|
backend_user_prefix=dict(type='str', required=False, default=""),
|
||||||
backend_user_suffix=dict(type='str', required=False, default=""),
|
backend_user_suffix=dict(type='str', required=False, default=""),
|
||||||
comment=dict(type='str', required=False, default=""),
|
comment=dict(type='str', required=False, default=""),
|
||||||
|
@ -322,16 +326,16 @@ def main():
|
||||||
frontend_logout=dict(type='str', required=False),
|
frontend_logout=dict(type='str', required=False),
|
||||||
frontend_mode=dict(type='str', required=False, default="Basic", choices=['Basic', 'Form']),
|
frontend_mode=dict(type='str', required=False, default="Basic", choices=['Basic', 'Form']),
|
||||||
frontend_realm=dict(type='str', required=False),
|
frontend_realm=dict(type='str', required=False),
|
||||||
frontend_session_allow_persistency=dict(type='bool', required=False, default=False),
|
frontend_session_allow_persistency=dict(type='bool', required=False, default=False, choices=[True, False]),
|
||||||
frontend_session_lifetime=dict(type='int', required=True),
|
frontend_session_lifetime=dict(type='int', required=True),
|
||||||
frontend_session_lifetime_limited=dict(type='bool', required=False, default=True),
|
frontend_session_lifetime_limited=dict(type='bool', required=False, default=True, choices=[True, False]),
|
||||||
frontend_session_lifetime_scope=dict(type='str', required=False, default="hours", choices=['days', 'hours', 'minutes']),
|
frontend_session_lifetime_scope=dict(type='str', required=False, default="hours", choices=['days', 'hours', 'minutes']),
|
||||||
frontend_session_timeout=dict(type='int', required=True),
|
frontend_session_timeout=dict(type='int', required=True),
|
||||||
frontend_session_timeout_enabled=dict(type='bool', required=False, default=True),
|
frontend_session_timeout_enabled=dict(type='bool', required=False, default=True, choices=[True, False]),
|
||||||
frontend_session_timeout_scope=dict(type='str', required=False, default="minutes", choices=['days', 'hours', 'minutes']),
|
frontend_session_timeout_scope=dict(type='str', required=False, default="minutes", choices=['days', 'hours', 'minutes']),
|
||||||
logout_delegation_urls=dict(type='list', elements='str', required=False, default=[]),
|
logout_delegation_urls=dict(type='list', elements='str', required=False, default=[]),
|
||||||
logout_mode=dict(type='str', required=False, default="None", choices=['None', 'Delegation']),
|
logout_mode=dict(type='str', required=False, default="None", choices=['None', 'Delegation']),
|
||||||
redirect_to_requested_url=dict(type='bool', required=False, default=False)
|
redirect_to_requested_url=dict(type='bool', required=False, default=False, choices=[True, False])
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
|
@ -339,5 +343,6 @@ def main():
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
module.fail_json(msg=to_native(e))
|
module.fail_json(msg=to_native(e))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
main()
|
main()
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue