lxc-stop.sgml.in revision 936762f3fb6cf10e0756719f03aebe052d5c31a8
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanolxc: linux Container library
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano(C) Copyright IBM Corp. 2007, 2008
9afe19d634946d50eab30e3b90cb5cebcde39eeaDaniel LezcanoDaniel Lezcano <daniel.lezcano at free.fr>
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.
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.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoYou should have received a copy of the GNU Lesser General Public
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLicense 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
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refnamediv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refpurpose>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano stop the application running inside a container
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refpurpose>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refnamediv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <refsynopsisdiv>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <cmdsynopsis>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="req">-n <replaceable>name</replaceable></arg>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <arg choice="opt">-t <replaceable>timeout</replaceable></arg>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </cmdsynopsis>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsynopsisdiv>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <command>lxc-stop</command> reboots, cleanly shuts down, or kills
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn all the processes inside the container. By default, it will
f0f1d8c076ae93d8ecf735c2eeae471e27ca6abdDwight Engen request a clean shutdown of the container by sending
f0f1d8c076ae93d8ecf735c2eeae471e27ca6abdDwight Engen <command>lxc.haltsignal</command> (defaults to SIGPWR) to
f0f1d8c076ae93d8ecf735c2eeae471e27ca6abdDwight Engen the container's init process, waiting up to 60 seconds for the container
f0f1d8c076ae93d8ecf735c2eeae471e27ca6abdDwight Engen to exit, and then returning. If the container fails to cleanly exit in
f0f1d8c076ae93d8ecf735c2eeae471e27ca6abdDwight Engen 60 seconds, it will be sent the <command>lxc.stopsignal</command>
936762f3fb6cf10e0756719f03aebe052d5c31a8Bogdan Purcareata (defaults to SIGKILL) to force it to shut down. A request to reboot will
936762f3fb6cf10e0756719f03aebe052d5c31a8Bogdan Purcareata send the <command>lxc.rebootsignal</command> (defaults to SIGINT) to the
936762f3fb6cf10e0756719f03aebe052d5c31a8Bogdan Purcareata container's init process.
84fbfcb434f5a59680b7f017bbc1d0db0b81a39dDwight Engen The <optional>-W</optional>, <optional>-r</optional>,
84fbfcb434f5a59680b7f017bbc1d0db0b81a39dDwight Engen <optional>-k</optional> and <optional>--nokill</optional>
84fbfcb434f5a59680b7f017bbc1d0db0b81a39dDwight Engen 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.
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <variablelist>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn Request a reboot of the container.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
84fbfcb434f5a59680b7f017bbc1d0db0b81a39dDwight Engen Rather than requesting a clean shutdown of the container, explicitly
84fbfcb434f5a59680b7f017bbc1d0db0b81a39dDwight Engen kill all tasks in the container. This is the legacy
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
84fbfcb434f5a59680b7f017bbc1d0db0b81a39dDwight Engen Only request a clean shutdown, do not kill the container tasks if the
84fbfcb434f5a59680b7f017bbc1d0db0b81a39dDwight Engen clean shutdown fails.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
8face1de22e8cf3bab2d6cdf33cdcc7476f9217bSerge Hallyn <varlistentry>
8face1de22e8cf3bab2d6cdf33cdcc7476f9217bSerge Hallyn This option avoids the use of any of the API lxc locking, and should
8face1de22e8cf3bab2d6cdf33cdcc7476f9217bSerge Hallyn only be used if <command>lxc-stop</command> is hanging due to a bad
8face1de22e8cf3bab2d6cdf33cdcc7476f9217bSerge Hallyn system state.
8face1de22e8cf3bab2d6cdf33cdcc7476f9217bSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn Simply perform the requestion action (reboot, shutdown, or hard
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn kill) and exit.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn <option>-t,--timeout <replaceable>TIMEOUT</replaceable></option>
25070b660187b61aa4e969db01b55d1360639543Serge Hallyn Wait TIMEOUT seconds before hard-stopping the container.
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </varlistentry>
3e625e2d2e12b919dd9590b97badc6108ee67b1aSerge Hallyn </variablelist>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn <variablelist>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn <varlistentry>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn The container was successfully stopped.
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn </varlistentry>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn <varlistentry>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn An error occurred while stopping the container.
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn </varlistentry>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn <varlistentry>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn The specified container exists but was not running.
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn </varlistentry>
13bc2fd2370f8e3778d81f58ac8dda5746550a4fSerge Hallyn </variablelist>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <variablelist>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano The specified container was not created before with
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </listitem>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber </varlistentry>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </variablelist>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano </refsect1>
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcano<!-- Keep this comment at the end of the file
d823d5b966f49d975a09a8512d084389d6d7ffc7dlezcanoLocal variables:
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