vultr_block_storage - Manages block storage volumes on Vultr.

New in version 2.7.

Synopsis

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 vultr.ini file.
The ENV variable VULTR_API_ACCOUNT is used as default, when defined.
api_endpoint
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
API key of the Vultr API.
The ENV variable VULTR_API_KEY is used as default, when defined.
api_retries
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_timeout
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.
name
required
Name of the block storage volume.

aliases: description, label
region
required
Region the block storage volume is deployed into.
size
required
Size of the block storage volume in GB.
state
    Choices:
  • present ←
  • absent
State of the block storage volume.
validate_certs
bool
    Choices:
  • no
  • yes ←
Validate SSL certs of the Vultr API.

Notes

Note

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_endpoint
string
 success
Endpoint used for the API requests

Sample:
https://api.vultr.com
  api_timeout
int
 success
Timeout used for the API requests

Sample:
60
  api_retries
int
 success
Amount of max retries for the API requests

Sample:
5
  api_account
string
 success
Account used in the ini file to select the key

Sample:
default
vultr_block_storage
complex
 success
Response from Vultr API
  status
string
 success
Status about the deployment of the volume

Sample:
active
  name
string
 success
Name of the volume

Sample:
ansible-test-volume
  region
string
 success
Region the volume was deployed into

Sample:
New Jersey
  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
  attached_to_id
string
 success
The ID of the server the volume is attached to

Sample:
10194376
  size
int
 success
Information about the volume size in GB

Sample:
10


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Yanis Guenane (@Spredzy)

Hint

If you notice any issues in this documentation you can edit this document to improve it.