Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / esis.4
blob830168e9fc404e1da6a82e15d47a17dc28bc1074
1 .\"     $NetBSD: esis.4,v 1.12 2003/06/27 18:23:08 wiz Exp $
2 .\"
3 .\" Copyright (c) 1990, 1991, 1993
4 .\"     The Regents of the University of California.  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 .\"     @(#)esis.4      8.2 (Berkeley) 11/30/93
31 .\"
32 .Dd November 30, 1993
33 .Dt ESIS 4
34 .Os
35 .Sh NAME
36 .Nm esis
37 .Nd End System to Intermediate System Routing Protocol
38 .Sh SYNOPSIS
39 .In sys/types.h
40 .In netiso/esis.h
41 .Sh DESCRIPTION
42 The
43 .Tn ES-IS
44 routing protocol is used to dynamically map between
45 .Tn ISO NSAP
46 addresses and
47 .Tn ISO SNPA
48 addresses; to permit End Systems (ES) and Intermediate Systems (IS)
49 to learn of each other's existence; and to allow Intermediate Systems
50 to inform End Systems of (potentially) better routes to use when forwarding
51 Network Protocol Data Units
52 .Pq Tn NPDU Ns s
53 to a particular destination.
54 .Pp
55 The mapping between
56 .Tn NSAP
57 addresses and
58 .Tn SNPA
59 addresses is accomplished by transmitting
60 .Qq hello
61 Protocol Data Units
62 .Pq Tn PDU Ns s
63 between the cooperating Systems.
64 These
65 .Tn PDU Ns s
66 are transmitted whenever the
67 .Em configuration
68 timer expires.
69 When a
70 .Qq hello
71 .Tn PDU
72 is received, the
73 .Tn SNPA
74 address that it conveys is stored in the routing table for as long as the
75 .Em holding time
76 in the
77 .Tn PDU
78 suggests.
79 The default
80 .Em holding time
81 (120 seconds) placed in the
82 .Qq hello
83 .Tn PDU ,
84 the configuration timer value, and the system type (End System or
85 Intermediate System) may be changed by issuing an
86 .Dv SIOCSSTYPE
87 .Xr ioctl 2 ,
88 which is defined in
89 .Aq Pa sys/netiso/iso_snpac.h .
90 .Pp
91 The protocol behaves differently depending on whether the System is
92 configured as an End System or an Intermediate System.
93 .Sh END SYSTEM OPERATION
94 When an interface requests a mapping for an address not in the cache, the
95 .Tn SNPA
96 of any known Intermediate System is returned.
97 If an Intermediate System is not known, then the
98 .Em all end systems
99 multicast address is returned.
100 It is assumed that the intended recipient of the
101 .Tn NPDU
102 will immediately transmit a
103 .Qq hello
104 .Tn PDU
105 back to the originator of the
106 .Tn NPDU .
108 If an
109 .Tn NPDU
110 is forwarded by the End System, a redirect
111 .Tn PDU
112 will not be generated.
113 However, redirect
114 .Tn PDU Ns s
115 received will be processed.
116 This processing consists of adding an entry in the routing table.
117 If the redirect is towards an Intermediate System, then an entry
118 is made in the routing table as well.
119 The entry in the routing table will mark the
120 .Tn NSAP
121 address contained in the redirect
122 .Tn PDU
123 as the gateway for the destination
124 system (if an NET is supplied), or will create a route with
126 .Tn NSAP
127 address as the destination and the
128 .Tn SNPA
129 address (embodied as a link-level struct sockaddr) as the
130 gateway.
132 If the System is configured as an End System, it will report all the
133 .Tn NSAP Ns s
134 that have been configured using the
135 .Xr ifconfig 8
136 command, and no others.
137 It is possible to have more than one
138 .Tn NSAP
139 assigned to a given interface,
140 and it is also possible to have the same
141 .Tn NSAP
142 assigned to multiple
143 interfaces.
144 However, any
145 .Tn NSAP
146 containing an
147 .Tn NSEL
148 that is consistent with the
149 .Em nsellength
150 option (default one) of any interface will be accepted as an
151 .Tn NSAP
152 for this System.
153 .Sh INTERMEDIATE SYSTEM OPERATION
154 When an interface requests a mapping for an address not in the routing table,
155 an error is returned.
157 When an
158 .Tn NPDU
159 is forwarded out on the same interface that the
160 .Tn NPDU
161 arrived upon, a redirect
162 .Tn PDU
163 is generated.
164 .Sh MANUAL ROUTING TABLE MODIFICATION
165 To facilitate communications with systems which do not use
166 .Tn ES-IS ,
167 one may add a route whose destination is a struct sockaddr_iso containing the
168 .Tn NSAP
169 in question, and the gateway being a link-level struct sockaddr,
170 either by writing a special purpose program, or using the
171 .Xr route 8
172 command e.g.:
173 .Bd -literal
174 route add -iface -osi 49.0.4.8.0.2b.b.83.bf \
175         -link qe0:8.0.2b.b.83.bf
178 If the System is configured as an End System and has a single
179 network interface which does not support multicast reception, it
180 is necessary to manually configure the location of an
181 .Tn IS ,
182 using the route command in a similar way.
183 There, the destination address should be
184 .Dq default
185 (spelled out literally as 7
186 .Tn ASCII
187 characters), and the gateway should be once again be a link-level
188 struct sockaddr specifying the
189 .Tn SNPA
190 of the
191 .Tn IS .
192 .Sh SEE ALSO
193 .Xr iso 4 ,
194 .\" .Xr un 4 ,
195 .Xr ifconfig 8 ,
196 .Xr route 8
198 .%T "End system to Intermediate system routing exchange protocol for use in conjunction with the Protocol for providing the connectionless-mode network service"
199 .%R ISO
200 .%N 9542
202 .Sh BUGS
203 Redirect
204 .Tn PDU Ns s
205 do not contain options from the forwarded
206 .Tn NPDU
207 which generated the redirect.
208 The multicast address used on the
209 .Tn IEEE 802.3
210 .Pq Tn Ethernet
211 network is taken from the
212 National Bureau of Standards
213 .Pq Tn NBS
214 December 1987 agreements.
215 This multicast address is not compatible with the
216 .Tn IEEE 802.5
217 .Pq Tn Token Ring
218 multicast addresses format.
219 Therefore, broadcast addresses are used on the
220 .Tn IEEE 802.5
221 subnetwork.
223 Researchers at the University of Wisconsin are constructing an implementation
224 of the
225 .Tn IS-IS
226 routing protocol.
228 .Tn NBS
229 is now known as the National Institute for Standards and Technology
230 .Pq Tn NIST .