community / community.general / 6.6.8 / inventory / linode Ansible dynamic inventory plugin for Linode. Authors: Luke Murphy (@decentral1se)community.general.linode (6.6.8) — inventory
Install with ansible-galaxy collection install community.general:==6.6.8
collections: - name: community.general version: 6.6.8
Reads inventories from the Linode API v4.
Uses a YAML configuration file that ends with linode.(yml|yaml).
Linode labels are used by default as the hostnames.
The default inventory groups are built from groups (deprecated by Linode) and not tags.
tags: default: [] description: Populate inventory only with instances which have at least one of the tags listed here. elements: string type: list version_added: 2.0.0 version_added_collection: community.general cache: default: false description: - Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. env: - name: ANSIBLE_INVENTORY_CACHE ini: - key: cache section: inventory type: bool version_added: 4.5.0 version_added_collection: community.general types: default: [] description: Populate inventory with instances with this type. elements: string type: list groups: default: {} description: Add hosts to group based on Jinja2 conditionals. type: dict version_added: 2.0.0 version_added_collection: community.general plugin: choices: - linode - community.general.linode description: Marks this as an instance of the 'linode' plugin. required: true 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.0.0 version_added_collection: community.general compose: default: {} description: Create vars from jinja2 expressions. type: dict version_added: 2.0.0 version_added_collection: community.general regions: default: [] description: Populate inventory with instances in this region. elements: string type: list ip_style: choices: - plain - api default: plain description: Populate hostvars with all information available from the Linode APIv4. type: string version_added: 3.6.0 version_added_collection: community.general access_token: description: The Linode account personal access token. env: - name: LINODE_ACCESS_TOKEN required: true cache_plugin: default: memory description: - Cache plugin to use for the inventory's source data. env: - name: ANSIBLE_CACHE_PLUGIN - name: ANSIBLE_INVENTORY_CACHE_PLUGIN ini: - key: fact_caching section: defaults - key: cache_plugin section: inventory type: str version_added: 4.5.0 version_added_collection: community.general cache_prefix: default: ansible_inventory_ description: - Prefix to use for cache plugin files/tables env: - name: ANSIBLE_CACHE_PLUGIN_PREFIX - name: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX ini: - key: fact_caching_prefix section: defaults - key: cache_prefix section: inventory version_added: 4.5.0 version_added_collection: community.general 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.0.0 version_added_collection: community.general cache_timeout: default: 3600 description: - Cache duration in seconds env: - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT - name: ANSIBLE_INVENTORY_CACHE_TIMEOUT ini: - key: fact_caching_timeout section: defaults - key: cache_timeout section: inventory type: int version_added: 4.5.0 version_added_collection: community.general 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 cache_connection: description: - Cache connection data or path, read cache plugin documentation for specifics. env: - name: ANSIBLE_CACHE_PLUGIN_CONNECTION - name: ANSIBLE_INVENTORY_CACHE_CONNECTION ini: - key: fact_caching_connection section: defaults - key: cache_connection section: inventory type: str version_added: 4.5.0 version_added_collection: community.general 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