diff --git a/plugins/modules/gcp_compute_address.py b/plugins/modules/gcp_compute_address.py index 8e6bdc3..ebc56bb 100644 --- a/plugins/modules/gcp_compute_address.py +++ b/plugins/modules/gcp_compute_address.py @@ -131,69 +131,61 @@ EXAMPLES = ''' ''' RETURN = ''' -address: - description: - - 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 - be inside the specified subnetwork, if any. - returned: success - type: str -addressType: - description: - - The type of address to reserve, either INTERNAL or EXTERNAL. - - If unspecified, defaults to EXTERNAL. - returned: success - type: str -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -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 -networkTier: - description: - - 'The networking tier used for configuring this address. This field can take the - following values: PREMIUM or STANDARD. If this field is not specified, it is assumed - to be PREMIUM.' - returned: success - type: str -subnetwork: - description: - - The URL of the subnetwork in which to reserve the address. If an IP address is - specified, it must be within the subnetwork's IP range. - - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER - purposes. - returned: success - type: dict -users: - description: - - The URLs of the resources that are using this address. - 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 + address: + description: + - 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 + be inside the specified subnetwork, if any. + returned: success + type: str + addressType: + description: + - The type of address to reserve, either INTERNAL or EXTERNAL. + - If unspecified, defaults to EXTERNAL. + returned: success + type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + 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 + subnetwork: + description: + - The URL of the subnetwork in which to reserve the address. If an IP address is specified, + it must be within the subnetwork's IP range. + - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. + returned: success + type: dict + users: + description: + - The URLs of the resources that are using this address. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_address_facts.py b/plugins/modules/gcp_compute_address_facts.py index 5ba825f..d8f02be 100644 --- a/plugins/modules/gcp_compute_address_facts.py +++ b/plugins/modules/gcp_compute_address_facts.py @@ -65,74 +65,66 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - address: - description: - - 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 be inside the specified subnetwork, if any. - returned: success - type: str - addressType: - description: - - The type of address to reserve, either INTERNAL or EXTERNAL. - - If unspecified, defaults to EXTERNAL. - returned: success - type: str - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - type: int - 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 - networkTier: - description: - - 'The networking tier used for configuring this address. This field can take - the following values: PREMIUM or STANDARD. If this field is not specified, - it is assumed to be PREMIUM.' - returned: success - type: str - subnetwork: - description: - - The URL of the subnetwork in which to reserve the address. If an IP address - is specified, it must be within the subnetwork's IP range. - - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER - purposes. - returned: success - type: dict - users: - description: - - The URLs of the resources that are using this address. - 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 +items: + description: List of items + returned: always + type: complex + contains: + address: + description: + - 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 + be inside the specified subnetwork, if any. + returned: success + type: str + addressType: + description: + - The type of address to reserve, either INTERNAL or EXTERNAL. + - If unspecified, defaults to EXTERNAL. + returned: success + type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + 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 + subnetwork: + description: + - The URL of the subnetwork in which to reserve the address. If an IP address is specified, + it must be within the subnetwork's IP range. + - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. + returned: success + type: dict + users: + description: + - The URLs of the resources that are using this address. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_backend_bucket.py b/plugins/modules/gcp_compute_backend_bucket.py index 9db83ca..445fa0d 100644 --- a/plugins/modules/gcp_compute_backend_bucket.py +++ b/plugins/modules/gcp_compute_backend_bucket.py @@ -120,59 +120,42 @@ EXAMPLES = ''' ''' RETURN = ''' -bucketName: - description: - - Cloud Storage bucket name. - returned: success - type: str -cdnPolicy: - description: - - Cloud CDN configuration for this Backend Bucket. - returned: success - type: complex - contains: - signedUrlCacheMaxAgeSec: - description: - - Maximum number of seconds the response to a signed URL request will be considered - fresh. Defaults to 1hr (3600s). After this time period, the response will - be revalidated before being served. - - 'When serving responses to signed URL requests, Cloud CDN will internally - behave as though all responses from this backend had a "Cache-Control: public, - max-age=[TTL]" header, regardless of any existing Cache-Control header. The - actual headers served in responses will not be altered.' - returned: success - type: int -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional textual description of the resource; provided by the client when the - resource is created. - returned: success - type: str -enableCdn: - description: - - If true, enable Cloud CDN for this BackendBucket. - 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 + bucketName: + description: + - Cloud Storage bucket name. + returned: success + type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional textual description of the resource; provided by the client when the + resource is created. + returned: success + type: str + enableCdn: + description: + - If true, enable Cloud CDN for this BackendBucket. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_backend_bucket_facts.py b/plugins/modules/gcp_compute_backend_bucket_facts.py index 6239d87..d7408f2 100644 --- a/plugins/modules/gcp_compute_backend_bucket_facts.py +++ b/plugins/modules/gcp_compute_backend_bucket_facts.py @@ -59,64 +59,47 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - bucketName: - description: - - Cloud Storage bucket name. - returned: success - type: str - cdnPolicy: - description: - - Cloud CDN configuration for this Backend Bucket. - returned: success - type: complex - contains: - signedUrlCacheMaxAgeSec: - description: - - Maximum number of seconds the response to a signed URL request will be - considered fresh. Defaults to 1hr (3600s). After this time period, the - response will be revalidated before being served. - - 'When serving responses to signed URL requests, Cloud CDN will internally - behave as though all responses from this backend had a "Cache-Control: - public, max-age=[TTL]" header, regardless of any existing Cache-Control - header. The actual headers served in responses will not be altered.' - returned: success - type: int - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional textual description of the resource; provided by the client when - the resource is created. - returned: success - type: str - enableCdn: - description: - - If true, enable Cloud CDN for this BackendBucket. - 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 +items: + description: List of items + returned: always + type: complex + contains: + bucketName: + description: + - Cloud Storage bucket name. + returned: success + type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional textual description of the resource; provided by the client when the + resource is created. + returned: success + type: str + enableCdn: + description: + - If true, enable Cloud CDN for this BackendBucket. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_backend_service.py b/plugins/modules/gcp_compute_backend_service.py index 082c5ce..2f92e76 100644 --- a/plugins/modules/gcp_compute_backend_service.py +++ b/plugins/modules/gcp_compute_backend_service.py @@ -341,275 +341,261 @@ EXAMPLES = ''' ''' RETURN = ''' -affinityCookieTtlSec: - description: - - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set - to 0, the cookie is non-persistent and lasts only until the end of the browser - session (or equivalent). The maximum allowed value for TTL is one day. - - When the load balancing scheme is INTERNAL, this field is not used. - returned: success - type: int -backends: - description: - - The list of backends that serve this BackendService. - returned: success - type: complex - contains: - balancingMode: - description: - - Specifies the balancing mode for this backend. - - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. - Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). - returned: success - type: str - capacityScaler: - description: - - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, - RATE or CONNECTION). - - Default value is 1, which means the group will serve up to 100% of its configured - capacity (depending on balancingMode). A setting of 0 means the group is completely - drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. - returned: success - type: str + affinityCookieTtlSec: + description: + - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to + 0, the cookie is non-persistent and lasts only until the end of the browser session + (or equivalent). The maximum allowed value for TTL is one day. + - When the load balancing scheme is INTERNAL, this field is not used. + returned: success + type: int + backends: + description: + - The list of backends that serve this BackendService. + returned: success + type: complex + contains: + balancingMode: + description: + - Specifies the balancing mode for this backend. + - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid + values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). + - This cannot be used for internal load balancing. + returned: success + type: str + capacityScaler: + description: + - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, + RATE or CONNECTION). + - Default value is 1, which means the group will serve up to 100% of its configured + capacity (depending on balancingMode). A setting of 0 means the group is completely + drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. + - This cannot be used for internal load balancing. + returned: success + type: str + description: + description: + - An optional description of this resource. + - 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: - - An optional description of this resource. - - Provide this property when you create the resource. - returned: success - type: str - group: - description: - - The fully-qualified URL of an Instance Group or Network Endpoint Group resource. - In case of instance group this 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. - - For Network Endpoint Groups this defines list of endpoints. All endpoints - of Network Endpoint Group must be hosted on instances located in the same - zone as the Network Endpoint Group. - - Backend service can not contain mix of Instance Group and Network Endpoint - Group backends. - - Note that you must specify an Instance Group or Network Endpoint Group resource - using the fully-qualified URL, rather than a partial URL. - returned: success - type: str - 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. - 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. - 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. - 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. - 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]. - 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 - 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 + description: + - An optional description of this resource. + returned: success + type: str + enableCDN: + description: + - If true, enable Cloud CDN for this BackendService. + - When the load balancing scheme is INTERNAL, this field is not used. + returned: success + type: bool + 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. + - For internal load balancing, a URL to a HealthCheck resource must be specified instead. + returned: success + type: list + id: + description: + - The unique identifier for the resource. + returned: success + type: int + 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. + 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. + - When the load balancing scheme is INTERNAL, this field is not used. + returned: success + type: str + protocol: + description: + - The protocol this BackendService uses to communicate with backends. + - Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. + - For internal load balancing, the possible values are TCP and UDP, and the default + is TCP. + returned: success + type: str + region: + description: + - The region where the regional backend service resides. + - This field is not applicable to global backend services. + returned: success + type: str + 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 load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, + or CLIENT_IP_PORT_PROTO. + - When the protocol is UDP, this field is not used. + returned: success + type: str + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_backend_service_facts.py b/plugins/modules/gcp_compute_backend_service_facts.py index f1319f4..9a4e58d 100644 --- a/plugins/modules/gcp_compute_backend_service_facts.py +++ b/plugins/modules/gcp_compute_backend_service_facts.py @@ -59,55 +59,175 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - affinityCookieTtlSec: - description: - - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If - set to 0, the cookie is non-persistent and lasts only until the end of the - browser session (or equivalent). The maximum allowed value for TTL is one - day. - - When the load balancing scheme is INTERNAL, this field is not used. - returned: success - type: int - backends: - description: - - The list of backends that serve this BackendService. - returned: success - type: complex - contains: - balancingMode: - description: - - Specifies the balancing mode for this backend. - - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. - Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). - returned: success - type: str - capacityScaler: - description: - - A multiplier applied to the group's maximum servicing capacity (based - on UTILIZATION, RATE or CONNECTION). - - Default value is 1, which means the group will serve up to 100% of its - configured capacity (depending on balancingMode). A setting of 0 means - the group is completely drained, offering 0% of its available Capacity. - Valid range is [0.0,1.0]. - returned: success - type: str +items: + description: List of items + returned: always + type: complex + contains: + affinityCookieTtlSec: + description: + - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to + 0, the cookie is non-persistent and lasts only until the end of the browser session + (or equivalent). The maximum allowed value for TTL is one day. + - When the load balancing scheme is INTERNAL, this field is not used. + returned: success + type: int + backends: + description: + - The list of backends that serve this BackendService. + returned: success + type: complex + contains: + balancingMode: + description: + - Specifies the balancing mode for this backend. + - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid + values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). + - This cannot be used for internal load balancing. + returned: success + type: str + capacityScaler: + description: + - A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, + RATE or CONNECTION). + - Default value is 1, which means the group will serve up to 100% of its configured + capacity (depending on balancingMode). A setting of 0 means the group is completely + drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. + - This cannot be used for internal load balancing. + returned: success + type: str + description: + description: + - An optional description of this resource. + - 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: - An optional description of this resource. returned: success type: str - enable_cdn: + enableCDN: description: - If true, enable Cloud CDN for this BackendService. - When the load balancing scheme is INTERNAL, this field is not used. returned: success type: bool - health_checks: + 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, @@ -131,22 +251,22 @@ resources: - Enables IAP. returned: success type: bool - oauth2_client_id: + oauth2ClientId: description: - OAuth2 Client ID for IAP. returned: success type: str - oauth2_client_secret: + oauth2ClientSecret: description: - OAuth2 Client Secret for IAP. returned: success type: str - oauth2_client_secret_sha256: + oauth2ClientSecretSha256: description: - OAuth2 Client Secret SHA-256 for IAP. returned: success type: str - load_balancing_scheme: + 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 @@ -163,7 +283,7 @@ resources: be a dash. returned: success type: str - port_name: + 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. @@ -184,7 +304,7 @@ resources: - This field is not applicable to global backend services. returned: success type: str - session_affinity: + 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. @@ -193,7 +313,7 @@ resources: - When the protocol is UDP, this field is not used. returned: success type: str - timeout_sec: + 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]. diff --git a/plugins/modules/gcp_compute_disk.py b/plugins/modules/gcp_compute_disk.py index c489ac4..50c8479 100644 --- a/plugins/modules/gcp_compute_disk.py +++ b/plugins/modules/gcp_compute_disk.py @@ -204,13 +204,13 @@ EXAMPLES = ''' ''' RETURN = ''' - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. returned: success type: str - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -226,12 +226,12 @@ RETURN = ''' - The unique identifier for the resource. returned: success type: int - last_attach_timestamp: + lastAttachTimestamp: description: - Last attach timestamp in RFC3339 text format. returned: success type: str - last_detach_timestamp: + lastDetachTimestamp: description: - Last dettach timestamp in RFC3339 text format. returned: success @@ -256,7 +256,7 @@ RETURN = ''' be a dash. returned: success type: str - size_gb: + sizeGb: description: - 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 @@ -277,7 +277,7 @@ RETURN = ''' Provide this when creating the disk. returned: success type: str - source_image: + sourceImage: description: - The source image used to create this disk. If the source image is deleted, this field will not be set. @@ -297,14 +297,14 @@ RETURN = ''' - A reference to the zone where the disk resides. returned: success type: str - source_image_encryption_key: + sourceImageEncryptionKey: description: - The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. returned: success type: complex contains: - raw_key: + rawKey: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. @@ -316,7 +316,7 @@ RETURN = ''' that protects this resource. returned: success type: str - source_image_id: + sourceImageId: description: - 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 @@ -325,7 +325,7 @@ RETURN = ''' was used. returned: success type: str - disk_encryption_key: + diskEncryptionKey: description: - Encrypts the disk using a customer-supplied encryption key. - After you encrypt a disk with a customer-supplied key, you must provide the same @@ -338,7 +338,7 @@ RETURN = ''' returned: success type: complex contains: - raw_key: + rawKey: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. @@ -350,7 +350,7 @@ RETURN = ''' that protects this resource. returned: success type: str - source_snapshot: + sourceSnapshot: description: - '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: * @@ -358,14 +358,14 @@ RETURN = ''' * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` .' returned: success type: dict - source_snapshot_encryption_key: + sourceSnapshotEncryptionKey: description: - The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. returned: success type: complex contains: - raw_key: + rawKey: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. @@ -377,7 +377,7 @@ RETURN = ''' that protects this resource. returned: success type: str - source_snapshot_id: + sourceSnapshotId: description: - 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 diff --git a/plugins/modules/gcp_compute_disk_facts.py b/plugins/modules/gcp_compute_disk_facts.py index 510526a..e76be89 100644 --- a/plugins/modules/gcp_compute_disk_facts.py +++ b/plugins/modules/gcp_compute_disk_facts.py @@ -69,13 +69,13 @@ items: returned: always type: complex contains: - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. returned: success type: str - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -91,12 +91,12 @@ items: - The unique identifier for the resource. returned: success type: int - last_attach_timestamp: + lastAttachTimestamp: description: - Last attach timestamp in RFC3339 text format. returned: success type: str - last_detach_timestamp: + lastDetachTimestamp: description: - Last dettach timestamp in RFC3339 text format. returned: success @@ -121,7 +121,7 @@ items: be a dash. returned: success type: str - size_gb: + sizeGb: description: - 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 @@ -142,7 +142,7 @@ items: Provide this when creating the disk. returned: success type: str - source_image: + sourceImage: description: - The source image used to create this disk. If the source image is deleted, this field will not be set. @@ -162,14 +162,14 @@ items: - A reference to the zone where the disk resides. returned: success type: str - source_image_encryption_key: + sourceImageEncryptionKey: description: - The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. returned: success type: complex contains: - raw_key: + rawKey: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. @@ -181,7 +181,7 @@ items: that protects this resource. returned: success type: str - source_image_id: + sourceImageId: description: - 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 @@ -190,7 +190,7 @@ items: was used. returned: success type: str - disk_encryption_key: + diskEncryptionKey: description: - Encrypts the disk using a customer-supplied encryption key. - After you encrypt a disk with a customer-supplied key, you must provide the same @@ -203,7 +203,7 @@ items: returned: success type: complex contains: - raw_key: + rawKey: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. @@ -215,7 +215,7 @@ items: that protects this resource. returned: success type: str - source_snapshot: + sourceSnapshot: description: - '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: * @@ -223,14 +223,14 @@ items: * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` .' returned: success type: dict - source_snapshot_encryption_key: + sourceSnapshotEncryptionKey: description: - The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. returned: success type: complex contains: - raw_key: + rawKey: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. @@ -242,7 +242,7 @@ items: that protects this resource. returned: success type: str - source_snapshot_id: + sourceSnapshotId: description: - 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 diff --git a/plugins/modules/gcp_compute_firewall.py b/plugins/modules/gcp_compute_firewall.py index 14ae00d..f943655 100644 --- a/plugins/modules/gcp_compute_firewall.py +++ b/plugins/modules/gcp_compute_firewall.py @@ -365,7 +365,7 @@ RETURN = ''' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' returned: success type: list - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -398,7 +398,7 @@ RETURN = ''' the resource. returned: success type: str - destination_ranges: + destinationRanges: description: - 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 @@ -447,7 +447,7 @@ RETURN = ''' precedence over ALLOW rules having equal priority. returned: success type: int - source_ranges: + sourceRanges: description: - 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. @@ -457,7 +457,7 @@ RETURN = ''' does not need to match both properties for the firewall to apply. Only IPv4 is supported. returned: success type: list - source_service_accounts: + sourceServiceAccounts: description: - 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 @@ -470,7 +470,7 @@ RETURN = ''' cannot be used at the same time as sourceTags or targetTags. returned: success type: list - source_tags: + sourceTags: description: - 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 @@ -482,7 +482,7 @@ RETURN = ''' firewall to apply. returned: success type: list - target_service_accounts: + targetServiceAccounts: description: - A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. @@ -491,7 +491,7 @@ RETURN = ''' applies to all instances on the specified network. returned: success type: list - target_tags: + targetTags: description: - A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. diff --git a/plugins/modules/gcp_compute_firewall_facts.py b/plugins/modules/gcp_compute_firewall_facts.py index cc8b30e..89f55a2 100644 --- a/plugins/modules/gcp_compute_firewall_facts.py +++ b/plugins/modules/gcp_compute_firewall_facts.py @@ -86,7 +86,7 @@ items: - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' returned: success type: list - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -119,7 +119,7 @@ items: the resource. returned: success type: str - destination_ranges: + destinationRanges: description: - 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 @@ -168,7 +168,7 @@ items: precedence over ALLOW rules having equal priority. returned: success type: int - source_ranges: + sourceRanges: description: - 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. @@ -178,7 +178,7 @@ items: does not need to match both properties for the firewall to apply. Only IPv4 is supported. returned: success type: list - source_service_accounts: + sourceServiceAccounts: description: - 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 @@ -191,7 +191,7 @@ items: cannot be used at the same time as sourceTags or targetTags. returned: success type: list - source_tags: + sourceTags: description: - 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 @@ -203,7 +203,7 @@ items: firewall to apply. returned: success type: list - target_service_accounts: + targetServiceAccounts: description: - A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. @@ -212,7 +212,7 @@ items: applies to all instances on the specified network. returned: success type: list - target_tags: + targetTags: description: - A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. diff --git a/plugins/modules/gcp_compute_forwarding_rule.py b/plugins/modules/gcp_compute_forwarding_rule.py index 12b4d52..2804c76 100644 --- a/plugins/modules/gcp_compute_forwarding_rule.py +++ b/plugins/modules/gcp_compute_forwarding_rule.py @@ -263,7 +263,7 @@ EXAMPLES = ''' ''' RETURN = ''' - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -279,7 +279,7 @@ RETURN = ''' - The unique identifier for the resource. returned: success type: int - ip_address: + IPAddress: description: - 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 @@ -300,27 +300,27 @@ RETURN = ''' * global/addresses/address * address .' returned: success type: str - ip_protocol: + IPProtocol: description: - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid. returned: success type: str - backend_service: + backendService: description: - A reference to a BackendService to receive the matched traffic. - This is used for internal load balancing. - "(not used for external load balancing) ." returned: success type: dict - ip_version: + ipVersion: description: - 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. returned: success type: str - load_balancing_scheme: + loadBalancingScheme: description: - '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 @@ -347,7 +347,7 @@ RETURN = ''' - This field is not used for external load balancing. returned: success type: dict - port_range: + portRange: description: - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. @@ -390,7 +390,7 @@ RETURN = ''' - This field is not used for internal load balancing. returned: success type: dict - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. diff --git a/plugins/modules/gcp_compute_forwarding_rule_facts.py b/plugins/modules/gcp_compute_forwarding_rule_facts.py index a5eb37c..c26dc93 100644 --- a/plugins/modules/gcp_compute_forwarding_rule_facts.py +++ b/plugins/modules/gcp_compute_forwarding_rule_facts.py @@ -70,7 +70,7 @@ items: returned: always type: complex contains: - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -86,7 +86,7 @@ items: - The unique identifier for the resource. returned: success type: int - ip_address: + IPAddress: description: - 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 @@ -107,27 +107,27 @@ items: * global/addresses/address * address .' returned: success type: str - ip_protocol: + IPProtocol: description: - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid. returned: success type: str - backend_service: + backendService: description: - A reference to a BackendService to receive the matched traffic. - This is used for internal load balancing. - "(not used for external load balancing) ." returned: success type: dict - ip_version: + ipVersion: description: - 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. returned: success type: str - load_balancing_scheme: + loadBalancingScheme: description: - '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 @@ -154,7 +154,7 @@ items: - This field is not used for external load balancing. returned: success type: dict - port_range: + portRange: description: - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. @@ -197,7 +197,7 @@ items: - This field is not used for internal load balancing. returned: success type: dict - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. diff --git a/plugins/modules/gcp_compute_global_address.py b/plugins/modules/gcp_compute_global_address.py index 6b80898..0c599e7 100644 --- a/plugins/modules/gcp_compute_global_address.py +++ b/plugins/modules/gcp_compute_global_address.py @@ -107,7 +107,7 @@ RETURN = ''' - The static external IP address represented by this resource. returned: success type: str - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -133,13 +133,13 @@ RETURN = ''' be a dash. returned: success type: str - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. returned: success type: str - ip_version: + ipVersion: description: - The IP Version that will be used by this address. Valid options are IPV4 or IPV6. The default value is IPV4. diff --git a/plugins/modules/gcp_compute_global_address_facts.py b/plugins/modules/gcp_compute_global_address_facts.py index 3c008df..2df6368 100644 --- a/plugins/modules/gcp_compute_global_address_facts.py +++ b/plugins/modules/gcp_compute_global_address_facts.py @@ -69,7 +69,7 @@ items: - The static external IP address represented by this resource. returned: success type: str - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -95,13 +95,13 @@ items: be a dash. returned: success type: str - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. returned: success type: str - ip_version: + ipVersion: description: - The IP Version that will be used by this address. Valid options are IPV4 or IPV6. The default value is IPV4. diff --git a/plugins/modules/gcp_compute_global_forwarding_rule.py b/plugins/modules/gcp_compute_global_forwarding_rule.py index 7f74198..34c87ab 100644 --- a/plugins/modules/gcp_compute_global_forwarding_rule.py +++ b/plugins/modules/gcp_compute_global_forwarding_rule.py @@ -234,105 +234,137 @@ EXAMPLES = ''' ''' RETURN = ''' -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 -id: - description: - - The unique identifier for the resource. - returned: success - type: int -IPAddress: - description: - - 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 or INTERNAL) and scope (global or regional). - - 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 - in the same region as the forwarding rule. If this field is empty, an ephemeral - IPv4 address from the same scope (global or regional) will be assigned. A regional - forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 - or IPv6. - - 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, - if this field is empty, an ephemeral internal IP address will be automatically - allocated from the IP range of the subnet or network configured for this forwarding - rule. - - 'An address can be specified either by a literal IP address or a URL reference - to an existing Address resource. The following examples are all valid: * 100.1.2.3 - * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) - * projects/project/regions/region/addresses/address * regions/region/addresses/address - * global/addresses/address * address .' - returned: success - type: str -IPProtocol: - description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCP - is valid. - returned: success - type: str -ipVersion: - description: - - The IP Version that will be used by this global forwarding rule. - - Valid options are IPV4 or IPV6. - returned: success - type: str -loadBalancingScheme: - description: - - This signifies what the GlobalForwardingRule will be used for. - - 'The value of INTERNAL_SELF_MANAGED means that this will be used for Internal - Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External - Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) NOTE: Currently - global forwarding rules cannot be used for INTERNAL load balancing.' - returned: success - 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 -network: - description: - - This field is not used for external load balancing. - - For INTERNAL_SELF_MANAGED load balancing, this field identifies the network that - the load balanced IP should belong to for this global forwarding rule. If this - field is not specified, the default network will be used. - returned: success - type: dict -portRange: - description: - - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, - TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. - - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to - ports in the specified range will be forwarded to target. - - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint - port ranges. - - 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy: - 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, - 465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110, 143, 195, 443, - 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: 500, 4500 .' - returned: success - type: str -target: - description: - - The URL of the target resource to receive the matched traffic. - - The forwarded traffic must be of a type appropriate to the target object. - returned: success - type: str + 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 + id: + description: + - The unique identifier for the resource. + returned: success + type: int + IPAddress: + description: + - 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 + or INTERNAL) and scope (global or regional). + - 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 in + the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 + address from the same scope (global or regional) will be assigned. A regional forwarding + rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. + - 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, + if this field is empty, an ephemeral internal IP address will be automatically allocated + from the IP range of the subnet or network configured for this forwarding rule. + - 'An address can be specified either by a literal IP address or a URL reference to + an existing Address resource. The following examples are all valid: * 100.1.2.3 + * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) + * projects/project/regions/region/addresses/address * regions/region/addresses/address + * global/addresses/address * address .' + returned: success + type: str + IPProtocol: + description: + - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, + SCTP or ICMP. + - When the load balancing scheme is INTERNAL, only TCP and UDP are valid. + returned: success + type: str + backendService: + description: + - A reference to a BackendService to receive the matched traffic. + - This is used for internal load balancing. + - "(not used for external load balancing) ." + returned: success + type: dict + ipVersion: + description: + - 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. + returned: success + type: str + loadBalancingScheme: + description: + - '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 + Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this + will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + .' + 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 + network: + description: + - For internal load balancing, this field identifies the network that the load balanced + IP should belong to for this Forwarding Rule. If this field is not specified, the + default network will be used. + - This field is not used for external load balancing. + returned: success + type: dict + portRange: + description: + - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, + TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. + - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to + ports in the specified range will be forwarded to target. + - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port + ranges. + - 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy: + 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, + 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110, + 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: + 500, 4500 .' + returned: success + type: str + ports: + description: + - This field is used along with the backend_service field for internal load balancing. + - When the load balancing scheme is INTERNAL, a single port or a comma separated list + of ports can be configured. Only packets addressed to these ports will be forwarded + to the backends configured with this forwarding rule. + - You may specify a maximum of up to 5 ports. + returned: success + type: list + subnetwork: + description: + - A reference to a subnetwork. + - For internal load balancing, this field identifies the subnetwork that the load + balanced IP should belong to for this Forwarding Rule. + - If the network specified is in auto subnet mode, this field is optional. However, + if the network is in custom subnet mode, a subnetwork must be specified. + - This field is not used for external load balancing. + returned: success + type: dict + region: + description: + - A reference to the region where the regional forwarding rule resides. + - This field is not applicable to global forwarding rules. + returned: success + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_global_forwarding_rule_facts.py b/plugins/modules/gcp_compute_global_forwarding_rule_facts.py index b6f9851..c192755 100644 --- a/plugins/modules/gcp_compute_global_forwarding_rule_facts.py +++ b/plugins/modules/gcp_compute_global_forwarding_rule_facts.py @@ -59,111 +59,142 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - 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 - id: - description: - - The unique identifier for the resource. - returned: success - type: int - IPAddress: - description: - - 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 or INTERNAL) and scope (global or regional). - - 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 in the same region as the forwarding rule. If this field is empty, - an ephemeral IPv4 address from the same scope (global or regional) will be - assigned. A regional forwarding rule supports IPv4 only. A global forwarding - rule supports either IPv4 or IPv6. - - 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, if this field is empty, an ephemeral internal IP address will - be automatically allocated from the IP range of the subnet or network configured - for this forwarding rule. - - 'An address can be specified either by a literal IP address or a URL reference - to an existing Address resource. The following examples are all valid: * 100.1.2.3 - * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) - * projects/project/regions/region/addresses/address * regions/region/addresses/address - * global/addresses/address * address .' - returned: success - type: str - IPProtocol: - description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - AH, SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, - only TCP is valid. - returned: success - type: str - ipVersion: - description: - - The IP Version that will be used by this global forwarding rule. - - Valid options are IPV4 or IPV6. - returned: success - type: str - loadBalancingScheme: - description: - - This signifies what the GlobalForwardingRule will be used for. - - 'The value of INTERNAL_SELF_MANAGED means that this will be used for Internal - Global HTTP(S) LB. The value of EXTERNAL means that this will be used for - External Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) - NOTE: Currently global forwarding rules cannot be used for INTERNAL load balancing.' - returned: success - 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 - network: - description: - - This field is not used for external load balancing. - - For INTERNAL_SELF_MANAGED load balancing, this field identifies the network - that the load balanced IP should belong to for this global forwarding rule. - If this field is not specified, the default network will be used. - returned: success - type: dict - portRange: - description: - - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, - TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. - - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed - to ports in the specified range will be forwarded to target. - - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint - port ranges. - - 'Some types of forwarding target have constraints on the acceptable ports: - * TargetHttpProxy: 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, - 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: - 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: - 500, 4500 .' - returned: success - type: str - target: - description: - - The URL of the target resource to receive the matched traffic. - - The forwarded traffic must be of a type appropriate to the target object. - returned: success - type: str +items: + description: List of items + returned: always + type: complex + contains: + 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 + id: + description: + - The unique identifier for the resource. + returned: success + type: int + IPAddress: + description: + - 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 + or INTERNAL) and scope (global or regional). + - 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 in + the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 + address from the same scope (global or regional) will be assigned. A regional forwarding + rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. + - 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, + if this field is empty, an ephemeral internal IP address will be automatically allocated + from the IP range of the subnet or network configured for this forwarding rule. + - 'An address can be specified either by a literal IP address or a URL reference to + an existing Address resource. The following examples are all valid: * 100.1.2.3 + * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) + * projects/project/regions/region/addresses/address * regions/region/addresses/address + * global/addresses/address * address .' + returned: success + type: str + IPProtocol: + description: + - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, + SCTP or ICMP. + - When the load balancing scheme is INTERNAL, only TCP and UDP are valid. + returned: success + type: str + backendService: + description: + - A reference to a BackendService to receive the matched traffic. + - This is used for internal load balancing. + - "(not used for external load balancing) ." + returned: success + type: dict + ipVersion: + description: + - 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. + returned: success + type: str + loadBalancingScheme: + description: + - '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 + Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this + will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + .' + 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 + network: + description: + - For internal load balancing, this field identifies the network that the load balanced + IP should belong to for this Forwarding Rule. If this field is not specified, the + default network will be used. + - This field is not used for external load balancing. + returned: success + type: dict + portRange: + description: + - This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, + TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. + - Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to + ports in the specified range will be forwarded to target. + - Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port + ranges. + - 'Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy: + 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, + 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110, + 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: + 500, 4500 .' + returned: success + type: str + ports: + description: + - This field is used along with the backend_service field for internal load balancing. + - When the load balancing scheme is INTERNAL, a single port or a comma separated list + of ports can be configured. Only packets addressed to these ports will be forwarded + to the backends configured with this forwarding rule. + - You may specify a maximum of up to 5 ports. + returned: success + type: list + subnetwork: + description: + - A reference to a subnetwork. + - For internal load balancing, this field identifies the subnetwork that the load + balanced IP should belong to for this Forwarding Rule. + - If the network specified is in auto subnet mode, this field is optional. However, + if the network is in custom subnet mode, a subnetwork must be specified. + - This field is not used for external load balancing. + returned: success + type: dict + region: + description: + - A reference to the region where the regional forwarding rule resides. + - This field is not applicable to global forwarding rules. + returned: success + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_health_check.py b/plugins/modules/gcp_compute_health_check.py index 2a76c9b..a18b02d 100644 --- a/plugins/modules/gcp_compute_health_check.py +++ b/plugins/modules/gcp_compute_health_check.py @@ -315,12 +315,12 @@ EXAMPLES = ''' ''' RETURN = ''' - check_interval_sec: + checkIntervalSec: description: - - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name - are defined, port takes precedence. - required: false - proxy_header: + - How often (in seconds) to send a health check. The default value is 5 seconds. + returned: success + type: int + creationTimestamp: description: - Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. @@ -336,11 +336,17 @@ RETURN = ''' suboptions: 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. - required: false - response: + - 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 bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data @@ -348,15 +354,22 @@ RETURN = ''' required: false port: description: - - The TCP port number for the TCP health check request. - - The default value is 443. - required: false - port_name: + - 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: - - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name - are defined, port takes precedence. - required: false - proxy_header: + - 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: - Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. @@ -372,281 +385,161 @@ RETURN = ''' suboptions: 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. - required: false - response: + - 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: - - The bytes to match against the beginning of the response data. If left empty - (the default value), any response will indicate health. The response data - can only be ASCII. - required: false - port: + - 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 + 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: - - The TCP port number for the SSL health check request. - - The default value is 443. - required: false - port_name: + - 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 + 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: - - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name - are defined, port takes precedence. - required: false - proxy_header: + - 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: - - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. - required: false - default: NONE - choices: - - NONE - - PROXY_V1 -extends_documentation_fragment: gcp -notes: -- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks)' -- 'Official Documentation: U(https://cloud.google.com/load-balancing/docs/health-checks)' -''' - -EXAMPLES = ''' -- name: create a health check - gcp_compute_health_check: - name: test_object - type: TCP - tcp_health_check: - port_name: service-health - request: ping - response: pong - healthy_threshold: 10 - timeout_sec: 2 - unhealthy_threshold: 5 - project: test_project - auth_kind: serviceaccount - service_account_file: "/tmp/auth.pem" - state: present -''' - -RETURN = ''' -checkIntervalSec: - description: - - How often (in seconds) to send a health check. The default value is 5 seconds. - returned: success - type: int -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str -healthyThreshold: - description: - - A so-far unhealthy instance will be marked healthy after this many consecutive - successes. The default value is 2. - returned: success - type: int -id: - description: - - The unique identifier for the resource. This identifier is defined by the server. - returned: success - type: int -name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str -timeoutSec: - description: - - How long (in seconds) to wait before claiming failure. - - The default value is 5 seconds. It is invalid for timeoutSec to have greater value - than checkIntervalSec. - returned: success - type: int -unhealthyThreshold: - description: - - A so-far healthy instance will be marked unhealthy after this many consecutive - failures. The default value is 2. - returned: success - type: int -type: - description: - - Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not - specified, the default is TCP. Exactly one of the protocol-specific health check - field must be specified, which must match type field. - returned: success - 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 + - 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_health_check_facts.py b/plugins/modules/gcp_compute_health_check_facts.py index 9c5f83d..84aabf8 100644 --- a/plugins/modules/gcp_compute_health_check_facts.py +++ b/plugins/modules/gcp_compute_health_check_facts.py @@ -59,235 +59,218 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - checkIntervalSec: - description: - - How often (in seconds) to send a health check. The default value is 5 seconds. - returned: success - type: int - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str - healthyThreshold: - description: - - A so-far unhealthy instance will be marked healthy after this many consecutive - successes. The default value is 2. - returned: success - type: int - id: - description: - - The unique identifier for the resource. This identifier is defined by the - server. - returned: success - type: int - name: - description: - - Name of the resource. Provided by the client when the resource is created. - The name must be 1-63 characters long, and comply with RFC1035. Specifically, - the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str - timeoutSec: - description: - - How long (in seconds) to wait before claiming failure. - - The default value is 5 seconds. It is invalid for timeoutSec to have greater - value than checkIntervalSec. - returned: success - type: int - unhealthyThreshold: - description: - - A so-far healthy instance will be marked unhealthy after this many consecutive - failures. The default value is 2. - returned: success - type: int - type: - description: - - Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If - not specified, the default is TCP. Exactly one of the protocol-specific health - check field must be specified, which must match type field. - returned: success - 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 +items: + description: List of items + returned: always + type: complex + contains: + checkIntervalSec: + description: + - How often (in seconds) to send a health check. The default value is 5 seconds. + returned: success + type: int + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + healthyThreshold: + description: + - A so-far unhealthy instance will be marked healthy after this many consecutive successes. + The default value is 2. + returned: success + type: int + id: + description: + - The unique identifier for the resource. This identifier is defined by the server. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + timeoutSec: + description: + - How long (in seconds) to wait before claiming failure. + - The default value is 5 seconds. It is invalid for timeoutSec to have greater value + than checkIntervalSec. + returned: success + type: int + unhealthyThreshold: + description: + - A so-far healthy instance will be marked unhealthy after this many consecutive failures. + The default value is 2. + returned: success + type: int + type: + description: + - Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, + the default is TCP. Exactly one of the protocol-specific health check field must + be specified, which must match type field. + returned: success + 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 + 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 + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_http_health_check.py b/plugins/modules/gcp_compute_http_health_check.py index 9df7a40..1acf2ac 100644 --- a/plugins/modules/gcp_compute_http_health_check.py +++ b/plugins/modules/gcp_compute_http_health_check.py @@ -124,75 +124,75 @@ EXAMPLES = ''' ''' RETURN = ''' -checkIntervalSec: - description: - - How often (in seconds) to send a health check. The default value is 5 seconds. - returned: success - type: int -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str -healthyThreshold: - description: - - A so-far unhealthy instance will be marked healthy after this many consecutive - successes. The default value is 2. - returned: success - type: int -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 -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 -port: - description: - - The TCP port number for the HTTP health check request. - - The default value is 80. - returned: success - type: int -requestPath: - description: - - The request path of the HTTP health check request. - - The default value is /. - 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 + checkIntervalSec: + description: + - How often (in seconds) to send a health check. The default value is 5 seconds. + returned: success + type: int + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + healthyThreshold: + description: + - A so-far unhealthy instance will be marked healthy after this many consecutive successes. + The default value is 2. + returned: success + type: int + 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 + 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 + port: + description: + - The TCP port number for the HTTP health check request. + - The default value is 80. + returned: success + type: int + requestPath: + description: + - The request path of the HTTP health check request. + - The default value is /. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_http_health_check_facts.py b/plugins/modules/gcp_compute_http_health_check_facts.py index 45014c8..928e8c6 100644 --- a/plugins/modules/gcp_compute_http_health_check_facts.py +++ b/plugins/modules/gcp_compute_http_health_check_facts.py @@ -59,81 +59,80 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - checkIntervalSec: - description: - - How often (in seconds) to send a health check. The default value is 5 seconds. - returned: success - type: int - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str - healthyThreshold: - description: - - A so-far unhealthy instance will be marked healthy after this many consecutive - successes. The default value is 2. - returned: success - type: int - 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 - 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 - port: - description: - - The TCP port number for the HTTP health check request. - - The default value is 80. - returned: success - type: int - requestPath: - description: - - The request path of the HTTP health check request. - - The default value is /. - 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 +items: + description: List of items + returned: always + type: complex + contains: + checkIntervalSec: + description: + - How often (in seconds) to send a health check. The default value is 5 seconds. + returned: success + type: int + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + healthyThreshold: + description: + - A so-far unhealthy instance will be marked healthy after this many consecutive successes. + The default value is 2. + returned: success + type: int + 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 + 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 + port: + description: + - The TCP port number for the HTTP health check request. + - The default value is 80. + returned: success + type: int + requestPath: + description: + - The request path of the HTTP health check request. + - The default value is /. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_https_health_check.py b/plugins/modules/gcp_compute_https_health_check.py index 1486960..9e5d9fe 100644 --- a/plugins/modules/gcp_compute_https_health_check.py +++ b/plugins/modules/gcp_compute_https_health_check.py @@ -121,75 +121,75 @@ EXAMPLES = ''' ''' RETURN = ''' -checkIntervalSec: - description: - - How often (in seconds) to send a health check. The default value is 5 seconds. - returned: success - type: int -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str -healthyThreshold: - description: - - A so-far unhealthy instance will be marked healthy after this many consecutive - successes. The default value is 2. - returned: success - type: int -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 -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 -port: - description: - - The TCP port number for the HTTPS health check request. - - The default value is 80. - returned: success - type: int -requestPath: - description: - - The request path of the HTTPS health check request. - - The default value is /. - 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 + checkIntervalSec: + description: + - How often (in seconds) to send a health check. The default value is 5 seconds. + returned: success + type: int + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + healthyThreshold: + description: + - A so-far unhealthy instance will be marked healthy after this many consecutive successes. + The default value is 2. + returned: success + type: int + 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 + 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 + port: + description: + - The TCP port number for the HTTPS health check request. + - The default value is 80. + returned: success + type: int + requestPath: + description: + - The request path of the HTTPS health check request. + - The default value is /. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_https_health_check_facts.py b/plugins/modules/gcp_compute_https_health_check_facts.py index a9c7d5b..557af76 100644 --- a/plugins/modules/gcp_compute_https_health_check_facts.py +++ b/plugins/modules/gcp_compute_https_health_check_facts.py @@ -59,81 +59,80 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - checkIntervalSec: - description: - - How often (in seconds) to send a health check. The default value is 5 seconds. - returned: success - type: int - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str - healthyThreshold: - description: - - A so-far unhealthy instance will be marked healthy after this many consecutive - successes. The default value is 2. - returned: success - type: int - 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 - 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 - port: - description: - - The TCP port number for the HTTPS health check request. - - The default value is 80. - returned: success - type: int - requestPath: - description: - - The request path of the HTTPS health check request. - - The default value is /. - 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 +items: + description: List of items + returned: always + type: complex + contains: + checkIntervalSec: + description: + - How often (in seconds) to send a health check. The default value is 5 seconds. + returned: success + type: int + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + healthyThreshold: + description: + - A so-far unhealthy instance will be marked healthy after this many consecutive successes. + The default value is 2. + returned: success + type: int + 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 + 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 + port: + description: + - The TCP port number for the HTTPS health check request. + - The default value is 80. + returned: success + type: int + requestPath: + description: + - The request path of the HTTPS health check request. + - The default value is /. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_image.py b/plugins/modules/gcp_compute_image.py index dbf20ef..ebfd473 100644 --- a/plugins/modules/gcp_compute_image.py +++ b/plugins/modules/gcp_compute_image.py @@ -210,214 +210,202 @@ EXAMPLES = ''' ''' RETURN = ''' -archiveSizeBytes: - description: - - Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). - returned: success - type: int -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - 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 + archiveSizeBytes: + description: + - Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). + returned: success + type: int + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str deprecated: - description: - - An optional RFC3339 timestamp on or after which the state of this resource - is intended to change to DEPRECATED. This is only informational and the status - will not change unless the client explicitly changes it. - returned: success - type: str - obsolete: - description: - - An optional RFC3339 timestamp on or after which the state of this resource - is intended to change to OBSOLETE. This is only informational and the status - will not change unless the client explicitly changes it. - returned: success - type: str - replacement: - description: - - The URL of the suggested replacement for a deprecated resource. - - The suggested replacement resource must be the same kind of resource as the - deprecated resource. - returned: success - type: str - state: - description: - - The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, - or DELETED. Operations which create a new resource using a DEPRECATED resource - will return successfully, but with a warning indicating the deprecated resource - and recommending its replacement. Operations which use OBSOLETE or DELETED - resources will be rejected and result in an error. - returned: success - type: str -description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str -diskSizeGb: - description: - - Size of the image when restored onto a persistent disk (in GB). - returned: success - type: int -family: - description: - - The name of the image family to which this image belongs. You can create disks - by specifying an image family instead of a specific image name. The image family - always returns its latest image that is not deprecated. The name of the image - family must comply with RFC1035. - returned: success - type: str -guestOsFeatures: - description: - - A list of features to enable on the guest OS. Applicable for bootable images only. - Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows - each virtual CPU to have its own queue. For Windows images, you can only enable - VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux - images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. - - For new Windows images, the server might also populate this field with the value - WINDOWS, to indicate that this is a Windows image. - - This value is purely informational and does not enable or disable any features. - returned: success - type: complex - contains: - type: - description: - - The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. - For newer Windows images, the server might also populate this property with - the value WINDOWS to indicate that this is a Windows image. This value is - purely informational and does not enable or disable any features. - returned: success - type: str -id: - description: - - The unique identifier for the resource. This identifier is defined by the server. - returned: success - type: int -imageEncryptionKey: - description: - - Encrypts the image using a customer-supplied encryption key. - - After you encrypt an image with a customer-supplied key, you must provide the - same key if you use the image later (e.g. to create a disk from the image) . - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - key that protects this resource. - returned: success - type: str -labels: - description: - - Labels to apply to this Image. - returned: success - type: dict -labelFingerprint: - description: - - The fingerprint used for optimistic locking of this resource. Used internally - during updates. - returned: success - type: str -licenses: - description: - - Any applicable license URI. - returned: success - type: list -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 -rawDisk: - description: - - The parameters of the raw disk image. - returned: success - type: complex - contains: - containerType: - description: - - The format used to encode and transmit the block device, which should be TAR. - This is just a container and transmission format and not a runtime format. - Provided by the client when the disk image is created. - returned: success - type: str - sha1Checksum: - description: - - An optional SHA1 checksum of the disk image before unpackaging. - - This is provided by the client when the disk image is created. - returned: success - type: str - source: - description: - - The full Google Cloud Storage URL where disk storage is stored You must provide - either this property or the sourceDisk property but not both. - returned: success - type: str -sourceDisk: - description: - - The source disk to create this image based on. - - You must provide either this property or the rawDisk.source property but not both - to create an image. - returned: success - type: dict -sourceDiskEncryptionKey: - description: - - The customer-supplied encryption key of the source disk. Required if the source - disk is protected by a customer-supplied encryption key. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - key that protects this resource. - returned: success - type: str -sourceDiskId: - description: - - The ID value of the disk used to create this image. This value may be used to - determine whether the image was taken from the current or a previous instance - of a given disk name. - returned: success - type: str -sourceType: - description: - - The type of the image used to create this disk. The default and only value is - RAW . - returned: success - type: str + 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: + description: + - An optional RFC3339 timestamp on or after which the state of this resource is intended + to change to DEPRECATED. This is only informational and the status will not change + unless the client explicitly changes it. + returned: success + type: str + obsolete: + description: + - An optional RFC3339 timestamp on or after which the state of this resource is intended + to change to OBSOLETE. This is only informational and the status will not change + unless the client explicitly changes it. + returned: success + type: str + replacement: + description: + - The URL of the suggested replacement for a deprecated resource. + - The suggested replacement resource must be the same kind of resource as the deprecated + resource. + returned: success + type: str + state: + description: + - The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. + Operations which create a new resource using a DEPRECATED resource will return successfully, + but with a warning indicating the deprecated resource and recommending its replacement. + Operations which use OBSOLETE or DELETED resources will be rejected and result in + an error. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + diskSizeGb: + description: + - Size of the image when restored onto a persistent disk (in GB). + returned: success + type: int + family: + description: + - The name of the image family to which this image belongs. You can create disks by + specifying an image family instead of a specific image name. The image family always + returns its latest image that is not deprecated. The name of the image family must + comply with RFC1035. + returned: success + type: str + guestOsFeatures: + description: + - A list of features to enable on the guest OS. Applicable for bootable images only. + Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows + each virtual CPU to have its own queue. For Windows images, you can only enable + VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux + images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. + - For new Windows images, the server might also populate this field with the value + WINDOWS, to indicate that this is a Windows image. + - This value is purely informational and does not enable or disable any features. + returned: success + type: complex + contains: + type: + description: + - The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. + For newer Windows images, the server might also populate this property with the + value WINDOWS to indicate that this is a Windows image. This value is purely informational + and does not enable or disable any features. + returned: success + type: str + id: + description: + - The unique identifier for the resource. This identifier is defined by the server. + returned: success + type: int + imageEncryptionKey: + description: + - Encrypts the image using a customer-supplied encryption key. + - After you encrypt an image with a customer-supplied key, you must provide the same + key if you use the image later (e.g. to create a disk from the image) . + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + licenses: + description: + - Any applicable license URI. + returned: success + type: list + 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 + rawDisk: + description: + - The parameters of the raw disk image. + returned: success + type: complex + contains: + containerType: + description: + - The format used to encode and transmit the block device, which should be TAR. This + is just a container and transmission format and not a runtime format. Provided by + the client when the disk image is created. + returned: success + type: str + sha1Checksum: + description: + - An optional SHA1 checksum of the disk image before unpackaging. + - This is provided by the client when the disk image is created. + returned: success + type: str + source: + description: + - The full Google Cloud Storage URL where disk storage is stored You must provide + either this property or the sourceDisk property but not both. + returned: success + type: str + sourceDisk: + description: + - Refers to a gcompute_disk object You must provide either this property or the rawDisk.source + property but not both to create an image. + returned: success + type: dict + sourceDiskEncryptionKey: + description: + - The customer-supplied encryption key of the source disk. Required if the source + disk is protected by a customer-supplied encryption key. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + sourceDiskId: + description: + - The ID value of the disk used to create this image. This value may be used to determine + whether the image was taken from the current or a previous instance of a given disk + name. + returned: success + type: str + sourceType: + description: + - The type of the image used to create this disk. The default and only value is RAW + . + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_image_facts.py b/plugins/modules/gcp_compute_image_facts.py index 2ec2007..1f7516b 100644 --- a/plugins/modules/gcp_compute_image_facts.py +++ b/plugins/modules/gcp_compute_image_facts.py @@ -59,223 +59,207 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - archiveSizeBytes: - description: - - Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). - returned: success - type: int - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - 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 +items: + description: List of items + returned: always + type: complex + contains: + archiveSizeBytes: + description: + - Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). + returned: success + type: int + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str deprecated: - description: - - An optional RFC3339 timestamp on or after which the state of this resource - is intended to change to DEPRECATED. This is only informational and the - status will not change unless the client explicitly changes it. - returned: success - type: str - obsolete: - description: - - An optional RFC3339 timestamp on or after which the state of this resource - is intended to change to OBSOLETE. This is only informational and the - status will not change unless the client explicitly changes it. - returned: success - type: str - replacement: - description: - - The URL of the suggested replacement for a deprecated resource. - - The suggested replacement resource must be the same kind of resource as - the deprecated resource. - returned: success - type: str - state: - description: - - The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, - or DELETED. Operations which create a new resource using a DEPRECATED - resource will return successfully, but with a warning indicating the deprecated - resource and recommending its replacement. Operations which use OBSOLETE - or DELETED resources will be rejected and result in an error. - returned: success - type: str - description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str - diskSizeGb: - description: - - Size of the image when restored onto a persistent disk (in GB). - returned: success - type: int - family: - description: - - The name of the image family to which this image belongs. You can create disks - by specifying an image family instead of a specific image name. The image - family always returns its latest image that is not deprecated. The name of - the image family must comply with RFC1035. - returned: success - type: str - guestOsFeatures: - description: - - A list of features to enable on the guest OS. Applicable for bootable images - only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, - which allows each virtual CPU to have its own queue. For Windows images, you - can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 - or higher. Linux images with kernel versions 3.17 and higher will support - VIRTIO_SCSI_MULTIQUEUE. - - For new Windows images, the server might also populate this field with the - value WINDOWS, to indicate that this is a Windows image. - - This value is purely informational and does not enable or disable any features. - returned: success - type: complex - contains: - type: - description: - - The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is - supported. For newer Windows images, the server might also populate this - property with the value WINDOWS to indicate that this is a Windows image. - This value is purely informational and does not enable or disable any - features. - returned: success - type: str - id: - description: - - The unique identifier for the resource. This identifier is defined by the - server. - returned: success - type: int - imageEncryptionKey: - description: - - Encrypts the image using a customer-supplied encryption key. - - After you encrypt an image with a customer-supplied key, you must provide - the same key if you use the image later (e.g. to create a disk from the image) - . - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - key that protects this resource. - returned: success - type: str - labels: - description: - - Labels to apply to this Image. - returned: success - type: dict - labelFingerprint: - description: - - The fingerprint used for optimistic locking of this resource. Used internally - during updates. - returned: success - type: str - licenses: - description: - - Any applicable license URI. - returned: success - type: list - 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 - rawDisk: - description: - - The parameters of the raw disk image. - returned: success - type: complex - contains: - containerType: - description: - - The format used to encode and transmit the block device, which should - be TAR. This is just a container and transmission format and not a runtime - format. Provided by the client when the disk image is created. - returned: success - type: str - sha1Checksum: - description: - - An optional SHA1 checksum of the disk image before unpackaging. - - This is provided by the client when the disk image is created. - returned: success - type: str - source: - description: - - The full Google Cloud Storage URL where disk storage is stored You must - provide either this property or the sourceDisk property but not both. - returned: success - type: str - sourceDisk: - description: - - The source disk to create this image based on. - - You must provide either this property or the rawDisk.source property but not - both to create an image. - returned: success - type: dict - sourceDiskEncryptionKey: - description: - - The customer-supplied encryption key of the source disk. Required if the source - disk is protected by a customer-supplied encryption key. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - key that protects this resource. - returned: success - type: str - sourceDiskId: - description: - - The ID value of the disk used to create this image. This value may be used - to determine whether the image was taken from the current or a previous instance - of a given disk name. - returned: success - type: str - sourceType: - description: - - The type of the image used to create this disk. The default and only value - is RAW . - returned: success - type: str + 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: + description: + - An optional RFC3339 timestamp on or after which the state of this resource is intended + to change to DEPRECATED. This is only informational and the status will not change + unless the client explicitly changes it. + returned: success + type: str + obsolete: + description: + - An optional RFC3339 timestamp on or after which the state of this resource is intended + to change to OBSOLETE. This is only informational and the status will not change + unless the client explicitly changes it. + returned: success + type: str + replacement: + description: + - The URL of the suggested replacement for a deprecated resource. + - The suggested replacement resource must be the same kind of resource as the deprecated + resource. + returned: success + type: str + state: + description: + - The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. + Operations which create a new resource using a DEPRECATED resource will return successfully, + but with a warning indicating the deprecated resource and recommending its replacement. + Operations which use OBSOLETE or DELETED resources will be rejected and result in + an error. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + diskSizeGb: + description: + - Size of the image when restored onto a persistent disk (in GB). + returned: success + type: int + family: + description: + - The name of the image family to which this image belongs. You can create disks by + specifying an image family instead of a specific image name. The image family always + returns its latest image that is not deprecated. The name of the image family must + comply with RFC1035. + returned: success + type: str + guestOsFeatures: + description: + - A list of features to enable on the guest OS. Applicable for bootable images only. + Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows + each virtual CPU to have its own queue. For Windows images, you can only enable + VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux + images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. + - For new Windows images, the server might also populate this field with the value + WINDOWS, to indicate that this is a Windows image. + - This value is purely informational and does not enable or disable any features. + returned: success + type: complex + contains: + type: + description: + - The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. + For newer Windows images, the server might also populate this property with the + value WINDOWS to indicate that this is a Windows image. This value is purely informational + and does not enable or disable any features. + returned: success + type: str + id: + description: + - The unique identifier for the resource. This identifier is defined by the server. + returned: success + type: int + imageEncryptionKey: + description: + - Encrypts the image using a customer-supplied encryption key. + - After you encrypt an image with a customer-supplied key, you must provide the same + key if you use the image later (e.g. to create a disk from the image) . + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + licenses: + description: + - Any applicable license URI. + returned: success + type: list + 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 + rawDisk: + description: + - The parameters of the raw disk image. + returned: success + type: complex + contains: + containerType: + description: + - The format used to encode and transmit the block device, which should be TAR. This + is just a container and transmission format and not a runtime format. Provided by + the client when the disk image is created. + returned: success + type: str + sha1Checksum: + description: + - An optional SHA1 checksum of the disk image before unpackaging. + - This is provided by the client when the disk image is created. + returned: success + type: str + source: + description: + - The full Google Cloud Storage URL where disk storage is stored You must provide + either this property or the sourceDisk property but not both. + returned: success + type: str + sourceDisk: + description: + - Refers to a gcompute_disk object You must provide either this property or the rawDisk.source + property but not both to create an image. + returned: success + type: dict + sourceDiskEncryptionKey: + description: + - The customer-supplied encryption key of the source disk. Required if the source + disk is protected by a customer-supplied encryption key. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + sourceDiskId: + description: + - The ID value of the disk used to create this image. This value may be used to determine + whether the image was taken from the current or a previous instance of a given disk + name. + returned: success + type: str + sourceType: + description: + - The type of the image used to create this disk. The default and only value is RAW + . + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_instance.py b/plugins/modules/gcp_compute_instance.py index 5129c6c..283b094 100644 --- a/plugins/modules/gcp_compute_instance.py +++ b/plugins/modules/gcp_compute_instance.py @@ -465,400 +465,393 @@ EXAMPLES = ''' ''' RETURN = ''' -canIpForward: - description: - - Allows this instance to send and receive packets with non-matching destination - or source IPs. This is required if you plan to use this instance to forward routes. - returned: success - type: bool -cpuPlatform: - description: - - The CPU platform used by this instance. - returned: success - type: str -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -disks: - description: - - An array of disks that are associated with the instances that are created from - this template. - returned: success - type: complex - contains: - autoDelete: - description: - - Specifies whether the disk will be auto-deleted when the instance is deleted - (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 behind on machine deletion.' - returned: success - type: bool - boot: - description: - - Indicates that this is a boot disk. The virtual machine will use the first - partition of the disk for its root filesystem. - returned: success - type: bool - deviceName: - description: - - 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 - be used to reference the device for mounting, resizing, and so on, from within - the instance. - returned: success - type: str - diskEncryptionKey: - description: - - Encrypts or decrypts a disk using a customer-supplied encryption key. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - returned: success - type: str - rsaEncryptedKey: - description: - - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - encryption key to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - key that protects this resource. - returned: success - type: str - index: - description: - - Assigns a zero-based index to this disk, where 0 is reserved for the boot - disk. For example, if you have many disks attached to an instance, each disk - would have a unique index number. If not specified, the server will choose - an appropriate value. - returned: success - type: int - initializeParams: - description: - - Specifies the parameters for a new disk that will be created alongside the - new instance. Use initialization parameters to create boot disks or local - SSDs attached to the new instance. - returned: success - type: complex - contains: - diskName: - description: - - Specifies the disk name. If not specified, the default is to use the name - of the instance. - returned: success - type: str - diskSizeGb: - description: - - Specifies the size of the disk in base-2 GB. - returned: success - type: int - diskType: - description: - - Reference to a disk type. - - Specifies the disk type to use to create the instance. - - If not specified, the default is pd-standard. - returned: success - type: str - sourceImage: - description: - - The source image to create this disk. When creating a new instance, one - of initializeParams.sourceImage or disks.source is required. To create - a disk with one of the public operating system images, specify the image - by its family name. - returned: success - type: str - sourceImageEncryptionKey: - description: - - The customer-supplied encryption key of the source image. Required if - the source image is protected by a customer-supplied encryption key. - - Instance templates do not store customer-supplied encryption keys, so - you cannot create disks for instances in a managed instance group if the - source images are encrypted with your own keys. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC - 4648 base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - encryption key that protects this resource. - returned: success - type: str - interface: - description: - - Specifies the disk interface to use for attaching this disk, which is either - SCSI or NVME. The default is SCSI. - - Persistent disks must always use SCSI and the request will fail if you attempt - to attach a persistent disk in any other format than SCSI. - returned: success - type: str - mode: - description: - - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - not specified, the default is to attach the disk in READ_WRITE mode. - returned: success - type: str - source: - description: - - Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - or disks.source is required. - - If desired, you can also attach existing non-root persistent disks using this - property. This field is only applicable for persistent disks. - returned: success - type: dict - type: - description: - - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, - the default is PERSISTENT. - returned: success - type: str -guestAccelerators: - description: - - List of the type and count of accelerator cards attached to the instance . - returned: success - type: complex - contains: - acceleratorCount: - description: - - The number of the guest accelerator cards exposed to this instance. - returned: success - type: int - acceleratorType: - description: - - Full or partial URL of the accelerator type resource to expose to this instance. - returned: success - type: str -id: - description: - - The unique identifier for the resource. This identifier is defined by the server. - returned: success - type: int -labelFingerprint: - description: - - 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 -metadata: - description: - - The metadata key/value pairs to assign to instances that are created from this - template. These pairs can consist of custom metadata or predefined keys. - returned: success - type: dict -machineType: - description: - - A reference to a machine type which defines VM kind. - 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 + canIpForward: + description: + - Allows this instance to send and receive packets with non-matching destination or + source IPs. This is required if you plan to use this instance to forward routes. + returned: success + type: bool + cpuPlatform: + description: + - The CPU platform used by this instance. + returned: success + type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + disks: + description: + - An array of disks that are associated with the instances that are created from this + template. + returned: success + type: complex + contains: + autoDelete: + description: + - Specifies whether the disk will be auto-deleted when the instance is deleted (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 + behind on machine deletion.' + returned: success + type: bool + boot: + description: + - Indicates that this is a boot disk. The virtual machine will use the first partition + of the disk for its root filesystem. + returned: success + type: bool + deviceName: + description: + - 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 be used + to reference the device for mounting, resizing, and so on, from within the instance. + returned: success + type: str + diskEncryptionKey: + description: + - Encrypts or decrypts a disk using a customer-supplied encryption key. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + rsaEncryptedKey: + description: + - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption + key to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + index: + description: + - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. + For example, if you have many disks attached to an instance, each disk would have + a unique index number. If not specified, the server will choose an appropriate value. + returned: success + type: int + initializeParams: + description: + - Specifies the parameters for a new disk that will be created alongside the new instance. + Use initialization parameters to create boot disks or local SSDs attached to the + new instance. + returned: success + type: complex + contains: + diskName: + description: + - Specifies the disk name. If not specified, the default is to use the name of the + instance. + returned: success + type: str + diskSizeGb: + description: + - Specifies the size of the disk in base-2 GB. + returned: success + type: int + diskType: + description: + - Reference to a gcompute_disk_type resource. + - Specifies the disk type to use to create the instance. + - If not specified, the default is pd-standard. + returned: success + type: str + sourceImage: + description: + - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. To create a disk with one of the public operating + system images, specify the image by its family name. + returned: success + type: str + sourceImageEncryptionKey: + description: + - The customer-supplied encryption key of the source image. Required if the source + image is protected by a customer-supplied encryption key. + - Instance templates do not store customer-supplied encryption keys, so you cannot + create disks for instances in a managed instance group if the source images are + encrypted with your own keys. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + interface: + description: + - Specifies the disk interface to use for attaching this disk, which is either SCSI + or NVME. The default is SCSI. + - Persistent disks must always use SCSI and the request will fail if you attempt to + attach a persistent disk in any other format than SCSI. + returned: success + type: str + mode: + description: + - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, + the default is to attach the disk in READ_WRITE mode. + returned: success + type: str + source: + description: + - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. + - If desired, you can also attach existing non-root persistent disks using this property. + This field is only applicable for persistent disks. + returned: success + type: dict + type: + description: + - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, + the default is PERSISTENT. + returned: success + type: str + guestAccelerators: + description: + - List of the type and count of accelerator cards attached to the instance . + returned: success + type: complex + contains: + acceleratorCount: + description: + - The number of the guest accelerator cards exposed to this instance. + returned: success + type: int + acceleratorType: + description: + - Full or partial URL of the accelerator type resource to expose to this instance. + returned: success + type: str + id: + description: + - The unique identifier for the resource. This identifier is defined by the server. + returned: success + type: int + labelFingerprint: + description: + - 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 + metadata: + description: + - The metadata key/value pairs to assign to instances that are created from this template. + These pairs can consist of custom metadata or predefined keys. + returned: success + type: dict + machineType: + description: + - A reference to a machine type which defines VM kind. + 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 network interface, generated by the server. For network devices, - these are eth0, eth1, etc . - returned: success - type: str - network: - description: - - Specifies the title of an existing network. When creating an instance, if - neither the network nor the subnetwork is specified, the default network global/networks/default - is used; if the network is not specified but the subnetwork is specified, - the network is inferred. - returned: success - type: dict - networkIP: - description: - - An IPv4 internal network address to assign to the instance for this network - interface. If not specified by the user, an unused internal IP is assigned - by the system. - returned: success - type: str - subnetwork: - description: - - Reference to a VPC network. - - If the network resource is in legacy mode, do not provide this property. If - the network is in auto subnet mode, providing the subnetwork is optional. - If the network is in custom subnet mode, then this field should be specified. - returned: success - type: dict -scheduling: - description: - - Sets the scheduling options for this instance. - returned: success - type: complex - contains: - automaticRestart: - description: - - Specifies whether the instance should be automatically restarted if it is - terminated by Compute Engine (not terminated by a user). - - You can only set the automatic restart option for standard instances. Preemptible - instances cannot be automatically restarted. - returned: success - type: bool - onHostMaintenance: - 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.' - - As a user, use RUNNING to keep a machine "on" and TERMINATED to turn a machine - off . - 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 + 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: + - Specifies the title of a gcompute_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: + description: + - The name of the network interface, generated by the server. For network devices, + these are eth0, eth1, etc . + returned: success + type: str + network: + description: + - Specifies the title of an existing gcompute_network. When creating an instance, + if neither the network nor the subnetwork is specified, the default network global/networks/default + is used; if the network is not specified but the subnetwork is specified, the network + is inferred. + returned: success + type: dict + networkIP: + description: + - An IPv4 internal network address to assign to the instance for this network interface. + If not specified by the user, an unused internal IP is assigned by the system. + returned: success + type: str + subnetwork: + description: + - Reference to a gcompute_subnetwork resource. + - If the network resource is in legacy mode, do not provide this property. If the + network is in auto subnet mode, providing the subnetwork is optional. If the network + is in custom subnet mode, then this field should be specified. + returned: success + type: dict + scheduling: + description: + - Sets the scheduling options for this instance. + returned: success + type: complex + contains: + automaticRestart: + description: + - Specifies whether the instance should be automatically restarted if it is terminated + by Compute Engine (not terminated by a user). + - You can only set the automatic restart option for standard instances. Preemptible + instances cannot be automatically restarted. + returned: success + type: bool + onHostMaintenance: + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_instance_facts.py b/plugins/modules/gcp_compute_instance_facts.py index 2731853..ca9145d 100644 --- a/plugins/modules/gcp_compute_instance_facts.py +++ b/plugins/modules/gcp_compute_instance_facts.py @@ -64,411 +64,398 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - canIpForward: - description: - - Allows this instance to send and receive packets with non-matching destination - or source IPs. This is required if you plan to use this instance to forward - routes. - returned: success - type: bool - cpuPlatform: - description: - - The CPU platform used by this instance. - returned: success - type: str - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - disks: - description: - - An array of disks that are associated with the instances that are created - from this template. - returned: success - type: complex - contains: - autoDelete: - description: - - Specifies whether the disk will be auto-deleted when the instance is deleted - (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 behind on machine deletion.' - returned: success - type: bool - boot: - description: - - Indicates that this is a boot disk. The virtual machine will use the first - partition of the disk for its root filesystem. - returned: success - type: bool - deviceName: - description: - - 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 be used to reference the device for mounting, - resizing, and so on, from within the instance. - returned: success - type: str - diskEncryptionKey: - description: - - Encrypts or decrypts a disk using a customer-supplied encryption key. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC - 4648 base64 to either encrypt or decrypt this resource. - returned: success - type: str - rsaEncryptedKey: - description: - - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - encryption key to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - encryption key that protects this resource. - returned: success - type: str - index: - description: - - Assigns a zero-based index to this disk, where 0 is reserved for the boot - disk. For example, if you have many disks attached to an instance, each - disk would have a unique index number. If not specified, the server will - choose an appropriate value. - returned: success - type: int - initializeParams: - description: - - Specifies the parameters for a new disk that will be created alongside - the new instance. Use initialization parameters to create boot disks or - local SSDs attached to the new instance. - returned: success - type: complex - contains: - diskName: - description: - - Specifies the disk name. If not specified, the default is to use the - name of the instance. - returned: success - type: str - diskSizeGb: - description: - - Specifies the size of the disk in base-2 GB. - returned: success - type: int - diskType: - description: - - Reference to a disk type. - - Specifies the disk type to use to create the instance. - - If not specified, the default is pd-standard. - returned: success - type: str - sourceImage: - description: - - The source image to create this disk. When creating a new instance, - one of initializeParams.sourceImage or disks.source is required. To - create a disk with one of the public operating system images, specify - the image by its family name. - returned: success - type: str - sourceImageEncryptionKey: - description: - - The customer-supplied encryption key of the source image. Required - if the source image is protected by a customer-supplied encryption - key. - - Instance templates do not store customer-supplied encryption keys, - so you cannot create disks for instances in a managed instance group - if the source images are encrypted with your own keys. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded - in RFC 4648 base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - encryption key that protects this resource. - returned: success - type: str - interface: - description: - - Specifies the disk interface to use for attaching this disk, which is - either SCSI or NVME. The default is SCSI. - - Persistent disks must always use SCSI and the request will fail if you - attempt to attach a persistent disk in any other format than SCSI. - returned: success - type: str - mode: - description: - - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. - If not specified, the default is to attach the disk in READ_WRITE mode. - returned: success - type: str - source: - description: - - Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - or disks.source is required. - - If desired, you can also attach existing non-root persistent disks using - this property. This field is only applicable for persistent disks. - returned: success - type: dict - type: - description: - - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, - the default is PERSISTENT. - returned: success - type: str - guestAccelerators: - description: - - List of the type and count of accelerator cards attached to the instance . - returned: success - type: complex - contains: - acceleratorCount: - description: - - The number of the guest accelerator cards exposed to this instance. - returned: success - type: int - acceleratorType: - description: - - Full or partial URL of the accelerator type resource to expose to this - instance. - returned: success - type: str - id: - description: - - The unique identifier for the resource. This identifier is defined by the - server. - returned: success - type: int - labelFingerprint: - description: - - 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 - metadata: - description: - - The metadata key/value pairs to assign to instances that are created from - this template. These pairs can consist of custom metadata or predefined keys. - returned: success - type: dict - machineType: - description: - - A reference to a machine type which defines VM kind. - 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 +items: + description: List of items + returned: always + type: complex + contains: + canIpForward: + description: + - Allows this instance to send and receive packets with non-matching destination or + source IPs. This is required if you plan to use this instance to forward routes. + returned: success + type: bool + cpuPlatform: + description: + - The CPU platform used by this instance. + returned: success + type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + disks: + description: + - An array of disks that are associated with the instances that are created from this + template. + returned: success + type: complex + contains: + autoDelete: + description: + - Specifies whether the disk will be auto-deleted when the instance is deleted (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 + behind on machine deletion.' + returned: success + type: bool + boot: + description: + - Indicates that this is a boot disk. The virtual machine will use the first partition + of the disk for its root filesystem. + returned: success + type: bool + deviceName: + description: + - 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 be used + to reference the device for mounting, resizing, and so on, from within the instance. + returned: success + type: str + diskEncryptionKey: + description: + - Encrypts or decrypts a disk using a customer-supplied encryption key. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + rsaEncryptedKey: + description: + - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption + key to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + index: + description: + - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. + For example, if you have many disks attached to an instance, each disk would have + a unique index number. If not specified, the server will choose an appropriate value. + returned: success + type: int + initializeParams: + description: + - Specifies the parameters for a new disk that will be created alongside the new instance. + Use initialization parameters to create boot disks or local SSDs attached to the + new instance. + returned: success + type: complex + contains: + diskName: + description: + - Specifies the disk name. If not specified, the default is to use the name of the + instance. + returned: success + type: str + diskSizeGb: + description: + - Specifies the size of the disk in base-2 GB. + returned: success + type: int + diskType: + description: + - Reference to a gcompute_disk_type resource. + - Specifies the disk type to use to create the instance. + - If not specified, the default is pd-standard. + returned: success + type: str + sourceImage: + description: + - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. To create a disk with one of the public operating + system images, specify the image by its family name. + returned: success + type: str + sourceImageEncryptionKey: + description: + - The customer-supplied encryption key of the source image. Required if the source + image is protected by a customer-supplied encryption key. + - Instance templates do not store customer-supplied encryption keys, so you cannot + create disks for instances in a managed instance group if the source images are + encrypted with your own keys. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + interface: + description: + - Specifies the disk interface to use for attaching this disk, which is either SCSI + or NVME. The default is SCSI. + - Persistent disks must always use SCSI and the request will fail if you attempt to + attach a persistent disk in any other format than SCSI. + returned: success + type: str + mode: + description: + - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, + the default is to attach the disk in READ_WRITE mode. + returned: success + type: str + source: + description: + - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. + - If desired, you can also attach existing non-root persistent disks using this property. + This field is only applicable for persistent disks. + returned: success + type: dict + type: + description: + - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, + the default is PERSISTENT. + returned: success + type: str + guestAccelerators: + description: + - List of the type and count of accelerator cards attached to the instance . + returned: success + type: complex + contains: + acceleratorCount: + description: + - The number of the guest accelerator cards exposed to this instance. + returned: success + type: int + acceleratorType: + description: + - Full or partial URL of the accelerator type resource to expose to this instance. + returned: success + type: str + id: + description: + - The unique identifier for the resource. This identifier is defined by the server. + returned: success + type: int + labelFingerprint: + description: + - 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 + metadata: + description: + - The metadata key/value pairs to assign to instances that are created from this template. + These pairs can consist of custom metadata or predefined keys. + returned: success + type: dict + machineType: + description: + - A reference to a machine type which defines VM kind. + 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 network interface, generated by the server. For network - devices, these are eth0, eth1, etc . - returned: success - type: str - network: - description: - - Specifies the title of an existing network. When creating an instance, - if neither the network nor the subnetwork is specified, the default network - global/networks/default is used; if the network is not specified but the - subnetwork is specified, the network is inferred. - returned: success - type: dict - networkIP: - description: - - An IPv4 internal network address to assign to the instance for this network - interface. If not specified by the user, an unused internal IP is assigned - by the system. - returned: success - type: str - subnetwork: - description: - - Reference to a VPC network. - - If the network resource is in legacy mode, do not provide this property. - If the network is in auto subnet mode, providing the subnetwork is optional. - If the network is in custom subnet mode, then this field should be specified. - returned: success - type: dict - scheduling: - description: - - Sets the scheduling options for this instance. - returned: success - type: complex - contains: - automaticRestart: - description: - - Specifies whether the instance should be automatically restarted if it - is terminated by Compute Engine (not terminated by a user). - - You can only set the automatic restart option for standard instances. - Preemptible instances cannot be automatically restarted. - returned: success - type: bool - onHostMaintenance: - 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.' - - As a user, use RUNNING to keep a machine "on" and TERMINATED to turn a machine - off . - 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 + 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: + - Specifies the title of a gcompute_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: + description: + - The name of the network interface, generated by the server. For network devices, + these are eth0, eth1, etc . + returned: success + type: str + network: + description: + - Specifies the title of an existing gcompute_network. When creating an instance, + if neither the network nor the subnetwork is specified, the default network global/networks/default + is used; if the network is not specified but the subnetwork is specified, the network + is inferred. + returned: success + type: dict + networkIP: + description: + - An IPv4 internal network address to assign to the instance for this network interface. + If not specified by the user, an unused internal IP is assigned by the system. + returned: success + type: str + subnetwork: + description: + - Reference to a gcompute_subnetwork resource. + - If the network resource is in legacy mode, do not provide this property. If the + network is in auto subnet mode, providing the subnetwork is optional. If the network + is in custom subnet mode, then this field should be specified. + returned: success + type: dict + scheduling: + description: + - Sets the scheduling options for this instance. + returned: success + type: complex + contains: + automaticRestart: + description: + - Specifies whether the instance should be automatically restarted if it is terminated + by Compute Engine (not terminated by a user). + - You can only set the automatic restart option for standard instances. Preemptible + instances cannot be automatically restarted. + returned: success + type: bool + onHostMaintenance: + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_instance_group.py b/plugins/modules/gcp_compute_instance_group.py index 6ad4bc3..b4aeac9 100644 --- a/plugins/modules/gcp_compute_instance_group.py +++ b/plugins/modules/gcp_compute_instance_group.py @@ -120,46 +120,29 @@ EXAMPLES = ''' ''' RETURN = ''' -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 -id: - description: - - A unique identifier for this instance group. - returned: success - 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: + 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 + id: + description: + - A unique identifier for this instance group. + returned: success + 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 - named_ports: + namedPorts: description: - Assigns a name to a port number. - 'For example: {name: "http", port: 80}.' diff --git a/plugins/modules/gcp_compute_instance_group_facts.py b/plugins/modules/gcp_compute_instance_group_facts.py index 356446d..c072737 100644 --- a/plugins/modules/gcp_compute_instance_group_facts.py +++ b/plugins/modules/gcp_compute_instance_group_facts.py @@ -64,51 +64,34 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - 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 - id: - description: - - A unique identifier for this instance group. - returned: success - 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: +items: + description: List of items + returned: always + type: complex + contains: + 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 + id: + description: + - A unique identifier for this instance group. + returned: success + 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 - named_ports: + namedPorts: description: - Assigns a name to a port number. - 'For example: {name: "http", port: 80}.' diff --git a/plugins/modules/gcp_compute_instance_group_manager.py b/plugins/modules/gcp_compute_instance_group_manager.py index 921abec..7ebfd4b 100644 --- a/plugins/modules/gcp_compute_instance_group_manager.py +++ b/plugins/modules/gcp_compute_instance_group_manager.py @@ -170,151 +170,151 @@ EXAMPLES = ''' ''' RETURN = ''' -baseInstanceName: - description: - - 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 - string to the base instance name. - - The base instance name must comply with RFC1035. - returned: success - type: str -creationTimestamp: - description: - - The creation timestamp for this managed instance group in RFC3339 text format. - returned: success - type: str -currentActions: - description: - - The list of instance actions and the number of instances in this managed instance - group that are scheduled for each of those actions. - returned: success - type: complex - contains: - abandoning: - description: - - The total number of instances in the managed instance group that are scheduled - to be abandoned. Abandoning an instance removes it from the managed instance - group without deleting it. - returned: success - type: int - creating: - description: - - The number of instances in the managed instance group that are scheduled to - be created or are currently being created. If the group fails to create any - of these instances, it tries again until it creates the instance successfully. - - If you have disabled creation retries, this field will not be populated; instead, - the creatingWithoutRetries field will be populated. - returned: success - type: int - creatingWithoutRetries: - description: - - 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 - create any of these instances, it decreases the group's targetSize value accordingly. - returned: success - type: int - deleting: - description: - - The number of instances in the managed instance group that are scheduled to - be deleted or are currently being deleted. - returned: success - type: int - none: - description: - - The number of instances in the managed instance group that are running and - have no scheduled actions. - returned: success - type: int - recreating: - description: - - The number of instances in the managed instance group that are scheduled to - be recreated or are currently being being recreated. - - Recreating an instance deletes the existing root persistent disk and creates - a new disk from the image that is defined in the instance template. - returned: success - type: int - refreshing: - description: - - 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, - setting or removing target pools for the instance. - returned: success - type: int - restarting: - description: - - The number of instances in the managed instance group that are scheduled to - be restarted or are currently being restarted. - returned: success - type: int -description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str -id: - description: - - A unique identifier for this resource. - returned: success - type: int -instanceGroup: - description: - - The instance group being managed. - returned: success - type: dict -instanceTemplate: - description: - - 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. - 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: + baseInstanceName: + description: + - 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 + string to the base instance name. + - The base instance name must comply with RFC1035. + returned: success + type: str + creationTimestamp: + description: + - The creation timestamp for this managed instance group in RFC3339 text format. + returned: success + type: str + currentActions: + description: + - The list of instance actions and the number of instances in this managed instance + group that are scheduled for each of those actions. + returned: success + type: complex + contains: + abandoning: + description: + - The total number of instances in the managed instance group that are scheduled to + be abandoned. Abandoning an instance removes it from the managed instance group + without deleting it. + returned: success + type: int + creating: + description: + - The number of instances in the managed instance group that are scheduled to be created + or are currently being created. If the group fails to create any of these instances, + it tries again until it creates the instance successfully. + - If you have disabled creation retries, this field will not be populated; instead, + the creatingWithoutRetries field will be populated. + returned: success + type: int + creatingWithoutRetries: + description: + - 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 create + any of these instances, it decreases the group's targetSize value accordingly. + returned: success + type: int + deleting: + description: + - The number of instances in the managed instance group that are scheduled to be deleted + or are currently being deleted. + returned: success + type: int + none: + description: + - The number of instances in the managed instance group that are running and have + no scheduled actions. + returned: success + type: int + recreating: + description: + - The number of instances in the managed instance group that are scheduled to be recreated + or are currently being being recreated. + - Recreating an instance deletes the existing root persistent disk and creates a new + disk from the image that is defined in the instance template. + returned: success + type: int + refreshing: + description: + - 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, + setting or removing target pools for the instance. + returned: success + type: int + restarting: + description: + - The number of instances in the managed instance group that are scheduled to be restarted + or are currently being restarted. + returned: success + type: int + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + id: + description: + - A unique identifier for this resource. + returned: success + type: int + instanceGroup: + description: + - The instance group being managed. + returned: success + type: dict + instanceTemplate: + description: + - 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. + returned: success + type: dict name: - description: - - The name for this named port. The name must be 1-63 characters long, and comply - with RFC1035. - returned: success - type: str - port: - description: - - The port number, which can be a value between 1 and 65535. - returned: success - type: int -region: - description: - - The region this managed instance group resides (for regional resources). - returned: success - type: str -targetPools: - description: - - TargetPool resources to which instances in the instanceGroup field are added. - The target pools automatically apply to all of the instances in the managed instance - 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 + 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: + description: + - The name for this named port. The name must be 1-63 characters long, and comply + with RFC1035. + returned: success + type: str + port: + description: + - The port number, which can be a value between 1 and 65535. + returned: success + type: int + region: + description: + - The region this managed instance group resides (for regional resources). + returned: success + type: str + targetPools: + description: + - TargetPool resources to which instances in the instanceGroup field are added. The + target pools automatically apply to all of the instances in the managed instance + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_instance_group_manager_facts.py b/plugins/modules/gcp_compute_instance_group_manager_facts.py index 9ca514c..f39e949 100644 --- a/plugins/modules/gcp_compute_instance_group_manager_facts.py +++ b/plugins/modules/gcp_compute_instance_group_manager_facts.py @@ -64,159 +64,156 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - baseInstanceName: - description: - - 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 string to the base instance name. - - The base instance name must comply with RFC1035. - returned: success - type: str - creationTimestamp: - description: - - The creation timestamp for this managed instance group in RFC3339 text format. - returned: success - type: str - currentActions: - description: - - The list of instance actions and the number of instances in this managed instance - group that are scheduled for each of those actions. - returned: success - type: complex - contains: - abandoning: - description: - - The total number of instances in the managed instance group that are scheduled - to be abandoned. Abandoning an instance removes it from the managed instance - group without deleting it. - returned: success - type: int - creating: - description: - - The number of instances in the managed instance group that are scheduled - to be created or are currently being created. If the group fails to create - any of these instances, it tries again until it creates the instance successfully. - - If you have disabled creation retries, this field will not be populated; - instead, the creatingWithoutRetries field will be populated. - returned: success - type: int - creatingWithoutRetries: - description: - - 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 create any of these instances, it decreases the group's targetSize - value accordingly. - returned: success - type: int - deleting: - description: - - The number of instances in the managed instance group that are scheduled - to be deleted or are currently being deleted. - returned: success - type: int - none: - description: - - The number of instances in the managed instance group that are running - and have no scheduled actions. - returned: success - type: int - recreating: - description: - - The number of instances in the managed instance group that are scheduled - to be recreated or are currently being being recreated. - - Recreating an instance deletes the existing root persistent disk and creates - a new disk from the image that is defined in the instance template. - returned: success - type: int - refreshing: - description: - - 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, setting or removing target pools for the instance. - returned: success - type: int - restarting: - description: - - The number of instances in the managed instance group that are scheduled - to be restarted or are currently being restarted. - returned: success - type: int - description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str - id: - description: - - A unique identifier for this resource. - returned: success - type: int - instanceGroup: - description: - - The instance group being managed. - returned: success - type: dict - instanceTemplate: - description: - - 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. - 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: +items: + description: List of items + returned: always + type: complex + contains: + baseInstanceName: + description: + - 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 + string to the base instance name. + - The base instance name must comply with RFC1035. + returned: success + type: str + creationTimestamp: + description: + - The creation timestamp for this managed instance group in RFC3339 text format. + returned: success + type: str + currentActions: + description: + - The list of instance actions and the number of instances in this managed instance + group that are scheduled for each of those actions. + returned: success + type: complex + contains: + abandoning: + description: + - The total number of instances in the managed instance group that are scheduled to + be abandoned. Abandoning an instance removes it from the managed instance group + without deleting it. + returned: success + type: int + creating: + description: + - The number of instances in the managed instance group that are scheduled to be created + or are currently being created. If the group fails to create any of these instances, + it tries again until it creates the instance successfully. + - If you have disabled creation retries, this field will not be populated; instead, + the creatingWithoutRetries field will be populated. + returned: success + type: int + creatingWithoutRetries: + description: + - 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 create + any of these instances, it decreases the group's targetSize value accordingly. + returned: success + type: int + deleting: + description: + - The number of instances in the managed instance group that are scheduled to be deleted + or are currently being deleted. + returned: success + type: int + none: + description: + - The number of instances in the managed instance group that are running and have + no scheduled actions. + returned: success + type: int + recreating: + description: + - The number of instances in the managed instance group that are scheduled to be recreated + or are currently being being recreated. + - Recreating an instance deletes the existing root persistent disk and creates a new + disk from the image that is defined in the instance template. + returned: success + type: int + refreshing: + description: + - 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, + setting or removing target pools for the instance. + returned: success + type: int + restarting: + description: + - The number of instances in the managed instance group that are scheduled to be restarted + or are currently being restarted. + returned: success + type: int + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + id: + description: + - A unique identifier for this resource. + returned: success + type: int + instanceGroup: + description: + - The instance group being managed. + returned: success + type: dict + instanceTemplate: + description: + - 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. + returned: success + type: dict name: - description: - - The name for this named port. The name must be 1-63 characters long, and - comply with RFC1035. - returned: success - type: str - port: - description: - - The port number, which can be a value between 1 and 65535. - returned: success - type: int - region: - description: - - The region this managed instance group resides (for regional resources). - returned: success - type: str - targetPools: - description: - - TargetPool resources to which instances in the instanceGroup field are added. - The target pools automatically apply to all of the instances in the managed - instance 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 + 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: + description: + - The name for this named port. The name must be 1-63 characters long, and comply + with RFC1035. + returned: success + type: str + port: + description: + - The port number, which can be a value between 1 and 65535. + returned: success + type: int + region: + description: + - The region this managed instance group resides (for regional resources). + returned: success + type: str + targetPools: + description: + - TargetPool resources to which instances in the instanceGroup field are added. The + target pools automatically apply to all of the instances in the managed instance + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_instance_template.py b/plugins/modules/gcp_compute_instance_template.py index 917cb6e..44f1377 100644 --- a/plugins/modules/gcp_compute_instance_template.py +++ b/plugins/modules/gcp_compute_instance_template.py @@ -443,390 +443,375 @@ EXAMPLES = ''' ''' RETURN = ''' -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 -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 + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str description: - description: - - An optional text description for the instances that are created from this - instance template. - returned: success - type: str - disks: - description: - - An array of disks that are associated with the instances that are created - from this template. - returned: success - type: complex - contains: - autoDelete: - description: - - Specifies whether the disk will be auto-deleted when the instance is deleted - (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 behind on machine deletion.' - returned: success - type: bool - boot: - description: - - Indicates that this is a boot disk. The virtual machine will use the first - partition of the disk for its root filesystem. - returned: success - type: bool - deviceName: - description: - - 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 be used to reference the device for mounting, - resizing, and so on, from within the instance. - returned: success - type: str - diskEncryptionKey: - description: - - Encrypts or decrypts a disk using a customer-supplied encryption key. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC - 4648 base64 to either encrypt or decrypt this resource. - returned: success - type: str - rsaEncryptedKey: - description: - - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - encryption key to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - encryption key that protects this resource. - returned: success - type: str - index: - description: - - Assigns a zero-based index to this disk, where 0 is reserved for the boot - disk. For example, if you have many disks attached to an instance, each - disk would have a unique index number. If not specified, the server will - choose an appropriate value. - returned: success - type: int - initializeParams: - description: - - Specifies the parameters for a new disk that will be created alongside - the new instance. Use initialization parameters to create boot disks or - local SSDs attached to the new instance. - returned: success - type: complex - contains: - diskName: - description: - - Specifies the disk name. If not specified, the default is to use the - name of the instance. - returned: success - type: str - diskSizeGb: - description: - - Specifies the size of the disk in base-2 GB. - returned: success - type: int - diskType: - description: - - Reference to a disk type. - - Specifies the disk type to use to create the instance. - - If not specified, the default is pd-standard. - returned: success - type: str - sourceImage: - description: - - The source image to create this disk. When creating a new instance, - one of initializeParams.sourceImage or disks.source is required. To - create a disk with one of the public operating system images, specify - the image by its family name. - returned: success - type: str - sourceImageEncryptionKey: - description: - - The customer-supplied encryption key of the source image. Required - if the source image is protected by a customer-supplied encryption - key. - - Instance templates do not store customer-supplied encryption keys, - so you cannot create disks for instances in a managed instance group - if the source images are encrypted with your own keys. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded - in RFC 4648 base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - encryption key that protects this resource. - returned: success - type: str - interface: - description: - - Specifies the disk interface to use for attaching this disk, which is - either SCSI or NVME. The default is SCSI. - - Persistent disks must always use SCSI and the request will fail if you - attempt to attach a persistent disk in any other format than SCSI. - returned: success - type: str - mode: - description: - - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. - If not specified, the default is to attach the disk in READ_WRITE mode. - returned: success - type: str - source: - description: - - Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - or disks.source is required. - - If desired, you can also attach existing non-root persistent disks using - this property. This field is only applicable for persistent disks. - - Note that for InstanceTemplate, specify the disk name, not the URL for - the disk. - returned: success - type: dict - type: - description: - - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, - the default is PERSISTENT. - returned: success - type: str - machineType: - description: - - The machine type to use in the VM instance template. - 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 - metadata: - description: - - The metadata key/value pairs to assign to instances that are created from - this template. These pairs can consist of custom metadata or predefined keys. - returned: success - type: dict - guestAccelerators: - description: - - List of the type and count of accelerator cards attached to the instance . - returned: success - type: complex - contains: - acceleratorCount: - description: - - The number of the guest accelerator cards exposed to this instance. - returned: success - type: int - acceleratorType: - description: - - Full or partial URL of the accelerator type resource to expose to this - instance. - 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: - description: - - The name of the network interface, generated by the server. For network - devices, these are eth0, eth1, etc . - returned: success - type: str - network: - description: - - Specifies the title of an existing network. When creating an instance, - if neither the network nor the subnetwork is specified, the default network - global/networks/default is used; if the network is not specified but the - subnetwork is specified, the network is inferred. - returned: success - type: dict - networkIP: - description: - - An IPv4 internal network address to assign to the instance for this network - interface. If not specified by the user, an unused internal IP is assigned - by the system. - returned: success - type: str - subnetwork: - description: - - Reference to a VPC network. - - If the network resource is in legacy mode, do not provide this property. - If the network is in auto subnet mode, providing the subnetwork is optional. - If the network is in custom subnet mode, then this field should be specified. - returned: success - type: dict - scheduling: - description: - - Sets the scheduling options for this instance. - returned: success - type: complex - contains: - automaticRestart: - description: - - Specifies whether the instance should be automatically restarted if it - is terminated by Compute Engine (not terminated by a user). - - You can only set the automatic restart option for standard instances. - Preemptible instances cannot be automatically restarted. - returned: success - type: bool - onHostMaintenance: - 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 - 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 + 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: + - An optional text description for the instances that are created from this instance + template. + returned: success + type: str + disks: + description: + - An array of disks that are associated with the instances that are created from this + template. + returned: success + type: complex + contains: + autoDelete: + description: + - Specifies whether the disk will be auto-deleted when the instance is deleted (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 + behind on machine deletion.' + returned: success + type: bool + boot: + description: + - Indicates that this is a boot disk. The virtual machine will use the first partition + of the disk for its root filesystem. + returned: success + type: bool + deviceName: + description: + - 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 be used + to reference the device for mounting, resizing, and so on, from within the instance. + returned: success + type: str + diskEncryptionKey: + description: + - Encrypts or decrypts a disk using a customer-supplied encryption key. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + rsaEncryptedKey: + description: + - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption + key to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + index: + description: + - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. + For example, if you have many disks attached to an instance, each disk would have + a unique index number. If not specified, the server will choose an appropriate value. + returned: success + type: int + initializeParams: + description: + - Specifies the parameters for a new disk that will be created alongside the new instance. + Use initialization parameters to create boot disks or local SSDs attached to the + new instance. + returned: success + type: complex + contains: + diskName: + description: + - Specifies the disk name. If not specified, the default is to use the name of the + instance. + returned: success + type: str + diskSizeGb: + description: + - Specifies the size of the disk in base-2 GB. + returned: success + type: int + diskType: + description: + - Reference to a gcompute_disk_type resource. + - Specifies the disk type to use to create the instance. + - If not specified, the default is pd-standard. + returned: success + type: str + sourceImage: + description: + - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. To create a disk with one of the public operating + system images, specify the image by its family name. + returned: success + type: str + sourceImageEncryptionKey: + description: + - The customer-supplied encryption key of the source image. Required if the source + image is protected by a customer-supplied encryption key. + - Instance templates do not store customer-supplied encryption keys, so you cannot + create disks for instances in a managed instance group if the source images are + encrypted with your own keys. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + interface: + description: + - Specifies the disk interface to use for attaching this disk, which is either SCSI + or NVME. The default is SCSI. + - Persistent disks must always use SCSI and the request will fail if you attempt to + attach a persistent disk in any other format than SCSI. + returned: success + type: str + mode: + description: + - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, + the default is to attach the disk in READ_WRITE mode. + returned: success + type: str + source: + description: + - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. + - If desired, you can also attach existing non-root persistent disks using this property. + This field is only applicable for persistent disks. + - Note that for InstanceTemplate, specify the disk name, not the URL for the disk. + returned: success + type: dict + type: + description: + - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, + the default is PERSISTENT. + returned: success + type: str + machineType: + description: + - Reference to a gcompute_machine_type resource. + returned: success + type: str + metadata: + description: + - The metadata key/value pairs to assign to instances that are created from this template. + These pairs can consist of custom metadata or predefined keys. + returned: success + type: dict + guestAccelerators: + description: + - List of the type and count of accelerator cards attached to the instance . + returned: success + type: complex + contains: + acceleratorCount: + description: + - The number of the guest accelerator cards exposed to this instance. + returned: success + type: int + acceleratorType: + description: + - Full or partial URL of the accelerator type resource to expose to this instance. + 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: + - Specifies the title of a gcompute_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: + description: + - The name of the network interface, generated by the server. For network devices, + these are eth0, eth1, etc . + returned: success + type: str + network: + description: + - Specifies the title of an existing gcompute_network. When creating an instance, + if neither the network nor the subnetwork is specified, the default network global/networks/default + is used; if the network is not specified but the subnetwork is specified, the network + is inferred. + returned: success + type: dict + networkIP: + description: + - An IPv4 internal network address to assign to the instance for this network interface. + If not specified by the user, an unused internal IP is assigned by the system. + returned: success + type: str + subnetwork: + description: + - Reference to a gcompute_subnetwork resource. + - If the network resource is in legacy mode, do not provide this property. If the + network is in auto subnet mode, providing the subnetwork is optional. If the network + is in custom subnet mode, then this field should be specified. + returned: success + type: dict + scheduling: + description: + - Sets the scheduling options for this instance. + returned: success + type: complex + contains: + automaticRestart: + description: + - Specifies whether the instance should be automatically restarted if it is terminated + by Compute Engine (not terminated by a user). + - You can only set the automatic restart option for standard instances. Preemptible + instances cannot be automatically restarted. + returned: success + type: bool + onHostMaintenance: + 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 + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_instance_template_facts.py b/plugins/modules/gcp_compute_instance_template_facts.py index 9471378..b568c16 100644 --- a/plugins/modules/gcp_compute_instance_template_facts.py +++ b/plugins/modules/gcp_compute_instance_template_facts.py @@ -59,405 +59,380 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - 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 - 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 +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str description: - description: - - An optional text description for the instances that are created from this - instance template. - returned: success - type: str - disks: - description: - - An array of disks that are associated with the instances that are created - from this template. - returned: success - type: complex - contains: - autoDelete: - description: - - Specifies whether the disk will be auto-deleted when the instance - is deleted (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 behind on machine deletion.' - returned: success - type: bool - boot: - description: - - Indicates that this is a boot disk. The virtual machine will use the - first partition of the disk for its root filesystem. - returned: success - type: bool - deviceName: - description: - - 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 be used to reference the device - for mounting, resizing, and so on, from within the instance. - returned: success - type: str - diskEncryptionKey: - description: - - Encrypts or decrypts a disk using a customer-supplied encryption key. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded - in RFC 4648 base64 to either encrypt or decrypt this resource. - returned: success - type: str - rsaEncryptedKey: - description: - - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied - encryption key to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - encryption key that protects this resource. - returned: success - type: str - index: - description: - - Assigns a zero-based index to this disk, where 0 is reserved for the - boot disk. For example, if you have many disks attached to an instance, - each disk would have a unique index number. If not specified, the - server will choose an appropriate value. - returned: success - type: int - initializeParams: - description: - - Specifies the parameters for a new disk that will be created alongside - the new instance. Use initialization parameters to create boot disks - or local SSDs attached to the new instance. - returned: success - type: complex - contains: - diskName: - description: - - Specifies the disk name. If not specified, the default is to use - the name of the instance. - returned: success - type: str - diskSizeGb: - description: - - Specifies the size of the disk in base-2 GB. - returned: success - type: int - diskType: - description: - - Reference to a disk type. - - Specifies the disk type to use to create the instance. - - If not specified, the default is pd-standard. - returned: success - type: str - sourceImage: - description: - - The source image to create this disk. When creating a new instance, - one of initializeParams.sourceImage or disks.source is required. - To create a disk with one of the public operating system images, - specify the image by its family name. - returned: success - type: str - sourceImageEncryptionKey: - description: - - The customer-supplied encryption key of the source image. Required - if the source image is protected by a customer-supplied encryption - key. - - Instance templates do not store customer-supplied encryption keys, - so you cannot create disks for instances in a managed instance - group if the source images are encrypted with your own keys. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded - in RFC 4648 base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied - encryption key that protects this resource. - returned: success - type: str - interface: - description: - - Specifies the disk interface to use for attaching this disk, which - is either SCSI or NVME. The default is SCSI. - - Persistent disks must always use SCSI and the request will fail if - you attempt to attach a persistent disk in any other format than SCSI. - returned: success - type: str - mode: - description: - - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. - If not specified, the default is to attach the disk in READ_WRITE - mode. - returned: success - type: str - source: - description: - - Reference to a disk. When creating a new instance, one of initializeParams.sourceImage - or disks.source is required. - - If desired, you can also attach existing non-root persistent disks - using this property. This field is only applicable for persistent - disks. - - Note that for InstanceTemplate, specify the disk name, not the URL - for the disk. - returned: success - type: dict - type: - description: - - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - specified, the default is PERSISTENT. - returned: success - type: str - machineType: - description: - - The machine type to use in the VM instance template. - 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 - metadata: - description: - - The metadata key/value pairs to assign to instances that are created from - this template. These pairs can consist of custom metadata or predefined - keys. - returned: success - type: dict - guestAccelerators: - description: - - List of the type and count of accelerator cards attached to the instance - . - returned: success - type: complex - contains: - acceleratorCount: - description: - - The number of the guest accelerator cards exposed to this instance. - returned: success - type: int - acceleratorType: - description: - - Full or partial URL of the accelerator type resource to expose to - this instance. - 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: - description: - - The name of the network interface, generated by the server. For network - devices, these are eth0, eth1, etc . - returned: success - type: str - network: - description: - - Specifies the title of an existing network. When creating an instance, - if neither the network nor the subnetwork is specified, the default - network global/networks/default is used; if the network is not specified - but the subnetwork is specified, the network is inferred. - returned: success - type: dict - networkIP: - description: - - An IPv4 internal network address to assign to the instance for this - network interface. If not specified by the user, an unused internal - IP is assigned by the system. - returned: success - type: str - subnetwork: - description: - - Reference to a VPC network. - - If the network resource is in legacy mode, do not provide this property. - If the network is in auto subnet mode, providing the subnetwork is - optional. If the network is in custom subnet mode, then this field - should be specified. - returned: success - type: dict - scheduling: - description: - - Sets the scheduling options for this instance. - returned: success - type: complex - contains: - automaticRestart: - description: - - Specifies whether the instance should be automatically restarted if - it is terminated by Compute Engine (not terminated by a user). - - You can only set the automatic restart option for standard instances. - Preemptible instances cannot be automatically restarted. - returned: success - type: bool - onHostMaintenance: - 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 - 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 + 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: + - An optional text description for the instances that are created from this instance + template. + returned: success + type: str + disks: + description: + - An array of disks that are associated with the instances that are created from this + template. + returned: success + type: complex + contains: + autoDelete: + description: + - Specifies whether the disk will be auto-deleted when the instance is deleted (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 + behind on machine deletion.' + returned: success + type: bool + boot: + description: + - Indicates that this is a boot disk. The virtual machine will use the first partition + of the disk for its root filesystem. + returned: success + type: bool + deviceName: + description: + - 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 be used + to reference the device for mounting, resizing, and so on, from within the instance. + returned: success + type: str + diskEncryptionKey: + description: + - Encrypts or decrypts a disk using a customer-supplied encryption key. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + rsaEncryptedKey: + description: + - Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption + key to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + index: + description: + - Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. + For example, if you have many disks attached to an instance, each disk would have + a unique index number. If not specified, the server will choose an appropriate value. + returned: success + type: int + initializeParams: + description: + - Specifies the parameters for a new disk that will be created alongside the new instance. + Use initialization parameters to create boot disks or local SSDs attached to the + new instance. + returned: success + type: complex + contains: + diskName: + description: + - Specifies the disk name. If not specified, the default is to use the name of the + instance. + returned: success + type: str + diskSizeGb: + description: + - Specifies the size of the disk in base-2 GB. + returned: success + type: int + diskType: + description: + - Reference to a gcompute_disk_type resource. + - Specifies the disk type to use to create the instance. + - If not specified, the default is pd-standard. + returned: success + type: str + sourceImage: + description: + - The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. To create a disk with one of the public operating + system images, specify the image by its family name. + returned: success + type: str + sourceImageEncryptionKey: + description: + - The customer-supplied encryption key of the source image. Required if the source + image is protected by a customer-supplied encryption key. + - Instance templates do not store customer-supplied encryption keys, so you cannot + create disks for instances in a managed instance group if the source images are + encrypted with your own keys. + returned: success + type: complex + contains: + rawKey: + description: + - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 + to either encrypt or decrypt this resource. + returned: success + type: str + sha256: + description: + - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key + that protects this resource. + returned: success + type: str + interface: + description: + - Specifies the disk interface to use for attaching this disk, which is either SCSI + or NVME. The default is SCSI. + - Persistent disks must always use SCSI and the request will fail if you attempt to + attach a persistent disk in any other format than SCSI. + returned: success + type: str + mode: + description: + - The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, + the default is to attach the disk in READ_WRITE mode. + returned: success + type: str + source: + description: + - Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage + or disks.source is required. + - If desired, you can also attach existing non-root persistent disks using this property. + This field is only applicable for persistent disks. + - Note that for InstanceTemplate, specify the disk name, not the URL for the disk. + returned: success + type: dict + type: + description: + - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, + the default is PERSISTENT. + returned: success + type: str + machineType: + description: + - Reference to a gcompute_machine_type resource. + returned: success + type: str + metadata: + description: + - The metadata key/value pairs to assign to instances that are created from this template. + These pairs can consist of custom metadata or predefined keys. + returned: success + type: dict + guestAccelerators: + description: + - List of the type and count of accelerator cards attached to the instance . + returned: success + type: complex + contains: + acceleratorCount: + description: + - The number of the guest accelerator cards exposed to this instance. + returned: success + type: int + acceleratorType: + description: + - Full or partial URL of the accelerator type resource to expose to this instance. + 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: + - Specifies the title of a gcompute_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: + description: + - The name of the network interface, generated by the server. For network devices, + these are eth0, eth1, etc . + returned: success + type: str + network: + description: + - Specifies the title of an existing gcompute_network. When creating an instance, + if neither the network nor the subnetwork is specified, the default network global/networks/default + is used; if the network is not specified but the subnetwork is specified, the network + is inferred. + returned: success + type: dict + networkIP: + description: + - An IPv4 internal network address to assign to the instance for this network interface. + If not specified by the user, an unused internal IP is assigned by the system. + returned: success + type: str + subnetwork: + description: + - Reference to a gcompute_subnetwork resource. + - If the network resource is in legacy mode, do not provide this property. If the + network is in auto subnet mode, providing the subnetwork is optional. If the network + is in custom subnet mode, then this field should be specified. + returned: success + type: dict + scheduling: + description: + - Sets the scheduling options for this instance. + returned: success + type: complex + contains: + automaticRestart: + description: + - Specifies whether the instance should be automatically restarted if it is terminated + by Compute Engine (not terminated by a user). + - You can only set the automatic restart option for standard instances. Preemptible + instances cannot be automatically restarted. + returned: success + type: bool + onHostMaintenance: + 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 + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_network.py b/plugins/modules/gcp_compute_network.py index e20f789..6b00846 100644 --- a/plugins/modules/gcp_compute_network.py +++ b/plugins/modules/gcp_compute_network.py @@ -116,78 +116,59 @@ EXAMPLES = ''' ''' RETURN = ''' -description: - description: - - An optional description of this resource. The resource must be recreated to modify - this field. - returned: success - type: str -gateway_ipv4: - description: - - The gateway address for default routing out of the network. This value is selected - by GCP. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -ipv4_range: - description: - - If this field is specified, a deprecated legacy network is created. - - You will no longer be able to create a legacy network on Feb 1, 2020. - - See the [legacy network docs](U(https://cloud.google.com/vpc/docs/legacy)) for - more details. - - The range of internal addresses that are legal on this legacy network. - - 'This range is a CIDR specification, for example: `192.168.0.0/16`.' - - The resource must be recreated to modify this field. - returned: success - 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 -subnetworks: - description: - - Server-defined fully-qualified URLs for all subnetworks in this network. - returned: success - type: list -autoCreateSubnetworks: - description: - - When set to `true`, the network is created in "auto subnet mode" and it will create - a subnet for each region automatically across the `10.128.0.0/9` address range. - - When set to `false`, the network is created in "custom subnet mode" so the user - can explicitly connect subnetwork resources. - returned: success - type: bool -creationTimestamp: - 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 + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + gateway_ipv4: + description: + - A gateway address for default routing to other networks. This value is read only + and is selected by the Google Compute Engine, typically as the first usable address + in the IPv4Range. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + ipv4_range: + description: + - 'The range of internal addresses that are legal on this network. This range is a + CIDR specification, for example: 192.168.0.0/16. Provided by the client when the + network is created.' + 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 + subnetworks: + description: + - Server-defined fully-qualified URLs for all subnetworks in this network. + returned: success + type: list + autoCreateSubnetworks: + description: + - When set to true, the network is created in "auto subnet mode". When set to false, + the network is in "custom subnet mode". + - In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 + and it automatically creates one subnetwork per region. + returned: success + type: bool + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_network_facts.py b/plugins/modules/gcp_compute_network_facts.py index f1bce60..eb3448a 100644 --- a/plugins/modules/gcp_compute_network_facts.py +++ b/plugins/modules/gcp_compute_network_facts.py @@ -59,84 +59,64 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - description: - description: - - An optional description of this resource. The resource must be recreated to - modify this field. - returned: success - type: str - gateway_ipv4: - description: - - The gateway address for default routing out of the network. This value is - selected by GCP. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - type: int - ipv4_range: - description: - - If this field is specified, a deprecated legacy network is created. - - You will no longer be able to create a legacy network on Feb 1, 2020. - - See the [legacy network docs](U(https://cloud.google.com/vpc/docs/legacy)) - for more details. - - The range of internal addresses that are legal on this legacy network. - - 'This range is a CIDR specification, for example: `192.168.0.0/16`.' - - The resource must be recreated to modify this field. - returned: success - 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 - subnetworks: - description: - - Server-defined fully-qualified URLs for all subnetworks in this network. - returned: success - type: list - autoCreateSubnetworks: - description: - - When set to `true`, the network is created in "auto subnet mode" and it will - create a subnet for each region automatically across the `10.128.0.0/9` address - range. - - When set to `false`, the network is created in "custom subnet mode" so the - user can explicitly connect subnetwork resources. - returned: success - type: bool - creationTimestamp: - 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 +items: + description: List of items + returned: always + type: complex + contains: + description: + description: + - An optional description of this resource. Provide this property when you create + the resource. + returned: success + type: str + gateway_ipv4: + description: + - A gateway address for default routing to other networks. This value is read only + and is selected by the Google Compute Engine, typically as the first usable address + in the IPv4Range. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + ipv4_range: + description: + - 'The range of internal addresses that are legal on this network. This range is a + CIDR specification, for example: 192.168.0.0/16. Provided by the client when the + network is created.' + 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 + subnetworks: + description: + - Server-defined fully-qualified URLs for all subnetworks in this network. + returned: success + type: list + autoCreateSubnetworks: + description: + - When set to true, the network is created in "auto subnet mode". When set to false, + the network is in "custom subnet mode". + - In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 + and it automatically creates one subnetwork per region. + returned: success + type: bool + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_route.py b/plugins/modules/gcp_compute_route.py index e1843c4..521a946 100644 --- a/plugins/modules/gcp_compute_route.py +++ b/plugins/modules/gcp_compute_route.py @@ -168,79 +168,79 @@ EXAMPLES = ''' ''' RETURN = ''' -destRange: - description: - - The destination range of outgoing packets that this route applies to. - - Only IPv4 is supported. - returned: success - type: str -description: - description: - - An optional description of this resource. Provide this property when you create - the 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 -network: - description: - - The network that this route applies to. - returned: success - type: dict -priority: - description: - - 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. - - In the case of two routes with equal prefix length, the one with the lowest-numbered - priority value wins. - - Default value is 1000. Valid range is 0 through 65535. - returned: success - type: int -tags: - description: - - A list of instance tags to which this route applies. - returned: success - type: list -nextHopGateway: - description: - - URL to a gateway that should handle matching packets. - - 'Currently, you can only specify the internet gateway, using a full or partial - valid 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 - .' - returned: success - type: str -nextHopInstance: - description: - - 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/) - instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance - .' - returned: success - type: dict -nextHopIp: - description: - - Network IP address of an instance that should handle matching packets. - returned: success - type: str -nextHopVpnTunnel: - description: - - URL to a VpnTunnel that should handle matching packets. - returned: success - type: dict -nextHopNetwork: - description: - - URL to a Network that should handle matching packets. - returned: success - type: str + destRange: + description: + - The destination range of outgoing packets that this route applies to. + - Only IPv4 is supported. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the 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 + network: + description: + - The network that this route applies to. + returned: success + type: dict + priority: + description: + - 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. + - In the case of two routes with equal prefix length, the one with the lowest-numbered + priority value wins. + - Default value is 1000. Valid range is 0 through 65535. + returned: success + type: int + tags: + description: + - A list of instance tags to which this route applies. + returned: success + type: list + nextHopGateway: + description: + - URL to a gateway that should handle matching packets. + - 'Currently, you can only specify the internet gateway, using a full or partial valid + 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 + .' + returned: success + type: str + nextHopInstance: + description: + - 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/) + instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance + .' + returned: success + type: str + nextHopIp: + description: + - Network IP address of an instance that should handle matching packets. + returned: success + type: str + nextHopVpnTunnel: + description: + - URL to a VpnTunnel that should handle matching packets. + returned: success + type: str + nextHopNetwork: + description: + - URL to a Network that should handle matching packets. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_route_facts.py b/plugins/modules/gcp_compute_route_facts.py index b1108df..dcf4cb7 100644 --- a/plugins/modules/gcp_compute_route_facts.py +++ b/plugins/modules/gcp_compute_route_facts.py @@ -59,84 +59,84 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - destRange: - description: - - The destination range of outgoing packets that this route applies to. - - Only IPv4 is supported. - returned: success - type: str - description: - description: - - An optional description of this resource. Provide this property when you create - the 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 - network: - description: - - The network that this route applies to. - returned: success - type: dict - priority: - description: - - 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. - - In the case of two routes with equal prefix length, the one with the lowest-numbered - priority value wins. - - Default value is 1000. Valid range is 0 through 65535. - returned: success - type: int - tags: - description: - - A list of instance tags to which this route applies. - returned: success - type: list - nextHopGateway: - description: - - URL to a gateway that should handle matching packets. - - 'Currently, you can only specify the internet gateway, using a full or partial - valid 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 - .' - returned: success - type: str - nextHopInstance: - description: - - 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/) - instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance - .' - returned: success - type: dict - nextHopIp: - description: - - Network IP address of an instance that should handle matching packets. - returned: success - type: str - nextHopVpnTunnel: - description: - - URL to a VpnTunnel that should handle matching packets. - returned: success - type: dict - nextHopNetwork: - description: - - URL to a Network that should handle matching packets. - returned: success - type: str +items: + description: List of items + returned: always + type: complex + contains: + destRange: + description: + - The destination range of outgoing packets that this route applies to. + - Only IPv4 is supported. + returned: success + type: str + description: + description: + - An optional description of this resource. Provide this property when you create + the 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 + network: + description: + - The network that this route applies to. + returned: success + type: dict + priority: + description: + - 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. + - In the case of two routes with equal prefix length, the one with the lowest-numbered + priority value wins. + - Default value is 1000. Valid range is 0 through 65535. + returned: success + type: int + tags: + description: + - A list of instance tags to which this route applies. + returned: success + type: list + nextHopGateway: + description: + - URL to a gateway that should handle matching packets. + - 'Currently, you can only specify the internet gateway, using a full or partial valid + 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 + .' + returned: success + type: str + nextHopInstance: + description: + - 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/) + instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance + .' + returned: success + type: str + nextHopIp: + description: + - Network IP address of an instance that should handle matching packets. + returned: success + type: str + nextHopVpnTunnel: + description: + - URL to a VpnTunnel that should handle matching packets. + returned: success + type: str + nextHopNetwork: + description: + - URL to a Network that should handle matching packets. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_router.py b/plugins/modules/gcp_compute_router.py index 48c6017..d48a855 100644 --- a/plugins/modules/gcp_compute_router.py +++ b/plugins/modules/gcp_compute_router.py @@ -154,78 +154,83 @@ EXAMPLES = ''' ''' RETURN = ''' -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 + 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: + - User-specified description for the IP range. + returned: success + type: str + region: description: description: - User-specified description for the IP range. diff --git a/plugins/modules/gcp_compute_router_facts.py b/plugins/modules/gcp_compute_router_facts.py index 332e76c..2481c31 100644 --- a/plugins/modules/gcp_compute_router_facts.py +++ b/plugins/modules/gcp_compute_router_facts.py @@ -64,94 +64,92 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - 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 +items: + description: List of items + returned: always + type: complex + contains: + id: description: - description: - - User-specified description for the IP range. - returned: success - type: str - region: - description: - - Region where the router resides. - returned: success - type: str + - 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: + - User-specified description for the IP range. + returned: success + type: str + region: + description: + - Region where the router resides. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_ssl_certificate.py b/plugins/modules/gcp_compute_ssl_certificate.py index 97896de..c149b39 100644 --- a/plugins/modules/gcp_compute_ssl_certificate.py +++ b/plugins/modules/gcp_compute_ssl_certificate.py @@ -119,7 +119,7 @@ RETURN = ''' - The chain must include at least one intermediate cert. returned: success type: str - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -144,7 +144,7 @@ RETURN = ''' be a dash. returned: success type: str - private_key: + privateKey: description: - The write-only private key in PEM format. returned: success diff --git a/plugins/modules/gcp_compute_ssl_certificate_facts.py b/plugins/modules/gcp_compute_ssl_certificate_facts.py index 2169eb0..aa8e845 100644 --- a/plugins/modules/gcp_compute_ssl_certificate_facts.py +++ b/plugins/modules/gcp_compute_ssl_certificate_facts.py @@ -71,7 +71,7 @@ items: - The chain must include at least one intermediate cert. returned: success type: str - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -96,7 +96,7 @@ items: be a dash. returned: success type: str - private_key: + privateKey: description: - The write-only private key in PEM format. returned: success diff --git a/plugins/modules/gcp_compute_ssl_policy.py b/plugins/modules/gcp_compute_ssl_policy.py index 0b390e8..04803a4 100644 --- a/plugins/modules/gcp_compute_ssl_policy.py +++ b/plugins/modules/gcp_compute_ssl_policy.py @@ -111,81 +111,80 @@ EXAMPLES = ''' ''' RETURN = ''' -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str -profile: - description: - - 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`, - `RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable - must be specified in the `customFeatures` field. - returned: success - type: str -minTlsVersion: - description: - - 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`, - `TLS_1_2`. - returned: success - type: str -enabledFeatures: - description: - - The list of features enabled in the SSL policy. - returned: success - type: list -customFeatures: - description: - - 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 - if the profile is not CUSTOM. - returned: success - type: list -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 -warnings: - description: - - If potential misconfigurations are detected for this SSL policy, this field will - be populated with warning messages. - returned: success - type: complex - contains: - code: - description: - - A warning code, if applicable. - returned: success - type: str - message: - description: - - A human-readable description of the warning code. - returned: success - type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + profile: + description: + - 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`, `RESTRICTED`, + or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable must be specified + in the `customFeatures` field. + returned: success + type: str + minTlsVersion: + description: + - 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`, `TLS_1_2`. + returned: success + type: str + enabledFeatures: + description: + - The list of features enabled in the SSL policy. + returned: success + type: list + customFeatures: + description: + - 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 + if the profile is not CUSTOM. + returned: success + type: list + 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 + warnings: + description: + - If potential misconfigurations are detected for this SSL policy, this field will + be populated with warning messages. + returned: success + type: complex + contains: + code: + description: + - A warning code, if applicable. + returned: success + type: str + message: + description: + - A human-readable description of the warning code. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_ssl_policy_facts.py b/plugins/modules/gcp_compute_ssl_policy_facts.py index bc85282..0844c82 100644 --- a/plugins/modules/gcp_compute_ssl_policy_facts.py +++ b/plugins/modules/gcp_compute_ssl_policy_facts.py @@ -59,86 +59,85 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - type: int - name: - description: - - Name of the resource. Provided by the client when the resource is created. - The name must be 1-63 characters long, and comply with RFC1035. Specifically, - the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str - profile: - description: - - 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`, - `RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable - must be specified in the `customFeatures` field. - returned: success - type: str - minTlsVersion: - description: - - 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`, - `TLS_1_2`. - returned: success - type: str - enabledFeatures: - description: - - The list of features enabled in the SSL policy. - returned: success - type: list - customFeatures: - description: - - 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 if the profile is not CUSTOM. - returned: success - type: list - 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 - warnings: - description: - - If potential misconfigurations are detected for this SSL policy, this field - will be populated with warning messages. - returned: success - type: complex - contains: - code: - description: - - A warning code, if applicable. - returned: success - type: str - message: - description: - - A human-readable description of the warning code. - returned: success - type: str +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + profile: + description: + - 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`, `RESTRICTED`, + or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable must be specified + in the `customFeatures` field. + returned: success + type: str + minTlsVersion: + description: + - 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`, `TLS_1_2`. + returned: success + type: str + enabledFeatures: + description: + - The list of features enabled in the SSL policy. + returned: success + type: list + customFeatures: + description: + - 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 + if the profile is not CUSTOM. + returned: success + type: list + 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 + warnings: + description: + - If potential misconfigurations are detected for this SSL policy, this field will + be populated with warning messages. + returned: success + type: complex + contains: + code: + description: + - A warning code, if applicable. + returned: success + type: str + message: + description: + - A human-readable description of the warning code. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_subnetwork.py b/plugins/modules/gcp_compute_subnetwork.py index 4d629cc..1c664a7 100644 --- a/plugins/modules/gcp_compute_subnetwork.py +++ b/plugins/modules/gcp_compute_subnetwork.py @@ -162,97 +162,63 @@ EXAMPLES = ''' ''' RETURN = ''' -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. This field can be set only at resource creation time. - returned: success - type: str -gatewayAddress: - description: - - The gateway address for default routes to reach destination addresses outside - this subnetwork. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - 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 + 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. This field can be set only at resource creation time. + returned: success + type: str + gatewayAddress: + description: + - The gateway address for default routes to reach destination addresses outside this + subnetwork. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int ipCidrRange: - description: - - The range of IP addresses belonging to this subnetwork secondary range. Provide - this property when you create the subnetwork. - - Ranges must be unique and non-overlapping with all primary and secondary IP - ranges within a network. Only IPv4 is supported. - returned: success - type: str -privateIpGoogleAccess: - description: - - When enabled, VMs in this subnetwork without external IP addresses can access - Google APIs and services by using Private Google Access. - returned: success - type: bool -region: - description: - - URL of the GCP region for this subnetwork. - returned: success - type: str + 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 + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_subnetwork_facts.py b/plugins/modules/gcp_compute_subnetwork_facts.py index b58a583..60e6940 100644 --- a/plugins/modules/gcp_compute_subnetwork_facts.py +++ b/plugins/modules/gcp_compute_subnetwork_facts.py @@ -64,103 +64,68 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - 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. This field can be set only at resource creation time. - returned: success - type: str - gatewayAddress: - description: - - The gateway address for default routes to reach destination addresses outside - this subnetwork. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - 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 +items: + description: List of items + returned: always + type: complex + contains: + 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. This field can be set only at resource creation time. + returned: success + type: str + gatewayAddress: + description: + - The gateway address for default routes to reach destination addresses outside this + subnetwork. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int ipCidrRange: - description: - - The range of IP addresses belonging to this subnetwork secondary range. - Provide this property when you create the subnetwork. - - Ranges must be unique and non-overlapping with all primary and secondary - IP ranges within a network. Only IPv4 is supported. - returned: success - type: str - privateIpGoogleAccess: - description: - - When enabled, VMs in this subnetwork without external IP addresses can access - Google APIs and services by using Private Google Access. - returned: success - type: bool - region: - description: - - URL of the GCP region for this subnetwork. - returned: success - type: str + 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 + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_http_proxy.py b/plugins/modules/gcp_compute_target_http_proxy.py index 4baf851..45aeacd 100644 --- a/plugins/modules/gcp_compute_target_http_proxy.py +++ b/plugins/modules/gcp_compute_target_http_proxy.py @@ -136,36 +136,36 @@ EXAMPLES = ''' ''' RETURN = ''' -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str -urlMap: - description: - - A reference to the UrlMap resource that defines the mapping from URL to the BackendService. - returned: success - type: dict + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + urlMap: + description: + - A reference to the UrlMap resource that defines the mapping from URL to the BackendService. + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_http_proxy_facts.py b/plugins/modules/gcp_compute_target_http_proxy_facts.py index 9675bd0..8460b04 100644 --- a/plugins/modules/gcp_compute_target_http_proxy_facts.py +++ b/plugins/modules/gcp_compute_target_http_proxy_facts.py @@ -59,42 +59,41 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - type: int - name: - description: - - Name of the resource. Provided by the client when the resource is created. - The name must be 1-63 characters long, and comply with RFC1035. Specifically, - the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str - urlMap: - description: - - A reference to the UrlMap resource that defines the mapping from URL to the - BackendService. - returned: success - type: dict +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + urlMap: + description: + - A reference to the UrlMap resource that defines the mapping from URL to the BackendService. + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_https_proxy.py b/plugins/modules/gcp_compute_target_https_proxy.py index 2e0387c..c4e1072 100644 --- a/plugins/modules/gcp_compute_target_https_proxy.py +++ b/plugins/modules/gcp_compute_target_https_proxy.py @@ -191,58 +191,51 @@ EXAMPLES = ''' ''' RETURN = ''' -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str -quicOverride: - description: - - Specifies the QUIC override policy for this resource. This determines whether - the load balancer will attempt to negotiate QUIC with clients or not. Can specify - one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with - no user overrides, which is equivalent to DISABLE. Not specifying this field is - equivalent to specifying NONE. - returned: success - type: str -sslCertificates: - description: - - 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. - returned: success - type: list -sslPolicy: - description: - - A reference to the SslPolicy resource that will be associated with the TargetHttpsProxy - resource. If not set, the TargetHttpsProxy resource will not have any SSL policy - configured. - returned: success - type: dict -urlMap: - description: - - A reference to the UrlMap resource that defines the mapping from URL to the BackendService. - returned: success - type: dict + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + quicOverride: + description: + - Specifies the QUIC override policy for this resource. This determines whether the + load balancer will attempt to negotiate QUIC with clients or not. Can specify one + of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with no + user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent + to specifying NONE. + returned: success + type: str + sslCertificates: + description: + - 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. + returned: success + type: list + urlMap: + description: + - A reference to the UrlMap resource that defines the mapping from URL to the BackendService. + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_https_proxy_facts.py b/plugins/modules/gcp_compute_target_https_proxy_facts.py index 6330dd8..4f1dc44 100644 --- a/plugins/modules/gcp_compute_target_https_proxy_facts.py +++ b/plugins/modules/gcp_compute_target_https_proxy_facts.py @@ -59,65 +59,56 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - type: int - name: - description: - - Name of the resource. Provided by the client when the resource is created. - The name must be 1-63 characters long, and comply with RFC1035. Specifically, - the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str - quicOverride: - description: - - Specifies the QUIC override policy for this resource. This determines whether - the load balancer will attempt to negotiate QUIC with clients or not. Can - specify one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC - policy with no user overrides, which is equivalent to DISABLE. Not specifying - this field is equivalent to specifying NONE. - returned: success - type: str - sslCertificates: - description: - - 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. - returned: success - type: list - sslPolicy: - description: - - A reference to the SslPolicy resource that will be associated with the TargetHttpsProxy - resource. If not set, the TargetHttpsProxy resource will not have any SSL - policy configured. - returned: success - type: dict - urlMap: - description: - - A reference to the UrlMap resource that defines the mapping from URL to the - BackendService. - returned: success - type: dict +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + quicOverride: + description: + - Specifies the QUIC override policy for this resource. This determines whether the + load balancer will attempt to negotiate QUIC with clients or not. Can specify one + of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with no + user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent + to specifying NONE. + returned: success + type: str + sslCertificates: + description: + - 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. + returned: success + type: list + urlMap: + description: + - A reference to the UrlMap resource that defines the mapping from URL to the BackendService. + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_pool.py b/plugins/modules/gcp_compute_target_pool.py index efd8d2c..5206506 100644 --- a/plugins/modules/gcp_compute_target_pool.py +++ b/plugins/modules/gcp_compute_target_pool.py @@ -145,90 +145,90 @@ EXAMPLES = ''' ''' RETURN = ''' -backupPool: - description: - - 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 - between [0, 1]. - - '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 - below failoverRatio, traffic arriving at the load-balanced IP will be directed - to the backup pool.' - - 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 - 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. - returned: success - type: dict -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. - returned: success - type: str -failoverRatio: - description: - - 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). - The value of the field must be in [0, 1]. - - '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 - pool is at or below this number, traffic arriving at the load-balanced IP will - be directed to the backup pool.' - - In case where failoverRatio is not set or all the instances in 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 with the best effort, - or to all instances when no instance is healthy. - returned: success - type: str -healthCheck: - description: - - A reference to a HttpHealthCheck resource. - - A member instance in this pool is considered healthy if and only if the health - checks pass. If not specified it means all member instances will be considered - healthy at all times. - returned: success - type: dict -id: - description: - - The unique identifier for the resource. - returned: success - type: int -instances: - description: - - A list of virtual machine instances serving this pool. - - They must live in zones contained in the same region as this pool. - returned: success - type: list -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 -sessionAffinity: - description: - - 'Session affinity option. Must be one of these values: - NONE: Connections from - 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 - in the pool while that instance remains healthy." - - "- 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." - returned: success - type: str -region: - description: - - The region where the target pool resides. - returned: success - type: str + backupPool: + description: + - 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 + between [0, 1]. + - '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 + below failoverRatio, traffic arriving at the load-balanced IP will be directed to + the backup pool.' + - 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 + 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. + returned: success + type: dict + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + failoverRatio: + description: + - 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). + The value of the field must be in [0, 1]. + - '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 + pool is at or below this number, traffic arriving at the load-balanced IP will be + directed to the backup pool.' + - In case where failoverRatio is not set or all the instances in 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 with the best effort, + or to all instances when no instance is healthy. + returned: success + type: str + healthCheck: + description: + - A reference to a HttpHealthCheck resource. + - A member instance in this pool is considered healthy if and only if the health checks + pass. If not specified it means all member instances will be considered healthy + at all times. + returned: success + type: dict + id: + description: + - The unique identifier for the resource. + returned: success + type: int + instances: + description: + - A list of virtual machine instances serving this pool. + - They must live in zones contained in the same region as this pool. + returned: success + type: list + 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 + sessionAffinity: + description: + - 'Session affinity option. Must be one of these values: - NONE: Connections from + 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 + in the pool while that instance remains healthy." + - "- 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." + returned: success + type: str + region: + description: + - The region where the target pool resides. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_pool_facts.py b/plugins/modules/gcp_compute_target_pool_facts.py index 6905743..b287f35 100644 --- a/plugins/modules/gcp_compute_target_pool_facts.py +++ b/plugins/modules/gcp_compute_target_pool_facts.py @@ -64,95 +64,95 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - backupPool: - description: - - 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 between [0, 1]. - - '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 below failoverRatio, traffic arriving at the load-balanced IP - will be directed to the backup pool.' - - 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 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. - returned: success - type: dict - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. - returned: success - type: str - failoverRatio: - description: - - 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). The value of the field must be in [0, 1]. - - '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 - pool is at or below this number, traffic arriving at the load-balanced IP - will be directed to the backup pool.' - - In case where failoverRatio is not set or all the instances in 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 - with the best effort, or to all instances when no instance is healthy. - returned: success - type: str - healthCheck: - description: - - A reference to a HttpHealthCheck resource. - - A member instance in this pool is considered healthy if and only if the health - checks pass. If not specified it means all member instances will be considered - healthy at all times. - returned: success - type: dict - id: - description: - - The unique identifier for the resource. - returned: success - type: int - instances: - description: - - A list of virtual machine instances serving this pool. - - They must live in zones contained in the same region as this pool. - returned: success - type: list - 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 - sessionAffinity: - description: - - 'Session affinity option. Must be one of these values: - NONE: Connections - from 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 - in the pool while that instance remains healthy." - - "- 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." - returned: success - type: str - region: - description: - - The region where the target pool resides. - returned: success - type: str +items: + description: List of items + returned: always + type: complex + contains: + backupPool: + description: + - 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 + between [0, 1]. + - '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 + below failoverRatio, traffic arriving at the load-balanced IP will be directed to + the backup pool.' + - 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 + 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. + returned: success + type: dict + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + failoverRatio: + description: + - 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). + The value of the field must be in [0, 1]. + - '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 + pool is at or below this number, traffic arriving at the load-balanced IP will be + directed to the backup pool.' + - In case where failoverRatio is not set or all the instances in 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 with the best effort, + or to all instances when no instance is healthy. + returned: success + type: str + healthCheck: + description: + - A reference to a HttpHealthCheck resource. + - A member instance in this pool is considered healthy if and only if the health checks + pass. If not specified it means all member instances will be considered healthy + at all times. + returned: success + type: dict + id: + description: + - The unique identifier for the resource. + returned: success + type: int + instances: + description: + - A list of virtual machine instances serving this pool. + - They must live in zones contained in the same region as this pool. + returned: success + type: list + 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 + sessionAffinity: + description: + - 'Session affinity option. Must be one of these values: - NONE: Connections from + 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 + in the pool while that instance remains healthy." + - "- 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." + returned: success + type: str + region: + description: + - The region where the target pool resides. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_ssl_proxy.py b/plugins/modules/gcp_compute_target_ssl_proxy.py index f9aee57..c5e4764 100644 --- a/plugins/modules/gcp_compute_target_ssl_proxy.py +++ b/plugins/modules/gcp_compute_target_ssl_proxy.py @@ -179,55 +179,48 @@ EXAMPLES = ''' ''' RETURN = ''' -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str -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 -service: - description: - - A reference to the BackendService resource. - returned: success - type: dict -sslCertificates: - description: - - 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. - returned: success - 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 + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + 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 + service: + description: + - A reference to the BackendService resource. + returned: success + type: dict + sslCertificates: + description: + - 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. + returned: success + type: list ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_ssl_proxy_facts.py b/plugins/modules/gcp_compute_target_ssl_proxy_facts.py index fadec07..fd7a6c0 100644 --- a/plugins/modules/gcp_compute_target_ssl_proxy_facts.py +++ b/plugins/modules/gcp_compute_target_ssl_proxy_facts.py @@ -59,61 +59,53 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - type: int - name: - description: - - Name of the resource. Provided by the client when the resource is created. - The name must be 1-63 characters long, and comply with RFC1035. Specifically, - the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str - 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 - service: - description: - - A reference to the BackendService resource. - returned: success - type: dict - sslCertificates: - description: - - 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. - returned: success - 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 +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + 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 + service: + description: + - A reference to the BackendService resource. + returned: success + type: dict + sslCertificates: + description: + - 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. + returned: success + type: list ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_tcp_proxy.py b/plugins/modules/gcp_compute_target_tcp_proxy.py index 390be2c..3ffb500 100644 --- a/plugins/modules/gcp_compute_target_tcp_proxy.py +++ b/plugins/modules/gcp_compute_target_tcp_proxy.py @@ -138,42 +138,42 @@ EXAMPLES = ''' ''' RETURN = ''' -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str -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 -service: - description: - - A reference to the BackendService resource. - returned: success - type: dict + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + 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 + service: + description: + - A reference to the BackendService resource. + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_tcp_proxy_facts.py b/plugins/modules/gcp_compute_target_tcp_proxy_facts.py index 6ec9554..8c03dd7 100644 --- a/plugins/modules/gcp_compute_target_tcp_proxy_facts.py +++ b/plugins/modules/gcp_compute_target_tcp_proxy_facts.py @@ -59,47 +59,47 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description of this resource. - returned: success - type: str - id: - description: - - The unique identifier for the resource. - returned: success - type: int - name: - description: - - Name of the resource. Provided by the client when the resource is created. - The name must be 1-63 characters long, and comply with RFC1035. Specifically, - the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str - 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 - service: - description: - - A reference to the BackendService resource. - returned: success - type: dict +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description of this resource. + returned: success + type: str + id: + description: + - The unique identifier for the resource. + returned: success + type: int + name: + description: + - Name of the resource. Provided by the client when the resource is created. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, the name must + be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + which means the first character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last character, which cannot + be a dash. + returned: success + type: str + 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 + service: + description: + - A reference to the BackendService resource. + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_vpn_gateway.py b/plugins/modules/gcp_compute_target_vpn_gateway.py index 2051d08..54a4fdf 100644 --- a/plugins/modules/gcp_compute_target_vpn_gateway.py +++ b/plugins/modules/gcp_compute_target_vpn_gateway.py @@ -111,52 +111,51 @@ EXAMPLES = ''' ''' RETURN = ''' -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description 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 -id: - description: - - The unique identifier for the resource. - returned: success - type: int -network: - description: - - The network this VPN gateway is accepting traffic for. - returned: success - type: dict -tunnels: - description: - - A list of references to VpnTunnel resources associated with this VPN gateway. - returned: success - type: list -forwardingRules: - description: - - A list of references to the ForwardingRule resources associated with this VPN - gateway. - returned: success - type: list -region: - description: - - The region this gateway should sit in. - returned: success - type: str + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description 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 + id: + description: + - The unique identifier for the resource. + returned: success + type: int + network: + description: + - The network this VPN gateway is accepting traffic for. + returned: success + type: dict + tunnels: + description: + - A list of references to VpnTunnel resources associated to this VPN gateway. + returned: success + type: list + forwardingRules: + description: + - A list of references to the ForwardingRule resources associated to this VPN gateway. + returned: success + type: list + region: + description: + - The region this gateway should sit in. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_target_vpn_gateway_facts.py b/plugins/modules/gcp_compute_target_vpn_gateway_facts.py index 7546270..f39ac5d 100644 --- a/plugins/modules/gcp_compute_target_vpn_gateway_facts.py +++ b/plugins/modules/gcp_compute_target_vpn_gateway_facts.py @@ -64,57 +64,56 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str - description: - description: - - An optional description 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 - id: - description: - - The unique identifier for the resource. - returned: success - type: int - network: - description: - - The network this VPN gateway is accepting traffic for. - returned: success - type: dict - tunnels: - description: - - A list of references to VpnTunnel resources associated with this VPN gateway. - returned: success - type: list - forwardingRules: - description: - - A list of references to the ForwardingRule resources associated with this - VPN gateway. - returned: success - type: list - region: - description: - - The region this gateway should sit in. - returned: success - type: str +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str + description: + description: + - An optional description 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 + id: + description: + - The unique identifier for the resource. + returned: success + type: int + network: + description: + - The network this VPN gateway is accepting traffic for. + returned: success + type: dict + tunnels: + description: + - A list of references to VpnTunnel resources associated to this VPN gateway. + returned: success + type: list + forwardingRules: + description: + - A list of references to the ForwardingRule resources associated to this VPN gateway. + returned: success + type: list + region: + description: + - The region this gateway should sit in. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_url_map.py b/plugins/modules/gcp_compute_url_map.py index 8842855..ef15c6b 100644 --- a/plugins/modules/gcp_compute_url_map.py +++ b/plugins/modules/gcp_compute_url_map.py @@ -216,137 +216,129 @@ EXAMPLES = ''' ''' RETURN = ''' -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - 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: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str defaultService: - description: - - A reference to a BackendService resource. This will be used if none of the - pathRules defined by this PathMatcher is matched by the URL's path portion. - returned: success - type: dict + description: + - A reference to BackendService resource if none of the hostRules match. + returned: success + type: dict description: - description: - - An optional description of this resource. - returned: success - type: str + 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 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: - description: - - The name to which this PathMatcher is referred by the HostRule. - returned: success - type: str - pathRules: - description: - - The list of path rules. - returned: success - type: complex - contains: - paths: - description: - - 'The list of path patterns to match. Each must start with / and the only - place a * is allowed is at the end following a /. The string fed to the - path matcher does not include any text after the first ? or #, and those - chars are not allowed here.' - returned: success - type: list - service: - description: - - A reference to the BackendService resource if this rule is matched. - returned: success - type: dict -tests: - description: - - The list of expected URL mappings. Requests 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 + 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: + description: + - A reference to a BackendService resource. This will be used if none of the pathRules + defined by this PathMatcher is matched by the URL's path portion. + returned: success + type: dict + description: + description: + - An optional description of this resource. + returned: success + type: str + name: + description: + - The name to which this PathMatcher is referred by the HostRule. + returned: success + type: str + pathRules: + description: + - The list of path rules. + returned: success + type: complex + contains: + paths: + description: + - 'The list of path patterns to match. Each must start with / and the only place a + * is allowed is at the end following a /. The string fed to the path matcher does + not include any text after the first ? or #, and those chars are not allowed here.' + returned: success + type: list + service: + description: + - A reference to the BackendService resource if this rule is matched. + returned: success + type: dict + tests: + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_url_map_facts.py b/plugins/modules/gcp_compute_url_map_facts.py index 930ef0d..e32b082 100644 --- a/plugins/modules/gcp_compute_url_map_facts.py +++ b/plugins/modules/gcp_compute_url_map_facts.py @@ -59,143 +59,134 @@ EXAMPLES = ''' ''' RETURN = ''' -resources: - description: List of resources - returned: always - type: complex - contains: - creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - 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: +items: + description: List of items + returned: always + type: complex + contains: + creationTimestamp: + description: + - Creation timestamp in RFC3339 text format. + returned: success + type: str defaultService: - description: - - A reference to a BackendService resource. This will be used if none of - the pathRules defined by this PathMatcher is matched by the URL's path - portion. - returned: success - type: dict + description: + - A reference to BackendService resource if none of the hostRules match. + returned: success + type: dict description: - description: - - An optional description of this resource. - returned: success - type: str + 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 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: - description: - - The name to which this PathMatcher is referred by the HostRule. - returned: success - type: str - pathRules: - description: - - The list of path rules. - returned: success - type: complex - contains: - paths: - description: - - 'The list of path patterns to match. Each must start with / and the - only place a * is allowed is at the end following a /. The string - fed to the path matcher does not include any text after the first - ? or #, and those chars are not allowed here.' - returned: success - type: list - service: - description: - - A reference to the BackendService resource if this rule is matched. - returned: success - type: dict - tests: - description: - - The list of expected URL mappings. Requests 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 + 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: + description: + - A reference to a BackendService resource. This will be used if none of the pathRules + defined by this PathMatcher is matched by the URL's path portion. + returned: success + type: dict + description: + description: + - An optional description of this resource. + returned: success + type: str + name: + description: + - The name to which this PathMatcher is referred by the HostRule. + returned: success + type: str + pathRules: + description: + - The list of path rules. + returned: success + type: complex + contains: + paths: + description: + - 'The list of path patterns to match. Each must start with / and the only place a + * is allowed is at the end following a /. The string fed to the path matcher does + not include any text after the first ? or #, and those chars are not allowed here.' + returned: success + type: list + service: + description: + - A reference to the BackendService resource if this rule is matched. + returned: success + type: dict + tests: + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_compute_vpn_tunnel.py b/plugins/modules/gcp_compute_vpn_tunnel.py index 490439b..eab5c68 100644 --- a/plugins/modules/gcp_compute_vpn_tunnel.py +++ b/plugins/modules/gcp_compute_vpn_tunnel.py @@ -171,7 +171,7 @@ EXAMPLES = ''' ''' RETURN = ''' - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -190,7 +190,7 @@ RETURN = ''' - An optional description of this resource. returned: success type: str - target_vpn_gateway: + targetVpnGateway: description: - URL of the Target VPN gateway with which this VPN tunnel is associated. returned: success @@ -200,29 +200,29 @@ RETURN = ''' - URL of router resource to be used for dynamic routing. returned: success type: dict - peer_ip: + peerIp: description: - IP address of the peer VPN gateway. Only IPv4 is supported. returned: success type: str - shared_secret: + sharedSecret: description: - Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. returned: success type: str - shared_secret_hash: + sharedSecretHash: description: - Hash of the shared secret. returned: success type: str - ike_version: + ikeVersion: description: - 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. returned: success type: int - local_traffic_selector: + localTrafficSelector: description: - 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 @@ -230,7 +230,7 @@ RETURN = ''' - Only IPv4 is supported. returned: success type: list - remote_traffic_selector: + remoteTrafficSelector: description: - 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 @@ -243,7 +243,7 @@ RETURN = ''' - Labels to apply to this VpnTunnel. returned: success type: dict - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. diff --git a/plugins/modules/gcp_compute_vpn_tunnel_facts.py b/plugins/modules/gcp_compute_vpn_tunnel_facts.py index f006d48..017512d 100644 --- a/plugins/modules/gcp_compute_vpn_tunnel_facts.py +++ b/plugins/modules/gcp_compute_vpn_tunnel_facts.py @@ -69,7 +69,7 @@ items: returned: always type: complex contains: - creation_timestamp: + creationTimestamp: description: - Creation timestamp in RFC3339 text format. returned: success @@ -88,7 +88,7 @@ items: - An optional description of this resource. returned: success type: str - target_vpn_gateway: + targetVpnGateway: description: - URL of the Target VPN gateway with which this VPN tunnel is associated. returned: success @@ -98,29 +98,29 @@ items: - URL of router resource to be used for dynamic routing. returned: success type: dict - peer_ip: + peerIp: description: - IP address of the peer VPN gateway. Only IPv4 is supported. returned: success type: str - shared_secret: + sharedSecret: description: - Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. returned: success type: str - shared_secret_hash: + sharedSecretHash: description: - Hash of the shared secret. returned: success type: str - ike_version: + ikeVersion: description: - 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. returned: success type: int - local_traffic_selector: + localTrafficSelector: description: - 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 @@ -128,7 +128,7 @@ items: - Only IPv4 is supported. returned: success type: list - remote_traffic_selector: + remoteTrafficSelector: description: - 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 @@ -141,7 +141,7 @@ items: - Labels to apply to this VpnTunnel. returned: success type: dict - label_fingerprint: + labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. diff --git a/plugins/modules/gcp_container_cluster.py b/plugins/modules/gcp_container_cluster.py index 1380b6e..d0aa3fc 100644 --- a/plugins/modules/gcp_container_cluster.py +++ b/plugins/modules/gcp_container_cluster.py @@ -292,325 +292,292 @@ EXAMPLES = ''' ''' RETURN = ''' -name: - description: - - The name of this cluster. The name must be unique within this project and location, - 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. - returned: success - type: str -description: - description: - - An optional description of this cluster. - returned: success - type: str -initialNodeCount: - description: - - 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 - have available firewall and routes quota. For requests, this field should only - be used in lieu of a "nodePool" object, since this configuration (along with the - "nodeConfig") will be used to create a "NodePool" object with an auto-generated - name. Do not use this and a nodePool at the same time. - returned: success - type: int -nodeConfig: - description: - - Parameters used in creating the cluster's nodes. - - 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 - a "NodePool" object with an auto-generated name. Do not use this and a nodePool - at 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. - 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 -masterAuth: - description: - - The authentication information for accessing the master endpoint. - returned: success - type: complex - contains: - username: - description: - - The username to use for HTTP basic authentication to the master endpoint. - returned: success - type: str - password: - description: - - The password to use for HTTP basic authentication to the master endpoint. - Because the master endpoint is open to the Internet, you should create a strong - password. - returned: success - type: str - clusterCaCertificate: - description: - - Base64-encoded public certificate that is the root of trust for the cluster. - returned: success - type: str - clientCertificate: - description: - - Base64-encoded public certificate used by clients to authenticate to the cluster - endpoint. - returned: success - type: str - clientKey: - description: - - Base64-encoded private key used by clients to authenticate to the cluster - endpoint. - returned: success - type: str -loggingService: - description: - - 'The logging service the cluster should use to write logs. Currently available - options: logging.googleapis.com - the Google Cloud Logging service.' - - none - no logs will be exported from the cluster. - - if left as an empty string,logging.googleapis.com will be used. - returned: success - type: str -monitoringService: - description: - - The monitoring service the cluster should use to write metrics. - - 'Currently available options: monitoring.googleapis.com - the Google Cloud Monitoring - service.' - - none - no metrics will be exported from the cluster. - - if left as an empty string, monitoring.googleapis.com will be used. - returned: success - type: str -network: - description: - - The name of the Google Compute Engine network to which the cluster is connected. - If left unspecified, the default network will be used. - returned: success - type: str -privateClusterConfig: - description: - - Configuration for a private cluster. - returned: success - type: complex - contains: - enablePrivateNodes: - description: - - Whether nodes have internal IP addresses only. If enabled, all nodes are given - only RFC 1918 private addresses and communicate with the master via private - networking. - returned: success - type: bool - enablePrivateEndpoint: - description: - - Whether the master's internal IP address is used as the cluster endpoint. - returned: success - type: bool - masterIpv4CidrBlock: - description: - - The IP range in CIDR notation to use for the hosted master network. This range - will be used for assigning internal IP addresses to the master or set of masters, - as well as the ILB VIP. This range must not overlap with any other ranges - in use within the cluster's network. - returned: success - type: str - privateEndpoint: - description: - - The internal IP address of this cluster's master endpoint. - returned: success - type: str - publicEndpoint: - description: - - The external IP address of this cluster's master endpoint. - returned: success - type: str -clusterIpv4Cidr: - description: - - The IP address range of the container pods in this cluster, in CIDR notation (e.g. - 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block - in 10.0.0.0/8. - returned: success - type: str -addonsConfig: - description: - - Configurations for the various addons available to run in the cluster. - returned: success - type: complex - contains: - httpLoadBalancing: - description: - - Configuration for the HTTP (L7) load balancing controller addon, which makes - it easy to set up HTTP load balancers for services in a cluster. - returned: success - type: complex - contains: - disabled: - description: - - Whether the HTTP Load Balancing controller is enabled in the cluster. - When enabled, it runs a small pod in the cluster that manages the load - balancers. - returned: success - type: bool - horizontalPodAutoscaling: - description: - - Configuration for the horizontal pod autoscaling feature, which increases - or decreases the number of replica pods a replication controller has based - on the resource usage of the existing pods. - returned: success - type: complex - contains: - disabled: - description: - - Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. - When enabled, it ensures that a Heapster pod is running in the cluster, - which is also used by the Cloud Monitoring service. - returned: success - type: bool -subnetwork: - description: - - The name of the Google Compute Engine subnetwork to which the cluster is connected. - returned: success - type: str -endpoint: - description: - - The IP address of this cluster's master endpoint. - - The endpoint can be accessed from the internet at https://username:password@endpoint/ - See the masterAuth property of this resource for username and password information. - returned: success - type: str -initialClusterVersion: - description: - - The software version of the master endpoint and kubelets used in the cluster when - it was first created. The version can be upgraded over time. - returned: success - type: str -currentMasterVersion: - description: - - The current software version of the master endpoint. - returned: success - type: str -currentNodeVersion: - description: - - The current version of the node software components. If they are currently at - multiple versions because they're in the process of being upgraded, this reflects - the minimum version of all nodes. - returned: success - 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 + name: + description: + - 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 + only. Must start with a letter. Must end with a number or a letter. + returned: success + type: str + description: + description: + - An optional description of this cluster. + returned: success + type: str + initialNodeCount: + description: + - 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 + have available firewall and routes quota. For requests, this field should only be + used in lieu of a "nodePool" object, since this configuration (along with the "nodeConfig") + will be used to create a "NodePool" object with an auto-generated name. Do not use + this and a nodePool at the same time. + returned: success + type: int + nodeConfig: + description: + - Parameters used in creating the cluster's nodes. + - 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 a + "NodePool" object with an auto-generated name. Do not use this and a nodePool at + 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. + 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 inforamtion about preemptible VM instances.' + returned: success + type: bool + masterAuth: + description: + - The authentication information for accessing the master endpoint. + returned: success + type: complex + contains: + username: + description: + - The username to use for HTTP basic authentication to the master endpoint. + returned: success + type: str + password: + description: + - The password to use for HTTP basic authentication to the master endpoint. Because + the master endpoint is open to the Internet, you should create a strong password. + returned: success + type: str + clusterCaCertificate: + description: + - Base64-encoded public certificate that is the root of trust for the cluster. + returned: success + type: str + clientCertificate: + description: + - Base64-encoded public certificate used by clients to authenticate to the cluster + endpoint. + returned: success + type: str + clientKey: + description: + - Base64-encoded private key used by clients to authenticate to the cluster endpoint. + returned: success + type: str + loggingService: + description: + - 'The logging service the cluster should use to write logs. Currently available options: logging.googleapis.com + - the Google Cloud Logging service.' + - none - no logs will be exported from the cluster. + - if left as an empty string,logging.googleapis.com will be used. + returned: success + type: str + monitoringService: + description: + - The monitoring service the cluster should use to write metrics. + - 'Currently available options: monitoring.googleapis.com - the Google Cloud Monitoring + service.' + - none - no metrics will be exported from the cluster. + - if left as an empty string, monitoring.googleapis.com will be used. + returned: success + type: str + network: + description: + - The name of the Google Compute Engine network to which the cluster is connected. + If left unspecified, the default network will be used. + - To ensure it exists and it is operations, configure the network using 'gcompute_network' + resource. + returned: success + type: str + clusterIpv4Cidr: + description: + - The IP address range of the container pods in this cluster, in CIDR notation (e.g. + 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block + in 10.0.0.0/8. + returned: success + type: str + addonsConfig: + description: + - Configurations for the various addons available to run in the cluster. + returned: success + type: complex + contains: + httpLoadBalancing: + description: + - Configuration for the HTTP (L7) load balancing controller addon, which makes it + easy to set up HTTP load balancers for services in a cluster. + returned: success + type: complex + contains: + disabled: + description: + - Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, + it runs a small pod in the cluster that manages the load balancers. + returned: success + type: bool + horizontalPodAutoscaling: + description: + - Configuration for the horizontal pod autoscaling feature, which increases or decreases + the number of replica pods a replication controller has based on the resource usage + of the existing pods. + returned: success + type: complex + contains: + disabled: + description: + - Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, + it ensures that a Heapster pod is running in the cluster, which is also used by + the Cloud Monitoring service. + returned: success + type: bool + subnetwork: + description: + - The name of the Google Compute Engine subnetwork to which the cluster is connected. + returned: success + type: str + location: + description: + - The list of Google Compute Engine locations in which the cluster's nodes should + be located. + returned: success + type: list + endpoint: + description: + - The IP address of this cluster's master endpoint. + - The endpoint can be accessed from the internet at https://username:password@endpoint/ See + the masterAuth property of this resource for username and password information. + returned: success + type: str + initialClusterVersion: + description: + - The software version of the master endpoint and kubelets used in the cluster when + it was first created. The version can be upgraded over time. + returned: success + type: str + currentMasterVersion: + description: + - The current software version of the master endpoint. + returned: success + type: str + currentNodeVersion: + description: + - The current version of the node software components. If they are currently at multiple + versions because they're in the process of being upgraded, this reflects the minimum + version of all nodes. + returned: success + 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 + zone: + description: + - The zone where the cluster is deployed. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_container_node_pool.py b/plugins/modules/gcp_container_node_pool.py index 09b815e..3cfc641 100644 --- a/plugins/modules/gcp_container_node_pool.py +++ b/plugins/modules/gcp_container_node_pool.py @@ -239,187 +239,185 @@ EXAMPLES = ''' ''' RETURN = ''' -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 + name: 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 -location: - description: - - The location where the node pool is deployed. - returned: success - type: str + - 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 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_dns_managed_zone.py b/plugins/modules/gcp_dns_managed_zone.py index bbbcb76..bb1d589 100644 --- a/plugins/modules/gcp_dns_managed_zone.py +++ b/plugins/modules/gcp_dns_managed_zone.py @@ -121,79 +121,47 @@ EXAMPLES = ''' ''' RETURN = ''' -description: - description: - - A mutable string of at most 1024 characters associated with this resource for - the user's convenience. Has no effect on the managed zone's function. - returned: success - type: str -dnsName: - description: - - The DNS name of this managed zone, for instance "example.com.". - returned: success - type: str -id: - description: - - Unique identifier for the resource; defined by the server. - returned: success - type: int -name: - description: - - User assigned name for this resource. - - Must be unique within the project. - returned: success - type: str -nameServers: - description: - - Delegate your managed_zone to these virtual name servers; defined by the server - . - returned: success - type: list -nameServerSet: - description: - - 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 this field unset. - returned: success - type: str -creationTime: - description: - - The time that this resource was created on the server. - - This is in RFC3339 text format. - returned: success - 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 + description: + description: + - A mutable string of at most 1024 characters associated with this resource for the + user's convenience. Has no effect on the managed zone's function. + returned: success + type: str + dnsName: + description: + - The DNS name of this managed zone, for instance "example.com.". + returned: success + type: str + id: + description: + - Unique identifier for the resource; defined by the server. + returned: success + type: int + name: + description: + - User assigned name for this resource. + - Must be unique within the project. + returned: success + type: str + nameServers: + description: + - Delegate your managed_zone to these virtual name servers; defined by the server + . + returned: success + type: list + nameServerSet: + description: + - 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 + this field unset. + returned: success + type: list + creationTime: + description: + - The time that this resource was created on the server. + - This is in RFC3339 text format. + returned: success + type: str ''' ################################################################################ diff --git a/plugins/modules/gcp_dns_managed_zone_facts.py b/plugins/modules/gcp_dns_managed_zone_facts.py index 04618a2..48adc7b 100644 --- a/plugins/modules/gcp_dns_managed_zone_facts.py +++ b/plugins/modules/gcp_dns_managed_zone_facts.py @@ -68,7 +68,7 @@ items: user's convenience. Has no effect on the managed zone's function. returned: success type: str - dns_name: + dnsName: description: - The DNS name of this managed zone, for instance "example.com.". returned: success @@ -84,20 +84,20 @@ items: - Must be unique within the project. returned: success type: str - name_servers: + nameServers: description: - Delegate your managed_zone to these virtual name servers; defined by the server . returned: success type: list - name_server_set: + nameServerSet: description: - 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 this field unset. returned: success type: list - creation_time: + creationTime: description: - The time that this resource was created on the server. - This is in RFC3339 text format. diff --git a/plugins/modules/gcp_pubsub_subscription.py b/plugins/modules/gcp_pubsub_subscription.py index da1d7f8..b8c5420 100644 --- a/plugins/modules/gcp_pubsub_subscription.py +++ b/plugins/modules/gcp_pubsub_subscription.py @@ -164,90 +164,48 @@ EXAMPLES = ''' ''' RETURN = ''' -name: - description: - - Name of the subscription. - returned: success - type: str -topic: - description: - - A reference to a Topic resource. - returned: success - type: dict -labels: - description: - - A set of key/value label pairs to assign to this Subscription. - returned: success - type: dict -pushConfig: - description: - - 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 - using API methods. - returned: success - type: complex - contains: - pushEndpoint: - description: - - A URL locating the endpoint to which messages should be pushed. - - For example, a Webhook endpoint might use "U(https://example.com/push".) - returned: success - type: str - attributes: - description: - - Endpoint configuration attributes. - - Every endpoint has a set of API supported attributes that can be used to control - different aspects of the message delivery. - - The currently supported attribute is x-goog-version, which you can use to - change the format of the pushed message. This attribute indicates the version - of the data expected by the endpoint. This controls the shape of the pushed - message (i.e., its fields and metadata). The endpoint version is based on - the version of the Pub/Sub API. - - If not present during the subscriptions.create call, it will default to the - version of the API used to make such call. If not present during a subscriptions.modifyPushConfig - call, its value will not be changed. subscriptions.get calls will always return - a valid version, even if the subscription was created without this attribute. - - 'The possible values for this attribute are: - v1beta1: uses the push format - defined in the v1beta1 Pub/Sub API.' - - "- v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API." - returned: success - type: dict -ackDeadlineSeconds: - 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 + name: + description: + - Name of the subscription. + returned: success + type: str + topic: + description: + - A reference to a Topic resource. + returned: success + type: dict + pushConfig: + description: + - 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 + using API methods. + returned: success + type: complex + contains: + pushEndpoint: + description: + - A URL locating the endpoint to which messages should be pushed. + - For example, a Webhook endpoint might use "U(https://example.com/push".) + returned: success + type: str + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_pubsub_subscription_facts.py b/plugins/modules/gcp_pubsub_subscription_facts.py index 93e102c..fc75d95 100644 --- a/plugins/modules/gcp_pubsub_subscription_facts.py +++ b/plugins/modules/gcp_pubsub_subscription_facts.py @@ -67,7 +67,7 @@ items: - A reference to a Topic resource. returned: success type: dict - push_config: + pushConfig: description: - 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 @@ -75,13 +75,13 @@ items: returned: success type: complex contains: - push_endpoint: + pushEndpoint: description: - A URL locating the endpoint to which messages should be pushed. - For example, a Webhook endpoint might use "U(https://example.com/push".) returned: success type: str - ack_deadline_seconds: + 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 diff --git a/plugins/modules/gcp_spanner_database.py b/plugins/modules/gcp_spanner_database.py index ef8148b..b7b3939 100644 --- a/plugins/modules/gcp_spanner_database.py +++ b/plugins/modules/gcp_spanner_database.py @@ -100,25 +100,25 @@ EXAMPLES = ''' ''' RETURN = ''' -name: - description: - - 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]. - returned: success - type: str -extraStatements: - description: - - 'An optional list of DDL statements to run inside the newly created database. - Statements can create tables, indexes, etc. These statements execute atomically - with the creation of the database: if there is an error in any statement, the - database is not created.' - returned: success - type: list -instance: - description: - - The instance to create the database on. - returned: success - type: dict + name: + description: + - A unique identifier for the database, which cannot be changed after the instance + is created. Values are of the form projects//instances/[a-z][-a-z0-9]*[a-z0-9]. + The final segment of the name must be between 6 and 30 characters in length. + returned: success + type: str + extraStatements: + description: + - 'An optional list of DDL statements to run inside the newly created database. Statements + can create tables, indexes, etc. These statements execute atomically with the creation + of the database: if there is an error in any statement, the database is not created.' + returned: success + type: list + instance: + description: + - The instance to create the database on. + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_spanner_instance.py b/plugins/modules/gcp_spanner_instance.py index 136979b..75a16b3 100644 --- a/plugins/modules/gcp_spanner_instance.py +++ b/plugins/modules/gcp_spanner_instance.py @@ -98,39 +98,51 @@ EXAMPLES = ''' ''' RETURN = ''' -name: - description: - - 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. - returned: success - type: str -config: - description: - - The name of the instance's configuration (similar but not quite the same as a - region) which defines defines the geographic placement and replication of your - databases in this instance. It determines where your data is stored. Values are - typically of the form `regional-europe-west1` , `us-central` etc. - - In order to obtain a valid list please consult the [Configuration section of the - docs](U(https://cloud.google.com/spanner/docs/instances).) - returned: success - type: str -displayName: - description: - - The descriptive name for this instance as it appears in UIs. Must be unique per - project and between 4 and 30 characters in length. - returned: success - type: str -nodeCount: - description: - - The number of nodes allocated to this instance. - returned: success - type: int -labels: - description: - - 'An object containing a list of "key": value pairs.' - - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' - returned: success - type: dict + name: + description: + - A unique identifier for the instance, which cannot be changed after the instance + is created. Values are of the form projects//instances/[a-z][-a-z0-9]*[a-z0-9]. + The final segment of the name must be between 6 and 30 characters in length. + returned: success + type: str + config: + description: + - A reference to the instance configuration. + returned: success + type: str + displayName: + description: + - The descriptive name for this instance as it appears in UIs. Must be unique per + project and between 4 and 30 characters in length. + returned: success + type: str + nodeCount: + description: + - The number of nodes allocated to this instance. + returned: success + type: int + labels: + description: + - Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources + into groups that reflect a customer's organizational needs and deployment strategies. + Cloud Labels can be used to filter collections of resources. They can be used to + control how resource metrics are aggregated. And they can be used as arguments to + policy management rules (e.g. route, firewall, load balancing, etc.). + - 'Label keys must be between 1 and 63 characters long and must conform to the following + regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.' + - Label values must be between 0 and 63 characters long and must conform to the regular + expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. + - No more than 64 labels can be associated with a given resource. + - See U(https://goo.gl/xmQnxf) for more information on and examples of labels. + - 'If you plan to use labels in your own code, please note that additional characters + may be allowed in the future. And so you are advised to use an internal label representation, + such as JSON, which doesn''t rely upon specific characters being disallowed. For + example, representing labels as the string: name + "_" + value would prove problematic + if we were to allow "_" in a future release.' + - 'An object containing a list of "key": value pairs.' + - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' + returned: success + type: dict ''' ################################################################################ diff --git a/plugins/modules/gcp_sql_instance.py b/plugins/modules/gcp_sql_instance.py index 02b39e0..0c28fb2 100644 --- a/plugins/modules/gcp_sql_instance.py +++ b/plugins/modules/gcp_sql_instance.py @@ -335,41 +335,96 @@ EXAMPLES = ''' ''' RETURN = ''' -backendType: - description: - - "* FIRST_GEN: First Generation instance. MySQL only." - - "* SECOND_GEN: Second Generation instance or PostgreSQL instance." - - "* EXTERNAL: A database server that is not managed by Google." - returned: success - type: str -connectionName: - description: - - Connection name of the Cloud SQL instance used in connection strings. - returned: success - type: str -databaseVersion: - description: - - 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. - Defaults to MYSQL_5_6. - - 'PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed - after instance creation.' - returned: success - type: str -failoverReplica: - description: - - The name and status of the failover replica. This property is applicable only - to Second Generation instances. - returned: success - type: complex - contains: - available: - description: - - The availability status of the failover replica. A false status indicates - that the failover replica is out of sync. The master can only failover to - the failover replica when the status is true. - returned: success - type: bool + backendType: + description: + - "* FIRST_GEN: First Generation instance. MySQL only." + - "* SECOND_GEN: Second Generation instance or PostgreSQL instance." + - "* EXTERNAL: A database server that is not managed by Google." + returned: success + type: str + connectionName: + description: + - Connection name of the Cloud SQL instance used in connection strings. + returned: success + type: str + databaseVersion: + description: + - 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. Defaults + to MYSQL_5_6. + - 'PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed + after instance creation.' + returned: success + type: str + failoverReplica: + description: + - The name and status of the failover replica. This property is applicable only to + Second Generation instances. + returned: success + type: complex + contains: + available: + description: + - The availability status of the failover replica. A false status indicates that the + failover replica is out of sync. The master can only failover to the falover replica + when the status is true. + returned: success + 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: description: - 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). returned: success type: str - replica_configuration: + replicaConfiguration: description: - Configuration specific to failover replicas and read replicas. returned: success type: complex contains: - failover_target: + failoverTarget: description: - Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. @@ -397,7 +452,7 @@ failoverReplica: in different zone with the master instance. returned: success type: bool - mysql_replica_configuration: + mysqlReplicaConfiguration: description: - MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys @@ -407,28 +462,28 @@ failoverReplica: returned: success type: complex contains: - ca_certificate: + caCertificate: description: - PEM representation of the trusted CA's x509 certificate. returned: success type: str - client_certificate: + clientCertificate: description: - PEM representation of the slave's x509 certificate . returned: success type: str - client_key: + clientKey: description: - PEM representation of the slave's private key. The corresponsing public key is encoded in the client's asf asd certificate. returned: success type: str - connect_retry_interval: + connectRetryInterval: description: - Seconds to wait between connect retries. MySQL's default is 60 seconds. returned: success type: int - dump_file_path: + dumpFilePath: description: - 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 @@ -437,7 +492,7 @@ failoverReplica: when using mysqldump. returned: success type: str - master_heartbeat_period: + masterHeartbeatPeriod: description: - Interval in milliseconds between replication heartbeats. returned: success @@ -447,7 +502,7 @@ failoverReplica: - The password for the replication connection. returned: success type: str - ssl_cipher: + sslCipher: description: - A list of permissible ciphers to use for SSL encryption. returned: success @@ -457,18 +512,18 @@ failoverReplica: - The username for the replication connection. returned: success type: str - verify_server_certificate: + verifyServerCertificate: description: - Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. returned: success type: bool - replica_names: + replicaNames: description: - The replicas of the instance. returned: success type: list - service_account_email_address: + serviceAccountEmailAddress: description: - The service account email address assigned to the instance. This property is applicable only to Second Generation instances. @@ -480,7 +535,7 @@ failoverReplica: returned: success type: complex contains: - ip_configuration: + ipConfiguration: description: - 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 @@ -488,19 +543,19 @@ failoverReplica: returned: success type: complex contains: - ipv4_enabled: + ipv4Enabled: description: - Whether the instance should be assigned an IP address or not. returned: success type: bool - authorized_networks: + authorizedNetworks: description: - 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). returned: success type: complex contains: - expiration_time: + expirationTime: description: - The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -518,7 +573,7 @@ failoverReplica: or subnet here. returned: success type: str - require_ssl: + requireSsl: description: - Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP. returned: success @@ -530,7 +585,7 @@ failoverReplica: or First Generation. returned: success type: str - settings_version: + settingsVersion: description: - 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 diff --git a/plugins/modules/gcp_storage_bucket.py b/plugins/modules/gcp_storage_bucket.py index 34a3d54..7f3fafb 100644 --- a/plugins/modules/gcp_storage_bucket.py +++ b/plugins/modules/gcp_storage_bucket.py @@ -351,373 +351,372 @@ EXAMPLES = ''' ''' RETURN = ''' -acl: - description: - - Access controls on the bucket. - 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 + acl: + description: + - Access controls on the bucket. + 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 + 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: - 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}} (such as "user-liz@example.com") * group-{{groupId}} * group-{{email}} - (such as "group-example@googlegroups.com") * domain-{{domain}} (such as "domain-example.com") - * project-team-{{projectId}} * allUsers * allAuthenticatedUsers .' - 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: - description: - - The ID of the bucket. For buckets, the id and name properities are the same. - returned: success - type: str -lifecycle: - description: - - The bucket's lifecycle configuration. - - See U(https://developers.google.com/storage/docs/lifecycle) for more information. - returned: success - type: complex - contains: - rule: - description: - - A lifecycle management rule, which is made of an action to take and the condition(s) - under which the action will be taken. - returned: success - type: complex - contains: - action: - description: - - The action to take. - returned: success - type: complex - contains: - storageClass: - description: - - Target storage class. Required iff the type of the action is SetStorageClass. - returned: success - type: str - type: - description: - - Type of the action. Currently, only Delete and SetStorageClass are - supported. - returned: success - type: str - condition: - description: - - The condition(s) under which the action will be taken. - returned: success - type: complex - contains: - ageDays: - description: - - Age of an object (in days). This condition is satisfied when an object - reaches the specified age. - returned: success - type: int - createdBefore: - description: - - A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). - This condition is satisfied when an object is created before midnight - of the specified date in UTC. - returned: success - type: str - isLive: - description: - - Relevant only for versioned objects. If the value is true, this condition - matches live objects; if the value is false, it matches archived objects. - returned: success - type: bool - matchesStorageClass: - description: - - Objects having any of the storage classes specified by this condition - will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, - COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. - returned: success - type: list - numNewerVersions: - description: - - Relevant only for versioned objects. If the value is N, this condition - is satisfied when there are at least N versions (including the live - version) newer than this version of the object. - 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 + description: + - The ID of the bucket. For buckets, the id and name properities are the same. + returned: success + type: str + lifecycle: + description: + - The bucket's lifecycle configuration. + - See U(https://developers.google.com/storage/docs/lifecycle) for more information. + returned: success + type: complex + contains: + rule: + description: + - A lifecycle management rule, which is made of an action to take and the condition(s) + under which the action will be taken. + returned: success + type: complex + contains: + action: + description: + - The action to take. + returned: success + type: complex + contains: + storageClass: + description: + - Target storage class. Required iff the type of the action is SetStorageClass. + returned: success + type: str + type: + description: + - Type of the action. Currently, only Delete and SetStorageClass are supported. + returned: success + type: str + condition: + description: + - The condition(s) under which the action will be taken. + returned: success + type: complex + contains: + ageDays: + description: + - Age of an object (in days). This condition is satisfied when an object reaches the + specified age. + returned: success + type: int + createdBefore: + description: + - A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). + This condition is satisfied when an object is created before midnight of the specified + date in UTC. + returned: success + type: str + isLive: + description: + - Relevant only for versioned objects. If the value is true, this condition matches + live objects; if the value is false, it matches archived objects. + returned: success + type: bool + matchesStorageClass: + description: + - Objects having any of the storage classes specified by this condition will be matched. + Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. + returned: success + type: list + numNewerVersions: + description: + - Relevant only for versioned objects. If the value is N, this condition is satisfied + when there are at least N versions (including the live version) newer than this + version of the object. + 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 ''' ################################################################################ diff --git a/plugins/modules/gcp_storage_bucket_access_control.py b/plugins/modules/gcp_storage_bucket_access_control.py index 156c6b5..b527256 100644 --- a/plugins/modules/gcp_storage_bucket_access_control.py +++ b/plugins/modules/gcp_storage_bucket_access_control.py @@ -128,62 +128,63 @@ EXAMPLES = ''' ''' RETURN = ''' -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 -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 + 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 + 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 ''' ################################################################################