]>
Commit | Line | Data |
---|---|---|
df3415e0 SH |
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 seealso SYSTEM "@builddir@/see_also.sgml"> | |
29 | ]> | |
30 | ||
31 | <refentry> | |
32 | ||
33 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
34 | ||
35 | <refmeta> | |
36 | <refentrytitle>lxc-usernet</refentrytitle> | |
37 | <manvolnum>5</manvolnum> | |
38 | </refmeta> | |
39 | ||
40 | <refnamediv> | |
41 | <refname>lxc-usernet</refname> | |
42 | ||
43 | <refpurpose> | |
44 | unprivileged user network administration file. | |
45 | </refpurpose> | |
46 | </refnamediv> | |
47 | ||
48 | <refsect1> | |
49 | <title>Description</title> | |
50 | ||
51 | <para> | |
52 | <filename>@LXC_USERNIC_CONF@</filename> controls the limits which the | |
53 | program <command>lxc-user-nic</command> places on network interfaces | |
54 | which an unprivileged user may create. | |
55 | </para> | |
56 | ||
57 | <refsect2> | |
58 | <title>Configuration</title> | |
59 | <para> | |
60 | This file consists of multiple entries, one per line, of the form: | |
61 | </para> | |
62 | ||
63 | <para> | |
64 | <command>user</command> <command>type</command> <command>bridge</command> <command>number</command> | |
65 | </para> | |
1940bff4 HK |
66 | <para>or</para> |
67 | <para> | |
68 | <command>@group</command> <command>type</command> <command>bridge</command> <command>number</command> | |
69 | </para> | |
df3415e0 SH |
70 | <para> |
71 | Where | |
72 | </para> | |
73 | ||
74 | <variablelist> | |
75 | ||
76 | <varlistentry> | |
77 | <term> | |
78 | <option>user</option> | |
79 | </term> | |
80 | <listitem> | |
81 | <para> | |
82 | is the username to whom this entry applies. | |
83 | </para> | |
84 | </listitem> | |
85 | </varlistentry> | |
86 | ||
1940bff4 HK |
87 | <varlistentry> |
88 | <term> | |
89 | <option>@group</option> | |
90 | </term> | |
91 | <listitem> | |
92 | <para> | |
93 | is the groupname to which this entry applies. | |
94 | </para> | |
95 | </listitem> | |
96 | </varlistentry> | |
97 | ||
df3415e0 SH |
98 | <varlistentry> |
99 | <term> | |
100 | <option>type</option> | |
101 | </term> | |
102 | <listitem> | |
103 | <para> | |
104 | is the type of network interface being allowed. Only veth | |
105 | is currently supported. | |
106 | </para> | |
107 | </listitem> | |
108 | </varlistentry> | |
109 | ||
110 | <varlistentry> | |
111 | <term> | |
112 | <option>bridge</option> | |
113 | </term> | |
114 | <listitem> | |
115 | <para> | |
116 | is the bridge to which the network interfaces may be attached, for | |
117 | instance <filename>lxcbr0</filename>. | |
118 | </para> | |
119 | </listitem> | |
120 | </varlistentry> | |
121 | ||
122 | <varlistentry> | |
123 | <term> | |
124 | <option>number</option> | |
125 | </term> | |
126 | <listitem> | |
127 | <para> | |
1940bff4 HK |
128 | is the number or quota of network interfaces of the given type which the |
129 | given user or group may attach to the given bridge, for instance <filename>2</filename>. | |
df3415e0 SH |
130 | </para> |
131 | </listitem> | |
132 | </varlistentry> | |
133 | </variablelist> | |
1940bff4 HK |
134 | |
135 | <para> | |
b0c80583 | 136 | Since a user can be specified both by username as well as one or |
21002b39 HK |
137 | more usergroups, it is possible that several configuration lines |
138 | enable that user to create network interfaces. In such cases, any | |
139 | interfaces create are counted towards the quotas of the user or group | |
140 | in the order in which they appear in the file. If the quota of one | |
141 | line is full, the rest will be parsed until one is found or the end of | |
1940bff4 HK |
142 | the file. |
143 | </para> | |
df3415e0 SH |
144 | </refsect2> |
145 | ||
146 | </refsect1> | |
147 | ||
148 | <refsect1> | |
149 | <title>See Also</title> | |
150 | <simpara> | |
151 | <citerefentry> | |
152 | <refentrytitle><command>lxc</command></refentrytitle> | |
153 | <manvolnum>1</manvolnum> | |
154 | </citerefentry>, | |
155 | <citerefentry> | |
156 | <refentrytitle><command>lxc-user-nic</command></refentrytitle> | |
157 | <manvolnum>1</manvolnum> | |
158 | </citerefentry> | |
159 | </simpara> | |
160 | </refsect1> | |
161 | ||
162 | <refsect1> | |
163 | <title>Author</title> | |
164 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
165 | </refsect1> | |
166 | ||
167 | </refentry> | |
168 | ||
169 | <!-- Keep this comment at the end of the file | |
170 | Local variables: | |
171 | mode: sgml | |
172 | sgml-omittag:t | |
173 | sgml-shorttag:t | |
174 | sgml-minimize-attributes:nil | |
175 | sgml-always-quote-attributes:t | |
176 | sgml-indent-step:2 | |
177 | sgml-indent-data: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 | |
183 | End: | |
184 | --> |