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