vr_account_facts - Gather facts about the Vultr account.
New in version 2.5.
Synopsis
- Gather facts about account balance, charges and payments.
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 | Default:
"https://api.vultr.com"
|
URL to API endpint (without trailing slash).
The ENV variable VULTR_API_ENDPOINT is used as default, when defined.
|
| api_key |
API key of the Vultr API.
The ENV variable VULTR_API_KEY is used as default, when defined.
|
|
| api_retries | Default:
5
|
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.
|
| api_timeout | Default:
60
|
HTTP timeout to Vultr API.
The ENV variable VULTR_API_TIMEOUT is used as default, when defined.
|
| validate_certs
bool
|
|
Validate SSL certs of the Vultr API.
|
Notes
Note
- Also see the API documentation on https://www.vultr.com/api/.
Examples
- name: Gather Vultr account facts
local_action:
module: vr_account_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_account_facts
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| vultr_account_facts
complex
|
success |
Response from Vultr API
|
|
| balance
float
|
success |
Your account balance.
Sample:
-214.69
|
|
| pending_charges
float
|
success |
Charges pending.
Sample:
57.03
|
|
| last_payment_date
string
|
success |
Date of the last payment.
Sample:
2017-08-26 12:47:48
|
|
| last_payment_amount
float
|
success |
The amount of the last payment transaction.
Sample:
-250.0
|
|
| 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_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_endpoint
string
|
success |
Endpoint used for the API requests
Sample:
https://api.vultr.com
|
|
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
- René Moser (@resmo)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vr_account_facts_module.html