community.general.lxd connection – Run tasks in LXD instances via lxc CLI

Note

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

Synopsis

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

Parameters

Parameter

Comments

executable

string

Shell to use for execution inside instance.

Default: "/bin/sh"

Configuration:

  • Variable: ansible_executable

  • Variable: ansible_lxd_executable

project

string

added in community.general 2.0.0

Name of the LXD project to use.

Configuration:

  • Variable: ansible_lxd_project

remote

string

added in community.general 2.0.0

Name of the LXD remote to use.

Default: "local"

Configuration:

  • Variable: ansible_lxd_remote

remote_addr

string

Instance (container/VM) identifier.

Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before .) is used as the instance identifier.

Default: "inventory_hostname"

Configuration:

  • Variable: inventory_hostname

  • Variable: ansible_host

  • Variable: ansible_lxd_host

Authors

  • Matt Clay (@mattclay)

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.