lxc-ls(1) — Linux manual page


LXC-LS(1)                                                          LXC-LS(1)

NAME         top

       lxc-ls - list the containers existing on the system

SYNOPSIS         top

       lxc-ls [ -1 ]  [ --active ]  [ --frozen ]  [ --running ]  [ --stopped
       ]  [ --defined ]  [ -f ]  [ -F format ]  [ -g groups ]  [
       --nesting=NUM ]  [ --filter=regex ]

DESCRIPTION         top

       lxc-ls list the containers existing on the system.

OPTIONS         top

       -1     Show one entry per line. (default when /dev/stdout isn't a

              List only active containers (same as --frozen --running).

              List only frozen containers.

              List only running containers.

              List only stopped containers.

              List only defined containers.

              Use a fancy, column-based output.

       -F,--fancy-format format
              Comma separated list of columns to show in the fancy output.
              The list of accepted and default fields is listed in --help.

       -g,--groups groups
              Comma separated list of groups the container must have to be
              displayed.  The parameter may be passed multiple times.

              Show nested containers. The number of nesting levels to be
              shown can be specified by passing a number as argument.

              The regular expression passed to lxc-ls will be applied to the
              container name. The format is a POSIX extended regular
              expression. It can also be given as additional argument
              without explicitly using --filter.

EXAMPLES         top

       lxc-ls --fancy
              list all the containers, listing one per line along with its
              name, state, ipv4 and ipv6 addresses.

       lxc-ls --active -1
              list active containers and display the list in one column.

COMMON OPTIONS         top

       These options are common to most of lxc commands.

       -?, -h, --help
              Print a longer usage message than normal.

              Give the usage message

       -q, --quiet
              mute on

       -P, --lxcpath=PATH
              Use an alternate container path. The default is

       -o, --logfile=FILE
              Output to an alternate log FILE. The default is no log.

       -l, --logpriority=LEVEL
              Set log priority to LEVEL. The default log priority is ERROR.
              Possible values are : FATAL, CRIT, WARN, ERROR, NOTICE, INFO,

              Note that this option is setting the priority of the events
              log in the alternate log file. It do not have effect on the
              ERROR events log on stderr.

       -n, --name=NAME
              Use container identifier NAME.  The container identifier
              format is an alphanumeric string.

              Specify the configuration file to configure the virtualization
              and isolation functionalities for the container.

              This configuration file if present will be used even if there
              is already a configuration file present in the previously
              created container (via lxc-create).

              Show the version number.

SEE ALSO         top

       lxc(7), lxc-create(1), lxc-copy(1), lxc-destroy(1), lxc-start(1),
       lxc-stop(1), lxc-execute(1), lxc-console(1), lxc-monitor(1),
       lxc-wait(1), lxc-cgroup(1), lxc-ls(1), lxc-info(1), lxc-freeze(1),
       lxc-unfreeze(1), lxc-attach(1), lxc.conf(5)

HISTORY         top

       Written originally as a shell script by Daniel Lezcano and Serge
       Hallyn.  Later reimplemented and extended in Python by Stéphane
       Graber and then reimplemented and extended in C by Christian Brauner.

AUTHOR         top

       Christian Brauner <christian.brauner@mailbox.org>, Stéphane Graber

COLOPHON         top

       This page is part of the lxc (Linux containers) project.  Information
       about the project can be found at ⟨http://linuxcontainers.org/⟩.  If
       you have a bug report for this manual page, send it to
       lxc-devel@lists.linuxcontainers.org.  This page was obtained from the
       project's upstream Git repository ⟨git://github.com/lxc/lxc⟩ on
       2020-11-01.  (At that time, the date of the most recent commit that
       was found in the repository was 2020-10-28.)  If you discover any
       rendering problems in this HTML version of the page, or you believe
       there is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

                                 2020-11-01                        LXC-LS(1)

Pages that refer to this page: lxc-attach(1)lxc-autostart(1)lxc-cgroup(1)lxc-checkconfig(1)lxc-checkpoint(1)lxc-config(1)lxc-console(1)lxc-copy(1)lxc-create(1)lxc-destroy(1)lxc-device(1)lxc-execute(1)lxc-freeze(1)lxc-info(1)lxc-ls(1)lxc-monitor(1)lxc-snapshot(1)lxc-start(1)lxc-stop(1)lxc-top(1)lxc-unfreeze(1)lxc-unshare(1)lxc-update-config(1)lxc-usernsexec(1)lxc-wait(1)lxc.container.conf(5)lxc.system.conf(5)lxc(7)