<!DOCTYPE refentry PUBLIC @docdtd@ [

<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">

<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">

]>

<refentry>

<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

<refmeta>

<refentrytitle>lxc-info</refentrytitle>

<manvolnum>1</manvolnum>

</refmeta>

<refnamediv>

<refname>lxc-info</refname>

<refpurpose>

query information about a container

</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>lxc-info</command>

<arg choice="opt">-n <replaceable>name</replaceable></arg>

<arg choice="opt">-c <replaceable>KEY</replaceable></arg>

<arg choice="opt">-s</arg>

<arg choice="opt">-p</arg>

<arg choice="opt">-i</arg>

<arg choice="opt">-t <replaceable>state</replaceable></arg>

<arg choice="opt">-S</arg>

<arg choice="opt">-H</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>

<command>lxc-info</command> queries and shows information about

containers.

</para>

</refsect1>

<refsect1>

<title>Options</title>

<variablelist>

<varlistentry>

<term>

<option><optional>-n <replaceable>name</replaceable></optional></option>

</term>

<listitem>

<para>

The container name. It is interpreted as a regular expression,

so it is possible to get information on all containers, several

of them or just one. See

<citerefentry>

<refentrytitle><command>regex</command></refentrytitle>

<manvolnum>7</manvolnum>

</citerefentry> for regular expression syntax. If not specified,

<replaceable>name</replaceable> will default to '.*' which

will give information on all containers in

<command>lxcpath</command>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional>-c <replaceable>KEY</replaceable></optional></option>

</term>

<listitem>

<para>

Print a configuration key from the running container. This option

may be given mulitple times to print out multiple key = value pairs.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional>-s</optional></option>

</term>

<listitem>

<para>

Just print the container's state.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional>-p</optional></option>

</term>

<listitem>

<para>

Just print the container's pid.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional>-i</optional></option>

</term>

<listitem>

<para>

Just print the container's IP addresses.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional>-S</optional></option>

</term>

<listitem>

<para>

Just print the container's statistics.

Note that for performance reasons the kernel does not account

kernel memory use unless a kernel memory limit is set. If a limit

is not set, <command>lxc-info</command> will display kernel memory

use as 0. A limit can be set by specifying

<programlisting>

lxc.cgroup.memory.kmem.limit_in_bytes = <replaceable>number</replaceable>

</programlisting>

in your container configuration file, see

<citerefentry>

<refentrytitle>lxc.conf</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional>-H</optional></option>

</term>

<listitem>

<para>

Print the container's statistics in raw, non-humanized form. The

default is to print statistics in humanized form.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional>-t <replaceable>state</replaceable></optional></option>

</term>

<listitem>

<para>

Check whether the container is in the provided state.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

&commonoptions;

<refsect1>

<title>Examples</title>

<variablelist>

<varlistentry>

<term>lxc-info -n foo</term>

<listitem>

<para>

Show information for foo.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>lxc-info -n 'ubuntu.*'</term>

<listitem>

<para>

Show information for all containers whose name starts with ubuntu.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>lxc-info -n foo -t RUNNING</term>

<listitem>

<para>

exits 0 if foo is RUNNING, 1 otherwise.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>lxc-info -n foo -c lxc.network.0.veth.pair</term>

<listitem>

<para>

prints the veth pair name of foo.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

&seealso;

<refsect1>

<title>Author</title>

<para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>

</refsect1>

</refentry>