File: lxc-usernet.sgml.in

package info (click to toggle)
lxc 1%3A5.0.2-1%2Bdeb12u3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,416 kB
  • sloc: ansic: 68,763; sh: 4,118; python: 135; makefile: 53
file content (184 lines) | stat: -rw-r--r-- 4,567 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<!--

lxc: linux Container library

(C) Copyright Canonical Ltd. 2013

Authors:
Serge Hallyn <serge.hallyn@ubuntu.com>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [

<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>

  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

  <refmeta>
    <refentrytitle>lxc-usernet</refentrytitle>
    <manvolnum>5</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>lxc-usernet</refname>

    <refpurpose>
      unprivileged user network administration file.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>

    <para>
      <filename>@LXC_USERNIC_CONF@</filename> controls the limits which the
      program <command>lxc-user-nic</command> places on network interfaces
      which an unprivileged user may create.
    </para>

    <refsect2>
      <title>Configuration</title>
      <para>
      This file consists of multiple entries, one per line, of the form:
      </para>

      <para>
      <command>user</command> <command>type</command> <command>bridge</command> <command>number</command>
      </para>
      <para>or</para>
      <para>
      <command>@group</command> <command>type</command> <command>bridge</command> <command>number</command>
      </para>
      <para>
      Where
      </para>

      <variablelist>

	<varlistentry>
	  <term>
	    <option>user</option>
	  </term>
	  <listitem>
	    <para>
	      is the username to whom this entry applies.
	     </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>
	    <option>@group</option>
	  </term>
	  <listitem>
	    <para>
	      is the groupname to which this entry applies.
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>
	    <option>type</option>
	  </term>
	  <listitem>
	    <para>
	      is the type of network interface being allowed.  Only veth
	      is currently supported.
	     </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>
	    <option>bridge</option>
	  </term>
	  <listitem>
	    <para>
	      is the bridge to which the network interfaces may be attached, for
	      instance <filename>lxcbr0</filename>.
	     </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>
	    <option>number</option>
	  </term>
	  <listitem>
	    <para>
	      is the number or quota of network interfaces of the given type which the
	      given user or group may attach to the given bridge, for instance <filename>2</filename>.
	     </para>
	  </listitem>
	</varlistentry>
      </variablelist>

      <para>
        Since a user can be specified both by username as well as one or
        more usergroups, it is possible that several configuration lines
        enable that user to create network interfaces. In such cases, any
        interfaces create are counted towards the quotas of the user or group
        in the order in which they appear in the file. If the quota of one
        line is full, the rest will be parsed until one is found or the end of
        the file.
      </para>
    </refsect2>

  </refsect1>

  <refsect1>
    <title>See Also</title>
    <simpara>
      <citerefentry>
	<refentrytitle><command>lxc</command></refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle><command>lxc-user-nic</command></refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>
    </simpara>
  </refsect1>

  <refsect1>
    <title>Author</title>
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
  </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->