lxc-info.sgml.in revision 9c631ea7c2906f41b23f5c8dcc9f6045078879db
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
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane GraberFoundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <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>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <arg choice="opt">-t <replaceable>state</replaceable></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>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <command>lxc-info</command> queries and shows information about a
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber 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
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <option>-n <replaceable>name</replaceable></option>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber The container name.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <varlistentry>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <term>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <option><optional>-c <replaceable>KEY</replaceable></optional></option>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen </term>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <listitem>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen <para>
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen Print a configuration key from the running container. This option
9c631ea7c2906f41b23f5c8dcc9f6045078879dbDwight Engen may be given mulitple 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>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <option><optional>-s</optional></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>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <option><optional>-p</optional></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
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <option><optional>-t <replaceable>state</replaceable></optional></option>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber Check whether the container is in the provided state.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </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>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <varlistentry>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <term>lxc-info -n foo -t RUNNING</term>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <listitem>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber <para>
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber exits 0 if foo is RUNNING, 1 otherwise.
4019712d198a7d50b08b326ade17f5ff1666efbbStéphane Graber </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-->