3 lxc: linux Container library
5 (C) Copyright Canonical Ltd. 2013
8 Serge Hallyn <serge.hallyn@ubuntu.com>
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.
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.
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
26 <!DOCTYPE refentry PUBLIC @docdtd@ [
28 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
34 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
37 <refentrytitle>lxc-user-nic</refentrytitle>
38 <manvolnum>1</manvolnum>
42 <refname>lxc-user-nic</refname>
45 Create and attach a nic to another network namespace.
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>
60 <title>Description</title>
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.
67 It will consult the configuration file <filename>@LXC_USERNIC_CONF@</filename>
68 to determine 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
80 <title>Options</title>
86 <option><replaceable>pid</replaceable></option>
90 The process id for the task to whose network namespace the interface
98 <option><replaceable>type</replaceable></option>
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
113 <option><replaceable>bridge</replaceable></option>
117 The bridge to which to attach the network interface, for
118 instance <filename>lxcbr0</filename>.
125 <option><replaceable>nicname</replaceable></option>
129 The desired interface name in the container. This will be
130 <filename>eth0</filename> if unspecified.
142 <title>See Also</title>
146 <refentrytitle><command>lxc</command></refentrytitle>
147 <manvolnum>1</manvolnum>
151 <refentrytitle><command>lxc-start</command></refentrytitle>
152 <manvolnum>1</manvolnum>
156 <refentrytitle><command>lxc-usernet.conf</command></refentrytitle>
157 <manvolnum>5</manvolnum>
163 <title>Author</title>
164 <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
169 <!-- Keep this comment at the end of the file
174 sgml-minimize-attributes:nil
175 sgml-always-quote-attributes:t
178 sgml-parent-document:nil
179 sgml-default-dtd-file:nil
180 sgml-exposed-tags:nil
181 sgml-local-catalogs:nil
182 sgml-local-ecat-files:nil