New in version 2.7.
The below requirements are needed on the host that executes this module.
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
-
|
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
-
|
API key of the Vultr API.
The ENV variable
VULTR_API_KEY is used as default, when defined. |
|
api_retries
-
|
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_timeout
-
|
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
|
|
Validate SSL certs of the Vultr API.
|
Note
- name: Gather Vultr user facts
local_action:
module: vultr_user_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_user_facts
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_timeout
integer
|
success |
Timeout used for the API requests
Sample:
60
|
|
vultr_user_facts
complex
|
success |
Response from Vultr API
|
|
vultr_user_facts
-
|
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.