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

Note

This connection plugin is part of the community.general collection (version 9.2.0).

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

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

Authors

  • Stéphane Graber (@stgraber)

Hint

Configuration entries for each entry type 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.