Documentation

vultr - Vultr inventory source

Synopsis

  • Get inventory hosts from Vultr public cloud.
  • Uses api_config, ~/.vultr.ini, ./vultr.ini or VULTR_API_CONFIG path to config file.

Parameters

Parameter Choices/Defaults Configuration Comments
api_account Default:
default
Specify the account to be used.
api_config
env:VULTR_API_CONFIG
Path to the vultr configuration file. If not specified will be taken from regular Vultr configuration.
api_key
env:VULTR_API_KEY
Vultr API key. If not specified will be taken from regular Vultr configuration.
hostname
string
    Choices:
  • v4_main_ip ←
  • v6_main_ip
  • name
Field to match the hostname. Note v4_main_ip corresponds to the main_ip field returned from the API and name to label.
plugin
required
    Choices:
  • vultr
token that ensures this is a source file for the 'vultr' plugin.

Examples

# vultr_inventory.yml file in YAML format
# Example command line: ansible-inventory --list -i vultr_inventory.yml

plugin: vultr

Status

Author

  • Yanis Guenane (@Spredzy)

Hint

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