6/sbin/atm/atm/atm.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$
  26 .\"
  27 .\"
  28 .de EX          \"Begin example
  29 .ne 5
  30 .if n .sp 1
  31 .if t .sp .5
  32 .nf
  33 .in +.5i
  34 ..
  35 .de EE
  36 .fi
  37 .in -.5i
  38 .if n .sp 1
  39 .if t .sp .5
  40 ..
  41 .TH ATM 8 "1998-08-20" "HARP"
  42 .SH NAME
  43 atm \- user configuration and display command for HARP ATM interface
  44 .SH SYNOPSIS
  45 Interface management subcommands:
  46 .in +10
  47 .ti -5
  48 .B atm attach
  49 <interface> <sigmgr>
  50 .ti -5
  51 .B atm detach
  52 <interface>
  53 .ti -5
  54 .B atm set MAC
  55 <interface> <MAC/ESI address>
  56 .ti -5
  57 .B atm set netif
  58 <interface> <prefix> <count>
  59 .ti -5
  60 .B atm set prefix
  61 <interface> <NSAP prefix>
  62 .ti -5
  63 .B atm show config
  64 [<interface>]
  65 .ti -5
  66 .B atm show interface
  67 [<interface>]
  68 .ti -5
  69 .B atm show netif
  70 [<netif>]
  71 .ti -5
  72 .B atm show stats interface
  73 [<interface> [phy | dev | atm | aal0 | aal4 | aal5 | driver]]
  74 .sp
  75 .ti -10
  76 VCC management subcommands:
  77 .ti -5
  78 .B atm add PVC
  79 <interface> <vpi> <vci> <aal> <encaps> <owner> ...
  80 .ti -5
  81 .B atm delete PVC
  82 <interface> <vpi> <vci>
  83 .ti -5
  84 .B atm delete SVC
  85 <interface> <vpi> <vci>
  86 .ti -5
  87 .B atm show stats VCC
  88 [<interface> [<vpi> [<vci>]]]
  89 .ti -5
  90 .B atm show VCC
  91 [<interface> [<vpi> [<vci>] | SVC | PVC]]
  92 .sp
  93 .ti -10
  94 IP management subcommands:
  95 .ti -5
  96 .B atm add ARP
  97 [<netif>] <host> <ATM address>
  98 .ti -5
  99 .B atm add PVC
 100 <interface> <vpi> <vci> <aal> <encaps> IP <netif> [<host> | dynamic] <traffic> <params> ...
 101 .ti -5
 102 .B atm delete ARP
 103 [<netif>] <host>
 104 .ti -5
 105 .B atm set arpserver
 106 <netif> <ATM address> | local [<IP prefix> ...]
 107 .ti -5
 108 .B atm show ARP
 109 [<host>]
 110 .ti -5
 111 .B atm show arpserver
 112 [<netif>]
 113 .ti -5
 114 .B atm show IPVCC
 115 [<host> | <netif>]
 116 .ti -5
 117 .sp
 118 .ti -10
 119 Miscellaneous subcommands:
 120 .ti -5
 121 .B atm help
 122 .ti -5
 123 .B atm show version
 124 .in -10
 125 .fi
 126 .SH DESCRIPTION
 127 .I atm
 128 configures and displays the status of the Host ATM Research Platform
 129 (HARP) networking software.
 130 The subcommands fall into several categories:
 131 .PP
 132 \fIInterface management\fP subcommands allow manipulation of the
 133 ATM interface.
 134 Functions include assigning a signalling manager to an interface,
 135 setting the ATM address, associating network interfaces with
 136 an interface, and displaying information about interfaces.
 137 .PP
 138 \fIVCC management\fP subcommands allow for managing ATM virtual
 139 channel connections (VCCs).
 140 Functions include opening and closing VCCs and displaying information
 141 about them.
 142 .PP
 143 \fIIP management\fP subcommands allow for managing the interface
 144 between IP and the ATM software.
 145 Functions include displaying and manipulating the ATMARP cache,
 146 opening a PVC connected to IP,
 147 assigning an ATMARP server to a network interface,
 148 and displaying information about IP VCCs.
 149 .PP
 150 \fIMiscellaneous\fP subcommands allow for displaying the version
 151 of the ATM software and for getting help with the \fIatm\fP command.
 152 .SS "Signalling Managers"
 153 The signalling manager is responsible for the opening and closing of
 154 VCCs.
 155 Four signalling managers are supported:
 156 .PP
 157 .in +10
 158 .ti -5
 159 PVC - for PVCs only,
 160 .ti -5
 161 SPANS - supports SPANS, FORE's proprietary signalling protocol,
 162 .ti -5
 163 UNI 3.0 - supports the signalling protocol from The ATM Forum's
 164 \fIATM User-Network Interface Specification, Version 3.0\fP.
 165 .ti -5
 166 UNI 3.1 - supports the signalling protocol from The ATM Forum's
 167 \fIATM User-Network Interface Specification, Version 3.1\fP.
 168 .in -10
 169 .PP
 170 All four signalling managers support the opening and closing of PVCs
 171 (see the \fIadd\fP and \fIdelete\fP subcommands).
 172 .PP
 173 A signalling manager must be attached to a physical interface
 174 (see the \fIattach\fP subcommand)
 175 before any VCCs can be created on the interface.
 176 .SS "Physical and Network Interfaces"
 177 Two types of interfaces are supported:
 178 physical interfaces and network interfaces.
 179 A physical interface represents a physical point of attachment to an
 180 ATM network.
 181 A physical interface has an ATM address associated with it, except
 182 when the PVC-only signalling manager is being used.
 183 .PP
 184 A network interface is a logical interface.
 185 One or more network interfaces are associated with a physical
 186 interface;  each network interface has an IP address associated with it.
 187 For UNI-controlled interfaces, there can be up to 256 network
 188 interfaces associated with a physical interface.
 189 In this case, the correspondence between the network interface and
 190 the ATM address is determined by the selector field (the last
 191 byte) of the physical interface's ATM address.
 192 For PVC-only interfaces, there can be up to 256 logical interfaces
 193 associated with each physical interface.
 194 For interfaces controlled by the SPANS signalling manager,
 195 there must be one and
 196 only one network interface associated with each physical interface.
 197 .SS "Keyword and Documentation Conventions"
 198 Command and subcommand keywords can be abbreviated by simply giving
 199 enough of the first part of the keyword to make it unique.
 200 Thus, \fIatm sh v\fB gives the same result as \fIatm show vcc\fB.
 201 .PP
 202 All keywords are case-insensitive.
 203 .PP
 204 Where a host address needs to be given to the \fIatm\fP command,
 205 either a DNS name or an IP address in dotted decimal format can
 206 be used.
 207 .PP
 208 ATM addresses are specified as strings of hex digits, with an
 209 optional leading "0x".
 210 Fields within the address may be separated by periods, but periods
 211 are for readability only and are ignored.
 212 SPANS addresses are 8 bytes long, while NSAP-format addresses
 213 are 20 bytes long.
 214 The full address, including any leading zeroes, must be given.
 215 For example:
 216 .in +5
 217 0x47.0005.80.ffe100.0000.f21a.0170.0020481a0170.00 (NSAP format)
 218 .br
 219 0x00000010.f2050aa9 (SPANS format)
 220 .in -5
 221 .fi
 222 .SH SUBCOMMANDS
 223 .SS Interface Management Subcommands:
 224 .in +5
 225 .ti -5
 226 \fIatm add PVC <interface> <vpi> <vci> <aal> <encaps> <owner> ...\fP
 227 .in -5
 228 .PP
 229 the format of the \fIadd PVC\fP subcommand varies depending on the
 230 owner of the PVC.
 231 See the description under "IP Management Subcommands."
 232 .PP
 233 \fIatm attach <interface> <sigmgr>\fP
 234 .PP
 235 where:
 236 .in +10
 237 .ti -5
 238 \fI<interface>\fP specifies the physical interface to which the
 239 signalling manager is to be attached,
 240 .ti -5
 241 \fI<sigmgr>\fP specifies which signalling manager is to be attached.
 242 Valid choices are "SIGPVC", "SPANS", "UNI30", and "UNI31".
 243 .in -10
 244 .PP
 245 This command attaches a signalling manager to an interface.
 246 Until this is done, VCCs cannot be opened or closed.
 247 Only one signalling manager at a time can be attached to an interface.
 248 .PP
 249 \fIatm detach <interface>\fP
 250 .PP
 251 where:
 252 .in +10
 253 .ti -5
 254 \fI<interface>\fP specifies the physical interface whose signalling
 255 manager is to be detached.
 256 .in -10
 257 .PP
 258 This command detaches a signalling manager from an interface.
 259 All VCCs that the signalling manager has created will be closed,
 260 and no new VCCs can be created until a signalling manager (either
 261 the same or a different one) is attached again.
 262 .PP
 263 \fIatm set MAC <interface> <MAC/ESI address>\fP
 264 .PP
 265 where:
 266 .in +10
 267 .ti -5
 268 \fI<interface>\fP specifies the physical interface whose
 269 MAC address is to be set,
 270 .ti -5
 271 \fI<MAC/ESI address>\fP specifies the 6-byte MAC part of the NSAP
 272 address for the interface.
 273 The MAC address is specified as a string of 12 hexadecimal
 274 digits with an optional leading "0x".
 275 Fields in the address may be separated by periods.
 276 .in -10
 277 .PP
 278 This command sets the MAC address for a UNI-controlled interface.
 279 The first 13 bytes (the prefix) of the 20-byte NSAP-format address
 280 are set by the \fIatm set prefix\fP command or the ILMI daemon
 281 (\fIilmid\fP (8)),
 282 the next 6 bytes (the End System Identifier (ESI)) are set by
 283 this command,
 284 and the last byte (the selector) will be determined by which
 285 network interface is to be associated with the address.
 286 .PP
 287 The \fIatm set MAC\fP command can be used to override the MAC
 288 address in the interface hardware.
 289 .PP
 290 \fIatm set netif <interface> <prefix> <count>\fP
 291 .PP
 292 where:
 293 .in +10
 294 .ti -5
 295 \fI<interface>\fP specifies the physical interface that the network
 296 interface(s) are to be associated with,
 297 .ti -5
 298 \fI<prefix>\fP specifies the invariant part of the network
 299 interface name,
 300 .ti -5
 301 \fI<count>\fP specifies the number of network interface to be
 302 created.
 303 .in -10
 304 .PP
 305 This command creates one or more network interfaces and associates them
 306 with the specified physical interface.
 307 The network interface names are determined by the prefix and the count.
 308 The names will be of the form <prefix><nn>, where <prefix> is the
 309 prefix specified in the \fIset\fP subcommand and <nn> is a number
 310 in the range 0 - <count>-1.  For example, the command:
 311 .PP
 312 .ti +5
 313 atm set netif hfa0 ni 2
 314 .PP
 315 would create two network interfaces, named ni0 and ni1, and associate
 316 them with physical interface hfa0.
 317 .PP
 318 \fIatm set prefix <interface> <NSAP prefix>\fP
 319 .PP
 320 where:
 321 .in +10
 322 .ti -5
 323 \fI<interface>\fP specifies the physical interface whose NSAP
 324 prefix is to be set,
 325 .ti -5
 326 \fI<NSAP prefix>\fP specifies the first 13 bytes of the NSAP address
 327 for the interface.
 328 The prefix is specified as a string of hexadecimal digits with an
 329 optional leading "0x".
 330 Fields in the prefix may be separated by periods.
 331 .in -10
 332 .PP
 333 This command sets the address for a UNI-controlled interface.
 334 The first 13 bytes (the prefix) of the 20-byte NSAP-format address
 335 are set by this command,
 336 the next 6 bytes (the End System Identifier (ESI)) will be the
 337 MAC address taken from the physical interface or set by the
 338 \fIset MAC\fP subcommand,
 339 and the last byte (the selector) will be determined by which
 340 network interface is to be associated with the address.
 341 .PP
 342 The NSAP prefix must be set before a UNI-controlled
 343 interface can become active.
 344 This can be accomplished either by the ILMI daemon (\fIilmid\fP (8))
 345 or the \fIset prefix\fP subcommand.
 346 .PP
 347 .I atm show config [<interface>]
 348 .PP
 349 displays the following information:
 350 .PP
 351 .B Interface
 352 \- the name of the physical interface.
 353 .PP
 354 .B Vendor
 355 \- the name of the adapter vendor.
 356 .PP
 357 .B Model
 358 \- the model of the adapter.
 359 .PP
 360 .B Media
 361 \- the communications medium used by the adapter.
 362 .PP
 363 .B Bus
 364 \- the type of bus the adapter is attached to.
 365 .PP
 366 .B Serial No.
 367 \- the adapter's serial number.
 368 .PP
 369 .B MAC address
 370 \- the MAC address of the interface.
 371 Note that this is the MAC address encoded in the hardware of
 372 the adapter, even if the \fIatm set MAC\fP command has been used
 373 to change the effective MAC address of the interface.
 374 .PP
 375 .B Hardware version
 376 \- the hardware revision level reported by the interface.
 377 .PP
 378 .B Firmware version
 379 \- the firmware revision level reported by the interface.
 380 .PP
 381 If no parameters are specified on the \fIshow config\fP subcommand,
 382 the configurations of all physical interfaces will be displayed.
 383 If an interface name is specified, only the configuration of the given
 384 interface is displayed.
 385 .PP
 386 .I atm show interface [<interface>]
 387 .PP
 388 displays the following information:
 389 .PP
 390 .B Interface
 391 \- the name of the physical interface.
 392 .PP
 393 .B Sigmgr
 394 \- the name of the signalling manager which has been attached to the
 395 interface.
 396 A dash (-) is shown if no signalling manager has been attached.
 397 .PP
 398 .B State
 399 \- the state of the signalling manager for the interface.
 400 Each signalling manager has its own set of states.
 401 They are:
 402 .in +21
 403 .ti -16
 404 PVC:
 405 .ti -11
 406 ACTIVE\ ---\ The signalling manager is active.
 407 .ti -11
 408 DETACH\ ---\ The signalling manager is being detached.
 409 .ti -16
 410 SPANS:
 411 .ti -11
 412 ACTIVE\ ---\ The signalling manager is active.
 413 .ti -11
 414 DETACH\ ---\ The signalling manager is being detached.
 415 .ti -11
 416 INIT\ -----\ The signalling manager's initial state.
 417 .ti -11
 418 PROBE\ ----\ The signalling manager is attempting to make
 419 contact with the ATM switch.
 420 .ti -16
 421 UNI 3.0 or UNI 3.1:
 422 .ti -11
 423 NULL\ -----\ The signalling manager's initial state.
 424 .ti -11
 425 ADR_WAIT\ -\ The signalling manager is waiting for the NSAP
 426 prefix to be set.
 427 .ti -11
 428 INIT\ -----\ The signalling manager is attempting to establish
 429 contact with the switch.
 430 .ti -11
 431 ACTIVE\ ---\ The signalling manager is active.
 432 .ti -11
 433 DETACH\ ---\ The signalling manager is being detached.
 434 .ti -21
 435 .PP
 436 .B ATM address
 437 \- the ATM address of the interface.
 438 .PP
 439 .B Network interfaces
 440 \- the names of network interfaces, if any, associated with the
 441 physical interface.
 442 .PP
 443 If no parameters are specified on the \fIshow interface\fP subcommand,
 444 information about all physical interfaces will be displayed.
 445 If an interface name is specified, only information about the given
 446 interface is displayed.
 447 .PP
 448 .I atm show netif [<netif>]
 449 .PP
 450 displays the following information:
 451 .PP
 452 .B Net Intf
 453 \- the name of the network interface.
 454 .PP
 455 .B IP Address
 456 \- the IP address of the network interface.
 457 .PP
 458 If no parameters are specified on the \fIshow netif\fP subcommand,
 459 information about all network interfaces will be displayed.
 460 If an interface name is specified, only information about the given
 461 network interface is displayed.
 462 .PP
 463 \fIatm show stats interface [<interface> [phy | dev | atm | aal0 |
 464 aal4 | aal5 | driver]]\fP
 465 .PP
 466 displays statistics associated with one or more interfaces.
 467 Subject-area keywords
 468 (\fIphy\fP, \fIdev\fP, \fIatm\fP, \fIaal0\fP,
 469 \fIaal4\fP, \fIaal5\fP, or \fIdriver\fP)
 470 can be specified to change the scope of the statistics displayed.
 471 .PP
 472 If no subject area keyword is specified, the following information is
 473 displayed:
 474 .PP
 475 .B Interface
 476 \- the name of the physical ATM interface.
 477 .PP
 478 .B Input PDUs
 479 \- the number of Protocol Data Units (PDUs) which have been received
 480 by the interface.
 481 .PP
 482 .B Input Bytes
 483 \- the number of bytes which have been received by the interface.
 484 .PP
 485 .B Input Errs
 486 \- the number of input errors which the interface has experienced.
 487 .PP
 488 .B Output PDUs
 489 \- the number of Protocol Data Units (PDUs) which have been transmitted
 490 by the interface.
 491 .PP
 492 .B Output Bytes
 493 \- the number of bytes which have been transmitted by the interface.
 494 .PP
 495 .B Output Errs
 496 \- the number of output errors which the interface has experienced.
 497 .PP
 498 .B Cmd Errs
 499 \- the number of command errors which the interface has experienced.
 500 .PP
 501 If a subject-area keyword is specified, then statistics for
 502 that subject are displayed.
 503 The statistics displayed depend on the adapter.
 504 If requested statistics are not available for an adaptor,
 505 an error will be noted.
 506 .PP
 507 If no parameters are specified on the \fIshow stats interface\fP
 508 subcommand, statistics for all ATM interfaces are displayed.
 509 If an interface name is specified, only statistics for the given
 510 interface are displayed.
 511 .PP
 512 .SS VCC Management Subcommands:
 513 .PP
 514 \fIatm delete PVC <interface> <vpi> <vci>\fP
 515 .br
 516 \fIatm delete SVC <interface> <vpi> <vci>\fP
 517 .PP
 518 where:
 519 .in +10
 520 .ti -5
 521 \fIPVC\fP specifies that the VCC to be closed is a PVC,
 522 .ti -5
 523 \fISVC\fP specifies that the VCC to be closed is an SVC,
 524 .ti -5
 525 \fI<interface>\fP specifies the physical interface at which the
 526 VCC to be closed terminates,
 527 .ti -5
 528 \fI<vpi>\fP specifies the Virtual Path Identifier (VPI) of the VCC,
 529 .ti -5
 530 \fI<vci>\fP specifies the Virtual Channel Identifier (VCI) of the VCC.
 531 .in -10
 532 .PP
 533 This command closes a VCC.
 534 The two forms differ only in that the first specifies that the
 535 VCC is a PVC (that was created by the \fIadd PVC\fP subcommand) and
 536 the second specifies that the VCC is an SVC.
 537 Reserved VCCs (with VCI values less than 32) cannot be closed
 538 with this command.
 539 .PP
 540 \fIatm show stats VCC [<interface> [<vpi> [<vci>]]]\fP
 541 .PP
 542 displays the following information:
 543 .PP
 544 .B Interface
 545 \- the physical interface on which the VCC terminates.
 546 .PP
 547 .B VPI
 548 \- the Virtual Path Identifier (VPI) for the VCC.
 549 .PP
 550 .B VCI
 551 \- the Virtual Channel Identifier (VCI) for the VCC.
 552 .PP
 553 .B Input PDUs
 554 \- the number of Protocol Data Units (PDUs) which have been received
 555 on the VCC.
 556 .PP
 557 .B Input Bytes
 558 \- the number of bytes which have been received on the VCC.
 559 .PP
 560 .B Input Errs
 561 \- the number of input errors which the VCC has experienced.
 562 .PP
 563 .B Output PDUs
 564 \- the number of Protocol Data Units (PDUs) which have been transmitted
 565 on the VCC.
 566 .PP
 567 .B Output Bytes
 568 \- the number of bytes which have been transmitted on the VCC.
 569 .PP
 570 .B Output Errs
 571 \- the number of output errors which the VCC has experienced.
 572 .PP
 573 If no parameters are specified on the \fIshow VCC\fP subcommand, all
 574 active VCCs are displayed.
 575 If an interface name is specified, all active VCCs for the given
 576 interface are displayed.
 577 If an interface and VPI are specified, all active VCCs for the VPI
 578 on the given interface are displayed.
 579 If an interface, VPI, and VCI are specified, only the specified VCC on
 580 the given interface is displayed (note that this could actually be
 581 two VCCs, since SPANS considers SVCs to be unidirectional).
 582 .PP
 583 \fIatm show VCC [<interface> [<vpi> [<vci>] | SVC | PVC]]\fP
 584 .PP
 585 displays the following information:
 586 .PP
 587 .B Interface
 588 \- the physical interface on which the VCC terminates.
 589 .PP
 590 .B VPI
 591 \- the Virtual Path Identifier (VPI) for the VCC.
 592 .PP
 593 .B VCI
 594 \- the Virtual Channel Identifier (VCI) for the VCC.
 595 .PP
 596 .B AAL
 597 \- the ATM Adaptation Layer (AAL) in use on the VCC.
 598 Possible values are null and AAL 1-5.
 599 .PP
 600 .B Type
 601 \- specifies whether the VCC is an SVC or a PVC.
 602 .PP
 603 .B Dir
 604 \- the direction of information flow on the VCC.
 605 VCCs can be inbound, outbound, or both.
 606 .PP
 607 .B State
 608 \- the state of the VCC, as reported by the signalling manager.
 609 Each signalling manager has its own set of states.
 610 They are:
 611 .in +21
 612 .ti -16
 613 PVC:
 614 .ti -11
 615 NULL\ -----\ No state.
 616 .ti -11
 617 ACTIVE\ ---\ The VCC is active.
 618 .ti -11
 619 FREE\ -----\ The VCC is closed and the signalling manager is waiting for
 620 its resources to be freed.
 621 .ti -16
 622 SPANS:
 623 .ti -11
 624 NULL\ -----\ No state.
 625 .ti -11
 626 ACTIVE\ ---\ The VCC is a PVC and is active.
 627 .ti -11
 628 ACT_DOWN\ -\ The VCC is a PVC and the interface is down.
 629 .ti -11
 630 POPEN\ ----\ The VCC is being opened.
 631 .ti -11
 632 R_POPEN\ --\ The VCC is being opened by a remote host.
 633 .ti -11
 634 OPEN\ -----\ The VCC is active.
 635 .ti -11
 636 CLOSE\ ----\ The VCC is being closed.
 637 .ti -11
 638 ABORT\ ----\ The VCC is being aborted.
 639 .ti -11
 640 FREE\ -----\ The VCC is closed and the signalling manager is waiting for
 641 its resources to be freed.
 642 .ti -16
 643 UNI 3.0 or UNI 3.1:
 644 .ti -11
 645 NULL\ -----\ No state.
 646 .ti -11
 647 C_INIT\ ---\ A VCC is being initiated.
 648 .ti -11
 649 C_OUT_PR\ -\ An outgoing VCC request is proceeding.
 650 .ti -11
 651 C_PRES\ ---\ A VCC is being initiated by the network.
 652 .ti -11
 653 CONN_REQ\ -\ A VCC request has been accepted by a HARP user.
 654 .ti -11
 655 C_IN_PR\ --\ An incoming VCC request is proceeding.
 656 .ti -11
 657 ACTIVE\ ---\ The VCC is active.
 658 .ti -11
 659 REL_REQ\ --\ The VCC is being closed.
 660 .ti -11
 661 REL_IND\ --\ The network is clearing a VCC.
 662 .ti -11
 663 SSCF_REC\ -\ The SSCF session on the signalling channel is in
 664 recovery from an error.
 665 .ti -11
 666 FREE\ -----\ The VCC is closed and the signalling manager is waiting
 667 for its resources to be freed.
 668 .ti -11
 669 ACT_DOWN\ -\ The VCC is a PVC and the interface is down.
 670 .ti -21
 671 .PP
 672 .B Encaps
 673 \- the encapsulation in effect on the VCC.
 674 Possible encapsulations are null and LLC/SNAP.
 675 .PP
 676 .B Owner
 677 \- the owner or owners of the VCC.
 678 Shows the name(s) of the function(s) using the VCC.
 679 .PP
 680 .B Destination
 681 \- the ATM address of the host at the remote end of the VCC.
 682 .PP
 683 If no parameters are specified on the \fIshow VCC\fP subcommand, all
 684 active VCCs are displayed.
 685 If an interface name is specified, all active VCCs for the given
 686 interface are displayed.
 687 If an interface and VPI are specified, all active VCCs for the VPI
 688 on the given interface are displayed.
 689 If an interface, VPI, and VCI are specified, only the specified VCC on
 690 the given interface is displayed (note that this could actually be
 691 two VCCs, since SPANS considers SVCs to be unidirectional).
 692 .PP
 693 .SS IP Management Subcommands:
 694 \fIatm add ARP [<netif>] <host> <ATM address>\fP
 695 .PP
 696 where:
 697 .in +10
 698 .ti -5
 699 \fI<netif>\fP is the optional name of the network interface the
 700 ATMARP entry is to be associated with.
 701 If no name is specified, a network interface is chosen depending
 702 on the IP address of the host being added.
 703 .ti -5
 704 \fI<host>\fP is the host name or IP address of the host to
 705 be added to the ATMARP table,
 706 .ti -5
 707 \fI<ATM address>\fP is the ATM address of the host.
 708 .in -10
 709 .PP
 710 This command adds an entry to the ATMARP table for ATM.
 711 The given host's IP address is associated with the given ATM address.
 712 When IP needs to transmit data to the host, the specified ATM
 713 address will be used to open an SVC.
 714 .PP
 715 The entry will be marked as permanent in the ATMARP table and will not
 716 be subject to aging.
 717 .PP
 718 .in +5
 719 .ti -5
 720 \fIatm add PVC <interface> <vpi> <vci> <aal> <encaps> IP <netif> [<host> | dynamic] <traffic> <params...>\fP
 721 .in -5
 722 .PP
 723 where:
 724 .in +10
 725 .ti -5
 726 \fI<interface>\fP specifies the physical interface where the PVC
 727 is to terminate,
 728 .ti -5
 729 \fI<vpi>\fP specifies the Virtual Path Identifier (VPI) of the PVC,
 730 .ti -5
 731 \fI<vci>\fP specifies the Virtual Channel Identifier (VCI) of the PVC,
 732 .ti -5
 733 \fI<aal>\fP specifies the ATM Adaptation Layer (AAL) for the PVC.
 734 Valid choices are "null" or "AAL0" for the null AAL; "AAL1" for
 735 AAL 1; "AAL2" for AAL 2; "AAL3", "AAL4", or "AAL3/4" for AAL 3/4;
 736 and "AAL5" for AAL 5,
 737 .ti -5
 738 \fI<encaps>\fP specifies the encapsulation for the PVC.
 739 Valid choices are "null" or "none" for null encapsulation, and
 740 "LLC/SNAP", "LLC", or "SNAP" for LLC/SNAP encapsulation,
 741 .ti -5
 742 \fIIP\fP specifies that the owner of the PVC is IP.
 743 .ti -5
 744 \fI<netif>\fP specifies the network interface which the PVC is
 745 to be associated with.
 746 The network interface must exist and be associated with the
 747 specified physical interface,
 748 .ti -5
 749 \fI<host> | dynamic\fP gives the address of the host at
 750 the far end of the PVC, or the word "dynamic" if its address
 751 is to be determined with Inverse ARP.
 752 If "dynamic" is specified, LLC/SNAP encapsulation must also
 753 be specified.
 754 .ti -5
 755 \fI<traffic>\fP is the traffic type of the PVC and may be one of
 756 UBR, CBR or VBR.
 757 Following the traffic type the traffic parameters must be given.
 758 For UBR and CBR this is the peak cell rate and for VBR these
 759 are the peak and sustainable cell rate and the maximum burst size.
 760 .PP
 761 This command creates a PVC with the specified attributes and attaches
 762 it to IP.
 763 .PP
 764 \fIatm delete ARP [<netif>] <host>\fP
 765 .PP
 766 where:
 767 .in +10
 768 .ti -5
 769 \fI<netif>\fP is the optional name of the network interface the
 770 ATMARP entry is associated with.
 771 If no name is specified, the specified host is deleted from the
 772 cache regardless of what network interface it is associated with.
 773 .ti -5
 774 \fI<host>\fP is the host name or IP address of the host to
 775 be deleted from the ATMARP table.
 776 .PP
 777 This command deletes the specified host's entry from the ATMARP table.
 778 .PP
 779 \fIatm set arpserver <netif> <ATM address> | local [<IP prefix> ...]\fP
 780 .PP
 781 where:
 782 .in +10
 783 .ti -5
 784 \fI<netif>\fP specifies the network interface for which the
 785 ATMARP server address is to be set.
 786 .ti -5
 787 \fI<ATM address>\fP specifies the ATM address of the host which is to
 788 provide ATMARP service.
 789 If "local" is specified instead of an ATM address, the host on
 790 which the command is issued will become the ATMARP server.
 791 .ti -5
 792 \fI<IP prefix> ...\fP is an optional list of IP prefixes
 793 that the ATMARP server will provide information about.
 794 An IP prefix is specified as a dotted decimal IP address, followed by
 795 a slash, followed a number specifying how many bits of the IP address
 796 are significant.
 797 For example, 10.0.0.0/8 indicates that the ATMARP server will provide
 798 services for all addresses on IP network 10.
 799 The IP subnetwork which the network interface belongs to is
 800 automatically included.
 801 .in -10
 802 .PP
 803 This command sets the address of the ATMARP server for a network
 804 interface.
 805 .PP
 806 .I atm show ARP [<host>]
 807 .PP
 808 displays the following information:
 809 .PP
 810 .B Net Intf
 811 \- the network interface which traffic for the entry will use.
 812 .PP
 813 .B Flags
 814 \- flags showing whether the entry is valid and whether it is
 815 permanent.
 816 \- flags giving further information about the ATMARP entry.
 817 The meanings of the characters in the flags are:
 818 .PP
 819 .in +5
 820 P - the entry is permanent
 821 .br
 822 R - the entry has been refreshed
 823 .br
 824 V - the entry is valid
 825 .in -5
 826 .PP
 827 .B Age
 828 \- the number of minutes for which the entry will remain valid.
 829 .PP
 830 .B Origin
 831 \- the source of the ATMARP entry.
 832 Possible values are:
 833 .in +16
 834 .ti -11
 835 LOCAL\ ----\ The entry is for an interface on the host.
 836 .ti -11
 837 PERM\ -----\ The entry is permanent.
 838 This is used for entries that are created with the
 839 \fIadd ARP\fP command.
 840 .ti -11
 841 REG\ ------\ The entry was created as the result of a host
 842 registering with the ATMARP server.
 843 .ti -11
 844 SCSP\ -----\ The entry was learned via SCSP.
 845 .ti -11
 846 LOOKUP\ ---\ The entry was created as the result of a host
 847 performing an ATMARP lookup.
 848 .ti -11
 849 PEER_RSP\ -\ The entry was created as the result of a host
 850 answering an InARP Request.
 851 .ti -11
 852 PEER_REQ\ -\ The entry was created as the result of a host
 853 sending an InARP Request.
 854 .in -5
 855 .PP
 856 .B ATM address
 857 \- the ATM address of the host the entry refers to.
 858 .PP
 859 .B IP address
 860 \- the IP address or domain name of the host the entry refers to.
 861 .PP
 862 If no parameters are specified on the \fIshow ARP\fP subcommand,
 863 the whole ATMARP table will be displayed.
 864 If a host name or IP address is specified, only information about the
 865 given host is displayed.
 866 .PP
 867 This command displays both information that has been learned dynamically
 868 (through one form or another of ATMARP and via SCSP) and information
 869 which has been configured by the user (through the \fIadd ARP\fP
 870 subcommand).
 871 .PP
 872 .I atm show arpserver [<netif>]
 873 .PP
 874 displays the following information:
 875 .PP
 876 .B Net Intf
 877 \- the network interface for which information is being displayed.
 878 .PP
 879 .B State
 880 \- the state of the connection to the ATMARP server.
 881 Possible values are:
 882 .in +16
 883 .ti -11
 884 NOT_CONF\ -\ No ATMARP server has been configured for the interface.
 885 .ti -11
 886 SERVER\ ---\ The host is the ATMARP server.
 887 .ti -11
 888 PEND_ADR\ -\ No ATM address has been set for the interface.
 889 .ti -11
 890 POPEN\ ----\ The host is attempting to open a VCC to the ATMARP server.
 891 .ti -11
 892 REGISTER\ -\ The host has a VCC open to the ATMARP server and is in
 893 the process of registering with the server.
 894 .ti -11
 895 ACTIVE\ ---\ The ATMARP server connection is active.
 896 .in -16
 897 .PP
 898 .B ATM Address
 899 \- the ATM address of the ATMARP server.
 900 .PP
 901 If no parameters are specified on the \fIshow arpserver\fP subcommand,
 902 the ATMARP servers for all network interfaces will be displayed.
 903 If an interface name is specified, only information about the given
 904 network interface is displayed.
 905 .PP
 906 .I atm show IPVCC [<host> | <netif>]
 907 .PP
 908 displays the following information:
 909 .PP
 910 .B Net Intf
 911 \- the name of the network interface at which the VCC terminates.
 912 .PP
 913 .B VPI
 914 \- the Virtual Path Identifier (VPI) for the VCC.
 915 .PP
 916 .B VCI
 917 \- the Virtual Channel Identifier (VCI) for the VCC.
 918 .PP
 919 .B State
 920 \- the state of the VCC.
 921 Possible values are:
 922 .in +15
 923 .ti -10
 924 PMAP\ ----\ The host has an IP packet to send and is waiting for
 925 an ATMARP mapping.
 926 .ti -10
 927 POPEN\ ---\ The VCC is being opened.
 928 .ti -10
 929 PACCEPT\ -\ A VCC from a remote host is being accepted.
 930 .ti -10
 931 ACTPENT\ -\ A PVC is open, but no ATMARP information is
 932 available for it yet.
 933 .ti -10
 934 ACTIVE\ --\ The VCC is active.
 935 .in -15
 936 .PP
 937 .B Flags
 938 \- flags giving further information about the VCC.
 939 The meanings of the characters in the flags are:
 940 .PP
 941 .in +5
 942 S - the VCC is an SVC
 943 .br
 944 P - the VCC is a PVC
 945 .br
 946 L - the VCC uses LLC/SNAP encapsulation
 947 .br
 948 M - the IP-to-ATM address mapping for the VCC is valid
 949 .br
 950 N - there is no idle timeout for the VCC
 951 .in -5
 952 .PP
 953 .B IP Address
 954 \- the name and IP address of the host at the remote end of the VCC.
 955 .PP
 956 If no parameters are specified on the \fIshow IPVCC\fP subcommand, all
 957 active VCCs are displayed.
 958 If a host name is specified, the active VCC(s) for the given
 959 host are displayed.
 960 If a network interface name is specified, the active VCC(s) for the
 961 given network interface are displayed.
 962 .PP
 963 .SS Miscellaneous Subcommands:
 964 .I atm help
 965 .PP
 966 displays a synopsis of the atm command with its subcommands
 967 and their parameters.
 968 .PP
 969 .I atm show version
 970 displays the version of the running HARP software.
 971 .fi
 972 .SH "SEE ALSO"
 973 \fIilmid\fP (8); \fIscspd\fP (8); \fIatmarpd\fP (8).
 974 .fi
 975 .SH BUGS
 976 Care must be taken to avoid confusing physical interfaces and
 977 network interfaces.
 978 .PP
 979 Please report any bugs to harp-bugs@magic.net.
 980 .fi
 981 .SH COPYRIGHT
 982 Copyright (c) 1994-1998, Network Computing Services, Inc.
 983 .fi
 984 .SH AUTHORS
 985 John Cavanaugh, Network Computing Services, Inc.
 986 .br
 987 Mike Spengler, Network Computing Services, Inc.
 988 .br
 989 Joe Thomas, Network Computing Services, Inc.
 990 .fi
 991 .SH ACKNOWLEDGMENTS
 992 This software was developed with the support of the Defense
 993 Advanced Research Projects Agency (DARPA).