lxc-user-nic.sgml.in revision df3415e02282317348bbd5f9ce66d03e1c81eeec
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornbergerlxc: linux Container library
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornberger(C) Copyright Canonical Ltd. 2013
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerSerge Hallyn <serge.hallyn@ubuntu.com>
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerThis library is free software; you can redistribute it and/or
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornbergermodify it under the terms of the GNU Lesser General Public
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerLicense as published by the Free Software Foundation; either
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornbergerversion 2.1 of the License, or (at your option) any later version.
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerThis library is distributed in the hope that it will be useful,
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornbergerbut WITHOUT ANY WARRANTY; without even the implied warranty of
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerLesser General Public License for more details.
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerYou should have received a copy of the GNU Lesser General Public
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerLicense along with this library; if not, write to the Free Software
736e78aff9e67436c35d4835c24fca667f3cadf3Julian KornbergerFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornberger<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornberger<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornberger <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
736e78aff9e67436c35d4835c24fca667f3cadf3Julian Kornberger <refentrytitle>lxc-user-nic</refentrytitle>
b27c7f227c8516589a2bd127c0f74338cf56f0b2Julian Kornberger Create and attach a nic to another network namespace.
555b7fd96768daf9592e7ddbd4217d784b08e451henning mueller </refpurpose>
555b7fd96768daf9592e7ddbd4217d784b08e451henning mueller </refnamediv>
555b7fd96768daf9592e7ddbd4217d784b08e451henning mueller <refsynopsisdiv>
555b7fd96768daf9592e7ddbd4217d784b08e451henning mueller <cmdsynopsis>
7b8fe34340b2727bb31fe0be67fdf684e47c3609Tim Reddehase <arg choice="req"><replaceable>pid</replaceable></arg>
7b8fe34340b2727bb31fe0be67fdf684e47c3609Tim Reddehase <arg choice="req"><replaceable>type</replaceable></arg>
1cbb38d1d07f559b4a1c012a4833513053716007Daniel Couto Vale <arg choice="req"><replaceable>bridge</replaceable></arg>
1cbb38d1d07f559b4a1c012a4833513053716007Daniel Couto Vale <arg choice="opt"><replaceable>nicname</replaceable></arg>
c997297b21c83680cdba2953cad369b82a5b8805Tim Reddehase </cmdsynopsis>
1b2e2335372f4737c0aa19da6320f7b5fd58b500Tim Reddehase </refsynopsisdiv>
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski <command>lxc-user-nic</command> is a setuid-root program with which
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski unprivileged users may create network interfaces for use by a lxc container.
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski It will consult the configuration file <filename>@LXC_USERNIC_CONF@</filename>
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski to determine number of interfaces which the calling user is allowed to
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski create, and which bridge he may attach them to. It tracks the
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski number of interfaces each user has created using the file
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski <filename>@LXC_USERNIC_DB@</filename>. It ensures that the calling
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski user is privileged over the network namespace to which the interface
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski will be attached.
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <variablelist>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <varlistentry>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <option><replaceable>pid</replaceable></option>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski The process id for the task to whose network namespace the interface
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski should be attached.
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski </varlistentry>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <varlistentry>
5ad93833caec560945adbce7b6f1342ef731ae83henning mueller <option><replaceable>type</replaceable></option>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski The network interface type to attach. Currently only veth is
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski supported. With this type, two interfaces representing each
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski tunnel endpoint are created. One endpoint will be attached
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski to the specified bridge, while the other will be passed into
0c07cc350bdb8afe9b01b4340b33d89500a43106Till Mossakowski the container.
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski </varlistentry>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <varlistentry>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <option><replaceable>bridge</replaceable></option>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski The bridge to which to attach the network interface, for
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski </varlistentry>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <varlistentry>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski <option><replaceable>nicname</replaceable></option>
1543bf02d52779c4bc29f75de1de4d14636d0e47Till Mossakowski The desired interface name in the container. This will be