Parameter |
Choices/Defaults |
Comments |
api_token
(added in 1.9.5) |
|
DigitalOcean api token.
|
backups_enabled
bool
(added in 1.6) |
|
Optional, Boolean, enables backups for your droplet.
|
command
|
|
Which target you want to operate on.
|
id
|
|
Numeric, the droplet id you want to operate on.
aliases: droplet_id
|
image_id
|
|
This is the slug of the image you would like the droplet created with.
|
ipv6
bool
(added in 2.2) |
|
Optional, Boolean, enable IPv6 for your droplet.
|
name
|
|
String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key.
|
private_networking
bool
(added in 1.4) |
|
Bool, add an additional, private network interface to droplet for inter-droplet communication.
|
region_id
|
|
This is the slug of the region you would like your server to be created in.
|
size_id
|
|
This is the slug of the size you would like the droplet created with.
|
ssh_key_ids
|
|
Optional, array of SSH key (numeric) ID that you would like to be added to the server.
|
ssh_pub_key
|
|
The public SSH key you want to add to your account.
|
state
|
Choices:
present ←
- active
- absent
- deleted
|
Indicate desired state of the target.
|
unique_name
bool
(added in 1.4) |
|
Bool, require unique hostnames. By default, DigitalOcean allows multiple hosts with the same name. Setting this to "yes" allows only one host per name. Useful for idempotence.
|
user_data
(added in 2.0) |
|
opaque blob of data which is made available to the droplet
|
virtio
bool
(added in 1.4) |
|
Bool, turn on virtio driver in droplet for improved network and storage I/O.
|
wait
bool |
|
Wait for the droplet to be in state 'running' before returning. If wait is "no" an ip_address may not be returned.
|
wait_timeout
|
Default:
300
|
How long before wait gives up, in seconds.
|