mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-06-29 12:10:20 -07:00
adding ansible types in documentation (#303)
Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician
Alex Stephen
parent
72e4cc7214
commit
43536a1e38
81 changed files with 844 additions and 0 deletions
|
|
@ -60,17 +60,20 @@ options:
|
|||
- How often (in seconds) to send a health check. The default value is 5 seconds.
|
||||
required: false
|
||||
default: '5'
|
||||
type: int
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
required: false
|
||||
type: str
|
||||
healthy_threshold:
|
||||
description:
|
||||
- A so-far unhealthy instance will be marked healthy after this many consecutive
|
||||
successes. The default value is 2.
|
||||
required: false
|
||||
default: '2'
|
||||
type: int
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. The
|
||||
|
|
@ -80,6 +83,7 @@ options:
|
|||
characters must be a dash, lowercase letter, or digit, except the last character,
|
||||
which cannot be a dash.
|
||||
required: true
|
||||
type: str
|
||||
timeout_sec:
|
||||
description:
|
||||
- How long (in seconds) to wait before claiming failure.
|
||||
|
|
@ -87,6 +91,7 @@ options:
|
|||
value than checkIntervalSec.
|
||||
required: false
|
||||
default: '5'
|
||||
type: int
|
||||
aliases:
|
||||
- timeout_seconds
|
||||
unhealthy_threshold:
|
||||
|
|
@ -95,6 +100,7 @@ options:
|
|||
failures. The default value is 2.
|
||||
required: false
|
||||
default: '2'
|
||||
type: int
|
||||
type:
|
||||
description:
|
||||
- Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not
|
||||
|
|
@ -102,10 +108,12 @@ options:
|
|||
field must be specified, which must match type field.
|
||||
- 'Some valid choices include: "TCP", "SSL", "HTTP", "HTTPS"'
|
||||
required: false
|
||||
type: str
|
||||
http_health_check:
|
||||
description:
|
||||
- A nested object resource.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
host:
|
||||
description:
|
||||
|
|
@ -113,28 +121,33 @@ options:
|
|||
- If left empty (default value), the public IP on behalf of which this health
|
||||
check is performed will be used.
|
||||
required: false
|
||||
type: str
|
||||
request_path:
|
||||
description:
|
||||
- The request path of the HTTP health check request.
|
||||
- The default value is /.
|
||||
required: false
|
||||
default: "/"
|
||||
type: str
|
||||
response:
|
||||
description:
|
||||
- The bytes to match against the beginning of the response data. If left empty
|
||||
(the default value), any response will indicate health. The response data
|
||||
can only be ASCII.
|
||||
required: false
|
||||
type: str
|
||||
port:
|
||||
description:
|
||||
- The TCP port number for the HTTP health check request.
|
||||
- The default value is 80.
|
||||
required: false
|
||||
type: int
|
||||
port_name:
|
||||
description:
|
||||
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
|
||||
are defined, port takes precedence.
|
||||
required: false
|
||||
type: str
|
||||
proxy_header:
|
||||
description:
|
||||
- Specifies the type of proxy header to append before sending data to the
|
||||
|
|
@ -142,10 +155,12 @@ options:
|
|||
- 'Some valid choices include: "NONE", "PROXY_V1"'
|
||||
required: false
|
||||
default: NONE
|
||||
type: str
|
||||
https_health_check:
|
||||
description:
|
||||
- A nested object resource.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
host:
|
||||
description:
|
||||
|
|
@ -153,28 +168,33 @@ options:
|
|||
- If left empty (default value), the public IP on behalf of which this health
|
||||
check is performed will be used.
|
||||
required: false
|
||||
type: str
|
||||
request_path:
|
||||
description:
|
||||
- The request path of the HTTPS health check request.
|
||||
- The default value is /.
|
||||
required: false
|
||||
default: "/"
|
||||
type: str
|
||||
response:
|
||||
description:
|
||||
- The bytes to match against the beginning of the response data. If left empty
|
||||
(the default value), any response will indicate health. The response data
|
||||
can only be ASCII.
|
||||
required: false
|
||||
type: str
|
||||
port:
|
||||
description:
|
||||
- The TCP port number for the HTTPS health check request.
|
||||
- The default value is 443.
|
||||
required: false
|
||||
type: int
|
||||
port_name:
|
||||
description:
|
||||
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
|
||||
are defined, port takes precedence.
|
||||
required: false
|
||||
type: str
|
||||
proxy_header:
|
||||
description:
|
||||
- Specifies the type of proxy header to append before sending data to the
|
||||
|
|
@ -182,10 +202,12 @@ options:
|
|||
- 'Some valid choices include: "NONE", "PROXY_V1"'
|
||||
required: false
|
||||
default: NONE
|
||||
type: str
|
||||
tcp_health_check:
|
||||
description:
|
||||
- A nested object resource.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
request:
|
||||
description:
|
||||
|
|
@ -193,22 +215,26 @@ options:
|
|||
(default value is empty). If both request and response are empty, the connection
|
||||
establishment alone will indicate health. The request data can only be ASCII.
|
||||
required: false
|
||||
type: str
|
||||
response:
|
||||
description:
|
||||
- The bytes to match against the beginning of the response data. If left empty
|
||||
(the default value), any response will indicate health. The response data
|
||||
can only be ASCII.
|
||||
required: false
|
||||
type: str
|
||||
port:
|
||||
description:
|
||||
- The TCP port number for the TCP health check request.
|
||||
- The default value is 443.
|
||||
required: false
|
||||
type: int
|
||||
port_name:
|
||||
description:
|
||||
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
|
||||
are defined, port takes precedence.
|
||||
required: false
|
||||
type: str
|
||||
proxy_header:
|
||||
description:
|
||||
- Specifies the type of proxy header to append before sending data to the
|
||||
|
|
@ -216,10 +242,12 @@ options:
|
|||
- 'Some valid choices include: "NONE", "PROXY_V1"'
|
||||
required: false
|
||||
default: NONE
|
||||
type: str
|
||||
ssl_health_check:
|
||||
description:
|
||||
- A nested object resource.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
request:
|
||||
description:
|
||||
|
|
@ -227,22 +255,26 @@ options:
|
|||
(default value is empty). If both request and response are empty, the connection
|
||||
establishment alone will indicate health. The request data can only be ASCII.
|
||||
required: false
|
||||
type: str
|
||||
response:
|
||||
description:
|
||||
- The bytes to match against the beginning of the response data. If left empty
|
||||
(the default value), any response will indicate health. The response data
|
||||
can only be ASCII.
|
||||
required: false
|
||||
type: str
|
||||
port:
|
||||
description:
|
||||
- The TCP port number for the SSL health check request.
|
||||
- The default value is 443.
|
||||
required: false
|
||||
type: int
|
||||
port_name:
|
||||
description:
|
||||
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
|
||||
are defined, port takes precedence.
|
||||
required: false
|
||||
type: str
|
||||
proxy_header:
|
||||
description:
|
||||
- Specifies the type of proxy header to append before sending data to the
|
||||
|
|
@ -250,6 +282,7 @@ options:
|
|||
- 'Some valid choices include: "NONE", "PROXY_V1"'
|
||||
required: false
|
||||
default: NONE
|
||||
type: str
|
||||
extends_documentation_fragment: gcp
|
||||
notes:
|
||||
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks)'
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue