W3cubDocs

/Ansible 2.10

google.cloud.gcp_compute_snapshot_info – Gather info for GCP Snapshot

Note

This plugin is part of the google.cloud collection.

To install it use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_snapshot_info.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Gather info for GCP Snapshot

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Parameters

Parameter	Choices/Defaults	Comments
auth_kind string / required	Choices: application machineaccount serviceaccount	The type of credential used.
env_type string		Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests.
filters list / elements=string		A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) .
project string		The Google Cloud Platform project to use.
scopes list / elements=string		Array of scopes to be used
service_account_contents jsonarg		The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email string		An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file path		The path of a Service Account JSON file if serviceaccount is selected as type.

Notes

Note

for authentication, you can set service_account_file using the gcp_service_account_file env variable.
for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
For authentication, you can set scopes using the GCP_SCOPES env variable.
Environment variables values will only be used if the playbook values are not set.
The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: get info on a snapshot
  gcp_compute_snapshot_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
resources complex			always	List of resources
	creationTimestamp string		success	Creation timestamp in RFC3339 text format.
	description string		success	An optional description of this resource.
	diskSizeGb integer		success	Size of the snapshot, specified in GB.
	id integer		success	The unique identifier for the resource.
	labelFingerprint string		success	The fingerprint used for optimistic locking of this resource. Used internally during updates.
	labels dictionary		success	Labels to apply to this Snapshot.
	licenses list / elements=string		success	A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). snapshotEncryptionKey nested object Encrypts the snapshot using a customer-supplied encryption key.
	name string		success	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.
	snapshotEncryptionKey complex		success	The customer-supplied encryption key of the snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
		kmsKeyName string	success	The name of the encryption key that is stored in Google Cloud KMS.
		kmsKeyServiceAccount string	success	The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.
		rawKey string	success	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
		sha256 string	success	The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
	sourceDisk dictionary		success	A reference to the disk used to create this snapshot.
	sourceDiskEncryptionKey complex		success	The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
		kmsKeyName string	success	The name of the encryption key that is stored in Google Cloud KMS.
		kmsKeyServiceAccount string	success	The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.
		rawKey string	success	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
	storageBytes integer		success	A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
	storageLocations list / elements=string		success	Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
	zone string		success	A reference to the zone where the disk is hosted.

Authors

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_snapshot_info_module.html