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