ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-07-27 07:01:32 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Return values should be camelcase instead of underscored (#95)

Browse source
This commit is contained in:
The Magician 2018-09-21 13:34:13 -07:00 • committed by Alex Stephen
commit b3c1afe126
71 changed files with 6574 additions and 6906 deletions
Download patch file Download diff file Expand all files Collapse all files

14
plugins/modules/gcp_compute_address.py
View file

@ -168,19 +168,11 @@ name:
except the last character, which cannot be a dash. except the last character, which cannot be a dash.
returned: success returned: success
type: str type: str
networkTier:
description:
- 'The networking tier used for configuring this address. This field can take the
following values: PREMIUM or STANDARD. If this field is not specified, it is assumed
to be PREMIUM.'
returned: success
type: str
subnetwork: subnetwork:
description: description:
- The URL of the subnetwork in which to reserve the address. If an IP address is - The URL of the subnetwork in which to reserve the address. If an IP address is specified,
specified, it must be within the subnetwork's IP range. it must be within the subnetwork's IP range.
- This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.
purposes.
returned: success returned: success
type: dict type: dict
users: users:

34
plugins/modules/gcp_compute_address_facts.py
View file

@ -65,16 +65,16 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
address: address:
description: description:
- The static external IP address represented by this resource. Only IPv4 is - The static external IP address represented by this resource. Only IPv4 is supported.
supported. An address may only be specified for INTERNAL address types. The An address may only be specified for INTERNAL address types. The IP address must
IP address must be inside the specified subnetwork, if any. be inside the specified subnetwork, if any.
returned: success returned: success
type: str type: str
addressType: addressType:
@ -100,26 +100,18 @@ resources:
type: int type: int
name: name:
description: description:
- Name of the resource. The name must be 1-63 characters long, and comply with - Name of the resource. The name must be 1-63 characters long, and comply with RFC1035.
RFC1035. Specifically, the name must be 1-63 characters long and match the Specifically, the name must be 1-63 characters long and match the regular expression
regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase
must be a lowercase letter, and all following characters must be a dash, lowercase letter, and all following characters must be a dash, lowercase letter, or digit,
letter, or digit, except the last character, which cannot be a dash. except the last character, which cannot be a dash.
returned: success
type: str
networkTier:
description:
- 'The networking tier used for configuring this address. This field can take
the following values: PREMIUM or STANDARD. If this field is not specified,
it is assumed to be PREMIUM.'
returned: success returned: success
type: str type: str
subnetwork: subnetwork:
description: description:
- The URL of the subnetwork in which to reserve the address. If an IP address - The URL of the subnetwork in which to reserve the address. If an IP address is specified,
is specified, it must be within the subnetwork's IP range. it must be within the subnetwork's IP range.
- This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.
purposes.
returned: success returned: success
type: dict type: dict
users: users:

29
plugins/modules/gcp_compute_backend_bucket.py
View file

@ -125,23 +125,6 @@ bucketName:
- Cloud Storage bucket name. - Cloud Storage bucket name.
returned: success returned: success
type: str type: str
cdnPolicy:
description:
- Cloud CDN configuration for this Backend Bucket.
returned: success
type: complex
contains:
signedUrlCacheMaxAgeSec:
description:
- Maximum number of seconds the response to a signed URL request will be considered
fresh. Defaults to 1hr (3600s). After this time period, the response will
be revalidated before being served.
- 'When serving responses to signed URL requests, Cloud CDN will internally
behave as though all responses from this backend had a "Cache-Control: public,
max-age=[TTL]" header, regardless of any existing Cache-Control header. The
actual headers served in responses will not be altered.'
returned: success
type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
@ -165,12 +148,12 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
''' '''

37
plugins/modules/gcp_compute_backend_bucket_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -69,23 +69,6 @@ resources:
- Cloud Storage bucket name. - Cloud Storage bucket name.
returned: success returned: success
type: str type: str
cdnPolicy:
description:
- Cloud CDN configuration for this Backend Bucket.
returned: success
type: complex
contains:
signedUrlCacheMaxAgeSec:
description:
- Maximum number of seconds the response to a signed URL request will be
considered fresh. Defaults to 1hr (3600s). After this time period, the
response will be revalidated before being served.
- 'When serving responses to signed URL requests, Cloud CDN will internally
behave as though all responses from this backend had a "Cache-Control:
public, max-age=[TTL]" header, regardless of any existing Cache-Control
header. The actual headers served in responses will not be altered.'
returned: success
type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
@ -93,8 +76,8 @@ resources:
type: str type: str
description: description:
description: description:
- An optional textual description of the resource; provided by the client when - An optional textual description of the resource; provided by the client when the
the resource is created. resource is created.
returned: success returned: success
type: str type: str
enableCdn: enableCdn:
@ -109,12 +92,12 @@ resources:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
''' '''

138
plugins/modules/gcp_compute_backend_service.py
View file

@ -343,9 +343,9 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
affinityCookieTtlSec: affinityCookieTtlSec:
description: description:
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to
to 0, the cookie is non-persistent and lasts only until the end of the browser 0, the cookie is non-persistent and lasts only until the end of the browser session
session (or equivalent). The maximum allowed value for TTL is one day. (or equivalent). The maximum allowed value for TTL is one day.
- When the load balancing scheme is INTERNAL, this field is not used. - When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: int type: int
@ -358,8 +358,9 @@ backends:
balancingMode: balancingMode:
description: description:
- Specifies the balancing mode for this backend. - Specifies the balancing mode for this backend.
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid
Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
capacityScaler: capacityScaler:
@ -369,6 +370,7 @@ backends:
- Default value is 1, which means the group will serve up to 100% of its configured - 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 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]. drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
description: description:
@ -379,57 +381,54 @@ backends:
type: str type: str
group: group:
description: description:
- The fully-qualified URL of an Instance Group or Network Endpoint Group resource. - This instance group defines the list of instances that serve traffic. Member virtual
In case of instance group this defines the list of instances that serve traffic. machine instances from each instance group must live in the same zone as the instance
Member virtual machine instances from each instance group must live in the group itself.
same zone as the instance group itself. No two backends in a backend service - No two backends in a backend service are allowed to use same Instance Group resource.
are allowed to use same Instance Group resource. - When the BackendService has load balancing scheme INTERNAL, the instance group must
- For Network Endpoint Groups this defines list of endpoints. All endpoints be in a zone within the same region as the BackendService.
of Network Endpoint Group must be hosted on instances located in the same
zone as the Network Endpoint Group.
- Backend service can not contain mix of Instance Group and Network Endpoint
Group backends.
- Note that you must specify an Instance Group or Network Endpoint Group resource
using the fully-qualified URL, rather than a partial URL.
returned: success returned: success
type: str type: dict
maxConnections: maxConnections:
description: description:
- The max number of simultaneous connections for the group. Can be used with - The max number of simultaneous connections for the group. Can be used with either
either CONNECTION or UTILIZATION balancing modes. CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
be set. set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxConnectionsPerInstance: maxConnectionsPerInstance:
description: description:
- The max number of simultaneous connections that a single backend instance - The max number of simultaneous connections that a single backend instance can handle.
can handle. This is used to calculate the capacity of the group. Can be used This is used to calculate the capacity of the group. Can be used in either CONNECTION
in either CONNECTION or UTILIZATION balancing modes. or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
be set. set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxRate: maxRate:
description: description:
- The max requests per second (RPS) of the group. - The max requests per second (RPS) of the group.
- Can be used with either RATE or UTILIZATION balancing modes, but required - Can be used with either RATE or UTILIZATION balancing modes, but required if RATE
if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
set. - This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxRatePerInstance: maxRatePerInstance:
description: description:
- The max requests per second (RPS) that a single backend instance can handle. - The max requests per second (RPS) that a single backend instance can handle. This
This is used to calculate the capacity of the group. Can be used in either is used to calculate the capacity of the group. Can be used in either balancing
balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
set. - This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
maxUtilization: maxUtilization:
description: description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target
target for the group. The default is 0.8. Valid range is [0.0, 1.0]. for the group. The default is 0.8. Valid range is [0.0, 1.0].
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
cdnPolicy: cdnPolicy:
@ -456,39 +455,27 @@ cdnPolicy:
type: bool type: bool
includeQueryString: includeQueryString:
description: description:
- If true, include query string parameters in the cache key according to - If true, include query string parameters in the cache key according to query_string_whitelist
query_string_whitelist and query_string_blacklist. If neither is set, and query_string_blacklist. If neither is set, the entire query string will be included.
the entire query string will be included.
- If false, the query string will be excluded from the cache key entirely. - If false, the query string will be excluded from the cache key entirely.
returned: success returned: success
type: bool type: bool
queryStringBlacklist: queryStringBlacklist:
description: description:
- Names of query string parameters to exclude in cache keys. - Names of query string parameters to exclude in cache keys.
- All other parameters will be included. Either specify query_string_whitelist - All other parameters will be included. Either specify query_string_whitelist or
or query_string_blacklist, not both. query_string_blacklist, not both.
- "'&' and '=' will be percent encoded and not treated as delimiters." - "'&' and '=' will be percent encoded and not treated as delimiters."
returned: success returned: success
type: list type: list
queryStringWhitelist: queryStringWhitelist:
description: description:
- Names of query string parameters to include in cache keys. - Names of query string parameters to include in cache keys.
- All other parameters will be excluded. Either specify query_string_whitelist - All other parameters will be excluded. Either specify query_string_whitelist or
or query_string_blacklist, not both. query_string_blacklist, not both.
- "'&' and '=' will be percent encoded and not treated as delimiters." - "'&' and '=' will be percent encoded and not treated as delimiters."
returned: success returned: success
type: list type: list
signedUrlCacheMaxAgeSec:
description:
- Maximum number of seconds the response to a signed URL request will be considered
fresh, defaults to 1hr (3600s). After this time period, the response will
be revalidated before being served.
- 'When serving responses to signed URL requests, Cloud CDN will internally
behave as though all responses from this backend had a "Cache-Control: public,
max-age=[TTL]" header, regardless of any existing Cache-Control header. The
actual headers served in responses will not be altered.'
returned: success
type: int
connectionDraining: connectionDraining:
description: description:
- Settings for connection draining. - Settings for connection draining.
@ -497,8 +484,8 @@ connectionDraining:
contains: contains:
drainingTimeoutSec: drainingTimeoutSec:
description: description:
- Time for which instance will be drained (not accept new connections, but still - Time for which instance will be drained (not accept new connections, but still work
work to finish started). to finish started).
returned: success returned: success
type: int type: int
creationTimestamp: creationTimestamp:
@ -506,12 +493,6 @@ creationTimestamp:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
fingerprint:
description:
- Fingerprint of this resource. A hash of the contents stored in this object. This
field is used in optimistic locking.
returned: success
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
@ -520,6 +501,7 @@ description:
enableCDN: enableCDN:
description: description:
- If true, enable Cloud CDN for this BackendService. - If true, enable Cloud CDN for this BackendService.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: bool type: bool
healthChecks: healthChecks:
@ -527,6 +509,7 @@ healthChecks:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health - The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified, checking this BackendService. Currently at most one health check can be specified,
and a health check is required. and a health check is required.
- For internal load balancing, a URL to a HealthCheck resource must be specified instead.
returned: success returned: success
type: list type: list
id: id:
@ -563,44 +546,47 @@ iap:
loadBalancingScheme: loadBalancingScheme:
description: description:
- Indicates whether the backend service will be used with internal or external load - Indicates whether the backend service will be used with internal or external load
balancing. A backend service created for one type of load balancing cannot be balancing. A backend service created for one type of load balancing cannot be used
used with the other. Must be `EXTERNAL` for a global backend service. Defaults with the other.
to `EXTERNAL`.
returned: success returned: success
type: str type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
portName: portName:
description: description:
- Name of backend port. The same name should appear in the instance groups referenced - 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. 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 returned: success
type: str type: str
protocol: protocol:
description: description:
- The protocol this BackendService uses to communicate with backends. - The protocol this BackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. **NOTE**: - Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
HTTP2 is only valid for beta HTTP/2 load balancer types and may result in errors - For internal load balancing, the possible values are TCP and UDP, and the default
if used with the GA API.' is TCP.
returned: success returned: success
type: str type: str
securityPolicy: region:
description: description:
- The security policy associated with this backend service. - The region where the regional backend service resides.
- This field is not applicable to global backend services.
returned: success returned: success
type: str type: str
sessionAffinity: sessionAffinity:
description: description:
- Type of session affinity to use. The default is NONE. - 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 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. - When the protocol is UDP, this field is not used.
returned: success returned: success
type: str type: str

166
plugins/modules/gcp_compute_backend_service_facts.py
View file

@ -59,17 +59,16 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
affinityCookieTtlSec: affinityCookieTtlSec:
description: description:
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to
set to 0, the cookie is non-persistent and lasts only until the end of the 0, the cookie is non-persistent and lasts only until the end of the browser session
browser session (or equivalent). The maximum allowed value for TTL is one (or equivalent). The maximum allowed value for TTL is one day.
day.
- When the load balancing scheme is INTERNAL, this field is not used. - When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: int type: int
@ -82,18 +81,139 @@ resources:
balancingMode: balancingMode:
description: description:
- Specifies the balancing mode for this backend. - Specifies the balancing mode for this backend.
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid
Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
capacityScaler: capacityScaler:
description: description:
- A multiplier applied to the group's maximum servicing capacity (based - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION,
on UTILIZATION, RATE or CONNECTION). RATE or CONNECTION).
- Default value is 1, which means the group will serve up to 100% of its - Default value is 1, which means the group will serve up to 100% of its configured
configured capacity (depending on balancingMode). A setting of 0 means capacity (depending on balancingMode). A setting of 0 means the group is completely
the group is completely drained, offering 0% of its available Capacity. drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
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.
- Provide this property when you create the resource.
returned: success
type: str
group:
description:
- This instance group defines the list of instances that serve traffic. Member virtual
machine instances from each instance group must live in the same zone as the instance
group itself.
- No two backends in a backend service are allowed to use same Instance Group resource.
- When the BackendService has load balancing scheme INTERNAL, the instance group must
be in a zone within the same region as the BackendService.
returned: success
type: dict
maxConnections:
description:
- The max number of simultaneous connections for the group. Can be used with either
CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
set.
- This cannot be used for internal load balancing.
returned: success
type: int
maxConnectionsPerInstance:
description:
- The max number of simultaneous connections that a single backend instance can handle.
This is used to calculate the capacity of the group. Can be used in either CONNECTION
or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
set.
- This cannot be used for internal load balancing.
returned: success
type: int
maxRate:
description:
- The max requests per second (RPS) of the group.
- Can be used with either RATE or UTILIZATION balancing modes, but required if RATE
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- This cannot be used for internal load balancing.
returned: success
type: int
maxRatePerInstance:
description:
- The max requests per second (RPS) that a single backend instance can handle. This
is used to calculate the capacity of the group. Can be used in either balancing
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
- This cannot be used for internal load balancing.
returned: success
type: str
maxUtilization:
description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target
for the group. The default is 0.8. Valid range is [0.0, 1.0].
- This cannot be used for internal load balancing.
returned: success
type: str
cdnPolicy:
description:
- Cloud CDN configuration for this BackendService.
returned: success
type: complex
contains:
cacheKeyPolicy:
description:
- The CacheKeyPolicy for this CdnPolicy.
returned: success
type: complex
contains:
includeHost:
description:
- If true requests to different hosts will be cached separately.
returned: success
type: bool
includeProtocol:
description:
- If true, http and https requests will be cached separately.
returned: success
type: bool
includeQueryString:
description:
- If true, include query string parameters in the cache key according to query_string_whitelist
and query_string_blacklist. If neither is set, the entire query string will be included.
- If false, the query string will be excluded from the cache key entirely.
returned: success
type: bool
queryStringBlacklist:
description:
- Names of query string parameters to exclude in cache keys.
- All other parameters will be included. Either specify query_string_whitelist or
query_string_blacklist, not both.
- "'&' and '=' will be percent encoded and not treated as delimiters."
returned: success
type: list
queryStringWhitelist:
description:
- Names of query string parameters to include in cache keys.
- All other parameters will be excluded. Either specify query_string_whitelist or
query_string_blacklist, not both.
- "'&' and '=' will be percent encoded and not treated as delimiters."
returned: success
type: list
connectionDraining:
description:
- Settings for connection draining.
returned: success
type: complex
contains:
drainingTimeoutSec:
description:
- Time for which instance will be drained (not accept new connections, but still work
to finish started).
returned: success
type: int
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
@ -101,13 +221,13 @@ resources:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
enable_cdn: enableCDN:
description: description:
- If true, enable Cloud CDN for this BackendService. - If true, enable Cloud CDN for this BackendService.
- When the load balancing scheme is INTERNAL, this field is not used. - When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: bool type: bool
health_checks: healthChecks:
description: description:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health - The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified, checking this BackendService. Currently at most one health check can be specified,
@ -131,22 +251,22 @@ resources:
- Enables IAP. - Enables IAP.
returned: success returned: success
type: bool type: bool
oauth2_client_id: oauth2ClientId:
description: description:
- OAuth2 Client ID for IAP. - OAuth2 Client ID for IAP.
returned: success returned: success
type: str type: str
oauth2_client_secret: oauth2ClientSecret:
description: description:
- OAuth2 Client Secret for IAP. - OAuth2 Client Secret for IAP.
returned: success returned: success
type: str type: str
oauth2_client_secret_sha256: oauth2ClientSecretSha256:
description: description:
- OAuth2 Client Secret SHA-256 for IAP. - OAuth2 Client Secret SHA-256 for IAP.
returned: success returned: success
type: str type: str
load_balancing_scheme: loadBalancingScheme:
description: description:
- Indicates whether the backend service will be used with internal or external load - Indicates whether the backend service will be used with internal or external load
balancing. A backend service created for one type of load balancing cannot be used balancing. A backend service created for one type of load balancing cannot be used
@ -163,7 +283,7 @@ resources:
be a dash. be a dash.
returned: success returned: success
type: str type: str
port_name: portName:
description: description:
- Name of backend port. The same name should appear in the instance groups referenced - 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. by this service. Required when the load balancing scheme is EXTERNAL.
@ -184,7 +304,7 @@ resources:
- This field is not applicable to global backend services. - This field is not applicable to global backend services.
returned: success returned: success
type: str type: str
session_affinity: sessionAffinity:
description: description:
- Type of session affinity to use. The default is NONE. - 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 EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
@ -193,7 +313,7 @@ resources:
- When the protocol is UDP, this field is not used. - When the protocol is UDP, this field is not used.
returned: success returned: success
type: str type: str
timeout_sec: timeoutSec:
description: description:
- How many seconds to wait for the backend before considering it a failed request. - How many seconds to wait for the backend before considering it a failed request.
Default is 30 seconds. Valid range is [1, 86400]. Default is 30 seconds. Valid range is [1, 86400].

30
plugins/modules/gcp_compute_disk.py
View file

@ -204,13 +204,13 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.
returned: success returned: success
type: str type: str
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -226,12 +226,12 @@ RETURN = '''
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
last_attach_timestamp: lastAttachTimestamp:
description: description:
- Last attach timestamp in RFC3339 text format. - Last attach timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
last_detach_timestamp: lastDetachTimestamp:
description: description:
- Last dettach timestamp in RFC3339 text format. - Last dettach timestamp in RFC3339 text format.
returned: success returned: success
@ -256,7 +256,7 @@ RETURN = '''
be a dash. be a dash.
returned: success returned: success
type: str type: str
size_gb: sizeGb:
description: description:
- Size of the persistent disk, specified in GB. You can specify this field when creating - Size of the persistent disk, specified in GB. You can specify this field when creating
a persistent disk using the sourceImage or sourceSnapshot parameter, or specify a persistent disk using the sourceImage or sourceSnapshot parameter, or specify
@ -277,7 +277,7 @@ RETURN = '''
Provide this when creating the disk. Provide this when creating the disk.
returned: success returned: success
type: str type: str
source_image: sourceImage:
description: description:
- The source image used to create this disk. If the source image is deleted, this - The source image used to create this disk. If the source image is deleted, this
field will not be set. field will not be set.
@ -297,14 +297,14 @@ RETURN = '''
- A reference to the zone where the disk resides. - A reference to the zone where the disk resides.
returned: success returned: success
type: str type: str
source_image_encryption_key: sourceImageEncryptionKey:
description: description:
- The customer-supplied encryption key of the source image. Required if the source - The customer-supplied encryption key of the source image. Required if the source
image is protected by a customer-supplied encryption key. image is protected by a customer-supplied encryption key.
returned: success returned: success
type: complex type: complex
contains: contains:
raw_key: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
@ -316,7 +316,7 @@ RETURN = '''
that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
source_image_id: sourceImageId:
description: description:
- The ID value of the image used to create this disk. This value identifies the exact - The ID value of the image used to create this disk. This value identifies the exact
image that was used to create this persistent disk. For example, if you created image that was used to create this persistent disk. For example, if you created
@ -325,7 +325,7 @@ RETURN = '''
was used. was used.
returned: success returned: success
type: str type: str
disk_encryption_key: diskEncryptionKey:
description: description:
- Encrypts the disk using a customer-supplied encryption key. - Encrypts the disk using a customer-supplied encryption key.
- After you encrypt a disk with a customer-supplied key, you must provide the same - After you encrypt a disk with a customer-supplied key, you must provide the same
@ -338,7 +338,7 @@ RETURN = '''
returned: success returned: success
type: complex type: complex
contains: contains:
raw_key: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
@ -350,7 +350,7 @@ RETURN = '''
that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
source_snapshot: sourceSnapshot:
description: description:
- 'The source snapshot used to create this disk. You can provide this as a partial or - 'The source snapshot used to create this disk. You can provide this as a partial or
full URL to the resource. For example, the following are valid values: * full URL to the resource. For example, the following are valid values: *
@ -358,14 +358,14 @@ RETURN = '''
* `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` .' * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` .'
returned: success returned: success
type: dict type: dict
source_snapshot_encryption_key: sourceSnapshotEncryptionKey:
description: description:
- The customer-supplied encryption key of the source snapshot. Required if the source - The customer-supplied encryption key of the source snapshot. Required if the source
snapshot is protected by a customer-supplied encryption key. snapshot is protected by a customer-supplied encryption key.
returned: success returned: success
type: complex type: complex
contains: contains:
raw_key: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
@ -377,7 +377,7 @@ RETURN = '''
that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
source_snapshot_id: sourceSnapshotId:
description: description:
- The unique ID of the snapshot used to create this disk. This value identifies the - The unique ID of the snapshot used to create this disk. This value identifies the
exact snapshot that was used to create this persistent disk. For example, if you exact snapshot that was used to create this persistent disk. For example, if you

30
plugins/modules/gcp_compute_disk_facts.py
View file

@ -69,13 +69,13 @@ items:
returned: always returned: always
type: complex type: complex
contains: contains:
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.
returned: success returned: success
type: str type: str
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -91,12 +91,12 @@ items:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
last_attach_timestamp: lastAttachTimestamp:
description: description:
- Last attach timestamp in RFC3339 text format. - Last attach timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
last_detach_timestamp: lastDetachTimestamp:
description: description:
- Last dettach timestamp in RFC3339 text format. - Last dettach timestamp in RFC3339 text format.
returned: success returned: success
@ -121,7 +121,7 @@ items:
be a dash. be a dash.
returned: success returned: success
type: str type: str
size_gb: sizeGb:
description: description:
- Size of the persistent disk, specified in GB. You can specify this field when creating - Size of the persistent disk, specified in GB. You can specify this field when creating
a persistent disk using the sourceImage or sourceSnapshot parameter, or specify a persistent disk using the sourceImage or sourceSnapshot parameter, or specify
@ -142,7 +142,7 @@ items:
Provide this when creating the disk. Provide this when creating the disk.
returned: success returned: success
type: str type: str
source_image: sourceImage:
description: description:
- The source image used to create this disk. If the source image is deleted, this - The source image used to create this disk. If the source image is deleted, this
field will not be set. field will not be set.
@ -162,14 +162,14 @@ items:
- A reference to the zone where the disk resides. - A reference to the zone where the disk resides.
returned: success returned: success
type: str type: str
source_image_encryption_key: sourceImageEncryptionKey:
description: description:
- The customer-supplied encryption key of the source image. Required if the source - The customer-supplied encryption key of the source image. Required if the source
image is protected by a customer-supplied encryption key. image is protected by a customer-supplied encryption key.
returned: success returned: success
type: complex type: complex
contains: contains:
raw_key: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
@ -181,7 +181,7 @@ items:
that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
source_image_id: sourceImageId:
description: description:
- The ID value of the image used to create this disk. This value identifies the exact - The ID value of the image used to create this disk. This value identifies the exact
image that was used to create this persistent disk. For example, if you created image that was used to create this persistent disk. For example, if you created
@ -190,7 +190,7 @@ items:
was used. was used.
returned: success returned: success
type: str type: str
disk_encryption_key: diskEncryptionKey:
description: description:
- Encrypts the disk using a customer-supplied encryption key. - Encrypts the disk using a customer-supplied encryption key.
- After you encrypt a disk with a customer-supplied key, you must provide the same - After you encrypt a disk with a customer-supplied key, you must provide the same
@ -203,7 +203,7 @@ items:
returned: success returned: success
type: complex type: complex
contains: contains:
raw_key: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
@ -215,7 +215,7 @@ items:
that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
source_snapshot: sourceSnapshot:
description: description:
- 'The source snapshot used to create this disk. You can provide this as a partial - 'The source snapshot used to create this disk. You can provide this as a partial
or full URL to the resource. For example, the following are valid values: * or full URL to the resource. For example, the following are valid values: *
@ -223,14 +223,14 @@ items:
* `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` .' * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` .'
returned: success returned: success
type: dict type: dict
source_snapshot_encryption_key: sourceSnapshotEncryptionKey:
description: description:
- The customer-supplied encryption key of the source snapshot. Required if the source - The customer-supplied encryption key of the source snapshot. Required if the source
snapshot is protected by a customer-supplied encryption key. snapshot is protected by a customer-supplied encryption key.
returned: success returned: success
type: complex type: complex
contains: contains:
raw_key: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
@ -242,7 +242,7 @@ items:
that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
source_snapshot_id: sourceSnapshotId:
description: description:
- The unique ID of the snapshot used to create this disk. This value identifies the - The unique ID of the snapshot used to create this disk. This value identifies the
exact snapshot that was used to create this persistent disk. For example, if you exact snapshot that was used to create this persistent disk. For example, if you

14
plugins/modules/gcp_compute_firewall.py
View file

