lxc-stop.sgml.in revision 3e625e2d2e12b919dd9590b97badc6108ee67b1a
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber<!--
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanolxc: linux Container library
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano(C) Copyright IBM Corp. 2007, 2008
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoAuthors:
9afe19d634946d50eab30e3b90cb5cebcde39eeaDaniel LezcanoDaniel Lezcano <daniel.lezcano at free.fr>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoThis library is free software; you can redistribute it and/or
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanomodify it under the terms of the GNU Lesser General Public
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLicense as published by the Free Software Foundation; either
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoversion 2.1 of the License, or (at your option) any later version.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoThis library is distributed in the hope that it will be useful,
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanobut WITHOUT ANY WARRANTY; without even the implied warranty of
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLesser General Public License for more details.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoYou should have received a copy of the GNU Lesser General Public
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLicense along with this library; if not, write to the Free Software
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoFoundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano-->
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
7f95145833bb24f54e037f73ecc37444d6635697Dwight Engen<!DOCTYPE refentry PUBLIC @docdtd@ [
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand]>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano<refentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refmeta>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refentrytitle>lxc-stop</refentrytitle>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <manvolnum>1</manvolnum>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refmeta>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refnamediv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refname>lxc-stop</refname>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refpurpose>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano stop the application running inside a container
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refpurpose>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refnamediv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refsynopsisdiv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <cmdsynopsis>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <command>lxc-stop</command>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="req">-n <replaceable>name</replaceable></arg>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <arg choice="opt">-W</arg>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <arg choice="opt">-r</arg>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <arg choice="opt">-t <replaceable>timeout</replaceable></arg>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <arg choice="opt">-k</arg>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <arg choice="opt">-s</arg>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </cmdsynopsis>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsynopsisdiv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <title>Description</title>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <command>lxc-stop</command> reboots, cleanly shuts down, or kills
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn all the processes inside the container. By default, it will
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn request a clean shutdown of the container (by sending SIGPWR to
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn the container), wait 60 seconds for the container to exit, and
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn returns. If the container fails to cleanly exit, then after 60
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn seconds the container will be sent the
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <command>lxc.stopsignal</command> to force it to shut down.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn The <optional>-W</optional>, <optional>-r</optional>, <optional>-s</optional>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn and <optional>-k</optional> options specify the action to perform.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <optional>-W</optional> indicates that after performing the specified
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn action, <command>lxc-stop</command> should immediately exit, while
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <optional>-t TIMEOUT</optional> specifies the maximum amount of time
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn to wait for the container to complete the shutdown or reboot.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <refsect1>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <title>Options</title>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <variablelist>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <option>-r,--reboot </option>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn Request a reboot of the container.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <option>-s,--shutdown </option>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn Only request a clean shutdown, do not kill the container tasks if the
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn clean shutdown fails.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <option>-k,--kill </option>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn Rather than requesting a clean shutdown of the container, explicitly
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn kill all tasks in the container. This is the legacy
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <command>lxc-stop</command> behavior.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <option>-W,--nowait </option>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn Simply perform the requestion action (reboot, shutdown, or hard
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn kill) and exit.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <option>-t,--timeout <replaceable>TIMEOUT</replaceable></option>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </term>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn Wait TIMEOUT seconds before hard-stopping the container of (in
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn the reboot case) returning failure.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </para>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </listitem>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </variablelist>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <title>Diagnostic</title>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <variablelist>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <term>The container is busy</term>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <listitem>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano The specified container is already running an
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano application. You should stop it before reuse this
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano container or create a new one.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </listitem>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber </varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <term>The container was not found</term>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <listitem>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano The specified container was not created before with
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano the <command>lxc-create</command> command.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </listitem>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber </varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </variablelist>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand &seealso;
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <title>Author</title>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano</refentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano<!-- Keep this comment at the end of the file
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLocal variables:
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanomode: sgml
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-omittag:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-shorttag:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-minimize-attributes:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-always-quote-attributes:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-indent-step:2
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-indent-data:t
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-parent-document:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-default-dtd-file:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-exposed-tags:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-local-catalogs:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanosgml-local-ecat-files:nil
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoEnd:
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano-->