vultr.cloud.instance_info module – Get information about the Vultr instances
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.instance_info
.
New in vultr.cloud 1.5.0
Synopsis
Get infos about available instances.
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: |
|
Name of the instance. |
|
Filter instances by region. |
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
- name: Get Vultr instance infos of region ams
vultr.cloud.instance_info:
region: ams
- name: Get Vultr instance infos of a single host
vultr.cloud.instance_info:
label: myhost
- name: Get all Vultr instance infos
vultr.cloud.instance_info:
register: results
- name: Print the gathered infos
ansible.builtin.debug:
var: results.vultr_instance_info
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 |
|
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 as list. Returned: available |
|
Allowed bandwidth of the instance. Returned: success Sample: |
|
App ID of the instance. Returned: success Sample: |
|
Date when the instance was created. Returned: success Sample: |
|
Disk size of the instance. Returned: success Sample: |
|
Features of the instance. Returned: success Sample: |
|
Firewall group ID of the instance. Returned: success Sample: |
|
Gateway IPv4. Returned: success Sample: |
|
Hostname of the instance. Returned: success Sample: |
|
ID of the instance. Returned: success Sample: |
|
Image ID of the instance. Returned: success Sample: |
|
Internal IP of the instance. Returned: success Sample: |
|
KVM of the instance. Returned: success Sample: |
|
Label of the instance. Returned: success Sample: |
|
IPv4 of the instance. Returned: success Sample: |
|
Netmask IPv4 of the instance. Returned: success Sample: |
|
OS of the instance. Returned: success Sample: |
|
OS ID of the instance. Returned: success Sample: |
|
Plan of the instance. Returned: success Sample: |
|
Power status of the instance. Returned: success Sample: |
|
RAM in MB of the instance. Returned: success Sample: |
|
Region the instance was deployed into. Returned: success Sample: |
|
Server status of the instance. Returned: success Sample: |
|
Status about the deployment of the instance. Returned: success Sample: |
|
Tags of the instance. Returned: success Sample: |
|
Base64 encoded user data (cloud init) of the instance. Returned: success Sample: |
|
IPv6 of the instance. Returned: success Sample: |
|
IPv6 network of the instance. Returned: success Sample: |
|
IPv6 network size of the instance. Returned: success Sample: |
|
vCPUs of the instance. Returned: success Sample: |