@ -365,7 +365,7 @@ RETURN = '''
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
returned: success returned: success
type: list type: list
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -398,7 +398,7 @@ RETURN = '''
the resource. the resource.
returned: success returned: success
type: str type: str
destination_ranges: destinationRanges:
description: description:
- If destination ranges are specified, the firewall will apply only to traffic that - If destination ranges are specified, the firewall will apply only to traffic that
has destination IP address in these ranges. These ranges must be expressed in CIDR has destination IP address in these ranges. These ranges must be expressed in CIDR
@ -447,7 +447,7 @@ RETURN = '''
precedence over ALLOW rules having equal priority. precedence over ALLOW rules having equal priority.
returned: success returned: success
type: int type: int
source_ranges: sourceRanges:
description: description:
- If source ranges are specified, the firewall will apply only to traffic that has - If source ranges are specified, the firewall will apply only to traffic that has
source IP address in these ranges. These ranges must be expressed in CIDR format. source IP address in these ranges. These ranges must be expressed in CIDR format.
@ -457,7 +457,7 @@ RETURN = '''
does not need to match both properties for the firewall to apply. Only IPv4 is supported. does not need to match both properties for the firewall to apply. Only IPv4 is supported.
returned: success returned: success
type: list type: list
source_service_accounts: sourceServiceAccounts:
description: description:
- If source service accounts are specified, the firewall will apply only to traffic - If source service accounts are specified, the firewall will apply only to traffic
originating from an instance with a service account in this list. Source service originating from an instance with a service account in this list. Source service
@ -470,7 +470,7 @@ RETURN = '''
cannot be used at the same time as sourceTags or targetTags. cannot be used at the same time as sourceTags or targetTags.
returned: success returned: success
type: list type: list
source_tags: sourceTags:
description: description:
- If source tags are specified, the firewall will apply only to traffic with source - If source tags are specified, the firewall will apply only to traffic with source
IP that belongs to a tag listed in source tags. Source tags cannot be used to control IP that belongs to a tag listed in source tags. Source tags cannot be used to control
@ -482,7 +482,7 @@ RETURN = '''
firewall to apply. firewall to apply.
returned: success returned: success
type: list type: list
target_service_accounts: targetServiceAccounts:
description: description:
- A list of service accounts indicating sets of instances located in the network that - A list of service accounts indicating sets of instances located in the network that
may make network connections as specified in allowed[]. may make network connections as specified in allowed[].
@ -491,7 +491,7 @@ RETURN = '''
applies to all instances on the specified network. applies to all instances on the specified network.
returned: success returned: success
type: list type: list
target_tags: targetTags:
description: description:
- A list of instance tags indicating sets of instances located in the network that - A list of instance tags indicating sets of instances located in the network that
may make network connections as specified in allowed[]. may make network connections as specified in allowed[].

14
plugins/modules/gcp_compute_firewall_facts.py
View file

@ -86,7 +86,7 @@ items:
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
returned: success returned: success
type: list type: list
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -119,7 +119,7 @@ items:
the resource. the resource.
returned: success returned: success
type: str type: str
destination_ranges: destinationRanges:
description: description:
- If destination ranges are specified, the firewall will apply only to traffic that - If destination ranges are specified, the firewall will apply only to traffic that
has destination IP address in these ranges. These ranges must be expressed in CIDR has destination IP address in these ranges. These ranges must be expressed in CIDR
@ -168,7 +168,7 @@ items:
precedence over ALLOW rules having equal priority. precedence over ALLOW rules having equal priority.
returned: success returned: success
type: int type: int
source_ranges: sourceRanges:
description: description:
- If source ranges are specified, the firewall will apply only to traffic that has - If source ranges are specified, the firewall will apply only to traffic that has
source IP address in these ranges. These ranges must be expressed in CIDR format. source IP address in these ranges. These ranges must be expressed in CIDR format.
@ -178,7 +178,7 @@ items:
does not need to match both properties for the firewall to apply. Only IPv4 is supported. does not need to match both properties for the firewall to apply. Only IPv4 is supported.
returned: success returned: success
type: list type: list
source_service_accounts: sourceServiceAccounts:
description: description:
- If source service accounts are specified, the firewall will apply only to traffic - If source service accounts are specified, the firewall will apply only to traffic
originating from an instance with a service account in this list. Source service originating from an instance with a service account in this list. Source service
@ -191,7 +191,7 @@ items:
cannot be used at the same time as sourceTags or targetTags. cannot be used at the same time as sourceTags or targetTags.
returned: success returned: success
type: list type: list
source_tags: sourceTags:
description: description:
- If source tags are specified, the firewall will apply only to traffic with source - If source tags are specified, the firewall will apply only to traffic with source
IP that belongs to a tag listed in source tags. Source tags cannot be used to control IP that belongs to a tag listed in source tags. Source tags cannot be used to control
@ -203,7 +203,7 @@ items:
firewall to apply. firewall to apply.
returned: success returned: success
type: list type: list
target_service_accounts: targetServiceAccounts:
description: description:
- A list of service accounts indicating sets of instances located in the network that - A list of service accounts indicating sets of instances located in the network that
may make network connections as specified in allowed[]. may make network connections as specified in allowed[].
@ -212,7 +212,7 @@ items:
applies to all instances on the specified network. applies to all instances on the specified network.
returned: success returned: success
type: list type: list
target_tags: targetTags:
description: description:
- A list of instance tags indicating sets of instances located in the network that - A list of instance tags indicating sets of instances located in the network that
may make network connections as specified in allowed[]. may make network connections as specified in allowed[].

16
plugins/modules/gcp_compute_forwarding_rule.py
View file

@ -263,7 +263,7 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -279,7 +279,7 @@ RETURN = '''
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
ip_address: IPAddress:
description: description:
- The IP address that this forwarding rule is serving on behalf of. - The IP address that this forwarding rule is serving on behalf of.
- Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL - Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL
@ -300,27 +300,27 @@ RETURN = '''
* global/addresses/address * address .' * global/addresses/address * address .'
returned: success returned: success
type: str type: str
ip_protocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH,
SCTP or ICMP. SCTP or ICMP.
- When the load balancing scheme is INTERNAL, only TCP and UDP are valid. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
returned: success returned: success
type: str type: str
backend_service: backendService:
description: description:
- A reference to a BackendService to receive the matched traffic. - A reference to a BackendService to receive the matched traffic.
- This is used for internal load balancing. - This is used for internal load balancing.
- "(not used for external load balancing) ." - "(not used for external load balancing) ."
returned: success returned: success
type: dict type: dict
ip_version: ipVersion:
description: description:
- The IP Version that will be used by this forwarding rule. Valid options are IPV4 - The IP Version that will be used by this forwarding rule. Valid options are IPV4
or IPV6. This can only be specified for a global forwarding rule. or IPV6. This can only be specified for a global forwarding rule.
returned: success returned: success
type: str type: str
load_balancing_scheme: loadBalancingScheme:
description: description:
- 'This signifies what the ForwardingRule will be used for and can only take the following - 'This signifies what the ForwardingRule will be used for and can only take the following
values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for
@ -347,7 +347,7 @@ RETURN = '''
- This field is not used for external load balancing. - This field is not used for external load balancing.
returned: success returned: success
type: dict type: dict
port_range: portRange:
description: description:
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
@ -390,7 +390,7 @@ RETURN = '''
- This field is not used for internal load balancing. - This field is not used for internal load balancing.
returned: success returned: success
type: dict type: dict
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.

16
plugins/modules/gcp_compute_forwarding_rule_facts.py
View file

@ -70,7 +70,7 @@ items:
returned: always returned: always
type: complex type: complex
contains: contains:
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -86,7 +86,7 @@ items:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
ip_address: IPAddress:
description: description:
- The IP address that this forwarding rule is serving on behalf of. - The IP address that this forwarding rule is serving on behalf of.
- Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL - Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL
@ -107,27 +107,27 @@ items:
* global/addresses/address * address .' * global/addresses/address * address .'
returned: success returned: success
type: str type: str
ip_protocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH,
SCTP or ICMP. SCTP or ICMP.
- When the load balancing scheme is INTERNAL, only TCP and UDP are valid. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
returned: success returned: success
type: str type: str
backend_service: backendService:
description: description:
- A reference to a BackendService to receive the matched traffic. - A reference to a BackendService to receive the matched traffic.
- This is used for internal load balancing. - This is used for internal load balancing.
- "(not used for external load balancing) ." - "(not used for external load balancing) ."
returned: success returned: success
type: dict type: dict
ip_version: ipVersion:
description: description:
- The IP Version that will be used by this forwarding rule. Valid options are IPV4 - The IP Version that will be used by this forwarding rule. Valid options are IPV4
or IPV6. This can only be specified for a global forwarding rule. or IPV6. This can only be specified for a global forwarding rule.
returned: success returned: success
type: str type: str
load_balancing_scheme: loadBalancingScheme:
description: description:
- 'This signifies what the ForwardingRule will be used for and can only take the following - 'This signifies what the ForwardingRule will be used for and can only take the following
values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for
@ -154,7 +154,7 @@ items:
- This field is not used for external load balancing. - This field is not used for external load balancing.
returned: success returned: success
type: dict type: dict
port_range: portRange:
description: description:
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
@ -197,7 +197,7 @@ items:
- This field is not used for internal load balancing. - This field is not used for internal load balancing.
returned: success returned: success
type: dict type: dict
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.

6
plugins/modules/gcp_compute_global_address.py
View file

@ -107,7 +107,7 @@ RETURN = '''
- The static external IP address represented by this resource. - The static external IP address represented by this resource.
returned: success returned: success
type: str type: str
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -133,13 +133,13 @@ RETURN = '''
be a dash. be a dash.
returned: success returned: success
type: str type: str
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.
returned: success returned: success
type: str type: str
ip_version: ipVersion:
description: description:
- The IP Version that will be used by this address. Valid options are IPV4 or IPV6. - The IP Version that will be used by this address. Valid options are IPV4 or IPV6.
The default value is IPV4. The default value is IPV4.

6
plugins/modules/gcp_compute_global_address_facts.py
View file

@ -69,7 +69,7 @@ items:
- The static external IP address represented by this resource. - The static external IP address represented by this resource.
returned: success returned: success
type: str type: str
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -95,13 +95,13 @@ items:
be a dash. be a dash.
returned: success returned: success
type: str type: str
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.
returned: success returned: success
type: str type: str
ip_version: ipVersion:
description: description:
- The IP Version that will be used by this address. Valid options are IPV4 or IPV6. - The IP Version that will be used by this address. Valid options are IPV4 or IPV6.
The default value is IPV4. The default value is IPV4.

106
plugins/modules/gcp_compute_global_forwarding_rule.py
View file

@ -253,21 +253,19 @@ id:
IPAddress: IPAddress:
description: description:
- The IP address that this forwarding rule is serving on behalf of. - The IP address that this forwarding rule is serving on behalf of.
- Addresses are restricted based on the forwarding rule's load balancing scheme - Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL
(EXTERNAL or INTERNAL) and scope (global or regional). or INTERNAL) and scope (global or regional).
- When the load balancing scheme is EXTERNAL, for global forwarding rules, the address - When the load balancing scheme is EXTERNAL, for global forwarding rules, the address
must be a global IP, and for regional forwarding rules, the address must live must be a global IP, and for regional forwarding rules, the address must live in
in the same region as the forwarding rule. If this field is empty, an ephemeral the same region as the forwarding rule. If this field is empty, an ephemeral IPv4
IPv4 address from the same scope (global or regional) will be assigned. A regional address from the same scope (global or regional) will be assigned. A regional forwarding
forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6.
or IPv6.
- When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address - When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address
belonging to the network/subnet configured for the forwarding rule. By default, belonging to the network/subnet configured for the forwarding rule. By default,
if this field is empty, an ephemeral internal IP address will be automatically if this field is empty, an ephemeral internal IP address will be automatically allocated
allocated from the IP range of the subnet or network configured for this forwarding from the IP range of the subnet or network configured for this forwarding rule.
rule. - 'An address can be specified either by a literal IP address or a URL reference to
- 'An address can be specified either by a literal IP address or a URL reference an existing Address resource. The following examples are all valid: * 100.1.2.3
to an existing Address resource. The following examples are all valid: * 100.1.2.3
* U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address)
* projects/project/regions/region/addresses/address * regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address
* global/addresses/address * address .' * global/addresses/address * address .'
@ -276,41 +274,48 @@ IPAddress:
IPProtocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH,
SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCP SCTP or ICMP.
is valid. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
returned: success returned: success
type: str type: str
backendService:
description:
- A reference to a BackendService to receive the matched traffic.
- This is used for internal load balancing.
- "(not used for external load balancing) ."
returned: success
type: dict
ipVersion: ipVersion:
description: description:
- The IP Version that will be used by this global forwarding rule. - The IP Version that will be used by this forwarding rule. Valid options are IPV4
- Valid options are IPV4 or IPV6. or IPV6. This can only be specified for a global forwarding rule.
returned: success returned: success
type: str type: str
loadBalancingScheme: loadBalancingScheme:
description: description:
- This signifies what the GlobalForwardingRule will be used for. - 'This signifies what the ForwardingRule will be used for and can only take the following
- 'The value of INTERNAL_SELF_MANAGED means that this will be used for Internal values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for
Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this
Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) NOTE: Currently will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
global forwarding rules cannot be used for INTERNAL load balancing.' .'
returned: success returned: success
type: str type: str
name: name:
description: description:
- Name of the resource; provided by the client when the resource is created. The - Name of the resource; provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
description: description:
- For internal load balancing, this field identifies the network that the load balanced
IP should belong to for this Forwarding Rule. If this field is not specified, the
default network will be used.
- This field is not used for external load balancing. - This field is not used for external load balancing.
- For INTERNAL_SELF_MANAGED load balancing, this field identifies the network that
the load balanced IP should belong to for this global forwarding rule. If this
field is not specified, the default network will be used.
returned: success returned: success
type: dict type: dict
portRange: portRange:
@ -319,18 +324,45 @@ portRange:
TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
- Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to
ports in the specified range will be forwarded to target. ports in the specified range will be forwarded to target.
- Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port
port ranges. ranges.
- 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy: - 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy:
80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465,
465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110, 143, 195, 443, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110,
465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: 500, 4500 .' 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway:
500, 4500 .'
returned: success
type: str
ports:
description:
- This field is used along with the backend_service field for internal load balancing.
- When the load balancing scheme is INTERNAL, a single port or a comma separated list
of ports can be configured. Only packets addressed to these ports will be forwarded
to the backends configured with this forwarding rule.
- You may specify a maximum of up to 5 ports.
returned: success
type: list
subnetwork:
description:
- A reference to a subnetwork.
- For internal load balancing, this field identifies the subnetwork that the load
balanced IP should belong to for this Forwarding Rule.
- If the network specified is in auto subnet mode, this field is optional. However,
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
returned: success
type: dict
region:
description:
- A reference to the region where the regional forwarding rule resides.
- This field is not applicable to global forwarding rules.
returned: success returned: success
type: str type: str
target: target:
description: description:
- The URL of the target resource to receive the matched traffic. - This target must be a global load balancing resource. The forwarded traffic must
- The forwarded traffic must be of a type appropriate to the target object. be of a type appropriate to the target object.
- 'Valid types: HTTP_PROXY, HTTPS_PROXY, SSL_PROXY, TCP_PROXY .'
returned: success returned: success
type: str type: str
''' '''

123
plugins/modules/gcp_compute_global_forwarding_rule_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -83,21 +83,19 @@ resources:
IPAddress: IPAddress:
description: description:
- The IP address that this forwarding rule is serving on behalf of. - The IP address that this forwarding rule is serving on behalf of.
- Addresses are restricted based on the forwarding rule's load balancing scheme - Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL
(EXTERNAL or INTERNAL) and scope (global or regional). or INTERNAL) and scope (global or regional).
- When the load balancing scheme is EXTERNAL, for global forwarding rules, the - When the load balancing scheme is EXTERNAL, for global forwarding rules, the address
address must be a global IP, and for regional forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in
must live in the same region as the forwarding rule. If this field is empty, the same region as the forwarding rule. If this field is empty, an ephemeral IPv4
an ephemeral IPv4 address from the same scope (global or regional) will be address from the same scope (global or regional) will be assigned. A regional forwarding
assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6.
rule supports either IPv4 or IPv6. - When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address
- When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP belonging to the network/subnet configured for the forwarding rule. By default,
address belonging to the network/subnet configured for the forwarding rule. if this field is empty, an ephemeral internal IP address will be automatically allocated
By default, if this field is empty, an ephemeral internal IP address will from the IP range of the subnet or network configured for this forwarding rule.
be automatically allocated from the IP range of the subnet or network configured - 'An address can be specified either by a literal IP address or a URL reference to
for this forwarding rule. an existing Address resource. The following examples are all valid: * 100.1.2.3
- 'An address can be specified either by a literal IP address or a URL reference
to an existing Address resource. The following examples are all valid: * 100.1.2.3
* U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address)
* projects/project/regions/region/addresses/address * regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address
* global/addresses/address * address .' * global/addresses/address * address .'
@ -105,63 +103,96 @@ resources:
type: str type: str
IPProtocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH,
AH, SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, SCTP or ICMP.
only TCP is valid. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
returned: success returned: success
type: str type: str
backendService:
description:
- A reference to a BackendService to receive the matched traffic.
- This is used for internal load balancing.
- "(not used for external load balancing) ."
returned: success
type: dict
ipVersion: ipVersion:
description: description:
- The IP Version that will be used by this global forwarding rule. - The IP Version that will be used by this forwarding rule. Valid options are IPV4
- Valid options are IPV4 or IPV6. or IPV6. This can only be specified for a global forwarding rule.
returned: success returned: success
type: str type: str
loadBalancingScheme: loadBalancingScheme:
description: description:
- This signifies what the GlobalForwardingRule will be used for. - 'This signifies what the ForwardingRule will be used for and can only take the following
- 'The value of INTERNAL_SELF_MANAGED means that this will be used for Internal values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for
Global HTTP(S) LB. The value of EXTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this
External Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
NOTE: Currently global forwarding rules cannot be used for INTERNAL load balancing.' .'
returned: success returned: success
type: str type: str
name: name:
description: description:
- Name of the resource; provided by the client when the resource is created. - Name of the resource; provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
description: description:
- For internal load balancing, this field identifies the network that the load balanced
IP should belong to for this Forwarding Rule. If this field is not specified, the
default network will be used.
- This field is not used for external load balancing. - This field is not used for external load balancing.
- For INTERNAL_SELF_MANAGED load balancing, this field identifies the network
that the load balanced IP should belong to for this global forwarding rule.
If this field is not specified, the default network will be used.
returned: success returned: success
type: dict type: dict
portRange: portRange:
description: description:
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
- Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to
to ports in the specified range will be forwarded to target. ports in the specified range will be forwarded to target.
- Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port
port ranges. ranges.
- 'Some types of forwarding target have constraints on the acceptable ports: - 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy:
* TargetHttpProxy: 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465,
43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110,
25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway:
500, 4500 .' 500, 4500 .'
returned: success returned: success
type: str type: str
ports:
description:
- This field is used along with the backend_service field for internal load balancing.
- When the load balancing scheme is INTERNAL, a single port or a comma separated list
of ports can be configured. Only packets addressed to these ports will be forwarded
to the backends configured with this forwarding rule.
- You may specify a maximum of up to 5 ports.
returned: success
type: list
subnetwork:
description:
- A reference to a subnetwork.
- For internal load balancing, this field identifies the subnetwork that the load
balanced IP should belong to for this Forwarding Rule.
- If the network specified is in auto subnet mode, this field is optional. However,
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
returned: success
type: dict
region:
description:
- A reference to the region where the regional forwarding rule resides.
- This field is not applicable to global forwarding rules.
returned: success
type: str
target: target:
description: description:
- The URL of the target resource to receive the matched traffic. - This target must be a global load balancing resource. The forwarded traffic must
- The forwarded traffic must be of a type appropriate to the target object. be of a type appropriate to the target object.
- 'Valid types: HTTP_PROXY, HTTPS_PROXY, SSL_PROXY, TCP_PROXY .'
returned: success returned: success
type: str type: str
''' '''

207
plugins/modules/gcp_compute_health_check.py
View file

@ -315,12 +315,12 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
check_interval_sec: checkIntervalSec:
description: description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name - How often (in seconds) to send a health check. The default value is 5 seconds.
are defined, port takes precedence. returned: success
required: false type: int
proxy_header: creationTimestamp:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend, either NONE or PROXY_V1. The default is NONE.
@ -336,11 +336,17 @@ RETURN = '''
suboptions: suboptions:
request: request:
description: description:
- The application data to send once the TCP connection has been established - An optional description of this resource. Provide this property when you create
(default value is empty). If both request and response are empty, the connection the resource.
establishment alone will indicate health. The request data can only be ASCII. returned: success
required: false type: str
response: healthyThreshold:
description:
- A so-far unhealthy instance will be marked healthy after this many consecutive successes.
The default value is 2.
returned: success
type: int
id:
description: description:
- The bytes to match against the beginning of the response data. If left empty - 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 (the default value), any response will indicate health. The response data
@ -348,15 +354,22 @@ RETURN = '''
required: false required: false
port: port:
description: description:
- The TCP port number for the TCP health check request. - Name of the resource. Provided by the client when the resource is created. The name
- The default value is 443. must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
required: false be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
port_name: 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
timeoutSec:
description: description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name - How long (in seconds) to wait before claiming failure.
are defined, port takes precedence. - The default value is 5 seconds. It is invalid for timeoutSec to have greater value
required: false than checkIntervalSec.
proxy_header: returned: success
type: int
unhealthyThreshold:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend, either NONE or PROXY_V1. The default is NONE.
@ -372,115 +385,9 @@ RETURN = '''
suboptions: suboptions:
request: request:
description: description:
- The application data to send once the SSL connection has been established - Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified,
(default value is empty). If both request and response are empty, the connection the default is TCP. Exactly one of the protocol-specific health check field must
establishment alone will indicate health. The request data can only be ASCII. be specified, which must match type field.
required: false
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
port:
description:
- The TCP port number for the SSL health check request.
- The default value is 443.
required: false
port_name:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
required: false
proxy_header:
description:
- Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE.
required: false
default: NONE
choices:
- NONE
- PROXY_V1
extends_documentation_fragment: gcp
notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks)'
- 'Official Documentation: U(https://cloud.google.com/load-balancing/docs/health-checks)'
'''
EXAMPLES = '''
- name: create a health check
gcp_compute_health_check:
name: test_object
type: TCP
tcp_health_check:
port_name: service-health
request: ping
response: pong
healthy_threshold: 10
timeout_sec: 2
unhealthy_threshold: 5
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
'''
RETURN = '''
checkIntervalSec:
description:
- How often (in seconds) to send a health check. The default value is 5 seconds.
returned: success
type: int
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
description:
description:
- An optional description of this resource. Provide this property when you create
the resource.
returned: success
type: str
healthyThreshold:
description:
- A so-far unhealthy instance will be marked healthy after this many consecutive
successes. The default value is 2.
returned: success
type: int
id:
description:
- The unique identifier for the resource. This identifier is defined by the server.
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
timeoutSec:
description:
- How long (in seconds) to wait before claiming failure.
- The default value is 5 seconds. It is invalid for timeoutSec to have greater value
than checkIntervalSec.
returned: success
type: int
unhealthyThreshold:
description:
- A so-far healthy instance will be marked unhealthy after this many consecutive
failures. The default value is 2.
returned: success
type: int
type:
description:
- Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not
specified, the default is TCP. Exactly one of the protocol-specific health check
field must be specified, which must match type field.
returned: success returned: success
type: str type: str
httpHealthCheck: httpHealthCheck:
@ -492,8 +399,8 @@ httpHealthCheck:
host: host:
description: description:
- The value of the host header in the HTTP health check request. - The value of the host header in the HTTP health check request.
- If left empty (default value), the public IP on behalf of which this health - If left empty (default value), the public IP on behalf of which this health check
check is performed will be used. is performed will be used.
returned: success returned: success
type: str type: str
requestPath: requestPath:
@ -502,13 +409,6 @@ httpHealthCheck:
- The default value is /. - The default value is /.
returned: success returned: success
type: str 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.
returned: success
type: str
port: port:
description: description:
- The TCP port number for the HTTP health check request. - The TCP port number for the HTTP health check request.
@ -536,8 +436,8 @@ httpsHealthCheck:
host: host:
description: description:
- The value of the host header in the HTTPS health check request. - The value of the host header in the HTTPS health check request.
- If left empty (default value), the public IP on behalf of which this health - If left empty (default value), the public IP on behalf of which this health check
check is performed will be used. is performed will be used.
returned: success returned: success
type: str type: str
requestPath: requestPath:
@ -546,13 +446,6 @@ httpsHealthCheck:
- The default value is /. - The default value is /.
returned: success returned: success
type: str 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.
returned: success
type: str
port: port:
description: description:
- The TCP port number for the HTTPS health check request. - The TCP port number for the HTTPS health check request.
@ -579,16 +472,16 @@ tcpHealthCheck:
contains: contains:
request: request:
description: description:
- The application data to send once the TCP connection has been established - The application data to send once the TCP connection has been established (default
(default value is empty). If both request and response are empty, the connection value is empty). If both request and response are empty, the connection establishment
establishment alone will indicate health. The request data can only be ASCII. alone will indicate health. The request data can only be ASCII.
returned: success returned: success
type: str type: str
response: response:
description: description:
- The bytes to match against the beginning of the response data. If left empty - The bytes to match against the beginning of the response data. If left empty (the
(the default value), any response will indicate health. The response data default value), any response will indicate health. The response data can only be
can only be ASCII. ASCII.
returned: success returned: success
type: str type: str
port: port:
@ -617,16 +510,16 @@ sslHealthCheck:
contains: contains:
request: request:
description: description:
- The application data to send once the SSL connection has been established - The application data to send once the SSL connection has been established (default
(default value is empty). If both request and response are empty, the connection value is empty). If both request and response are empty, the connection establishment
establishment alone will indicate health. The request data can only be ASCII. alone will indicate health. The request data can only be ASCII.
returned: success returned: success
type: str type: str
response: response:
description: description:
- The bytes to match against the beginning of the response data. If left empty - The bytes to match against the beginning of the response data. If left empty (the
(the default value), any response will indicate health. The response data default value), any response will indicate health. The response data can only be
can only be ASCII. ASCII.
returned: success returned: success
type: str type: str
port: port:

117
plugins/modules/gcp_compute_health_check_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -82,44 +82,43 @@ resources:
type: str type: str
healthyThreshold: healthyThreshold:
description: description:
- A so-far unhealthy instance will be marked healthy after this many consecutive - A so-far unhealthy instance will be marked healthy after this many consecutive successes.
successes. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
id: id:
description: description:
- The unique identifier for the resource. This identifier is defined by the - The unique identifier for the resource. This identifier is defined by the server.
server.
returned: success returned: success
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
timeoutSec: timeoutSec:
description: description:
- How long (in seconds) to wait before claiming failure. - How long (in seconds) to wait before claiming failure.
- The default value is 5 seconds. It is invalid for timeoutSec to have greater - The default value is 5 seconds. It is invalid for timeoutSec to have greater value
value than checkIntervalSec. than checkIntervalSec.
returned: success returned: success
type: int type: int
unhealthyThreshold: unhealthyThreshold:
description: description:
- A so-far healthy instance will be marked unhealthy after this many consecutive - A so-far healthy instance will be marked unhealthy after this many consecutive failures.
failures. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
type: type:
description: description:
- Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If - Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified,
not specified, the default is TCP. Exactly one of the protocol-specific health the default is TCP. Exactly one of the protocol-specific health check field must
check field must be specified, which must match type field. be specified, which must match type field.
returned: success returned: success
type: str type: str
httpHealthCheck: httpHealthCheck:
@ -131,8 +130,8 @@ resources:
host: host:
description: description:
- The value of the host header in the HTTP health check request. - The value of the host header in the HTTP health check request.
- If left empty (default value), the public IP on behalf of which this health - If left empty (default value), the public IP on behalf of which this health check
check is performed will be used. is performed will be used.
returned: success returned: success
type: str type: str
requestPath: requestPath:
@ -141,13 +140,6 @@ resources:
- The default value is /. - The default value is /.
returned: success returned: success
type: str 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.
returned: success
type: str
port: port:
description: description:
- The TCP port number for the HTTP health check request. - The TCP port number for the HTTP health check request.
@ -156,14 +148,14 @@ resources:
type: int type: int
portName: portName:
description: description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
port_name are defined, port takes precedence. are defined, port takes precedence.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the backend,
backend, either NONE or PROXY_V1. The default is NONE. either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
httpsHealthCheck: httpsHealthCheck:
@ -175,8 +167,8 @@ resources:
host: host:
description: description:
- The value of the host header in the HTTPS health check request. - The value of the host header in the HTTPS health check request.
- If left empty (default value), the public IP on behalf of which this health - If left empty (default value), the public IP on behalf of which this health check
check is performed will be used. is performed will be used.
returned: success returned: success
type: str type: str
requestPath: requestPath:
@ -185,13 +177,6 @@ resources:
- The default value is /. - The default value is /.
returned: success returned: success
type: str 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.
returned: success
type: str
port: port:
description: description:
- The TCP port number for the HTTPS health check request. - The TCP port number for the HTTPS health check request.
@ -200,14 +185,14 @@ resources:
type: int type: int
portName: portName:
description: description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
port_name are defined, port takes precedence. are defined, port takes precedence.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the backend,
backend, either NONE or PROXY_V1. The default is NONE. either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
tcpHealthCheck: tcpHealthCheck:
@ -218,17 +203,16 @@ resources:
contains: contains:
request: request:
description: description:
- The application data to send once the TCP connection has been established - The application data to send once the TCP connection has been established (default
(default value is empty). If both request and response are empty, the value is empty). If both request and response are empty, the connection establishment
connection establishment alone will indicate health. The request data alone will indicate health. The request data can only be ASCII.
can only be ASCII.
returned: success returned: success
type: str type: str
response: response:
description: description:
- The bytes to match against the beginning of the response data. If left - The bytes to match against the beginning of the response data. If left empty (the
empty (the default value), any response will indicate health. The response default value), any response will indicate health. The response data can only be
data can only be ASCII. ASCII.
returned: success returned: success
type: str type: str
port: port:
@ -239,14 +223,14 @@ resources:
type: int type: int
portName: portName:
description: description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
port_name are defined, port takes precedence. are defined, port takes precedence.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the backend,
backend, either NONE or PROXY_V1. The default is NONE. either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
sslHealthCheck: sslHealthCheck:
@ -257,17 +241,16 @@ resources:
contains: contains:
request: request:
description: description:
- The application data to send once the SSL connection has been established - The application data to send once the SSL connection has been established (default
(default value is empty). If both request and response are empty, the value is empty). If both request and response are empty, the connection establishment
connection establishment alone will indicate health. The request data alone will indicate health. The request data can only be ASCII.
can only be ASCII.
returned: success returned: success
type: str type: str
response: response:
description: description:
- The bytes to match against the beginning of the response data. If left - The bytes to match against the beginning of the response data. If left empty (the
empty (the default value), any response will indicate health. The response default value), any response will indicate health. The response data can only be
data can only be ASCII. ASCII.
returned: success returned: success
type: str type: str
port: port:
@ -278,14 +261,14 @@ resources:
type: int type: int
portName: portName:
description: description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
port_name are defined, port takes precedence. are defined, port takes precedence.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the backend,
backend, either NONE or PROXY_V1. The default is NONE. either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
''' '''

