community.general.incus connection – Run tasks in Incus instances using the Incus CLI

Note

This connection plugin is part of the community.general collection (version 11.2.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.incus.

New in community.general 8.2.0

Synopsis

  • Run commands or put/fetch files to an existing Incus instance using Incus CLI.

Parameters

Parameter

Comments

executable

string

The shell to use for execution inside the instance.

Default: "/bin/sh"

Configuration:

  • Variable: ansible_executable

  • Variable: ansible_incus_executable

incus_become_method

string

added in community.general 10.4.0

Become command used to switch to a non-root user.

Is only used when remote_user is not root.

Default: "/bin/su"

Configuration:

  • Variable: incus_become_method

project

string

The name of the Incus project to use (per incus project list).

Projects are used to divide the instances running on a server.

Default: "default"

Configuration:

  • Variable: ansible_incus_project

remote

string

The name of the Incus remote to use (per incus remote list).

Remotes are used to access multiple servers from a single client.

Default: "local"

Configuration:

  • Variable: ansible_incus_remote

remote_addr

string

The instance identifier.

Default: "inventory_hostname"

Configuration:

  • Variable: inventory_hostname

  • Variable: ansible_host

  • Variable: ansible_incus_host

remote_user

string

added in community.general 10.4.0

User to login/authenticate as.

Can be set from the CLI with the --user or -u options.

Default: "root"

Configuration:

  • INI entry:

    [defaults]
remote_user = root

  • Environment variable: ANSIBLE_REMOTE_USER

  • Keyword: remote_user

  • Variable: ansible_user

Note

Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. The entry types are also ordered by precedence from low to high priority order. For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).

Authors

  • Stéphane Graber (@stgraber)