W3cubDocs

/Ansible 2.10

community.general.linode – Ansible dynamic inventory plugin for Linode.

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.linode.

Synopsis

  • 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 inventory groups are built from groups and not tags.

Requirements

The below requirements are needed on the local controller node that executes this inventory.

  • python >= 2.7
  • linode_api4 >= 2.0.0

Parameters

Parameter Choices/Defaults Configuration Comments
access_token
string / required
env:LINODE_ACCESS_TOKEN
The Linode account personal access token.
plugin
string / required
    Choices:
  • linode
  • community.general.linode
marks this as an instance of the 'linode' plugin
regions
list / elements=string
Default:
[]
Populate inventory with instances in this region.
types
list / elements=string
Default:
[]
Populate inventory with instances with this type.

Examples

# 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

Authors

  • Luke Murphy (@decentral1se)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/linode_inventory.html