Note
This plugin is part of the community.general collection (version 3.8.1).
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 community.general.
To use it in a playbook, specify: community.general.linode.
The below requirements are needed on the local controller node that executes this inventory.
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
| access_token string / required | env:LINODE_ACCESS_TOKEN | The Linode account personal access token. | |
| compose dictionary added in 2.0.0 of community.general | Default: {} | Create vars from jinja2 expressions. | |
| groups dictionary added in 2.0.0 of community.general | Default: {} | Add hosts to group based on Jinja2 conditionals. | |
| ip_style string added in 3.6.0 of community.general |
| Populate hostvars with all information available from the Linode APIv4. | |
| keyed_groups list / elements=string added in 2.0.0 of community.general | Default: [] | Add hosts to group based on the values of a variable. | |
| leading_separator boolean added in 2.11 of ansible.builtin |
| 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. | |
| plugin string / required |
| Marks this as an instance of the 'linode' plugin. | |
| regions list / elements=string | Default: [] | Populate inventory with instances in this region. | |
| strict boolean added in 2.0.0 of community.general |
| If 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. | |
| tags list / elements=string added in 2.0.0 of community.general | Default: [] | Populate inventory only with instances which have at least one of the tags listed here. | |
| types list / elements=string | Default: [] | Populate inventory with instances with this type. | |
| use_extra_vars boolean added in 2.11 of ansible.builtin |
| ini entries: [inventory_plugins] env:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Merge extra vars into the available variables for composition (highest precedence). |
# Minimal example. `LINODE_ACCESS_TOKEN` is exposed in environment.
plugin: community.general.linode
# Example with regions, types, groups and access token
plugin: community.general.linode
access_token: foobar
regions:
- eu-west
types:
- g5-standard-2
# Example with keyed_groups, groups, and compose
plugin: community.general.linode
access_token: foobar
keyed_groups:
- key: tags
separator: ''
- key: region
prefix: region
groups:
webservers: "'web' in (tags|list)"
mailservers: "'mail' in (tags|list)"
compose:
# By default, Ansible tries to connect to the label of the instance.
# Since that might not be a valid name to connect to, you can
# replace it with the first IPv4 address of the linode as follows:
ansible_ssh_host: ipv4[0]
ansible_port: 2222
# Example where control traffic limited to internal network
plugin: community.general.linode
access_token: foobar
ip_style: api
compose:
ansible_host: "ipv4 | community.general.json_query('[?public==`false`].address') | first"
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/linode_inventory.html