Documentation

PLEASE NOTE: This document applies to v2.19 version and not to the latest stable release v2.20

Documentation for other releases can be found by using the version selector in the top right of any doc page.

lxd_container

Manage LXD containers.

Attributes

check_mode:
  support: full

Parameters

Parameter	Required	Type	Values	Description
config		object		Container configuration key-value pairs.
devices		object		Device configuration.
force		boolean		Force operation (for stop/delete).
name	true	string		Name of the container.
profiles		array		Profiles to apply to the container.
project		string		Project name.
source		object		Image source configuration.
state		string	absent present started stopped frozen	State of the container.
target		string		Target remote LXD server.
timeout		integer		Timeout for operations (seconds).
wait		boolean		Wait for operation to complete.

Example

- name: Create and start a container
  lxd_container:
    name: webserver
    state: started
    source:
      type: image
      alias: ubuntu/22.04

- name: Create container with custom config
  lxd_container:
    name: myapp
    state: started
    source:
      type: image
      alias: alpine/3.18
    config:
      limits.cpu: "2"
      limits.memory: 2GB

- name: Create container with profiles
  lxd_container:
    name: profiled
    state: started
    source:
      type: image
      alias: ubuntu/22.04
    profiles:
      - default
      - custom-profile

- name: Create container with devices
  lxd_container:
    name: devcontainer
    state: started
    source:
      type: image
      alias: ubuntu/22.04
    devices:
      eth0:
        type: nic
        nictype: bridged
        parent: lxdbr0

- name: Stop a container
  lxd_container:
    name: webserver
    state: stopped

- name: Freeze a container
  lxd_container:
    name: webserver
    state: frozen

- name: Delete a container
  lxd_container:
    name: webserver
    state: absent