share/man/man4/ng_cisco.4

   1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Subject to the following obligations and disclaimer of warranty, use and
   5 .\" redistribution of this software, in source or object code forms, with or
   6 .\" without modifications are expressly permitted by Whistle Communications;
   7 .\" provided, however, that:
   8 .\" 1. Any and all reproductions of the source or object code must include the
   9 .\"    copyright notice above and the following disclaimer of warranties; and
  10 .\" 2. No rights are granted, in any manner or form, to use Whistle
  11 .\"    Communications, Inc. trademarks, including the mark "WHISTLE
  12 .\"    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  13 .\"    such appears in the above copyright notice or in the software.
  14 .\"
  15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  31 .\" OF SUCH DAMAGE.
  32 .\"
  33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
  34 .\"
  35 .\" $FreeBSD: src/share/man/man4/ng_cisco.4,v 1.11.2.1 2001/12/21 09:00:51 ru Exp $
  36 .\" $DragonFly: src/share/man/man4/ng_cisco.4,v 1.3 2006/02/17 19:37:09 swildner Exp $
  37 .\" $Whistle: ng_cisco.8,v 1.5 1999/01/25 23:46:26 archie Exp $
  38 .\"
  39 .Dd January 19, 1999
  40 .Dt NG_CISCO 4
  41 .Os
  42 .Sh NAME
  43 .Nm ng_cisco
  44 .Nd Cisco HDLC protocol netgraph node type
  45 .Sh SYNOPSIS
  46 .In netinet/in.h
  47 .In netgraph/ng_cisco.h
  48 .Sh DESCRIPTION
  49 The
  50 .Nm cisco
  51 node type performs encapsulation and de-encapsulation of packets
  52 using the Cisco HDLC protocol. This is a fairly simple
  53 protocol for the transmission of packets across
  54 high speed synchronous lines. Each packet is prepended with
  55 an Ethertype, indicating the protocol. There is also a
  56 .Dq keep alive
  57 and an
  58 .Dq inquire
  59 capability.
  60 .Pp
  61 The
  62 .Dv downstream
  63 hook should connect to the synchronous line. On the other side
  64 of the node are the
  65 .Dv inet ,
  66 .Dv inet6 ,
  67 .Dv atalk ,
  68 and
  69 .Dv ipx
  70 hooks, which transmit and receive raw IP, IPv6, AppleTalk, and IPX packets,
  71 respectively.  Typically these hooks would connect to the corresponding
  72 hooks on an
  73 .Xr ng_iface 4
  74 type node.
  75 .Sh IP Configuration
  76 In order to function properly for IP traffic, the node must be informed
  77 of the local IP address and netmask setting.  This is because the protocol
  78 includes an
  79 .Dq inquire
  80 packet which we must be prepared to answer.
  81 There are two ways to accomplish this, manually and automatically.
  82 .Pp
  83 Whenever such an inquire packet is received, the node sends a
  84 .Dv NGM_CISCO_GET_IPADDR
  85 control message to the peer node connected to the
  86 .Dv inet
  87 hook (if any).
  88 If the peer responds, then that response is used. This is the automatic method.
  89 .Pp
  90 If the peer does not respond, the node falls back on its cached value
  91 for the IP address and netmask. This cached value can be set at any time
  92 with a
  93 .Dv NGM_CISCO_SET_IPADDR
  94 message, and this is the manual method.
  95 .Pp
  96 If the
  97 .Dv inet
  98 hook is connected to the
  99 .Dv inet
 100 hook of an
 101 .Xr ng_iface 4
 102 node, as is usually the case, then configuration is automatic as the
 103 .Xr ng_iface 4
 104 understands the
 105 .Dv NGM_CISCO_GET_IPADDR
 106 message.
 107 .Sh HOOKS
 108 This node type supports the following hooks:
 109 .Pp
 110 .Bl -tag -width foobarbazio
 111 .It Dv downstream
 112 The connection to the synchronous line.
 113 .It Dv inet
 114 IP hook.
 115 .It Dv inet6
 116 IPv6 hook.
 117 .It Dv atalk
 118 AppleTalk hook.
 119 .It Dv ipx
 120 IPX hook
 121 .El
 122 .Sh CONTROL MESSAGES
 123 This node type supports the generic control messages, plus the following:
 124 .Bl -tag -width foo
 125 .It Dv NGM_CISCO_SET_IPADDR
 126 This command takes an array of two
 127 .Dv "struct in_addr"
 128 arguments. The first is the IP address of the corresponding interface
 129 and the second is the netmask.
 130 .It Dv NGM_CISCO_GET_IPADDR
 131 This command returns the IP configuration in the same format used by
 132 .Dv NGM_CISCO_SET_IPADDR .
 133 This command is also
 134 .Em sent
 135 by this node type to the
 136 .Dv inet
 137 peer whenever an IP address inquiry packet is received.
 138 .It Dv NGM_CISCO_GET_STATUS
 139 Returns a
 140 .Dv "struct ngciscostat" :
 141 .Bd -literal -offset 4n
 142 struct ngciscostat {
 143   u_int32_t   seq_retries;       /* # unack'd retries */
 144   u_int32_t   keepalive_period;  /* in seconds */
 145 };
 146 .Ed
 147 .El
 148 .Sh SHUTDOWN
 149 This node shuts down upon receipt of a
 150 .Dv NGM_SHUTDOWN
 151 control message, or when all hooks have been disconnected.
 152 .Sh SEE ALSO
 153 .Xr netgraph 4 ,
 154 .Xr ng_iface 4 ,
 155 .Xr ngctl 8
 156 .Rs
 157 .%A D. Perkins
 158 .%T "Requirements for an Internet Standard Point-to-Point Protocol"
 159 .%O RFC 1547
 160 .Re
 161 .Sh LEGAL
 162 .Tn Cisco
 163 is a trademark of Cisco Systems, Inc.
 164 .Sh HISTORY
 165 The
 166 .Nm
 167 node type was implemented in
 168 .Fx 4.0 .
 169 .Sh AUTHORS
 170 .An Julian Elischer Aq julian@FreeBSD.org ,
 171 .An Archie Cobbs Aq archie@FreeBSD.org
 172 .Sh BUGS
 173 Not all of the functionality has been implemented. For example,
 174 the node does not support querying the remote end for its IP address
 175 and netmask.