The Ansible Linode Collection contains various plugins for managing Linode services.

This collection has been tested against following Ansible versions: >=2.9.10.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Modules for managing Linode infrastructure.

Modules for retrieving information about existing Linode infrastructure.

Modules for retrieving and filtering on multiple Linode resources.

Dynamically add Linode infrastructure to an Ansible inventory.

You can install the Linode collection with the Ansible Galaxy CLI:

ansible-galaxy collection install linode.cloud

The Python module dependencies are not installed by ansible-galaxy. They can be manually installed using pip:

pip install --upgrade -r https://raw.githubusercontent.com/linode/ansible_linode/main/requirements.txt

⚠️ NOTE: Python dependencies should always be reinstalled when upgrading collection versions

Once the Linode Ansible collection is installed, it can be referenced by its Fully Qualified Collection Namespace (FQCN): linode.cloud.module_name.

In order to use this collection, the LINODE_API_TOKEN environment variable must be set to a valid Linode API v4 token. Alternatively, you can pass your Linode API v4 token into the api_token option for each Linode module you reference.

The LINODE_UA_PREFIX environment variable or the ua_prefix module option can be used to specify a custom User-Agent prefix.

The LINODE_API_URL environment variable pr the api_url module option can be used to specify a custom API base url.

--- - name: create linode instance hosts: localhost tasks: - name: Create a Linode instance  linode.cloud.instance: label: my-linode type: g6-nanode-1 region: us-east image: linode/ubuntu22.04 root_pass: verysecurepassword!!! state: present

For more information on Ansible collection usage, see Ansible's official usage guide.

Use-case examples for this collection can be found here.

The following section outlines various information relating to the development of this collection.

This collection's documentation is generated dynamically from the specification defined in each module using ansible-specdoc.

To quickly and easily attach a debugger to a running module in this collection, you can use the madbg package:

1. Install madbg in your local Python environment:

pip install madbg

2. Call madbg.set_trace(...) at the location you would like to create a breakpoint at:

import madbg; madbg.set_trace()

3. Run the module in either a playbook or a test.
4. In a separate shell, run madbg connect.
5. You should now be able to remotely debug the module as soon as the breakpoint is triggered.

GNU General Public License v3.0.

See COPYING to see the full text.