vultr_server_facts – Gather facts about the Vultr servers available

New in version 2.7.

DEPRECATED

Removed in Ansible:
 version: 2.13
Why:Deprecated in favour of _info module.
Alternative:Use vultr_server_info instead.

Synopsis

  • Gather facts about servers available.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
api_account
string
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
string
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
string
API key of the Vultr API.
The ENV variable VULTR_API_KEY is used as default, when defined.
api_retries
integer
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_retry_max_delay
integer
added in 2.9
Retry backoff delay in seconds is exponential up to this max. value, in seconds.
The ENV variable VULTR_API_RETRY_MAX_DELAY is used as default, when defined.
Fallback value is 12 seconds.
api_timeout
integer
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
    Choices:
  • no
  • yes ←
Validate SSL certs of the Vultr API.

Notes

Note

Examples

- name: Gather Vultr servers facts
  local_action:
    module: vultr_server_facts

- name: Print the gathered facts
  debug:
    var: ansible_facts.vultr_server_facts

Return Values

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_retry_max_delay
integer
added in 2.9
 success
Exponential backoff delay in seconds between retries up to this max delay value.

Sample:
12
 
api_timeout
integer
success
Timeout used for the API requests

Sample:
60
vultr_server_facts
complex
success
Response from Vultr API

Sample:
{'vultr_server_facts': [{'allowed_bandwidth_gb': 1000, 'auto_backup_enabled': False, 'application': None, 'cost_per_month': 5.0, 'current_bandwidth_gb': 0, 'date_created': '2018-07-19 08:23:03', 'default_password': 'p4ssw0rd!', 'disk': 'Virtual 25 GB', 'firewallgroup': None, 'id': 17241096, 'internal_ip': '', 'kvm_url': 'https://my.vultr.com/subs/vps/novnc/api.php?data=OFB...', 'name': 'ansibletest', 'os': 'CentOS 7 x64', 'pending_charges': 0.01, 'plan': '1024 MB RAM,25 GB SSD,1.00 TB BW', 'power_status': 'running', 'ram': '1024 MB', 'region': 'Amsterdam', 'server_state': 'ok', 'status': 'active', 'tag': '', 'v4_gateway': '105.178.158.1', 'v4_main_ip': '105.178.158.181', 'v4_netmask': '255.255.254.0', 'v6_main_ip': '', 'v6_network': '', 'v6_network_size': '', 'v6_networks': [], 'vcpu_count': 1}]}


Status

  • This module will be removed in version 2.13. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Yanis Guenane (@Spredzy)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.