ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-08 11:50:28 -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
parent 2a6c1e408e
commit b3c1afe126
71 changed files with 6574 additions and 6906 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

118
plugins/modules/gcp_compute_address.py
View file

@ -131,69 +131,61 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
address: address:
description: description:
- The static external IP address represented by this resource. Only IPv4 is supported. - The static external IP address represented by this resource. Only IPv4 is supported.
An address may only be specified for INTERNAL address types. The IP address must An address may only be specified for INTERNAL address types. The 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:
description: description:
- The type of address to reserve, either INTERNAL or EXTERNAL. - The type of address to reserve, either INTERNAL or EXTERNAL.
- If unspecified, defaults to EXTERNAL. - If unspecified, defaults to EXTERNAL.
returned: success returned: success
type: str type: str
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
name: name:
description: description:
- Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. - Name of the resource. 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 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 `[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, letter, and all following characters must be a dash, lowercase 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
networkTier: subnetwork:
description: description:
- 'The networking tier used for configuring this address. This field can take the - The URL of the subnetwork in which to reserve the address. If an IP address is specified,
following values: PREMIUM or STANDARD. If this field is not specified, it is assumed it must be within the subnetwork's IP range.
to be PREMIUM.' - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.
returned: success returned: success
type: str type: dict
subnetwork: users:
description: description:
- The URL of the subnetwork in which to reserve the address. If an IP address is - The URLs of the resources that are using this address.
specified, it must be within the subnetwork's IP range. returned: success
- This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER type: list
purposes. region:
returned: success description:
type: dict - URL of the region where the regional address resides.
users: - This field is not applicable to global addresses.
description: returned: success
- The URLs of the resources that are using this address. type: str
returned: success
type: list
region:
description:
- URL of the region where the regional address resides.
- This field is not applicable to global addresses.
returned: success
type: str
''' '''
################################################################################ ################################################################################

128
plugins/modules/gcp_compute_address_facts.py
View file

@ -65,74 +65,66 @@ 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:
description: description:
- The type of address to reserve, either INTERNAL or EXTERNAL. - The type of address to reserve, either INTERNAL or EXTERNAL.
- If unspecified, defaults to EXTERNAL. - If unspecified, defaults to EXTERNAL.
returned: success returned: success
type: str type: str
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
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 returned: success
type: str type: str
networkTier: subnetwork:
description: description:
- 'The networking tier used for configuring this address. This field can take - The URL of the subnetwork in which to reserve the address. If an IP address is specified,
the following values: PREMIUM or STANDARD. If this field is not specified, it must be within the subnetwork's IP range.
it is assumed to be PREMIUM.' - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.
returned: success returned: success
type: str type: dict
subnetwork: users:
description: description:
- The URL of the subnetwork in which to reserve the address. If an IP address - The URLs of the resources that are using this address.
is specified, it must be within the subnetwork's IP range. returned: success
- This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER type: list
purposes. region:
returned: success description:
type: dict - URL of the region where the regional address resides.
users: - This field is not applicable to global addresses.
description: returned: success
- The URLs of the resources that are using this address. type: str
returned: success
type: list
region:
description:
- URL of the region where the regional address resides.
- This field is not applicable to global addresses.
returned: success
type: str
''' '''
################################################################################ ################################################################################

89
plugins/modules/gcp_compute_backend_bucket.py
View file

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

99
plugins/modules/gcp_compute_backend_bucket_facts.py
View file

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

522
plugins/modules/gcp_compute_backend_service.py
View file

@ -341,275 +341,261 @@ 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
backends: backends:
description: description:
- The list of backends that serve this BackendService. - The list of backends that serve this BackendService.
returned: success returned: success
type: complex type: complex
contains: contains:
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).
returned: success - This cannot be used for internal load balancing.
type: str returned: success
capacityScaler: type: str
description: capacityScaler:
- A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, description:
RATE or CONNECTION). - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION,
- Default value is 1, which means the group will serve up to 100% of its configured RATE or CONNECTION).
capacity (depending on balancingMode). A setting of 0 means the group is completely - Default value is 1, which means the group will serve up to 100% of its configured
drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. capacity (depending on balancingMode). A setting of 0 means the group is completely
returned: success drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
type: str - 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
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
- Provide this property when you create the resource. returned: success
returned: success type: str
type: str enableCDN:
group: description:
description: - If true, enable Cloud CDN for this BackendService.
- The fully-qualified URL of an Instance Group or Network Endpoint Group resource. - When the load balancing scheme is INTERNAL, this field is not used.
In case of instance group this defines the list of instances that serve traffic. returned: success
Member virtual machine instances from each instance group must live in the type: bool
same zone as the instance group itself. No two backends in a backend service healthChecks:
are allowed to use same Instance Group resource. description:
- For Network Endpoint Groups this defines list of endpoints. All endpoints - The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
of Network Endpoint Group must be hosted on instances located in the same checking this BackendService. Currently at most one health check can be specified,
zone as the Network Endpoint Group. and a health check is required.
- Backend service can not contain mix of Instance Group and Network Endpoint - For internal load balancing, a URL to a HealthCheck resource must be specified instead.
Group backends. returned: success
- Note that you must specify an Instance Group or Network Endpoint Group resource type: list
using the fully-qualified URL, rather than a partial URL. id:
returned: success description:
type: str - The unique identifier for the resource.
maxConnections: returned: success
description: type: int
- The max number of simultaneous connections for the group. Can be used with iap:
either CONNECTION or UTILIZATION balancing modes. description:
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must - Settings for enabling Cloud Identity Aware Proxy.
be set. returned: success
returned: success type: complex
type: int contains:
maxConnectionsPerInstance: enabled:
description: description:
- The max number of simultaneous connections that a single backend instance - Enables IAP.
can handle. This is used to calculate the capacity of the group. Can be used returned: success
in either CONNECTION or UTILIZATION balancing modes. type: bool
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must oauth2ClientId:
be set. description:
returned: success - OAuth2 Client ID for IAP.
type: int returned: success
maxRate: type: str
description: oauth2ClientSecret:
- The max requests per second (RPS) of the group. description:
- Can be used with either RATE or UTILIZATION balancing modes, but required - OAuth2 Client Secret for IAP.
if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be returned: success
set. type: str
returned: success oauth2ClientSecretSha256:
type: int description:
maxRatePerInstance: - OAuth2 Client Secret SHA-256 for IAP.
description: returned: success
- The max requests per second (RPS) that a single backend instance can handle. type: str
This is used to calculate the capacity of the group. Can be used in either loadBalancingScheme:
balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be description:
set. - Indicates whether the backend service will be used with internal or external load
returned: success balancing. A backend service created for one type of load balancing cannot be used
type: str with the other.
maxUtilization: returned: success
description: type: str
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization name:
target for the group. The default is 0.8. Valid range is [0.0, 1.0]. description:
returned: success - Name of the resource. Provided by the client when the resource is created. The name
type: str must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
cdnPolicy: be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
description: which means the first character must be a lowercase letter, and all following characters
- Cloud CDN configuration for this BackendService. must be a dash, lowercase letter, or digit, except the last character, which cannot
returned: success be a dash.
type: complex returned: success
contains: type: str
cacheKeyPolicy: portName:
description: description:
- The CacheKeyPolicy for this CdnPolicy. - Name of backend port. The same name should appear in the instance groups referenced
returned: success by this service. Required when the load balancing scheme is EXTERNAL.
type: complex - When the load balancing scheme is INTERNAL, this field is not used.
contains: returned: success
includeHost: type: str
description: protocol:
- If true requests to different hosts will be cached separately. description:
returned: success - The protocol this BackendService uses to communicate with backends.
type: bool - Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
includeProtocol: - For internal load balancing, the possible values are TCP and UDP, and the default
description: is TCP.
- If true, http and https requests will be cached separately. returned: success
returned: success type: str
type: bool region:
includeQueryString: description:
description: - The region where the regional backend service resides.
- If true, include query string parameters in the cache key according to - This field is not applicable to global backend services.
query_string_whitelist and query_string_blacklist. If neither is set, returned: success
the entire query string will be included. type: str
- If false, the query string will be excluded from the cache key entirely. sessionAffinity:
returned: success description:
type: bool - Type of session affinity to use. The default is NONE.
queryStringBlacklist: - When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
description: - When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
- Names of query string parameters to exclude in cache keys. or CLIENT_IP_PORT_PROTO.
- All other parameters will be included. Either specify query_string_whitelist - When the protocol is UDP, this field is not used.
or query_string_blacklist, not both. returned: success
- "'&' and '=' will be percent encoded and not treated as delimiters." type: str
returned: success timeoutSec:
type: list description:
queryStringWhitelist: - How many seconds to wait for the backend before considering it a failed request.
description: Default is 30 seconds. Valid range is [1, 86400].
- Names of query string parameters to include in cache keys. returned: success
- All other parameters will be excluded. Either specify query_string_whitelist type: int
or query_string_blacklist, not both.
- "'&' and '=' will be percent encoded and not treated as delimiters."
returned: success
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:
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
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:
- An optional description of this resource.
returned: success
type: str
enableCDN:
description:
- If true, enable Cloud CDN for this BackendService.
returned: success
type: bool
healthChecks:
description:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified,
and a health check is required.
returned: success
type: list
id:
description:
- The unique identifier for the resource.
returned: success
type: int
iap:
description:
- Settings for enabling Cloud Identity Aware Proxy.
returned: success
type: complex
contains:
enabled:
description:
- Enables IAP.
returned: success
type: bool
oauth2ClientId:
description:
- OAuth2 Client ID for IAP .
returned: success
type: str
oauth2ClientSecret:
description:
- OAuth2 Client Secret for IAP .
returned: success
type: str
oauth2ClientSecretSha256:
description:
- OAuth2 Client Secret SHA-256 for IAP .
returned: success
type: str
loadBalancingScheme:
description:
- 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 with the other. Must be `EXTERNAL` for a global backend service. Defaults
to `EXTERNAL`.
returned: success
type: str
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
portName:
description:
- Name of backend port. The same name should appear in the instance groups referenced
by this service. Required when the load balancing scheme is EXTERNAL.
returned: success
type: str
protocol:
description:
- The protocol this BackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. **NOTE**:
HTTP2 is only valid for beta HTTP/2 load balancer types and may result in errors
if used with the GA API.'
returned: success
type: str
securityPolicy:
description:
- The security policy associated with this backend service.
returned: success
type: str
sessionAffinity:
description:
- Type of session affinity to use. The default is NONE.
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
- When the protocol is UDP, this field is not used.
returned: success
type: str
timeoutSec:
description:
- How many seconds to wait for the backend before considering it a failed request.
Default is 30 seconds. Valid range is [1, 86400].
returned: success
type: int
''' '''
################################################################################ ################################################################################

212
plugins/modules/gcp_compute_backend_service_facts.py
View file

@ -59,55 +59,175 @@ 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 backends:
backends: description:
description: - The list of backends that serve this BackendService.
- The list of backends that serve this BackendService. returned: success
returned: success type: complex
type: complex contains:
contains: 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. Valid
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
Valid 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 returned: success
type: str 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
type: str
description: description:
description: description:
- 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.

230
plugins/modules/gcp_compute_global_forwarding_rule.py
View file

@ -234,105 +234,137 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
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 allocated
if this field is empty, an ephemeral internal IP address will be automatically from the IP range of the subnet or network configured for this forwarding rule.
allocated from the IP range of the subnet or network configured for this forwarding - 'An address can be specified either by a literal IP address or a URL reference to
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 * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address)
to an existing Address resource. The following examples are all valid: * 100.1.2.3 * projects/project/regions/region/addresses/address * regions/region/addresses/address
* U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) * global/addresses/address * address .'
* projects/project/regions/region/addresses/address * regions/region/addresses/address returned: success
* global/addresses/address * address .' type: str
returned: success IPProtocol:
type: str description:
IPProtocol: - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH,
description: SCTP or ICMP.
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCP returned: success
is valid. type: str
returned: success backendService:
type: str description:
ipVersion: - A reference to a BackendService to receive the matched traffic.
description: - This is used for internal load balancing.
- The IP Version that will be used by this global forwarding rule. - "(not used for external load balancing) ."
- Valid options are IPV4 or IPV6. returned: success
returned: success type: dict
type: str ipVersion:
loadBalancingScheme: description:
description: - The IP Version that will be used by this forwarding rule. Valid options are IPV4
- This signifies what the GlobalForwardingRule will be used for. or IPV6. This can only be specified for a global forwarding rule.
- 'The value of INTERNAL_SELF_MANAGED means that this will be used for Internal returned: success
Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External type: str
Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) NOTE: Currently loadBalancingScheme:
global forwarding rules cannot be used for INTERNAL load balancing.' description:
returned: success - 'This signifies what the ForwardingRule will be used for and can only take the following
type: str values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for
name: Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this
description: will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
- 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 returned: success
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` type: str
which means the first character must be a lowercase letter, and all following name:
characters must be a dash, lowercase letter, or digit, except the last character, description:
which cannot be a dash. - Name of the resource; provided by the client when the resource is created. The name
returned: success must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
type: str be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
network: which means the first character must be a lowercase letter, and all following characters
description: must be a dash, lowercase letter, or digit, except the last character, which cannot
- This field is not used for external load balancing. be a dash.
- For INTERNAL_SELF_MANAGED load balancing, this field identifies the network that returned: success
the load balanced IP should belong to for this global forwarding rule. If this type: str
field is not specified, the default network will be used. network:
returned: success description:
type: dict - For internal load balancing, this field identifies the network that the load balanced
portRange: IP should belong to for this Forwarding Rule. If this field is not specified, the
description: default network will be used.
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, - This field is not used for external load balancing.
TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. returned: success
- Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to type: dict
ports in the specified range will be forwarded to target. portRange:
- Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint description:
port ranges. - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
- 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy: TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to
465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110, 143, 195, 443, ports in the specified range will be forwarded to target.
465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: 500, 4500 .' - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port
returned: success ranges.
type: str - 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy:
target: 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465,
description: 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110,
- The URL of the target resource to receive the matched traffic. 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway:
- The forwarded traffic must be of a type appropriate to the target object. 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:
description:
- This target must be a global load balancing resource. The forwarded traffic must
be of a type appropriate to the target object.
- 'Valid types: HTTP_PROXY, HTTPS_PROXY, SSL_PROXY, TCP_PROXY .'
returned: success
type: str
''' '''
################################################################################ ################################################################################

241
plugins/modules/gcp_compute_global_forwarding_rule_facts.py
View file

