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.5.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 |
---|---|
The shell to use for execution inside the instance. Default: Configuration:
|
|
The name of the Incus project to use (per Projects are used to divide the instances running on a server. Default: Configuration:
|
|
The name of the Incus remote to use (per Remotes are used to access multiple servers from a single client. Default: Configuration:
|
|
The instance identifier. Default: Configuration:
|