]> git.ipfire.org Git - people/ms/network.git/blame - man/network-zone-bridge.txt
man: Convert network-zone-bridge(8) to asciidoc
[people/ms/network.git] / man / network-zone-bridge.txt
CommitLineData
010f24cf
MT
1= network-zone-bridge(8)
2Michael Tremer <michael.tremer@ipfire.org>
3
4== NAME
5network-zone-bridge - Manage network zones
6
7== SYNOPSIS
8[verse]
9'network zone new ZONE bridge' ...
10'network zone ZONE edit' ...
11
12== DESCRIPTION
13The bridge hook creates an ethernet bridge which acts as an unmanaged network
14switch. It contains one or multiple physical network interfaces or virtual
15devices which will be connected to each other.
16
17The bridge hook is the preferred hook for local area network zones which are
18connected to an ethernet network.
19
20== OPTIONS
21The following options are understood:
22
23'--address=ADDRESS'::
24 By this option, you may define the MAC address of the bridge. If this option
25 is missing, a random MAC address will be generated.
26
27'--mtu=MTU'::
28 Sets the default MTU of the bridge.
29 All ports in the bridge must support this MTU value.
30
31'--stp=[_on_|off]'::
32 This option enables or disables use of the _Spanning Tree Protocol_ (STP).
33 This protocol is used to avoid loops in networks by dynamically disabling
34 packet forwarding on links.
35 +
36 It is highly recommended to leave this option enabled when you add more
37 than one device to the zone. Read below how the behaviour of STP can be changed.
38
39Spanning Tree Protocol (802.1D) configuration options:
40
41'--stp-forward-delay=_0_'::
42 This sets the default time the interfaces are hold off after they have been
43 added to a bridge. The default value is 0.
44
45'--stp-hello=_2_'::
46 This option defines how often a hello message should be sent. The value is
47 given in seconds and the default is 2.
48
49'--stp-priority=512'::
50 The STP priority sets the ranking of this network device within the network.
51 The bridge with the best rank (0 is best) will become the root bridge.
52
53== SEE ALSO
54link:network[8],
55link:network-zone[8]