W3cubDocs

/Ansible

ngine_io.vultr.vultr_block_storage_info – Get information about the Vultr block storage volumes available.

Note

This plugin is part of the ngine_io.vultr collection (version 1.1.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 ngine_io.vultr.

To use it in a playbook, specify: ngine_io.vultr.vultr_block_storage_info.

New in version 0.1.0: of ngine_io.vultr

Synopsis

  • Get infos about block storage volumes available in 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.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Validate SSL certs of the Vultr API.

Notes

Note

Examples

- name: Get Vultr block storage infos
  ngine_io.vultr.vultr_block_storage_info:
  register: result

- name: Print the infos
  debug:
    var: result.vultr_block_storage_info

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:
https://api.vultr.com
api_retries
integer
success
Amount of max retries for the API requests

Sample:
5
api_retry_max_delay
integer
success
Exponential backoff delay in seconds between retries up to this max delay value.

Sample:
12
api_timeout
integer
success
Timeout used for the API requests

Sample:
60
vultr_block_storage_info
complex
success
Response from Vultr API as list
attached_to_id
string
success
Block storage is attached to this server ID.
cost_per_month
float
success
Cost per month of the block storage.

Sample:
1.0
date_created
string
success
Date created of the block storage.

Sample:
2018-07-24 12:59:59
id
integer
success
ID of the block storage.

Sample:
17332323
name
string
success
Name of the block storage.

Sample:
my volume
region
string
success
Region the block storage is located in.

Sample:
New Jersey
size
integer
success
Size in GB of the block storage.

Sample:
10
status
string
success
Status of the block storage.

Sample:
active


Authors

  • Yanis Guenane (@Spredzy)
  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/vultr/vultr_block_storage_info_module.html