Parameter | Choices | Default | Comments |
---|---|---|---|
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. | ||
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) |
A human-readable name for the volume snapshot. | ||
state (str) |
|
present | State of the resource, present to create, absent to destroy. |
tags (list) |
A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | ||
timeout (int) |
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 |
||
volume_id (str) |
The ID of the block storage volume. |
- name: Create a volume snapshot
digitalocean.cloud.volume_snapshot:
token: "{{ token }}"
state: present
volume_id: 7724db7c-e098-11e5-b522-000f53304e51
name: big-data-snapshot1475261774
tags:
- aninterestingtag
Key | Returned | Description |
---|---|---|
error (dict) |
failure |
DigitalOcean API error.
Sample:
|
msg (str) |
always |
Droplet result information.
Sample:
|
snapshot (dict) |
always |
Volume snapshot information.
Sample:
|