d24a4c2ec0e37e355d893a3ad89964723fb3dce7
[dragonfly.git] / sbin / atm / ilmid / ilmid.8
1 .\"
2 .\" ===================================
3 .\" HARP  |  Host ATM Research Platform
4 .\" ===================================
5 .\"
6 .\"
7 .\" This Host ATM Research Platform ("HARP") file (the "Software") is
8 .\" made available by Network Computing Services, Inc. ("NetworkCS")
9 .\" "AS IS".  NetworkCS does not provide maintenance, improvements or
10 .\" support of any kind.
11 .\"
12 .\" NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
13 .\" INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
14 .\" AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
15 .\" SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
16 .\" In no event shall NetworkCS be responsible for any damages, including
17 .\" but not limited to consequential damages, arising from or relating to
18 .\" any use of the Software or related support.
19 .\"
20 .\" Copyright 1994-1998 Network Computing Services, Inc.
21 .\"
22 .\" Copies of this Software may be made, however, the above copyright
23 .\" notice must be reproduced on all copies.
24 .\"
25 .\" @(#) $FreeBSD: src/sbin/atm/ilmid/ilmid.8,v 1.3.2.2 2002/08/21 18:58:05 trhodes Exp $
26 .\" @(#) $DragonFly: src/sbin/atm/ilmid/ilmid.8,v 1.2 2003/06/17 04:27:32 dillon Exp $
27 .\"
28 .\"
29 .Dd September 14, 1998
30 .Dt ILMID 8
31 .Os
32 .Sh NAME
33 .Nm ilmid
34 .Nd "simple ILMI ATM address registration daemon"
35 .Sh SYNOPSIS
36 .Nm
37 .Op Fl d Ar level
38 .Op Fl f
39 .Op Fl r
40 .Sh DESCRIPTION
41 The
42 .Nm
43 utility is a HARP ATM daemon that performs the ILMI ATM address registration
44 procedures with an ATM network switch.
45 It is normally invoked at boot time
46 from the ATM startup script.
47 .Pp
48 For each ATM interface with a UNI signalling manager attached,
49 .Nm
50 will open an ILMI PVC (VPI = 0, VCI = 16) and register the interface's
51 ATM address with the switch.
52 As part of the address registration procedure,
53 the ATM switch will notify the endsystem (local host) of the
54 .Dq "network prefix"
55 portion of the endsystem's ATM address and
56 .Nm
57 will notify the switch of the endsystem's
58 .Dq "user part"
59 of its address
60 (typically the interface card MAC address).
61 .Sh OPTIONS
62 .Bl -tag -width indent
63 .It Fl d Ar level
64 Specify the debug level for optional protocol tracing.
65 Messages are
66 written to
67 .Pa /var/log/ilmid .
68 .It Fl f
69 Causes
70 .Nm
71 to run in the foreground.
72 .It Fl r
73 Causes
74 .Nm
75 to issue a coldStart TRAP on all ATM interfaces it's able to open and exit.
76 .El
77 .Sh NOTES
78 This daemon does not fully conform to the ATM Forum ILMI specifications.
79 In particular, it
80 does not make any queries of the network side to ensure
81 that the ATM Address table is empty.
82 It also does not implement any
83 of the ATM Forum MIB that is specified as part of ILMI.
84 .Pp
85 The
86 .Nm
87 utility will increment the debug level when it receives a
88 .Dv SIGUSR1
89 signal and will
90 decrement the debug level when it receives a
91 .Dv SIGUSR2
92 signal.
93 .Sh SEE ALSO
94 The ATM Forum,
95 .%T "ATM User-Network Interface, Version 3.1 (UNI 3.1) Specification"
96 for details on the ILMI protocols and address registration
97 procedures.
98 .Sh BUGS
99 Please report any bugs to
100 .Aq harp\-bugs@magic.net .
101 .Sh COPYRIGHT
102 Copyright (c) 1994-1998, Network Computing Services, Inc.
103 .Sh AUTHORS
104 .An John Cavanaugh ,
105 Network Computing Services, Inc.
106 .An Mike Spengler ,
107 Network Computing Services, Inc.
108 .An Joseph Thomas ,
109 Network Computing Services, Inc.
110 .Sh ACKNOWLEDGMENTS
111 This software was developed with the support of the
112 Defense Advanced Research Projects Agency (DARPA).