community.google.gce_snapshot module – Create or destroy snapshots for GCE storage volumes
Note
This module is part of the community.google collection (version 1.0.0).
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 community.google
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.google.gce_snapshot
.
Synopsis
Manages snapshots for GCE instances. This module manages snapshots for the storage volumes of a GCE compute instance. If there are multiple volumes, each snapshot will be prepended with the disk name
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
apache-libcloud >= 0.19.0
Parameters
Parameter |
Comments |
---|---|
The path to the credentials file associated with the service account |
|
A list of disks to create snapshots for. If none is provided, all of the volumes will have snapshots created. |
|
The GCE instance to snapshot |
|
The GCP project ID to use |
|
GCP service account email for the project where the instance resides |
|
The name of the snapshot to manage |
|
Whether a snapshot should be Choices:
|
Examples
- name: Create gce snapshot
community.google.gce_snapshot:
instance_name: example-instance
snapshot_name: example-snapshot
state: present
service_account_email: [email protected]
credentials_file: /path/to/credentials
project_id: project_name
delegate_to: localhost
- name: Delete gce snapshot
community.google.gce_snapshot:
instance_name: example-instance
snapshot_name: example-snapshot
state: absent
service_account_email: [email protected]
credentials_file: /path/to/credentials
project_id: project_name
delegate_to: localhost
# This example creates snapshots for only two of the available disks as
# disk0-example-snapshot and disk1-example-snapshot
- name: Create snapshots of specific disks
community.google.gce_snapshot:
instance_name: example-instance
snapshot_name: example-snapshot
state: present
disks:
- disk0
- disk1
service_account_email: [email protected]
credentials_file: /path/to/credentials
project_id: project_name
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of snapshots that were already absent (no-op) Returned: When snapshots were already absent Sample: |
|
List of newly created snapshots Returned: When snapshots are created Sample: |
|
List of destroyed snapshots Returned: When snapshots are deleted Sample: |
|
List of snapshots that already existed (no-op) Returned: When snapshots were already present Sample: |