Merge from vendor branch HEIMDAL:
[dragonfly.git] / share / examples / atm / Startup
1 HARP ATM Startup Configuration Instructions
2 ===========================================
3
4 The following steps are required in order to use the HARP ATM software.
5 See the file atm-config.sh for an example ATM startup script.
6
7 1.  Each ATM physical interface must be configured with one or more network
8     interfaces.  The physical interfaces are named:
9
10         FORE Systems: hfa0, hfa1, ...
11         Efficient Networks: hea0, hea1, ...
12
13     The network interface names and the number of network interfaces for a
14     particular physical interface are specified via the atm command.  The
15     network interface name prefix may be any alphabetic string, but the 
16     generated network interface names must be unique amongst all network
17     interfaces, including non-ATM interfaces.
18
19     To configure the network interfaces, type:
20
21         atm set netif <interface_name> <netif_prefix> <netif_count>
22
23     For example, the command:
24
25         atm set netif hfa0 ni 3
26
27     will generate the network interfaces ni0, ni1 and ni2 on the physical
28     interface hfa0.
29
30     For further details, see the man page atm(8).
31
32
33 2.  Each ATM network interface (netif) must be configured with an IP network
34     address.  Each network interface must be on a different IP subnet.
35
36     To configure the network interface, type:
37
38         ifconfig <netif_name> <IP_address> up
39
40
41 3.  Each ATM physical interface must have a signalling manager attached.  The
42     interfaces may have the same or different signalling managers.
43  
44     To attach a signalling manager, type:
45
46         atm attach <interface_name> <signalling_manager_name>
47
48         where <signalling_manager_name> may be:
49
50                 sigpvc - to only support PVCs on the interface;
51                 spans - to run FORE Systems SPANS signalling protocol across 
52                         the interface, plus support of PVCs;
53                 uni30 - to run ATM Forum UNI 3.0 signalling protocol across 
54                         the interface, plus support of PVCs;
55                 uni31 - to run ATM Forum UNI 3.1 signalling protocol across 
56                         the interface, plus support of PVCs;
57
58     For further details, see the man page atm(8).
59
60
61 4.  Each of the host's PVCs (if any) must be defined.  
62  
63     To define a PVC, type:
64
65         atm add pvc <interface_name> <vpi> <vci> <aal> <encaps> <owner> ....
66
67         where <interface_name> is the name of the ATM physical interface 
68                         over which the PVC is being defined;
69               <vpi> is the VPI value for the PVC;
70               <vci> is the VCI value for the PVC;
71               <aal> is the AAL type which the PVC endpoints will use;
72               <encaps> is the encapsulation which the PVC endpoints will use;
73               <owner> specifies the the owner of the PVC, which may be:
74                         ip - the PVC is used for IP traffic;
75
76         additional parameters may be required, depending on the PVC owner:
77
78         for owner=ip,
79               <netif_name> is the name of the PVC's network interface;
80               <dst> specifies the IP address at the remote end of this PVC;
81
82     For further details, see the man page atm(8).
83
84
85 5.  HARP includes an ILMI daemon, which will perform host address registration
86     with the ATM switch for ATM Forum UNI interfaces.  If ILMI support is
87     available and activated in the ATM switch and the ILMI daemon is running
88     (see ilmid(8)), no further registration procedures are required.  
89     The 'atm set prefix' command is not needed in this case.
90
91     If ILMI address registration support is not available or activated, then
92     the host must be manually registered with its switch.  There should be
93     a user command available on the switch in order to do the registration.
94
95     For example, if you are using a FORE Systems switch, you should enter
96     the following AMI command:
97
98         > conf nsap route new <host_nsap> 152 <switch_port> 0 
99
100     If you are using a Cisco LightStream 1010 switch, you would use the
101     following configuration command:
102
103        > atm route <host_nsap> atm <atm_interface_#> internal
104
105     For ATM Forum UNI interfaces, the 'atm set prefix' command must also
106     be issued when not using ILMI address registration.
107
108
109 6.  HARP includes support for the Server Cache Synchronization Protocol (SCSP),
110     which can synchronize the ATMARP caches of multiple ATMARP servers.
111     Obviously, this is only useful on hosts which are ATMARP servers.
112
113     To run SCSP between servers, two daemons, scspd and atmarpd, must be
114     started.  Scspd implements the SCSP protocol and atmarpd provides an
115     interface between scspd and the ATMARP server in the kernel.  Scspd
116     requires a configuration file.  It will look for a configuration
117     file at /etc/scspd.conf unless told otherwise.
118     
119     An example of commands to start the two daemons is:
120
121         # scspd
122         # atmarpd <netif>
123
124     See the man pages scspd(8) and atmarpd(8) for further information.
125
126         @(#) $FreeBSD: src/share/examples/atm/Startup,v 1.2 1999/08/28 00:19:07 peter Exp $
127         @(#) $DragonFly: src/share/examples/atm/Startup,v 1.2 2003/06/17 04:36:57 dillon Exp $
128