man/network-zone-bridge.8.in

   1 .TH network-zone-bridge 8 "8 Jun 2012" "@VERSION@" "network man page"
   2
   3 .SH NAME
   4 network-zone-bridge \- Network Configuration Control Program
   5
   6 .SH SYNOPSIS
   7 \fBnetwork [OPTIONS] zone create <zone> bridge ...\fR
   8 .P
   9 All options may be edited on zones which have already been set up with the \fBbridge\fR hook:
  10 .P
  11 \fBnetwork [OPTIONS] zone <zone> edit ...\fR
  12
  13 .SH DESCRIPTION
  14 The bridge hook creates an ethernet bridge which acts as an unmanaged network
  15 switch. It contains one or multiple phyisical network interfaces or virtual
  16 devices which will be connected to each other.
  17 .PP
  18 The bridge hook is the prefered hook for local area network zones which are
  19 connected to an ethernet network.
  20
  21 .SH OPTIONS
  22 The \fBbridge\fR hook offers various configuration options:
  23
  24 \fB--stp\fR = [\fBon\fR|off]
  25 .RS 4
  26 This option enables or disable the use of the \fBSpanning Tree Protocol\fR (STP).
  27 This protocol is used to avoid loops in networks by dynamically disabling packet
  28 forwarding on links.
  29 .PP
  30 It is highly recommended to leave this option enabled when you add more than
  31 one device to the zone. Read below how the behaviour of STP can be changed.
  32 .RE
  33 .PP
  34
  35 \fB--mtu\fR = 1500
  36 .RS 4
  37 Sets the default MTU of the bridge. All ports in the bridge must support this
  38 MTU.
  39 .RE
  40 .PP
  41
  42 \fB--mac\fR = ...
  43 .RS 4
  44 By this option, you may define the MAC address of the bridge. If this option
  45 is missing, a random MAC address will be generated.
  46 .RE
  47 .PP
  48
  49 Spanning Tree Protocol configuration options:
  50
  51 \fB--stp-mode\fR = [\fBrstp\fR|stp]
  52 .RS 4
  53 When STP is enabled, this option will set the operational mode which can either be:
  54 .PP
  55 * \fBSpanning Tree Protocol IEEE 802.1D\fR (stp) was introduced in 1998 by Radia
  56 Perlman.
  57 .P
  58 * \fBRapid Spanning Tree Protocol IEEE 802.1W\fR (rstp) which has much faster convergence
  59 times and was introduced in 2004. This is the default option.
  60 .RE
  61 .PP
  62
  63 \fB--stp-forward-delay\fR = 0
  64 .RS 4
  65 This sets the default time the interfaces are hold off after they have been added
  66 to a bridge. The default value is 0.
  67 .RE
  68 .PP
  69
  70 \fB--stp-hello\fR = 2
  71 .RS 4
  72 This option defines how often a hello message should be sent. The value is given in seconds
  73 and the default is 2.
  74 .RE
  75 .PP
  76
  77 \fB--stp-priority\fR = 512
  78 .RS 4
  79 The STP priority sets the ranking of this network device within the network. The bridge
  80 with the best rank (0 is best) will become the root bridge.
  81 .RE
  82 .PP
  83
  84 .SH SEE ALSO
  85 network(8)
  86
  87 .SH AUTHOR
  88 Michael Tremer (michael.tremer@ipfire.org)