droplet_action_snapshot
Generated on 22 May 2025
from digitalocean.cloud
version
v1.2.1
Synopsis
Take a snapshot of a Droplet. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplet-Actions.
Requirements
- pydo >= 0.1.3
- azure-core >= 1.26.1
Parameters
Parameter | Choices / Default | Description |
---|---|---|
client_override_options dict |
Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options. | |
droplet_id int |
A unique identifier for a Droplet instance. If provided, name and region are ignore. |
|
module_override_options dict |
Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options. | |
name str |
The name of the Droplet to act on. If provided, must be unique and given with region . |
|
region str |
The name of the Droplet to act on. Required with name . |
|
snapshot_name str |
The name to give the new snapshot of the Droplet. | |
state str |
Choices:
|
State of the resource, present to create, absent to destroy. |
timeout int |
Default: 300 |
Polling timeout in seconds. |
token str |
DigitalOcean API token. There are several environment variables which can be used to provide this value. DIGITALOCEAN_ACCESS_TOKEN , DIGITALOCEAN_TOKEN , DO_API_TOKEN , DO_API_KEY , DO_OAUTH_TOKEN and OAUTH_TOKEN |
Examples
- name: Snapshot a Droplet
digitalocean.cloud.droplet_action_snapshot:
token: "{{ token }}"
state: present
name: my-droplet
region: nyc3
snapshot_name: my-droplet-snapshot
Return Values
Key | Returned | Description |
---|---|---|
action dict |
always | DigitalOcean snapshot action information. Sample:
|
error dict |
failure | DigitalOcean API error. Sample:
|
msg str |
always | DigitalOcean action information. Sample:
|