Give Feedback

droplet_action_power

Generated on 1 Jul 2025 from digitalocean.cloud version v1.2.1

Synopsis

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.

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 ignored.
`force_power_off` bool		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	Choices: `power_off` `power_on` (default) `shutdown`	The power state transition.
`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: 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

Return Values

Key Returned Description

Key	Returned	Description
`action` dict	always	DigitalOcean action information. Sample: `{ "completed_at": null, "id": 1882339039, "region": { "available": true, "features": [ "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer" ], "name": "New York 3", "sizes": [ "s-1vcpu-1gb", "s-1vcpu-1gb-amd", "s-1vcpu-1gb-intel", "and many more" ], "slug": "nyc3" }, "region_slug": "nyc3", "resource_id": 336851565, "resource_type": "droplet", "started_at": "2023-09-03T12:59:10Z", "status": "in-progress", "type": "power_on" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	DigitalOcean action information. Sample: [ "No Droplet with ID 336851565", "No Droplet with name test-droplet-1 in nyc3", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'power_off'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'power_off' and it has not completed, status is 'in-progress'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'power_off' and it has not completed, status is 'errored'", "Droplet test-droplet-1 (336851565) in nyc3 would be sent action 'power_off', it is 'off'", "Droplet test-droplet-1 (336851565) in nyc3 would not be sent action 'power_off', it is 'active'", "Droplet test-droplet-1 (336851565) in nyc3 not sent action 'power_off', it is 'off'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'power_on'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'power_on' and it has not completed, status is 'in-progress'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'power_on' and it has not completed, status is 'errored'", "Droplet test-droplet-1 (336851565) in nyc3 would be sent action 'power_on', it is 'active'", "Droplet test-droplet-1 (336851565) in nyc3 would not be sent action 'power_on', it is 'off'", "Droplet test-droplet-1 (336851565) in nyc3 not sent action 'power_on', it is 'active'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'shutdown'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'shutdown' and it has not completed, status is 'in-progress'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'shutdown' and it has not completed, status is 'errored'", "Droplet test-droplet-1 (336851565) in nyc3 would be sent action 'shutdown', it is 'active'", "Droplet test-droplet-1 (336851565) in nyc3 would not be sent action 'shutdown', it is 'off'", "Droplet test-droplet-1 (336851565) in nyc3 not sent action 'shutdown', it is 'off'" ]

action
dict

always

DigitalOcean action information.
Sample:

{
  "completed_at": null,
  "id": 1882339039,
  "region": {
    "available": true,
    "features": [
      "backups",
      "ipv6",
      "metadata",
      "install_agent",
      "storage",
      "image_transfer"
    ],
    "name": "New York 3",
    "sizes": [
      "s-1vcpu-1gb",
      "s-1vcpu-1gb-amd",
      "s-1vcpu-1gb-intel",
      "and many more"
    ],
    "slug": "nyc3"
  },
  "region_slug": "nyc3",
  "resource_id": 336851565,
  "resource_type": "droplet",
  "started_at": "2023-09-03T12:59:10Z",
  "status": "in-progress",
  "type": "power_on"
}

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str