Merge pull request #6344 from alimony/patch-1
Touch up documentation strings for DigitalOcean.
This commit is contained in:
commit
87d4bd771f
1 changed files with 9 additions and 9 deletions
|
@ -20,7 +20,7 @@ DOCUMENTATION = '''
|
||||||
module: digital_ocean
|
module: digital_ocean
|
||||||
short_description: Create/delete a droplet/SSH_key in DigitalOcean
|
short_description: Create/delete a droplet/SSH_key in DigitalOcean
|
||||||
description:
|
description:
|
||||||
- Create/delete a droplet in DigitalOcean and optionally waits for it to be 'running', or deploy an SSH key.
|
- Create/delete a droplet in DigitalOcean and optionally wait for it to be 'running', or deploy an SSH key.
|
||||||
version_added: "1.3"
|
version_added: "1.3"
|
||||||
options:
|
options:
|
||||||
command:
|
command:
|
||||||
|
@ -35,10 +35,10 @@ options:
|
||||||
choices: ['present', 'active', 'absent', 'deleted']
|
choices: ['present', 'active', 'absent', 'deleted']
|
||||||
client_id:
|
client_id:
|
||||||
description:
|
description:
|
||||||
- Digital Ocean manager id.
|
- DigitalOcean manager id.
|
||||||
api_key:
|
api_key:
|
||||||
description:
|
description:
|
||||||
- Digital Ocean api key.
|
- DigitalOcean api key.
|
||||||
id:
|
id:
|
||||||
description:
|
description:
|
||||||
- Numeric, the droplet id you want to operate on.
|
- Numeric, the droplet id you want to operate on.
|
||||||
|
@ -47,31 +47,31 @@ options:
|
||||||
- String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key.
|
- String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key.
|
||||||
unique_name:
|
unique_name:
|
||||||
description:
|
description:
|
||||||
- Bool, require unique hostnames. By default, digital ocean allows multiple hosts with the same name. Setting this to "yes" allows only one host per name. Useful for idempotence.
|
- 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.
|
||||||
version_added: "1.4"
|
version_added: "1.4"
|
||||||
default: "no"
|
default: "no"
|
||||||
choices: [ "yes", "no" ]
|
choices: [ "yes", "no" ]
|
||||||
size_id:
|
size_id:
|
||||||
description:
|
description:
|
||||||
- Numeric, this is the id of the size you would like the droplet created at.
|
- Numeric, this is the id of the size you would like the droplet created with.
|
||||||
image_id:
|
image_id:
|
||||||
description:
|
description:
|
||||||
- Numeric, this is the id of the image you would like the droplet created with.
|
- Numeric, this is the id of the image you would like the droplet created with.
|
||||||
region_id:
|
region_id:
|
||||||
description:
|
description:
|
||||||
- "Numeric, this is the id of the region you would like your server"
|
- "Numeric, this is the id of the region you would like your server to be created in."
|
||||||
ssh_key_ids:
|
ssh_key_ids:
|
||||||
description:
|
description:
|
||||||
- Optional, comma separated list of ssh_key_ids that you would like to be added to the server
|
- Optional, comma separated list of ssh_key_ids that you would like to be added to the server.
|
||||||
virtio:
|
virtio:
|
||||||
description:
|
description:
|
||||||
- "Bool, turn on virtio driver in droplet for improved network and storage I/O"
|
- "Bool, turn on virtio driver in droplet for improved network and storage I/O."
|
||||||
version_added: "1.4"
|
version_added: "1.4"
|
||||||
default: "yes"
|
default: "yes"
|
||||||
choices: [ "yes", "no" ]
|
choices: [ "yes", "no" ]
|
||||||
private_networking:
|
private_networking:
|
||||||
description:
|
description:
|
||||||
- "Bool, add an additional, private network interface to droplet for inter-droplet communication"
|
- "Bool, add an additional, private network interface to droplet for inter-droplet communication."
|
||||||
version_added: "1.4"
|
version_added: "1.4"
|
||||||
default: "no"
|
default: "no"
|
||||||
choices: [ "yes", "no" ]
|
choices: [ "yes", "no" ]
|
||||||
|
|
Loading…
Reference in a new issue