vultr.cloud.snapshot module – Manages snapshots on Vultr
Note
This module is part of the vultr.cloud collection (version 1.13.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 vultr.cloud
.
To use it in a playbook, specify: vultr.cloud.snapshot
.
New in vultr.cloud 1.7.0
Synopsis
Create and remove snapshots.
Parameters
Parameter |
Comments |
---|---|
URL to API endpint (without trailing slash). Fallback environment variable Default: |
|
API key of the Vultr API. Fallback environment variable |
|
Amount of retries in case of the Vultr API retuns an HTTP error code, such as - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Fallback environment variable Default: |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable Default: |
|
HTTP timeout to Vultr API. Fallback environment variable Default: |
|
Description of the snapshot. |
|
The description or ID of the instance from which to take the snapshot. Mutually exclusive with url. instance or url is required if state=present. |
|
State of the snapshot. Choices:
|
|
The URL of the snapshot image (RAW) to be uploaded. Mutually exclusive with instance. instance or url is required if state=present. |
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
- name: Ensure a snapshot is present
vultr.cloud.snapshot:
description: my snapshot of my instance
instance: my instance
- name: Ensure a snapshot is present
vultr.cloud.snapshot:
description: debian 11 generic
url: https://cloud.debian.org/images/cloud/bullseye/latest/debian-11-generic-amd64.raw
- name: Ensure a snapshot is absent
vultr.cloud.snapshot:
description: my snapshot of my instance
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Vultr API with a few additions/modification. Returned: success |
|
Endpoint used for the API requests. Returned: success Sample: |
|
Amount of max retries for the API requests. Returned: success Sample: |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: |
|
Timeout used for the API requests. Returned: success Sample: |
|
Response from Vultr API. Returned: success |
|
ID of the app. Returned: success Sample: |
|
Compressed size of the snapshot. Returned: success Sample: |
|
Date the snapshot was created. Returned: success Sample: |
|
Description of the snapshot. Returned: success Sample: |
|
ID of the snapshot. Returned: success Sample: |
|
ID of the OS. Returned: success Sample: |
|
Size of the snapshot. Returned: success Sample: |
|
Status of the snapshot. Returned: success Sample: |