4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber<!--
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber(C) Copyright Canonical Ltd. 2013
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberAuthors:
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberStéphane Graber <stgraber@ubuntu.com>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberThis library is free software; you can redistribute it and/or
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabermodify it under the terms of the GNU Lesser General Public
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberLicense as published by the Free Software Foundation; either
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graberversion 2.1 of the License, or (at your option) any later version.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberThis library is distributed in the hope that it will be useful,
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graberbut WITHOUT ANY WARRANTY; without even the implied warranty of
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberLesser General Public License for more details.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberYou should have received a copy of the GNU Lesser General Public
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberLicense along with this library; if not, write to the Free Software
250b1eec71b074acdff1c5f6b5a1f0d7d2c20b77Stéphane GraberFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber-->
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
7f95145833bb24f54e037f73ecc37444d6635697Dwight Engen<!DOCTYPE refentry PUBLIC @docdtd@ [
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber]>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber<refentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refmeta>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refentrytitle>lxc-info</refentrytitle>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <manvolnum>1</manvolnum>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refmeta>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refnamediv>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refname>lxc-info</refname>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refpurpose>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber query information about a container
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refpurpose>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refnamediv>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refsynopsisdiv>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <cmdsynopsis>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <command>lxc-info</command>
e339d6b9c1b85e6341c0d230ac68c5958f28cf08KATOH Yasufumi <arg choice="req">-n <replaceable>name</replaceable></arg>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <arg choice="opt">-s</arg>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <arg choice="opt">-p</arg>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber <arg choice="opt">-i</arg>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <arg choice="opt">-S</arg>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <arg choice="opt">-H</arg>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </cmdsynopsis>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refsynopsisdiv>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <title>Description</title>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>
e339d6b9c1b85e6341c0d230ac68c5958f28cf08KATOH Yasufumi <command>lxc-info</command> queries and shows information about a
e339d6b9c1b85e6341c0d230ac68c5958f28cf08KATOH Yasufumi container.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <title>Options</title>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <variablelist>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <varlistentry>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-c, --config <replaceable>KEY</replaceable></option>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </term>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <listitem>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <para>
5c4734bcfb57a9886904e0dec3a2685fea617811Stéphane Graber Print a configuration key from the container. This option
e9555a6bc7056cd887ee19c80b6c59627ac61255Evgeni Golov may be given multiple times to print out multiple key = value pairs.
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </para>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </listitem>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </varlistentry>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-s, --state</option>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber Just print the container's state.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-p, --pid</option>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber Just print the container's pid.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber <varlistentry>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-i, --ips</option>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber </term>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber <listitem>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber <para>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber Just print the container's IP addresses.
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber </para>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber </listitem>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber </varlistentry>
211e51e81e7c6ab670d1d282d78e5ef26d039a79Stéphane Graber
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <varlistentry>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-S, --stats</option>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </term>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <listitem>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <para>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen Just print the container's statistics.
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen Note that for performance reasons the kernel does not account
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen kernel memory use unless a kernel memory limit is set. If a limit
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen is not set, <command>lxc-info</command> will display kernel memory
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen use as 0. A limit can be set by specifying
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <programlisting>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </programlisting>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen in your container configuration file, see
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <citerefentry>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <refentrytitle>lxc.conf</refentrytitle>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <manvolnum>5</manvolnum>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </citerefentry>.
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </para>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </listitem>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </varlistentry>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <varlistentry>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-H, --no-humanize</option>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </term>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <listitem>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <para>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen Print the container's statistics in raw, non-humanized form. The
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen default is to print statistics in humanized form.
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </para>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </listitem>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </variablelist>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber &commonoptions;
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <title>Examples</title>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <variablelist>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <term>lxc-info -n foo</term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber Show information for foo.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </para>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </listitem>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </varlistentry>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <varlistentry>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <term>lxc-info -n 'ubuntu.*'</term>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <listitem>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen <para>
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen Show information for all containers whose name starts with ubuntu.
b9d957c316c3827898b91cc69788d90be3260935Dwight Engen </para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <varlistentry>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <term>lxc-info -n foo -c lxc.network.0.veth.pair</term>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <listitem>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <para>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen prints the veth pair name of foo.
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </para>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </listitem>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </varlistentry>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </variablelist>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber &seealso;
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <title>Author</title>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </refsect1>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber</refentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber<!-- Keep this comment at the end of the file
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberLocal variables:
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabermode: sgml
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-omittag:t
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-shorttag:t
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-minimize-attributes:nil
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-always-quote-attributes:t
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-indent-step:2
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-indent-data:t
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-parent-document:nil
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-default-dtd-file:nil
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-exposed-tags:nil
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-local-catalogs:nil
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Grabersgml-local-ecat-files:nil
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberEnd:
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber-->