usr.sbin/IPXrouted/IPXrouted.8

   1 .\" Copyright (c) 1986, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Copyright (c) 1995 John Hay.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" $FreeBSD: src/usr.sbin/IPXrouted/IPXrouted.8,v 1.8.2.5 2003/03/11 21:13:47 trhodes Exp $
  35 .\"
  36 .Dd October 11, 1995
  37 .Dt IPXROUTED 8
  38 .Os
  39 .Sh NAME
  40 .Nm IPXrouted
  41 .Nd IPX Routing Information Protocol daemon
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl N
  45 .Op Fl q
  46 .Op Fl s
  47 .Op Fl S
  48 .Op Fl t
  49 .Op Ar logfile
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility is invoked at boot time to manage the IPX routing tables.
  54 The IPX routing daemon uses the Novell IPX Routing
  55 Information Protocol in maintaining up to date kernel routing
  56 table entries.
  57 .Pp
  58 Available options:
  59 .Bl -tag -width logfile
  60 .It Fl N
  61 Do not reply on GetNearestServer SAP request.
  62 .It Fl q
  63 Do not supply routing information (opposite of
  64 .Fl s
  65 option below).
  66 .It Fl s
  67 Forces
  68 .Nm
  69 to supply routing information whether it is acting as an internetwork
  70 router or not.
  71 .It Fl S
  72 Do not supply Service Advertising Protocol
  73 (SAP)
  74 information.
  75 The default is to supply
  76 SAP
  77 information.
  78 .It Fl t
  79 All packets sent or received are
  80 printed on the standard output.  In addition,
  81 .Nm
  82 will not divorce itself from the controlling terminal
  83 so that interrupts from the keyboard will kill the process.
  84 .It Ar logfile
  85 Name of file in which
  86 .Nm Ns 's
  87 actions should be logged.  This log contains information
  88 about any changes to the routing tables and a history of
  89 recent messages sent and received which are related to
  90 the changed route.
  91 .El
  92 .Pp
  93 In normal operation
  94 .Nm
  95 listens
  96 for routing information packets.  If the host is connected to
  97 multiple IPX networks, it periodically supplies copies
  98 of its routing tables to any directly connected hosts
  99 and networks.
 100 .Pp
 101 When
 102 .Nm
 103 is started, it uses the
 104 .Dv SIOCGIFCONF
 105 .Xr ioctl 2
 106 to find those
 107 directly connected interfaces configured into the
 108 system and marked
 109 .Dq up
 110 (the software loopback interface
 111 is ignored).  If multiple interfaces
 112 are present, it is assumed the host will forward packets
 113 between networks.
 114 The
 115 .Nm
 116 utility then transmits a
 117 .Em request
 118 packet on each interface (using a broadcast packet if
 119 the interface supports it) and enters a loop, listening
 120 for
 121 .Em request
 122 and
 123 .Em response
 124 packets from other hosts.
 125 .Pp
 126 When a
 127 .Em request
 128 packet is received,
 129 .Nm
 130 formulates a reply based on the information maintained in its
 131 internal tables.  The
 132 .Em response
 133 packet generated contains a list of known routes, each marked
 134 with a
 135 .Dq hop count
 136 metric (a count of 16, or greater, is
 137 considered
 138 .Dq infinite ) .
 139 The metric associated with each
 140 route returned provides a metric
 141 .Em relative to the sender .
 142 .Pp
 143 .Em Response
 144 packets received by
 145 .Nm
 146 are used to update the routing tables if one of the following
 147 conditions is satisfied:
 148 .Bl -bullet
 149 .It
 150 No routing table entry exists for the destination network
 151 or host, and the metric indicates the destination is ``reachable''
 152 (i.e. the hop count is not infinite).
 153 .It
 154 The source host of the packet is the same as the router in the
 155 existing routing table entry.  That is, updated information is
 156 being received from the very internetwork router through which
 157 packets for the destination are being routed.
 158 .It
 159 The existing entry in the routing table has not been updated for
 160 some time (defined to be 90 seconds) and the route is at least
 161 as cost effective as the current route.
 162 .It
 163 The new route describes a shorter route to the destination than
 164 the one currently stored in the routing tables; the metric of
 165 the new route is compared against the one stored in the table
 166 to decide this.
 167 .El
 168 .Pp
 169 When an update is applied,
 170 .Nm
 171 records the change in its internal tables and generates a
 172 .Em response
 173 packet to all directly connected hosts and networks.
 174 .Xr Routed 8
 175 waits a short period
 176 of time (no more than 30 seconds) before modifying the kernel's
 177 routing tables to allow possible unstable situations to settle.
 178 .Pp
 179 In addition to processing incoming packets,
 180 .Nm
 181 also periodically checks the routing table entries.
 182 If an entry has not been updated for 3 minutes, the entry's metric
 183 is set to infinity and marked for deletion.  Deletions are delayed
 184 an additional 60 seconds to insure the invalidation is propagated
 185 to other routers.
 186 .Pp
 187 Hosts acting as internetwork routers gratuitously supply their
 188 routing tables every 30 seconds to all directly connected hosts
 189 and networks.
 190 .Pp
 191 If
 192 .Nm
 193 receives a SIGINFO signal the current contents of the RIP and SAP
 194 tables are appended to the file /var/log/ipxrouted.dmp.
 195 .Sh SEE ALSO
 196 .Xr ipx 3
 197 .Sh HISTORY