20
plugins/modules/gcp_compute_http_health_check.py
View file

@ -142,8 +142,8 @@ description:
type: str type: str
healthyThreshold: healthyThreshold:
description: description:
- A so-far unhealthy instance will be marked healthy after this many consecutive - A so-far unhealthy instance will be marked healthy after this many consecutive successes.
successes. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
host: host:
@ -160,12 +160,12 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
port: port:
@ -189,8 +189,8 @@ timeoutSec:
type: int type: int
unhealthyThreshold: unhealthyThreshold:
description: description:
- A so-far healthy instance will be marked unhealthy after this many consecutive - A so-far healthy instance will be marked unhealthy after this many consecutive failures.
failures. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
''' '''

37
plugins/modules/gcp_compute_http_health_check_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -82,31 +82,30 @@ resources:
type: str type: str
healthyThreshold: healthyThreshold:
description: description:
- A so-far unhealthy instance will be marked healthy after this many consecutive - A so-far unhealthy instance will be marked healthy after this many consecutive successes.
successes. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
host: host:
description: description:
- The value of the host header in the HTTP health check request. If left empty - The value of the host header in the HTTP health check request. If left empty (default
(default value), the public IP on behalf of which this health check is performed value), the public IP on behalf of which this health check is performed will be
will be used. used.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. This identifier is defined by the - The unique identifier for the resource. This identifier is defined by the server.
server.
returned: success returned: success
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
port: port:
@ -124,14 +123,14 @@ resources:
timeoutSec: timeoutSec:
description: description:
- How long (in seconds) to wait before claiming failure. - How long (in seconds) to wait before claiming failure.
- The default value is 5 seconds. It is invalid for timeoutSec to have greater - The default value is 5 seconds. It is invalid for timeoutSec to have greater value
value than checkIntervalSec. than checkIntervalSec.
returned: success returned: success
type: int type: int
unhealthyThreshold: unhealthyThreshold:
description: description:
- A so-far healthy instance will be marked unhealthy after this many consecutive - A so-far healthy instance will be marked unhealthy after this many consecutive failures.
failures. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
''' '''

26
plugins/modules/gcp_compute_https_health_check.py
View file

@ -139,15 +139,15 @@ description:
type: str type: str
healthyThreshold: healthyThreshold:
description: description:
- A so-far unhealthy instance will be marked healthy after this many consecutive - A so-far unhealthy instance will be marked healthy after this many consecutive successes.
successes. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
host: host:
description: description:
- The value of the host header in the HTTPS health check request. If left empty - The value of the host header in the HTTPS health check request. If left empty (default
(default value), the public IP on behalf of which this health check is performed value), the public IP on behalf of which this health check is performed will be
will be used. used.
returned: success returned: success
type: str type: str
id: id:
@ -157,12 +157,12 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
port: port:
@ -186,8 +186,8 @@ timeoutSec:
type: int type: int
unhealthyThreshold: unhealthyThreshold:
description: description:
- A so-far healthy instance will be marked unhealthy after this many consecutive - A so-far healthy instance will be marked unhealthy after this many consecutive failures.
failures. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
''' '''

37
plugins/modules/gcp_compute_https_health_check_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -82,31 +82,30 @@ resources:
type: str type: str
healthyThreshold: healthyThreshold:
description: description:
- A so-far unhealthy instance will be marked healthy after this many consecutive - A so-far unhealthy instance will be marked healthy after this many consecutive successes.
successes. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
host: host:
description: description:
- The value of the host header in the HTTPS health check request. If left empty - The value of the host header in the HTTPS health check request. If left empty (default
(default value), the public IP on behalf of which this health check is performed value), the public IP on behalf of which this health check is performed will be
will be used. used.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. This identifier is defined by the - The unique identifier for the resource. This identifier is defined by the server.
server.
returned: success returned: success
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
port: port:
@ -124,14 +123,14 @@ resources:
timeoutSec: timeoutSec:
description: description:
- How long (in seconds) to wait before claiming failure. - How long (in seconds) to wait before claiming failure.
- The default value is 5 seconds. It is invalid for timeoutSec to have greater - The default value is 5 seconds. It is invalid for timeoutSec to have greater value
value than checkIntervalSec. than checkIntervalSec.
returned: success returned: success
type: int type: int
unhealthyThreshold: unhealthyThreshold:
description: description:
- A so-far healthy instance will be marked unhealthy after this many consecutive - A so-far healthy instance will be marked unhealthy after this many consecutive failures.
failures. The default value is 2. The default value is 2.
returned: success returned: success
type: int type: int
''' '''

110
plugins/modules/gcp_compute_image.py
View file

@ -228,39 +228,39 @@ deprecated:
contains: contains:
deleted: deleted:
description: description:
- An optional RFC3339 timestamp on or after which the state of this resource - An optional RFC3339 timestamp on or after which the state of this resource is intended
is intended to change to DELETED. This is only informational and the status to change to DELETED. This is only informational and the status will not change
will not change unless the client explicitly changes it. unless the client explicitly changes it.
returned: success returned: success
type: str type: str
deprecated: deprecated:
description: description:
- An optional RFC3339 timestamp on or after which the state of this resource - An optional RFC3339 timestamp on or after which the state of this resource is intended
is intended to change to DEPRECATED. This is only informational and the status to change to DEPRECATED. This is only informational and the status will not change
will not change unless the client explicitly changes it. unless the client explicitly changes it.
returned: success returned: success
type: str type: str
obsolete: obsolete:
description: description:
- An optional RFC3339 timestamp on or after which the state of this resource - An optional RFC3339 timestamp on or after which the state of this resource is intended
is intended to change to OBSOLETE. This is only informational and the status to change to OBSOLETE. This is only informational and the status will not change
will not change unless the client explicitly changes it. unless the client explicitly changes it.
returned: success returned: success
type: str type: str
replacement: replacement:
description: description:
- The URL of the suggested replacement for a deprecated resource. - The URL of the suggested replacement for a deprecated resource.
- The suggested replacement resource must be the same kind of resource as the - The suggested replacement resource must be the same kind of resource as the deprecated
deprecated resource. resource.
returned: success returned: success
type: str type: str
state: state:
description: description:
- The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, - The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED.
or DELETED. Operations which create a new resource using a DEPRECATED resource Operations which create a new resource using a DEPRECATED resource will return successfully,
will return successfully, but with a warning indicating the deprecated resource but with a warning indicating the deprecated resource and recommending its replacement.
and recommending its replacement. Operations which use OBSOLETE or DELETED Operations which use OBSOLETE or DELETED resources will be rejected and result in
resources will be rejected and result in an error. an error.
returned: success returned: success
type: str type: str
description: description:
@ -276,10 +276,10 @@ diskSizeGb:
type: int type: int
family: family:
description: description:
- The name of the image family to which this image belongs. You can create disks - The name of the image family to which this image belongs. You can create disks by
by specifying an image family instead of a specific image name. The image family specifying an image family instead of a specific image name. The image family always
always returns its latest image that is not deprecated. The name of the image returns its latest image that is not deprecated. The name of the image family must
family must comply with RFC1035. comply with RFC1035.
returned: success returned: success
type: str type: str
guestOsFeatures: guestOsFeatures:
@ -298,9 +298,9 @@ guestOsFeatures:
type: type:
description: description:
- The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. - The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
For newer Windows images, the server might also populate this property with For newer Windows images, the server might also populate this property with the
the value WINDOWS to indicate that this is a Windows image. This value is value WINDOWS to indicate that this is a Windows image. This value is purely informational
purely informational and does not enable or disable any features. and does not enable or disable any features.
returned: success returned: success
type: str type: str
id: id:
@ -311,32 +311,21 @@ id:
imageEncryptionKey: imageEncryptionKey:
description: description:
- Encrypts the image using a customer-supplied encryption key. - Encrypts the image using a customer-supplied encryption key.
- After you encrypt an image with a customer-supplied key, you must provide the - After you encrypt an image with a customer-supplied key, you must provide the same
same key if you use the image later (e.g. to create a disk from the image) . key if you use the image later (e.g. to create a disk from the image) .
returned: success returned: success
type: complex type: complex
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
key that protects this resource. that protects this resource.
returned: success
type: str
labels:
description:
- Labels to apply to this Image.
returned: success
type: dict
labelFingerprint:
description:
- The fingerprint used for optimistic locking of this resource. Used internally
during updates.
returned: success returned: success
type: str type: str
licenses: licenses:
@ -346,12 +335,12 @@ licenses:
type: list type: list
name: name:
description: description:
- Name of the resource; provided by the client when the resource is created. The - Name of the resource; provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
rawDisk: rawDisk:
@ -362,9 +351,9 @@ rawDisk:
contains: contains:
containerType: containerType:
description: description:
- The format used to encode and transmit the block device, which should be TAR. - The format used to encode and transmit the block device, which should be TAR. This
This is just a container and transmission format and not a runtime format. is just a container and transmission format and not a runtime format. Provided by
Provided by the client when the disk image is created. the client when the disk image is created.
returned: success returned: success
type: str type: str
sha1Checksum: sha1Checksum:
@ -381,9 +370,8 @@ rawDisk:
type: str type: str
sourceDisk: sourceDisk:
description: description:
- The source disk to create this image based on. - Refers to a gcompute_disk object You must provide either this property or the rawDisk.source
- You must provide either this property or the rawDisk.source property but not both property but not both to create an image.
to create an image.
returned: success returned: success
type: dict type: dict
sourceDiskEncryptionKey: sourceDiskEncryptionKey:
@ -395,27 +383,27 @@ sourceDiskEncryptionKey:
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
sourceDiskId: sourceDiskId:
description: description:
- The ID value of the disk used to create this image. This value may be used to - The ID value of the disk used to create this image. This value may be used to determine
determine whether the image was taken from the current or a previous instance whether the image was taken from the current or a previous instance of a given disk
of a given disk name. name.
returned: success returned: success
type: str type: str
sourceType: sourceType:
description: description:
- The type of the image used to create this disk. The default and only value is - The type of the image used to create this disk. The default and only value is RAW
RAW . .
returned: success returned: success
type: str type: str
''' '''

140
plugins/modules/gcp_compute_image_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -82,39 +82,39 @@ resources:
contains: contains:
deleted: deleted:
description: description:
- An optional RFC3339 timestamp on or after which the state of this resource - An optional RFC3339 timestamp on or after which the state of this resource is intended
is intended to change to DELETED. This is only informational and the status to change to DELETED. This is only informational and the status will not change
will not change unless the client explicitly changes it. unless the client explicitly changes it.
returned: success returned: success
type: str type: str
deprecated: deprecated:
description: description:
- An optional RFC3339 timestamp on or after which the state of this resource - An optional RFC3339 timestamp on or after which the state of this resource is intended
is intended to change to DEPRECATED. This is only informational and the to change to DEPRECATED. This is only informational and the status will not change
status will not change unless the client explicitly changes it. unless the client explicitly changes it.
returned: success returned: success
type: str type: str
obsolete: obsolete:
description: description:
- An optional RFC3339 timestamp on or after which the state of this resource - An optional RFC3339 timestamp on or after which the state of this resource is intended
is intended to change to OBSOLETE. This is only informational and the to change to OBSOLETE. This is only informational and the status will not change
status will not change unless the client explicitly changes it. unless the client explicitly changes it.
returned: success returned: success
type: str type: str
replacement: replacement:
description: description:
- The URL of the suggested replacement for a deprecated resource. - The URL of the suggested replacement for a deprecated resource.
- The suggested replacement resource must be the same kind of resource as - The suggested replacement resource must be the same kind of resource as the deprecated
the deprecated resource. resource.
returned: success returned: success
type: str type: str
state: state:
description: description:
- The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, - The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED.
or DELETED. Operations which create a new resource using a DEPRECATED Operations which create a new resource using a DEPRECATED resource will return successfully,
resource will return successfully, but with a warning indicating the deprecated but with a warning indicating the deprecated resource and recommending its replacement.
resource and recommending its replacement. Operations which use OBSOLETE Operations which use OBSOLETE or DELETED resources will be rejected and result in
or DELETED resources will be rejected and result in an error. an error.
returned: success returned: success
type: str type: str
description: description:
@ -130,71 +130,56 @@ resources:
type: int type: int
family: family:
description: description:
- The name of the image family to which this image belongs. You can create disks - The name of the image family to which this image belongs. You can create disks by
by specifying an image family instead of a specific image name. The image specifying an image family instead of a specific image name. The image family always
family always returns its latest image that is not deprecated. The name of returns its latest image that is not deprecated. The name of the image family must
the image family must comply with RFC1035. comply with RFC1035.
returned: success returned: success
type: str type: str
guestOsFeatures: guestOsFeatures:
description: description:
- A list of features to enable on the guest OS. Applicable for bootable images - A list of features to enable on the guest OS. Applicable for bootable images only.
only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows
which allows each virtual CPU to have its own queue. For Windows images, you each virtual CPU to have its own queue. For Windows images, you can only enable
can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux
or higher. Linux images with kernel versions 3.17 and higher will support images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE.
VIRTIO_SCSI_MULTIQUEUE. - For new Windows images, the server might also populate this field with the value
- For new Windows images, the server might also populate this field with the WINDOWS, to indicate that this is a Windows image.
value WINDOWS, to indicate that this is a Windows image.
- This value is purely informational and does not enable or disable any features. - This value is purely informational and does not enable or disable any features.
returned: success returned: success
type: complex type: complex
contains: contains:
type: type:
description: description:
- The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is - The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
supported. For newer Windows images, the server might also populate this For newer Windows images, the server might also populate this property with the
property with the value WINDOWS to indicate that this is a Windows image. value WINDOWS to indicate that this is a Windows image. This value is purely informational
This value is purely informational and does not enable or disable any and does not enable or disable any features.
features.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. This identifier is defined by the - The unique identifier for the resource. This identifier is defined by the server.
server.
returned: success returned: success
type: int type: int
imageEncryptionKey: imageEncryptionKey:
description: description:
- Encrypts the image using a customer-supplied encryption key. - Encrypts the image using a customer-supplied encryption key.
- After you encrypt an image with a customer-supplied key, you must provide - After you encrypt an image with a customer-supplied key, you must provide the same
the same key if you use the image later (e.g. to create a disk from the image) key if you use the image later (e.g. to create a disk from the image) .
.
returned: success returned: success
type: complex type: complex
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
key that protects this resource. that protects this resource.
returned: success
type: str
labels:
description:
- Labels to apply to this Image.
returned: success
type: dict
labelFingerprint:
description:
- The fingerprint used for optimistic locking of this resource. Used internally
during updates.
returned: success returned: success
type: str type: str
licenses: licenses:
@ -204,12 +189,12 @@ resources:
type: list type: list
name: name:
description: description:
- Name of the resource; provided by the client when the resource is created. - Name of the resource; provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
rawDisk: rawDisk:
@ -220,9 +205,9 @@ resources:
contains: contains:
containerType: containerType:
description: description:
- The format used to encode and transmit the block device, which should - The format used to encode and transmit the block device, which should be TAR. This
be TAR. This is just a container and transmission format and not a runtime is just a container and transmission format and not a runtime format. Provided by
format. Provided by the client when the disk image is created. the client when the disk image is created.
returned: success returned: success
type: str type: str
sha1Checksum: sha1Checksum:
@ -233,15 +218,14 @@ resources:
type: str type: str
source: source:
description: description:
- The full Google Cloud Storage URL where disk storage is stored You must - The full Google Cloud Storage URL where disk storage is stored You must provide
provide either this property or the sourceDisk property but not both. either this property or the sourceDisk property but not both.
returned: success returned: success
type: str type: str
sourceDisk: sourceDisk:
description: description:
- The source disk to create this image based on. - Refers to a gcompute_disk object You must provide either this property or the rawDisk.source
- You must provide either this property or the rawDisk.source property but not property but not both to create an image.
both to create an image.
returned: success returned: success
type: dict type: dict
sourceDiskEncryptionKey: sourceDiskEncryptionKey:
@ -253,27 +237,27 @@ resources:
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
sourceDiskId: sourceDiskId:
description: description:
- The ID value of the disk used to create this image. This value may be used - The ID value of the disk used to create this image. This value may be used to determine
to determine whether the image was taken from the current or a previous instance whether the image was taken from the current or a previous instance of a given disk
of a given disk name. name.
returned: success returned: success
type: str type: str
sourceType: sourceType:
description: description:
- The type of the image used to create this disk. The default and only value - The type of the image used to create this disk. The default and only value is RAW
is RAW . .
returned: success returned: success
type: str type: str
''' '''

201
plugins/modules/gcp_compute_instance.py
View file

@ -467,8 +467,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
canIpForward: canIpForward:
description: description:
- Allows this instance to send and receive packets with non-matching destination - Allows this instance to send and receive packets with non-matching destination or
or source IPs. This is required if you plan to use this instance to forward routes. source IPs. This is required if you plan to use this instance to forward routes.
returned: success returned: success
type: bool type: bool
cpuPlatform: cpuPlatform:
@ -483,31 +483,30 @@ creationTimestamp:
type: str type: str
disks: disks:
description: description:
- An array of disks that are associated with the instances that are created from - An array of disks that are associated with the instances that are created from this
this template. template.
returned: success returned: success
type: complex type: complex
contains: contains:
autoDelete: autoDelete:
description: description:
- Specifies whether the disk will be auto-deleted when the instance is deleted - Specifies whether the disk will be auto-deleted when the instance is deleted (but
(but not when the disk is detached from the instance). not when the disk is detached from the instance).
- 'Tip: Disks should be set to autoDelete=true so that leftover disks are not - 'Tip: Disks should be set to autoDelete=true so that leftover disks are not left
left behind on machine deletion.' behind on machine deletion.'
returned: success returned: success
type: bool type: bool
boot: boot:
description: description:
- Indicates that this is a boot disk. The virtual machine will use the first - Indicates that this is a boot disk. The virtual machine will use the first partition
partition of the disk for its root filesystem. of the disk for its root filesystem.
returned: success returned: success
type: bool type: bool
deviceName: deviceName:
description: description:
- Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* - Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-*
tree of a Linux operating system running within the instance. This name can tree of a Linux operating system running within the instance. This name can be used
be used to reference the device for mounting, resizing, and so on, from within to reference the device for mounting, resizing, and so on, from within the instance.
the instance.
returned: success returned: success
type: str type: str
diskEncryptionKey: diskEncryptionKey:
@ -518,42 +517,41 @@ disks:
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
rsaEncryptedKey: rsaEncryptedKey:
description: description:
- Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption
encryption key to either encrypt or decrypt this resource. key to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
index: index:
description: description:
- Assigns a zero-based index to this disk, where 0 is reserved for the boot - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk.
disk. For example, if you have many disks attached to an instance, each disk For example, if you have many disks attached to an instance, each disk would have
would have a unique index number. If not specified, the server will choose a unique index number. If not specified, the server will choose an appropriate value.
an appropriate value.
returned: success returned: success
type: int type: int
initializeParams: initializeParams:
description: description:
- Specifies the parameters for a new disk that will be created alongside the - Specifies the parameters for a new disk that will be created alongside the new instance.
new instance. Use initialization parameters to create boot disks or local Use initialization parameters to create boot disks or local SSDs attached to the
SSDs attached to the new instance. new instance.
returned: success returned: success
type: complex type: complex
contains: contains:
diskName: diskName:
description: description:
- Specifies the disk name. If not specified, the default is to use the name - Specifies the disk name. If not specified, the default is to use the name of the
of the instance. instance.
returned: success returned: success
type: str type: str
diskSizeGb: diskSizeGb:
@ -563,61 +561,60 @@ disks:
type: int type: int
diskType: diskType:
description: description:
- Reference to a disk type. - Reference to a gcompute_disk_type resource.
- Specifies the disk type to use to create the instance. - Specifies the disk type to use to create the instance.
- If not specified, the default is pd-standard. - If not specified, the default is pd-standard.
returned: success returned: success
type: str type: str
sourceImage: sourceImage:
description: description:
- The source image to create this disk. When creating a new instance, one - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage
of initializeParams.sourceImage or disks.source is required. To create or disks.source is required. To create a disk with one of the public operating
a disk with one of the public operating system images, specify the image system images, specify the image by its family name.
by its family name.
returned: success returned: success
type: str type: str
sourceImageEncryptionKey: sourceImageEncryptionKey:
description: description:
- The customer-supplied encryption key of the source image. Required if - The customer-supplied encryption key of the source image. Required if the source
the source image is protected by a customer-supplied encryption key. image is protected by a customer-supplied encryption key.
- Instance templates do not store customer-supplied encryption keys, so - Instance templates do not store customer-supplied encryption keys, so you cannot
you cannot create disks for instances in a managed instance group if the create disks for instances in a managed instance group if the source images are
source images are encrypted with your own keys. encrypted with your own keys.
returned: success returned: success
type: complex type: complex
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
4648 base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
encryption key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
interface: interface:
description: description:
- Specifies the disk interface to use for attaching this disk, which is either - Specifies the disk interface to use for attaching this disk, which is either SCSI
SCSI or NVME. The default is SCSI. or NVME. The default is SCSI.
- Persistent disks must always use SCSI and the request will fail if you attempt - Persistent disks must always use SCSI and the request will fail if you attempt to
to attach a persistent disk in any other format than SCSI. attach a persistent disk in any other format than SCSI.
returned: success returned: success
type: str type: str
mode: mode:
description: description:
- The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified,
not specified, the default is to attach the disk in READ_WRITE mode. the default is to attach the disk in READ_WRITE mode.
returned: success returned: success
type: str type: str
source: source:
description: description:
- Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage
or disks.source is required. or disks.source is required.
- If desired, you can also attach existing non-root persistent disks using this - If desired, you can also attach existing non-root persistent disks using this property.
property. This field is only applicable for persistent disks. This field is only applicable for persistent disks.
returned: success returned: success
type: dict type: dict
type: type:
@ -649,17 +646,16 @@ id:
type: int type: int
labelFingerprint: labelFingerprint:
description: description:
- A fingerprint for this request, which is essentially a hash of the metadata's - A fingerprint for this request, which is essentially a hash of the metadata's contents
contents and used for optimistic locking. The fingerprint is initially generated and used for optimistic locking. The fingerprint is initially generated by Compute
by Compute Engine and changes after every request to modify or update metadata. Engine and changes after every request to modify or update metadata. You must always
You must always provide an up-to-date fingerprint hash in order to update or change provide an up-to-date fingerprint hash in order to update or change metadata.
metadata.
returned: success returned: success
type: str type: str
metadata: metadata:
description: description:
- The metadata key/value pairs to assign to instances that are created from this - The metadata key/value pairs to assign to instances that are created from this template.
template. These pairs can consist of custom metadata or predefined keys. These pairs can consist of custom metadata or predefined keys.
returned: success returned: success
type: dict type: dict
machineType: machineType:
@ -678,9 +674,9 @@ name:
- The name of the resource, provided by the client when initially creating the resource. - The name of the resource, provided by the client when initially creating the resource.
The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, The resource 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])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
networkInterfaces: networkInterfaces:
@ -693,27 +689,27 @@ networkInterfaces:
contains: contains:
accessConfigs: accessConfigs:
description: description:
- An array of configurations for this interface. Currently, only one access - An array of configurations for this interface. Currently, only one access config,
config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this
then this instance will have no external internet access. instance will have no external internet access.
returned: success returned: success
type: complex type: complex
contains: contains:
name: name:
description: description:
- The name of this access configuration. The default and recommended name - The name of this access configuration. The default and recommended name is External
is External NAT but you can use any arbitrary string you would like. For NAT but you can use any arbitrary string you would like. For example, My external
example, My external IP or Network Access. IP or Network Access.
returned: success returned: success
type: str type: str
natIP: natIP:
description: description:
- Reference to an address. - Specifies the title of a gcompute_address.
- An external IP address associated with this instance. - An external IP address associated with this instance.
- Specify an unused static external IP address available to the project - Specify an unused static external IP address available to the project or leave this
or leave this field undefined to use an IP from a shared ephemeral IP field undefined to use an IP from a shared ephemeral IP address pool. If you specify
address pool. If you specify a static external IP address, it must live a static external IP address, it must live in the same region as the zone of the
in the same region as the zone of the instance. instance.
returned: success returned: success
type: dict type: dict
type: type:
@ -723,25 +719,25 @@ networkInterfaces:
type: str type: str
aliasIpRanges: aliasIpRanges:
description: description:
- An array of alias IP ranges for this network interface. Can only be specified - An array of alias IP ranges for this network interface. Can only be specified for
for network interfaces on subnet-mode networks. network interfaces on subnet-mode networks.
returned: success returned: success
type: complex type: complex
contains: contains:
ipCidrRange: ipCidrRange:
description: description:
- The IP CIDR range represented by this alias IP range. - The IP CIDR range represented by this alias IP range.
- This IP CIDR range must belong to the specified subnetwork and cannot - This IP CIDR range must belong to the specified subnetwork and cannot contain IP
contain IP addresses reserved by system or used by other network interfaces. addresses reserved by system or used by other network interfaces. This range may
This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string
/24) or a CIDR format string (e.g. 10.1.2.0/24). (e.g. 10.1.2.0/24).
returned: success returned: success
type: str type: str
subnetworkRangeName: subnetworkRangeName:
description: description:
- Optional subnetwork secondary range name specifying the secondary range - Optional subnetwork secondary range name specifying the secondary range from which
from which to allocate the IP CIDR range for this alias IP range. If left to allocate the IP CIDR range for this alias IP range. If left unspecified, the
unspecified, the primary range of the subnetwork will be used. primary range of the subnetwork will be used.
returned: success returned: success
type: str type: str
name: name:
@ -752,25 +748,24 @@ networkInterfaces:
type: str type: str
network: network:
description: description:
- Specifies the title of an existing network. When creating an instance, if - Specifies the title of an existing gcompute_network. When creating an instance,
neither the network nor the subnetwork is specified, the default network global/networks/default if neither the network nor the subnetwork is specified, the default network global/networks/default
is used; if the network is not specified but the subnetwork is specified, is used; if the network is not specified but the subnetwork is specified, the network
the network is inferred. is inferred.
returned: success returned: success
type: dict type: dict
networkIP: networkIP:
description: description:
- An IPv4 internal network address to assign to the instance for this network - An IPv4 internal network address to assign to the instance for this network interface.
interface. If not specified by the user, an unused internal IP is assigned If not specified by the user, an unused internal IP is assigned by the system.
by the system.
returned: success returned: success
type: str type: str
subnetwork: subnetwork:
description: description:
- Reference to a VPC network. - Reference to a gcompute_subnetwork resource.
- If the network resource is in legacy mode, do not provide this property. If - If the network resource is in legacy mode, do not provide this property. If the
the network is in auto subnet mode, providing the subnetwork is optional. network is in auto subnet mode, providing the subnetwork is optional. If the network
If the network is in custom subnet mode, then this field should be specified. is in custom subnet mode, then this field should be specified.
returned: success returned: success
type: dict type: dict
scheduling: scheduling:
@ -781,17 +776,17 @@ scheduling:
contains: contains:
automaticRestart: automaticRestart:
description: description:
- Specifies whether the instance should be automatically restarted if it is - Specifies whether the instance should be automatically restarted if it is terminated
terminated by Compute Engine (not terminated by a user). by Compute Engine (not terminated by a user).
- You can only set the automatic restart option for standard instances. Preemptible - You can only set the automatic restart option for standard instances. Preemptible
instances cannot be automatically restarted. instances cannot be automatically restarted.
returned: success returned: success
type: bool type: bool
onHostMaintenance: onHostMaintenance:
description: description:
- Defines the maintenance behavior for this instance. For standard instances, - Defines the maintenance behavior for this instance. For standard instances, the
the default behavior is MIGRATE. For preemptible instances, the default and default behavior is MIGRATE. For preemptible instances, the default and only possible
only possible behavior is TERMINATE. behavior is TERMINATE.
- For more information, see Setting Instance Scheduling Options. - For more information, see Setting Instance Scheduling Options.
returned: success returned: success
type: str type: str
@ -822,8 +817,6 @@ status:
description: description:
- 'The status of the instance. One of the following values: PROVISIONING, STAGING, - 'The status of the instance. One of the following values: PROVISIONING, STAGING,
RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.' RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.'
- As a user, use RUNNING to keep a machine "on" and TERMINATED to turn a machine
off .
returned: success returned: success
type: str type: str
statusMessage: statusMessage:
@ -842,11 +835,11 @@ tags:
contains: contains:
fingerprint: fingerprint:
description: description:
- Specifies a fingerprint for this request, which is essentially a hash of the - Specifies a fingerprint for this request, which is essentially a hash of the metadata's
metadata's contents and used for optimistic locking. contents and used for optimistic locking.
- The fingerprint is initially generated by Compute Engine and changes after - The fingerprint is initially generated by Compute Engine and changes after every
every request to modify or update metadata. You must always provide an up-to-date request to modify or update metadata. You must always provide an up-to-date fingerprint
fingerprint hash in order to update or change metadata. hash in order to update or change metadata.
returned: success returned: success
type: str type: str
items: items:

