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

Note

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

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.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

lxd_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: lxd_become_method

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

remote_user

string

added in community.general 10.4.0

User to login/authenticate as.

Can be set from the CLI via 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

  • Matt Clay (@mattclay)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/lxd_connection.html