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$
  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
  54 .Tn IPX
  55 routing tables.
  56 The
  57 .Tn IPX
  58 routing daemon uses the Novell
  59 .Tn IPX
  60 Routing Information Protocol in maintaining up to date kernel routing
  61 table entries.
  62 .Pp
  63 Available options:
  64 .Bl -tag -width logfile
  65 .It Fl N
  66 Do not reply on GetNearestServer
  67 .Tn SAP
  68 request.
  69 .It Fl q
  70 Do not supply routing information (opposite of
  71 .Fl s
  72 option below).
  73 .It Fl s
  74 Forces
  75 .Nm
  76 to supply routing information whether it is acting as an internetwork
  77 router or not.
  78 .It Fl S
  79 Do not supply Service Advertising Protocol
  80 .Pq Tn SAP
  81 information.
  82 The default is to supply
  83 .Tn SAP
  84 information.
  85 .It Fl t
  86 All packets sent or received are
  87 printed on the standard output.
  88 In addition,
  89 .Nm
  90 will not divorce itself from the controlling terminal
  91 so that interrupts from the keyboard will kill the process.
  92 .It Ar logfile
  93 Name of file in which
  94 .Nm Ns 's
  95 actions should be logged.
  96 This log contains information
  97 about any changes to the routing tables and a history of
  98 recent messages sent and received which are related to
  99 the changed route.
 100 .El
 101 .Pp
 102 In normal operation
 103 .Nm
 104 listens
 105 for routing information packets.
 106 If the host is connected to
 107 multiple
 108 .Tn IPX
 109 networks, it periodically supplies copies
 110 of its routing tables to any directly connected hosts
 111 and networks.
 112 .Pp
 113 When
 114 .Nm
 115 is started, it uses the
 116 .Dv SIOCGIFCONF
 117 .Xr ioctl 2
 118 to find those
 119 directly connected interfaces configured into the
 120 system and marked
 121 .Dq up
 122 (the software loopback interface is ignored).
 123 If multiple interfaces
 124 are present, it is assumed the host will forward packets
 125 between networks.
 126 The
 127 .Nm
 128 utility then transmits a
 129 .Em request
 130 packet on each interface (using a broadcast packet if
 131 the interface supports it) and enters a loop, listening
 132 for
 133 .Em request
 134 and
 135 .Em response
 136 packets from other hosts.
 137 .Pp
 138 When a
 139 .Em request
 140 packet is received,
 141 .Nm
 142 formulates a reply based on the information maintained in its
 143 internal tables.
 144 The
 145 .Em response
 146 packet generated contains a list of known routes, each marked
 147 with a
 148 .Dq hop count
 149 metric (a count of 16, or greater, is
 150 considered
 151 .Dq infinite ) .
 152 The metric associated with each
 153 route returned provides a metric
 154 .Em relative to the sender .
 155 .Pp
 156 .Em Response
 157 packets received by
 158 .Nm
 159 are used to update the routing tables if one of the following
 160 conditions is satisfied:
 161 .Bl -bullet
 162 .It
 163 No routing table entry exists for the destination network
 164 or host, and the metric indicates the destination is
 165 .Dq reachable
 166 (i.e., the hop count is not infinite).
 167 .It
 168 The source host of the packet is the same as the router in the
 169 existing routing table entry.
 170 That is, updated information is
 171 being received from the very internetwork router through which
 172 packets for the destination are being routed.
 173 .It
 174 The existing entry in the routing table has not been updated for
 175 some time (defined to be 90 seconds) and the route is at least
 176 as cost effective as the current route.
 177 .It
 178 The new route describes a shorter route to the destination than
 179 the one currently stored in the routing tables; the metric of
 180 the new route is compared against the one stored in the table
 181 to decide this.
 182 .El
 183 .Pp
 184 When an update is applied,
 185 .Nm
 186 records the change in its internal tables and generates a
 187 .Em response
 188 packet to all directly connected hosts and networks.
 189 The
 190 .Xr routed 8
 191 utility waits a short period
 192 of time (no more than 30 seconds) before modifying the kernel's
 193 routing tables to allow possible unstable situations to settle.
 194 .Pp
 195 In addition to processing incoming packets,
 196 .Nm
 197 also periodically checks the routing table entries.
 198 If an entry has not been updated for 3 minutes, the entry's metric
 199 is set to infinity and marked for deletion.
 200 Deletions are delayed
 201 an additional 60 seconds to ensure the invalidation is propagated
 202 to other routers.
 203 .Pp
 204 Hosts acting as internetwork routers gratuitously supply their
 205 routing tables every 30 seconds to all directly connected hosts
 206 and networks.
 207 .Pp
 208 If
 209 .Nm
 210 receives a
 211 .Dv SIGINFO
 212 signal the current contents of the
 213 .Tn RIP
 214 and
 215 .Tn SAP
 216 tables are appended to the file
 217 .Pa /var/log/ipxrouted.dmp .
 218 .Sh SEE ALSO
 219 .Xr ipx 3
 220 .Sh HISTORY
 221 The
 222 .Nm
 223 utility first appeared in
 224 .Fx 2.2 .