257
plugins/modules/gcp_compute_instance_facts.py
View file

@ -64,16 +64,15 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
canIpForward: canIpForward:
description: description:
- Allows this instance to send and receive packets with non-matching destination - Allows this instance to send and receive packets with non-matching destination or
or source IPs. This is required if you plan to use this instance to forward source IPs. This is required if you plan to use this instance to forward routes.
routes.
returned: success returned: success
type: bool type: bool
cpuPlatform: cpuPlatform:
@ -88,31 +87,30 @@ resources:
type: str type: str
disks: disks:
description: description:
- An array of disks that are associated with the instances that are created - An array of disks that are associated with the instances that are created from this
from this template. template.
returned: success returned: success
type: complex type: complex
contains: contains:
autoDelete: autoDelete:
description: description:
- Specifies whether the disk will be auto-deleted when the instance is deleted - Specifies whether the disk will be auto-deleted when the instance is deleted (but
(but not when the disk is detached from the instance). not when the disk is detached from the instance).
- 'Tip: Disks should be set to autoDelete=true so that leftover disks are - 'Tip: Disks should be set to autoDelete=true so that leftover disks are not left
not left behind on machine deletion.' behind on machine deletion.'
returned: success returned: success
type: bool type: bool
boot: boot:
description: description:
- Indicates that this is a boot disk. The virtual machine will use the first - Indicates that this is a boot disk. The virtual machine will use the first partition
partition of the disk for its root filesystem. of the disk for its root filesystem.
returned: success returned: success
type: bool type: bool
deviceName: deviceName:
description: description:
- Specifies a unique device name of your choice that is reflected into the - Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-*
/dev/disk/by-id/google-* tree of a Linux operating system running within tree of a Linux operating system running within the instance. This name can be used
the instance. This name can be used to reference the device for mounting, to reference the device for mounting, resizing, and so on, from within the instance.
resizing, and so on, from within the instance.
returned: success returned: success
type: str type: str
diskEncryptionKey: diskEncryptionKey:
@ -123,42 +121,41 @@ resources:
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
4648 base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
rsaEncryptedKey: rsaEncryptedKey:
description: description:
- Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption
encryption key to either encrypt or decrypt this resource. key to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
encryption key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
index: index:
description: description:
- Assigns a zero-based index to this disk, where 0 is reserved for the boot - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk.
disk. For example, if you have many disks attached to an instance, each For example, if you have many disks attached to an instance, each disk would have
disk would have a unique index number. If not specified, the server will a unique index number. If not specified, the server will choose an appropriate value.
choose an appropriate value.
returned: success returned: success
type: int type: int
initializeParams: initializeParams:
description: description:
- Specifies the parameters for a new disk that will be created alongside - Specifies the parameters for a new disk that will be created alongside the new instance.
the new instance. Use initialization parameters to create boot disks or Use initialization parameters to create boot disks or local SSDs attached to the
local SSDs attached to the new instance. new instance.
returned: success returned: success
type: complex type: complex
contains: contains:
diskName: diskName:
description: description:
- Specifies the disk name. If not specified, the default is to use the - Specifies the disk name. If not specified, the default is to use the name of the
name of the instance. instance.
returned: success returned: success
type: str type: str
diskSizeGb: diskSizeGb:
@ -168,62 +165,60 @@ resources:
type: int type: int
diskType: diskType:
description: description:
- Reference to a disk type. - Reference to a gcompute_disk_type resource.
- Specifies the disk type to use to create the instance. - Specifies the disk type to use to create the instance.
- If not specified, the default is pd-standard. - If not specified, the default is pd-standard.
returned: success returned: success
type: str type: str
sourceImage: sourceImage:
description: description:
- The source image to create this disk. When creating a new instance, - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage
one of initializeParams.sourceImage or disks.source is required. To or disks.source is required. To create a disk with one of the public operating
create a disk with one of the public operating system images, specify system images, specify the image by its family name.
the image by its family name.
returned: success returned: success
type: str type: str
sourceImageEncryptionKey: sourceImageEncryptionKey:
description: description:
- The customer-supplied encryption key of the source image. Required - The customer-supplied encryption key of the source image. Required if the source
if the source image is protected by a customer-supplied encryption image is protected by a customer-supplied encryption key.
key. - Instance templates do not store customer-supplied encryption keys, so you cannot
- Instance templates do not store customer-supplied encryption keys, create disks for instances in a managed instance group if the source images are
so you cannot create disks for instances in a managed instance group encrypted with your own keys.
if the source images are encrypted with your own keys.
returned: success returned: success
type: complex type: complex
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
in RFC 4648 base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
encryption key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
interface: interface:
description: description:
- Specifies the disk interface to use for attaching this disk, which is - Specifies the disk interface to use for attaching this disk, which is either SCSI
either SCSI or NVME. The default is SCSI. or NVME. The default is SCSI.
- Persistent disks must always use SCSI and the request will fail if you - Persistent disks must always use SCSI and the request will fail if you attempt to
attempt to attach a persistent disk in any other format than SCSI. attach a persistent disk in any other format than SCSI.
returned: success returned: success
type: str type: str
mode: mode:
description: description:
- The mode in which to attach this disk, either READ_WRITE or READ_ONLY. - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified,
If not specified, the default is to attach the disk in READ_WRITE mode. the default is to attach the disk in READ_WRITE mode.
returned: success returned: success
type: str type: str
source: source:
description: description:
- Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage
or disks.source is required. or disks.source is required.
- If desired, you can also attach existing non-root persistent disks using - If desired, you can also attach existing non-root persistent disks using this property.
this property. This field is only applicable for persistent disks. This field is only applicable for persistent disks.
returned: success returned: success
type: dict type: dict
type: type:
@ -245,29 +240,26 @@ resources:
type: int type: int
acceleratorType: acceleratorType:
description: description:
- Full or partial URL of the accelerator type resource to expose to this - Full or partial URL of the accelerator type resource to expose to this instance.
instance.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. This identifier is defined by the - The unique identifier for the resource. This identifier is defined by the server.
server.
returned: success returned: success
type: int type: int
labelFingerprint: labelFingerprint:
description: description:
- A fingerprint for this request, which is essentially a hash of the metadata's - A fingerprint for this request, which is essentially a hash of the metadata's contents
contents and used for optimistic locking. The fingerprint is initially generated and used for optimistic locking. The fingerprint is initially generated by Compute
by Compute Engine and changes after every request to modify or update metadata. Engine and changes after every request to modify or update metadata. You must always
You must always provide an up-to-date fingerprint hash in order to update provide an up-to-date fingerprint hash in order to update or change metadata.
or change metadata.
returned: success returned: success
type: str type: str
metadata: metadata:
description: description:
- The metadata key/value pairs to assign to instances that are created from - The metadata key/value pairs to assign to instances that are created from this template.
this template. These pairs can consist of custom metadata or predefined keys. These pairs can consist of custom metadata or predefined keys.
returned: success returned: success
type: dict type: dict
machineType: machineType:
@ -277,51 +269,51 @@ resources:
type: str type: str
minCpuPlatform: minCpuPlatform:
description: description:
- Specifies a minimum CPU platform for the VM instance. Applicable values are - Specifies a minimum CPU platform for the VM instance. Applicable values are the
the friendly names of CPU platforms . friendly names of CPU platforms .
returned: success returned: success
type: str type: str
name: name:
description: description:
- The name of the resource, provided by the client when initially creating the - The name of the resource, provided by the client when initially creating the resource.
resource. The resource name must be 1-63 characters long, and comply with The resource name must be 1-63 characters long, and comply with RFC1035. Specifically,
RFC1035. Specifically, the name must be 1-63 characters long and match the the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character which means the first character must be a lowercase letter, and all following characters
must be a lowercase letter, and all following characters must be a dash, lowercase must be a dash, lowercase letter, or digit, except the last character, which cannot
letter, or digit, except the last character, which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
networkInterfaces: networkInterfaces:
description: description:
- An array of configurations for this interface. This specifies how this interface - An array of configurations for this interface. This specifies how this interface
is configured to interact with other network services, such as connecting is configured to interact with other network services, such as connecting to the
to the internet. Only one network interface is supported per instance. internet. Only one network interface is supported per instance.
returned: success returned: success
type: complex type: complex
contains: contains:
accessConfigs: accessConfigs:
description: description:
- An array of configurations for this interface. Currently, only one access - An array of configurations for this interface. Currently, only one access config,
config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this
then this instance will have no external internet access. instance will have no external internet access.
returned: success returned: success
type: complex type: complex
contains: contains:
name: name:
description: description:
- The name of this access configuration. The default and recommended - The name of this access configuration. The default and recommended name is External
name is External NAT but you can use any arbitrary string you would NAT but you can use any arbitrary string you would like. For example, My external
like. For example, My external IP or Network Access. IP or Network Access.
returned: success returned: success
type: str type: str
natIP: natIP:
description: description:
- Reference to an address. - Specifies the title of a gcompute_address.
- An external IP address associated with this instance. - An external IP address associated with this instance.
- Specify an unused static external IP address available to the project - Specify an unused static external IP address available to the project or leave this
or leave this field undefined to use an IP from a shared ephemeral field undefined to use an IP from a shared ephemeral IP address pool. If you specify
IP address pool. If you specify a static external IP address, it must a static external IP address, it must live in the same region as the zone of the
live in the same region as the zone of the instance. instance.
returned: success returned: success
type: dict type: dict
type: type:
@ -331,54 +323,53 @@ resources:
type: str type: str
aliasIpRanges: aliasIpRanges:
description: description:
- An array of alias IP ranges for this network interface. Can only be specified - An array of alias IP ranges for this network interface. Can only be specified for
for network interfaces on subnet-mode networks. network interfaces on subnet-mode networks.
returned: success returned: success
type: complex type: complex
contains: contains:
ipCidrRange: ipCidrRange:
description: description:
- The IP CIDR range represented by this alias IP range. - The IP CIDR range represented by this alias IP range.
- This IP CIDR range must belong to the specified subnetwork and cannot - This IP CIDR range must belong to the specified subnetwork and cannot contain IP
contain IP addresses reserved by system or used by other network interfaces. addresses reserved by system or used by other network interfaces. This range may
This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string
/24) or a CIDR format string (e.g. 10.1.2.0/24). (e.g. 10.1.2.0/24).
returned: success returned: success
type: str type: str
subnetworkRangeName: subnetworkRangeName:
description: description:
- Optional subnetwork secondary range name specifying the secondary - Optional subnetwork secondary range name specifying the secondary range from which
range from which to allocate the IP CIDR range for this alias IP range. to allocate the IP CIDR range for this alias IP range. If left unspecified, the
If left unspecified, the primary range of the subnetwork will be used. primary range of the subnetwork will be used.
returned: success returned: success
type: str type: str
name: name:
description: description:
- The name of the network interface, generated by the server. For network - The name of the network interface, generated by the server. For network devices,
devices, these are eth0, eth1, etc . these are eth0, eth1, etc .
returned: success returned: success
type: str type: str
network: network:
description: description:
- Specifies the title of an existing network. When creating an instance, - Specifies the title of an existing gcompute_network. When creating an instance,
if neither the network nor the subnetwork is specified, the default network if neither the network nor the subnetwork is specified, the default network global/networks/default
global/networks/default is used; if the network is not specified but the is used; if the network is not specified but the subnetwork is specified, the network
subnetwork is specified, the network is inferred. is inferred.
returned: success returned: success
type: dict type: dict
networkIP: networkIP:
description: description:
- An IPv4 internal network address to assign to the instance for this network - An IPv4 internal network address to assign to the instance for this network interface.
interface. If not specified by the user, an unused internal IP is assigned If not specified by the user, an unused internal IP is assigned by the system.
by the system.
returned: success returned: success
type: str type: str
subnetwork: subnetwork:
description: description:
- Reference to a VPC network. - Reference to a gcompute_subnetwork resource.
- If the network resource is in legacy mode, do not provide this property. - If the network resource is in legacy mode, do not provide this property. If the
If the network is in auto subnet mode, providing the subnetwork is optional. network is in auto subnet mode, providing the subnetwork is optional. If the network
If the network is in custom subnet mode, then this field should be specified. is in custom subnet mode, then this field should be specified.
returned: success returned: success
type: dict type: dict
scheduling: scheduling:
@ -389,31 +380,30 @@ resources:
contains: contains:
automaticRestart: automaticRestart:
description: description:
- Specifies whether the instance should be automatically restarted if it - Specifies whether the instance should be automatically restarted if it is terminated
is terminated by Compute Engine (not terminated by a user). by Compute Engine (not terminated by a user).
- You can only set the automatic restart option for standard instances. - You can only set the automatic restart option for standard instances. Preemptible
Preemptible instances cannot be automatically restarted. instances cannot be automatically restarted.
returned: success returned: success
type: bool type: bool
onHostMaintenance: onHostMaintenance:
description: description:
- Defines the maintenance behavior for this instance. For standard instances, - Defines the maintenance behavior for this instance. For standard instances, the
the default behavior is MIGRATE. For preemptible instances, the default default behavior is MIGRATE. For preemptible instances, the default and only possible
and only possible behavior is TERMINATE. behavior is TERMINATE.
- For more information, see Setting Instance Scheduling Options. - For more information, see Setting Instance Scheduling Options.
returned: success returned: success
type: str type: str
preemptible: preemptible:
description: description:
- Defines whether the instance is preemptible. This can only be set during - Defines whether the instance is preemptible. This can only be set during instance
instance creation, it cannot be set or changed after the instance has creation, it cannot be set or changed after the instance has been created.
been created.
returned: success returned: success
type: bool type: bool
serviceAccounts: serviceAccounts:
description: description:
- A list of service accounts, with their specified scopes, authorized for this - A list of service accounts, with their specified scopes, authorized for this instance.
instance. Only one service account per VM instance is supported. Only one service account per VM instance is supported.
returned: success returned: success
type: complex type: complex
contains: contains:
@ -431,8 +421,6 @@ resources:
description: description:
- 'The status of the instance. One of the following values: PROVISIONING, STAGING, - 'The status of the instance. One of the following values: PROVISIONING, STAGING,
RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.' RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.'
- As a user, use RUNNING to keep a machine "on" and TERMINATED to turn a machine
off .
returned: success returned: success
type: str type: str
statusMessage: statusMessage:
@ -442,26 +430,25 @@ resources:
type: str type: str
tags: tags:
description: description:
- A list of tags to apply to this instance. Tags are used to identify valid - A list of tags to apply to this instance. Tags are used to identify valid sources
sources or targets for network firewalls and are specified by the client during or targets for network firewalls and are specified by the client during instance
instance creation. The tags can be later modified by the setTags method. Each creation. The tags can be later modified by the setTags method. Each tag within
tag within the list must comply with RFC1035. the list must comply with RFC1035.
returned: success returned: success
type: complex type: complex
contains: contains:
fingerprint: fingerprint:
description: description:
- Specifies a fingerprint for this request, which is essentially a hash - Specifies a fingerprint for this request, which is essentially a hash of the metadata's
of the metadata's contents and used for optimistic locking. contents and used for optimistic locking.
- The fingerprint is initially generated by Compute Engine and changes after - The fingerprint is initially generated by Compute Engine and changes after every
every request to modify or update metadata. You must always provide an request to modify or update metadata. You must always provide an up-to-date fingerprint
up-to-date fingerprint hash in order to update or change metadata. hash in order to update or change metadata.
returned: success returned: success
type: str type: str
items: items:
description: description:
- An array of tags. Each tag must be 1-63 characters long, and comply with - An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
RFC1035.
returned: success returned: success
type: list type: list
zone: zone:

17
plugins/modules/gcp_compute_instance_group.py
View file

@ -143,23 +143,6 @@ name:
returned: success returned: success
type: str type: str
namedPorts: namedPorts:
description:
- Assigns a name to a port number.
- 'For example: {name: "http", port: 80}.'
- This allows the system to reference ports by the assigned name instead of a port
number. Named ports can also contain multiple ports.
- 'For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports
apply to all instances in this instance group.'
returned: success
type: complex
contains:
name:
description:
- The name of the instance group.
- The name must be 1-63 characters long, and comply with RFC1035.
returned: success
type: str
named_ports:
description: description:
- Assigns a name to a port number. - Assigns a name to a port number.
- 'For example: {name: "http", port: 80}.' - 'For example: {name: "http", port: 80}.'

21
plugins/modules/gcp_compute_instance_group_facts.py
View file

@ -64,8 +64,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -92,23 +92,6 @@ resources:
returned: success returned: success
type: str type: str
namedPorts: namedPorts:
description:
- Assigns a name to a port number.
- 'For example: {name: "http", port: 80}.'
- This allows the system to reference ports by the assigned name instead of
a port number. Named ports can also contain multiple ports.
- 'For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named
ports apply to all instances in this instance group.'
returned: success
type: complex
contains:
name:
description:
- The name of the instance group.
- The name must be 1-63 characters long, and comply with RFC1035.
returned: success
type: str
named_ports:
description: description:
- Assigns a name to a port number. - Assigns a name to a port number.
- 'For example: {name: "http", port: 80}.' - 'For example: {name: "http", port: 80}.'

48
plugins/modules/gcp_compute_instance_group_manager.py
View file

@ -192,16 +192,16 @@ currentActions:
contains: contains:
abandoning: abandoning:
description: description:
- The total number of instances in the managed instance group that are scheduled - The total number of instances in the managed instance group that are scheduled to
to be abandoned. Abandoning an instance removes it from the managed instance be abandoned. Abandoning an instance removes it from the managed instance group
group without deleting it. without deleting it.
returned: success returned: success
type: int type: int
creating: creating:
description: description:
- The number of instances in the managed instance group that are scheduled to - The number of instances in the managed instance group that are scheduled to be created
be created or are currently being created. If the group fails to create any or are currently being created. If the group fails to create any of these instances,
of these instances, it tries again until it creates the instance successfully. it tries again until it creates the instance successfully.
- If you have disabled creation retries, this field will not be populated; instead, - If you have disabled creation retries, this field will not be populated; instead,
the creatingWithoutRetries field will be populated. the creatingWithoutRetries field will be populated.
returned: success returned: success
@ -209,28 +209,28 @@ currentActions:
creatingWithoutRetries: creatingWithoutRetries:
description: description:
- The number of instances that the managed instance group will attempt to create. - The number of instances that the managed instance group will attempt to create.
The group attempts to create each instance only once. If the group fails to The group attempts to create each instance only once. If the group fails to create
create any of these instances, it decreases the group's targetSize value accordingly. any of these instances, it decreases the group's targetSize value accordingly.
returned: success returned: success
type: int type: int
deleting: deleting:
description: description:
- The number of instances in the managed instance group that are scheduled to - The number of instances in the managed instance group that are scheduled to be deleted
be deleted or are currently being deleted. or are currently being deleted.
returned: success returned: success
type: int type: int
none: none:
description: description:
- The number of instances in the managed instance group that are running and - The number of instances in the managed instance group that are running and have
have no scheduled actions. no scheduled actions.
returned: success returned: success
type: int type: int
recreating: recreating:
description: description:
- The number of instances in the managed instance group that are scheduled to - The number of instances in the managed instance group that are scheduled to be recreated
be recreated or are currently being being recreated. or are currently being being recreated.
- Recreating an instance deletes the existing root persistent disk and creates - Recreating an instance deletes the existing root persistent disk and creates a new
a new disk from the image that is defined in the instance template. disk from the image that is defined in the instance template.
returned: success returned: success
type: int type: int
refreshing: refreshing:
@ -242,8 +242,8 @@ currentActions:
type: int type: int
restarting: restarting:
description: description:
- The number of instances in the managed instance group that are scheduled to - The number of instances in the managed instance group that are scheduled to be restarted
be restarted or are currently being restarted. or are currently being restarted.
returned: success returned: success
type: int type: int
description: description:
@ -270,14 +270,14 @@ instanceTemplate:
type: dict type: dict
name: name:
description: description:
- The name of the managed instance group. The name must be 1-63 characters long, - The name of the managed instance group. The name must be 1-63 characters long, and
and comply with RFC1035. comply with RFC1035.
returned: success returned: success
type: str type: str
namedPorts: namedPorts:
description: description:
- Named ports configured for the Instance Groups complementary to this Instance - Named ports configured for the Instance Groups complementary to this Instance Group
Group Manager. Manager.
returned: success returned: success
type: complex type: complex
contains: contains:
@ -299,8 +299,8 @@ region:
type: str type: str
targetPools: targetPools:
description: description:
- TargetPool resources to which instances in the instanceGroup field are added. - TargetPool resources to which instances in the instanceGroup field are added. The
The target pools automatically apply to all of the instances in the managed instance target pools automatically apply to all of the instances in the managed instance
group. group.
returned: success returned: success
type: list type: list

83
plugins/modules/gcp_compute_instance_group_manager_facts.py
View file

@ -64,16 +64,16 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
baseInstanceName: baseInstanceName:
description: description:
- The base instance name to use for instances in this group. The value must - The base instance name to use for instances in this group. The value must be 1-58
be 1-58 characters long. Instances are named by appending a hyphen and a random characters long. Instances are named by appending a hyphen and a random four-character
four-character string to the base instance name. string to the base instance name.
- The base instance name must comply with RFC1035. - The base instance name must comply with RFC1035.
returned: success returned: success
type: str type: str
@ -91,59 +91,58 @@ resources:
contains: contains:
abandoning: abandoning:
description: description:
- The total number of instances in the managed instance group that are scheduled - The total number of instances in the managed instance group that are scheduled to
to be abandoned. Abandoning an instance removes it from the managed instance be abandoned. Abandoning an instance removes it from the managed instance group
group without deleting it. without deleting it.
returned: success returned: success
type: int type: int
creating: creating:
description: description:
- The number of instances in the managed instance group that are scheduled - The number of instances in the managed instance group that are scheduled to be created
to be created or are currently being created. If the group fails to create or are currently being created. If the group fails to create any of these instances,
any of these instances, it tries again until it creates the instance successfully. it tries again until it creates the instance successfully.
- If you have disabled creation retries, this field will not be populated; - If you have disabled creation retries, this field will not be populated; instead,
instead, the creatingWithoutRetries field will be populated. the creatingWithoutRetries field will be populated.
returned: success returned: success
type: int type: int
creatingWithoutRetries: creatingWithoutRetries:
description: description:
- The number of instances that the managed instance group will attempt to - The number of instances that the managed instance group will attempt to create.
create. The group attempts to create each instance only once. If the group The group attempts to create each instance only once. If the group fails to create
fails to create any of these instances, it decreases the group's targetSize any of these instances, it decreases the group's targetSize value accordingly.
value accordingly.
returned: success returned: success
type: int type: int
deleting: deleting:
description: description:
- The number of instances in the managed instance group that are scheduled - The number of instances in the managed instance group that are scheduled to be deleted
to be deleted or are currently being deleted. or are currently being deleted.
returned: success returned: success
type: int type: int
none: none:
description: description:
- The number of instances in the managed instance group that are running - The number of instances in the managed instance group that are running and have
and have no scheduled actions. no scheduled actions.
returned: success returned: success
type: int type: int
recreating: recreating:
description: description:
- The number of instances in the managed instance group that are scheduled - The number of instances in the managed instance group that are scheduled to be recreated
to be recreated or are currently being being recreated. or are currently being being recreated.
- Recreating an instance deletes the existing root persistent disk and creates - Recreating an instance deletes the existing root persistent disk and creates a new
a new disk from the image that is defined in the instance template. disk from the image that is defined in the instance template.
returned: success returned: success
type: int type: int
refreshing: refreshing:
description: description:
- The number of instances in the managed instance group that are being reconfigured - The number of instances in the managed instance group that are being reconfigured
with properties that do not require a restart or a recreate action. For with properties that do not require a restart or a recreate action. For example,
example, setting or removing target pools for the instance. setting or removing target pools for the instance.
returned: success returned: success
type: int type: int
restarting: restarting:
description: description:
- The number of instances in the managed instance group that are scheduled - The number of instances in the managed instance group that are scheduled to be restarted
to be restarted or are currently being restarted. or are currently being restarted.
returned: success returned: success
type: int type: int
description: description:
@ -164,28 +163,27 @@ resources:
type: dict type: dict
instanceTemplate: instanceTemplate:
description: description:
- The instance template that is specified for this managed instance group. The - The instance template that is specified for this managed instance group. The group
group uses this template to create all new instances in the managed instance uses this template to create all new instances in the managed instance group.
group.
returned: success returned: success
type: dict type: dict
name: name:
description: description:
- The name of the managed instance group. The name must be 1-63 characters long, - The name of the managed instance group. The name must be 1-63 characters long, and
and comply with RFC1035. comply with RFC1035.
returned: success returned: success
type: str type: str
namedPorts: namedPorts:
description: description:
- Named ports configured for the Instance Groups complementary to this Instance - Named ports configured for the Instance Groups complementary to this Instance Group
Group Manager. Manager.
returned: success returned: success
type: complex type: complex
contains: contains:
name: name:
description: description:
- The name for this named port. The name must be 1-63 characters long, and - The name for this named port. The name must be 1-63 characters long, and comply
comply with RFC1035. with RFC1035.
returned: success returned: success
type: str type: str
port: port:
@ -200,16 +198,15 @@ resources:
type: str type: str
targetPools: targetPools:
description: description:
- TargetPool resources to which instances in the instanceGroup field are added. - TargetPool resources to which instances in the instanceGroup field are added. The
The target pools automatically apply to all of the instances in the managed target pools automatically apply to all of the instances in the managed instance
instance group. group.
returned: success returned: success
type: list type: list
targetSize: targetSize:
description: description:
- The target number of running instances for this managed instance group. Deleting - The target number of running instances for this managed instance group. Deleting
or abandoning instances reduces this number. Resizing the group changes this or abandoning instances reduces this number. Resizing the group changes this number.
number.
returned: success returned: success
type: int type: int
zone: zone:

243
plugins/modules/gcp_compute_instance_template.py
View file

