lxc-start-ephemeral.sgml.in revision 8900b9eb2514c07047541833286428572493a9fd
1516N/A
941N/A<!--
941N/A
941N/A(C) Copyright Canonical Ltd. 2013
941N/A
941N/AAuthors:
941N/AStéphane Graber <stgraber@ubuntu.com>
941N/A
941N/AThis library is free software; you can redistribute it and/or
941N/Amodify it under the terms of the GNU Lesser General Public
941N/ALicense as published by the Free Software Foundation; either
941N/Aversion 2.1 of the License, or (at your option) any later version.
941N/A
941N/AThis library is distributed in the hope that it will be useful,
941N/Abut WITHOUT ANY WARRANTY; without even the implied warranty of
941N/AMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
941N/ALesser General Public License for more details.
941N/A
941N/AYou should have received a copy of the GNU Lesser General Public
941N/ALicense along with this library; if not, write to the Free Software
941N/AFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
941N/A
3315N/A-->
941N/A
3339N/A<!DOCTYPE refentry PUBLIC @docdtd@ [
941N/A
941N/A<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
1715N/A]>
941N/A
1230N/A<refentry>
941N/A
941N/A <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
1230N/A
941N/A <refmeta>
1230N/A <refentrytitle>lxc-start-ephemeral</refentrytitle>
3234N/A <manvolnum>1</manvolnum>
3234N/A </refmeta>
941N/A
941N/A <refnamediv>
941N/A <refname>lxc-start-ephemeral</refname>
941N/A
941N/A <refpurpose>
1286N/A start an ephemeral copy of an existing container
941N/A </refpurpose>
941N/A </refnamediv>
3339N/A
941N/A <refsynopsisdiv>
941N/A <cmdsynopsis>
1715N/A <command>lxc-start-ephemeral</command>
3315N/A <arg choice="opt">-o</arg>
3315N/A <arg choice="opt">-n</arg>
941N/A <arg choice="opt">-d</arg>
941N/A <arg choice="opt">--bdir</arg>
941N/A <arg choice="opt">--user</arg>
941N/A <arg choice="opt">--key</arg>
941N/A <arg choice="opt">--union-type</arg>
3177N/A <arg choice="opt">--keep-data</arg>
1715N/A <arg choice="opt">COMMAND</arg>
2453N/A </cmdsynopsis>
941N/A </refsynopsisdiv>
941N/A
1682N/A <refsect1>
941N/A <title>Description</title>
941N/A <para>
1682N/A <command>lxc-start-ephemeral</command> start an ephemeral copy of an
941N/A existing container.
2291N/A </para>
941N/A </refsect1>
941N/A
941N/A <refsect1>
941N/A <title>Options</title>
941N/A <variablelist>
1715N/A <varlistentry>
941N/A <term>
941N/A <option>-o</option>
1843N/A </term>
1843N/A <listitem>
1843N/A <para>
1843N/A Original container name
1843N/A </para>
1843N/A </listitem>
1843N/A </varlistentry>
1843N/A
1843N/A <varlistentry>
1843N/A <term>
941N/A <option><optional>-n</optional></option>
941N/A </term>
1715N/A <listitem>
941N/A <para>
941N/A Name of the ephemeral container (defaults to a random suffix).
941N/A </para>
941N/A </listitem>
1127N/A </varlistentry>
941N/A
941N/A <varlistentry>
941N/A <term>
941N/A <option><optional>-d</optional></option>
1715N/A </term>
941N/A <listitem>
941N/A <para>
941N/A Start the container in background and print the name and IP.
941N/A This option can't be used if a command is passed.
941N/A </para>
1115N/A </listitem>
941N/A </varlistentry>
941N/A
941N/A <varlistentry>
941N/A <term>
1115N/A <option><optional>--bdir</optional></option>
941N/A </term>
941N/A <listitem>
941N/A <para>
941N/A Directory to bind mount into container.
941N/A Can be passed multiple times.
941N/A </para>
941N/A </listitem>
941N/A </varlistentry>
941N/A
941N/A <varlistentry>
941N/A <term>
941N/A <option><optional>--user</optional></option>
941N/A </term>
941N/A <listitem>
941N/A <para>
941N/A The user to connect to the container as.
941N/A Used when passing a command to lxc-start-ephemeral.
1127N/A </para>
1127N/A </listitem>
1127N/A </varlistentry>
1127N/A
1127N/A <varlistentry>
1127N/A <term>
1127N/A <option><optional>--key</optional></option>
1127N/A </term>
1431N/A <listitem>
1127N/A <para>
1127N/A Copy the provided SSH public key into the container.
1127N/A </para>
1127N/A </listitem>
1127N/A </varlistentry>
1127N/A
1127N/A <varlistentry>
1728N/A <term>
1728N/A <option><optional>--union-type</optional></option>
1728N/A </term>
1728N/A <listitem>
1661N/A <para>
1661N/A Force a specific union file system.
1661N/A Can be one of: overlayfs aufs
1661N/A </para>
1661N/A </listitem>
1661N/A </varlistentry>
1661N/A
1661N/A <varlistentry>
1661N/A <term>
1661N/A <option><optional>--keep-data</optional></option>
2185N/A </term>
2185N/A <listitem>
2185N/A <para>
2185N/A Use a persistent backend instead of tmpfs.
2185N/A With this option, you can lxc-stop and lxc-start the no longer so
2185N/A ephemeral container (it's still an overlay, but a persistent one).
1682N/A </para>
1682N/A </listitem>
2453N/A </varlistentry>
1431N/A
1431N/A <varlistentry>
1431N/A <term>
1431N/A <option><optional>COMMAND</optional></option>
1431N/A </term>
1431N/A <listitem>
1431N/A <para>
941N/A Immediately run the provided command in the container.
3460N/A This currently uses ssh (not attach) and is incompatible
941N/A with daemon mode.
941N/A </para>
1360N/A </listitem>
3460N/A </varlistentry>
1360N/A </variablelist>
1360N/A </refsect1>
941N/A
941N/A <refsect1>
941N/A <title>See Also</title>
941N/A
941N/A <simpara>
3177N/A <citerefentry>
941N/A <refentrytitle>lxc-start</refentrytitle>
941N/A <manvolnum>1</manvolnum>
941N/A </citerefentry>,
1682N/A </simpara>
941N/A
941N/A <title>Examples</title>
1127N/A <variablelist>
1682N/A <varlistentry>
1127N/A <term>lxc-start-ephemeral -o p1</term>
1127N/A <listitem>
1127N/A <para>
941N/A Simply start an ephemeral container and attach to the console.
1682N/A This container will be based on existing container "p1".
1682N/A </para>
941N/A </listitem>
941N/A </varlistentry>
2453N/A
2453N/A <varlistentry>
2453N/A <term>lxc-start-ephemeral -o p1 -n p1-ephemeral -d</term>
2453N/A <listitem>
2453N/A <para>
2453N/A Start an ephemeral container based on p1 called p1-ephemeral and
2453N/A print its IP and name to the console instead of attaching.
2453N/A </para>
2453N/A </listitem>
2453N/A </varlistentry>
2453N/A </variablelist>
2453N/A </refsect1>
2453N/A
2453N/A &seealso;
2453N/A
2453N/A <refsect1>
2453N/A <title>Author</title>
2453N/A <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
941N/A </refsect1>
941N/A</refentry>
941N/A
941N/A<!-- Keep this comment at the end of the file
1127N/ALocal variables:
1127N/Amode: sgml
1127N/Asgml-omittag:t
1127N/Asgml-shorttag:t
941N/Asgml-minimize-attributes:nil
1682N/Asgml-always-quote-attributes:t
1127N/Asgml-indent-step:2
1127N/Asgml-indent-data:t
941N/Asgml-parent-document:nil
1431N/Asgml-default-dtd-file:nil
2453N/Asgml-exposed-tags:nil
2453N/Asgml-local-catalogs:nil
941N/Asgml-local-ecat-files:nil
941N/AEnd:
941N/A-->
1431N/A