Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 12 Sep 2007 13:53:06 +0200
From:      "Murray Stokely" <murray.stokely@gmail.com>
To:        "Andrew Thompson" <thompsa@freebsd.org>
Cc:        doc@freebsd.org
Subject:   Re: New link aggregation chapter
Message-ID:  <474078f80709120453k2522bc64mdef8477b3bb3ece8@mail.gmail.com>
In-Reply-To: <20070830202437.GA4797@heff.fud.org.nz>
References:  <20070830202437.GA4797@heff.fud.org.nz>

next in thread | previous in thread | raw e-mail | index | archive | help
Hi Andrew, your DocBook looks nice.  I just made a few minor changes.
The individual <sect3>s in the Operating Modes section (sect2) were
pretty minor and in some cases with just a few words underneath a
numbered section, so I thought it looked better as a <variablelist>
with individual <varlistentry>s for each sect3 you had defined there.
Similarly, in the next <sect2> for examples I used <example> tags so
we can reference these specific examples elsewhere in the text.

Also I made a few minor grammar nits.  My diff of your diff, which is
now committed, is attached for reference.

Thanks again for a very useful new section to the Handbook!

        - Murray

---


 <chapter id="advanced-networking">
@@ -2888,18 +2888,21 @@
     <sect2>
       <title>Operating Modes</title>

-      <sect3>
-       <title>failover</title>
+      <variablelist>
+
+       <varlistentry><term>failover</term>

+       <listitem>
        <para>Sends and receives traffic only through the master port. If the
          master port becomes unavailable, the next active port is used. The
          first interface added is the master port; any interfaces added after
          that are used as failover devices.</para>
-      </sect3>
+        </listitem>
+        </varlistentry>

-      <sect3>
-       <title>fec</title>
+       <varlistentry><term>fec</term>

+       <listitem>
        <para>Supports Cisco EtherChannel. This is a static setup and does not
          negotiate aggregation with the peer or exchange frames to monitor the
          link, if the switch supports LACP then that should be used
@@ -2910,11 +2913,12 @@
          active port. The hash includes the Ethernet source and destination
          address, and, if available, the VLAN tag, and the IPv4/IPv6 source
          and destination address.</para>
-      </sect3>
+        </listitem>
+       </varlistentry>

-      <sect3>
-       <title>lacp</title>
+       <varlistentry><term>lacp</term>

+       <listitem>
        <para>Supports the IEEE 802.3ad Link Aggregation Control Protocol
          (LACP) and the Marker Protocol. LACP will negotiate a set of
          aggregable links with the peer in to one or more Link Aggregated
@@ -2930,28 +2934,32 @@
          active port. The hash includes the Ethernet source and destination
          address, and, if available, the VLAN tag, and the IPv4/IPv6 source
          and destination address.</para>
-      </sect3>
+        </listitem>
+       </varlistentry>

-      <sect3>
-       <title>loadbalance</title>
+       <varlistentry><term>loadbalance</term>

+       <listitem>
        <para>This is an alias of <emphasis>fec</emphasis> mode.</para>
-      </sect3>
+        </listitem>
+        </varlistentry>

-      <sect3>
-       <title>roundrobin</title>
+       <varlistentry><term>roundrobin</term>

+       <listitem>
        <para>Distributes outgoing traffic using a round-robin scheduler
          through all active ports and accepts incoming traffic from any active
          port. This mode will violate Ethernet frame ordering and should be
          used with caution.</para>
-      </sect3>
+        </listitem>
+       </varlistentry>
+      </variablelist>
     </sect2>

     <sect2>
       <title>Examples</title>

-      <sect3>
+      <example id="networking-lacp-aggregation-cisco">
        <title>LACP aggregation with a Cisco switch</title>

        <para>This example connects two interfaces on a &os; machine to the
@@ -2965,44 +2973,39 @@

        <para>On the Cisco switch add the interfaces to the channel
group.</para>

-       <screen>
-interface FastEthernet0/1
+       <screen>interface FastEthernet0/1
  channel-group 1 mode active
  channel-protocol lacp
 !
 interface FastEthernet0/2
  channel-group 1 mode active
  channel-protocol lacp