@ -472,46 +472,45 @@ properties:
contains: contains:
canIpForward: canIpForward:
description: description:
- Enables instances created based on this template to send packets with source - Enables instances created based on this template to send packets with source IP
IP addresses other than their own and receive packets with destination IP addresses other than their own and receive packets with destination IP addresses
addresses other than their own. If these instances will be used as an IP gateway other than their own. If these instances will be used as an IP gateway or it will
or it will be set as the next-hop in a Route resource, specify true. If unsure, be set as the next-hop in a Route resource, specify true. If unsure, leave this
leave this set to false. set to false.
returned: success returned: success
type: bool type: bool
description: description:
description: description:
- An optional text description for the instances that are created from this - An optional text description for the instances that are created from this instance
instance template. template.
returned: success returned: success
type: str type: str
disks: disks:
description: description:
- An array of disks that are associated with the instances that are created - An array of disks that are associated with the instances that are created from this
from this template. template.
returned: success returned: success
type: complex type: complex
contains: contains:
autoDelete: autoDelete:
description: description:
- Specifies whether the disk will be auto-deleted when the instance is deleted - Specifies whether the disk will be auto-deleted when the instance is deleted (but
(but not when the disk is detached from the instance). not when the disk is detached from the instance).
- 'Tip: Disks should be set to autoDelete=true so that leftover disks are - 'Tip: Disks should be set to autoDelete=true so that leftover disks are not left
not left behind on machine deletion.' behind on machine deletion.'
returned: success returned: success
type: bool type: bool
boot: boot:
description: description:
- Indicates that this is a boot disk. The virtual machine will use the first - Indicates that this is a boot disk. The virtual machine will use the first partition
partition of the disk for its root filesystem. of the disk for its root filesystem.
returned: success returned: success
type: bool type: bool
deviceName: deviceName:
description: description:
- Specifies a unique device name of your choice that is reflected into the - Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-*
/dev/disk/by-id/google-* tree of a Linux operating system running within tree of a Linux operating system running within the instance. This name can be used
the instance. This name can be used to reference the device for mounting, to reference the device for mounting, resizing, and so on, from within the instance.
resizing, and so on, from within the instance.
returned: success returned: success
type: str type: str
diskEncryptionKey: diskEncryptionKey:
@ -522,42 +521,41 @@ properties:
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
4648 base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
rsaEncryptedKey: rsaEncryptedKey:
description: description:
- Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption
encryption key to either encrypt or decrypt this resource. key to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
encryption key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
index: index:
description: description:
- Assigns a zero-based index to this disk, where 0 is reserved for the boot - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk.
disk. For example, if you have many disks attached to an instance, each For example, if you have many disks attached to an instance, each disk would have
disk would have a unique index number. If not specified, the server will a unique index number. If not specified, the server will choose an appropriate value.
choose an appropriate value.
returned: success returned: success
type: int type: int
initializeParams: initializeParams:
description: description:
- Specifies the parameters for a new disk that will be created alongside - Specifies the parameters for a new disk that will be created alongside the new instance.
the new instance. Use initialization parameters to create boot disks or Use initialization parameters to create boot disks or local SSDs attached to the
local SSDs attached to the new instance. new instance.
returned: success returned: success
type: complex type: complex
contains: contains:
diskName: diskName:
description: description:
- Specifies the disk name. If not specified, the default is to use the - Specifies the disk name. If not specified, the default is to use the name of the
name of the instance. instance.
returned: success returned: success
type: str type: str
diskSizeGb: diskSizeGb:
@ -567,64 +565,61 @@ properties:
type: int type: int
diskType: diskType:
description: description:
- Reference to a disk type. - Reference to a gcompute_disk_type resource.
- Specifies the disk type to use to create the instance. - Specifies the disk type to use to create the instance.
- If not specified, the default is pd-standard. - If not specified, the default is pd-standard.
returned: success returned: success
type: str type: str
sourceImage: sourceImage:
description: description:
- The source image to create this disk. When creating a new instance, - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage
one of initializeParams.sourceImage or disks.source is required. To or disks.source is required. To create a disk with one of the public operating
create a disk with one of the public operating system images, specify system images, specify the image by its family name.
the image by its family name.
returned: success returned: success
type: str type: str
sourceImageEncryptionKey: sourceImageEncryptionKey:
description: description:
- The customer-supplied encryption key of the source image. Required - The customer-supplied encryption key of the source image. Required if the source
if the source image is protected by a customer-supplied encryption image is protected by a customer-supplied encryption key.
key. - Instance templates do not store customer-supplied encryption keys, so you cannot
- Instance templates do not store customer-supplied encryption keys, create disks for instances in a managed instance group if the source images are
so you cannot create disks for instances in a managed instance group encrypted with your own keys.
if the source images are encrypted with your own keys.
returned: success returned: success
type: complex type: complex
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
in RFC 4648 base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
encryption key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
interface: interface:
description: description:
- Specifies the disk interface to use for attaching this disk, which is - Specifies the disk interface to use for attaching this disk, which is either SCSI
either SCSI or NVME. The default is SCSI. or NVME. The default is SCSI.
- Persistent disks must always use SCSI and the request will fail if you - Persistent disks must always use SCSI and the request will fail if you attempt to
attempt to attach a persistent disk in any other format than SCSI. attach a persistent disk in any other format than SCSI.
returned: success returned: success
type: str type: str
mode: mode:
description: description:
- The mode in which to attach this disk, either READ_WRITE or READ_ONLY. - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified,
If not specified, the default is to attach the disk in READ_WRITE mode. the default is to attach the disk in READ_WRITE mode.
returned: success returned: success
type: str type: str
source: source:
description: description:
- Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage
or disks.source is required. or disks.source is required.
- If desired, you can also attach existing non-root persistent disks using - If desired, you can also attach existing non-root persistent disks using this property.
this property. This field is only applicable for persistent disks. This field is only applicable for persistent disks.
- Note that for InstanceTemplate, specify the disk name, not the URL for - Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
the disk.
returned: success returned: success
type: dict type: dict
type: type:
@ -635,19 +630,13 @@ properties:
type: str type: str
machineType: machineType:
description: description:
- The machine type to use in the VM instance template. - Reference to a gcompute_machine_type resource.
returned: success
type: str
minCpuPlatform:
description:
- Specifies a minimum CPU platform for the VM instance. Applicable values are
the friendly names of CPU platforms .
returned: success returned: success
type: str type: str
metadata: metadata:
description: description:
- The metadata key/value pairs to assign to instances that are created from - The metadata key/value pairs to assign to instances that are created from this template.
this template. These pairs can consist of custom metadata or predefined keys. These pairs can consist of custom metadata or predefined keys.
returned: success returned: success
type: dict type: dict
guestAccelerators: guestAccelerators:
@ -663,41 +652,40 @@ properties:
type: int type: int
acceleratorType: acceleratorType:
description: description:
- Full or partial URL of the accelerator type resource to expose to this - Full or partial URL of the accelerator type resource to expose to this instance.
instance.
returned: success returned: success
type: str type: str
networkInterfaces: networkInterfaces:
description: description:
- An array of configurations for this interface. This specifies how this interface - An array of configurations for this interface. This specifies how this interface
is configured to interact with other network services, such as connecting is configured to interact with other network services, such as connecting to the
to the internet. Only one network interface is supported per instance. internet. Only one network interface is supported per instance.
returned: success returned: success
type: complex type: complex
contains: contains:
accessConfigs: accessConfigs:
description: description:
- An array of configurations for this interface. Currently, only one access - An array of configurations for this interface. Currently, only one access config,
config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this
then this instance will have no external internet access. instance will have no external internet access.
returned: success returned: success
type: complex type: complex
contains: contains:
name: name:
description: description:
- The name of this access configuration. The default and recommended - The name of this access configuration. The default and recommended name is External
name is External NAT but you can use any arbitrary string you would NAT but you can use any arbitrary string you would like. For example, My external
like. For example, My external IP or Network Access. IP or Network Access.
returned: success returned: success
type: str type: str
natIP: natIP:
description: description:
- Reference to an address. - Specifies the title of a gcompute_address.
- An external IP address associated with this instance. - An external IP address associated with this instance.
- Specify an unused static external IP address available to the project - Specify an unused static external IP address available to the project or leave this
or leave this field undefined to use an IP from a shared ephemeral field undefined to use an IP from a shared ephemeral IP address pool. If you specify
IP address pool. If you specify a static external IP address, it must a static external IP address, it must live in the same region as the zone of the
live in the same region as the zone of the instance. instance.
returned: success returned: success
type: dict type: dict
type: type:
@ -707,54 +695,53 @@ properties:
type: str type: str
aliasIpRanges: aliasIpRanges:
description: description:
- An array of alias IP ranges for this network interface. Can only be specified - An array of alias IP ranges for this network interface. Can only be specified for
for network interfaces on subnet-mode networks. network interfaces on subnet-mode networks.
returned: success returned: success
type: complex type: complex
contains: contains:
ipCidrRange: ipCidrRange:
description: description:
- The IP CIDR range represented by this alias IP range. - The IP CIDR range represented by this alias IP range.
- This IP CIDR range must belong to the specified subnetwork and cannot - This IP CIDR range must belong to the specified subnetwork and cannot contain IP
contain IP addresses reserved by system or used by other network interfaces. addresses reserved by system or used by other network interfaces. This range may
This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string
/24) or a CIDR format string (e.g. 10.1.2.0/24). (e.g. 10.1.2.0/24).
returned: success returned: success
type: str type: str
subnetworkRangeName: subnetworkRangeName:
description: description:
- Optional subnetwork secondary range name specifying the secondary - Optional subnetwork secondary range name specifying the secondary range from which
range from which to allocate the IP CIDR range for this alias IP range. to allocate the IP CIDR range for this alias IP range. If left unspecified, the
If left unspecified, the primary range of the subnetwork will be used. primary range of the subnetwork will be used.
returned: success returned: success
type: str type: str
name: name:
description: description:
- The name of the network interface, generated by the server. For network - The name of the network interface, generated by the server. For network devices,
devices, these are eth0, eth1, etc . these are eth0, eth1, etc .
returned: success returned: success
type: str type: str
network: network:
description: description:
- Specifies the title of an existing network. When creating an instance, - Specifies the title of an existing gcompute_network. When creating an instance,
if neither the network nor the subnetwork is specified, the default network if neither the network nor the subnetwork is specified, the default network global/networks/default
global/networks/default is used; if the network is not specified but the is used; if the network is not specified but the subnetwork is specified, the network
subnetwork is specified, the network is inferred. is inferred.
returned: success returned: success
type: dict type: dict
networkIP: networkIP:
description: description:
- An IPv4 internal network address to assign to the instance for this network - An IPv4 internal network address to assign to the instance for this network interface.
interface. If not specified by the user, an unused internal IP is assigned If not specified by the user, an unused internal IP is assigned by the system.
by the system.
returned: success returned: success
type: str type: str
subnetwork: subnetwork:
description: description:
- Reference to a VPC network. - Reference to a gcompute_subnetwork resource.
- If the network resource is in legacy mode, do not provide this property. - If the network resource is in legacy mode, do not provide this property. If the
If the network is in auto subnet mode, providing the subnetwork is optional. network is in auto subnet mode, providing the subnetwork is optional. If the network
If the network is in custom subnet mode, then this field should be specified. is in custom subnet mode, then this field should be specified.
returned: success returned: success
type: dict type: dict
scheduling: scheduling:
@ -765,31 +752,30 @@ properties:
contains: contains:
automaticRestart: automaticRestart:
description: description:
- Specifies whether the instance should be automatically restarted if it - Specifies whether the instance should be automatically restarted if it is terminated
is terminated by Compute Engine (not terminated by a user). by Compute Engine (not terminated by a user).
- You can only set the automatic restart option for standard instances. - You can only set the automatic restart option for standard instances. Preemptible
Preemptible instances cannot be automatically restarted. instances cannot be automatically restarted.
returned: success returned: success
type: bool type: bool
onHostMaintenance: onHostMaintenance:
description: description:
- Defines the maintenance behavior for this instance. For standard instances, - Defines the maintenance behavior for this instance. For standard instances, the
the default behavior is MIGRATE. For preemptible instances, the default default behavior is MIGRATE. For preemptible instances, the default and only possible
and only possible behavior is TERMINATE. behavior is TERMINATE.
- For more information, see Setting Instance Scheduling Options. - For more information, see Setting Instance Scheduling Options.
returned: success returned: success
type: str type: str
preemptible: preemptible:
description: description:
- Defines whether the instance is preemptible. This can only be set during - Defines whether the instance is preemptible. This can only be set during instance
instance creation, it cannot be set or changed after the instance has creation, it cannot be set or changed after the instance has been created.
been created.
returned: success returned: success
type: bool type: bool
serviceAccounts: serviceAccounts:
description: description:
- A list of service accounts, with their specified scopes, authorized for this - A list of service accounts, with their specified scopes, authorized for this instance.
instance. Only one service account per VM instance is supported. Only one service account per VM instance is supported.
returned: success returned: success
type: complex type: complex
contains: contains:
@ -805,26 +791,25 @@ properties:
type: list type: list
tags: tags:
description: description:
- A list of tags to apply to this instance. Tags are used to identify valid - A list of tags to apply to this instance. Tags are used to identify valid sources
sources or targets for network firewalls and are specified by the client during or targets for network firewalls and are specified by the client during instance
instance creation. The tags can be later modified by the setTags method. Each creation. The tags can be later modified by the setTags method. Each tag within
tag within the list must comply with RFC1035. the list must comply with RFC1035.
returned: success returned: success
type: complex type: complex
contains: contains:
fingerprint: fingerprint:
description: description:
- Specifies a fingerprint for this request, which is essentially a hash - Specifies a fingerprint for this request, which is essentially a hash of the metadata's
of the metadata's contents and used for optimistic locking. contents and used for optimistic locking.
- The fingerprint is initially generated by Compute Engine and changes after - The fingerprint is initially generated by Compute Engine and changes after every
every request to modify or update metadata. You must always provide an request to modify or update metadata. You must always provide an up-to-date fingerprint
up-to-date fingerprint hash in order to update or change metadata. hash in order to update or change metadata.
returned: success returned: success
type: str type: str
items: items:
description: description:
- An array of tags. Each tag must be 1-63 characters long, and comply with - An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
RFC1035.
returned: success returned: success
type: list type: list
''' '''

267
plugins/modules/gcp_compute_instance_template_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -77,8 +77,7 @@ resources:
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. This identifier is defined by the - The unique identifier for the resource. This identifier is defined by the server.
server.
returned: success returned: success
type: int type: int
name: name:
@ -94,46 +93,45 @@ resources:
contains: contains:
canIpForward: canIpForward:
description: description:
- Enables instances created based on this template to send packets with - Enables instances created based on this template to send packets with source IP
source IP addresses other than their own and receive packets with destination addresses other than their own and receive packets with destination IP addresses
IP addresses other than their own. If these instances will be used as other than their own. If these instances will be used as an IP gateway or it will
an IP gateway or it will be set as the next-hop in a Route resource, specify be set as the next-hop in a Route resource, specify true. If unsure, leave this
true. If unsure, leave this set to false. set to false.
returned: success returned: success
type: bool type: bool
description: description:
description: description:
- An optional text description for the instances that are created from this - An optional text description for the instances that are created from this instance
instance template. template.
returned: success returned: success
type: str type: str
disks: disks:
description: description:
- An array of disks that are associated with the instances that are created - An array of disks that are associated with the instances that are created from this
from this template. template.
returned: success returned: success
type: complex type: complex
contains: contains:
autoDelete: autoDelete:
description: description:
- Specifies whether the disk will be auto-deleted when the instance - Specifies whether the disk will be auto-deleted when the instance is deleted (but
is deleted (but not when the disk is detached from the instance). not when the disk is detached from the instance).
- 'Tip: Disks should be set to autoDelete=true so that leftover disks - 'Tip: Disks should be set to autoDelete=true so that leftover disks are not left
are not left behind on machine deletion.' behind on machine deletion.'
returned: success returned: success
type: bool type: bool
boot: boot:
description: description:
- Indicates that this is a boot disk. The virtual machine will use the - Indicates that this is a boot disk. The virtual machine will use the first partition
first partition of the disk for its root filesystem. of the disk for its root filesystem.
returned: success returned: success
type: bool type: bool
deviceName: deviceName:
description: description:
- Specifies a unique device name of your choice that is reflected into - Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-*
the /dev/disk/by-id/google-* tree of a Linux operating system running tree of a Linux operating system running within the instance. This name can be used
within the instance. This name can be used to reference the device to reference the device for mounting, resizing, and so on, from within the instance.
for mounting, resizing, and so on, from within the instance.
returned: success returned: success
type: str type: str
diskEncryptionKey: diskEncryptionKey:
@ -144,42 +142,41 @@ resources:
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
in RFC 4648 base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
rsaEncryptedKey: rsaEncryptedKey:
description: description:
- Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption
encryption key to either encrypt or decrypt this resource. key to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
encryption key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
index: index:
description: description:
- Assigns a zero-based index to this disk, where 0 is reserved for the - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk.
boot disk. For example, if you have many disks attached to an instance, For example, if you have many disks attached to an instance, each disk would have
each disk would have a unique index number. If not specified, the a unique index number. If not specified, the server will choose an appropriate value.
server will choose an appropriate value.
returned: success returned: success
type: int type: int
initializeParams: initializeParams:
description: description:
- Specifies the parameters for a new disk that will be created alongside - Specifies the parameters for a new disk that will be created alongside the new instance.
the new instance. Use initialization parameters to create boot disks Use initialization parameters to create boot disks or local SSDs attached to the
or local SSDs attached to the new instance. new instance.
returned: success returned: success
type: complex type: complex
contains: contains:
diskName: diskName:
description: description:
- Specifies the disk name. If not specified, the default is to use - Specifies the disk name. If not specified, the default is to use the name of the
the name of the instance. instance.
returned: success returned: success
type: str type: str
diskSizeGb: diskSizeGb:
@ -189,96 +186,83 @@ resources:
type: int type: int
diskType: diskType:
description: description:
- Reference to a disk type. - Reference to a gcompute_disk_type resource.
- Specifies the disk type to use to create the instance. - Specifies the disk type to use to create the instance.
- If not specified, the default is pd-standard. - If not specified, the default is pd-standard.
returned: success returned: success
type: str type: str
sourceImage: sourceImage:
description: description:
- The source image to create this disk. When creating a new instance, - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage
one of initializeParams.sourceImage or disks.source is required. or disks.source is required. To create a disk with one of the public operating
To create a disk with one of the public operating system images, system images, specify the image by its family name.
specify the image by its family name.
returned: success returned: success
type: str type: str
sourceImageEncryptionKey: sourceImageEncryptionKey:
description: description:
- The customer-supplied encryption key of the source image. Required - The customer-supplied encryption key of the source image. Required if the source
if the source image is protected by a customer-supplied encryption image is protected by a customer-supplied encryption key.
key. - Instance templates do not store customer-supplied encryption keys, so you cannot
- Instance templates do not store customer-supplied encryption keys, create disks for instances in a managed instance group if the source images are
so you cannot create disks for instances in a managed instance encrypted with your own keys.
group if the source images are encrypted with your own keys.
returned: success returned: success
type: complex type: complex
contains: contains:
rawKey: rawKey:
description: description:
- Specifies a 256-bit customer-supplied encryption key, encoded - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
in RFC 4648 base64 to either encrypt or decrypt this resource. to either encrypt or decrypt this resource.
returned: success returned: success
type: str type: str
sha256: sha256:
description: description:
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
encryption key that protects this resource. that protects this resource.
returned: success returned: success
type: str type: str
interface: interface:
description: description:
- Specifies the disk interface to use for attaching this disk, which - Specifies the disk interface to use for attaching this disk, which is either SCSI
is either SCSI or NVME. The default is SCSI. or NVME. The default is SCSI.
- Persistent disks must always use SCSI and the request will fail if - Persistent disks must always use SCSI and the request will fail if you attempt to
you attempt to attach a persistent disk in any other format than SCSI. attach a persistent disk in any other format than SCSI.
returned: success returned: success
type: str type: str
mode: mode:
description: description:
- The mode in which to attach this disk, either READ_WRITE or READ_ONLY. - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified,
If not specified, the default is to attach the disk in READ_WRITE the default is to attach the disk in READ_WRITE mode.
mode.
returned: success returned: success
type: str type: str
source: source:
description: description:
- Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage
or disks.source is required. or disks.source is required.
- If desired, you can also attach existing non-root persistent disks - If desired, you can also attach existing non-root persistent disks using this property.
using this property. This field is only applicable for persistent This field is only applicable for persistent disks.
disks. - Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
- Note that for InstanceTemplate, specify the disk name, not the URL
for the disk.
returned: success returned: success
type: dict type: dict
type: type:
description: description:
- Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified,
specified, the default is PERSISTENT. the default is PERSISTENT.
returned: success returned: success
type: str type: str
machineType: machineType:
description: description:
- The machine type to use in the VM instance template. - Reference to a gcompute_machine_type resource.
returned: success
type: str
minCpuPlatform:
description:
- Specifies a minimum CPU platform for the VM instance. Applicable values
are the friendly names of CPU platforms .
returned: success returned: success
type: str type: str
metadata: metadata:
description: description:
- The metadata key/value pairs to assign to instances that are created from - The metadata key/value pairs to assign to instances that are created from this template.
this template. These pairs can consist of custom metadata or predefined These pairs can consist of custom metadata or predefined keys.
keys.
returned: success returned: success
type: dict type: dict
guestAccelerators: guestAccelerators:
description: description:
- List of the type and count of accelerator cards attached to the instance - List of the type and count of accelerator cards attached to the instance .
.
returned: success returned: success
type: complex type: complex
contains: contains:
@ -289,42 +273,40 @@ resources:
type: int type: int
acceleratorType: acceleratorType:
description: description:
- Full or partial URL of the accelerator type resource to expose to - Full or partial URL of the accelerator type resource to expose to this instance.
this instance.
returned: success returned: success
type: str type: str
networkInterfaces: networkInterfaces:
description: description:
- An array of configurations for this interface. This specifies how this - An array of configurations for this interface. This specifies how this interface
interface is configured to interact with other network services, such is configured to interact with other network services, such as connecting to the
as connecting to the internet. Only one network interface is supported internet. Only one network interface is supported per instance.
per instance.
returned: success returned: success
type: complex type: complex
contains: contains:
accessConfigs: accessConfigs:
description: description:
- An array of configurations for this interface. Currently, only one - An array of configurations for this interface. Currently, only one access config,
access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this
specified, then this instance will have no external internet access. instance will have no external internet access.
returned: success returned: success
type: complex type: complex
contains: contains:
name: name:
description: description:
- The name of this access configuration. The default and recommended - The name of this access configuration. The default and recommended name is External
name is External NAT but you can use any arbitrary string you NAT but you can use any arbitrary string you would like. For example, My external
would like. For example, My external IP or Network Access. IP or Network Access.
returned: success returned: success
type: str type: str
natIP: natIP:
description: description:
- Reference to an address. - Specifies the title of a gcompute_address.
- An external IP address associated with this instance. - An external IP address associated with this instance.
- Specify an unused static external IP address available to the - Specify an unused static external IP address available to the project or leave this
project or leave this field undefined to use an IP from a shared field undefined to use an IP from a shared ephemeral IP address pool. If you specify
ephemeral IP address pool. If you specify a static external IP a static external IP address, it must live in the same region as the zone of the
address, it must live in the same region as the zone of the instance. instance.
returned: success returned: success
type: dict type: dict
type: type:
@ -334,57 +316,53 @@ resources:
type: str type: str
aliasIpRanges: aliasIpRanges:
description: description:
- An array of alias IP ranges for this network interface. Can only be - An array of alias IP ranges for this network interface. Can only be specified for
specified for network interfaces on subnet-mode networks. network interfaces on subnet-mode networks.
returned: success returned: success
type: complex type: complex
contains: contains:
ipCidrRange: ipCidrRange:
description: description:
- The IP CIDR range represented by this alias IP range. - The IP CIDR range represented by this alias IP range.
- This IP CIDR range must belong to the specified subnetwork and - This IP CIDR range must belong to the specified subnetwork and cannot contain IP
cannot contain IP addresses reserved by system or used by other addresses reserved by system or used by other network interfaces. This range may
network interfaces. This range may be a single IP address (e.g. be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string
10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. (e.g. 10.1.2.0/24).
10.1.2.0/24).
returned: success returned: success
type: str type: str
subnetworkRangeName: subnetworkRangeName:
description: description:
- Optional subnetwork secondary range name specifying the secondary - Optional subnetwork secondary range name specifying the secondary range from which
range from which to allocate the IP CIDR range for this alias to allocate the IP CIDR range for this alias IP range. If left unspecified, the
IP range. If left unspecified, the primary range of the subnetwork primary range of the subnetwork will be used.
will be used.
returned: success returned: success
type: str type: str
name: name:
description: description:
- The name of the network interface, generated by the server. For network - The name of the network interface, generated by the server. For network devices,
devices, these are eth0, eth1, etc . these are eth0, eth1, etc .
returned: success returned: success
type: str type: str
network: network:
description: description:
- Specifies the title of an existing network. When creating an instance, - Specifies the title of an existing gcompute_network. When creating an instance,
if neither the network nor the subnetwork is specified, the default if neither the network nor the subnetwork is specified, the default network global/networks/default
network global/networks/default is used; if the network is not specified is used; if the network is not specified but the subnetwork is specified, the network
but the subnetwork is specified, the network is inferred. is inferred.
returned: success returned: success
type: dict type: dict
networkIP: networkIP:
description: description:
- An IPv4 internal network address to assign to the instance for this - An IPv4 internal network address to assign to the instance for this network interface.
network interface. If not specified by the user, an unused internal If not specified by the user, an unused internal IP is assigned by the system.
IP is assigned by the system.
returned: success returned: success
type: str type: str
subnetwork: subnetwork:
description: description:
- Reference to a VPC network. - Reference to a gcompute_subnetwork resource.
- If the network resource is in legacy mode, do not provide this property. - If the network resource is in legacy mode, do not provide this property. If the
If the network is in auto subnet mode, providing the subnetwork is network is in auto subnet mode, providing the subnetwork is optional. If the network
optional. If the network is in custom subnet mode, then this field is in custom subnet mode, then this field should be specified.
should be specified.
returned: success returned: success
type: dict type: dict
scheduling: scheduling:
@ -395,31 +373,30 @@ resources:
contains: contains:
automaticRestart: automaticRestart:
description: description:
- Specifies whether the instance should be automatically restarted if - Specifies whether the instance should be automatically restarted if it is terminated
it is terminated by Compute Engine (not terminated by a user). by Compute Engine (not terminated by a user).
- You can only set the automatic restart option for standard instances. - You can only set the automatic restart option for standard instances. Preemptible
Preemptible instances cannot be automatically restarted. instances cannot be automatically restarted.
returned: success returned: success
type: bool type: bool
onHostMaintenance: onHostMaintenance:
description: description:
- Defines the maintenance behavior for this instance. For standard instances, - Defines the maintenance behavior for this instance. For standard instances, the
the default behavior is MIGRATE. For preemptible instances, the default default behavior is MIGRATE. For preemptible instances, the default and only possible
and only possible behavior is TERMINATE. behavior is TERMINATE.
- For more information, see Setting Instance Scheduling Options. - For more information, see Setting Instance Scheduling Options.
returned: success returned: success
type: str type: str
preemptible: preemptible:
description: description:
- Defines whether the instance is preemptible. This can only be set - Defines whether the instance is preemptible. This can only be set during instance
during instance creation, it cannot be set or changed after the instance creation, it cannot be set or changed after the instance has been created.
has been created.
returned: success returned: success
type: bool type: bool
serviceAccounts: serviceAccounts:
description: description:
- A list of service accounts, with their specified scopes, authorized for - A list of service accounts, with their specified scopes, authorized for this instance.
this instance. Only one service account per VM instance is supported. Only one service account per VM instance is supported.
returned: success returned: success
type: complex type: complex
contains: contains:
@ -435,27 +412,25 @@ resources:
type: list type: list
tags: tags:
description: description:
- A list of tags to apply to this instance. Tags are used to identify valid - A list of tags to apply to this instance. Tags are used to identify valid sources
sources or targets for network firewalls and are specified by the client or targets for network firewalls and are specified by the client during instance
during instance creation. The tags can be later modified by the setTags creation. The tags can be later modified by the setTags method. Each tag within
method. Each tag within the list must comply with RFC1035. the list must comply with RFC1035.
returned: success returned: success
type: complex type: complex
contains: contains:
fingerprint: fingerprint:
description: description:
- Specifies a fingerprint for this request, which is essentially a hash - Specifies a fingerprint for this request, which is essentially a hash of the metadata's
of the metadata's contents and used for optimistic locking. contents and used for optimistic locking.
- The fingerprint is initially generated by Compute Engine and changes - The fingerprint is initially generated by Compute Engine and changes after every
after every request to modify or update metadata. You must always request to modify or update metadata. You must always provide an up-to-date fingerprint
provide an up-to-date fingerprint hash in order to update or change hash in order to update or change metadata.
metadata.
returned: success returned: success
type: str type: str
items: items:
description: description:
- An array of tags. Each tag must be 1-63 characters long, and comply - An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
with RFC1035.
returned: success returned: success
type: list type: list
''' '''

55
plugins/modules/gcp_compute_network.py
View file

