lxc-ls(1)

1lxc-ls(1)                                                            lxc-ls(1)
2
3
4

NAME

6       lxc-ls - list the containers existing on the system
7

SYNOPSIS

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

DESCRIPTION

13       lxc-ls list the containers existing on the system.
14

OPTIONS

16       -1     Show one entry per line. (default when /dev/stdout isn't a tty)
17
18       --active
19              List only active containers (same as --frozen --running).
20
21       --frozen
22              List only frozen containers.
23
24       --running
25              List only running containers.
26
27       --stopped
28              List only stopped containers.
29
30       --defined
31              List only defined containers.
32
33       -f,--fancy
34              Use a fancy, column-based output.
35
36       -F,--fancy-format format
37              Comma separated list of columns to show  in  the  fancy  output.
38              The list of accepted and default fields is listed in --help.
39
40       -g,--groups groups
41              Comma  separated  list  of  groups the container must have to be
42              displayed.  The parameter may be passed multiple times.
43
44       --nesting=NUM
45              Show nested containers. The number of nesting levels to be shown
46              can be specified by passing a number as argument.
47
48       --filter=regex
49              The  regular  expression passed to lxc-ls will be applied to the
50              container name. The format is a POSIX extended  regular  expres‐
51              sion.  It  can  also be given as additional argument without ex‐
52              plicitly using --filter.
53

EXAMPLES

55       lxc-ls --fancy
56              list all the containers, listing one per  line  along  with  its
57              name, state, ipv4 and ipv6 addresses.
58
59       lxc-ls --active -1
60              list active containers and display the list in one column.
61

COMMON OPTIONS

63       These options are common to most of lxc commands.
64
65       -?, -h, --help
66              Print a longer usage message than normal.
67
68       --usage
69              Give the usage message
70
71       -q, --quiet
72              mute on
73
74       -P, --lxcpath=PATH
75              Use an alternate container path. The default is /var/lib/lxc.
76
77       -o, --logfile=FILE
78              Output to an alternate log FILE. The default is no log.
79
80       -l, --logpriority=LEVEL
81              Set  log  priority  to LEVEL. The default log priority is ERROR.
82              Possible values are : FATAL, CRIT, WARN,  ERROR,  NOTICE,  INFO,
83              DEBUG.
84
85              Note  that this option is setting the priority of the events log
86              in the alternate log file. It do not have effect  on  the  ERROR
87              events log on stderr.
88
89       -n, --name=NAME
90              Use  container identifier NAME.  The container identifier format
91              is an alphanumeric string.
92
93       --rcfile=FILE
94              Specify the configuration file to configure  the  virtualization
95              and isolation functionalities for the container.
96
97              This configuration file if present will be used even if there is
98              already a configuration file present in the  previously  created
99              container (via lxc-create).
100
101       --version
102              Show the version number.
103

HISTORY

111       Written originally as a shell script by Daniel Lezcano and  Serge  Hal‐
112       lyn.  Later reimplemented and extended in Python by Stéphane Graber and
113       then reimplemented and extended in C by Christian Brauner.
114

AUTHOR

116       Christian  Brauner  <christian.brauner@mailbox.org>,  Stéphane   Graber
117       <stgraber@ubuntu.com>
118
119
120
121                                  2021-05-08                         lxc-ls(1)