-!
-       </screen>
+!</screen>

        <para>On the &os; machine create the lagg interface.</para>

         <screen>&prompt.root; <userinput>ifconfig lagg0 create</userinput>
 &prompt.root; <userinput>ifconfig lagg0 up laggproto lacp laggport
fxp0 laggport fxp1</userinput></screen>

-       <para>View the interface status from ifconfig, ports marked as
+       <para>View the interface status from ifconfig; ports marked as
          <emphasis>ACTIVE</emphasis> are part of the active aggregation group
          that has been negotiated with the remote switch and traffic will be
          transmitted and received.  Use the verbose output of &man.ifconfig.8;
          to view the LAG identifiers.</para>

-       <screen>
-lagg0: flags=8843&lt;UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST&gt;
metric 0 mtu 1500
+       <screen>lagg0:
flags=8843&lt;UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST&gt; metric 0 mtu
1500
         options=8&lt;VLAN_MTU&gt;
         ether 00:05:5d:71:8d:b8
         media: Ethernet autoselect
         status: active
         laggproto lacp
         laggport: fxp1 flags=1c&lt;ACTIVE,COLLECTING,DISTRIBUTING&gt;
-        laggport: fxp0 flags=1c&lt;ACTIVE,COLLECTING,DISTRIBUTING&gt;
-       </screen>
+        laggport: fxp0 flags=1c&lt;ACTIVE,COLLECTING,DISTRIBUTING&gt;</screen>

-       <para>The switch will show which ports are active, for more detail use
+       <para>The switch will show which ports are active.  For more detail use
          <userinput>show lacp neighbor detail</userinput>.</para>

-       <screen>
-switch# show lacp neighbor
+       <screen>switch# show lacp neighbor
 Flags:  S - Device is requesting Slow LACPDUs
         F - Device is requesting Fast LACPDUs
         A - Device is in Active mode       P - Device is in Passive mode
@@ -3014,11 +3017,10 @@
                   LACP port                        Oper    Port     Port
 Port      Flags   Priority  Dev ID         Age     Key     Number   State
 Fa0/1     SA      32768     0005.5d71.8db8  29s    0x146   0x3      0x3D
-Fa0/2     SA      32768     0005.5d71.8db8  29s    0x146   0x4      0x3D
-       </screen>
+Fa0/2     SA      32768     0005.5d71.8db8  29s    0x146   0x4
0x3D</screen>

-      </sect3>
-      <sect3>
+      </example>
+      <example id="networking-lagg-failover">
        <title>Failover mode</title>

        <para>Failover mode can be used to switch over to another interface if
@@ -3027,23 +3029,21 @@
         <screen>&prompt.root; <userinput>ifconfig lagg0 create</userinput>
 &prompt.root; <userinput>ifconfig lagg0 up laggproto failover
laggport fxp0 laggport fxp1</userinput></screen>

-       <screen>
-lagg0: flags=8843&lt;UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST&gt;
metric 0 mtu 1500
+       <screen>lagg0:
flags=8843&lt;UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST&gt; metric 0 mtu
1500
         options=8&lt;VLAN_MTU&gt;
         ether 00:05:5d:71:8d:b8
         media: Ethernet autoselect
         status: active
         laggproto failover
         laggport: fxp1 flags=0&lt;&gt;
-        laggport: fxp0 flags=5&lt;MASTER,ACTIVE&gt;
-       </screen>
+        laggport: fxp0 flags=5&lt;MASTER,ACTIVE&gt;</screen>

        <para>Traffic will be transmitted and received on
-         <devicename>fxp0</devicename>, if the link is lost on
+         <devicename>fxp0</devicename>.  If the link is lost on
          <devicename>fxp0</devicename> then <devicename>fxp1</devicename> will
          become the active link. If the link is restored on the master
          interface then it will once again become the active link.</para>
-      </sect3>
+      </example>
     </sect2>
   </sect1>



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?474078f80709120453k2522bc64mdef8477b3bb3ece8>