@ -118,14 +118,15 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
description: description:
description: description:
- An optional description of this resource. The resource must be recreated to modify - An optional description of this resource. Provide this property when you create
this field. the resource.
returned: success returned: success
type: str type: str
gateway_ipv4: gateway_ipv4:
description: description:
- The gateway address for default routing out of the network. This value is selected - A gateway address for default routing to other networks. This value is read only
by GCP. and is selected by the Google Compute Engine, typically as the first usable address
in the IPv4Range.
returned: success returned: success
type: str type: str
id: id:
@ -135,23 +136,19 @@ id:
type: int type: int
ipv4_range: ipv4_range:
description: description:
- If this field is specified, a deprecated legacy network is created. - 'The range of internal addresses that are legal on this network. This range is a
- You will no longer be able to create a legacy network on Feb 1, 2020. CIDR specification, for example: 192.168.0.0/16. Provided by the client when the
- See the [legacy network docs](U(https://cloud.google.com/vpc/docs/legacy)) for network is created.'
more details.
- The range of internal addresses that are legal on this legacy network.
- 'This range is a CIDR specification, for example: `192.168.0.0/16`.'
- The resource must be recreated to modify this field.
returned: success returned: success
type: str type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
subnetworks: subnetworks:
@ -161,10 +158,10 @@ subnetworks:
type: list type: list
autoCreateSubnetworks: autoCreateSubnetworks:
description: description:
- When set to `true`, the network is created in "auto subnet mode" and it will create - When set to true, the network is created in "auto subnet mode". When set to false,
a subnet for each region automatically across the `10.128.0.0/9` address range. the network is in "custom subnet mode".
- When set to `false`, the network is created in "custom subnet mode" so the user - In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9
can explicitly connect subnetwork resources. and it automatically creates one subnetwork per region.
returned: success returned: success
type: bool type: bool
creationTimestamp: creationTimestamp:
@ -172,22 +169,6 @@ creationTimestamp:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
routingConfig:
description:
- The network-level routing configuration for this network. Used by Cloud Router
to determine what type of network-wide routing behavior to enforce.
returned: success
type: complex
contains:
routingMode:
description:
- The network-wide routing mode to use. If set to `REGIONAL`, this network's
cloud routers will only advertise routes with subnetworks of this network
in the same region as the router. If set to `GLOBAL`, this network's cloud
routers will advertise routes with all subnetworks of this network, across
regions.
returned: success
type: str
''' '''
################################################################################ ################################################################################

60
plugins/modules/gcp_compute_network_facts.py
View file

@ -59,21 +59,22 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
description: description:
description: description:
- An optional description of this resource. The resource must be recreated to - An optional description of this resource. Provide this property when you create
modify this field. the resource.
returned: success returned: success
type: str type: str
gateway_ipv4: gateway_ipv4:
description: description:
- The gateway address for default routing out of the network. This value is - A gateway address for default routing to other networks. This value is read only
selected by GCP. and is selected by the Google Compute Engine, typically as the first usable address
in the IPv4Range.
returned: success returned: success
type: str type: str
id: id:
@ -83,23 +84,19 @@ resources:
type: int type: int
ipv4_range: ipv4_range:
description: description:
- If this field is specified, a deprecated legacy network is created. - 'The range of internal addresses that are legal on this network. This range is a
- You will no longer be able to create a legacy network on Feb 1, 2020. CIDR specification, for example: 192.168.0.0/16. Provided by the client when the
- See the [legacy network docs](U(https://cloud.google.com/vpc/docs/legacy)) network is created.'
for more details.
- The range of internal addresses that are legal on this legacy network.
- 'This range is a CIDR specification, for example: `192.168.0.0/16`.'
- The resource must be recreated to modify this field.
returned: success returned: success
type: str type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
subnetworks: subnetworks:
@ -109,11 +106,10 @@ resources:
type: list type: list
autoCreateSubnetworks: autoCreateSubnetworks:
description: description:
- When set to `true`, the network is created in "auto subnet mode" and it will - When set to true, the network is created in "auto subnet mode". When set to false,
create a subnet for each region automatically across the `10.128.0.0/9` address the network is in "custom subnet mode".
range. - In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9
- When set to `false`, the network is created in "custom subnet mode" so the and it automatically creates one subnetwork per region.
user can explicitly connect subnetwork resources.
returned: success returned: success
type: bool type: bool
creationTimestamp: creationTimestamp:
@ -121,22 +117,6 @@ resources:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
routingConfig:
description:
- The network-level routing configuration for this network. Used by Cloud Router
to determine what type of network-wide routing behavior to enforce.
returned: success
type: complex
contains:
routingMode:
description:
- The network-wide routing mode to use. If set to `REGIONAL`, this network's
cloud routers will only advertise routes with subnetworks of this network
in the same region as the router. If set to `GLOBAL`, this network's cloud
routers will advertise routes with all subnetworks of this network, across
regions.
returned: success
type: str
''' '''
################################################################################ ################################################################################

20
plugins/modules/gcp_compute_route.py
View file

@ -182,12 +182,12 @@ description:
type: str type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
@ -212,8 +212,8 @@ tags:
nextHopGateway: nextHopGateway:
description: description:
- URL to a gateway that should handle matching packets. - URL to a gateway that should handle matching packets.
- 'Currently, you can only specify the internet gateway, using a full or partial - 'Currently, you can only specify the internet gateway, using a full or partial valid
valid URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway) URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
* projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
.' .'
returned: success returned: success
@ -225,7 +225,7 @@ nextHopInstance:
instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
.' .'
returned: success returned: success
type: dict type: str
nextHopIp: nextHopIp:
description: description:
- Network IP address of an instance that should handle matching packets. - Network IP address of an instance that should handle matching packets.
@ -235,7 +235,7 @@ nextHopVpnTunnel:
description: description:
- URL to a VpnTunnel that should handle matching packets. - URL to a VpnTunnel that should handle matching packets.
returned: success returned: success
type: dict type: str
nextHopNetwork: nextHopNetwork:
description: description:
- URL to a Network that should handle matching packets. - URL to a Network that should handle matching packets.

28
plugins/modules/gcp_compute_route_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -78,12 +78,12 @@ resources:
type: str type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
@ -93,8 +93,8 @@ resources:
type: dict type: dict
priority: priority:
description: description:
- The priority of this route. Priority is used to break ties in cases where - The priority of this route. Priority is used to break ties in cases where there
there is more than one matching route of equal prefix length. is more than one matching route of equal prefix length.
- In the case of two routes with equal prefix length, the one with the lowest-numbered - In the case of two routes with equal prefix length, the one with the lowest-numbered
priority value wins. priority value wins.
- Default value is 1000. Valid range is 0 through 65535. - Default value is 1000. Valid range is 0 through 65535.
@ -108,8 +108,8 @@ resources:
nextHopGateway: nextHopGateway:
description: description:
- URL to a gateway that should handle matching packets. - URL to a gateway that should handle matching packets.
- 'Currently, you can only specify the internet gateway, using a full or partial - 'Currently, you can only specify the internet gateway, using a full or partial valid
valid URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway) URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
* projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
.' .'
returned: success returned: success
@ -121,7 +121,7 @@ resources:
instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
.' .'
returned: success returned: success
type: dict type: str
nextHopIp: nextHopIp:
description: description:
- Network IP address of an instance that should handle matching packets. - Network IP address of an instance that should handle matching packets.
@ -131,7 +131,7 @@ resources:
description: description:
- URL to a VpnTunnel that should handle matching packets. - URL to a VpnTunnel that should handle matching packets.
returned: success returned: success
type: dict type: str
nextHopNetwork: nextHopNetwork:
description: description:
- URL to a Network that should handle matching packets. - URL to a Network that should handle matching packets.

25
plugins/modules/gcp_compute_router.py
View file

@ -191,9 +191,9 @@ bgp:
contains: contains:
asn: asn:
description: description:
- Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, - Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either
either 16-bit or 32-bit. The value will be fixed for this router resource. 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels
All VPN tunnels that link to this router will have the same local ASN. that link to this router will have the same local ASN.
returned: success returned: success
type: int type: int
advertiseMode: advertiseMode:
@ -205,18 +205,17 @@ bgp:
advertisedGroups: advertisedGroups:
description: description:
- User-specified list of prefix groups to advertise in custom mode. - User-specified list of prefix groups to advertise in custom mode.
- This field can only be populated if advertiseMode is CUSTOM and is advertised - This field can only be populated if advertiseMode is CUSTOM and is advertised to
to all peers of the router. These groups will be advertised in addition to all peers of the router. These groups will be advertised in addition to any specified
any specified prefixes. Leave this field blank to advertise no custom groups. prefixes. Leave this field blank to advertise no custom groups.
- 'This enum field has the one valid value: ALL_SUBNETS .' - 'This enum field has the one valid value: ALL_SUBNETS .'
returned: success returned: success
type: list type: list
advertisedIpRanges: advertisedIpRanges:
description: description:
- User-specified list of individual IP ranges to advertise in custom mode. This - User-specified list of individual IP ranges to advertise in custom mode. This field
field can only be populated if advertiseMode is CUSTOM and is advertised to can only be populated if advertiseMode is CUSTOM and is advertised to all peers
all peers of the router. These IP ranges will be advertised in addition to of the router. These IP ranges will be advertised in addition to any specified groups.
any specified groups.
- Leave this field blank to advertise no custom IP ranges. - Leave this field blank to advertise no custom IP ranges.
returned: success returned: success
type: complex type: complex
@ -231,6 +230,12 @@ bgp:
- User-specified description for the IP range. - User-specified description for the IP range.
returned: success returned: success
type: str type: str
region:
description:
description:
- User-specified description for the IP range.
returned: success
type: str
region: region:
description: description:
- Region where the router resides. - Region where the router resides.

34
plugins/modules/gcp_compute_router_facts.py
View file

@ -64,8 +64,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -81,11 +81,11 @@ resources:
type: str type: str
name: name:
description: description:
- Name of the resource. The name must be 1-63 characters long, and comply with - Name of the resource. The name must be 1-63 characters long, and comply with RFC1035.
RFC1035. Specifically, the name must be 1-63 characters long and match the Specifically, the name must be 1-63 characters long and match the regular expression
regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase
must be a lowercase letter, and all following characters must be a dash, lowercase letter, and all following characters must be a dash, lowercase letter, or digit,
letter, or digit, except the last character, which cannot be a dash. except the last character, which cannot be a dash.
returned: success returned: success
type: str type: str
description: description:
@ -106,9 +106,9 @@ resources:
contains: contains:
asn: asn:
description: description:
- Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, - Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either
either 16-bit or 32-bit. The value will be fixed for this router resource. 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels
All VPN tunnels that link to this router will have the same local ASN. that link to this router will have the same local ASN.
returned: success returned: success
type: int type: int
advertiseMode: advertiseMode:
@ -120,19 +120,17 @@ resources:
advertisedGroups: advertisedGroups:
description: description:
- User-specified list of prefix groups to advertise in custom mode. - User-specified list of prefix groups to advertise in custom mode.
- This field can only be populated if advertiseMode is CUSTOM and is advertised - This field can only be populated if advertiseMode is CUSTOM and is advertised to
to all peers of the router. These groups will be advertised in addition all peers of the router. These groups will be advertised in addition to any specified
to any specified prefixes. Leave this field blank to advertise no custom prefixes. Leave this field blank to advertise no custom groups.
groups.
- 'This enum field has the one valid value: ALL_SUBNETS .' - 'This enum field has the one valid value: ALL_SUBNETS .'
returned: success returned: success
type: list type: list
advertisedIpRanges: advertisedIpRanges:
description: description:
- User-specified list of individual IP ranges to advertise in custom mode. - User-specified list of individual IP ranges to advertise in custom mode. This field
This field can only be populated if advertiseMode is CUSTOM and is advertised can only be populated if advertiseMode is CUSTOM and is advertised to all peers
to all peers of the router. These IP ranges will be advertised in addition of the router. These IP ranges will be advertised in addition to any specified groups.
to any specified groups.
- Leave this field blank to advertise no custom IP ranges. - Leave this field blank to advertise no custom IP ranges.
returned: success returned: success
type: complex type: complex

4
plugins/modules/gcp_compute_ssl_certificate.py
View file

@ -119,7 +119,7 @@ RETURN = '''
- The chain must include at least one intermediate cert. - The chain must include at least one intermediate cert.
returned: success returned: success
type: str type: str
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -144,7 +144,7 @@ RETURN = '''
be a dash. be a dash.
returned: success returned: success
type: str type: str
private_key: privateKey:
description: description:
- The write-only private key in PEM format. - The write-only private key in PEM format.
returned: success returned: success

4
plugins/modules/gcp_compute_ssl_certificate_facts.py
View file

@ -71,7 +71,7 @@ items:
- The chain must include at least one intermediate cert. - The chain must include at least one intermediate cert.
returned: success returned: success
type: str type: str
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -96,7 +96,7 @@ items:
be a dash. be a dash.
returned: success returned: success
type: str type: str
private_key: privateKey:
description: description:
- The write-only private key in PEM format. - The write-only private key in PEM format.
returned: success returned: success

21
plugins/modules/gcp_compute_ssl_policy.py
View file

@ -128,27 +128,26 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
profile: profile:
description: description:
- Profile specifies the set of SSL features that can be used by the load balancer - Profile specifies the set of SSL features that can be used by the load balancer
when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, `RESTRICTED`,
`RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable must be specified
must be specified in the `customFeatures` field. in the `customFeatures` field.
returned: success returned: success
type: str type: str
minTlsVersion: minTlsVersion:
description: description:
- The minimum version of SSL protocol that can be used by the clients to establish - The minimum version of SSL protocol that can be used by the clients to establish
a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, `TLS_1_2`.
`TLS_1_2`.
returned: success returned: success
type: str type: str
enabledFeatures: enabledFeatures:

39
plugins/modules/gcp_compute_ssl_policy_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -81,27 +81,26 @@ resources:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
profile: profile:
description: description:
- Profile specifies the set of SSL features that can be used by the load balancer - Profile specifies the set of SSL features that can be used by the load balancer
when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, `RESTRICTED`,
`RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable must be specified
must be specified in the `customFeatures` field. in the `customFeatures` field.
returned: success returned: success
type: str type: str
minTlsVersion: minTlsVersion:
description: description:
- The minimum version of SSL protocol that can be used by the clients to establish - The minimum version of SSL protocol that can be used by the clients to establish
a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, `TLS_1_2`.
`TLS_1_2`.
returned: success returned: success
type: str type: str
enabledFeatures: enabledFeatures:
@ -111,21 +110,21 @@ resources:
type: list type: list
customFeatures: customFeatures:
description: description:
- A list of features enabled when the selected profile is CUSTOM. The method - A list of features enabled when the selected profile is CUSTOM. The method returns
returns the set of features that can be specified in this list. This field the set of features that can be specified in this list. This field must be empty
must be empty if the profile is not CUSTOM. if the profile is not CUSTOM.
returned: success returned: success
type: list type: list
fingerprint: fingerprint:
description: description:
- Fingerprint of this resource. A hash of the contents stored in this object. - Fingerprint of this resource. A hash of the contents stored in this object. This
This field is used in optimistic locking. field is used in optimistic locking.
returned: success returned: success
type: str type: str
warnings: warnings:
description: description:
- If potential misconfigurations are detected for this SSL policy, this field - If potential misconfigurations are detected for this SSL policy, this field will
will be populated with warning messages. be populated with warning messages.
returned: success returned: success
type: complex type: complex
contains: contains:

58
plugins/modules/gcp_compute_subnetwork.py
View file

@ -175,8 +175,8 @@ description:
type: str type: str
gatewayAddress: gatewayAddress:
description: description:
- The gateway address for default routes to reach destination addresses outside - The gateway address for default routes to reach destination addresses outside this
this subnetwork. subnetwork.
returned: success returned: success
type: str type: str
id: id:
@ -187,19 +187,19 @@ id:
ipCidrRange: ipCidrRange:
description: description:
- The range of internal addresses that are owned by this subnetwork. - The range of internal addresses that are owned by this subnetwork.
- Provide this property when you create the subnetwork. For example, 10.0.0.0/8 - Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or
or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only
Only IPv4 is supported. IPv4 is supported.
returned: success returned: success
type: str type: str
name: name:
description: description:
- The name of the resource, provided by the client when initially creating the resource. - The name of the resource, provided by the client when initially creating the resource.
The name must be 1-63 characters long, and comply with RFC1035. Specifically, The name must be 1-63 characters long, and comply with RFC1035. Specifically, the
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
@ -208,44 +208,10 @@ network:
- Only networks that are in the distributed mode can have subnetworks. - Only networks that are in the distributed mode can have subnetworks.
returned: success returned: success
type: dict type: dict
enableFlowLogs:
description:
- Whether to enable flow logging for this subnetwork.
returned: success
type: bool
fingerprint:
description:
- Fingerprint of this resource. This field is used internally during updates of
this resource.
returned: success
type: str
secondaryIpRanges:
description:
- An array of configurations for secondary IP ranges for VM instances contained
in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange
of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
returned: success
type: complex
contains:
rangeName:
description:
- The name associated with this subnetwork secondary range, used when adding
an alias IP range to a VM instance. The name must be 1-63 characters long,
and comply with RFC1035. The name must be unique within the subnetwork.
returned: success
type: str
ipCidrRange:
description:
- The range of IP addresses belonging to this subnetwork secondary range. Provide
this property when you create the subnetwork.
- Ranges must be unique and non-overlapping with all primary and secondary IP
ranges within a network. Only IPv4 is supported.
returned: success
type: str
privateIpGoogleAccess: privateIpGoogleAccess:
description: description:
- When enabled, VMs in this subnetwork without external IP addresses can access - Whether the VMs in this subnet can access Google services without assigned external
Google APIs and services by using Private Google Access. IP addresses.
returned: success returned: success
type: bool type: bool
region: region:

65
plugins/modules/gcp_compute_subnetwork_facts.py
View file

@ -64,8 +64,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -82,8 +82,8 @@ resources:
type: str type: str
gatewayAddress: gatewayAddress:
description: description:
- The gateway address for default routes to reach destination addresses outside - The gateway address for default routes to reach destination addresses outside this
this subnetwork. subnetwork.
returned: success returned: success
type: str type: str
id: id:
@ -94,19 +94,19 @@ resources:
ipCidrRange: ipCidrRange:
description: description:
- The range of internal addresses that are owned by this subnetwork. - The range of internal addresses that are owned by this subnetwork.
- Provide this property when you create the subnetwork. For example, 10.0.0.0/8 - Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or
or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only
Only IPv4 is supported. IPv4 is supported.
returned: success returned: success
type: str type: str
name: name:
description: description:
- The name of the resource, provided by the client when initially creating the - The name of the resource, provided by the client when initially creating the resource.
resource. The name must be 1-63 characters long, and comply with RFC1035. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the
Specifically, the name must be 1-63 characters long and match the regular name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must which means the first character must be a lowercase letter, and all following characters
be a lowercase letter, and all following characters must be a dash, lowercase must be a dash, lowercase letter, or digit, except the last character, which cannot
letter, or digit, except the last character, which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
@ -115,45 +115,10 @@ resources:
- Only networks that are in the distributed mode can have subnetworks. - Only networks that are in the distributed mode can have subnetworks.
returned: success returned: success
type: dict type: dict
enableFlowLogs:
description:
- Whether to enable flow logging for this subnetwork.
returned: success
type: bool
fingerprint:
description:
- Fingerprint of this resource. This field is used internally during updates
of this resource.
returned: success
type: str
secondaryIpRanges:
description:
- An array of configurations for secondary IP ranges for VM instances contained
in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange
of the subnetwork. The alias IPs may belong to either primary or secondary
ranges.
returned: success
type: complex
contains:
rangeName:
description:
- The name associated with this subnetwork secondary range, used when adding
an alias IP range to a VM instance. The name must be 1-63 characters long,
and comply with RFC1035. The name must be unique within the subnetwork.
returned: success
type: str
ipCidrRange:
description:
- The range of IP addresses belonging to this subnetwork secondary range.
Provide this property when you create the subnetwork.
- Ranges must be unique and non-overlapping with all primary and secondary
IP ranges within a network. Only IPv4 is supported.
returned: success
type: str
privateIpGoogleAccess: privateIpGoogleAccess:
description: description:
- When enabled, VMs in this subnetwork without external IP addresses can access - Whether the VMs in this subnet can access Google services without assigned external
Google APIs and services by using Private Google Access. IP addresses.
returned: success returned: success
type: bool type: bool
region: region:

12
plugins/modules/gcp_compute_target_http_proxy.py
View file

@ -153,12 +153,12 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
urlMap: urlMap:

19
plugins/modules/gcp_compute_target_http_proxy_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -81,18 +81,17 @@ resources:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
urlMap: urlMap:
description: description:
- A reference to the UrlMap resource that defines the mapping from URL to the - A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
BackendService.
returned: success returned: success
type: dict type: dict
''' '''

29
plugins/modules/gcp_compute_target_https_proxy.py
View file

@ -208,21 +208,21 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
quicOverride: quicOverride:
description: description:
- Specifies the QUIC override policy for this resource. This determines whether - Specifies the QUIC override policy for this resource. This determines whether the
the load balancer will attempt to negotiate QUIC with clients or not. Can specify load balancer will attempt to negotiate QUIC with clients or not. Can specify one
one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with no
no user overrides, which is equivalent to DISABLE. Not specifying this field is user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent
equivalent to specifying NONE. to specifying NONE.
returned: success returned: success
type: str type: str
sslCertificates: sslCertificates:
@ -231,13 +231,6 @@ sslCertificates:
users and the load balancer. Currently, exactly one SSL certificate must be specified. users and the load balancer. Currently, exactly one SSL certificate must be specified.
returned: success returned: success
type: list type: list
sslPolicy:
description:
- A reference to the SslPolicy resource that will be associated with the TargetHttpsProxy
resource. If not set, the TargetHttpsProxy resource will not have any SSL policy
configured.
returned: success
type: dict
urlMap: urlMap:
description: description:
- A reference to the UrlMap resource that defines the mapping from URL to the BackendService. - A reference to the UrlMap resource that defines the mapping from URL to the BackendService.

41
plugins/modules/gcp_compute_target_https_proxy_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -81,41 +81,32 @@ resources:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
quicOverride: quicOverride:
description: description:
- Specifies the QUIC override policy for this resource. This determines whether - Specifies the QUIC override policy for this resource. This determines whether the
the load balancer will attempt to negotiate QUIC with clients or not. Can load balancer will attempt to negotiate QUIC with clients or not. Can specify one
specify one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with no
policy with no user overrides, which is equivalent to DISABLE. Not specifying user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent
this field is equivalent to specifying NONE. to specifying NONE.
returned: success returned: success
type: str type: str
sslCertificates: sslCertificates:
description: description:
- A list of SslCertificate resources that are used to authenticate connections - A list of SslCertificate resources that are used to authenticate connections between
between users and the load balancer. Currently, exactly one SSL certificate users and the load balancer. Currently, exactly one SSL certificate must be specified.
must be specified.
returned: success returned: success
type: list type: list
sslPolicy:
description:
- A reference to the SslPolicy resource that will be associated with the TargetHttpsProxy
resource. If not set, the TargetHttpsProxy resource will not have any SSL
policy configured.
returned: success
type: dict
urlMap: urlMap:
description: description:
- A reference to the UrlMap resource that defines the mapping from URL to the - A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
BackendService.
returned: success returned: success
type: dict type: dict
''' '''

30
plugins/modules/gcp_compute_target_pool.py
View file

@ -152,8 +152,8 @@ backupPool:
between [0, 1]. between [0, 1].
- 'backupPool and failoverRatio together define the fallback behavior of the primary - 'backupPool and failoverRatio together define the fallback behavior of the primary
target pool: if the ratio of the healthy instances in the primary pool is at or target pool: if the ratio of the healthy instances in the primary pool is at or
below failoverRatio, traffic arriving at the load-balanced IP will be directed below failoverRatio, traffic arriving at the load-balanced IP will be directed to
to the backup pool.' the backup pool.'
- In case where failoverRatio and backupPool are not set, or all the instances in - In case where failoverRatio and backupPool are not set, or all the instances in
the backup pool are unhealthy, the traffic will be directed back to the primary the backup pool are unhealthy, the traffic will be directed back to the primary
pool in the "force" mode, where traffic will be spread to the healthy instances pool in the "force" mode, where traffic will be spread to the healthy instances
@ -177,10 +177,10 @@ failoverRatio:
The value of the field must be in [0, 1]. The value of the field must be in [0, 1].
- 'If set, backupPool must also be set. They together define the fallback behavior - 'If set, backupPool must also be set. They together define the fallback behavior
of the primary target pool: if the ratio of the healthy instances in the primary of the primary target pool: if the ratio of the healthy instances in the primary
pool is at or below this number, traffic arriving at the load-balanced IP will pool is at or below this number, traffic arriving at the load-balanced IP will be
be directed to the backup pool.' directed to the backup pool.'
- In case where failoverRatio is not set or all the instances in the backup pool - In case where failoverRatio is not set or all the instances in the backup pool are
are unhealthy, the traffic will be directed back to the primary pool in the "force" unhealthy, the traffic will be directed back to the primary pool in the "force"
mode, where traffic will be spread to the healthy instances with the best effort, mode, where traffic will be spread to the healthy instances with the best effort,
or to all instances when no instance is healthy. or to all instances when no instance is healthy.
returned: success returned: success
@ -188,9 +188,9 @@ failoverRatio:
healthCheck: healthCheck:
description: description:
- A reference to a HttpHealthCheck resource. - A reference to a HttpHealthCheck resource.
- A member instance in this pool is considered healthy if and only if the health - A member instance in this pool is considered healthy if and only if the health checks
checks pass. If not specified it means all member instances will be considered pass. If not specified it means all member instances will be considered healthy
healthy at all times. at all times.
returned: success returned: success
type: dict type: dict
id: id:
@ -206,12 +206,12 @@ instances:
type: list type: list
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
sessionAffinity: sessionAffinity:

66
plugins/modules/gcp_compute_target_pool_facts.py
View file

@ -64,24 +64,24 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
backupPool: backupPool:
description: description:
- This field is applicable only when the containing target pool is serving a - This field is applicable only when the containing target pool is serving a forwarding
forwarding rule as the primary pool, and its failoverRatio field is properly rule as the primary pool, and its failoverRatio field is properly set to a value
set to a value between [0, 1]. between [0, 1].
- 'backupPool and failoverRatio together define the fallback behavior of the - 'backupPool and failoverRatio together define the fallback behavior of the primary
primary target pool: if the ratio of the healthy instances in the primary target pool: if the ratio of the healthy instances in the primary pool is at or
pool is at or below failoverRatio, traffic arriving at the load-balanced IP below failoverRatio, traffic arriving at the load-balanced IP will be directed to
will be directed to the backup pool.' the backup pool.'
- In case where failoverRatio and backupPool are not set, or all the instances - In case where failoverRatio and backupPool are not set, or all the instances in
in the backup pool are unhealthy, the traffic will be directed back to the the backup pool are unhealthy, the traffic will be directed back to the primary
primary pool in the "force" mode, where traffic will be spread to the healthy pool in the "force" mode, where traffic will be spread to the healthy instances
instances with the best effort, or to all instances when no instance is healthy. with the best effort, or to all instances when no instance is healthy.
returned: success returned: success
type: dict type: dict
creationTimestamp: creationTimestamp:
@ -96,25 +96,25 @@ resources:
type: str type: str
failoverRatio: failoverRatio:
description: description:
- This field is applicable only when the containing target pool is serving a - This field is applicable only when the containing target pool is serving a forwarding
forwarding rule as the primary pool (i.e., not as a backup pool to some other rule as the primary pool (i.e., not as a backup pool to some other target pool).
target pool). The value of the field must be in [0, 1]. The value of the field must be in [0, 1].
- 'If set, backupPool must also be set. They together define the fallback behavior - 'If set, backupPool must also be set. They together define the fallback behavior
of the primary target pool: if the ratio of the healthy instances in the primary of the primary target pool: if the ratio of the healthy instances in the primary
pool is at or below this number, traffic arriving at the load-balanced IP pool is at or below this number, traffic arriving at the load-balanced IP will be
will be directed to the backup pool.' directed to the backup pool.'
- In case where failoverRatio is not set or all the instances in the backup - In case where failoverRatio is not set or all the instances in the backup pool are
pool are unhealthy, the traffic will be directed back to the primary pool unhealthy, the traffic will be directed back to the primary pool in the "force"
in the "force" mode, where traffic will be spread to the healthy instances mode, where traffic will be spread to the healthy instances with the best effort,
with the best effort, or to all instances when no instance is healthy. or to all instances when no instance is healthy.
returned: success returned: success
type: str type: str
healthCheck: healthCheck:
description: description:
- A reference to a HttpHealthCheck resource. - A reference to a HttpHealthCheck resource.
- A member instance in this pool is considered healthy if and only if the health - A member instance in this pool is considered healthy if and only if the health checks
checks pass. If not specified it means all member instances will be considered pass. If not specified it means all member instances will be considered healthy
healthy at all times. at all times.
returned: success returned: success
type: dict type: dict
id: id:
@ -130,18 +130,18 @@ resources:
type: list type: list
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
sessionAffinity: sessionAffinity:
description: description:
- 'Session affinity option. Must be one of these values: - NONE: Connections - 'Session affinity option. Must be one of these values: - NONE: Connections from
from the same client IP may go to any instance in the pool.' the same client IP may go to any instance in the pool.'
- "- CLIENT_IP: Connections from the same client IP will go to the same instance - "- CLIENT_IP: Connections from the same client IP will go to the same instance
in the pool while that instance remains healthy." in the pool while that instance remains healthy."
- "- CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol - "- CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol

19
plugins/modules/gcp_compute_target_ssl_proxy.py
View file

@ -196,12 +196,12 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:
@ -221,13 +221,6 @@ sslCertificates:
users and the load balancer. Currently, exactly one SSL certificate must be specified. users and the load balancer. Currently, exactly one SSL certificate must be specified.
returned: success returned: success
type: list type: list
sslPolicy:
description:
- A reference to the SslPolicy resource that will be associated with the TargetSslProxy
resource. If not set, the TargetSslProxy resource will not have any SSL policy
configured.
returned: success
type: dict
''' '''
################################################################################ ################################################################################

28
plugins/modules/gcp_compute_target_ssl_proxy_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -81,12 +81,12 @@ resources:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:
@ -102,18 +102,10 @@ resources:
type: dict type: dict
sslCertificates: sslCertificates:
description: description:
- A list of SslCertificate resources that are used to authenticate connections - A list of SslCertificate resources that are used to authenticate connections between
between users and the load balancer. Currently, exactly one SSL certificate users and the load balancer. Currently, exactly one SSL certificate must be specified.
must be specified.
returned: success returned: success
type: list type: list
sslPolicy:
description:
- A reference to the SslPolicy resource that will be associated with the TargetSslProxy
resource. If not set, the TargetSslProxy resource will not have any SSL policy
configured.
returned: success
type: dict
''' '''
################################################################################ ################################################################################

12
plugins/modules/gcp_compute_target_tcp_proxy.py
View file

@ -155,12 +155,12 @@ id:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:

16
plugins/modules/gcp_compute_target_tcp_proxy_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -81,12 +81,12 @@ resources:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
proxyHeader: proxyHeader:

17
plugins/modules/gcp_compute_target_vpn_gateway.py
View file

@ -123,12 +123,12 @@ description:
type: str type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
id: id:
@ -143,13 +143,12 @@ network:
type: dict type: dict
tunnels: tunnels:
description: description:
- A list of references to VpnTunnel resources associated with this VPN gateway. - A list of references to VpnTunnel resources associated to this VPN gateway.
returned: success returned: success
type: list type: list
forwardingRules: forwardingRules:
description: description:
- A list of references to the ForwardingRule resources associated with this VPN - A list of references to the ForwardingRule resources associated to this VPN gateway.
gateway.
returned: success returned: success
type: list type: list
region: region:

21
plugins/modules/gcp_compute_target_vpn_gateway_facts.py
View file

@ -64,8 +64,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -81,12 +81,12 @@ resources:
type: str type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
id: id:
@ -101,13 +101,12 @@ resources:
type: dict type: dict
tunnels: tunnels:
description: description:
- A list of references to VpnTunnel resources associated with this VPN gateway. - A list of references to VpnTunnel resources associated to this VPN gateway.
returned: success returned: success
type: list type: list
forwardingRules: forwardingRules:
description: description:
- A list of references to the ForwardingRule resources associated with this - A list of references to the ForwardingRule resources associated to this VPN gateway.
VPN gateway.
returned: success returned: success
type: list type: list
region: region:

48
plugins/modules/gcp_compute_url_map.py
View file

@ -240,21 +240,21 @@ hostRules:
contains: contains:
description: description:
description: description:
- An optional description of this HostRule. Provide this property when you create - An optional description of this resource. Provide this property when you create
the resource. the resource.
returned: success returned: success
type: str type: str
hosts: hosts:
description: description:
- The list of host patterns to match. They must be valid hostnames, except * - The list of host patterns to match. They must be valid hostnames, except * will
will match any string of ([a-z0-9-.]*). In that case, * must be the first match any string of ([a-z0-9-.]*). In that case, * must be the first character and
character and must be followed in the pattern by either - or . must be followed in the pattern by either - or .
returned: success returned: success
type: list type: list
pathMatcher: pathMatcher:
description: description:
- The name of the PathMatcher to use to match the path portion of the URL if - The name of the PathMatcher to use to match the path portion of the URL if the hostRule
the hostRule matches the URL's host portion. matches the URL's host portion.
returned: success returned: success
type: str type: str
id: id:
@ -262,20 +262,14 @@ id:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
fingerprint:
description:
- Fingerprint of this resource. This field is used internally during updates of
this resource.
returned: success
type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
pathMatchers: pathMatchers:
@ -286,8 +280,8 @@ pathMatchers:
contains: contains:
defaultService: defaultService:
description: description:
- A reference to a BackendService resource. This will be used if none of the - A reference to a BackendService resource. This will be used if none of the pathRules
pathRules defined by this PathMatcher is matched by the URL's path portion. defined by this PathMatcher is matched by the URL's path portion.
returned: success returned: success
type: dict type: dict
description: description:
@ -308,10 +302,9 @@ pathMatchers:
contains: contains:
paths: paths:
description: description:
- 'The list of path patterns to match. Each must start with / and the only - 'The list of path patterns to match. Each must start with / and the only place a
place a * is allowed is at the end following a /. The string fed to the * is allowed is at the end following a /. The string fed to the path matcher does
path matcher does not include any text after the first ? or #, and those not include any text after the first ? or #, and those chars are not allowed here.'
chars are not allowed here.'
returned: success returned: success
type: list type: list
service: service:
@ -321,8 +314,8 @@ pathMatchers:
type: dict type: dict
tests: tests:
description: description:
- The list of expected URL mappings. Requests to update this UrlMap will succeed - The list of expected URL mappings. Request to update this UrlMap will succeed only
only if all of the test cases pass. if all of the test cases pass.
returned: success returned: success
type: complex type: complex
contains: contains:
@ -343,8 +336,7 @@ tests:
type: str type: str
service: service:
description: description:
- A reference to expected BackendService resource the given URL should be mapped - A reference to expected BackendService resource the given URL should be mapped to.
to.
returned: success returned: success
type: dict type: dict
''' '''

55
plugins/modules/gcp_compute_url_map_facts.py
View file

@ -59,8 +59,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
@ -88,21 +88,21 @@ resources:
contains: contains:
description: description:
description: description:
- An optional description of this HostRule. Provide this property when you - An optional description of this resource. Provide this property when you create
create the resource. the resource.
returned: success returned: success
type: str type: str
hosts: hosts:
description: description:
- The list of host patterns to match. They must be valid hostnames, except - The list of host patterns to match. They must be valid hostnames, except * will
* will match any string of ([a-z0-9-.]*). In that case, * must be the match any string of ([a-z0-9-.]*). In that case, * must be the first character and
first character and must be followed in the pattern by either - or . must be followed in the pattern by either - or .
returned: success returned: success
type: list type: list
pathMatcher: pathMatcher:
description: description:
- The name of the PathMatcher to use to match the path portion of the URL - The name of the PathMatcher to use to match the path portion of the URL if the hostRule
if the hostRule matches the URL's host portion. matches the URL's host portion.
returned: success returned: success
type: str type: str
id: id:
@ -110,20 +110,14 @@ resources:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
fingerprint:
description:
- Fingerprint of this resource. This field is used internally during updates
of this resource.
returned: success
type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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 which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
pathMatchers: pathMatchers:
@ -134,9 +128,8 @@ resources:
contains: contains:
defaultService: defaultService:
description: description:
- A reference to a BackendService resource. This will be used if none of - A reference to a BackendService resource. This will be used if none of the pathRules
the pathRules defined by this PathMatcher is matched by the URL's path defined by this PathMatcher is matched by the URL's path portion.
portion.
returned: success returned: success
type: dict type: dict
description: description:
@ -157,10 +150,9 @@ resources:
contains: contains:
paths: paths:
description: description:
- 'The list of path patterns to match. Each must start with / and the - 'The list of path patterns to match. Each must start with / and the only place a
only place a * is allowed is at the end following a /. The string * is allowed is at the end following a /. The string fed to the path matcher does
fed to the path matcher does not include any text after the first not include any text after the first ? or #, and those chars are not allowed here.'
? or #, and those chars are not allowed here.'
returned: success returned: success
type: list type: list
service: service:
@ -170,8 +162,8 @@ resources:
type: dict type: dict
tests: tests:
description: description:
- The list of expected URL mappings. Requests to update this UrlMap will succeed - The list of expected URL mappings. Request to update this UrlMap will succeed only
only if all of the test cases pass. if all of the test cases pass.
returned: success returned: success
type: complex type: complex
contains: contains:
@ -192,8 +184,7 @@ resources:
type: str type: str
service: service:
description: description:
- A reference to expected BackendService resource the given URL should be - A reference to expected BackendService resource the given URL should be mapped to.
mapped to.
returned: success returned: success
type: dict type: dict
''' '''

18
plugins/modules/gcp_compute_vpn_tunnel.py
View file

@ -171,7 +171,7 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -190,7 +190,7 @@ RETURN = '''
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
target_vpn_gateway: targetVpnGateway:
description: description:
- URL of the Target VPN gateway with which this VPN tunnel is associated. - URL of the Target VPN gateway with which this VPN tunnel is associated.
returned: success returned: success
@ -200,29 +200,29 @@ RETURN = '''
- URL of router resource to be used for dynamic routing. - URL of router resource to be used for dynamic routing.
returned: success returned: success
type: dict type: dict
peer_ip: peerIp:
description: description:
- IP address of the peer VPN gateway. Only IPv4 is supported. - IP address of the peer VPN gateway. Only IPv4 is supported.
returned: success returned: success
type: str type: str
shared_secret: sharedSecret:
description: description:
- Shared secret used to set the secure session between the Cloud VPN gateway and the - Shared secret used to set the secure session between the Cloud VPN gateway and the
peer VPN gateway. peer VPN gateway.
returned: success returned: success
type: str type: str
shared_secret_hash: sharedSecretHash:
description: description:
- Hash of the shared secret. - Hash of the shared secret.
returned: success returned: success
type: str type: str
ike_version: ikeVersion:
description: description:
- IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. - IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
- Acceptable IKE versions are 1 or 2. Default version is 2. - Acceptable IKE versions are 1 or 2. Default version is 2.
returned: success returned: success
type: int type: int
local_traffic_selector: localTrafficSelector:
description: description:
- Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. - Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
@ -230,7 +230,7 @@ RETURN = '''
- Only IPv4 is supported. - Only IPv4 is supported.
returned: success returned: success
type: list type: list
remote_traffic_selector: remoteTrafficSelector:
description: description:
- Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. - Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
@ -243,7 +243,7 @@ RETURN = '''
- Labels to apply to this VpnTunnel. - Labels to apply to this VpnTunnel.
returned: success returned: success
type: dict type: dict
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.

18
plugins/modules/gcp_compute_vpn_tunnel_facts.py
View file

@ -69,7 +69,7 @@ items:
returned: always returned: always
type: complex type: complex
contains: contains:
creation_timestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -88,7 +88,7 @@ items:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
target_vpn_gateway: targetVpnGateway:
description: description:
- URL of the Target VPN gateway with which this VPN tunnel is associated. - URL of the Target VPN gateway with which this VPN tunnel is associated.
returned: success returned: success
@ -98,29 +98,29 @@ items:
- URL of router resource to be used for dynamic routing. - URL of router resource to be used for dynamic routing.
returned: success returned: success
type: dict type: dict
peer_ip: peerIp:
description: description:
- IP address of the peer VPN gateway. Only IPv4 is supported. - IP address of the peer VPN gateway. Only IPv4 is supported.
returned: success returned: success
type: str type: str
shared_secret: sharedSecret:
description: description:
- Shared secret used to set the secure session between the Cloud VPN gateway and the - Shared secret used to set the secure session between the Cloud VPN gateway and the
peer VPN gateway. peer VPN gateway.
returned: success returned: success
type: str type: str
shared_secret_hash: sharedSecretHash:
description: description:
- Hash of the shared secret. - Hash of the shared secret.
returned: success returned: success
type: str type: str
ike_version: ikeVersion:
description: description:
- IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. - IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
- Acceptable IKE versions are 1 or 2. Default version is 2. - Acceptable IKE versions are 1 or 2. Default version is 2.
returned: success returned: success
type: int type: int
local_traffic_selector: localTrafficSelector:
description: description:
- Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. - Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
@ -128,7 +128,7 @@ items:
- Only IPv4 is supported. - Only IPv4 is supported.
returned: success returned: success
type: list type: list
remote_traffic_selector: remoteTrafficSelector:
description: description:
- Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. - Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
@ -141,7 +141,7 @@ items:
- Labels to apply to this VpnTunnel. - Labels to apply to this VpnTunnel.
returned: success returned: success
type: dict type: dict
label_fingerprint: labelFingerprint:
description: description:
- The fingerprint used for optimistic locking of this resource. Used internally during - The fingerprint used for optimistic locking of this resource. Used internally during
updates. updates.

173
plugins/modules/gcp_container_cluster.py
View file

@ -294,7 +294,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
name: name:
description: description:
- The name of this cluster. The name must be unique within this project and location, - The name of this cluster. The name must be unique within this project and zone,
and can be up to 40 characters. Must be Lowercase letters, numbers, and hyphens and can be up to 40 characters. Must be Lowercase letters, numbers, and hyphens
only. Must start with a letter. Must end with a number or a letter. only. Must start with a letter. Must end with a number or a letter.
returned: success returned: success
@ -308,19 +308,19 @@ initialNodeCount:
description: description:
- The number of nodes to create in this cluster. You must ensure that your Compute - The number of nodes to create in this cluster. You must ensure that your Compute
Engine resource quota is sufficient for this number of instances. You must also Engine resource quota is sufficient for this number of instances. You must also
have available firewall and routes quota. For requests, this field should only have available firewall and routes quota. For requests, this field should only be
be used in lieu of a "nodePool" object, since this configuration (along with the used in lieu of a "nodePool" object, since this configuration (along with the "nodeConfig")
"nodeConfig") will be used to create a "NodePool" object with an auto-generated will be used to create a "NodePool" object with an auto-generated name. Do not use
name. Do not use this and a nodePool at the same time. this and a nodePool at the same time.
returned: success returned: success
type: int type: int
nodeConfig: nodeConfig:
description: description:
- Parameters used in creating the cluster's nodes. - Parameters used in creating the cluster's nodes.
- For requests, this field should only be used in lieu of a "nodePool" object, since - For requests, this field should only be used in lieu of a "nodePool" object, since
this configuration (along with the "initialNodeCount") will be used to create this configuration (along with the "initialNodeCount") will be used to create a
a "NodePool" object with an auto-generated name. Do not use this and a nodePool "NodePool" object with an auto-generated name. Do not use this and a nodePool at
at the same time. For responses, this field will be populated with the node configuration the same time. For responses, this field will be populated with the node configuration
of the first node pool. If unspecified, the defaults are used. of the first node pool. If unspecified, the defaults are used.
returned: success returned: success
type: complex type: complex
@ -333,40 +333,39 @@ nodeConfig:
type: str type: str
diskSizeGb: diskSizeGb:
description: description:
- Size of the disk attached to each node, specified in GB. The smallest allowed - Size of the disk attached to each node, specified in GB. The smallest allowed disk
disk size is 10GB. If unspecified, the default disk size is 100GB. size is 10GB. If unspecified, the default disk size is 100GB.
returned: success returned: success
type: int type: int
oauthScopes: oauthScopes:
description: description:
- The set of Google API scopes to be made available on all of the node VMs under - The set of Google API scopes to be made available on all of the node VMs under the
the "default" service account. "default" service account.
- 'The following scopes are recommended, but not required, and by default are - 'The following scopes are recommended, but not required, and by default are not
not included: U(https://www.googleapis.com/auth/compute) is required for mounting included: U(https://www.googleapis.com/auth/compute) is required for mounting persistent
persistent storage on your nodes.' storage on your nodes.'
- U(https://www.googleapis.com/auth/devstorage.read_only) is required for communicating - U(https://www.googleapis.com/auth/devstorage.read_only) is required for communicating
with gcr.io (the Google Container Registry). with gcr.io (the Google Container Registry).
- If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring - If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are
are enabled, in which case their required scopes will be added. enabled, in which case their required scopes will be added.
returned: success returned: success
type: list type: list
serviceAccount: serviceAccount:
description: description:
- The Google Cloud Platform Service Account to be used by the node VMs. If no - The Google Cloud Platform Service Account to be used by the node VMs. If no Service
Service Account is specified, the "default" service account is used. Account is specified, the "default" service account is used.
returned: success returned: success
type: str type: str
metadata: metadata:
description: description:
- The metadata key/value pairs assigned to instances in the cluster. - The metadata key/value pairs assigned to instances in the cluster.
- 'Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes - 'Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length.
in length. These are reflected as part of a URL in the metadata server. Additionally, These are reflected as part of a URL in the metadata server. Additionally, to avoid
to avoid ambiguity, keys must not conflict with any other metadata keys for ambiguity, keys must not conflict with any other metadata keys for the project or
the project or be one of the four reserved keys: "instance-template", "kube-env", be one of the four reserved keys: "instance-template", "kube-env", "startup-script",
"startup-script", and "user-data" Values are free-form strings, and only have and "user-data" Values are free-form strings, and only have meaning as interpreted
meaning as interpreted by the image running in the instance. The only restriction by the image running in the instance. The only restriction placed on them is that
placed on them is that each value''s size must be less than or equal to 32 each value''s size must be less than or equal to 32 KB.'
KB.'
- The total size of all keys and values must be less than 512 KB. - The total size of all keys and values must be less than 512 KB.
- 'An object containing a list of "key": value pairs.' - 'An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
@ -374,19 +373,19 @@ nodeConfig:
type: dict type: dict
imageType: imageType:
description: description:
- The image type to use for this node. Note that for a given image type, the - The image type to use for this node. Note that for a given image type, the latest
latest version of it will be used. version of it will be used.
returned: success returned: success
type: str type: str
labels: labels:
description: description:
- 'The map of Kubernetes labels (key/value pairs) to be applied to each node. - 'The map of Kubernetes labels (key/value pairs) to be applied to each node.
These will added in addition to any default label(s) that Kubernetes may apply These will added in addition to any default label(s) that Kubernetes may apply to
to the node. In case of conflict in label keys, the applied set may differ the node. In case of conflict in label keys, the applied set may differ depending
depending on the Kubernetes version -- it''s best to assume the behavior is on the Kubernetes version -- it''s best to assume the behavior is undefined and
undefined and conflicts should be avoided. For more information, including conflicts should be avoided. For more information, including usage and the valid
usage and the valid values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html) values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html) An object
An object containing a list of "key": value pairs.' containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success returned: success
type: dict type: dict
@ -394,22 +393,21 @@ nodeConfig:
description: description:
- The number of local SSD disks to be attached to the node. - The number of local SSD disks to be attached to the node.
- 'The limit for this value is dependant upon the maximum number of disks available - 'The limit for this value is dependant upon the maximum number of disks available
on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits) on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits) for
for more information.' more information.'
returned: success returned: success
type: int type: int
tags: tags:
description: description:
- The list of instance tags applied to all nodes. Tags are used to identify - The list of instance tags applied to all nodes. Tags are used to identify valid
valid sources or targets for network firewalls and are specified by the client sources or targets for network firewalls and are specified by the client during
during cluster or node pool creation. Each tag within the list must comply cluster or node pool creation. Each tag within the list must comply with RFC1035.
with RFC1035.
returned: success returned: success
type: list type: list
preemptible: preemptible:
description: description:
- 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible) - 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible)
for more information about preemptible VM instances.' for more inforamtion about preemptible VM instances.'
returned: success returned: success
type: bool type: bool
masterAuth: masterAuth:
@ -425,9 +423,8 @@ masterAuth:
type: str type: str
password: password:
description: description:
- The password to use for HTTP basic authentication to the master endpoint. - The password to use for HTTP basic authentication to the master endpoint. Because
Because the master endpoint is open to the Internet, you should create a strong the master endpoint is open to the Internet, you should create a strong password.
password.
returned: success returned: success
type: str type: str
clusterCaCertificate: clusterCaCertificate:
@ -443,14 +440,13 @@ masterAuth:
type: str type: str
clientKey: clientKey:
description: description:
- Base64-encoded private key used by clients to authenticate to the cluster - Base64-encoded private key used by clients to authenticate to the cluster endpoint.
endpoint.
returned: success returned: success
type: str type: str
loggingService: loggingService:
description: description:
- 'The logging service the cluster should use to write logs. Currently available - 'The logging service the cluster should use to write logs. Currently available options: logging.googleapis.com
options: logging.googleapis.com - the Google Cloud Logging service.' - the Google Cloud Logging service.'
- none - no logs will be exported from the cluster. - none - no logs will be exported from the cluster.
- if left as an empty string,logging.googleapis.com will be used. - if left as an empty string,logging.googleapis.com will be used.
returned: success returned: success
@ -468,42 +464,8 @@ network:
description: description:
- The name of the Google Compute Engine network to which the cluster is connected. - The name of the Google Compute Engine network to which the cluster is connected.
If left unspecified, the default network will be used. If left unspecified, the default network will be used.
returned: success - To ensure it exists and it is operations, configure the network using 'gcompute_network'
type: str resource.
privateClusterConfig:
description:
- Configuration for a private cluster.
returned: success
type: complex
contains:
enablePrivateNodes:
description:
- Whether nodes have internal IP addresses only. If enabled, all nodes are given
only RFC 1918 private addresses and communicate with the master via private
networking.
returned: success
type: bool
enablePrivateEndpoint:
description:
- Whether the master's internal IP address is used as the cluster endpoint.
returned: success
type: bool
masterIpv4CidrBlock:
description:
- The IP range in CIDR notation to use for the hosted master network. This range
will be used for assigning internal IP addresses to the master or set of masters,
as well as the ILB VIP. This range must not overlap with any other ranges
in use within the cluster's network.
returned: success
type: str
privateEndpoint:
description:
- The internal IP address of this cluster's master endpoint.
returned: success
type: str
publicEndpoint:
description:
- The external IP address of this cluster's master endpoint.
returned: success returned: success
type: str type: str
clusterIpv4Cidr: clusterIpv4Cidr:
@ -521,31 +483,30 @@ addonsConfig:
contains: contains:
httpLoadBalancing: httpLoadBalancing:
description: description:
- Configuration for the HTTP (L7) load balancing controller addon, which makes - Configuration for the HTTP (L7) load balancing controller addon, which makes it
it easy to set up HTTP load balancers for services in a cluster. easy to set up HTTP load balancers for services in a cluster.
returned: success returned: success
type: complex type: complex
contains: contains:
disabled: disabled:
description: description:
- Whether the HTTP Load Balancing controller is enabled in the cluster. - Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled,
When enabled, it runs a small pod in the cluster that manages the load it runs a small pod in the cluster that manages the load balancers.
balancers.
returned: success returned: success
type: bool type: bool
horizontalPodAutoscaling: horizontalPodAutoscaling:
description: description:
- Configuration for the horizontal pod autoscaling feature, which increases - Configuration for the horizontal pod autoscaling feature, which increases or decreases
or decreases the number of replica pods a replication controller has based the number of replica pods a replication controller has based on the resource usage
on the resource usage of the existing pods. of the existing pods.
returned: success returned: success
type: complex type: complex
contains: contains:
disabled: disabled:
description: description:
- Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. - Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled,
When enabled, it ensures that a Heapster pod is running in the cluster, it ensures that a Heapster pod is running in the cluster, which is also used by
which is also used by the Cloud Monitoring service. the Cloud Monitoring service.
returned: success returned: success
type: bool type: bool
subnetwork: subnetwork:
@ -553,11 +514,17 @@ subnetwork:
- The name of the Google Compute Engine subnetwork to which the cluster is connected. - The name of the Google Compute Engine subnetwork to which the cluster is connected.
returned: success returned: success
type: str type: str
location:
description:
- The list of Google Compute Engine locations in which the cluster's nodes should
be located.
returned: success
type: list
endpoint: endpoint:
description: description:
- The IP address of this cluster's master endpoint. - The IP address of this cluster's master endpoint.
- The endpoint can be accessed from the internet at https://username:password@endpoint/ - The endpoint can be accessed from the internet at https://username:password@endpoint/ See
See the masterAuth property of this resource for username and password information. the masterAuth property of this resource for username and password information.
returned: success returned: success
type: str type: str
initialClusterVersion: initialClusterVersion:
@ -573,9 +540,9 @@ currentMasterVersion:
type: str type: str
currentNodeVersion: currentNodeVersion:
description: description:
- The current version of the node software components. If they are currently at - The current version of the node software components. If they are currently at multiple
multiple versions because they're in the process of being upgraded, this reflects versions because they're in the process of being upgraded, this reflects the minimum
the minimum version of all nodes. version of all nodes.
returned: success returned: success
type: str type: str
createTime: createTime:
@ -606,9 +573,9 @@ expireTime:
- The time the cluster will be automatically deleted in RFC3339 text format. - The time the cluster will be automatically deleted in RFC3339 text format.
returned: success returned: success
type: str type: str
location: zone:
description: description:
- The location where the cluster is deployed. - The zone where the cluster is deployed.
returned: success returned: success
type: str type: str
''' '''

