share/man/man4/ng_fec.4

   1 .\" Copyright (c) 2004 Gleb Smirnoff
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd July 22, 2004
  28 .Dt NG_FEC 4
  29 .Os
  30 .Sh NAME
  31 .Nm ng_fec
  32 .Nd netgraph Fast EtherChannel node
  33 .Sh SYNOPSIS
  34 .In netgraph/ng_fec.h
  35 .Sh DESCRIPTION
  36 The
  37 .Nm fec
  38 node implements Ethernet port trunking using the
  39 .Dq Cisco Fast EtherChannel
  40 protocol.
  41 Upon creation, a
  42 .Nm fec
  43 node creates a network interface associated with it.
  44 Interfaces are named
  45 .Dq Li fec0 ,
  46 .Dq Li fec1 ,
  47 etc.
  48 New nodes take the first available unit.
  49 .Sh HOOKS
  50 The
  51 .Nm fec
  52 node accepts any hooks.
  53 However it does not use them.
  54 Under normal operation, a
  55 .Nm fec
  56 node should not have any hooks.
  57 .Sh CONTROL MESSAGES
  58 Interface membership in the FEC group is configured with the following
  59 control messages:
  60 .Bl -tag -width indent
  61 .It Dv NGM_FEC_ADD_IFACE Pq Dq Li add_iface
  62 Attach interface to the FEC group.
  63 The target interface name is passed as a string argument.
  64 .It Dv NGM_FEC_DEL_IFACE Pq Dq Li del_iface
  65 Remove interface from the trunk.
  66 The target interface name is passed as a string argument.
  67 .El
  68 .Pp
  69 The following control messages define the forwarding method for a node:
  70 .Bl -tag -width indent
  71 .It Dv NGM_FEC_SET_MODE_MAC Pq Dq Li set_mode_mac
  72 Forwarding decisions will be based on the link-layer MAC address of the destination.
  73 .It Dv NGM_FEC_SET_MODE_INET Pq Dq Li set_mode_inet
  74 Forwarding decisions will be based on the IP address of the destination.
  75 .El
  76 .Sh SHUTDOWN
  77 This node shuts down upon receipt of a
  78 .Dv NGM_SHUTDOWN
  79 control message.
  80 .Sh EXAMPLES
  81 The following example script creates an
  82 .Nm fec
  83 node, attaches four Ethernet interfaces to it and
  84 sets the forwarding method to be IP-address based:
  85 .Bd -literal -offset indent
  86 /usr/sbin/ngctl -f- << SEQ
  87         mkpeer fec dummy fec
  88         msg fec0: add_iface "dc0"
  89         msg fec0: add_iface "dc1"
  90         msg fec0: add_iface "dc2"
  91         msg fec0: add_iface "dc3"
  92         msg fec0: set_mode_inet
  93 SEQ
  94 .Ed
  95 .Sh SEE ALSO
  96 .Xr netgraph 4
  97 .Sh HISTORY
  98 The
  99 .Nm fec
 100 node type was implemented in
 101 .Fx 5.0 .
 102 .Sh AUTHORS
 103 .An -nosplit
 104 The
 105 .Nm fec
 106 node was written by
 107 .An "Bill Paul" Aq wpaul@FreeBSD.org .
 108 This manual page was written by
 109 .An "Gleb Smirnoff" Aq glebius@FreeBSD.org .