archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Bug fixes for gcp_compute_backend_service_facts (#44291)

Browse Source
pull/41255/merge
Alex Stephen 7 years ago committed by Ryan Brown
parent b56639447f
commit 2fe1f3deb4
1 changed files with 224 additions and 219 deletions
Show Stats Download Patch File Download Diff File

443
lib/ansible/modules/cloud/google/gcp_compute_backend_service_facts.py
Unescape Escape View File

@ -61,228 +61,233 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
affinity_cookie_ttl_sec: items:
description: description: List of items
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to returned: always
0, the cookie is non-persistent and lasts only until the end of the browser session type: complex
(or equivalent). The maximum allowed value for TTL is one day. contains:
- When the load balancing scheme is INTERNAL, this field is not used. affinity_cookie_ttl_sec:
returned: success
type: int
backends:
description:
- The list of backends that serve this BackendService.
returned: success
type: complex
contains:
balancing_mode:
description:
- Specifies the balancing mode for this backend.
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid
values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
- This cannot be used for internal load balancing.
returned: success
type: str
capacity_scaler:
description:
- A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION,
RATE or CONNECTION).
- Default value is 1, which means the group will serve up to 100% of its configured
capacity (depending on balancingMode). A setting of 0 means the group is completely
drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
- This cannot be used for internal load balancing.
returned: success
type: str
description: description:
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to
0, the cookie is non-persistent and lasts only until the end of the browser session
(or equivalent). The maximum allowed value for TTL is one day.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success
type: int
backends:
description:
- The list of backends that serve this BackendService.
returned: success
type: complex
contains:
balancing_mode:
description:
- Specifies the balancing mode for this backend.
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid
values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
- This cannot be used for internal load balancing.
returned: success
type: str
capacity_scaler:
description:
- A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION,
RATE or CONNECTION).
- Default value is 1, which means the group will serve up to 100% of its configured
capacity (depending on balancingMode). A setting of 0 means the group is completely
drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
- This cannot be used for internal load balancing.
returned: success
type: str
description: description:
- An optional description of this resource. description:
- Provide this property when you create the resource. - An optional description of this resource.
returned: success - Provide this property when you create the resource.
type: str returned: success
group: type: str
description: group:
- This instance group defines the list of instances that serve traffic. Member virtual description:
machine instances from each instance group must live in the same zone as the instance - This instance group defines the list of instances that serve traffic. Member virtual
group itself. machine instances from each instance group must live in the same zone as the instance
- No two backends in a backend service are allowed to use same Instance Group resource. group itself.
- When the BackendService has load balancing scheme INTERNAL, the instance group must - No two backends in a backend service are allowed to use same Instance Group resource.
be in a zone within the same region as the BackendService. - When the BackendService has load balancing scheme INTERNAL, the instance group must
returned: success be in a zone within the same region as the BackendService.
type: dict returned: success
max_connections: type: dict
description: max_connections:
- The max number of simultaneous connections for the group. Can be used with either description:
CONNECTION or UTILIZATION balancing modes. - The max number of simultaneous connections for the group. Can be used with either
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be CONNECTION or UTILIZATION balancing modes.
set. - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
- This cannot be used for internal load balancing. set.
returned: success - This cannot be used for internal load balancing.
type: int returned: success
max_connections_per_instance: type: int
description: max_connections_per_instance:
- The max number of simultaneous connections that a single backend instance can handle. description:
This is used to calculate the capacity of the group. Can be used in either CONNECTION - The max number of simultaneous connections that a single backend instance can handle.
or UTILIZATION balancing modes. This is used to calculate the capacity of the group. Can be used in either CONNECTION
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be or UTILIZATION balancing modes.
set. - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
- This cannot be used for internal load balancing. set.
returned: success - This cannot be used for internal load balancing.
type: int returned: success
max_rate: type: int
description: max_rate:
- The max requests per second (RPS) of the group. description:
- Can be used with either RATE or UTILIZATION balancing modes, but required if RATE - The max requests per second (RPS) of the group.
mode. For RATE mode, either maxRate or maxRatePerInstance must be set. - Can be used with either RATE or UTILIZATION balancing modes, but required if RATE
- This cannot be used for internal load balancing. mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
returned: success - This cannot be used for internal load balancing.
type: int returned: success
max_rate_per_instance: type: int
description: max_rate_per_instance:
- The max requests per second (RPS) that a single backend instance can handle. This description:
is used to calculate the capacity of the group. Can be used in either balancing - The max requests per second (RPS) that a single backend instance can handle. This
mode. For RATE mode, either maxRate or maxRatePerInstance must be set. is used to calculate the capacity of the group. Can be used in either balancing
- This cannot be used for internal load balancing. mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
returned: success - This cannot be used for internal load balancing.
type: str returned: success
max_utilization: type: str
description: max_utilization:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target description:
for the group. The default is 0.8. Valid range is [0.0, 1.0]. - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target
- This cannot be used for internal load balancing. for the group. The default is 0.8. Valid range is [0.0, 1.0].
returned: success - This cannot be used for internal load balancing.
type: str returned: success
cdn_policy: type: str
description: cdn_policy:
- Cloud CDN configuration for this BackendService. description:
returned: success - Cloud CDN configuration for this BackendService.
type: complex returned: success
contains: type: complex
cache_key_policy: contains:
description: cache_key_policy:
- The CacheKeyPolicy for this CdnPolicy. description:
returned: success - The CacheKeyPolicy for this CdnPolicy.
type: complex returned: success
contains: type: complex
include_host: contains:
description: include_host:
- If true requests to different hosts will be cached separately. description:
returned: success - If true requests to different hosts will be cached separately.
type: bool returned: success
include_protocol: type: bool
description: include_protocol:
- If true, http and https requests will be cached separately. description:
returned: success - If true, http and https requests will be cached separately.
type: bool returned: success
include_query_string: type: bool
description: include_query_string:
- If true, include query string parameters in the cache key according to query_string_whitelist description:
and query_string_blacklist. If neither is set, the entire query string will be included. - If true, include query string parameters in the cache key according to query_string_whitelist
- If false, the query string will be excluded from the cache key entirely. and query_string_blacklist. If neither is set, the entire query string will be included.
returned: success - If false, the query string will be excluded from the cache key entirely.
type: bool returned: success
query_string_blacklist: type: bool
description: query_string_blacklist:
- Names of query string parameters to exclude in cache keys. description:
- All other parameters will be included. Either specify query_string_whitelist or - Names of query string parameters to exclude in cache keys.
query_string_blacklist, not both. - All other parameters will be included. Either specify query_string_whitelist or
- "'&' and '=' will be percent encoded and not treated as delimiters." query_string_blacklist, not both.
returned: success - "'&' and '=' will be percent encoded and not treated as delimiters."
type: list returned: success
query_string_whitelist: type: list
description: query_string_whitelist:
- Names of query string parameters to include in cache keys. description:
- All other parameters will be excluded. Either specify query_string_whitelist or - Names of query string parameters to include in cache keys.
query_string_blacklist, not both. - All other parameters will be excluded. Either specify query_string_whitelist or
- "'&' and '=' will be percent encoded and not treated as delimiters." query_string_blacklist, not both.
returned: success - "'&' and '=' will be percent encoded and not treated as delimiters."
type: list returned: success
connection_draining: type: list
description: connection_draining:
- Settings for connection draining. description:
returned: success - Settings for connection draining.
type: complex returned: success
contains: type: complex
draining_timeout_sec: contains:
description: draining_timeout_sec:
- Time for which instance will be drained (not accept new connections, but still work description:
to finish started). - Time for which instance will be drained (not accept new connections, but still work
returned: success to finish started).
type: int returned: success
creation_timestamp: type: int
description: creation_timestamp:
- Creation timestamp in RFC3339 text format. description:
returned: success - Creation timestamp in RFC3339 text format.
type: str returned: success
description: type: str
description:
- An optional description of this resource.
returned: success
type: str
enable_cdn:
description:
- If true, enable Cloud CDN for this BackendService.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success
type: bool
health_checks:
description:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified,
and a health check is required.
- For internal load balancing, a URL to a HealthCheck resource must be specified instead.
returned: success
type: list
id:
description:
- The unique identifier for the resource.
returned: success
type: int
name:
description:
- Name of the resource. Provided by the client when the resource is created. The name
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
which means the first character must be a lowercase letter, and all following characters
must be a dash, lowercase letter, or digit, except the last character, which cannot
be a dash.
returned: success
type: str
port_name:
description:
- Name of backend port. The same name should appear in the instance groups referenced
by this service. Required when the load balancing scheme is EXTERNAL.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success
type: str
protocol:
description:
- The protocol this BackendService uses to communicate with backends.
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
- For internal load balancing, the possible values are TCP and UDP, and the default
is TCP.
returned: success
type: str
region:
description:
- The region where the regional backend service resides.
- This field is not applicable to global backend services.
returned: success
type: str
session_affinity:
description:
- Type of session affinity to use. The default is NONE.
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
or CLIENT_IP_PORT_PROTO.
- When the protocol is UDP, this field is not used.
returned: success
type: str
timeout_sec:
description: description:
- How many seconds to wait for the backend before considering it a failed request. description:
Default is 30 seconds. Valid range is [1, 86400]. - An optional description of this resource.
returned: success returned: success
type: int type: str
enable_cdn:
description:
- If true, enable Cloud CDN for this BackendService.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success
type: bool
health_checks:
description:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified,
and a health check is required.
- For internal load balancing, a URL to a HealthCheck resource must be specified instead.
returned: success
type: list
id:
description:
- The unique identifier for the resource.
returned: success
type: int
name:
description:
- Name of the resource. Provided by the client when the resource is created. The name
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
which means the first character must be a lowercase letter, and all following characters
must be a dash, lowercase letter, or digit, except the last character, which cannot
be a dash.
returned: success
type: str
port_name:
description:
- Name of backend port. The same name should appear in the instance groups referenced
by this service. Required when the load balancing scheme is EXTERNAL.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success
type: str
protocol:
description:
- The protocol this BackendService uses to communicate with backends.
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
- For internal load balancing, the possible values are TCP and UDP, and the default
is TCP.
returned: success
type: str
region:
description:
- The region where the regional backend service resides.
- This field is not applicable to global backend services.
returned: success
type: str
session_affinity:
description:
- Type of session affinity to use. The default is NONE.
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
or CLIENT_IP_PORT_PROTO.
- When the protocol is UDP, this field is not used.
returned: success
type: str
timeout_sec:
description:
- How many seconds to wait for the backend before considering it a failed request.
Default is 30 seconds. Valid range is [1, 86400].
returned: success
type: int
''' '''
################################################################################ ################################################################################

Write Preview
Loading…
Cancel
Save