96
plugins/modules/gcp_container_node_pool.py
View file

@ -258,40 +258,39 @@ config:
type: str type: str
diskSizeGb: diskSizeGb:
description: description:
- Size of the disk attached to each node, specified in GB. The smallest allowed - Size of the disk attached to each node, specified in GB. The smallest allowed disk
disk size is 10GB. If unspecified, the default disk size is 100GB. size is 10GB. If unspecified, the default disk size is 100GB.
returned: success returned: success
type: int type: int
oauthScopes: oauthScopes:
description: description:
- The set of Google API scopes to be made available on all of the node VMs under - The set of Google API scopes to be made available on all of the node VMs under the
the "default" service account. "default" service account.
- 'The following scopes are recommended, but not required, and by default are - 'The following scopes are recommended, but not required, and by default are not
not included: U(https://www.googleapis.com/auth/compute) is required for mounting included: U(https://www.googleapis.com/auth/compute) is required for mounting persistent
persistent storage on your nodes.' storage on your nodes.'
- U(https://www.googleapis.com/auth/devstorage.read_only) is required for communicating - U(https://www.googleapis.com/auth/devstorage.read_only) is required for communicating
with gcr.io (the Google Container Registry). with gcr.io (the Google Container Registry).
- If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring - If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are
are enabled, in which case their required scopes will be added. enabled, in which case their required scopes will be added.
returned: success returned: success
type: list type: list
serviceAccount: serviceAccount:
description: description:
- The Google Cloud Platform Service Account to be used by the node VMs. If no - The Google Cloud Platform Service Account to be used by the node VMs. If no Service
Service Account is specified, the "default" service account is used. Account is specified, the "default" service account is used.
returned: success returned: success
type: str type: str
metadata: metadata:
description: description:
- The metadata key/value pairs assigned to instances in the cluster. - The metadata key/value pairs assigned to instances in the cluster.
- 'Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes - 'Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length.
in length. These are reflected as part of a URL in the metadata server. Additionally, These are reflected as part of a URL in the metadata server. Additionally, to avoid
to avoid ambiguity, keys must not conflict with any other metadata keys for ambiguity, keys must not conflict with any other metadata keys for the project or
the project or be one of the four reserved keys: "instance-template", "kube-env", be one of the four reserved keys: "instance-template", "kube-env", "startup-script",
"startup-script", and "user-data" Values are free-form strings, and only have and "user-data" Values are free-form strings, and only have meaning as interpreted
meaning as interpreted by the image running in the instance. The only restriction by the image running in the instance. The only restriction placed on them is that
placed on them is that each value''s size must be less than or equal to 32 each value''s size must be less than or equal to 32 KB.'
KB.'
- The total size of all keys and values must be less than 512 KB. - The total size of all keys and values must be less than 512 KB.
- 'An object containing a list of "key": value pairs.' - 'An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
@ -299,19 +298,19 @@ config:
type: dict type: dict
imageType: imageType:
description: description:
- The image type to use for this node. Note that for a given image type, the - The image type to use for this node. Note that for a given image type, the latest
latest version of it will be used. version of it will be used.
returned: success returned: success
type: str type: str
labels: labels:
description: description:
- 'The map of Kubernetes labels (key/value pairs) to be applied to each node. - 'The map of Kubernetes labels (key/value pairs) to be applied to each node.
These will added in addition to any default label(s) that Kubernetes may apply These will added in addition to any default label(s) that Kubernetes may apply to
to the node. In case of conflict in label keys, the applied set may differ the node. In case of conflict in label keys, the applied set may differ depending
depending on the Kubernetes version -- it''s best to assume the behavior is on the Kubernetes version -- it''s best to assume the behavior is undefined and
undefined and conflicts should be avoided. For more information, including conflicts should be avoided. For more information, including usage and the valid
usage and the valid values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html) values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html) An object
An object containing a list of "key": value pairs.' containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success returned: success
type: dict type: dict
@ -319,29 +318,28 @@ config:
description: description:
- The number of local SSD disks to be attached to the node. - The number of local SSD disks to be attached to the node.
- 'The limit for this value is dependant upon the maximum number of disks available - 'The limit for this value is dependant upon the maximum number of disks available
on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits) on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits) for
for more information.' more information.'
returned: success returned: success
type: int type: int
tags: tags:
description: description:
- The list of instance tags applied to all nodes. Tags are used to identify - The list of instance tags applied to all nodes. Tags are used to identify valid
valid sources or targets for network firewalls and are specified by the client sources or targets for network firewalls and are specified by the client during
during cluster or node pool creation. Each tag within the list must comply cluster or node pool creation. Each tag within the list must comply with RFC1035.
with RFC1035.
returned: success returned: success
type: list type: list
preemptible: preemptible:
description: description:
- 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible) - 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible)
for more information about preemptible VM instances.' for more inforamtion about preemptible VM instances.'
returned: success returned: success
type: bool type: bool
initialNodeCount: initialNodeCount:
description: description:
- The initial node count for the pool. You must ensure that your Compute Engine - The initial node count for the pool. You must ensure that your Compute Engine resource
resource quota is sufficient for this number of instances. You must also have quota is sufficient for this number of instances. You must also have available firewall
available firewall and routes quota. and routes quota.
returned: success returned: success
type: int type: int
version: version:
@ -380,16 +378,16 @@ management:
contains: contains:
autoUpgrade: autoUpgrade:
description: description:
- A flag that specifies whether node auto-upgrade is enabled for the node pool. - A flag that specifies whether node auto-upgrade is enabled for the node pool. If
If enabled, node auto-upgrade helps keep the nodes in your node pool up to enabled, node auto-upgrade helps keep the nodes in your node pool up to date with
date with the latest release version of Kubernetes. the latest release version of Kubernetes.
returned: success returned: success
type: bool type: bool
autoRepair: autoRepair:
description: description:
- A flag that specifies whether the node auto-repair is enabled for the node - A flag that specifies whether the node auto-repair is enabled for the node pool.
pool. If enabled, the nodes in this node pool will be monitored and, if they If enabled, the nodes in this node pool will be monitored and, if they fail health
fail health checks too many times, an automatic repair action will be triggered. checks too many times, an automatic repair action will be triggered.
returned: success returned: success
type: bool type: bool
upgradeOptions: upgradeOptions:
@ -400,14 +398,14 @@ management:
contains: contains:
autoUpgradeStartTime: autoUpgradeStartTime:
description: description:
- This field is set when upgrades are about to commence with the approximate - This field is set when upgrades are about to commence with the approximate start
start time for the upgrades, in RFC3339 text format. time for the upgrades, in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- This field is set when upgrades are about to commence with the description - This field is set when upgrades are about to commence with the description of the
of the upgrade. upgrade.
returned: success returned: success
type: str type: str
cluster: cluster:
@ -415,9 +413,9 @@ cluster:
- The cluster this node pool belongs to. - The cluster this node pool belongs to.
returned: success returned: success
type: dict type: dict
location: zone:
description: description:
- The location where the node pool is deployed. - The zone where the node pool is deployed.
returned: success returned: success
type: str type: str
''' '''