@ -59,111 +59,142 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
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 * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address)
to an existing Address resource. The following examples are all valid: * 100.1.2.3 * projects/project/regions/region/addresses/address * regions/region/addresses/address
* U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) * global/addresses/address * address .'
* projects/project/regions/region/addresses/address * regions/region/addresses/address returned: success
* global/addresses/address * address .' type: str
returned: success IPProtocol:
type: str description:
IPProtocol: - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH,
description: SCTP or ICMP.
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
AH, SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, returned: success
only TCP is valid. type: str
returned: success backendService:
type: str description:
ipVersion: - A reference to a BackendService to receive the matched traffic.
description: - This is used for internal load balancing.
- The IP Version that will be used by this global forwarding rule. - "(not used for external load balancing) ."
- Valid options are IPV4 or IPV6. returned: success
returned: success type: dict
type: str ipVersion:
loadBalancingScheme: description:
description: - The IP Version that will be used by this forwarding rule. Valid options are IPV4
- This signifies what the GlobalForwardingRule will be used for. or IPV6. This can only be specified for a global forwarding rule.
- 'The value of INTERNAL_SELF_MANAGED means that this will be used for Internal returned: success
Global HTTP(S) LB. The value of EXTERNAL means that this will be used for type: str
External Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) loadBalancingScheme:
NOTE: Currently global forwarding rules cannot be used for INTERNAL load balancing.' description:
returned: success - 'This signifies what the ForwardingRule will be used for and can only take the following
type: str values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for
name: Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this
description: will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
- 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, returned: success
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` type: str
which means the first character must be a lowercase letter, and all following name:
characters must be a dash, lowercase letter, or digit, except the last character, description:
which cannot be a dash. - Name of the resource; provided by the client when the resource is created. The name
returned: success must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
type: str be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
network: which means the first character must be a lowercase letter, and all following characters
description: must be a dash, lowercase letter, or digit, except the last character, which cannot
- This field is not used for external load balancing. be a dash.
- For INTERNAL_SELF_MANAGED load balancing, this field identifies the network returned: success
that the load balanced IP should belong to for this global forwarding rule. type: str
If this field is not specified, the default network will be used. network:
returned: success description:
type: dict - For internal load balancing, this field identifies the network that the load balanced
portRange: IP should belong to for this Forwarding Rule. If this field is not specified, the
description: default network will be used.
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, - This field is not used for external load balancing.
TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. returned: success
- Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed type: dict
to ports in the specified range will be forwarded to target. portRange:
- Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint description:
port ranges. - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
- 'Some types of forwarding target have constraints on the acceptable ports: TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
* TargetHttpProxy: 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to
43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: ports in the specified range will be forwarded to target.
25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port
500, 4500 .' ranges.
returned: success - 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy:
type: str 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465,
target: 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110,
description: 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway:
- The URL of the target resource to receive the matched traffic. 500, 4500 .'
- The forwarded traffic must be of a type appropriate to the target object. 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:
description:
- This target must be a global load balancing resource. The forwarded traffic must
be of a type appropriate to the target object.
- 'Valid types: HTTP_PROXY, HTTPS_PROXY, SSL_PROXY, TCP_PROXY .'
returned: success
type: str
''' '''
################################################################################ ################################################################################

471
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,281 +385,161 @@ 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 returned: success
response: type: str
httpHealthCheck:
description: description:
- The bytes to match against the beginning of the response data. If left empty - A nested object resource.
(the default value), any response will indicate health. The response data returned: success
can only be ASCII. type: complex
required: false contains:
port: host:
description:
- 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 check
is performed will be used.
returned: success
type: str
requestPath:
description:
- The request path of the HTTP health check request.
- The default value is /.
returned: success
type: str
port:
description:
- The TCP port number for the HTTP health check request.
- The default value is 80.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the backend,
either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
httpsHealthCheck:
description: description:
- The TCP port number for the SSL health check request. - A nested object resource.
- The default value is 443. returned: success
required: false type: complex
port_name: contains:
host:
description:
- 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 check
is performed will be used.
returned: success
type: str
requestPath:
description:
- The request path of the HTTPS health check request.
- The default value is /.
returned: success
type: str
port:
description:
- The TCP port number for the HTTPS health check request.
- The default value is 443.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the backend,
either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
tcpHealthCheck:
description: description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name - A nested object resource.
are defined, port takes precedence. returned: success
required: false type: complex
proxy_header: contains:
request:
description:
- The application data to send once the TCP connection has been established (default
value is empty). If both request and response are empty, the connection establishment
alone will indicate health. The request data can only be ASCII.
returned: success
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:
description:
- The TCP port number for the TCP health check request.
- The default value is 443.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the backend,
either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
sslHealthCheck:
description: description:
- Specifies the type of proxy header to append before sending data to the - A nested object resource.
backend, either NONE or PROXY_V1. The default is NONE. returned: success
required: false type: complex
default: NONE contains:
choices: request:
- NONE description:
- PROXY_V1 - The application data to send once the SSL connection has been established (default
extends_documentation_fragment: gcp value is empty). If both request and response are empty, the connection establishment
notes: alone will indicate health. The request data can only be ASCII.
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks)' returned: success
- 'Official Documentation: U(https://cloud.google.com/load-balancing/docs/health-checks)' type: str
''' response:
description:
EXAMPLES = ''' - The bytes to match against the beginning of the response data. If left empty (the
- name: create a health check default value), any response will indicate health. The response data can only be
gcp_compute_health_check: ASCII.
name: test_object returned: success
type: TCP type: str
tcp_health_check: port:
port_name: service-health description:
request: ping - The TCP port number for the SSL health check request.
response: pong - The default value is 443.
healthy_threshold: 10 returned: success
timeout_sec: 2 type: int
unhealthy_threshold: 5 portName:
project: test_project description:
auth_kind: serviceaccount - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
service_account_file: "/tmp/auth.pem" are defined, port takes precedence.
state: present returned: success
''' type: str
proxyHeader:
RETURN = ''' description:
checkIntervalSec: - Specifies the type of proxy header to append before sending data to the backend,
description: either NONE or PROXY_V1. The default is NONE.
- How often (in seconds) to send a health check. The default value is 5 seconds. returned: success
returned: success type: str
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
type: str
httpHealthCheck:
description:
- A nested object resource.
returned: success
type: complex
contains:
host:
description:
- 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
check is performed will be used.
returned: success
type: str
requestPath:
description:
- The request path of the HTTP health check request.
- The default value is /.
returned: success
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:
description:
- The TCP port number for the HTTP health check request.
- The default value is 80.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the backend,
either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
httpsHealthCheck:
description:
- A nested object resource.
returned: success
type: complex
contains:
host:
description:
- 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
check is performed will be used.
returned: success
type: str
requestPath:
description:
- The request path of the HTTPS health check request.
- The default value is /.
returned: success
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:
description:
- The TCP port number for the HTTPS health check request.
- The default value is 443.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the backend,
either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
tcpHealthCheck:
description:
- A nested object resource.
returned: success
type: complex
contains:
request:
description:
- The application data to send once the TCP connection has been established
(default value is empty). If both request and response are empty, the connection
establishment alone will indicate health. The request data can only be ASCII.
returned: success
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:
description:
- The TCP port number for the TCP health check request.
- The default value is 443.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the backend,
either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
sslHealthCheck:
description:
- A nested object resource.
returned: success
type: complex
contains:
request:
description:
- The application data to send once the SSL connection has been established
(default value is empty). If both request and response are empty, the connection
establishment alone will indicate health. The request data can only be ASCII.
returned: success
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:
description:
- The TCP port number for the SSL health check request.
- The default value is 443.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the backend,
either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
''' '''
################################################################################ ################################################################################

441
plugins/modules/gcp_compute_health_check_facts.py
View file

@ -59,235 +59,218 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
checkIntervalSec: checkIntervalSec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.
returned: success returned: success
type: int type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
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. The name
- Name of the resource. Provided by the client when the resource is created. must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
The name must be 1-63 characters long, and comply with RFC1035. Specifically, 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 characters
which means the first character must be a lowercase letter, and all following must be a dash, lowercase letter, or digit, except the last character, which cannot
characters must be a dash, lowercase letter, or digit, except the last character, be a dash.
which cannot 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 value
- The default value is 5 seconds. It is invalid for timeoutSec to have greater than checkIntervalSec.
value 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 failures.
- A so-far healthy instance will be marked unhealthy after this many consecutive The default value is 2.
failures. 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 not specified,
- Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If the default is TCP. Exactly one of the protocol-specific health check field must
not specified, the default is TCP. Exactly one of the protocol-specific health be specified, which must match type field.
check field must be specified, which must match type field. returned: success
returned: success type: str
type: str httpHealthCheck:
httpHealthCheck: description:
description: - A nested object resource.
- A nested object resource. returned: success
returned: success type: complex
type: complex contains:
contains: 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 check
- If left empty (default value), the public IP on behalf of which this health is performed will be used.
check is performed will be used. returned: success
returned: success type: str
type: str requestPath:
requestPath: description:
description: - The request path of the HTTP health check request.
- The request path of the HTTP health check request. - The default value is /.
- The default value is /. returned: success
returned: success type: str
type: str port:
response: description:
description: - The TCP port number for the HTTP health check request.
- The bytes to match against the beginning of the response data. If left - The default value is 80.
empty (the default value), any response will indicate health. The response returned: success
data can only be ASCII. type: int
returned: success portName:
type: str description:
port: - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
description: are defined, port takes precedence.
- The TCP port number for the HTTP health check request. returned: success
- The default value is 80. type: str
returned: success proxyHeader:
type: int description:
portName: - Specifies the type of proxy header to append before sending data to the backend,
description: either NONE or PROXY_V1. The default is NONE.
- Port name as defined in InstanceGroup#NamedPort#name. If both port and returned: success
port_name are defined, port takes precedence. type: str
returned: success httpsHealthCheck:
type: str description:
proxyHeader: - A nested object resource.
description: returned: success
- Specifies the type of proxy header to append before sending data to the type: complex
backend, either NONE or PROXY_V1. The default is NONE. contains:
returned: success host:
type: str description:
httpsHealthCheck: - The value of the host header in the HTTPS health check request.
description: - If left empty (default value), the public IP on behalf of which this health check
- A nested object resource. is performed will be used.
returned: success returned: success
type: complex type: str
contains: requestPath:
host: description:
description: - The request path of the HTTPS health check request.
- The value of the host header in the HTTPS health check request. - The default value is /.
- If left empty (default value), the public IP on behalf of which this health returned: success
check is performed will be used. type: str
returned: success port:
type: str description:
requestPath: - The TCP port number for the HTTPS health check request.
description: - The default value is 443.
- The request path of the HTTPS health check request. returned: success
- The default value is /. type: int
returned: success portName:
type: str description:
response: - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
description: are defined, port takes precedence.
- The bytes to match against the beginning of the response data. If left returned: success
empty (the default value), any response will indicate health. The response type: str
data can only be ASCII. proxyHeader:
returned: success description:
type: str - Specifies the type of proxy header to append before sending data to the backend,
port: either NONE or PROXY_V1. The default is NONE.
description: returned: success
- The TCP port number for the HTTPS health check request. type: str
- The default value is 443. tcpHealthCheck:
returned: success description:
type: int - A nested object resource.
portName: returned: success
description: type: complex
- Port name as defined in InstanceGroup#NamedPort#name. If both port and contains:
port_name are defined, port takes precedence. request:
returned: success description:
type: str - The application data to send once the TCP connection has been established (default
proxyHeader: value is empty). If both request and response are empty, the connection establishment
description: alone will indicate health. The request data can only be ASCII.
- Specifies the type of proxy header to append before sending data to the returned: success
backend, either NONE or PROXY_V1. The default is NONE. type: str
returned: success response:
type: str description:
tcpHealthCheck: - The bytes to match against the beginning of the response data. If left empty (the
description: default value), any response will indicate health. The response data can only be
- A nested object resource. ASCII.
returned: success returned: success
type: complex type: str
contains: port:
request: description:
description: - The TCP port number for the TCP health check request.
- The application data to send once the TCP connection has been established - The default value is 443.
(default value is empty). If both request and response are empty, the returned: success
connection establishment alone will indicate health. The request data type: int
can only be ASCII. portName:
returned: success description:
type: str - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
response: are defined, port takes precedence.
description: returned: success
- The bytes to match against the beginning of the response data. If left type: str
empty (the default value), any response will indicate health. The response proxyHeader:
data can only be ASCII. description:
returned: success - Specifies the type of proxy header to append before sending data to the backend,
type: str either NONE or PROXY_V1. The default is NONE.
port: returned: success
description: type: str
- The TCP port number for the TCP health check request. sslHealthCheck:
- The default value is 443. description:
returned: success - A nested object resource.
type: int returned: success
portName: type: complex
description: contains:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and request:
port_name are defined, port takes precedence. description:
returned: success - The application data to send once the SSL connection has been established (default
type: str value is empty). If both request and response are empty, the connection establishment
proxyHeader: alone will indicate health. The request data can only be ASCII.
description: returned: success
- Specifies the type of proxy header to append before sending data to the type: str
backend, either NONE or PROXY_V1. The default is NONE. response:
returned: success description:
type: str - The bytes to match against the beginning of the response data. If left empty (the
sslHealthCheck: default value), any response will indicate health. The response data can only be
description: ASCII.
- A nested object resource. returned: success
returned: success type: str
type: complex port:
contains: description:
request: - The TCP port number for the SSL health check request.
description: - The default value is 443.
- The application data to send once the SSL connection has been established returned: success
(default value is empty). If both request and response are empty, the type: int
connection establishment alone will indicate health. The request data portName:
can only be ASCII. description:
returned: success - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name
type: str are defined, port takes precedence.
response: returned: success
description: type: str
- The bytes to match against the beginning of the response data. If left proxyHeader:
empty (the default value), any response will indicate health. The response description:
data can only be ASCII. - Specifies the type of proxy header to append before sending data to the backend,
returned: success either NONE or PROXY_V1. The default is NONE.
type: str returned: success
port: type: str
description:
- The TCP port number for the SSL health check request.
- The default value is 443.
returned: success
type: int
portName:
description:
- Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
returned: success
type: str
proxyHeader:
description:
- Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE.
returned: success
type: str
''' '''
################################################################################ ################################################################################

138
plugins/modules/gcp_compute_http_health_check.py
View file

@ -124,75 +124,75 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
checkIntervalSec: checkIntervalSec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.
returned: success returned: success
type: int type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
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 (default - 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 check is performed will be value), the public IP on behalf of which this health check is performed 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 server. - The unique identifier for the resource. This identifier is defined by the 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. 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:
description: description:
- The TCP port number for the HTTP health check request. - The TCP port number for the HTTP health check request.
- The default value is 80. - The default value is 80.
returned: success returned: success
type: int type: int
requestPath: requestPath:
description: description:
- The request path of the HTTP health check request. - The request path of the HTTP health check request.
- The default value is /. - The default value is /.
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 value - The default value is 5 seconds. It is invalid for timeoutSec to have greater 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
''' '''
################################################################################ ################################################################################

149
plugins/modules/gcp_compute_http_health_check_facts.py
View file

@ -59,81 +59,80 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
checkIntervalSec: checkIntervalSec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.
returned: success returned: success
type: int type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
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. The name
- Name of the resource. Provided by the client when the resource is created. must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
The name must be 1-63 characters long, and comply with RFC1035. Specifically, 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 characters
which means the first character must be a lowercase letter, and all following must be a dash, lowercase letter, or digit, except the last character, which cannot
characters must be a dash, lowercase letter, or digit, except the last character, be a dash.
which cannot be a dash. returned: success
returned: success type: str
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. - The default value is 80.
- The default value is 80. returned: success
returned: success type: int
type: int requestPath:
requestPath: description:
description: - The request path of the HTTP health check request.
- The request path of the HTTP health check request. - The default value is /.
- The default value is /. 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 value
- The default value is 5 seconds. It is invalid for timeoutSec to have greater than checkIntervalSec.
value 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 failures.
- A so-far healthy instance will be marked unhealthy after this many consecutive The default value is 2.
failures. The default value is 2. returned: success
returned: success type: int
type: int
''' '''
################################################################################ ################################################################################

138
plugins/modules/gcp_compute_https_health_check.py
View file

@ -121,75 +121,75 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
checkIntervalSec: checkIntervalSec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.
returned: success returned: success
type: int type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
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 server. - The unique identifier for the resource. This identifier is defined by the 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. 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:
description: description:
- The TCP port number for the HTTPS health check request. - The TCP port number for the HTTPS health check request.
- The default value is 80. - The default value is 80.
returned: success returned: success
type: int type: int
requestPath: requestPath:
description: description:
- The request path of the HTTPS health check request. - The request path of the HTTPS health check request.
- The default value is /. - The default value is /.
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 value - The default value is 5 seconds. It is invalid for timeoutSec to have greater 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
''' '''
################################################################################ ################################################################################

149
plugins/modules/gcp_compute_https_health_check_facts.py
View file

@ -59,81 +59,80 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
checkIntervalSec: checkIntervalSec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.
returned: success returned: success
type: int type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
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. The name
- Name of the resource. Provided by the client when the resource is created. must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
The name must be 1-63 characters long, and comply with RFC1035. Specifically, 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 characters
which means the first character must be a lowercase letter, and all following must be a dash, lowercase letter, or digit, except the last character, which cannot
characters must be a dash, lowercase letter, or digit, except the last character, be a dash.
which cannot be a dash. returned: success
returned: success type: str
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. - The default value is 80.
- The default value is 80. returned: success
returned: success type: int
type: int requestPath:
requestPath: description:
description: - The request path of the HTTPS health check request.
- The request path of the HTTPS health check request. - The default value is /.
- The default value is /. 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 value
- The default value is 5 seconds. It is invalid for timeoutSec to have greater than checkIntervalSec.
value 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 failures.
- A so-far healthy instance will be marked unhealthy after this many consecutive The default value is 2.
failures. The default value is 2. returned: success
returned: success type: int
type: int
''' '''
################################################################################ ################################################################################

402
plugins/modules/gcp_compute_image.py
View file

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

416
plugins/modules/gcp_compute_image_facts.py
View file

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

779
plugins/modules/gcp_compute_instance.py
View file

@ -465,400 +465,393 @@ 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:
description: description:
- The CPU platform used by this instance. - The CPU platform used by this instance.
returned: success returned: success
type: str type: str
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
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 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: description:
description: - Encrypts or decrypts a disk using a customer-supplied encryption key.
- Encrypts or decrypts a disk using a customer-supplied encryption key. 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 base64
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 to either encrypt or decrypt this resource.
base64 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 encryption
- Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied key to either encrypt or decrypt this resource.
encryption 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 key
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption that protects this resource.
key 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 disk.
- Assigns a zero-based index to this disk, where 0 is reserved for the boot For example, if you have many disks attached to an instance, each disk would have
disk. For example, if you have many disks attached to an instance, each disk a unique index number. If not specified, the server will choose an appropriate value.
would have a unique index number. If not specified, the server will choose returned: success
an appropriate value. type: int
returned: success initializeParams:
type: int description:
initializeParams: - Specifies the parameters for a new disk that will be created alongside the new instance.
description: Use initialization parameters to create boot disks or local SSDs attached to 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 returned: success
SSDs attached to the new instance. type: complex
returned: success contains:
type: complex diskName:
contains: description:
diskName: - Specifies the disk name. If not specified, the default is to use the name of the
description: instance.
- Specifies the disk name. If not specified, the default is to use the name returned: success
of the instance. type: str
returned: success diskSizeGb:
type: str description:
diskSizeGb: - Specifies the size of the disk in base-2 GB.
description: returned: success
- Specifies the size of the disk in base-2 GB. type: int
returned: success diskType:
type: int description:
diskType: - Reference to a gcompute_disk_type resource.
description: - Specifies the disk type to use to create the instance.
- Reference to a disk type. - If not specified, the default is pd-standard.
- Specifies the disk type to use to create the instance. returned: success
- If not specified, the default is pd-standard. type: str
returned: success sourceImage:
type: str description:
sourceImage: - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage
description: or disks.source is required. To create a disk with one of the public operating
- The source image to create this disk. When creating a new instance, one system images, specify the image by its family name.
of initializeParams.sourceImage or disks.source is required. To create returned: success
a disk with one of the public operating system images, specify the image type: str
by its family name. sourceImageEncryptionKey:
returned: success description:
type: str - The customer-supplied encryption key of the source image. Required if the source
sourceImageEncryptionKey: image is protected by a customer-supplied encryption key.
description: - Instance templates do not store customer-supplied encryption keys, so you cannot
- The customer-supplied encryption key of the source image. Required if create disks for instances in a managed instance group if the source images are
the source image is protected by a customer-supplied encryption key. encrypted with your own keys.
- Instance templates do not store customer-supplied encryption keys, so returned: success
you cannot create disks for instances in a managed instance group if the type: complex
source images are encrypted with your own keys. contains:
returned: success rawKey:
type: complex description:
contains: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
rawKey: to either encrypt or decrypt this resource.
description: returned: success
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC type: str
4648 base64 to either encrypt or decrypt this resource. sha256:
returned: success description:
type: str - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
sha256: that protects this resource.
description: returned: success
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied type: str
encryption key that protects this resource. interface:
returned: success description:
type: str - Specifies the disk interface to use for attaching this disk, which is either SCSI
interface: or NVME. The default is SCSI.
description: - Persistent disks must always use SCSI and the request will fail if you attempt to
- Specifies the disk interface to use for attaching this disk, which is either attach a persistent disk in any other format than SCSI.
SCSI or NVME. The default is SCSI. returned: success
- Persistent disks must always use SCSI and the request will fail if you attempt type: str
to attach a persistent disk in any other format than SCSI. mode:
returned: success description:
type: str - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified,
mode: the default is to attach the disk in READ_WRITE mode.
description: returned: success
- The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If type: str
not specified, the default is to attach the disk in READ_WRITE mode. source:
returned: success description:
type: str - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage
source: or disks.source is required.
description: - If desired, you can also attach existing non-root persistent disks using this property.
- Reference to a disk. When creating a new instance, one of initializeParams.sourceImage This field is only applicable for persistent disks.
or disks.source is required. returned: success
- If desired, you can also attach existing non-root persistent disks using this type: dict
property. This field is only applicable for persistent disks. type:
returned: success description:
type: dict - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified,
type: the default is PERSISTENT.
description: returned: success
- Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, type: str
the default is PERSISTENT. guestAccelerators:
returned: success description:
type: str - List of the type and count of accelerator cards attached to the instance .
guestAccelerators: returned: success
description: type: complex
- List of the type and count of accelerator cards attached to the instance . contains:
returned: success acceleratorCount:
type: complex description:
contains: - The number of the guest accelerator cards exposed to this instance.
acceleratorCount: returned: success
description: type: int
- The number of the guest accelerator cards exposed to this instance. acceleratorType:
returned: success description:
type: int - Full or partial URL of the accelerator type resource to expose to this instance.
acceleratorType: returned: success
description: type: str
- Full or partial URL of the accelerator type resource to expose to this instance. id:
returned: success description:
type: str - The unique identifier for the resource. This identifier is defined by the server.
id: returned: success
description: type: int
- The unique identifier for the resource. This identifier is defined by the server. labelFingerprint:
returned: success description:
type: int - A fingerprint for this request, which is essentially a hash of the metadata's contents
labelFingerprint: and used for optimistic locking. The fingerprint is initially generated by Compute
description: Engine and changes after every request to modify or update metadata. You must always
- A fingerprint for this request, which is essentially a hash of the metadata's provide an up-to-date fingerprint hash in order to update or change metadata.
contents and used for optimistic locking. The fingerprint is initially generated returned: success
by Compute Engine and changes after every request to modify or update metadata. type: str
You must always provide an up-to-date fingerprint hash in order to update or change metadata:
metadata. description:
returned: success - The metadata key/value pairs to assign to instances that are created from this template.
type: str These pairs can consist of custom metadata or predefined keys.
metadata: returned: success
description: type: dict
- The metadata key/value pairs to assign to instances that are created from this machineType:
template. These pairs can consist of custom metadata or predefined keys. description:
returned: success - A reference to a machine type which defines VM kind.
type: dict returned: success
machineType: type: str
description: minCpuPlatform:
- A reference to a machine type which defines VM kind. description:
returned: success - Specifies a minimum CPU platform for the VM instance. Applicable values are the
type: str friendly names of CPU platforms .
minCpuPlatform: returned: success
description: type: str
- Specifies a minimum CPU platform for the VM instance. Applicable values are the
friendly names of CPU platforms .
returned: success
type: str
name:
description:
- 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 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
networkInterfaces:
description:
- An array of configurations for this interface. This specifies how this interface
is configured to interact with other network services, such as connecting to the
internet. Only one network interface is supported per instance.
returned: success
type: complex
contains:
accessConfigs:
description:
- An array of configurations for this interface. Currently, only one access
config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified,
then this instance will have no external internet access.
returned: success
type: complex
contains:
name:
description:
- The name of this access configuration. The default and recommended name
is External NAT but you can use any arbitrary string you would like. For
example, My external IP or Network Access.
returned: success
type: str
natIP:
description:
- Reference to an address.
- An external IP address associated with this instance.
- Specify an unused static external IP address available to the project
or leave this field undefined to use an IP from a shared ephemeral IP
address pool. If you specify a static external IP address, it must live
in the same region as the zone of the instance.
returned: success
type: dict
type:
description:
- The type of configuration. The default and only option is ONE_TO_ONE_NAT.
returned: success
type: str
aliasIpRanges:
description:
- An array of alias IP ranges for this network interface. Can only be specified
for network interfaces on subnet-mode networks.
returned: success
type: complex
contains:
ipCidrRange:
description:
- The IP CIDR range represented by this alias IP range.
- This IP CIDR range must belong to the specified subnetwork and cannot
contain IP addresses reserved by system or used by other network interfaces.
This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g.
/24) or a CIDR format string (e.g. 10.1.2.0/24).
returned: success
type: str
subnetworkRangeName:
description:
- Optional subnetwork secondary range name specifying the secondary range
from which to allocate the IP CIDR range for this alias IP range. If left
unspecified, the primary range of the subnetwork will be used.
returned: success
type: str
name: name:
description: description:
- The name of the network interface, generated by the server. For network devices, - The name of the resource, provided by the client when initially creating the resource.
these are eth0, eth1, etc . The resource name must be 1-63 characters long, and comply with RFC1035. Specifically,
returned: success the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
type: str which means the first character must be a lowercase letter, and all following characters
network: must be a dash, lowercase letter, or digit, except the last character, which cannot
description: be a dash.
- Specifies the title of an existing network. When creating an instance, if returned: success
neither the network nor the subnetwork is specified, the default network global/networks/default type: str
is used; if the network is not specified but the subnetwork is specified, networkInterfaces:
the network is inferred. description:
returned: success - An array of configurations for this interface. This specifies how this interface
type: dict is configured to interact with other network services, such as connecting to the
networkIP: internet. Only one network interface is supported per instance.
description: returned: success
- An IPv4 internal network address to assign to the instance for this network type: complex
interface. If not specified by the user, an unused internal IP is assigned contains:
by the system. accessConfigs:
returned: success description:
type: str - An array of configurations for this interface. Currently, only one access config,
subnetwork: ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this
description: instance will have no external internet access.
- Reference to a VPC network. returned: success
- If the network resource is in legacy mode, do not provide this property. If type: complex
the network is in auto subnet mode, providing the subnetwork is optional. contains:
If the network is in custom subnet mode, then this field should be specified. name:
returned: success description:
type: dict - The name of this access configuration. The default and recommended name is External
scheduling: NAT but you can use any arbitrary string you would like. For example, My external
description: IP or Network Access.
- Sets the scheduling options for this instance. returned: success
returned: success type: str
type: complex natIP:
contains: description:
automaticRestart: - Specifies the title of a gcompute_address.
description: - An external IP address associated with this instance.
- Specifies whether the instance should be automatically restarted if it is - Specify an unused static external IP address available to the project or leave this
terminated by Compute Engine (not terminated by a user). field undefined to use an IP from a shared ephemeral IP address pool. If you specify
- You can only set the automatic restart option for standard instances. Preemptible a static external IP address, it must live in the same region as the zone of the
instances cannot be automatically restarted. instance.
returned: success returned: success
type: bool type: dict
onHostMaintenance: type:
description: description:
- Defines the maintenance behavior for this instance. For standard instances, - The type of configuration. The default and only option is ONE_TO_ONE_NAT.
the default behavior is MIGRATE. For preemptible instances, the default and returned: success
only possible behavior is TERMINATE. type: str
- For more information, see Setting Instance Scheduling Options. aliasIpRanges:
returned: success description:
type: str - An array of alias IP ranges for this network interface. Can only be specified for
preemptible: network interfaces on subnet-mode networks.
description: returned: success
- Defines whether the instance is preemptible. This can only be set during instance type: complex
creation, it cannot be set or changed after the instance has been created. contains:
returned: success ipCidrRange:
type: bool description:
serviceAccounts: - The IP CIDR range represented by this alias IP range.
description: - This IP CIDR range must belong to the specified subnetwork and cannot contain IP
- A list of service accounts, with their specified scopes, authorized for this instance. addresses reserved by system or used by other network interfaces. This range may
Only one service account per VM instance is supported. be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string
returned: success (e.g. 10.1.2.0/24).
type: complex returned: success
contains: type: str
email: subnetworkRangeName:
description: description:
- Email address of the service account. - Optional subnetwork secondary range name specifying the secondary range from which
returned: success to allocate the IP CIDR range for this alias IP range. If left unspecified, the
type: str primary range of the subnetwork will be used.
scopes: returned: success
description: type: str
- The list of scopes to be made available for this service account. name:
returned: success description:
type: list - The name of the network interface, generated by the server. For network devices,
status: these are eth0, eth1, etc .
description: returned: success
- 'The status of the instance. One of the following values: PROVISIONING, STAGING, type: str
RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.' network:
- As a user, use RUNNING to keep a machine "on" and TERMINATED to turn a machine description:
off . - Specifies the title of an existing gcompute_network. When creating an instance,
returned: success if neither the network nor the subnetwork is specified, the default network global/networks/default
type: str is used; if the network is not specified but the subnetwork is specified, the network
statusMessage: is inferred.
description: returned: success
- An optional, human-readable explanation of the status. type: dict
returned: success networkIP:
type: str description:
tags: - An IPv4 internal network address to assign to the instance for this network interface.
description: If not specified by the user, an unused internal IP is assigned by the system.
- A list of tags to apply to this instance. Tags are used to identify valid sources returned: success
or targets for network firewalls and are specified by the client during instance type: str
creation. The tags can be later modified by the setTags method. Each tag within subnetwork:
the list must comply with RFC1035. description:
returned: success - Reference to a gcompute_subnetwork resource.
type: complex - If the network resource is in legacy mode, do not provide this property. If the
contains: network is in auto subnet mode, providing the subnetwork is optional. If the network
fingerprint: is in custom subnet mode, then this field should be specified.
description: returned: success
- Specifies a fingerprint for this request, which is essentially a hash of the type: dict
metadata's contents and used for optimistic locking. scheduling:
- The fingerprint is initially generated by Compute Engine and changes after description:
every request to modify or update metadata. You must always provide an up-to-date - Sets the scheduling options for this instance.
fingerprint hash in order to update or change metadata. returned: success
returned: success type: complex
type: str contains:
items: automaticRestart:
description: description:
- An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. - Specifies whether the instance should be automatically restarted if it is terminated
returned: success by Compute Engine (not terminated by a user).
type: list - You can only set the automatic restart option for standard instances. Preemptible
zone: instances cannot be automatically restarted.
description: returned: success
- A reference to the zone where the machine resides. type: bool
returned: success onHostMaintenance:
type: str description:
- Defines the maintenance behavior for this instance. For standard instances, the
default behavior is MIGRATE. For preemptible instances, the default and only possible
behavior is TERMINATE.
- For more information, see Setting Instance Scheduling Options.
returned: success
type: str
preemptible:
description:
- Defines whether the instance is preemptible. This can only be set during instance
creation, it cannot be set or changed after the instance has been created.
returned: success
type: bool
serviceAccounts:
description:
- A list of service accounts, with their specified scopes, authorized for this instance.
Only one service account per VM instance is supported.
returned: success
type: complex
contains:
email:
description:
- Email address of the service account.
returned: success
type: str
scopes:
description:
- The list of scopes to be made available for this service account.
returned: success
type: list
status:
description:
- 'The status of the instance. One of the following values: PROVISIONING, STAGING,
RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.'
returned: success
type: str
statusMessage:
description:
- An optional, human-readable explanation of the status.
returned: success
type: str
tags:
description:
- A list of tags to apply to this instance. Tags are used to identify valid sources
or targets for network firewalls and are specified by the client during instance
creation. The tags can be later modified by the setTags method. Each tag within
the list must comply with RFC1035.
returned: success
type: complex
contains:
fingerprint:
description:
- Specifies a fingerprint for this request, which is essentially a hash of the metadata's
contents and used for optimistic locking.
- The fingerprint is initially generated by Compute Engine and changes after every
request to modify or update metadata. You must always provide an up-to-date fingerprint
hash in order to update or change metadata.
returned: success
type: str
items:
description:
- An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
returned: success
type: list
zone:
description:
- A reference to the zone where the machine resides.
returned: success
type: str
''' '''
################################################################################ ################################################################################

795
plugins/modules/gcp_compute_instance_facts.py
View file

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

51
plugins/modules/gcp_compute_instance_group.py
View file

@ -120,46 +120,29 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
id: id:
description: description:
- A unique identifier for this instance group. - A unique identifier for this instance group.
returned: success returned: success
type: int type: int
name:
description:
- The name of the instance group.
- The name must be 1-63 characters long, and comply with RFC1035.
returned: success
type: str
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: name:
description: description:
- The name of the instance group. - The name of the instance group.
- The name must be 1-63 characters long, and comply with RFC1035. - The name must be 1-63 characters long, and comply with RFC1035.
returned: success returned: success
type: str type: str
named_ports: namedPorts:
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}.'

61
plugins/modules/gcp_compute_instance_group_facts.py
View file

@ -64,51 +64,34 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
id: id:
description: description:
- A unique identifier for this instance group. - A unique identifier for this instance group.
returned: success returned: success
type: int type: int
name:
description:
- The name of the instance group.
- The name must be 1-63 characters long, and comply with RFC1035.
returned: success
type: str
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: name:
description: description:
- The name of the instance group. - The name of the instance group.
- The name must be 1-63 characters long, and comply with RFC1035. - The name must be 1-63 characters long, and comply with RFC1035.
returned: success returned: success
type: str type: str
named_ports: namedPorts:
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}.'

288
plugins/modules/gcp_compute_instance_group_manager.py
View file

@ -170,151 +170,151 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
baseInstanceName: baseInstanceName:
description: description:
- The base instance name to use for instances in this group. The value must be 1-58 - The base instance name to use for instances in this group. The value must be 1-58
characters long. Instances are named by appending a hyphen and a random four-character characters long. Instances are named by appending a hyphen and a random 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
creationTimestamp: creationTimestamp:
description: description:
- The creation timestamp for this managed instance group in RFC3339 text format. - The creation timestamp for this managed instance group in RFC3339 text format.
returned: success returned: success
type: str type: str
currentActions: currentActions:
description: description:
- The list of instance actions and the number of instances in this managed instance - The list of instance actions and the number of instances in this managed instance
group that are scheduled for each of those actions. group that are scheduled for each of those actions.
returned: success returned: success
type: complex type: complex
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
type: int type: int
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:
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 example, with properties that do not require a restart or a recreate action. For 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 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:
description: description:
- An optional description of this resource. 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
id: id:
description: description:
- A unique identifier for this resource. - A unique identifier for this resource.
returned: success returned: success
type: int type: int
instanceGroup: instanceGroup:
description: description:
- The instance group being managed. - The instance group being managed.
returned: success returned: success
type: dict type: dict
instanceTemplate: instanceTemplate:
description: description:
- The instance template that is specified for this managed instance group. The group - The instance template that is specified for this managed instance group. The group
uses this template to create all new instances in the managed instance group. uses this template to create all new instances in the managed instance group.
returned: success returned: success
type: dict type: dict
name:
description:
- The name of the managed instance group. The name must be 1-63 characters long,
and comply with RFC1035.
returned: success
type: str
namedPorts:
description:
- Named ports configured for the Instance Groups complementary to this Instance
Group Manager.
returned: success
type: complex
contains:
name: name:
description: description:
- The name for this named port. The name must be 1-63 characters long, and comply - The name of the managed instance group. The name must be 1-63 characters long, and
with RFC1035. comply with RFC1035.
returned: success returned: success
type: str type: str
port: namedPorts:
description: description:
- The port number, which can be a value between 1 and 65535. - Named ports configured for the Instance Groups complementary to this Instance Group
returned: success Manager.
type: int returned: success
region: type: complex
description: contains:
- The region this managed instance group resides (for regional resources). name:
returned: success description:
type: str - The name for this named port. The name must be 1-63 characters long, and comply
targetPools: with RFC1035.
description: returned: success
- TargetPool resources to which instances in the instanceGroup field are added. type: str
The target pools automatically apply to all of the instances in the managed instance port:
group. description:
returned: success - The port number, which can be a value between 1 and 65535.
type: list returned: success
targetSize: type: int
description: region:
- The target number of running instances for this managed instance group. Deleting description:
or abandoning instances reduces this number. Resizing the group changes this number. - The region this managed instance group resides (for regional resources).
returned: success returned: success
type: int type: str
zone: targetPools:
description: description:
- The zone the managed instance group resides. - TargetPool resources to which instances in the instanceGroup field are added. The
returned: success target pools automatically apply to all of the instances in the managed instance
type: str group.
returned: success
type: list
targetSize:
description:
- The target number of running instances for this managed instance group. Deleting
or abandoning instances reduces this number. Resizing the group changes this number.
returned: success
type: int
zone:
description:
- The zone the managed instance group resides.
returned: success
type: str
''' '''
################################################################################ ################################################################################

301
plugins/modules/gcp_compute_instance_group_manager_facts.py
View file

@ -64,159 +64,156 @@ 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
creationTimestamp: creationTimestamp:
description: description:
- The creation timestamp for this managed instance group in RFC3339 text format. - The creation timestamp for this managed instance group in RFC3339 text format.
returned: success returned: success
type: str type: str
currentActions: currentActions:
description: description:
- The list of instance actions and the number of instances in this managed instance - The list of instance actions and the number of instances in this managed instance
group that are scheduled for each of those actions. group that are scheduled for each of those actions.
returned: success returned: success
type: complex type: complex
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 to be deleted
- The number of instances in the managed instance group that are scheduled or are currently being deleted.
to be 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 have
- The number of instances in the managed instance group that are running no scheduled actions.
and have 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 be recreated
- The number of instances in the managed instance group that are scheduled or are currently being being recreated.
to be recreated or are currently being being recreated. - Recreating an instance deletes the existing root persistent disk and creates a new
- Recreating an instance deletes the existing root persistent disk and creates disk from the image that is defined in the instance template.
a new 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 example,
with properties that do not require a restart or a recreate action. For setting or removing target pools for the instance.
example, 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 to be restarted
- The number of instances in the managed instance group that are scheduled or are currently being restarted.
to be restarted or are currently being restarted. returned: success
returned: success type: int
type: int description:
description: description:
description: - An optional description of this resource. 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 id:
id: description:
description: - A unique identifier for this resource.
- A unique identifier for this resource. returned: success
returned: success type: int
type: int instanceGroup:
instanceGroup: description:
description: - The instance group being managed.
- The instance group being managed. returned: success
returned: success type: dict
type: dict instanceTemplate:
instanceTemplate: description:
description: - The instance template that is specified for this managed instance group. The group
- The instance template that is specified for this managed instance group. The uses this template to create all new instances in the managed instance group.
group uses this template to create all new instances in the managed instance returned: success
group. type: dict
returned: success
type: dict
name:
description:
- The name of the managed instance group. The name must be 1-63 characters long,
and comply with RFC1035.
returned: success
type: str
namedPorts:
description:
- Named ports configured for the Instance Groups complementary to this Instance
Group Manager.
returned: success
type: complex
contains:
name: name:
description: description:
- The name for this named port. The name must be 1-63 characters long, and - The name of the managed instance group. The name must be 1-63 characters long, and
comply with RFC1035. comply with RFC1035.
returned: success returned: success
type: str type: str
port: namedPorts:
description: description:
- The port number, which can be a value between 1 and 65535. - Named ports configured for the Instance Groups complementary to this Instance Group
returned: success Manager.
type: int returned: success
region: type: complex
description: contains:
- The region this managed instance group resides (for regional resources). name:
returned: success description:
type: str - The name for this named port. The name must be 1-63 characters long, and comply
targetPools: with RFC1035.
description: returned: success
- TargetPool resources to which instances in the instanceGroup field are added. type: str
The target pools automatically apply to all of the instances in the managed port:
instance group. description:
returned: success - The port number, which can be a value between 1 and 65535.
type: list returned: success
targetSize: type: int
description: region:
- The target number of running instances for this managed instance group. Deleting description:
or abandoning instances reduces this number. Resizing the group changes this - The region this managed instance group resides (for regional resources).
number. returned: success
returned: success type: str
type: int targetPools:
zone: description:
description: - TargetPool resources to which instances in the instanceGroup field are added. The
- The zone the managed instance group resides. target pools automatically apply to all of the instances in the managed instance
returned: success group.
type: str returned: success
type: list
targetSize:
description:
- The target number of running instances for this managed instance group. Deleting
or abandoning instances reduces this number. Resizing the group changes this number.
returned: success
type: int
zone:
description:
- The zone the managed instance group resides.
returned: success
type: str
''' '''
################################################################################ ################################################################################

751
plugins/modules/gcp_compute_instance_template.py
View file

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

771
plugins/modules/gcp_compute_instance_template_facts.py
View file

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

125
plugins/modules/gcp_compute_network.py
View file

@ -116,78 +116,59 @@ 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
returned: success in the IPv4Range.
type: str returned: success
id: type: str
description: id:
- The unique identifier for the resource. description:
returned: success - The unique identifier for the resource.
type: int returned: success
ipv4_range: type: int
description: ipv4_range:
- If this field is specified, a deprecated legacy network is created. description:
- You will no longer be able to create a legacy network on Feb 1, 2020. - 'The range of internal addresses that are legal on this network. This range is a
- See the [legacy network docs](U(https://cloud.google.com/vpc/docs/legacy)) for CIDR specification, for example: 192.168.0.0/16. Provided by the client when the
more details. network is created.'
- The range of internal addresses that are legal on this legacy network. returned: success
- 'This range is a CIDR specification, for example: `192.168.0.0/16`.' type: str
- The resource must be recreated to modify this field. name:
returned: success description:
type: str - 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 name must
description: be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
- Name of the resource. Provided by the client when the resource is created. The which means the first character must be a lowercase letter, and all following characters
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be a dash, lowercase letter, or digit, except the last character, which cannot
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` be a dash.
which means the first character must be a lowercase letter, and all following returned: success
characters must be a dash, lowercase letter, or digit, except the last character, type: str
which cannot be a dash. subnetworks:
returned: success description:
type: str - Server-defined fully-qualified URLs for all subnetworks in this network.
subnetworks: returned: success
description: type: list
- Server-defined fully-qualified URLs for all subnetworks in this network. autoCreateSubnetworks:
returned: success description:
type: list - When set to true, the network is created in "auto subnet mode". When set to false,
autoCreateSubnetworks: the network is in "custom subnet mode".
description: - In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9
- When set to `true`, the network is created in "auto subnet mode" and it will create and it automatically creates one subnetwork per region.
a subnet for each region automatically across the `10.128.0.0/9` address range. returned: success
- When set to `false`, the network is created in "custom subnet mode" so the user type: bool
can explicitly connect subnetwork resources. creationTimestamp:
returned: success description:
type: bool - Creation timestamp in RFC3339 text format.
creationTimestamp: returned: success
description: type: str
- Creation timestamp in RFC3339 text format.
returned: success
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
''' '''
################################################################################ ################################################################################

