vultr_block_storage – Manages block storage volumes on Vultr.
vultr_block_storage – Manages block storage volumes on Vultr.
New in version 2.7.
Synopsis
- Manage block storage volumes on Vultr.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_account - |
Default: "default" |
Name of the ini section in the The ENV variable |
api_endpoint - |
URL to API endpint (without trailing slash). The ENV variable Fallback value is https://api.vultr.com if not specified. | |
api_key - |
API key of the Vultr API. The ENV variable | |
api_retries - |
Amount of retries in case of the Vultr API retuns an HTTP 503 code. The ENV variable Fallback value is 5 retries if not specified. | |
api_timeout - |
HTTP timeout to Vultr API. The ENV variable Fallback value is 60 seconds if not specified. | |
name - / required |
Name of the block storage volume.
| |
region - / required |
Region the block storage volume is deployed into. | |
size - / required |
Size of the block storage volume in GB. | |
state - |
|
State of the block storage volume. |
validate_certs boolean |
|
Validate SSL certs of the Vultr API. |
Notes
Examples
- name: Ensure a block storage volume is present
local_action:
module: vultr_block_storage
name: myvolume
size: 10
region: Amsterdam
- name: Ensure a block storage volume is absent
local_action:
module: vultr_block_storage
name: myvolume
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
vultr_api complex |
success |
Response from Vultr API with a few additions/modification
| |
api_account string |
success |
Account used in the ini file to select the key
Sample: default | |
api_endpoint string |
success |
Endpoint used for the API requests
Sample: | |
api_retries integer |
success |
Amount of max retries for the API requests
Sample: 5 | |
api_timeout integer |
success |
Timeout used for the API requests
Sample: 60 | |
vultr_block_storage complex |
success |
Response from Vultr API
| |
attached_to_id string |
success |
The ID of the server the volume is attached to
Sample: 10194376 | |
cost_per_month float |
success |
Cost per month for the volume
Sample: 1.0 | |
date_created string |
success |
Date when the volume was created
Sample: 2017-08-26 12:47:48 | |
id string |
success |
ID of the block storage volume
Sample: 1234abcd | |
name string |
success |
Name of the volume
Sample: ansible-test-volume | |
region string |
success |
Region the volume was deployed into
Sample: New Jersey | |
size integer |
success |
Information about the volume size in GB
Sample: 10 | |
status string |
success |
Status about the deployment of the volume
Sample: active |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Yanis Guenane (@Spredzy)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vultr_block_storage_module.html