Debian Codegraph @

doc/ja/lxc-user-nic.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
6 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
7 ]>
8
9 <refentry>
10
11 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
12
13 <refmeta>
14 <refentrytitle>lxc-user-nic</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-user-nic</refname>
20
21 <refpurpose>
22 <!--
23 Manage nics in another namespace
24 -->
25 現在と異なるネットワーク名前空間の NIC を管理する
26 </refpurpose>
27 </refnamediv>
28
29 <refsynopsisdiv>
30 <cmdsynopsis>
31 <command>lxc-user-nic</command>
32 <command>create</command>
33 <arg choice="req"><replaceable>lxcpath</replaceable></arg>
34 <arg choice="req"><replaceable>name</replaceable></arg>
35 <arg choice="req"><replaceable>pid</replaceable></arg>
36 <arg choice="req"><replaceable>type</replaceable></arg>
37 <arg choice="req"><replaceable>bridge</replaceable></arg>
38 <arg choice="opt"><replaceable>container nicname</replaceable></arg>
39 </cmdsynopsis>
40
41 <cmdsynopsis>
42 <command>lxc-user-nic</command>
43 <command>delete</command>
44 <arg choice="req"><replaceable>lxcpath</replaceable></arg>
45 <arg choice="req"><replaceable>name</replaceable></arg>
46 <arg choice="req"><replaceable>path to network namespace</replaceable></arg>
47 <arg choice="req"><replaceable>type</replaceable></arg>
48 <arg choice="req"><replaceable>bridge</replaceable></arg>
49 <arg choice="req"><replaceable>container nicname</replaceable></arg>
50 </cmdsynopsis>
51 </refsynopsisdiv>
52
53 <refsect1>
54 <title><!-- Description -->説明</title>
55
56 <para>
57 <!--
58 <command>lxc-user-nic</command> is a setuid-root program with which
59 unprivileged users may create network interfaces for use by a
60 lxc container.
61 -->
62 <command>lxc-user-nic</command> は root に setuid されたプログラムで、lxc コンテナが使うネットワークインターフェースを、特権を持たないユーザが作成できます。
63 </para>
64 <para>
65 <!--
66 It will consult the configuration file <filename>@LXC_USERNIC_CONF@</filename>
67 to determine the number of interfaces which the calling user is allowed to
68 create, and which bridge they may attach them to. It tracks the
69 number of interfaces each user has created using the file
70 <filename>@LXC_USERNIC_DB@</filename>. It ensures that the calling
71 user is privileged over the network namespace to which the interface
72 will be attached.
73 <command>lxc-user-nic</command> also allows one to delete network devices.
74 Currently only ovs ports can be deleted.
75 -->
76 このプログラムは、<filename>@LXC_USERNIC_CONF@</filename> という設定ファイルを参照して、呼び出したユーザが作成することができるインターフェースの数と、どのブリッジに接続するかを決定します。
77 また、ユーザが作成したインターフェースの数を <filename>@LXC_USERNIC_DB@</filename> を使ってチェックします。
78 これにより、呼び出したユーザが、インターフェースを割り当てるネットワーク名前空間上で特権を持つことが保証されます。
79 <command>lxc-user-nic</command> はネットワークデバイスを削除することもできます。
80 現時点では ovs ポートの削除のみ可能です。
81 </para>
82
83 </refsect1>
84
85 <refsect1>
86
87 <title><!-- Options -->オプション</title>
88
89 <variablelist>
90 <varlistentry>
91 <term>
92 <option><replaceable>lxcpath</replaceable></option>
93 </term>
94 <listitem>
95 <para>
96 <!--
97 The path of the container. This is currently not used.
98 -->
99 すべてのコンテナが保存されるパス。これは現在使われていません。
100 </para>
101 </listitem>
102 </varlistentry>
103
104 <varlistentry>
105 <term>
106 <option><replaceable>name</replaceable></option>
107 </term>
108 <listitem>
109 <para>
110 <!--
111 The name of the container. This is currently not used.
112 -->
113 コンテナ名。これは現在使われていません。
114 </para>
115 </listitem>
116 </varlistentry>
117
118 <varlistentry>
119 <term>
120 <option><replaceable>pid</replaceable></option>
121 </term>
122 <listitem>
123 <para>
124 <!--
125 The process id for the task to whose network namespace the interface
126 should be attached.
127 -->
128 インターフェースを割り当てたいネットワーク名前空間を持つタスクのプロセス ID。
129 </para>
130 </listitem>
131 </varlistentry>
132
133 <varlistentry>
134 <term>
135 <option><replaceable>type</replaceable></option>
136 </term>
137 <listitem>
138 <para>
139 <!--
140 The network interface type to attach. Currently only veth is
141 supported. With this type, two interfaces representing each
142 tunnel endpoint are created. One endpoint will be attached
143 to the specified bridge, while the other will be passed into
144 the container.
145 -->
146 割り当てるネットワークインターフェースのタイプ。現時点では、veth のみサポートされます。
147 このタイプを指定すると、それぞれがトンネルのエンドポイントとなる 2 つのインターフェースが作成されます。
148 一方のエンドポイントは指定したブリッジに接続され、もう一方はコンテナに割り当てられます。
149 </para>
150 </listitem>
151 </varlistentry>
152
153 <varlistentry>
154 <term>
155 <option><replaceable>bridge</replaceable></option>
156 </term>
157 <listitem>
158 <para>
159 <!--
160 The bridge to which to attach the network interface, for
161 instance <filename>lxcbr0</filename>.
162 -->
163 ネットワークインターフェースを接続するブリッジ。
164 例えば <filename>lxcbr0</filename> のように指定します。
165 </para>
166 </listitem>
167 </varlistentry>
168
169 <varlistentry>
170 <term>
171 <option><replaceable>container nicname</replaceable></option>
172 </term>
173 <listitem>
174 <para>
175 <!--
176 The desired interface name in the container. This will be
177 <filename>eth0</filename> if unspecified.
178 -->
179 コンテナ内に作られるインターフェースの名前。
180 もし指定しない場合、<filename>eth0</filename> となります。
181 </para>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry>
186 <term>
187 <option><replaceable>path to network namespace</replaceable></option>
188 </term>
189 <listitem>
190 <para>
191 <!--
192 A path to open to get a file descriptor for the target
193 network namespace.
194 This is only relevant when an veth device is deleted.
195 -->
196 対象のネットワーク名前空間のファイルディスクリプタを取得するために open するためのパス。
197 これは veth デバイスを削除するときのみ関係します。
198 </para>
199 </listitem>
200 </varlistentry>
201
202 </variablelist>
203
204 </refsect1>
205
206 <refsect1>
207 <title>See Also</title>
208
209 <simpara>
210 <citerefentry>
211 <refentrytitle><command>lxc</command></refentrytitle>
212 <manvolnum>1</manvolnum>
213 </citerefentry>,
214
215 <citerefentry>
216 <refentrytitle><command>lxc-start</command></refentrytitle>
217 <manvolnum>1</manvolnum>
218 </citerefentry>,
219
220 <citerefentry>
221 <refentrytitle><command>lxc-usernet</command></refentrytitle>
222 <manvolnum>5</manvolnum>
223 </citerefentry>
224 </simpara>
225 </refsect1>
226 </refentry>
227
228 <!-- Keep this comment at the end of the file
229 Local variables:
230 mode: sgml
231 sgml-omittag:t
232 sgml-shorttag:t
233 sgml-minimize-attributes:nil
234 sgml-always-quote-attributes:t
235 sgml-indent-step:2
236 sgml-indent-data:t
237 sgml-parent-document:nil
238 sgml-default-dtd-file:nil
239 sgml-exposed-tags:nil
240 sgml-local-catalogs:nil
241 sgml-local-ecat-files:nil
242 End:
243 -->