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 Cisco Fast EtherChannel protocol.
  39 Upon creation, node creates a network interface associated with it.
  40 Interfaces are named
  41 .Dq Li fec0 ,
  42 .Dq Li fec1 ,
  43 etc.
  44 New node takes first available unit.
  45 .Sh HOOKS
  46 The
  47 .Nm fec
  48 node accepts any hooks.
  49 However it does not use them.
  50 Under normal operation, node should not have any hooks.
  51 .Sh CONTROL MESSAGES
  52 Interface membership in the FEC group is configured with the following
  53 control messages:
  54 .Bl -tag -width indent
  55 .It Dv NGM_FEC_ADD_IFACE Pq Dq Li add_iface
  56 Attach interface to the FEC group.
  57 Target interface name is passed as a string argument.
  58 .It Dv NGM_FEC_DEL_IFACE Pq Dq Li del_iface
  59 Remove interface from the trunk.
  60 Target interface name is passed as a string argument.
  61 .El
  62 .Pp
  63 The following control messages define forwarding method for a node:
  64 .Bl -tag -width indent
  65 .It Dv NGM_FEC_MODE_INET Pq Dq Li set_mode_mac
  66 Forwarding decisions will be made on destination link layer MAC addresses.
  67 .It Dv NGM_FEC_MODE_MAC Pq Dq Li set_mode_inet
  68 Forwarding decisions will be made on destination IP addresses.
  69 .El
  70 .Sh SHUTDOWN
  71 This node shuts down upon receipt of a
  72 .Dv NGM_SHUTDOWN
  73 control message.
  74 .Sh EXAMPLES
  75 This example script creates a
  76 .Nm fec
  77 node, attaches four Ethernet interfaces to it and
  78 sets forwarding method based on IP address:
  79 .Bd -literal -offset indent
  80 /usr/sbin/ngctl -f- <<-SEQ
  81         mkpeer fec dummy fec
  82         msg fec0: add_iface "dc0"
  83         msg fec0: add_iface "dc1"
  84         msg fec0: add_iface "dc2"
  85         msg fec0: add_iface "dc3"
  86         msg fec0: set_mode_inet
  87 SEQ
  88 .Ed
  89 .Sh SEE ALSO
  90 .Xr netgraph 4
  91 .Sh HISTORY
  92 The
  93 .Nm fec
  94 node type was implemented in
  95 .Fx 5.0 .
  96 .Sh AUTHORS
  97 .An -nosplit
  98 The
  99 .Nm fec
 100 node was written by
 101 .An "Bill Paul" Aq wpaul@FreeBSD.org .
 102 This manual page was written by
 103 .An "Gleb Smirnoff" .