vultr.cloud.block_storage module – Manages block storage volumes on Vultr
Note
This module is part of the vultr.cloud collection (version 1.13.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install vultr.cloud
.
To use it in a playbook, specify: vultr.cloud.block_storage
.
New in vultr.cloud 1.0.0
Synopsis
Manage block storage volumes.
Parameters
Parameter |
Comments |
---|---|
URL to API endpint (without trailing slash). Fallback environment variable Default: |
|
API key of the Vultr API. Fallback environment variable |
|
Amount of retries in case of the Vultr API retuns an HTTP error code, such as - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Fallback environment variable Default: |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable Default: |
|
HTTP timeout to Vultr API. Fallback environment variable Default: |
|
The ID of the server instance the volume is attached to. |
|
The type of block storage volume that will be created. Choices:
|
|
Name of the block storage volume. |
|
Whether the volume should be attached/detached without restarting the instance. Choices:
|
|
Region the block storage volume is deployed into. Required if state is present. |
|
Size of the block storage volume in GB. Required if state is present. If it is larger than the volume’s current size, the volume will be resized. |
|
State of the block storage volume. Choices:
|
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
---
- name: Ensure a block storage volume is present
vultr.cloud.block_storage:
name: myvolume
size_gb: 10
block_type: storage_opt
region: ams
- name: Ensure a block storage volume is absent
vultr.cloud.block_storage:
name: myvolume
state: absent
- name: Ensure a block storage volume exists and is attached a server instance
vultr.cloud.block_storage:
name: myvolume
attached_to_instance: cb676a46-66fd-4dfb-b839-443f2e6c0b60
size_gb: 50
block_type: high_perf
- name: Ensure a block storage volume exists but is not attached to any server instance
vultr.cloud.block_storage:
name: myvolume
attached_to_instance: ""
size_gb: 50
block_type: high_perf
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Vultr API with a few additions/modification. Returned: success |
|
Account used in the ini file to select the key. Returned: success Sample: |
|
Endpoint used for the API requests. Returned: success Sample: |
|
Amount of max retries for the API requests. Returned: success Sample: |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: |
|
Timeout used for the API requests. Returned: success Sample: |
|
Response from Vultr API. Returned: success |
|
The ID of the server instance the volume is attached to. Returned: success Sample: |
|
HDD or NVMe (storage_opt or high_perf) Returned: success Sample: |
|
Cost per month for the volume. Returned: success Sample: |
|
Date when the volume was created. Returned: success Sample: |
|
ID of the block storage volume. Returned: success Sample: |
|
Label of the volume. Returned: success Sample: |
|
Mount ID of the volume. Returned: success Sample: |
|
Region the volume was deployed into. Returned: success Sample: |
|
Information about the volume size in GB. Returned: success Sample: |
|
Status about the deployment of the volume. Returned: success Sample: |