vultr.cloud.account_info module – Get information about the Vultr account
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.account_info
.
New in vultr.cloud 1.0.0
Synopsis
Get infos about account balance, charges and payments.
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: |
|
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 account infos
vultr.cloud.account_info:
register: result
- name: Print the infos
ansible.builtin.debug:
var: result.vultr_account_info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Vultr API. Returned: success |
|
Your account balance. Returned: success Sample: |
|
The amount of the last payment transaction. Returned: success Sample: |
|
Date of the last payment. Returned: success Sample: |
|
Charges pending. Returned: success Sample: |
|
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: |