delowan / delowan.googlecloud / 1.0.2 / module / gcp_compute_snapshot Creates a GCP Snapshot Authors: Google Inc. (@googlecloudplatform) preview | supported by communitydelowan.googlecloud.gcp_compute_snapshot (1.0.2) — module
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections: - name: delowan.googlecloud version: 1.0.2
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.
- 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
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. required: true type: str zone: description: - A reference to the zone where the disk is hosted. required: false type: str state: choices: - present - absent default: present description: - Whether the given object should exist in GCP type: str labels: description: - Labels to apply to this Snapshot. required: false type: dict scopes: description: - Array of scopes to be used elements: str type: list project: description: - The Google Cloud Platform project to use. type: str env_type: description: - 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. type: str auth_kind: choices: - application - machineaccount - serviceaccount description: - The type of credential used. required: true type: str description: description: - An optional description of this resource. required: false type: str source_disk: description: - 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 }}"' required: true type: dict storage_locations: description: - Cloud Storage bucket storage location of the snapshot (regional or multi-regional). elements: str required: false type: list service_account_file: description: - The path of a Service Account JSON file if serviceaccount is selected as type. type: path service_account_email: description: - An optional service account email address if machineaccount is selected and the user does not wish to use the default email. type: str snapshot_encryption_key: description: - The customer-supplied encryption key of the snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. required: false suboptions: kms_key_name: description: - The name of the encryption key that is stored in Google Cloud KMS. required: false type: str kms_key_service_account: description: - The service account used for the encryption request for the given KMS key. - If absent, the Compute Engine Service Agent service account is used. required: false type: str raw_key: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. required: false type: str type: dict service_account_contents: description: - The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. type: jsonarg source_disk_encryption_key: description: - The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. required: false suboptions: kms_key_name: description: - The name of the encryption key that is stored in Google Cloud KMS. required: false type: str kms_key_service_account: description: - The service account used for the encryption request for the given KMS key. - If absent, the Compute Engine Service Agent service account is used. required: false type: str raw_key: description: - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. required: false type: str 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 diskSizeGb: description: - Size of the snapshot, specified in GB. returned: success type: int id: description: - The unique identifier for the resource. returned: success type: int labelFingerprint: description: - The fingerprint used for optimistic locking of this resource. Used internally during updates. returned: success type: str labels: description: - Labels to apply to this Snapshot. returned: success type: dict licenses: description: - 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. 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 snapshotEncryptionKey: contains: kmsKeyName: description: - The name of the encryption key that is stored in Google Cloud KMS. returned: success type: str kmsKeyServiceAccount: description: - The service account used for the encryption request for the given KMS key. - If absent, the Compute Engine Service Agent service account is used. returned: success type: str 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 description: - The customer-supplied encryption key of the snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. returned: success type: complex sourceDisk: description: - A reference to the disk used to create this snapshot. returned: success type: dict sourceDiskEncryptionKey: contains: kmsKeyName: description: - The name of the encryption key that is stored in Google Cloud KMS. returned: success type: str kmsKeyServiceAccount: description: - The service account used for the encryption request for the given KMS key. - If absent, the Compute Engine Service Agent service account is used. returned: success type: str 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 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 storageBytes: description: - A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. returned: success type: int storageLocations: description: - Cloud Storage bucket storage location of the snapshot (regional or multi-regional). returned: success type: list zone: description: - A reference to the zone where the disk is hosted. returned: success type: str