]>
Commit | Line | Data |
---|---|---|
a2a6f759 MT |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-zone-bridge"> | |
6 | <refentryinfo> | |
7 | <title>network-zone-bridge</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Michael</firstname> | |
14 | <surname>Tremer</surname> | |
15 | <email>michael.tremer@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-zone-bridge</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone-bridge</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>network zone create <replaceable>ZONE</replaceable> bridge ...</command> | |
33 | </cmdsynopsis> | |
34 | ||
35 | <cmdsynopsis> | |
36 | <command>network zone <replaceable>ZONE</replaceable> edit ...</command> | |
37 | </cmdsynopsis> | |
38 | </refsynopsisdiv> | |
39 | ||
40 | <refsect1> | |
41 | <title>Description</title> | |
42 | ||
43 | <para> | |
44 | The bridge hook creates an ethernet bridge which acts as an unmanaged network | |
45 | switch. It contains one or multiple phyisical network interfaces or virtual | |
46 | devices which will be connected to each other. | |
47 | </para> | |
48 | <para> | |
49 | The bridge hook is the prefered hook for local area network zones which are | |
50 | connected to an ethernet network. | |
51 | </para> | |
52 | </refsect1> | |
53 | ||
54 | <refsect1> | |
55 | <title>Options</title> | |
56 | ||
57 | <para> | |
58 | The following options are understood: | |
59 | </para> | |
60 | ||
61 | <variablelist> | |
62 | <varlistentry> | |
63 | <term> | |
64 | <option>--stp=[<emphasis>on</emphasis>|off]</option> | |
65 | </term> | |
66 | ||
67 | <listitem> | |
68 | <para> | |
69 | This option enables or disable the use of the | |
70 | <emphasis>Spanning Tree Protocol</emphasis> (STP). | |
71 | This protocol is used to avoid loops in networks by | |
72 | dynamically disabling packet forwarding on links. | |
73 | </para> | |
74 | <para> | |
75 | It is highly recommended to leave this option enabled | |
76 | when you add more than one device to the zone. | |
77 | Read below how the behaviour of STP can be changed. | |
78 | </para> | |
79 | </listitem> | |
80 | </varlistentry> | |
81 | ||
82 | <varlistentry> | |
83 | <term> | |
84 | <option>--mtu=<replaceable>MTU</replaceable></option> | |
85 | </term> | |
86 | ||
87 | <listitem> | |
88 | <para> | |
89 | Sets the default MTU of the bridge. | |
90 | All ports in the bridge must support this MTU value. | |
91 | </para> | |
92 | </listitem> | |
93 | </varlistentry> | |
94 | ||
95 | <varlistentry> | |
96 | <term> | |
97 | <option>--address=<replaceable>ADDRESS</replaceable></option> | |
98 | </term> | |
99 | ||
100 | <listitem> | |
101 | <para> | |
102 | By this option, you may define the MAC address of the | |
103 | bridge. If this option is missing, a random MAC address | |
104 | will be generated. | |
105 | </para> | |
106 | </listitem> | |
107 | </varlistentry> | |
108 | </variablelist> | |
109 | ||
110 | <para> | |
111 | Spanning Tree Protocol configuration options: | |
112 | </para> | |
113 | ||
114 | <variablelist> | |
115 | <varlistentry> | |
116 | <term> | |
117 | <option>--stp-mode=[<emphasis>rstp</emphasis>|stp]</option> | |
118 | </term> | |
119 | ||
120 | <listitem> | |
121 | <para> | |
122 | When STP is enabled, this option will set the operational | |
123 | mode which can either be: | |
124 | </para> | |
125 | <itemizedlist> | |
126 | <listitem> | |
127 | <para> | |
128 | <emphasis>Spanning Tree Protocol IEEE 802.1D</emphasis> | |
129 | (stp) was introduced in 1998 by Radia Perlman. | |
130 | </para> | |
131 | </listitem> | |
132 | <listitem> | |
133 | <para> | |
134 | <emphasis>Rapid Spanning Tree Protocol IEEE 802.1W</emphasis> | |
135 | (rstp) which has much faster convergence times and was | |
136 | introduced in 2004. This is the default option. | |
137 | </para> | |
138 | </listitem> | |
139 | </itemizedlist> | |
140 | </listitem> | |
141 | </varlistentry> | |
142 | ||
143 | <varlistentry> | |
144 | <term> | |
145 | <option>--stp-forward-delay=<replaceable>0</replaceable></option> | |
146 | </term> | |
147 | ||
148 | <listitem> | |
149 | <para> | |
150 | This sets the default time the interfaces are hold off | |
151 | after they have been added to a bridge. | |
152 | The default value is 0. | |
153 | </para> | |
154 | </listitem> | |
155 | </varlistentry> | |
156 | ||
157 | <varlistentry> | |
158 | <term> | |
159 | <option>--stp-hello=<replaceable>2</replaceable></option> | |
160 | </term> | |
161 | ||
162 | <listitem> | |
163 | <para> | |
164 | This option defines how often a hello message should be | |
165 | sent. The value is given in seconds and the default is 2. | |
166 | </para> | |
167 | </listitem> | |
168 | </varlistentry> | |
169 | ||
170 | <varlistentry> | |
171 | <term> | |
172 | <option>--stp-priority=<replaceable>512</replaceable></option> | |
173 | </term> | |
174 | ||
175 | <listitem> | |
176 | <para> | |
177 | The STP priority sets the ranking of this network device | |
178 | within the network. The bridge with the best rank | |
179 | (0 is best) will become the root bridge. | |
180 | </para> | |
181 | </listitem> | |
182 | </varlistentry> | |
183 | </variablelist> | |
184 | </refsect1> | |
185 | ||
186 | <refsect1> | |
187 | <title>See Also</title> | |
188 | ||
189 | <para> | |
190 | <citerefentry> | |
191 | <refentrytitle>network</refentrytitle> | |
192 | <manvolnum>8</manvolnum> | |
193 | </citerefentry>, | |
194 | <citerefentry> | |
195 | <refentrytitle>network-zone</refentrytitle> | |
196 | <manvolnum>8</manvolnum> | |
197 | </citerefentry> | |
198 | </para> | |
199 | </refsect1> | |
200 | </refentry> |