ngine_io.vultr.vultr inventory – Vultr inventory source
Note
This inventory plugin is part of the ngine_io.vultr collection (version 1.1.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ngine_io.vultr
.
To use it in a playbook, specify: ngine_io.vultr.vultr
.
Synopsis
Get inventory hosts from Vultr public cloud.
Uses an YAML configuration file ending with either vultr.yml or vultr.yaml to set parameter values (also see examples).
Uses api_config, ~/.vultr.ini, ./vultr.ini or
VULTR_API_CONFIG
pointing to a Vultr credentials INI file (see https://docs.ansible.com/ansible/latest/scenario_guides/guide_vultr.html).
Parameters
Parameter |
Comments |
---|---|
Specify the account to be used. Default: |
|
Path to the vultr configuration file. If not specified will be taken from regular Vultr configuration. Configuration:
|
|
Vultr API key. If not specified will be taken from regular Vultr configuration. Configuration:
|
|
Create vars from jinja2 expressions. Default: |
|
Only return servers filtered by this tag |
|
Add hosts to group based on Jinja2 conditionals. Default: |
|
Field to match the hostname. Note v4_main_ip corresponds to the main_ip field returned from the API and name to label. Choices:
|
|
Add hosts to group based on the values of a variable. Default: |
|
The default value when the host variable’s value is an empty string. This option is mutually exclusive with |
|
The key from input dictionary used to generate groups |
|
parent group for keyed group |
|
A keyed group name will start with this prefix Default: |
|
separator used to build the keyed group name Default: |
|
Set this option to False to omit the This option is mutually exclusive with Choices:
|
|
Use in conjunction with keyed_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is “” and the default separator is “_”. Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. Choices:
|
|
Token that ensures this is a source file for the ‘vultr’ plugin. Choices:
|
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. Choices:
|
|
Merge extra vars into the available variables for composition (highest precedence). Choices:
Configuration:
|
Examples
# inventory_vultr.yml file in YAML format
# Example command line: ansible-inventory --list -i inventory_vultr.yml
# Group by a region as lower case and with prefix e.g. "vultr_region_amsterdam" and by OS without prefix e.g. "CentOS_7_x64"
plugin: vultr
keyed_groups:
- prefix: vultr_region
key: region | lower
- separator: ""
key: os
# Pass a tag filter to the API
plugin: vultr
filter_by_tag: Cache