lxc-ls

List all containers

$ sudo lxc-ls

$ sudo lxc-ls --active

$ sudo lxc-ls --frozen

$ sudo lxc-ls --stopped

$ sudo lxc-ls [[-f|--fancy]]

$ lxc-ls [[-?|--help]]

lxc-ls [OPTIONS]

-f
    Show detailed information for each container, including their current state, IP addresses (if any), and PID (if running).

-1
    Output one container name per line.

-h
    Display help message.

-v
    Show version.

The `lxc-ls` command is a fundamental tool for managing LXC (Linux Containers). It provides a simple and effective way to list all defined LXC containers on a system, along with their current state. This state includes information such as whether the container is running, stopped, frozen, or defined but not yet created.

Without any options, `lxc-ls` simply displays a newline-separated list of container names to standard output. The command is usually the starting point for any LXC administration task, as it allows the user to quickly identify the containers they want to manage. For example, before stopping or starting a container, one would typically use `lxc-ls` to ensure the container's name is correct. It provides a quick and easy way to get an overview of your container environment, making it easier to start, stop, or otherwise interact with your containers effectively and efficiently. In larger environments with many containers, the `lxc-ls` helps maintain awareness and organization.

It does not require root privileges to simply list the names, but may do so to retrieve container information which is otherwise unavailable to a non-privileged user.

The output of `lxc-ls` might not be consistent if containers are being created or destroyed while the command is running. It reflects the LXC configuration at the time of execution.

The command returns 0 on success and a non-zero value on failure.

When used without `-f`, output is a simple list of container names separated by spaces. When `-f` is used the format is defined by `lxc-info`.

The `lxc-ls` command has been a core component of the LXC toolset since its initial development. It's a basic command but has been consistently maintained and updated along with the LXC project's evolution to ensure compatibility with new features and kernel versions.

lxc-create(1), lxc-start(1), lxc-stop(1), lxc-destroy(1), lxc-info(1)