<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">

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

]>

<refentry>

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

<refmeta>

<refentrytitle>lxc-create</refentrytitle>

<manvolnum>1</manvolnum>

</refmeta>

<refnamediv>

<refname>lxc-create</refname>

<refpurpose>

creates a container

</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>lxc-create</command>

<arg choice="req">-n <replaceable>name</replaceable></arg>

<arg choice="opt">-f <replaceable>config_file</replaceable></arg>

<arg choice="opt">-t <replaceable>template</replaceable></arg>

<arg choice="opt">-B <replaceable>backingstore</replaceable></arg>

<arg choice="opt">-- <replaceable>template-options</replaceable></arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>

<command>lxc-create</command> creates a system object where is

stored the configuration informations and where can be stored

user information. The identifier <replaceable>name</replaceable>

is used to specify the container to be used with the different

lxc commands.

</para>

<para>

The object is a directory created in <filename>@LXCPATH@</filename>

and identified by its name.

</para>

<para>

The object is the definition of the different resources an

application can use or can see. The more the configuration file

contains informations, the more the container is isolated and

the more the application is jailed.

</para>

<para>

If the configuration file <replaceable>config_file</replaceable>

is not specified, the container will be created with the default

isolation: processes, sysv ipc and mount points.

</para>

</refsect1>

<refsect1>

<title>Options</title>

<variablelist>

<varlistentry>

<term>

<option>-f <replaceable>config_file</replaceable></option>

</term>

<listitem>

<para>

Specify the configuration file to configure the virtualization

and isolation functionalities for the container.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-t <replaceable>template</replaceable></option>

</term>

<listitem>

<para>

'template' is the short name of an existing 'lxc-template'

script that is called by lxc-create,

eg. busybox, debian, fedora, ubuntu or sshd.

Refer to the examples in <filename>@LXCTEMPLATEDIR@</filename>

for details of the expected script structure.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-B <replaceable>backingstore</replaceable></option>

</term>

<listitem>

<para>

'backingstore' is one of 'none', 'dir', 'lvm', or 'btrfs'. The

default is 'none', meaning that the container root filesystem

will be a directory under <filename>@LXCPATH@/container/rootfs</filename>.

'dir' has the same meaning as 'none', but also allows the optional

<replaceable>--dir ROOTFS</replaceable> to be specified, meaning

that the container rootfs should be placed under the specified path,

rather than the default.

The option 'btrfs' need not be specified as it will be used

automatically if the <filename>@LXCPATH@</filename> filesystem is found to

be btrfs. If backingstore is 'lvm', then an lvm block device will be

used and the following further options are available:

<replaceable>--lvname lvname1</replaceable> will create an LV

named <filename>lvname1</filename> rather than the default, which

is the container name. <replaceable>--vgname vgname1</replaceable>

will create the LV in volume group <filename>vgname1</filename>

rather than the default, <filename>lxc</filename>.

<replaceable>--fstype FSTYPE</replaceable> will create an FSTYPE

filesystem on the LV, rather than the default, which is ext4.

<replaceable>--fssize SIZE</replaceable> will create a LV (and

filesystem) of size SIZE rather than the default, which is 1G.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>-- <replaceable>template-options</replaceable></option>

</term>

<listitem>

<para>

This will pass <replaceable>template-options</replaceable> to the

template as arguments. To see the list of options supported by

the template, you can run

<command>lxc-create -t TEMPLATE -h</command>.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>Diagnostic</title>

<variablelist>

<varlistentry>

<term>The container already exists</term>

<listitem>

<para>

As the message mention it, you try to create a container

but there is a container with the same name. You can use

the <command>lxc-ls -l</command> command to list the

available containers on the system.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

&seealso;

<refsect1>

<title>Author</title>

<para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>

</refsect1>

</refentry>