vultr_account_facts – Gather facts about the Vultr account.
vultr_account_facts – Gather facts about the Vultr account.
New in version 2.5.
Synopsis
- Gather facts about account balance, charges and payments.
Aliases: vr_account_facts
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 The ENV variable |
api_endpoint - |
URL to API endpint (without trailing slash). The ENV variable Fallback value is https://api.vultr.com if not specified. | |
api_key - |
API key of the Vultr API. The ENV variable | |
api_retries - |
Amount of retries in case of the Vultr API retuns an HTTP 503 code. The ENV variable Fallback value is 5 retries if not specified. | |
api_timeout - |
HTTP timeout to Vultr API. The ENV variable Fallback value is 60 seconds if not specified. | |
validate_certs boolean |
|
Validate SSL certs of the Vultr API. |
Notes
Examples
- name: Gather Vultr account facts
local_action:
module: vultr_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 | |
last_payment_amount float |
success |
The amount of the last payment transaction.
Sample: -250.0 | |
last_payment_date string |
success |
Date of the last payment.
Sample: 2017-08-26 12:47:48 | |
pending_charges float |
success |
Charges pending.
Sample: 57.03 | |
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: | |
api_retries integer |
success |
Amount of max retries for the API requests
Sample: 5 | |
api_timeout integer |
success |
Timeout used for the API requests
Sample: 60 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vultr_account_facts_module.html