42
plugins/modules/gcp_dns_managed_zone.py
View file

@ -123,8 +123,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
description: description:
description: description:
- A mutable string of at most 1024 characters associated with this resource for - A mutable string of at most 1024 characters associated with this resource for the
the user's convenience. Has no effect on the managed zone's function. user's convenience. Has no effect on the managed zone's function.
returned: success returned: success
type: str type: str
dnsName: dnsName:
@ -152,48 +152,16 @@ nameServers:
nameServerSet: nameServerSet:
description: description:
- Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is - Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is
a set of DNS name servers that all host the same ManagedZones. Most users will a set of DNS name servers that all host the same ManagedZones. Most users will leave
leave this field unset. this field unset.
returned: success returned: success
type: str type: list
creationTime: creationTime:
description: description:
- The time that this resource was created on the server. - The time that this resource was created on the server.
- This is in RFC3339 text format. - This is in RFC3339 text format.
returned: success returned: success
type: str type: str
labels:
description:
- A set of key/value label pairs to assign to this ManagedZone.
returned: success
type: dict
visibility:
description:
- 'The zone''s visibility: public zones are exposed to the Internet, while private
zones are visible only to Virtual Private Cloud resources.'
- 'Must be one of: `public`, `private`.'
returned: success
type: str
privateVisibilityConfig:
description:
- For privately visible zones, the set of Virtual Private Cloud resources that the
zone is visible from.
returned: success
type: complex
contains:
networks:
description:
- The list of VPC networks that can see this zone.
returned: success
type: complex
contains:
networkUrl:
description:
- The fully qualified URL of the VPC network to bind to.
- This should be formatted like `U(https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`)
.
returned: success
type: str
''' '''
################################################################################ ################################################################################

8
plugins/modules/gcp_dns_managed_zone_facts.py
View file

@ -68,7 +68,7 @@ items:
user's convenience. Has no effect on the managed zone's function. user's convenience. Has no effect on the managed zone's function.
returned: success returned: success
type: str type: str
dns_name: dnsName:
description: description:
- The DNS name of this managed zone, for instance "example.com.". - The DNS name of this managed zone, for instance "example.com.".
returned: success returned: success
@ -84,20 +84,20 @@ items:
- Must be unique within the project. - Must be unique within the project.
returned: success returned: success
type: str type: str
name_servers: nameServers:
description: description:
- Delegate your managed_zone to these virtual name servers; defined by the server - Delegate your managed_zone to these virtual name servers; defined by the server
. .
returned: success returned: success
type: list type: list
name_server_set: nameServerSet:
description: description:
- Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is - Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is
a set of DNS name servers that all host the same ManagedZones. Most users will leave a set of DNS name servers that all host the same ManagedZones. Most users will leave
this field unset. this field unset.
returned: success returned: success
type: list type: list
creation_time: creationTime:
description: description:
- The time that this resource was created on the server. - The time that this resource was created on the server.
- This is in RFC3339 text format. - This is in RFC3339 text format.

46
plugins/modules/gcp_pubsub_subscription.py
View file

@ -174,11 +174,6 @@ topic:
- A reference to a Topic resource. - A reference to a Topic resource.
returned: success returned: success
type: dict type: dict
labels:
description:
- A set of key/value label pairs to assign to this Subscription.
returned: success
type: dict
pushConfig: pushConfig:
description: description:
- If push delivery is used with this subscription, this field is used to configure - If push delivery is used with this subscription, this field is used to configure
@ -193,25 +188,6 @@ pushConfig:
- For example, a Webhook endpoint might use "U(https://example.com/push".) - For example, a Webhook endpoint might use "U(https://example.com/push".)
returned: success returned: success
type: str type: str
attributes:
description:
- Endpoint configuration attributes.
- Every endpoint has a set of API supported attributes that can be used to control
different aspects of the message delivery.
- The currently supported attribute is x-goog-version, which you can use to
change the format of the pushed message. This attribute indicates the version
of the data expected by the endpoint. This controls the shape of the pushed
message (i.e., its fields and metadata). The endpoint version is based on
the version of the Pub/Sub API.
- If not present during the subscriptions.create call, it will default to the
version of the API used to make such call. If not present during a subscriptions.modifyPushConfig
call, its value will not be changed. subscriptions.get calls will always return
a valid version, even if the subscription was created without this attribute.
- 'The possible values for this attribute are: - v1beta1: uses the push format
defined in the v1beta1 Pub/Sub API.'
- "- v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API."
returned: success
type: dict
ackDeadlineSeconds: ackDeadlineSeconds:
description: description:
- This value is the maximum time after a subscriber receives a message before the - This value is the maximum time after a subscriber receives a message before the
@ -224,30 +200,12 @@ ackDeadlineSeconds:
specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds
(10 minutes). (10 minutes).
- If this parameter is 0, a default value of 10 seconds is used. - If this parameter is 0, a default value of 10 seconds is used.
- For push delivery, this value is also used to set the request timeout for the - For push delivery, this value is also used to set the request timeout for the call
call to the push endpoint. to the push endpoint.
- If the subscriber never acknowledges the message, the Pub/Sub system will eventually - If the subscriber never acknowledges the message, the Pub/Sub system will eventually
redeliver the message. redeliver the message.
returned: success returned: success
type: int type: int
messageRetentionDuration:
description:
- How long to retain unacknowledged messages in the subscription's backlog, from
the moment a message is published. If retainAckedMessages is true, then this also
configures the retention of acknowledged messages, and thus configures how far
back in time a subscriptions.seek can be done. Defaults to 7 days. Cannot be more
than 7 days (`"604800s"`) or less than 10 minutes (`"600s"`).
- 'A duration in seconds with up to nine fractional digits, terminated by ''s''.
Example: `"600.5s"`.'
returned: success
type: str
retainAckedMessages:
description:
- Indicates whether to retain acknowledged messages. If `true`, then messages are
not expunged from the subscription's backlog, even if they are acknowledged, until
they fall out of the messageRetentionDuration window.
returned: success
type: bool
''' '''
################################################################################ ################################################################################

6
plugins/modules/gcp_pubsub_subscription_facts.py
View file

@ -67,7 +67,7 @@ items:
- A reference to a Topic resource. - A reference to a Topic resource.
returned: success returned: success
type: dict type: dict
push_config: pushConfig:
description: description:
- If push delivery is used with this subscription, this field is used to configure - If push delivery is used with this subscription, this field is used to configure
it. An empty pushConfig signifies that the subscriber will pull and ack messages it. An empty pushConfig signifies that the subscriber will pull and ack messages
@ -75,13 +75,13 @@ items:
returned: success returned: success
type: complex type: complex
contains: contains:
push_endpoint: pushEndpoint:
description: description:
- A URL locating the endpoint to which messages should be pushed. - A URL locating the endpoint to which messages should be pushed.
- For example, a Webhook endpoint might use "U(https://example.com/push".) - For example, a Webhook endpoint might use "U(https://example.com/push".)
returned: success returned: success
type: str type: str
ack_deadline_seconds: ackDeadlineSeconds:
description: description:
- This value is the maximum time after a subscriber receives a message before the - This value is the maximum time after a subscriber receives a message before the
subscriber should acknowledge the message. After message delivery but before the subscriber should acknowledge the message. After message delivery but before the

10
plugins/modules/gcp_spanner_database.py
View file

@ -103,15 +103,15 @@ RETURN = '''
name: name:
description: description:
- A unique identifier for the database, which cannot be changed after the instance - A unique identifier for the database, which cannot be changed after the instance
is created. Values are of the form [a-z][-a-z0-9]*[a-z0-9]. is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9].
The final segment of the name must be between 6 and 30 characters in length.
returned: success returned: success
type: str type: str
extraStatements: extraStatements:
description: description:
- 'An optional list of DDL statements to run inside the newly created database. - 'An optional list of DDL statements to run inside the newly created database. Statements
Statements can create tables, indexes, etc. These statements execute atomically can create tables, indexes, etc. These statements execute atomically with the creation
with the creation of the database: if there is an error in any statement, the of the database: if there is an error in any statement, the database is not created.'
database is not created.'
returned: success returned: success
type: list type: list
instance: instance:

26
plugins/modules/gcp_spanner_instance.py
View file

@ -101,17 +101,13 @@ RETURN = '''
name: name:
description: description:
- A unique identifier for the instance, which cannot be changed after the instance - A unique identifier for the instance, which cannot be changed after the instance
is created. The name must be between 6 and 30 characters in length. is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9].
The final segment of the name must be between 6 and 30 characters in length.
returned: success returned: success
type: str type: str
config: config:
description: description:
- The name of the instance's configuration (similar but not quite the same as a - A reference to the instance configuration.
region) which defines defines the geographic placement and replication of your
databases in this instance. It determines where your data is stored. Values are
typically of the form `regional-europe-west1` , `us-central` etc.
- In order to obtain a valid list please consult the [Configuration section of the
docs](U(https://cloud.google.com/spanner/docs/instances).)
returned: success returned: success
type: str type: str
displayName: displayName:
@ -127,6 +123,22 @@ nodeCount:
type: int type: int
labels: labels:
description: description:
- Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources
into groups that reflect a customer's organizational needs and deployment strategies.
Cloud Labels can be used to filter collections of resources. They can be used to
control how resource metrics are aggregated. And they can be used as arguments to
policy management rules (e.g. route, firewall, load balancing, etc.).
- 'Label keys must be between 1 and 63 characters long and must conform to the following
regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.'
- Label values must be between 0 and 63 characters long and must conform to the regular
expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
- No more than 64 labels can be associated with a given resource.
- See U(https://goo.gl/xmQnxf) for more information on and examples of labels.
- 'If you plan to use labels in your own code, please note that additional characters
may be allowed in the future. And so you are advised to use an internal label representation,
such as JSON, which doesn''t rely upon specific characters being disallowed. For
example, representing labels as the string: name + "_" + value would prove problematic
if we were to allow "_" in a future release.'
- 'An object containing a list of "key": value pairs.' - 'An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success returned: success

107
plugins/modules/gcp_sql_instance.py
View file

@ -350,26 +350,81 @@ connectionName:
databaseVersion: databaseVersion:
description: description:
- The database engine type and version. For First Generation instances, can be MYSQL_5_5, - The database engine type and version. For First Generation instances, can be MYSQL_5_5,
or MYSQL_5_6. For Second Generation instances, can be MYSQL_5_6 or MYSQL_5_7. or MYSQL_5_6. For Second Generation instances, can be MYSQL_5_6 or MYSQL_5_7. Defaults
Defaults to MYSQL_5_6. to MYSQL_5_6.
- 'PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed - 'PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed
after instance creation.' after instance creation.'
returned: success returned: success
type: str type: str
failoverReplica: failoverReplica:
description: description:
- The name and status of the failover replica. This property is applicable only - The name and status of the failover replica. This property is applicable only to
to Second Generation instances. Second Generation instances.
returned: success returned: success
type: complex type: complex
contains: contains:
available: available:
description: description:
- The availability status of the failover replica. A false status indicates - The availability status of the failover replica. A false status indicates that the
that the failover replica is out of sync. The master can only failover to failover replica is out of sync. The master can only failover to the falover replica
the failover replica when the status is true. when the status is true.
returned: success returned: success
type: bool type: bool
name:
description:
- The name of the failover replica. If specified at instance creation, a failover
replica is created for the instance. The name doesn't include the project ID. This
property is applicable only to Second Generation instances.
returned: success
type: str
instanceType:
description:
- The instance type. This can be one of the following.
- "* CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master."
- "* ON_PREMISES_INSTANCE: An instance running on the customer's premises."
- "* READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica."
returned: success
type: str
ipAddresses:
description:
- The assigned IP addresses for the instance.
returned: success
type: complex
contains:
ipAddress:
description:
- The IP address assigned.
returned: success
type: str
timeToRetire:
description:
- The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
This field is only available when the IP is scheduled to be retired.
returned: success
type: str
type:
description:
- The type of this IP address. A PRIMARY address is an address that can accept incoming
connections. An OUTGOING address is the source address of connections originating
from the instance, if supported.
returned: success
type: str
ipv6Address:
description:
- The IPv6 address assigned to the instance. This property is applicable only to First
Generation instances.
returned: success
type: str
masterInstanceName:
description:
- The name of the instance which will act as master in the replication setup.
returned: success
type: str
maxDiskSize:
description:
- The maximum disk size of the instance in bytes.
returned: success
type: int
name: name:
description: description:
- Name of the Cloud SQL instance. This does not include the project ID. - Name of the Cloud SQL instance. This does not include the project ID.
@ -381,13 +436,13 @@ failoverReplica:
instance type (First Generation or Second Generation/PostgreSQL). instance type (First Generation or Second Generation/PostgreSQL).
returned: success returned: success
type: str type: str
replica_configuration: replicaConfiguration:
description: description:
- Configuration specific to failover replicas and read replicas. - Configuration specific to failover replicas and read replicas.
returned: success returned: success
type: complex type: complex
contains: contains:
failover_target: failoverTarget:
description: description:
- Specifies if the replica is the failover target. If the field is set to true the - Specifies if the replica is the failover target. If the field is set to true the
replica will be designated as a failover replica. replica will be designated as a failover replica.
@ -397,7 +452,7 @@ failoverReplica:
in different zone with the master instance. in different zone with the master instance.
returned: success returned: success
type: bool type: bool
mysql_replica_configuration: mysqlReplicaConfiguration:
description: description:
- MySQL specific configuration when replicating from a MySQL on-premises master. Replication - MySQL specific configuration when replicating from a MySQL on-premises master. Replication
configuration information such as the username, password, certificates, and keys configuration information such as the username, password, certificates, and keys
@ -407,28 +462,28 @@ failoverReplica:
returned: success returned: success
type: complex type: complex
contains: contains:
ca_certificate: caCertificate:
description: description:
- PEM representation of the trusted CA's x509 certificate. - PEM representation of the trusted CA's x509 certificate.
returned: success returned: success
type: str type: str
client_certificate: clientCertificate:
description: description:
- PEM representation of the slave's x509 certificate . - PEM representation of the slave's x509 certificate .
returned: success returned: success
type: str type: str
client_key: clientKey:
description: description:
- PEM representation of the slave's private key. The corresponsing public key is encoded - PEM representation of the slave's private key. The corresponsing public key is encoded
in the client's asf asd certificate. in the client's asf asd certificate.
returned: success returned: success
type: str type: str
connect_retry_interval: connectRetryInterval:
description: description:
- Seconds to wait between connect retries. MySQL's default is 60 seconds. - Seconds to wait between connect retries. MySQL's default is 60 seconds.
returned: success returned: success
type: int type: int
dump_file_path: dumpFilePath:
description: description:
- Path to a SQL dump file in Google Cloud Storage from which the slave instance is - Path to a SQL dump file in Google Cloud Storage from which the slave instance is
to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip
@ -437,7 +492,7 @@ failoverReplica:
when using mysqldump. when using mysqldump.
returned: success returned: success
type: str type: str
master_heartbeat_period: masterHeartbeatPeriod:
description: description:
- Interval in milliseconds between replication heartbeats. - Interval in milliseconds between replication heartbeats.
returned: success returned: success
@ -447,7 +502,7 @@ failoverReplica:
- The password for the replication connection. - The password for the replication connection.
returned: success returned: success
type: str type: str
ssl_cipher: sslCipher:
description: description:
- A list of permissible ciphers to use for SSL encryption. - A list of permissible ciphers to use for SSL encryption.
returned: success returned: success
@ -457,18 +512,18 @@ failoverReplica:
- The username for the replication connection. - The username for the replication connection.
returned: success returned: success
type: str type: str
verify_server_certificate: verifyServerCertificate:
description: description:
- Whether or not to check the master's Common Name value in the certificate that it - Whether or not to check the master's Common Name value in the certificate that it
sends during the SSL handshake. sends during the SSL handshake.
returned: success returned: success
type: bool type: bool
replica_names: replicaNames:
description: description:
- The replicas of the instance. - The replicas of the instance.
returned: success returned: success
type: list type: list
service_account_email_address: serviceAccountEmailAddress:
description: description:
- The service account email address assigned to the instance. This property is applicable - The service account email address assigned to the instance. This property is applicable
only to Second Generation instances. only to Second Generation instances.
@ -480,7 +535,7 @@ failoverReplica:
returned: success returned: success
type: complex type: complex
contains: contains:
ip_configuration: ipConfiguration:
description: description:
- The settings for IP Management. This allows to enable or disable the instance IP - The settings for IP Management. This allows to enable or disable the instance IP
and manage which external networks can connect to the instance. The IPv4 address and manage which external networks can connect to the instance. The IPv4 address
@ -488,19 +543,19 @@ failoverReplica:
returned: success returned: success
type: complex type: complex
contains: contains:
ipv4_enabled: ipv4Enabled:
description: description:
- Whether the instance should be assigned an IP address or not. - Whether the instance should be assigned an IP address or not.
returned: success returned: success
type: bool type: bool
authorized_networks: authorizedNetworks:
description: description:
- The list of external networks that are allowed to connect to the instance using - The list of external networks that are allowed to connect to the instance using
the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24). the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
returned: success returned: success
type: complex type: complex
contains: contains:
expiration_time: expirationTime:
description: description:
- The time when this access control entry expires in RFC 3339 format, for example - The time when this access control entry expires in RFC 3339 format, for example
2012-11-15T16:19:00.094Z. 2012-11-15T16:19:00.094Z.
@ -518,7 +573,7 @@ failoverReplica:
or subnet here. or subnet here.
returned: success returned: success
type: str type: str
require_ssl: requireSsl:
description: description:
- Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP. - Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
returned: success returned: success
@ -530,7 +585,7 @@ failoverReplica:
or First Generation. or First Generation.
returned: success returned: success
type: str type: str
settings_version: settingsVersion:
description: description:
- The version of instance settings. This is a required field for update method to - The version of instance settings. This is a required field for update method to
make sure concurrent updates are handled properly. During update, use the most make sure concurrent updates are handled properly. During update, use the most

81
plugins/modules/gcp_storage_bucket.py
View file

@ -375,12 +375,12 @@ acl:
entity: entity:
description: description:
- 'The entity holding the permission, in one of the following forms: user-userId - 'The entity holding the permission, in one of the following forms: user-userId
user-email group-groupId group-email domain-domain project-team-projectId user-email group-groupId group-email domain-domain project-team-projectId allUsers
allUsers allAuthenticatedUsers Examples: The user liz@example.com would be allAuthenticatedUsers Examples: The user liz@example.com would be
user-liz@example.com.' user-liz@example.com.'
- The group example@googlegroups.com would be group-example@googlegroups.com. - The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, - To refer to all members of the Google Apps for Business domain example.com, the
the entity would be domain-example.com. entity would be domain-example.com.
returned: success returned: success
type: str type: str
entityId: entityId:
@ -422,15 +422,14 @@ cors:
contains: contains:
maxAgeSeconds: maxAgeSeconds:
description: description:
- The value, in seconds, to return in the Access-Control-Max-Age header used - The value, in seconds, to return in the Access-Control-Max-Age header used in preflight
in preflight responses. responses.
returned: success returned: success
type: int type: int
method: method:
description: description:
- 'The list of HTTP methods on which to include CORS response headers, (GET, - 'The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS,
OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means POST, etc) Note: "*" is permitted in the list of methods, and means "any method".'
"any method".'
returned: success returned: success
type: list type: list
origin: origin:
@ -468,10 +467,13 @@ defaultObjectAcl:
type: str type: str
entity: entity:
description: description:
- 'The entity holding the permission, in one of the following forms: * user-{{userId}} - 'The entity holding the permission, in one of the following forms: user-userId
* user-{{email}} (such as "user-liz@example.com") * group-{{groupId}} * group-{{email}} user-email group-groupId group-email domain-domain project-team-projectId allUsers
(such as "group-example@googlegroups.com") * domain-{{domain}} (such as "domain-example.com") allAuthenticatedUsers Examples: The user liz@example.com would be
* project-team-{{projectId}} * allUsers * allAuthenticatedUsers .' user-liz@example.com.'
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the
entity would be domain-example.com.
returned: success returned: success
type: str type: str
entityId: entityId:
@ -547,8 +549,7 @@ lifecycle:
type: str type: str
type: type:
description: description:
- Type of the action. Currently, only Delete and SetStorageClass are - Type of the action. Currently, only Delete and SetStorageClass are supported.
supported.
returned: success returned: success
type: str type: str
condition: condition:
@ -559,42 +560,41 @@ lifecycle:
contains: contains:
ageDays: ageDays:
description: description:
- Age of an object (in days). This condition is satisfied when an object - Age of an object (in days). This condition is satisfied when an object reaches the
reaches the specified age. specified age.
returned: success returned: success
type: int type: int
createdBefore: createdBefore:
description: description:
- A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). - A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
This condition is satisfied when an object is created before midnight This condition is satisfied when an object is created before midnight of the specified
of the specified date in UTC. date in UTC.
returned: success returned: success
type: str type: str
isLive: isLive:
description: description:
- Relevant only for versioned objects. If the value is true, this condition - Relevant only for versioned objects. If the value is true, this condition matches
matches live objects; if the value is false, it matches archived objects. live objects; if the value is false, it matches archived objects.
returned: success returned: success
type: bool type: bool
matchesStorageClass: matchesStorageClass:
description: description:
- Objects having any of the storage classes specified by this condition - Objects having any of the storage classes specified by this condition will be matched.
will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
returned: success returned: success
type: list type: list
numNewerVersions: numNewerVersions:
description: description:
- Relevant only for versioned objects. If the value is N, this condition - Relevant only for versioned objects. If the value is N, this condition is satisfied
is satisfied when there are at least N versions (including the live when there are at least N versions (including the live version) newer than this
version) newer than this version of the object. version of the object.
returned: success returned: success
type: int type: int
location: location:
description: description:
- The location of the bucket. Object data for objects in the bucket resides in physical - The location of the bucket. Object data for objects in the bucket resides in physical
storage within this region. Defaults to US. See the developer's guide for the storage within this region. Defaults to US. See the developer's guide for the authoritative
authoritative list. list.
returned: success returned: success
type: str type: str
logging: logging:
@ -647,12 +647,12 @@ projectNumber:
type: int type: int
storageClass: storageClass:
description: description:
- The bucket's default storage class, used whenever no storageClass is specified - The bucket's default storage class, used whenever no storageClass is specified for
for a newly-created object. This defines how objects in the bucket are stored a newly-created object. This defines how objects in the bucket are stored and determines
and determines the SLA and the cost of storage. the SLA and the cost of storage.
- Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. - Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY.
If this value is not specified when the bucket is created, it will default to If this value is not specified when the bucket is created, it will default to STANDARD.
STANDARD. For more information, see storage classes. For more information, see storage classes.
returned: success returned: success
type: str type: str
timeCreated: timeCreated:
@ -685,17 +685,16 @@ website:
contains: contains:
mainPageSuffix: mainPageSuffix:
description: description:
- If the requested object path is missing, the service will ensure the path - If the requested object path is missing, the service will ensure the path has a
has a trailing '/', append this suffix, and attempt to retrieve the resulting trailing '/', append this suffix, and attempt to retrieve the resulting object.
object. This allows the creation of index.html objects to represent directory This allows the creation of index.html objects to represent directory pages.
pages.
returned: success returned: success
type: str type: str
notFoundPage: notFoundPage:
description: description:
- If the requested object path is missing, and any mainPageSuffix object is - If the requested object path is missing, and any mainPageSuffix object is missing,
missing, if applicable, the service will return the named object from this if applicable, the service will return the named object from this bucket as the
bucket as the content for a 404 Not Found result. content for a 404 Not Found result.
returned: success returned: success
type: str type: str
project: project:

3
plugins/modules/gcp_storage_bucket_access_control.py
View file

@ -147,7 +147,8 @@ entity:
description: description:
- 'The entity holding the permission, in one of the following forms: user-userId - 'The entity holding the permission, in one of the following forms: user-userId
user-email group-groupId group-email domain-domain project-team-projectId allUsers user-email group-groupId group-email domain-domain project-team-projectId allUsers
allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com.' allAuthenticatedUsers Examples: The user liz@example.com would be
user-liz@example.com.'
- The group example@googlegroups.com would be group-example@googlegroups.com. - The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the - To refer to all members of the Google Apps for Business domain example.com, the
entity would be domain-example.com. entity would be domain-example.com.