Set power states of a Droplet.
State power_on powers on a Droplet.
State power_off is a hard shutdown and should only be used if the shutdown action is not successful. It is similar to cutting the power on a server and could lead to complications.
State shutdown is an attempt to shutdown the Droplet in a graceful way, similar to using the shutdown command from the console. Since a shutdown command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a power_off state to ensure the Droplet is off.
View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplet-Actions.
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. | ||
droplet_id (int) |
A unique identifier for a Droplet instance. If provided, name and region are ignored. |
||
force_power_off (bool) |
False | Force power off if shutdown fails. |
|
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 . |
||
state (str) |
|
power_on | The power state transition. |
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 |
- name: Power off a Droplet
digitalocean.cloud.droplet_action_power:
token: "{{ token }}"
state: power_off
id: 1122334455
- name: Power on a Droplet
digitalocean.cloud.droplet_action_power:
token: "{{ token }}"
state: power_on
id: 1122334455
- name: Shut down a Droplet
digitalocean.cloud.droplet_action_power:
token: "{{ token }}"
state: shutdown
id: 1122334455
- name: Shut down a Droplet (force if unsuccessful)
digitalocean.cloud.droplet_action_power:
token: "{{ token }}"
state: shutdown
force_power_off: true
id: 1122334455
Key | Returned | Description |
---|---|---|
action (dict) |
always |
DigitalOcean action information.
Sample:
|
error (dict) |
failure |
DigitalOcean API error.
Sample:
|
msg (str) |
always |
DigitalOcean action information.
Sample:
|