- Fix sanity checks
- Fixed documentation trailing whitespaces - Added missing/broken documentationpull/4420/head
parent
617e20e955
commit
d3865a0a8a
|
@ -17,16 +17,16 @@ DOCUMENTATION = """
|
||||||
---
|
---
|
||||||
module: utm_proxy_frontend
|
module: utm_proxy_frontend
|
||||||
|
|
||||||
author:
|
author:
|
||||||
- Johannes Brunswicker (@MatrixCrawler)
|
- Johannes Brunswicker (@MatrixCrawler)
|
||||||
|
|
||||||
short_description: create, update or destroy reverse_proxy frontend entry in Sophos UTM
|
short_description: create, update or destroy reverse_proxy frontend entry in Sophos UTM
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Create, update or destroy a reverse_proxy frontend entry in SOPHOS UTM.
|
- 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.
|
- 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:
|
||||||
|
@ -35,7 +35,8 @@ options:
|
||||||
required: true
|
required: true
|
||||||
add_content_type_header :
|
add_content_type_header :
|
||||||
description:
|
description:
|
||||||
- whether to add he content type header or not
|
- Whether to add the content type header or not
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
address:
|
address:
|
||||||
description:
|
description:
|
||||||
|
@ -56,6 +57,7 @@ options:
|
||||||
disable_compression:
|
disable_compression:
|
||||||
description:
|
description:
|
||||||
- Whether to enable the compression
|
- Whether to enable the compression
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
domain:
|
domain:
|
||||||
description:
|
description:
|
||||||
|
@ -66,19 +68,22 @@ options:
|
||||||
default: []
|
default: []
|
||||||
htmlrewrite:
|
htmlrewrite:
|
||||||
description:
|
description:
|
||||||
- whether to enable html rewrite or not
|
- Whether to enable html rewrite or not
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
htmlrewrite_cookies:
|
htmlrewrite_cookies:
|
||||||
description:
|
description:
|
||||||
- whether to enable html rewrite cookie or not
|
- Whether to enable html rewrite cookie or not
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
implicitredirect:
|
implicitredirect:
|
||||||
description:
|
description:
|
||||||
- whether to enable implicit redirection or not
|
- Whether to enable implicit redirection or not
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
lbmethod:
|
lbmethod:
|
||||||
description:
|
description:
|
||||||
- which loadbalancer method should be used
|
- Which loadbalancer method should be used
|
||||||
choices:
|
choices:
|
||||||
- ""
|
- ""
|
||||||
- bybusyness
|
- bybusyness
|
||||||
|
@ -89,32 +94,35 @@ options:
|
||||||
description:
|
description:
|
||||||
- A list of location ref names (reverse_proxy/location)
|
- A list of location ref names (reverse_proxy/location)
|
||||||
default: []
|
default: []
|
||||||
port:
|
port:
|
||||||
description:
|
description:
|
||||||
- The frontend http port
|
- The frontend http port
|
||||||
default: 80
|
default: 80
|
||||||
preservehost:
|
preservehost:
|
||||||
description:
|
description:
|
||||||
- whether to preserve host header
|
- Whether to preserve host header
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
profile:
|
profile:
|
||||||
description:
|
description:
|
||||||
- the reference string of the reverse_proxy/profile
|
- The reference string of the reverse_proxy/profile
|
||||||
default: ""
|
default: ""
|
||||||
status:
|
status:
|
||||||
description:
|
description:
|
||||||
- whether to activate the frontend entry or not
|
- Whether to activate the frontend entry or not
|
||||||
|
type: bool
|
||||||
default: True
|
default: True
|
||||||
type:
|
type:
|
||||||
description:
|
description:
|
||||||
- which protocol should be used
|
- Which protocol should be used
|
||||||
choices:
|
choices:
|
||||||
- http
|
- http
|
||||||
- https
|
- https
|
||||||
default: http
|
default: http
|
||||||
xheaders:
|
xheaders:
|
||||||
description:
|
description:
|
||||||
- whether to pass the host header or not
|
- Whether to pass the host header or not
|
||||||
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
@ -123,18 +131,18 @@ extends_documentation_fragment:
|
||||||
|
|
||||||
EXAMPLES = """
|
EXAMPLES = """
|
||||||
- name: Create utm proxy_frontend
|
- name: Create utm proxy_frontend
|
||||||
utm_proxy_backend:
|
utm_proxy_frontend:
|
||||||
utm_host: sophos.host.name
|
utm_host: sophos.host.name
|
||||||
utm_token: abcdefghijklmno1234
|
utm_token: abcdefghijklmno1234
|
||||||
name: TestBackendEntry
|
name: TestFrontendEntry
|
||||||
host: REF_OBJECT_STRING
|
host: REF_OBJECT_STRING
|
||||||
state: present
|
state: present
|
||||||
|
|
||||||
- name: Remove utm proxy_backend
|
- name: Remove utm proxy_frontend
|
||||||
utm_proxy_backend:
|
utm_proxy_frontend:
|
||||||
utm_host: sophos.host.name
|
utm_host: sophos.host.name
|
||||||
utm_token: abcdefghijklmno1234
|
utm_token: abcdefghijklmno1234
|
||||||
name: TestBackendEntry
|
name: TestFrontendEntry
|
||||||
state: absent
|
state: absent
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
@ -184,10 +192,10 @@ result:
|
||||||
description: State of html rewrite
|
description: State of html rewrite
|
||||||
type: bool
|
type: bool
|
||||||
htmlrewrite_cookies:
|
htmlrewrite_cookies:
|
||||||
description: whether the html rewrite cookie will be set
|
description: Whether the html rewrite cookie will be set
|
||||||
type: bool
|
type: bool
|
||||||
implicitredirect:
|
implicitredirect:
|
||||||
description: whether to use implicit redirection
|
description: Whether to use implicit redirection
|
||||||
type: bool
|
type: bool
|
||||||
lbmethod:
|
lbmethod:
|
||||||
description: The method of loadbalancer to use
|
description: The method of loadbalancer to use
|
||||||
|
|
Loading…
Reference in New Issue