136
plugins/modules/gcp_compute_network_facts.py
View file

@ -59,84 +59,64 @@ 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
returned: success in the IPv4Range.
type: str returned: success
id: type: str
description: id:
- The unique identifier for the resource. description:
returned: success - The unique identifier for the resource.
type: int returned: success
ipv4_range: type: int
description: ipv4_range:
- If this field is specified, a deprecated legacy network is created. description:
- You will no longer be able to create a legacy network on Feb 1, 2020. - 'The range of internal addresses that are legal on this network. This range is a
- See the [legacy network docs](U(https://cloud.google.com/vpc/docs/legacy)) CIDR specification, for example: 192.168.0.0/16. Provided by the client when the
for more details. network is created.'
- The range of internal addresses that are legal on this legacy network. returned: success
- 'This range is a CIDR specification, for example: `192.168.0.0/16`.' type: str
- The resource must be recreated to modify this field. name:
returned: success description:
type: str - 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 name must
description: be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
- Name of the resource. Provided by the client when the resource is created. which means the first character must be a lowercase letter, and all following characters
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be a dash, lowercase letter, or digit, except the last character, which cannot
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` be a dash.
which means the first character must be a lowercase letter, and all following returned: success
characters must be a dash, lowercase letter, or digit, except the last character, type: str
which cannot be a dash. subnetworks:
returned: success description:
type: str - Server-defined fully-qualified URLs for all subnetworks in this network.
subnetworks: returned: success
description: type: list
- Server-defined fully-qualified URLs for all subnetworks in this network. autoCreateSubnetworks:
returned: success description:
type: list - When set to true, the network is created in "auto subnet mode". When set to false,
autoCreateSubnetworks: the network is in "custom subnet mode".
description: - In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9
- When set to `true`, the network is created in "auto subnet mode" and it will and it automatically creates one subnetwork per region.
create a subnet for each region automatically across the `10.128.0.0/9` address returned: success
range. type: bool
- When set to `false`, the network is created in "custom subnet mode" so the creationTimestamp:
user can explicitly connect subnetwork resources. description:
returned: success - Creation timestamp in RFC3339 text format.
type: bool returned: success
creationTimestamp: type: str
description:
- Creation timestamp in RFC3339 text format.
returned: success
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
''' '''
################################################################################ ################################################################################

146
plugins/modules/gcp_compute_route.py
View file

@ -168,79 +168,79 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
destRange: destRange:
description: description:
- The destination range of outgoing packets that this route applies to. - The destination range of outgoing packets that this route applies to.
- Only IPv4 is supported. - Only IPv4 is supported.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
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:
- The network that this route applies to. - The network that this route applies to.
returned: success returned: success
type: dict type: dict
priority: priority:
description: description:
- The priority of this route. Priority is used to break ties in cases where there - The priority of this route. Priority is used to break ties in cases where 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.
returned: success returned: success
type: int type: int
tags: tags:
description: description:
- A list of instance tags to which this route applies. - A list of instance tags to which this route applies.
returned: success returned: success
type: list type: list
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
type: str type: str
nextHopInstance: nextHopInstance:
description: description:
- URL to an instance that should handle matching packets. - URL to an instance that should handle matching packets.
- 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/) - 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
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.
returned: success returned: success
type: str type: str
nextHopVpnTunnel: 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.
returned: success returned: success
type: str type: str
''' '''
################################################################################ ################################################################################

156
plugins/modules/gcp_compute_route_facts.py
View file

@ -59,84 +59,84 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
destRange: destRange:
description: description:
- The destination range of outgoing packets that this route applies to. - The destination range of outgoing packets that this route applies to.
- Only IPv4 is supported. - Only IPv4 is supported.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. 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
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:
- The network that this route applies to. - The network that this route applies to.
returned: success returned: success
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.
returned: success returned: success
type: int type: int
tags: tags:
description: description:
- A list of instance tags to which this route applies. - A list of instance tags to which this route applies.
returned: success returned: success
type: list type: list
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
type: str type: str
nextHopInstance: nextHopInstance:
description: description:
- URL to an instance that should handle matching packets. - URL to an instance that should handle matching packets.
- 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/) - 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
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.
returned: success returned: success
type: str type: str
nextHopVpnTunnel: 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.
returned: success returned: success
type: str type: str
''' '''
################################################################################ ################################################################################

149
plugins/modules/gcp_compute_router.py
View file

@ -154,78 +154,83 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
name: name:
description: description:
- Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. - Name of the resource. 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 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 `[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, letter, and all following characters must be a dash, lowercase 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:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
network: network:
description: description:
- A reference to the network to which this router belongs. - A reference to the network to which this router belongs.
returned: success returned: success
type: dict type: dict
bgp: bgp:
description: description:
- BGP information specific to this router. - BGP information specific to this router.
returned: success returned: success
type: complex type: complex
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:
description: description:
- User-specified flag to indicate which mode to use for advertisement. - User-specified flag to indicate which mode to use for advertisement.
- 'Valid values of this enum field are: DEFAULT, CUSTOM .' - 'Valid values of this enum field are: DEFAULT, CUSTOM .'
returned: success returned: success
type: str type: str
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 contains:
contains: range:
range: description:
description: - The IP range to advertise. The value must be a CIDR-formatted string.
- The IP range to advertise. The value must be a CIDR-formatted string. returned: success
returned: success type: str
type: str description:
description:
- User-specified description for the IP range.
returned: success
type: str
region:
description: description:
description: description:
- User-specified description for the IP range. - User-specified description for the IP range.

172
plugins/modules/gcp_compute_router_facts.py
View file

@ -64,94 +64,92 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
id: id:
description:
- The unique identifier for the resource.
returned: success
type: int
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
name:
description:
- Name of the resource. 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
description:
description:
- An optional description of this resource.
returned: success
type: str
network:
description:
- A reference to the network to which this router belongs.
returned: success
type: dict
bgp:
description:
- BGP information specific to this router.
returned: success
type: complex
contains:
asn:
description:
- Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN,
either 16-bit or 32-bit. The value will be fixed for this router resource.
All VPN tunnels that link to this router will have the same local ASN.
returned: success
type: int
advertiseMode:
description:
- User-specified flag to indicate which mode to use for advertisement.
- 'Valid values of this enum field are: DEFAULT, CUSTOM .'
returned: success
type: str
advertisedGroups:
description:
- User-specified list of prefix groups to advertise in custom mode.
- This field can only be populated if advertiseMode is CUSTOM and is advertised
to all peers of the router. These groups will be advertised in addition
to any specified prefixes. Leave this field blank to advertise no custom
groups.
- 'This enum field has the one valid value: ALL_SUBNETS .'
returned: success
type: list
advertisedIpRanges:
description:
- User-specified list of individual IP ranges to advertise in custom mode.
This field can only be populated if advertiseMode is CUSTOM and is advertised
to all peers of the router. These IP ranges will be advertised in addition
to any specified groups.
- Leave this field blank to advertise no custom IP ranges.
returned: success
type: complex
contains:
range:
description:
- The IP range to advertise. The value must be a CIDR-formatted string.
returned: success
type: str
description: description:
description: - The unique identifier for the resource.
- User-specified description for the IP range. returned: success
returned: success type: int
type: str creationTimestamp:
region: description:
description: - Creation timestamp in RFC3339 text format.
- Region where the router resides. returned: success
returned: success type: str
type: str name:
description:
- Name of the resource. 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
description:
description:
- An optional description of this resource.
returned: success
type: str
network:
description:
- A reference to the network to which this router belongs.
returned: success
type: dict
bgp:
description:
- BGP information specific to this router.
returned: success
type: complex
contains:
asn:
description:
- Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either
16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels
that link to this router will have the same local ASN.
returned: success
type: int
advertiseMode:
description:
- User-specified flag to indicate which mode to use for advertisement.
- 'Valid values of this enum field are: DEFAULT, CUSTOM .'
returned: success
type: str
advertisedGroups:
description:
- User-specified list of prefix groups to advertise in custom mode.
- This field can only be populated if advertiseMode is CUSTOM and is advertised to
all peers of the router. These groups will be advertised in addition to any specified
prefixes. Leave this field blank to advertise no custom groups.
- 'This enum field has the one valid value: ALL_SUBNETS .'
returned: success
type: list
advertisedIpRanges:
description:
- User-specified list of individual IP ranges to advertise in custom mode. This field
can only be populated if advertiseMode is CUSTOM and is advertised to all peers
of the router. These IP ranges will be advertised in addition to any specified groups.
- Leave this field blank to advertise no custom IP ranges.
returned: success
type: complex
contains:
range:
description:
- The IP range to advertise. The value must be a CIDR-formatted string.
returned: success
type: str
description:
description:
- User-specified description for the IP range.
returned: success
type: str
region:
description:
- Region where the router resides.
returned: success
type: str
''' '''
################################################################################ ################################################################################

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

149
plugins/modules/gcp_compute_ssl_policy.py
View file

@ -111,81 +111,80 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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. 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: description:
description: - The list of features enabled in the SSL policy.
- The list of features enabled in the SSL policy. returned: success
returned: success type: list
type: list customFeatures:
customFeatures: description:
description: - A list of features enabled when the selected profile is CUSTOM. The method returns
- A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty
the set of features that can be specified in this list. This field 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. This
- Fingerprint of this resource. A hash of the contents stored in this object. 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 will
- If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
be populated with warning messages. returned: success
returned: success type: complex
type: complex contains:
contains: code:
code: description:
description: - A warning code, if applicable.
- A warning code, if applicable. returned: success
returned: success type: str
type: str message:
message: description:
description: - A human-readable description of the warning code.
- A human-readable description of the warning code. returned: success
returned: success type: str
type: str
''' '''
################################################################################ ################################################################################

159
plugins/modules/gcp_compute_ssl_policy_facts.py
View file

@ -59,86 +59,85 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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
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: description:
description: - The list of features enabled in the SSL policy.
- The list of features enabled in the SSL policy. returned: success
returned: success type: list
type: list customFeatures:
customFeatures: description:
description: - A list of features enabled when the selected profile is CUSTOM. The method returns
- A list of features enabled when the selected profile is CUSTOM. The method the set of features that can be specified in this list. This field must be empty
returns the set of features that can be specified in this list. This field if the profile is not CUSTOM.
must be empty 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. This
- Fingerprint of this resource. A hash of the contents stored in this object. field is used in optimistic locking.
This 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 will
- If potential misconfigurations are detected for this SSL policy, this field be populated with warning messages.
will be populated with warning messages. returned: success
returned: success type: complex
type: complex contains:
contains: code:
code: description:
description: - A warning code, if applicable.
- A warning code, if applicable. returned: success
returned: success type: str
type: str message:
message: description:
description: - A human-readable description of the warning code.
- A human-readable description of the warning code. returned: success
returned: success type: str
type: str
''' '''
################################################################################ ################################################################################

146
plugins/modules/gcp_compute_subnetwork.py
View file

@ -162,97 +162,63 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create
the resource. This field can be set only at resource creation time. the resource. This field can be set only at resource creation time.
returned: success returned: success
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:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
ipCidrRange:
description:
- 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
or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
Only IPv4 is supported.
returned: success
type: str
name:
description:
- 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 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
network:
description:
- The network this subnet belongs to.
- Only networks that are in the distributed mode can have subnetworks.
returned: success
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: ipCidrRange:
description: description:
- The range of IP addresses belonging to this subnetwork secondary range. Provide - The range of internal addresses that are owned by this subnetwork.
this property when you create the subnetwork. - Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or
- Ranges must be unique and non-overlapping with all primary and secondary IP 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only
ranges within a network. Only IPv4 is supported. IPv4 is supported.
returned: success returned: success
type: str type: str
privateIpGoogleAccess: name:
description: description:
- When enabled, VMs in this subnetwork without external IP addresses can access - The name of the resource, provided by the client when initially creating the resource.
Google APIs and services by using Private Google Access. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the
returned: success name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
type: bool which means the first character must be a lowercase letter, and all following characters
region: must be a dash, lowercase letter, or digit, except the last character, which cannot
description: be a dash.
- URL of the GCP region for this subnetwork. returned: success
returned: success type: str
type: str network:
description:
- The network this subnet belongs to.
- Only networks that are in the distributed mode can have subnetworks.
returned: success
type: dict
privateIpGoogleAccess:
description:
- Whether the VMs in this subnet can access Google services without assigned external
IP addresses.
returned: success
type: bool
region:
description:
- URL of the GCP region for this subnetwork.
returned: success
type: str
''' '''
################################################################################ ################################################################################

157
plugins/modules/gcp_compute_subnetwork_facts.py
View file

@ -64,103 +64,68 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create
the resource. This field can be set only at resource creation time. the resource. This field can be set only at resource creation time.
returned: success returned: success
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:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
ipCidrRange:
description:
- 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
or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
Only IPv4 is supported.
returned: success
type: str
name:
description:
- 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 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
network:
description:
- The network this subnet belongs to.
- Only networks that are in the distributed mode can have subnetworks.
returned: success
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: ipCidrRange:
description: description:
- The range of IP addresses belonging to this subnetwork secondary range. - The range of internal addresses that are owned by this subnetwork.
Provide this property when you create the subnetwork. - Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or
- Ranges must be unique and non-overlapping with all primary and secondary 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only
IP ranges within a network. Only IPv4 is supported. IPv4 is supported.
returned: success returned: success
type: str type: str
privateIpGoogleAccess: name:
description: description:
- When enabled, VMs in this subnetwork without external IP addresses can access - The name of the resource, provided by the client when initially creating the resource.
Google APIs and services by using Private Google Access. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the
returned: success name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
type: bool which means the first character must be a lowercase letter, and all following characters
region: must be a dash, lowercase letter, or digit, except the last character, which cannot
description: be a dash.
- URL of the GCP region for this subnetwork. returned: success
returned: success type: str
type: str network:
description:
- The network this subnet belongs to.
- Only networks that are in the distributed mode can have subnetworks.
returned: success
type: dict
privateIpGoogleAccess:
description:
- Whether the VMs in this subnet can access Google services without assigned external
IP addresses.
returned: success
type: bool
region:
description:
- URL of the GCP region for this subnetwork.
returned: success
type: str
''' '''
################################################################################ ################################################################################

60
plugins/modules/gcp_compute_target_http_proxy.py
View file

@ -136,36 +136,36 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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. 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:
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.
returned: success returned: success
type: dict type: dict
''' '''
################################################################################ ################################################################################

71
plugins/modules/gcp_compute_target_http_proxy_facts.py
View file

@ -59,42 +59,41 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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
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
''' '''
################################################################################ ################################################################################

97
plugins/modules/gcp_compute_target_https_proxy.py
View file

@ -191,58 +191,51 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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. 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:
description: description:
- A list of SslCertificate resources that are used to authenticate connections between - A list of SslCertificate resources that are used to authenticate connections between
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: urlMap:
description: description:
- A reference to the SslPolicy resource that will be associated with the TargetHttpsProxy - A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
resource. If not set, the TargetHttpsProxy resource will not have any SSL policy returned: success
configured. type: dict
returned: success
type: dict
urlMap:
description:
- A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
returned: success
type: dict
''' '''
################################################################################ ################################################################################

109
plugins/modules/gcp_compute_target_https_proxy_facts.py
View file

@ -59,65 +59,56 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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
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 urlMap:
sslPolicy: description:
description: - A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
- A reference to the SslPolicy resource that will be associated with the TargetHttpsProxy returned: success
resource. If not set, the TargetHttpsProxy resource will not have any SSL type: dict
policy configured.
returned: success
type: dict
urlMap:
description:
- A reference to the UrlMap resource that defines the mapping from URL to the
BackendService.
returned: success
type: dict
''' '''
################################################################################ ################################################################################

168
plugins/modules/gcp_compute_target_pool.py
View file

@ -145,90 +145,90 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
backupPool: backupPool:
description: description:
- This field is applicable only when the containing target pool is serving a forwarding - This field is applicable only when the containing target pool is serving a forwarding
rule as the primary pool, and its failoverRatio field is properly set to a value rule as the primary pool, and its failoverRatio field is properly set to a value
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
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:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
failoverRatio: failoverRatio:
description: description:
- This field is applicable only when the containing target pool is serving a forwarding - This field is applicable only when the containing target pool is serving a forwarding
rule as the primary pool (i.e., not as a backup pool to some other target pool). rule as the primary pool (i.e., not as a backup pool to some other 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 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
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:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
instances: instances:
description: description:
- A list of virtual machine instances serving this pool. - A list of virtual machine instances serving this pool.
- They must live in zones contained in the same region as this pool. - They must live in zones contained in the same region as this pool.
returned: success returned: success
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:
description: description:
- 'Session affinity option. Must be one of these values: - NONE: Connections from - 'Session affinity option. Must be one of these values: - NONE: Connections 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
will go to the same instance in the pool while that instance remains healthy." will go to the same instance in the pool while that instance remains healthy."
returned: success returned: success
type: str type: str
region: region:
description: description:
- The region where the target pool resides. - The region where the target pool resides.
returned: success returned: success
type: str type: str
''' '''
################################################################################ ################################################################################

178
plugins/modules/gcp_compute_target_pool_facts.py
View file

@ -64,95 +64,95 @@ 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:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
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:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
instances: instances:
description: description:
- A list of virtual machine instances serving this pool. - A list of virtual machine instances serving this pool.
- They must live in zones contained in the same region as this pool. - They must live in zones contained in the same region as this pool.
returned: success returned: success
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
will go to the same instance in the pool while that instance remains healthy." will go to the same instance in the pool while that instance remains healthy."
returned: success returned: success
type: str type: str
region: region:
description: description:
- The region where the target pool resides. - The region where the target pool resides.
returned: success returned: success
type: str type: str
''' '''
################################################################################ ################################################################################

91
plugins/modules/gcp_compute_target_ssl_proxy.py
View file

@ -179,55 +179,48 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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. 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:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the 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
service: service:
description: description:
- A reference to the BackendService resource. - A reference to the BackendService resource.
returned: success returned: success
type: dict type: dict
sslCertificates: sslCertificates:
description: description:
- A list of SslCertificate resources that are used to authenticate connections between - A list of SslCertificate resources that are used to authenticate connections between
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
''' '''
################################################################################ ################################################################################

102
plugins/modules/gcp_compute_target_ssl_proxy_facts.py
View file

@ -59,61 +59,53 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the 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
service: service:
description: description:
- A reference to the BackendService resource. - A reference to the BackendService resource.
returned: success returned: success
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
''' '''
################################################################################ ################################################################################

72
plugins/modules/gcp_compute_target_tcp_proxy.py
View file

@ -138,42 +138,42 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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. 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:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the 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
service: service:
description: description:
- A reference to the BackendService resource. - A reference to the BackendService resource.
returned: success returned: success
type: dict type: dict
''' '''
################################################################################ ################################################################################

82
plugins/modules/gcp_compute_target_tcp_proxy_facts.py
View file

@ -59,47 +59,47 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
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
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the 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
service: service:
description: description:
- A reference to the BackendService resource. - A reference to the BackendService resource.
returned: success returned: success
type: dict type: dict
''' '''
################################################################################ ################################################################################

91
plugins/modules/gcp_compute_target_vpn_gateway.py
View file

@ -111,52 +111,51 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
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
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
network: network:
description: description:
- The network this VPN gateway is accepting traffic for. - The network this VPN gateway is accepting traffic for.
returned: success returned: success
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: description:
description: - The region this gateway should sit in.
- The region this gateway should sit in. returned: success
returned: success type: str
type: str
''' '''
################################################################################ ################################################################################

101
plugins/modules/gcp_compute_target_vpn_gateway_facts.py
View file

@ -64,57 +64,56 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
resources: items:
description: List of resources description: List of items
returned: always returned: always
type: complex type: complex
contains: contains:
creationTimestamp: creationTimestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
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
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
network: network:
description: description:
- The network this VPN gateway is accepting traffic for. - The network this VPN gateway is accepting traffic for.
returned: success returned: success
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: description:
description: - The region this gateway should sit in.
- The region this gateway should sit in. returned: success
returned: success type: str
type: str
''' '''
################################################################################ ################################################################################

248
plugins/modules/gcp_compute_url_map.py
View file

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

259
plugins/modules/gcp_compute_url_map_facts.py
View file

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

605
plugins/modules/gcp_container_cluster.py
View file

@ -292,325 +292,292 @@ 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
type: str type: str
description: description:
description: description:
- An optional description of this cluster. - An optional description of this cluster.
returned: success returned: success
type: str type: str
initialNodeCount: 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
contains: contains:
machineType: machineType:
description: description:
- The name of a Google Compute Engine machine type (e.g. - The name of a Google Compute Engine machine type (e.g.
- n1-standard-1). If unspecified, the default machine type is n1-standard-1. - n1-standard-1). If unspecified, the default machine type is n1-standard-1.
returned: success returned: success
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" }.' returned: success
returned: success type: dict
type: dict imageType:
imageType: description:
description: - The image type to use for this node. Note that for a given image type, the latest
- The image type to use for this node. Note that for a given image type, the version of it will be used.
latest 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 to
These will added in addition to any default label(s) that Kubernetes may apply the node. In case of conflict in label keys, the applied set may differ depending
to the node. In case of conflict in label keys, the applied set may differ on the Kubernetes version -- it''s best to assume the behavior is undefined and
depending on the Kubernetes version -- it''s best to assume the behavior is conflicts should be avoided. For more information, including usage and the valid
undefined and conflicts should be avoided. For more information, including values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html) An object
usage and the valid values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html) 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 type: dict
type: dict localSsdCount:
localSsdCount: 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) for
on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits) more information.'
for 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 valid
- The list of instance tags applied to all nodes. Tags are used to identify sources or targets for network firewalls and are specified by the client during
valid sources or targets for network firewalls and are specified by the client cluster or node pool creation. Each tag within the list must comply with RFC1035.
during cluster or node pool creation. Each tag within the list must comply returned: success
with RFC1035. type: list
returned: success preemptible:
type: list description:
preemptible: - 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible)
description: for more inforamtion about preemptible VM instances.'
- 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible) returned: success
for more information about preemptible VM instances.' type: bool
returned: success masterAuth:
type: bool description:
masterAuth: - The authentication information for accessing the master endpoint.
description: returned: success
- The authentication information for accessing the master endpoint. type: complex
returned: success contains:
type: complex username:
contains: description:
username: - The username to use for HTTP basic authentication to the master endpoint.
description: returned: success
- The username to use for HTTP basic authentication to the master endpoint. type: str
returned: success password:
type: str description:
password: - The password to use for HTTP basic authentication to the master endpoint. Because
description: the master endpoint is open to the Internet, you should create a strong password.
- The password to use for HTTP basic authentication to the master endpoint. returned: success
Because the master endpoint is open to the Internet, you should create a strong type: str
password. clusterCaCertificate:
returned: success description:
type: str - Base64-encoded public certificate that is the root of trust for the cluster.
clusterCaCertificate: returned: success
description: type: str
- Base64-encoded public certificate that is the root of trust for the cluster. clientCertificate:
returned: success description:
type: str - Base64-encoded public certificate used by clients to authenticate to the cluster
clientCertificate: endpoint.
description: returned: success
- Base64-encoded public certificate used by clients to authenticate to the cluster type: str
endpoint. clientKey:
returned: success description:
type: str - Base64-encoded private key used by clients to authenticate to the cluster endpoint.
clientKey: returned: success
description: type: str
- Base64-encoded private key used by clients to authenticate to the cluster loggingService:
endpoint. description:
returned: success - 'The logging service the cluster should use to write logs. Currently available options: logging.googleapis.com
type: str - the Google Cloud Logging service.'
loggingService: - none - no logs will be exported from the cluster.
description: - if left as an empty string,logging.googleapis.com will be used.
- 'The logging service the cluster should use to write logs. Currently available returned: success
options: logging.googleapis.com - the Google Cloud Logging service.' type: str
- none - no logs will be exported from the cluster. monitoringService:
- if left as an empty string,logging.googleapis.com will be used. description:
returned: success - The monitoring service the cluster should use to write metrics.
type: str - 'Currently available options: monitoring.googleapis.com - the Google Cloud Monitoring
monitoringService: service.'
description: - none - no metrics will be exported from the cluster.
- The monitoring service the cluster should use to write metrics. - if left as an empty string, monitoring.googleapis.com will be used.
- 'Currently available options: monitoring.googleapis.com - the Google Cloud Monitoring returned: success
service.' type: str
- none - no metrics will be exported from the cluster. network:
- if left as an empty string, monitoring.googleapis.com will be used. description:
returned: success - The name of the Google Compute Engine network to which the cluster is connected.
type: str If left unspecified, the default network will be used.
network: - To ensure it exists and it is operations, configure the network using 'gcompute_network'
description: resource.
- The name of the Google Compute Engine network to which the cluster is connected. returned: success
If left unspecified, the default network will be used. type: str
returned: success clusterIpv4Cidr:
type: str description:
privateClusterConfig: - The IP address range of the container pods in this cluster, in CIDR notation (e.g.
description: 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block
- Configuration for a private cluster. in 10.0.0.0/8.
returned: success returned: success
type: complex type: str
contains: addonsConfig:
enablePrivateNodes: description:
description: - Configurations for the various addons available to run in the cluster.
- Whether nodes have internal IP addresses only. If enabled, all nodes are given returned: success
only RFC 1918 private addresses and communicate with the master via private type: complex
networking. contains:
returned: success httpLoadBalancing:
type: bool description:
enablePrivateEndpoint: - Configuration for the HTTP (L7) load balancing controller addon, which makes it
description: easy to set up HTTP load balancers for services in a cluster.
- Whether the master's internal IP address is used as the cluster endpoint. returned: success
returned: success type: complex
type: bool contains:
masterIpv4CidrBlock: disabled:
description: description:
- The IP range in CIDR notation to use for the hosted master network. This range - Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled,
will be used for assigning internal IP addresses to the master or set of masters, it runs a small pod in the cluster that manages the load balancers.
as well as the ILB VIP. This range must not overlap with any other ranges returned: success
in use within the cluster's network. type: bool
returned: success horizontalPodAutoscaling:
type: str description:
privateEndpoint: - Configuration for the horizontal pod autoscaling feature, which increases or decreases
description: the number of replica pods a replication controller has based on the resource usage
- The internal IP address of this cluster's master endpoint. of the existing pods.
returned: success returned: success
type: str type: complex
publicEndpoint: contains:
description: disabled:
- The external IP address of this cluster's master endpoint. description:
returned: success - Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled,
type: str it ensures that a Heapster pod is running in the cluster, which is also used by
clusterIpv4Cidr: the Cloud Monitoring service.
description: returned: success
- The IP address range of the container pods in this cluster, in CIDR notation (e.g. type: bool
10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block subnetwork:
in 10.0.0.0/8. description:
returned: success - The name of the Google Compute Engine subnetwork to which the cluster is connected.
type: str returned: success
addonsConfig: type: str
description: location:
- Configurations for the various addons available to run in the cluster. description:
returned: success - The list of Google Compute Engine locations in which the cluster's nodes should
type: complex be located.
contains: returned: success
httpLoadBalancing: type: list
description: endpoint:
- Configuration for the HTTP (L7) load balancing controller addon, which makes description:
it easy to set up HTTP load balancers for services in a cluster. - The IP address of this cluster's master endpoint.
returned: success - The endpoint can be accessed from the internet at https://username:password@endpoint/ See
type: complex the masterAuth property of this resource for username and password information.
contains: returned: success
disabled: type: str
description: initialClusterVersion:
- Whether the HTTP Load Balancing controller is enabled in the cluster. description:
When enabled, it runs a small pod in the cluster that manages the load - The software version of the master endpoint and kubelets used in the cluster when
balancers. it was first created. The version can be upgraded over time.
returned: success returned: success
type: bool type: str
horizontalPodAutoscaling: currentMasterVersion:
description: description:
- Configuration for the horizontal pod autoscaling feature, which increases - The current software version of the master endpoint.
or decreases the number of replica pods a replication controller has based returned: success
on the resource usage of the existing pods. type: str
returned: success currentNodeVersion:
type: complex description:
contains: - The current version of the node software components. If they are currently at multiple
disabled: versions because they're in the process of being upgraded, this reflects the minimum
description: version of all nodes.
- Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. returned: success
When enabled, it ensures that a Heapster pod is running in the cluster, type: str
which is also used by the Cloud Monitoring service. createTime:
returned: success description:
type: bool - The time the cluster was created, in RFC3339 text format.
subnetwork: returned: success
description: type: str
- The name of the Google Compute Engine subnetwork to which the cluster is connected. nodeIpv4CidrSize:
returned: success description:
type: str - The size of the address space on each node for hosting containers.
endpoint: - This is provisioned from within the container_ipv4_cidr range.
description: returned: success
- The IP address of this cluster's master endpoint. type: int
- The endpoint can be accessed from the internet at https://username:password@endpoint/ servicesIpv4Cidr:
See the masterAuth property of this resource for username and password information. description:
returned: success - The IP address range of the Kubernetes services in this cluster, in CIDR notation
type: str (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the
initialClusterVersion: container CIDR.
description: returned: success
- The software version of the master endpoint and kubelets used in the cluster when type: str
it was first created. The version can be upgraded over time. currentNodeCount:
returned: success description:
type: str - The number of nodes currently in the cluster.
currentMasterVersion: returned: success
description: type: int
- The current software version of the master endpoint. expireTime:
returned: success description:
type: str - The time the cluster will be automatically deleted in RFC3339 text format.
currentNodeVersion: returned: success
description: type: str
- The current version of the node software components. If they are currently at zone:
multiple versions because they're in the process of being upgraded, this reflects description:
the minimum version of all nodes. - The zone where the cluster is deployed.
returned: success returned: success
type: str type: str
createTime:
description:
- The time the cluster was created, in RFC3339 text format.
returned: success
type: str
nodeIpv4CidrSize:
description:
- The size of the address space on each node for hosting containers.
- This is provisioned from within the container_ipv4_cidr range.
returned: success
type: int
servicesIpv4Cidr:
description:
- The IP address range of the Kubernetes services in this cluster, in CIDR notation
(e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the
container CIDR.
returned: success
type: str
currentNodeCount:
description:
- The number of nodes currently in the cluster.
returned: success
type: int
expireTime:
description:
- The time the cluster will be automatically deleted in RFC3339 text format.
returned: success
type: str
location:
description:
- The location where the cluster is deployed.
returned: success
type: str
''' '''
################################################################################ ################################################################################

358
plugins/modules/gcp_container_node_pool.py
View file

@ -239,187 +239,185 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
name: name:
description:
- The name of the node pool.
returned: success
type: str
config:
description:
- The node configuration of the pool.
returned: success
type: complex
contains:
machineType:
description:
- The name of a Google Compute Engine machine type (e.g.
- n1-standard-1). If unspecified, the default machine type is n1-standard-1.
returned: success
type: str
diskSizeGb:
description:
- Size of the disk attached to each node, specified in GB. The smallest allowed
disk size is 10GB. If unspecified, the default disk size is 100GB.
returned: success
type: int
oauthScopes:
description:
- The set of Google API scopes to be made available on all of the node VMs under
the "default" service account.
- 'The following scopes are recommended, but not required, and by default are
not included: U(https://www.googleapis.com/auth/compute) is required for mounting
persistent storage on your nodes.'
- U(https://www.googleapis.com/auth/devstorage.read_only) is required for communicating
with gcr.io (the Google Container Registry).
- If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring
are enabled, in which case their required scopes will be added.
returned: success
type: list
serviceAccount:
description:
- The Google Cloud Platform Service Account to be used by the node VMs. If no
Service Account is specified, the "default" service account is used.
returned: success
type: str
metadata:
description:
- 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
in length. These are reflected as part of a URL in the metadata server. Additionally,
to avoid ambiguity, keys must not conflict with any other metadata keys for
the project or be one of the four reserved keys: "instance-template", "kube-env",
"startup-script", and "user-data" Values are free-form strings, and only have
meaning as interpreted by the image running in the instance. The only restriction
placed on them is that each value''s size must be less than or equal to 32
KB.'
- The total size of all keys and values must be less than 512 KB.
- 'An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success
type: dict
imageType:
description:
- The image type to use for this node. Note that for a given image type, the
latest version of it will be used.
returned: success
type: str
labels:
description:
- '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
to the node. In case of conflict in label keys, the applied set may differ
depending on the Kubernetes version -- it''s best to assume the behavior is
undefined and conflicts should be avoided. For more information, including
usage and the valid values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html)
An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success
type: dict
localSsdCount:
description:
- 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
on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits)
for more information.'
returned: success
type: int
tags:
description:
- The list of instance tags applied to all nodes. Tags are used to identify
valid sources or targets for network firewalls and are specified by the client
during cluster or node pool creation. Each tag within the list must comply
with RFC1035.
returned: success
type: list
preemptible:
description:
- '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.'
returned: success
type: bool
initialNodeCount:
description:
- The initial node count for the pool. You must ensure that your Compute Engine
resource quota is sufficient for this number of instances. You must also have
available firewall and routes quota.
returned: success
type: int
version:
description:
- The version of the Kubernetes of this node.
returned: success
type: str
autoscaling:
description:
- Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid
configuration is present.
returned: success
type: complex
contains:
enabled:
description:
- Is autoscaling enabled for this node pool.
returned: success
type: bool
minNodeCount:
description:
- Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount.
returned: success
type: int
maxNodeCount:
description:
- Maximum number of nodes in the NodePool. Must be >= minNodeCount.
- There has to enough quota to scale up the cluster.
returned: success
type: int
management:
description:
- Management configuration for this NodePool.
returned: success
type: complex
contains:
autoUpgrade:
description:
- A flag that specifies whether node auto-upgrade is enabled for the node pool.
If enabled, node auto-upgrade helps keep the nodes in your node pool up to
date with the latest release version of Kubernetes.
returned: success
type: bool
autoRepair:
description:
- A flag that specifies whether the node auto-repair is enabled for the node
pool. If enabled, the nodes in this node pool will be monitored and, if they
fail health checks too many times, an automatic repair action will be triggered.
returned: success
type: bool
upgradeOptions:
description:
- Specifies the Auto Upgrade knobs for the node pool.
returned: success
type: complex
contains:
autoUpgradeStartTime:
description:
- This field is set when upgrades are about to commence with the approximate
start time for the upgrades, in RFC3339 text format.
returned: success
type: str
description: description:
description: - The name of the node pool.
- This field is set when upgrades are about to commence with the description returned: success
of the upgrade. type: str
returned: success config:
type: str description:
cluster: - The node configuration of the pool.
description: returned: success
- The cluster this node pool belongs to. type: complex
returned: success contains:
type: dict machineType:
location: description:
description: - The name of a Google Compute Engine machine type (e.g.
- The location where the node pool is deployed. - n1-standard-1). If unspecified, the default machine type is n1-standard-1.
returned: success returned: success
type: str type: str
diskSizeGb:
description:
- Size of the disk attached to each node, specified in GB. The smallest allowed disk
size is 10GB. If unspecified, the default disk size is 100GB.
returned: success
type: int
oauthScopes:
description:
- The set of Google API scopes to be made available on all of the node VMs under the
"default" service account.
- 'The following scopes are recommended, but not required, and by default are not
included: U(https://www.googleapis.com/auth/compute) is required for mounting persistent
storage on your nodes.'
- U(https://www.googleapis.com/auth/devstorage.read_only) is required for communicating
with gcr.io (the Google Container Registry).
- If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are
enabled, in which case their required scopes will be added.
returned: success
type: list
serviceAccount:
description:
- The Google Cloud Platform Service Account to be used by the node VMs. If no Service
Account is specified, the "default" service account is used.
returned: success
type: str
metadata:
description:
- 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 in length.
These are reflected as part of a URL in the metadata server. Additionally, to avoid
ambiguity, keys must not conflict with any other metadata keys for the project or
be one of the four reserved keys: "instance-template", "kube-env", "startup-script",
and "user-data" Values are free-form strings, and only have meaning as interpreted
by the image running in the instance. The only restriction placed on them is that
each value''s size must be less than or equal to 32 KB.'
- The total size of all keys and values must be less than 512 KB.
- 'An object containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success
type: dict
imageType:
description:
- The image type to use for this node. Note that for a given image type, the latest
version of it will be used.
returned: success
type: str
labels:
description:
- '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 to
the node. In case of conflict in label keys, the applied set may differ depending
on the Kubernetes version -- it''s best to assume the behavior is undefined and
conflicts should be avoided. For more information, including usage and the valid
values, see: U(http://kubernetes.io/v1.1/docs/user-guide/labels.html) An object
containing a list of "key": value pairs.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success
type: dict
localSsdCount:
description:
- 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
on a machine per zone. See: U(https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits) for
more information.'
returned: success
type: int
tags:
description:
- The list of instance tags applied to all nodes. Tags are used to identify valid
sources or targets for network firewalls and are specified by the client during
cluster or node pool creation. Each tag within the list must comply with RFC1035.
returned: success
type: list
preemptible:
description:
- 'Whether the nodes are created as preemptible VM instances. See: U(https://cloud.google.com/compute/docs/instances/preemptible)
for more inforamtion about preemptible VM instances.'
returned: success
type: bool
initialNodeCount:
description:
- The initial node count for the pool. You must ensure that your Compute Engine resource
quota is sufficient for this number of instances. You must also have available firewall
and routes quota.
returned: success
type: int
version:
description:
- The version of the Kubernetes of this node.
returned: success
type: str
autoscaling:
description:
- Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid
configuration is present.
returned: success
type: complex
contains:
enabled:
description:
- Is autoscaling enabled for this node pool.
returned: success
type: bool
minNodeCount:
description:
- Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount.
returned: success
type: int
maxNodeCount:
description:
- Maximum number of nodes in the NodePool. Must be >= minNodeCount.
- There has to enough quota to scale up the cluster.
returned: success
type: int
management:
description:
- Management configuration for this NodePool.
returned: success
type: complex
contains:
autoUpgrade:
description:
- A flag that specifies whether node auto-upgrade is enabled for the node pool. If
enabled, node auto-upgrade helps keep the nodes in your node pool up to date with
the latest release version of Kubernetes.
returned: success
type: bool
autoRepair:
description:
- A flag that specifies whether the node auto-repair is enabled for the node pool.
If enabled, the nodes in this node pool will be monitored and, if they fail health
checks too many times, an automatic repair action will be triggered.
returned: success
type: bool
upgradeOptions:
description:
- Specifies the Auto Upgrade knobs for the node pool.
returned: success
type: complex
contains:
autoUpgradeStartTime:
description:
- This field is set when upgrades are about to commence with the approximate start
time for the upgrades, in RFC3339 text format.
returned: success
type: str
description:
description:
- This field is set when upgrades are about to commence with the description of the
upgrade.
returned: success
type: str
cluster:
description:
- The cluster this node pool belongs to.
returned: success
type: dict
zone:
description:
- The zone where the node pool is deployed.
returned: success
type: str
''' '''
################################################################################ ################################################################################

114
plugins/modules/gcp_dns_managed_zone.py
View file

@ -121,79 +121,47 @@ 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:
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
type: str type: str
id: id:
description: description:
- Unique identifier for the resource; defined by the server. - Unique identifier for the resource; defined by the server.
returned: success returned: success
type: int type: int
name: name:
description: description:
- User assigned name for this resource. - User assigned name for this resource.
- Must be unique within the project. - Must be unique within the project.
returned: success returned: success
type: str type: str
nameServers: 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
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.

126
plugins/modules/gcp_pubsub_subscription.py
View file

@ -164,90 +164,48 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
name: name:
description: description:
- Name of the subscription. - Name of the subscription.
returned: success returned: success
type: str type: str
topic: topic:
description: description:
- A reference to a Topic resource. - A reference to a Topic resource.
returned: success returned: success
type: dict type: dict
labels: pushConfig:
description: description:
- A set of key/value label pairs to assign to this Subscription. - If push delivery is used with this subscription, this field is used to configure
returned: success it. An empty pushConfig signifies that the subscriber will pull and ack messages
type: dict using API methods.
pushConfig: returned: success
description: type: complex
- If push delivery is used with this subscription, this field is used to configure contains:
it. An empty pushConfig signifies that the subscriber will pull and ack messages pushEndpoint:
using API methods. description:
returned: success - A URL locating the endpoint to which messages should be pushed.
type: complex - For example, a Webhook endpoint might use "U(https://example.com/push".)
contains: returned: success
pushEndpoint: type: str
description: ackDeadlineSeconds:
- A URL locating the endpoint to which messages should be pushed. description:
- For example, a Webhook endpoint might use "U(https://example.com/push".) - This value is the maximum time after a subscriber receives a message before the
returned: success subscriber should acknowledge the message. After message delivery but before the
type: str ack deadline expires and before the message is acknowledged, it is an outstanding
attributes: message and will not be delivered again during that time (on a best-effort basis).
description: - For pull subscriptions, this value is used as the initial value for the ack deadline.
- Endpoint configuration attributes. To override this value for a given message, call subscriptions.modifyAckDeadline
- Every endpoint has a set of API supported attributes that can be used to control with the corresponding ackId if using pull. The minimum custom deadline you can
different aspects of the message delivery. specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds
- The currently supported attribute is x-goog-version, which you can use to (10 minutes).
change the format of the pushed message. This attribute indicates the version - If this parameter is 0, a default value of 10 seconds is used.
of the data expected by the endpoint. This controls the shape of the pushed - For push delivery, this value is also used to set the request timeout for the call
message (i.e., its fields and metadata). The endpoint version is based on to the push endpoint.
the version of the Pub/Sub API. - If the subscriber never acknowledges the message, the Pub/Sub system will eventually
- If not present during the subscriptions.create call, it will default to the redeliver the message.
version of the API used to make such call. If not present during a subscriptions.modifyPushConfig returned: success
call, its value will not be changed. subscriptions.get calls will always return type: int
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:
description:
- 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
ack deadline expires and before the message is acknowledged, it is an outstanding
message and will not be delivered again during that time (on a best-effort basis).
- For pull subscriptions, this value is used as the initial value for the ack deadline.
To override this value for a given message, call subscriptions.modifyAckDeadline
with the corresponding ackId if using pull. The minimum custom deadline you can
specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds
(10 minutes).
- 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
call to the push endpoint.
- If the subscriber never acknowledges the message, the Pub/Sub system will eventually
redeliver the message.
returned: success
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

38
plugins/modules/gcp_spanner_database.py
View file

@ -100,25 +100,25 @@ EXAMPLES = '''
''' '''
RETURN = ''' 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].
returned: success The final segment of the name must be between 6 and 30 characters in length.
type: str returned: success
extraStatements: type: str
description: extraStatements:
- 'An optional list of DDL statements to run inside the newly created database. description:
Statements can create tables, indexes, etc. These statements execute atomically - 'An optional list of DDL statements to run inside the newly created database. Statements
with the creation of the database: if there is an error in any statement, the can create tables, indexes, etc. These statements execute atomically with the creation
database is not created.' of the database: if there is an error in any statement, the database is not created.'
returned: success returned: success
type: list type: list
instance: instance:
description: description:
- The instance to create the database on. - The instance to create the database on.
returned: success returned: success
type: dict type: dict
''' '''
################################################################################ ################################################################################

78
plugins/modules/gcp_spanner_instance.py
View file

@ -98,39 +98,51 @@ EXAMPLES = '''
''' '''
RETURN = ''' 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].
returned: success The final segment of the name must be between 6 and 30 characters in length.
type: str returned: success
config: type: str
description: config:
- The name of the instance's configuration (similar but not quite the same as a description:
region) which defines defines the geographic placement and replication of your - A reference to the instance configuration.
databases in this instance. It determines where your data is stored. Values are returned: success
typically of the form `regional-europe-west1` , `us-central` etc. type: str
- In order to obtain a valid list please consult the [Configuration section of the displayName:
docs](U(https://cloud.google.com/spanner/docs/instances).) description:
returned: success - The descriptive name for this instance as it appears in UIs. Must be unique per
type: str project and between 4 and 30 characters in length.
displayName: returned: success
description: type: str
- The descriptive name for this instance as it appears in UIs. Must be unique per nodeCount:
project and between 4 and 30 characters in length. description:
returned: success - The number of nodes allocated to this instance.
type: str returned: success
nodeCount: type: int
description: labels:
- The number of nodes allocated to this instance. description:
returned: success - Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources
type: int into groups that reflect a customer's organizational needs and deployment strategies.
labels: Cloud Labels can be used to filter collections of resources. They can be used to
description: control how resource metrics are aggregated. And they can be used as arguments to
- 'An object containing a list of "key": value pairs.' policy management rules (e.g. route, firewall, load balancing, etc.).
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' - 'Label keys must be between 1 and 63 characters long and must conform to the following
returned: success regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.'
type: dict - 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.'
- 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
returned: success
type: dict
''' '''
################################################################################ ################################################################################

163
plugins/modules/gcp_sql_instance.py
View file

@ -335,41 +335,96 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
backendType: backendType:
description: description:
- "* FIRST_GEN: First Generation instance. MySQL only." - "* FIRST_GEN: First Generation instance. MySQL only."
- "* SECOND_GEN: Second Generation instance or PostgreSQL instance." - "* SECOND_GEN: Second Generation instance or PostgreSQL instance."
- "* EXTERNAL: A database server that is not managed by Google." - "* EXTERNAL: A database server that is not managed by Google."
returned: success returned: success
type: str type: str
connectionName: connectionName:
description: description:
- Connection name of the Cloud SQL instance used in connection strings. - Connection name of the Cloud SQL instance used in connection strings.
returned: success returned: success
type: str type: str
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

731
plugins/modules/gcp_storage_bucket.py
View file

@ -351,373 +351,372 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
acl: acl:
description: description:
- Access controls on the bucket. - Access controls on the bucket.
returned: success returned: success
type: complex type: complex
contains: contains:
bucket: bucket:
description: description:
- The name of the bucket. - The name of the bucket.
returned: success returned: success
type: dict type: dict
domain: domain:
description: description:
- The domain associated with the entity. - The domain associated with the entity.
returned: success returned: success
type: str type: str
email: email:
description: description:
- The email address associated with the entity. - The email address associated with the entity.
returned: success returned: success
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 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:
description: description:
- The ID for the entity. - The ID for the entity.
returned: success returned: success
type: str type: str
id:
description:
- The ID of the access-control entry.
returned: success
type: str
projectTeam:
description:
- The project team associated with the entity.
returned: success
type: complex
contains:
projectNumber:
description:
- The project team associated with the entity.
returned: success
type: str
team:
description:
- The team.
returned: success
type: str
role:
description:
- The access permission for the entity.
returned: success
type: str
cors:
description:
- The bucket's Cross-Origin Resource Sharing (CORS) configuration.
returned: success
type: complex
contains:
maxAgeSeconds:
description:
- The value, in seconds, to return in the Access-Control-Max-Age header used in preflight
responses.
returned: success
type: int
method:
description:
- 'The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS,
POST, etc) Note: "*" is permitted in the list of methods, and means "any method".'
returned: success
type: list
origin:
description:
- The list of Origins eligible to receive CORS response headers.
- 'Note: "*" is permitted in the list of origins, and means "any Origin".'
returned: success
type: list
responseHeader:
description:
- The list of HTTP headers other than the simple response headers to give permission
for the user-agent to share across domains.
returned: success
type: list
defaultObjectAcl:
description:
- Default access controls to apply to new objects when no ACL is provided.
returned: success
type: complex
contains:
bucket:
description:
- The name of the bucket.
returned: success
type: dict
domain:
description:
- The domain associated with the entity.
returned: success
type: str
email:
description:
- The email address associated with the entity.
returned: success
type: str
entity:
description:
- '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
allAuthenticatedUsers Examples: The user liz@example.com would be
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
type: str
entityId:
description:
- The ID for the entity.
returned: success
type: str
generation:
description:
- The content generation of the object, if applied to an object.
returned: success
type: int
id:
description:
- The ID of the access-control entry.
returned: success
type: str
object:
description:
- The name of the object, if applied to an object.
returned: success
type: str
projectTeam:
description:
- The project team associated with the entity.
returned: success
type: complex
contains:
projectNumber:
description:
- The project team associated with the entity.
returned: success
type: str
team:
description:
- The team.
returned: success
type: str
role:
description:
- The access permission for the entity.
returned: success
type: str
id: id:
description: description:
- The ID of the access-control entry. - The ID of the bucket. For buckets, the id and name properities are the same.
returned: success returned: success
type: str type: str
projectTeam: lifecycle:
description: description:
- The project team associated with the entity. - The bucket's lifecycle configuration.
returned: success - See U(https://developers.google.com/storage/docs/lifecycle) for more information.
type: complex returned: success
contains: type: complex
projectNumber: contains:
description: rule:
- The project team associated with the entity. description:
returned: success - A lifecycle management rule, which is made of an action to take and the condition(s)
type: str under which the action will be taken.
team: returned: success
description: type: complex
- The team. contains:
returned: success action:
type: str description:
role: - The action to take.
description: returned: success
- The access permission for the entity. type: complex
returned: success contains:
type: str storageClass:
cors: description:
description: - Target storage class. Required iff the type of the action is SetStorageClass.
- The bucket's Cross-Origin Resource Sharing (CORS) configuration. returned: success
returned: success type: str
type: complex type:
contains: description:
maxAgeSeconds: - Type of the action. Currently, only Delete and SetStorageClass are supported.
description: returned: success
- The value, in seconds, to return in the Access-Control-Max-Age header used type: str
in preflight responses. condition:
returned: success description:
type: int - The condition(s) under which the action will be taken.
method: returned: success
description: type: complex
- 'The list of HTTP methods on which to include CORS response headers, (GET, contains:
OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means ageDays:
"any method".' description:
returned: success - Age of an object (in days). This condition is satisfied when an object reaches the
type: list specified age.
origin: returned: success
description: type: int
- The list of Origins eligible to receive CORS response headers. createdBefore:
- 'Note: "*" is permitted in the list of origins, and means "any Origin".' description:
returned: success - A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
type: list This condition is satisfied when an object is created before midnight of the specified
responseHeader: date in UTC.
description: returned: success
- The list of HTTP headers other than the simple response headers to give permission type: str
for the user-agent to share across domains. isLive:
returned: success description:
type: list - Relevant only for versioned objects. If the value is true, this condition matches
defaultObjectAcl: live objects; if the value is false, it matches archived objects.
description: returned: success
- Default access controls to apply to new objects when no ACL is provided. type: bool
returned: success matchesStorageClass:
type: complex description:
contains: - Objects having any of the storage classes specified by this condition will be matched.
bucket: Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
description: returned: success
- The name of the bucket. type: list
returned: success numNewerVersions:
type: dict description:
domain: - Relevant only for versioned objects. If the value is N, this condition is satisfied
description: when there are at least N versions (including the live version) newer than this
- The domain associated with the entity. version of the object.
returned: success returned: success
type: str type: int
email: location:
description: description:
- The email address associated with the entity. - The location of the bucket. Object data for objects in the bucket resides in physical
returned: success storage within this region. Defaults to US. See the developer's guide for the authoritative
type: str list.
entity: returned: success
description: type: str
- 'The entity holding the permission, in one of the following forms: * user-{{userId}} logging:
* user-{{email}} (such as "user-liz@example.com") * group-{{groupId}} * group-{{email}} description:
(such as "group-example@googlegroups.com") * domain-{{domain}} (such as "domain-example.com") - The bucket's logging configuration, which defines the destination bucket and optional
* project-team-{{projectId}} * allUsers * allAuthenticatedUsers .' name prefix for the current bucket's logs.
returned: success returned: success
type: str type: complex
entityId: contains:
description: logBucket:
- The ID for the entity. description:
returned: success - The destination bucket where the current bucket's logs should be placed.
type: str returned: success
generation: type: str
description: logObjectPrefix:
- The content generation of the object, if applied to an object. description:
returned: success - A prefix for log object names.
type: int returned: success
id: type: str
description: metageneration:
- The ID of the access-control entry. description:
returned: success - The metadata generation of this bucket.
type: str returned: success
object: type: int
description: name:
- The name of the object, if applied to an object. description:
returned: success - The name of the bucket.
type: str returned: success
projectTeam: type: str
description: owner:
- The project team associated with the entity. description:
returned: success - The owner of the bucket. This is always the project team's owner group.
type: complex returned: success
contains: type: complex
projectNumber: contains:
description: entity:
- The project team associated with the entity. description:
returned: success - The entity, in the form project-owner-projectId.
type: str returned: success
team: type: str
description: entityId:
- The team. description:
returned: success - The ID for the entity.
type: str returned: success
role: type: str
description: projectNumber:
- The access permission for the entity. description:
returned: success - The project number of the project the bucket belongs to.
type: str returned: success
id: type: int
description: storageClass:
- The ID of the bucket. For buckets, the id and name properities are the same. description:
returned: success - The bucket's default storage class, used whenever no storageClass is specified for
type: str a newly-created object. This defines how objects in the bucket are stored and determines
lifecycle: the SLA and the cost of storage.
description: - Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY.
- The bucket's lifecycle configuration. If this value is not specified when the bucket is created, it will default to STANDARD.
- See U(https://developers.google.com/storage/docs/lifecycle) for more information. For more information, see storage classes.
returned: success returned: success
type: complex type: str
contains: timeCreated:
rule: description:
description: - The creation time of the bucket in RFC 3339 format.
- A lifecycle management rule, which is made of an action to take and the condition(s) returned: success
under which the action will be taken. type: str
returned: success updated:
type: complex description:
contains: - The modification time of the bucket in RFC 3339 format.
action: returned: success
description: type: str
- The action to take. versioning:
returned: success description:
type: complex - The bucket's versioning configuration.
contains: returned: success
storageClass: type: complex
description: contains:
- Target storage class. Required iff the type of the action is SetStorageClass. enabled:
returned: success description:
type: str - While set to true, versioning is fully enabled for this bucket.
type: returned: success
description: type: bool
- Type of the action. Currently, only Delete and SetStorageClass are website:
supported. description:
returned: success - The bucket's website configuration, controlling how the service behaves when accessing
type: str bucket contents as a web site. See the Static Website Examples for more information.
condition: returned: success
description: type: complex
- The condition(s) under which the action will be taken. contains:
returned: success mainPageSuffix:
type: complex description:
contains: - If the requested object path is missing, the service will ensure the path has a
ageDays: trailing '/', append this suffix, and attempt to retrieve the resulting object.
description: This allows the creation of index.html objects to represent directory pages.
- Age of an object (in days). This condition is satisfied when an object returned: success
reaches the specified age. type: str
returned: success notFoundPage:
type: int description:
createdBefore: - If the requested object path is missing, and any mainPageSuffix object is missing,
description: if applicable, the service will return the named object from this bucket as the
- A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). content for a 404 Not Found result.
This condition is satisfied when an object is created before midnight returned: success
of the specified date in UTC. type: str
returned: success project:
type: str description:
isLive: - A valid API project identifier.
description: returned: success
- Relevant only for versioned objects. If the value is true, this condition type: str
matches live objects; if the value is false, it matches archived objects. predefinedDefaultObjectAcl:
returned: success description:
type: bool - Apply a predefined set of default object access controls to this bucket.
matchesStorageClass: - 'Acceptable values are: - "authenticatedRead": Object owner gets OWNER access,
description: and allAuthenticatedUsers get READER access.'
- Objects having any of the storage classes specified by this condition - '- "bucketOwnerFullControl": Object owner gets OWNER access, and project team
will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, owners get OWNER access.'
COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. - '- "bucketOwnerRead": Object owner gets OWNER access, and project team owners
returned: success get READER access.'
type: list - '- "private": Object owner gets OWNER access.'
numNewerVersions: - '- "projectPrivate": Object owner gets OWNER access, and project team members
description: get access according to their roles.'
- Relevant only for versioned objects. If the value is N, this condition - '- "publicRead": Object owner gets OWNER access, and allUsers get READER access.'
is satisfied when there are at least N versions (including the live returned: success
version) newer than this version of the object. type: str
returned: success
type: int
location:
description:
- 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
authoritative list.
returned: success
type: str
logging:
description:
- The bucket's logging configuration, which defines the destination bucket and optional
name prefix for the current bucket's logs.
returned: success
type: complex
contains:
logBucket:
description:
- The destination bucket where the current bucket's logs should be placed.
returned: success
type: str
logObjectPrefix:
description:
- A prefix for log object names.
returned: success
type: str
metageneration:
description:
- The metadata generation of this bucket.
returned: success
type: int
name:
description:
- The name of the bucket.
returned: success
type: str
owner:
description:
- The owner of the bucket. This is always the project team's owner group.
returned: success
type: complex
contains:
entity:
description:
- The entity, in the form project-owner-projectId.
returned: success
type: str
entityId:
description:
- The ID for the entity.
returned: success
type: str
projectNumber:
description:
- The project number of the project the bucket belongs to.
returned: success
type: int
storageClass:
description:
- The bucket's default storage class, used whenever no storageClass is specified
for a newly-created object. This defines how objects in the bucket are stored
and determines the SLA and the cost of storage.
- 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
STANDARD. For more information, see storage classes.
returned: success
type: str
timeCreated:
description:
- The creation time of the bucket in RFC 3339 format.
returned: success
type: str
updated:
description:
- The modification time of the bucket in RFC 3339 format.
returned: success
type: str
versioning:
description:
- The bucket's versioning configuration.
returned: success
type: complex
contains:
enabled:
description:
- While set to true, versioning is fully enabled for this bucket.
returned: success
type: bool
website:
description:
- The bucket's website configuration, controlling how the service behaves when accessing
bucket contents as a web site. See the Static Website Examples for more information.
returned: success
type: complex
contains:
mainPageSuffix:
description:
- If the requested object path is missing, the service will ensure the path
has a trailing '/', append this suffix, and attempt to retrieve the resulting
object. This allows the creation of index.html objects to represent directory
pages.
returned: success
type: str
notFoundPage:
description:
- If the requested object path is missing, and any mainPageSuffix object is
missing, if applicable, the service will return the named object from this
bucket as the content for a 404 Not Found result.
returned: success
type: str
project:
description:
- A valid API project identifier.
returned: success
type: str
predefinedDefaultObjectAcl:
description:
- Apply a predefined set of default object access controls to this bucket.
- 'Acceptable values are: - "authenticatedRead": Object owner gets OWNER access,
and allAuthenticatedUsers get READER access.'
- '- "bucketOwnerFullControl": Object owner gets OWNER access, and project team
owners get OWNER access.'
- '- "bucketOwnerRead": Object owner gets OWNER access, and project team owners
get READER access.'
- '- "private": Object owner gets OWNER access.'
- '- "projectPrivate": Object owner gets OWNER access, and project team members
get access according to their roles.'
- '- "publicRead": Object owner gets OWNER access, and allUsers get READER access.'
returned: success
type: str
''' '''
################################################################################ ################################################################################

113
plugins/modules/gcp_storage_bucket_access_control.py
View file

@ -128,62 +128,63 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
bucket: bucket:
description: description:
- The name of the bucket. - The name of the bucket.
returned: success returned: success
type: dict type: dict
domain: domain:
description: description:
- The domain associated with the entity. - The domain associated with the entity.
returned: success returned: success
type: str type: str
email: email:
description: description:
- The email address associated with the entity. - The email address associated with the entity.
returned: success returned: success
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 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
- The group example@googlegroups.com would be group-example@googlegroups.com. user-liz@example.com.'
- To refer to all members of the Google Apps for Business domain example.com, the - The group example@googlegroups.com would be group-example@googlegroups.com.
entity would be domain-example.com. - To refer to all members of the Google Apps for Business domain example.com, the
returned: success entity would be domain-example.com.
type: str returned: success
entityId: type: str
description: entityId:
- The ID for the entity. description:
returned: success - The ID for the entity.
type: str returned: success
id: type: str
description: id:
- The ID of the access-control entry. description:
returned: success - The ID of the access-control entry.
type: str returned: success
projectTeam: type: str
description: projectTeam:
- The project team associated with the entity. description:
returned: success - The project team associated with the entity.
type: complex returned: success
contains: type: complex
projectNumber: contains:
description: projectNumber:
- The project team associated with the entity. description:
returned: success - The project team associated with the entity.
type: str returned: success
team: type: str
description: team:
- The team. description:
returned: success - The team.
type: str returned: success
role: type: str
description: role:
- The access permission for the entity. description:
returned: success - The access permission for the entity.
type: str returned: success
type: str
''' '''
################################################################################ ################################################################################