ngine_io.vultr.vultr_block_storage – Manages block storage volumes on Vultr.¶
Note
This plugin is part of the ngine_io.vultr collection (version 1.1.0).
To install it use: ansible-galaxy collection install ngine_io.vultr
.
To use it in a playbook, specify: ngine_io.vultr.vultr_block_storage
.
New in version 0.1.0: of ngine_io.vultr
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_account
string
|
Default: "default"
|
Name of the ini section in the
vultr.ini file.The ENV variable
VULTR_API_ACCOUNT is used as default, when defined. |
api_endpoint
string
|
URL to API endpint (without trailing slash).
The ENV variable
VULTR_API_ENDPOINT is used as default, when defined.Fallback value is https://api.vultr.com if not specified.
|
|
api_key
string
|
API key of the Vultr API.
The ENV variable
VULTR_API_KEY is used as default, when defined. |
|
api_retries
integer
|
Amount of retries in case of the Vultr API retuns an HTTP 503 code.
The ENV variable
VULTR_API_RETRIES is used as default, when defined.Fallback value is 5 retries if not specified.
|
|
api_retry_max_delay
integer
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds.
The ENV variable
VULTR_API_RETRY_MAX_DELAY is used as default, when defined.Fallback value is 12 seconds.
|
|
api_timeout
integer
|
HTTP timeout to Vultr API.
The ENV variable
VULTR_API_TIMEOUT is used as default, when defined.Fallback value is 60 seconds if not specified.
|
|
attached_to_SUBID
integer
|
The ID of the server the volume is attached to.
Required if state is attached.
aliases: attached_to_id |
|
live_attachment
boolean
|
|
Whether the volume should be attached/detached, even if the server not stopped.
|
name
string
/ required
|
Name of the block storage volume.
aliases: description, label |
|
region
string
|
Region the block storage volume is deployed into.
Required if state is present.
|
|
size
integer
|
Size of the block storage volume in GB.
Required if state is present.
If it's larger than the volume's current size, the volume will be resized.
|
|
state
string
|
|
State of the block storage volume.
|
validate_certs
boolean
|
|
Validate SSL certs of the Vultr API.
|
Notes¶
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples¶
- name: Ensure a block storage volume is present
ngine_io.vultr.vultr_block_storage:
name: myvolume
size: 10
region: Amsterdam
- name: Ensure a block storage volume is absent
ngine_io.vultr.vultr_block_storage:
name: myvolume
state: absent
- name: Ensure a block storage volume exists and is attached to server 114
ngine_io.vultr.vultr_block_storage:
name: myvolume
state: attached
attached_to_id: 114
size: 10
- name: Ensure a block storage volume exists and is not attached to any server
ngine_io.vultr.vultr_block_storage:
name: myvolume
state: detached
size: 10
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Yanis Guenane (@Spredzy)