W3cubDocs

/Ansible

google.cloud.gcp_compute_snapshot – Creates a GCP Snapshot

Note

This plugin is part of the google.cloud collection (version 1.0.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Represents a Persistent Disk Snapshot resource.
Use snapshots to back up data from your persistent disks. Snapshots are different from public images and custom images, which are used primarily to create instances or configure instance templates. Snapshots are useful for periodic backup of the data on your persistent disks. You can create snapshots from persistent disks even while they are attached to running instances.
Snapshots are incremental, so you can create regular snapshots on a persistent disk faster and at a much lower cost than if you regularly created a full image of the disk.

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.
description string			An optional description of this resource.
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.
labels dictionary			Labels to apply to this Snapshot.
name string / required			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.
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.
snapshot_encryption_key dictionary			The customer-supplied encryption key of the snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
	kms_key_name string		The name of the encryption key that is stored in Google Cloud KMS.
	kms_key_service_account string		The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.
	raw_key string		Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
source_disk dictionary / required			A reference to the disk used to create this snapshot. This field represents a link to a Disk resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'name' and value of your resource's name Alternatively, you can add `register: name-of-resource` to a gcp_compute_disk task and then set this source_disk field to "{{ name-of-resource }}"
source_disk_encryption_key dictionary			The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
	kms_key_name string		The name of the encryption key that is stored in Google Cloud KMS.
	kms_key_service_account string		The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.
	raw_key string		Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
state string		Choices: present ← absent	Whether the given object should exist in GCP
storage_locations list / elements=string			Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
zone string			A reference to the zone where the disk is hosted.

Notes

Note

API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/snapshots
Official Documentation: https://cloud.google.com/compute/docs/disks/create-snapshots
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: create a disk
  google.cloud.gcp_compute_disk:
    name: disk-snapshot
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: disk

- name: create a snapshot
  google.cloud.gcp_compute_snapshot:
    name: test_object
    source_disk: "{{ disk }}"
    zone: us-central1-a
    labels:
      my_label: value
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

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

Key		Returned	Description
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_snapshot_module.html