lxc-snapshot.sgml.in revision a5ba96715d4ef264c43d4f187251de491ba198c0
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynlxc: linux Container library
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn(C) Copyright Canonical Inc. 2007, 2008
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynSerge Hallyn <serge.hallyn at ubuntu.com>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynThis library is free software; you can redistribute it and/or
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynmodify it under the terms of the GNU Lesser General Public
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynLicense as published by the Free Software Foundation; either
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynversion 2.1 of the License, or (at your option) any later version.
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynThis library is distributed in the hope that it will be useful,
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynbut WITHOUT ANY WARRANTY; without even the implied warranty of
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynLesser General Public License for more details.
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynYou should have received a copy of the GNU Lesser General Public
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynLicense along with this library; if not, write to the Free Software
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <refnamediv>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <refpurpose>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn Snapshot an existing container.
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </refpurpose>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </refnamediv>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <refsynopsisdiv>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <cmdsynopsis>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <arg choice="opt">-c, --comment <replaceable>file</replaceable></arg>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </cmdsynopsis>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <cmdsynopsis>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </cmdsynopsis>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <cmdsynopsis>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <arg choice="req">-r, -restore <replaceable>snapshot-name</replaceable></arg>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <arg choice="opt"> <replaceable> newname</replaceable></arg>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </cmdsynopsis>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </refsynopsisdiv>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <command>lxc-snapshot</command> creates, lists, and restores
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn container snapshots.
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn Snapshots are stored as snapshotted containers under a private configuration path. For instance, if the container's configuration path is <filename>/var/lib/lxc</filename> and the container is <filename>c1</filename>, then the first snapshot will be stored as container <filename>snap0</filename> under configuration path <filename>/var/lib/lxcsnaps/c1</filename>.
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <variablelist>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <term> <option>-c,--comment <replaceable>comment_file</replaceable></option> </term>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <para> Associate the comment in <replaceable>comment_file</replaceable> with the newly created snapshot.</para>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <term> <option>-C,--showcomments </option> </term>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <para> Show snapshot comments in the snapshots listings. </para>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <term> <option>-r,--restore snapshot-name</option> </term>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <para> Restore the named snapshot, meaning a full new container is created which is a copy of the snapshot.</para>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <para> When restoring a snapshot, the last optional argument is the name to use for the restored container. If no name is given, then the original container will be destroyed and the restored container will take its place. Note that deleting the original snapshot is not possible in the case of overlayfs or zfs backed snapshots.</para>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </varlistentry>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn </variablelist>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn &commonoptions;
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn <para>Serge Hallyn <email>serge.hallyn@ubuntu.com </email></para>
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallyn<!-- Keep this comment at the end of the file
813a4837659d5d7a2c0d0abe03c87196747217e9Serge HallynLocal variables:
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-omittag:t
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-shorttag:t
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-minimize-attributes:nil
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-always-quote-attributes:t
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-indent-step:2
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-indent-data:t
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-parent-document:nil
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-default-dtd-file:nil
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-exposed-tags:nil
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-local-catalogs:nil
813a4837659d5d7a2c0d0abe03c87196747217e9Serge Hallynsgml-local-ecat-files:nil