ansible / ansible.builtin / v2.9.27 / inventory / vultr Vultr inventory source | "added in version" 2.7 of ansible.builtin" Authors: Yanis Guenane (@Spredzy), René Moser (@resmo)ansible.builtin.vultr (v2.9.27) — inventory
pip
Install with pip install ansible==2.9.27
Get inventory hosts from Vultr public cloud.
Uses an YAML configuration file ending with either I(vultr.yml) or I(vultr.yaml) to set parameter values (also see examples).
Uses I(api_config), I(~/.vultr.ini), I(./vultr.ini) or C(VULTR_API_CONFIG) pointing to a Vultr credentials INI file (see U(https://docs.ansible.com/ansible/latest/scenario_guides/guide_vultr.html)).
groups: default: {} description: Add hosts to group based on Jinja2 conditionals. type: dict version_added: '2.8' version_added_collection: ansible.builtin plugin: choices: - vultr description: Token that ensures this is a source file for the 'vultr' plugin. required: true type: string strict: default: false description: - If V(yes) make invalid entries a fatal error, otherwise skip and continue. - Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. type: bool version_added: '2.8' version_added_collection: ansible.builtin api_key: description: Vultr API key. If not specified will be taken from regular Vultr configuration. env: - name: VULTR_API_KEY type: string compose: default: {} description: Create vars from jinja2 expressions. type: dict version_added: '2.8' version_added_collection: ansible.builtin hostname: choices: - v4_main_ip - v6_main_ip - name default: v4_main_ip description: Field to match the hostname. Note v4_main_ip corresponds to the main_ip field returned from the API and name to label. type: string api_config: description: Path to the vultr configuration file. If not specified will be taken from regular Vultr configuration. env: - name: VULTR_API_CONFIG type: path api_account: default: default description: Specify the account to be used. type: string keyed_groups: default: [] description: Add hosts to group based on the values of a variable. elements: dict suboptions: default_value: description: - The default value when the host variable's value is an empty string. - This option is mutually exclusive with O(keyed_groups[].trailing_separator). type: str version_added: '2.12' version_added_collection: ansible.builtin key: description: - The key from input dictionary used to generate groups type: str parent_group: description: parent group for keyed group type: str prefix: default: '' description: A keyed group name will start with this prefix type: str separator: default: _ description: separator used to build the keyed group name type: str trailing_separator: default: true description: - Set this option to V(False) to omit the O(keyed_groups[].separator) after the host variable when the value is an empty string. - This option is mutually exclusive with O(keyed_groups[].default_value). type: bool version_added: '2.12' version_added_collection: ansible.builtin type: list version_added: '2.8' version_added_collection: ansible.builtin filter_by_tag: description: Only return servers filtered by this tag type: string version_added: '2.8' version_added_collection: ansible.builtin use_extra_vars: default: false description: Merge extra vars into the available variables for composition (highest precedence). env: - name: ANSIBLE_INVENTORY_USE_EXTRA_VARS ini: - key: use_extra_vars section: inventory_plugins type: bool version_added: '2.11' version_added_collection: ansible.builtin leading_separator: default: true description: - 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. type: boolean version_added: '2.11' version_added_collection: ansible.builtin