3 (C) Copyright Canonical Ltd. 2013
6 Stéphane Graber <stgraber@ubuntu.com>
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public
10 License as published by the Free Software Foundation; either
11 version 2.1 of the License, or (at your option) any later version.
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public
19 License along with this library; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 <!DOCTYPE refentry PUBLIC @docdtd@ [
26 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
27 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
32 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
35 <refentrytitle>lxc-info</refentrytitle>
36 <manvolnum>1</manvolnum>
40 <refname>lxc-info</refname>
43 query information about a container
49 <command>lxc-info</command>
50 <arg choice="req">-n <replaceable>name</replaceable></arg>
51 <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
52 <arg choice="opt">-s</arg>
53 <arg choice="opt">-p</arg>
54 <arg choice="opt">-i</arg>
55 <arg choice="opt">-S</arg>
56 <arg choice="opt">-H</arg>
61 <title>Description</title>
63 <command>lxc-info</command> queries and shows information about a
69 <title>Options</title>
74 <option>-c, --config <replaceable>KEY</replaceable></option>
78 Print a configuration key from the container. This option
79 may be given multiple times to print out multiple key = value pairs.
86 <option>-s, --state</option>
90 Just print the container's state.
97 <option>-p, --pid</option>
101 Just print the container's pid.
108 <option>-i, --ips</option>
112 Just print the container's IP addresses.
119 <option>-S, --stats</option>
123 Just print the container's statistics.
124 Note that for performance reasons the kernel does not account
125 kernel memory use unless a kernel memory limit is set. If a limit
126 is not set, <command>lxc-info</command> will display kernel memory
127 use as 0. A limit can be set by specifying
129 lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable>
131 in your container configuration file, see
133 <refentrytitle>lxc.conf</refentrytitle>
134 <manvolnum>5</manvolnum>
142 <option>-H, --no-humanize</option>
146 Print the container's statistics in raw, non-humanized form. The
147 default is to print statistics in humanized form.
157 <title>Examples</title>
160 <term>lxc-info -n foo</term>
163 Show information for foo.
169 <term>lxc-info -n 'ubuntu.*'</term>
172 Show information for all containers whose name starts with ubuntu.
178 <term>lxc-info -n foo -c lxc.net.0.veth.pair</term>
181 prints the veth pair name of foo.
192 <title>Author</title>
193 <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
197 <!-- Keep this comment at the end of the file
202 sgml-minimize-attributes:nil
203 sgml-always-quote-attributes:t
206 sgml-parent-document:nil
207 sgml-default-dtd-file:nil
208 sgml-exposed-tags:nil
209 sgml-local-catalogs:nil
210 sgml-local-ecat-files:nil