<!--

(C) Copyright Canonical Ltd. 2013

Authors:

Stéphane Graber <stgraber@ubuntu.com>

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [

<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">

]>

<refentry>

<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

<refmeta>

<refentrytitle>lxc-start-ephemeral</refentrytitle>

<manvolnum>1</manvolnum>

</refmeta>

<refnamediv>

<refname>lxc-start-ephemeral</refname>

<refpurpose>

start an ephemeral copy of an existing container

</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>lxc-start-ephemeral</command>

<arg choice="opt">-o</arg>

<arg choice="opt">-n</arg>

<arg choice="opt">-d</arg>

<arg choice="opt">--bdir</arg>

<arg choice="opt">--user</arg>

<arg choice="opt">--key</arg>

<arg choice="opt">--storage-type</arg>

<arg choice="opt">--union-type</arg>

<arg choice="opt">--keep-data</arg>

<arg choice="opt">COMMAND</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>

<command>lxc-start-ephemeral</command> start an ephemeral copy of an

existing container.

</para>

</refsect1>

<refsect1>

<title>Options</title>

<variablelist>

<varlistentry>

<term>

<option>-o, --orig <replaceable>orig</replaceable></option>

</term>

<listitem>

<para>

Original container name

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-n, --name <replaceable>name</replaceable></option>

</term>

<listitem>

<para>

Name of the ephemeral container (defaults to a random suffix).

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-d, --daemon</option>

</term>

<listitem>

<para>

Start the container in background and print the name and IP.

This option can't be used if a command is passed.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-b, --bdir <replaceable>bdir</replaceable></option>

</term>

<listitem>

<para>

Directory to bind mount into container.

Can be passed multiple times.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-u, --user <replaceable>user</replaceable></option>

</term>

<listitem>

<para>

The user to connect to the container as.

Used when passing a command to lxc-start-ephemeral.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-S, --key <replaceable>key</replaceable></option>

</term>

<listitem>

<para>

Copy the provided SSH public key into the container.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-s, --storage-type <replaceable>storage type</replaceable></option>

</term>

<listitem>

<para>

Specify the type of storage used by the container. Valid types are tmpfs or dir.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-U, --union-type <replaceable>union type</replaceable></option>

</term>

<listitem>

<para>

Force a specific union file system.

Can be one of: overlayfs aufs

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-k, --keep-data</option>

</term>

<listitem>

<para>

Use a persistent backend instead of tmpfs.

With this option, you can lxc-stop and lxc-start the no longer so

ephemeral container (it's still an overlay, but a persistent one).

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>COMMAND</option>

</term>

<listitem>

<para>

Immediately run the provided command in the container.

This uses attach if the kernel supports it, otherwise uses ssh.

This is incompatible with daemon mode.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>See Also</title>

<simpara>

<citerefentry>

<refentrytitle>lxc-start</refentrytitle>

<manvolnum>1</manvolnum>

</citerefentry>,

</simpara>

</refsect1>

<refsect1>

<title>Examples</title>

<variablelist>

<varlistentry>

<term>lxc-start-ephemeral -o p1</term>

<listitem>

<para>

Simply start an ephemeral container and attach to the console.

This container will be based on existing container "p1".

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>lxc-start-ephemeral -o p1 -n p1-ephemeral -d</term>

<listitem>

<para>

Start an ephemeral container based on p1 called p1-ephemeral and

print its IP and name to the console instead of attaching.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>Notes</title>

<para>

<command>lxc-start-ephemeral</command> is deprecated in favor of

<command>lxc-copy</command>.

</para>

</refsect1>

&seealso;

<refsect1>

<title>Author</title>

<para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:2

sgml-indent-data:t

sgml-parent-document:nil

sgml-default-dtd-file:nil

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

-->