Debian Codegraph @

doc/lxc-usernet.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
6 ]>
7
8 <refentry>
9
10 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
11
12 <refmeta>
13 <refentrytitle>lxc-usernet</refentrytitle>
14 <manvolnum>5</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>lxc-usernet</refname>
19
20 <refpurpose>
21 unprivileged user network administration file.
22 </refpurpose>
23 </refnamediv>
24
25 <refsect1>
26 <title>Description</title>
27
28 <para>
29 <filename>@LXC_USERNIC_CONF@</filename> controls the limits which the
30 program <command>lxc-user-nic</command> places on network interfaces
31 which an unprivileged user may create.
32 </para>
33
34 <refsect2>
35 <title>Configuration</title>
36 <para>
37 This file consists of multiple entries, one per line, of the form:
38 </para>
39
40 <para>
41 <command>user</command> <command>type</command> <command>bridge</command> <command>number</command>
42 </para>
43 <para>or</para>
44 <para>
45 <command>@group</command> <command>type</command> <command>bridge</command> <command>number</command>
46 </para>
47 <para>
48 Where
49 </para>
50
51 <variablelist>
52
53 <varlistentry>
54 <term>
55 <option>user</option>
56 </term>
57 <listitem>
58 <para>
59 is the username to whom this entry applies.
60 </para>
61 </listitem>
62 </varlistentry>
63
64 <varlistentry>
65 <term>
66 <option>@group</option>
67 </term>
68 <listitem>
69 <para>
70 is the groupname to which this entry applies.
71 </para>
72 </listitem>
73 </varlistentry>
74
75 <varlistentry>
76 <term>
77 <option>type</option>
78 </term>
79 <listitem>
80 <para>
81 is the type of network interface being allowed. Only veth
82 is currently supported.
83 </para>
84 </listitem>
85 </varlistentry>
86
87 <varlistentry>
88 <term>
89 <option>bridge</option>
90 </term>
91 <listitem>
92 <para>
93 is the bridge to which the network interfaces may be attached, for
94 instance <filename>lxcbr0</filename>.
95 </para>
96 </listitem>
97 </varlistentry>
98
99 <varlistentry>
100 <term>
101 <option>number</option>
102 </term>
103 <listitem>
104 <para>
105 is the number or quota of network interfaces of the given type which the
106 given user or group may attach to the given bridge, for instance <filename>2</filename>.
107 </para>
108 </listitem>
109 </varlistentry>
110 </variablelist>
111
112 <para>
113 Since a user can be specified both by username as well as one or
114 more usergroups, it is possible that several configuration lines
115 enable that user to create network interfaces. In such cases, any
116 interfaces create are counted towards the quotas of the user or group
117 in the order in which they appear in the file. If the quota of one
118 line is full, the rest will be parsed until one is found or the end of
119 the file.
120 </para>
121 </refsect2>
122
123 </refsect1>
124
125 <refsect1>
126 <title>See Also</title>
127 <simpara>
128 <citerefentry>
129 <refentrytitle><command>lxc</command></refentrytitle>
130 <manvolnum>1</manvolnum>
131 </citerefentry>,
132 <citerefentry>
133 <refentrytitle><command>lxc-user-nic</command></refentrytitle>
134 <manvolnum>1</manvolnum>
135 </citerefentry>
136 </simpara>
137 </refsect1>
138
139 </refentry>
140
141 <!-- Keep this comment at the end of the file
142 Local variables:
143 mode: sgml
144 sgml-omittag:t
145 sgml-shorttag:t
146 sgml-minimize-attributes:nil
147 sgml-always-quote-attributes:t
148 sgml-indent-step:2
149 sgml-indent-data:t
150 sgml-parent-document:nil
151 sgml-default-dtd-file:nil
152 sgml-exposed-tags:nil
153 sgml-local-catalogs:nil
154 sgml-local-ecat-files:nil
155 End:
156 -->