doc/lxc-user-nic.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright Canonical Ltd. 2013
   6
   7 Authors:
   8 Serge Hallyn <serge.hallyn@ubuntu.com>
   9
  10 This library is free software; you can redistribute it and/or
  11 modify it under the terms of the GNU Lesser General Public
  12 License as published by the Free Software Foundation; either
  13 version 2.1 of the License, or (at your option) any later version.
  14
  15 This library is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with this library; if not, write to the Free Software
  22 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC @docdtd@ [
  27
  28 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  30 ]>
  31
  32 <refentry>
  33
  34   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  35
  36   <refmeta>
  37     <refentrytitle>lxc-user-nic</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-user-nic</refname>
  43
  44     <refpurpose>
  45       Create and attach a nic to another network namespace.
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-user-nic</command>
  52       <arg choice="req"><replaceable>pid</replaceable></arg>
  53       <arg choice="req"><replaceable>type</replaceable></arg>
  54       <arg choice="req"><replaceable>bridge</replaceable></arg>
  55       <arg choice="opt"><replaceable>nicname</replaceable></arg>
  56     </cmdsynopsis>
  57   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61
  62     <para>
  63       <command>lxc-user-nic</command> is a setuid-root program with which
  64       unprivileged users may create network interfaces for use by a lxc container.
  65     </para>
  66     <para>
  67       It will consult the configuration file <filename>@LXC_USERNIC_CONF@</filename>
  68       to determine the number of interfaces which the calling user is allowed to
  69       create, and which bridge he may attach them to.  It tracks the
  70       number of interfaces each user has created using the file
  71       <filename>@LXC_USERNIC_DB@</filename>.  It ensures that the calling
  72       user is privileged over the network namespace to which the interface
  73       will be attached.
  74     </para>
  75
  76   </refsect1>
  77
  78   <refsect1>
  79
  80     <title>Options</title>
  81
  82     <variablelist>
  83
  84       <varlistentry>
  85         <term>
  86           <option><replaceable>pid</replaceable></option>
  87         </term>
  88         <listitem>
  89           <para>
  90           The process id for the task to whose network namespace the interface
  91           should be attached.
  92           </para>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term>
  98           <option><replaceable>type</replaceable></option>
  99         </term>
 100         <listitem>
 101           <para>
 102           The network interface type to attach.  Currently only veth is
 103           supported.  With this type, two interfaces representing each
 104           tunnel endpoint are created.  One endpoint will be attached
 105           to the specified bridge, while the other will be passed into
 106           the container.
 107           </para>
 108         </listitem>
 109       </varlistentry>
 110
 111       <varlistentry>
 112         <term>
 113           <option><replaceable>bridge</replaceable></option>
 114         </term>
 115         <listitem>
 116           <para>
 117           The bridge to which to attach the network interface, for
 118           instance <filename>lxcbr0</filename>.
 119           </para>
 120         </listitem>
 121       </varlistentry>
 122
 123       <varlistentry>
 124         <term>
 125           <option><replaceable>nicname</replaceable></option>
 126         </term>
 127         <listitem>
 128           <para>
 129           The desired interface name in the container.  This will be
 130           <filename>eth0</filename> if unspecified.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134
 135     </variablelist>
 136
 137   </refsect1>
 138
 139   <refsect1>
 140     <title>See Also</title>
 141
 142     <simpara>
 143       <citerefentry>
 144         <refentrytitle><command>lxc</command></refentrytitle>
 145         <manvolnum>1</manvolnum>
 146       </citerefentry>,
 147
 148       <citerefentry>
 149         <refentrytitle><command>lxc-start</command></refentrytitle>
 150         <manvolnum>1</manvolnum>
 151       </citerefentry>,
 152
 153       <citerefentry>
 154         <refentrytitle><command>lxc-usernet</command></refentrytitle>
 155         <manvolnum>5</manvolnum>
 156       </citerefentry>
 157     </simpara>
 158    </refsect1>
 159
 160   <refsect1>
 161     <title>Author</title>
 162     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 163   </refsect1>
 164
 165 </refentry>
 166
 167 <!-- Keep this comment at the end of the file
 168 Local variables:
 169 mode: sgml
 170 sgml-omittag:t
 171 sgml-shorttag:t
 172 sgml-minimize-attributes:nil
 173 sgml-always-quote-attributes:t
 174 sgml-indent-step:2
 175 sgml-indent-data:t
 176 sgml-parent-document:nil
 177 sgml-default-dtd-file:nil
 178 sgml-exposed-tags:nil
 179 sgml-local-catalogs:nil
 180 sgml-local-ecat-files:nil
 181 End:
 182 -->