]>
Commit | Line | Data |
---|---|---|
4019712d SG |
1 | <!-- |
2 | ||
3 | (C) Copyright Canonical Ltd. 2013 | |
4 | ||
5 | Authors: | |
6 | Stéphane Graber <stgraber@ubuntu.com> | |
7 | ||
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. | |
12 | ||
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. | |
17 | ||
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 | |
250b1eec | 20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
4019712d SG |
21 | |
22 | --> | |
23 | ||
7f951458 | 24 | <!DOCTYPE refentry PUBLIC @docdtd@ [ |
4019712d SG |
25 | |
26 | <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> | |
27 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> | |
28 | ]> | |
29 | ||
30 | <refentry> | |
31 | ||
32 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
33 | ||
34 | <refmeta> | |
35 | <refentrytitle>lxc-info</refentrytitle> | |
36 | <manvolnum>1</manvolnum> | |
37 | </refmeta> | |
38 | ||
39 | <refnamediv> | |
40 | <refname>lxc-info</refname> | |
41 | ||
42 | <refpurpose> | |
43 | query information about a container | |
44 | </refpurpose> | |
45 | </refnamediv> | |
46 | ||
47 | <refsynopsisdiv> | |
48 | <cmdsynopsis> | |
49 | <command>lxc-info</command> | |
e339d6b9 | 50 | <arg choice="req">-n <replaceable>name</replaceable></arg> |
9c631ea7 DE |
51 | <arg choice="opt">-c <replaceable>KEY</replaceable></arg> |
52 | <arg choice="opt">-s</arg> | |
53 | <arg choice="opt">-p</arg> | |
211e51e8 | 54 | <arg choice="opt">-i</arg> |
b9d957c3 DE |
55 | <arg choice="opt">-S</arg> |
56 | <arg choice="opt">-H</arg> | |
4019712d SG |
57 | </cmdsynopsis> |
58 | </refsynopsisdiv> | |
59 | ||
60 | <refsect1> | |
61 | <title>Description</title> | |
62 | <para> | |
e339d6b9 KY |
63 | <command>lxc-info</command> queries and shows information about a |
64 | container. | |
4019712d SG |
65 | </para> |
66 | </refsect1> | |
67 | ||
68 | <refsect1> | |
69 | <title>Options</title> | |
70 | <variablelist> | |
71 | ||
9c631ea7 DE |
72 | <varlistentry> |
73 | <term> | |
1bc07a5b | 74 | <option>-c, --config <replaceable>KEY</replaceable></option> |
9c631ea7 DE |
75 | </term> |
76 | <listitem> | |
77 | <para> | |
5c4734bc | 78 | Print a configuration key from the container. This option |
e9555a6b | 79 | may be given multiple times to print out multiple key = value pairs. |
9c631ea7 DE |
80 | </para> |
81 | </listitem> | |
82 | </varlistentry> | |
83 | ||
4019712d SG |
84 | <varlistentry> |
85 | <term> | |
1bc07a5b | 86 | <option>-s, --state</option> |
4019712d SG |
87 | </term> |
88 | <listitem> | |
89 | <para> | |
90 | Just print the container's state. | |
91 | </para> | |
92 | </listitem> | |
93 | </varlistentry> | |
94 | ||
95 | <varlistentry> | |
96 | <term> | |
1bc07a5b | 97 | <option>-p, --pid</option> |
4019712d SG |
98 | </term> |
99 | <listitem> | |
100 | <para> | |
101 | Just print the container's pid. | |
102 | </para> | |
103 | </listitem> | |
104 | </varlistentry> | |
105 | ||
211e51e8 SG |
106 | <varlistentry> |
107 | <term> | |
1bc07a5b | 108 | <option>-i, --ips</option> |
211e51e8 SG |
109 | </term> |
110 | <listitem> | |
111 | <para> | |
112 | Just print the container's IP addresses. | |
113 | </para> | |
114 | </listitem> | |
115 | </varlistentry> | |
116 | ||
b9d957c3 DE |
117 | <varlistentry> |
118 | <term> | |
1bc07a5b | 119 | <option>-S, --stats</option> |
b9d957c3 DE |
120 | </term> |
121 | <listitem> | |
122 | <para> | |
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 | |
128 | <programlisting> | |
129 | lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable> | |
130 | </programlisting> | |
131 | in your container configuration file, see | |
132 | <citerefentry> | |
133 | <refentrytitle>lxc.conf</refentrytitle> | |
134 | <manvolnum>5</manvolnum> | |
135 | </citerefentry>. | |
136 | </para> | |
137 | </listitem> | |
138 | </varlistentry> | |
139 | ||
140 | <varlistentry> | |
141 | <term> | |
1bc07a5b | 142 | <option>-H, --no-humanize</option> |
b9d957c3 DE |
143 | </term> |
144 | <listitem> | |
145 | <para> | |
146 | Print the container's statistics in raw, non-humanized form. The | |
147 | default is to print statistics in humanized form. | |
148 | </para> | |
149 | </listitem> | |
150 | </varlistentry> | |
4019712d SG |
151 | </variablelist> |
152 | </refsect1> | |
153 | ||
154 | &commonoptions; | |
155 | ||
156 | <refsect1> | |
157 | <title>Examples</title> | |
158 | <variablelist> | |
159 | <varlistentry> | |
160 | <term>lxc-info -n foo</term> | |
161 | <listitem> | |
162 | <para> | |
163 | Show information for foo. | |
164 | </para> | |
b9d957c3 DE |
165 | </listitem> |
166 | </varlistentry> | |
167 | ||
168 | <varlistentry> | |
169 | <term>lxc-info -n 'ubuntu.*'</term> | |
170 | <listitem> | |
171 | <para> | |
172 | Show information for all containers whose name starts with ubuntu. | |
173 | </para> | |
4019712d SG |
174 | </listitem> |
175 | </varlistentry> | |
176 | ||
9c631ea7 | 177 | <varlistentry> |
7fa3f2e9 | 178 | <term>lxc-info -n foo -c lxc.net.0.veth.pair</term> |
9c631ea7 DE |
179 | <listitem> |
180 | <para> | |
181 | prints the veth pair name of foo. | |
182 | </para> | |
183 | </listitem> | |
184 | </varlistentry> | |
185 | ||
4019712d SG |
186 | </variablelist> |
187 | </refsect1> | |
188 | ||
189 | &seealso; | |
190 | ||
191 | <refsect1> | |
192 | <title>Author</title> | |
193 | <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para> | |
194 | </refsect1> | |
195 | </refentry> | |
196 | ||
197 | <!-- Keep this comment at the end of the file | |
198 | Local variables: | |
199 | mode: sgml | |
200 | sgml-omittag:t | |
201 | sgml-shorttag:t | |
202 | sgml-minimize-attributes:nil | |
203 | sgml-always-quote-attributes:t | |
204 | sgml-indent-step:2 | |
205 | sgml-indent-data: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 | |
211 | End: | |
212 | --> |