Document revision date: 19 July 1999
[Compaq] [Go to the documentation home page] [How to order documentation] [Help on this site] [How to contact us]
[OpenVMS documentation]

OpenVMS System Management Utilities Reference Manual


Previous Contents Index


Chapter 12
LAN Control Program (LANCP) Utility

12.1 LANCP Description

The LAN Control Program (LANCP) utility allows you to configure and control the LAN software on OpenVMS systems. You can use LANCP to:

12.2 LANCP Usage Summary

You can use the LANCP utility to:

Format

LANCP [command]


Parameter

command

Specifies a LANCP command. This parameter is optional. If no command is specified, the utility displays its prompt and waits for command input.
Usage Summary To invoke LANCP, enter the following command at the DCL command prompt:


$ RUN SYS$SYSTEM:LANCP

The LANCP utility responds by displaying the LANCP> prompt, at which you can enter any LANCP command described in this chapter.

You can also invoke LANCP by using the MCR command or by defining LANCP as a foreign command.

To use the MCR command, at the DCL command prompt, enter:


$ MCR LANCP

To define LANCP as a foreign command, either at the DCL prompt or in a startup or login command file, enter:


$ LANCP :== $SYS$SYSTEM:LANCP

Then you can enter the LANCP command at the DCL prompt to invoke the utility and enter LANCP commands.

When you enter the LANCP or MCR LANCP command:

Note

Some LANCP commands require special privileges.

To exit from the LANCP utility, enter the EXIT command at the LANCP> prompt or press Ctrl/Z.

For information about the LANCP utility, enter the HELP command at the LANCP> prompt.

12.3 LANCP Commands

This section describes and provides examples of the LANCP commands. The following table summarizes the LANCP commands.
Command Function
@ (Execute Procedure) Executes a command procedure.
CLEAR DLL Clears MOP downline load counters for all nodes and devices.
CLEAR DEVICE Deletes a device from the LAN volatile device database.
CLEAR MOPDLL Same as the CLEAR DLL command.
CLEAR NODE Deletes a node from the LAN volatile node database.
CONNECT NODE Connects to a LAN device, such as a terminal server, that implements a management interface using the MOP console carrier protocol.
CONVERT DEVICE_DATABASE Converts the device database to the format required by the current version of LANCP.
CONVERT NODE_DATABASE Converts the node database to the format required by the current version of LANCP.
DEFINE DEVICE Enters a device into the LAN permanent device database or modifies an existing entry.
DEFINE NODE Enters a node into the LAN permanent node database or modifies an existing entry.
EXIT Stops execution of LANCP and returns control to the DCL command level.
HELP Provides online help information about the LANCP utility.
LIST DEVICE Displays information in the LAN permanent device database.
LIST NODE Displays information in the LAN permanent node database.
PURGE DEVICE Deletes a device from the LAN permanent device database.
PURGE NODE Deletes a node from the LAN permanent node database.
SET ACP Modifies the operation of the LANACP LAN Server process.
SET DEVICE Enters a device into the LAN volatile device database or modifies an existing entry and sets device parameters.
SET NODE Enters a node into the LAN volatile node database or modifies an existing entry.
SHOW CONFIGURATION Displays a list of LAN devices on the system.
SHOW DEVICE Displays information in the LAN volatile device database and displays device data.
SHOW DLL Displays the current state of MOP downline load services.
SHOW LOG Displays recent downline load activity.
SHOW MOPDLL Same as the SHOW DLL command.
SHOW NODE Displays information in the LAN volatile node database.
SPAWN Creates a subprocess of the current process.
TRIGGER NODE Issues a request to reboot to a remote node.
UPDATE DEVICE++ Updates firmware image for a device.


++Alpha only

@ (Execute Procedure)

Executes a command procedure or requests the command interpreter to read subsequent command input from a specific file or device.

Format

@ file-spec


Parameter

file-spec

Specifies either the input device or the file for the preceding command, or the command procedure to be executed.

Qualifiers

None.

Example


$ CREATE COUNT.COM
SHOW DEVICE/COUNTERS
SPAWN WAIT 00:01:00
@COUNT
[Ctrl/Z]
$ RUN SYS$SYSTEM:LANCP
LANCP> @COUNT
 
Device Counters EXA0: 
             Value  Counter 
             -----  ------- 
        4294967295  Seconds since last zeroed 
          38731696  Data blocks received 
          28378137  Multicast blocks received 
           2621447  Receive failure 
        4294967295  Bytes received 
        3203299230  Multicast bytes received 
                 1  Data overrun 
          13771761  Data blocks sent 
            672064  Multicast packets transmitted 
            662415  Blocks sent, multiple collisions 
            502863  Blocks sent, single collision 
           1056303  Blocks sent, initially deferred 
        1462759444  Bytes sent 
          76562996  Multicast bytes transmitted 
          40042529  Send failure 
                 0  Collision detect check failure 
                 0  Unrecognized frame destination 
                 0  System buffer unavailable 
                 0  User buffer unavailable
 
 
      

This example creates and runs a command procedure, COUNT.COM, that displays device counters once every minute.

CLEAR DEVICE

Deletes a device from the LAN volatile device database. Requires SYSPRV privilege.

Format

CLEAR DEVICE device-name


Parameter

device-name

Supplies the LAN controller device name. The device name has the form ddcu where dd is the device code, c is the controller designation, and u is the unit number. LAN devices are specified as the name of the template device which is unit 0. For example, the first PCI Ethernet device is specified as EWA0, the second as EWB0.

For example, you can specify a DEMNA controller as either EXA, EXA0, or EXA0:.


Qualifier

/ALL

Deletes all LAN devices in the LAN volatile device database. If you specify a device name, all matching LAN devices are selected, for example: E to select all Ethernet devices, F for FDDI, I for Token Ring, EW to select all PCI Ethernet PCI devices.

Example


LANCP> CLEAR DEVICE EXA0
      

This command deletes device EXA0 from the LAN volatile device database.

CLEAR DLL

This command clears MOP downline load counters from the LAN volatile device and node databases for all nodes and devices. Requires SYSPRV privilege.

Format

CLEAR DLL


Parameters

None.

Qualifiers

None.

Example


LANCP> CLEAR DLL
 
      

This command clears MOP downline load counters from the LAN volatile device and node databases for all nodes and devices.

CLEAR NODE

Deletes a node from the LAN volatile node database. Requires SYSPRV privilege.

Format

CLEAR NODE node-name


Parameter

node-name

Supplies the name of a node in the LAN volatile node database.

Qualifier

/ALL

Deletes all LAN nodes in the LAN volatile node database. If you specify a node name, all matching nodes are selected; for example, A/ALL deletes all nodes whose name begins with A.

Example


LANCP> CLEAR NODE VAXSYS
 
      

This command deletes the node VAXSYS from the LAN volatile node database.

CONNECT NODE

Opens a MOP console carrier connection to the specified node. This allows a local terminal to act as the console for a remote system.

Format

CONNECT NODE node-specification


Parameter

node-specification

Supplies either the node name or the node address of the target node. If you supply the node name, the node address is obtained by looking up the node name in the LAN volatile node database. If you supply the node address, the corresponding node need not be defined in the LAN volatile node database. The canonical form of the address consists of 6 hexadecimal byte characters separated by hyphens. Use a colon as the separator character to indicate the bit-reversed form of the address.

Qualifiers

/DEVICE=device-name

Specifies the LAN controller device name to be used for the connection. For example, you can specify a DEMNA controller as EXA, EXA0, or EXA0:.

/DISCONNECT=disconnect-character

Specifies a character that you can use to terminate the connection to the remote node. To terminate a connection, press Ctrl/disconnect-character. You can select any ASCII character from @ through Z, except C, M, Q, S, Y; the default disconnect character is D.

/PASSWORD=16hexdigits

Supplies the password to be used when the connection is initiated, in hexadecimal (for example, /PASSWORD=0123456789ABCDEF). The default password is zero. You can omit leading zeros.

/V3 or /V4

Indicates that MOP Version 3 or Version 4 formatted messages, respectively, are to be used to make the connection. By default, LANCP determines the format by sending MOP Request ID messages to the remote node first in MOP Version 4 format, then in Version 3 format, repeating this process until a response is received or timeout occurs.

You can specify the format:


Examples

#1

LANCP> CONNECT NODE GALAXY/DEVICE=EWA0
      

This command attempts a console-carrier connection to node GALAXY using the Ethernet device EWA0.

#2

LANCP> CONNECT NODE 08-00-2B-11-22-33/DEVICE=EWA0/PASSWORD=0123456789AB
      

This command attempts a console-carrier connection to the given node address using the Ethernet device EWA0, with the specified password.

CONVERT DEVICE_DATABASE

Converts the device database to the format required by LANCP. If the database is not updated, LANCP can read the database but not update entries in it. Requires SYSPRV privilege.

Format

CONVERT DEVICE_DATABASE device_database


Parameters

None.

Qualifiers

None.

CONVERT NODE_DATABASE

Converts the node database to the format required by LANCP. If the database is not updated, LANCP can read the database but not update entries in it. Requires SYSPRV privilege.

Format

CONVERT NODE_DATABASE node_database


Parameters

None.

Qualifiers

None.

DEFINE DEVICE

Enters a device into the LAN permanent device database or modifies an existing entry. Requires SYSPRV privilege.

Format

DEFINE DEVICE device-name


Parameter

device-name

Supplies the name of a device to be added to the LAN permanent device database or an entry to be modified. The device name has the form ddcu where dd is the device code, c is the controller designation, and u is the unit number. LAN devices are specified as the name of the template device which is unit 0. For example, the first PCI Ethernet device is specified as EWA0, the second as EWB0.

Qualifiers

/ALL

Defines data for all LAN devices in the LAN permanent device database. If you specify a device name, all matching LAN devices are selected, for example: E to select all Ethernet devices, F for FDDI, I for Token Ring, EW to select all Ethernet PCI devices.

/ATMADDRESS=LES

On Alpha systems, defines the LAN emulation server (LES) address for asynchronous transfer mode (ATM). Usually the address is not user specified; this qualifier is used only if you want a specific address. By default the address is determined by software from the configuration server for the LES.

The /ATMADDRESS=LES qualifier's syntax is as follows:


DEFINE DEVICE/ATMADDRESS = ([NO]LES=the ATM server) 
 

/ATMADDRESS=ARP

On Alpha systems, defines the LAN address resolution protocol (ARP) server address for ATM. This qualifier is required before a logical IP subnet (LIS) is enabled if the local host is not the ARP server.

The /ATMADDRESS=ARP qualifier's syntax is as follows:


 
DEFINE DEVICE/ATMADDRESS = (ARP=atm_arp_server) 
 

/CLIP

On Alpha systems, the Classical Internet Protocol (CLIP) qualifier defines a device with the TCP/IP protocol that enables it to see a network as being configured as one or more logical IP subnets (LIS), which allows the Alpha system to transmit Ethernet frames over the ATM network. The /CLIP = ENABLE command causes the system to join the LIS when LANCP initializes. The /CLIP = DISABLE command causes the client to leave the logical IP subnet.

Note that a LIS requires a server, and there must be only one server for each subnet. Communication between subnets can only be performed by a router. Also, there can only be one client for each ATM adapter.

The /CLIP qualifier's syntax with standard Internet dotted notation is as follows:


DEFINE DEVICE/CLIP =(ip_subnet=a.b.c.d, 
                     ip_address=a.b.c.d, 
                     parent=devnam, 
                     name="ip subnet name", 
                     enable, disable 
                     type = client|server) 

The meanings for the syntax for /CLIP are as follows:
Option Meaning
ip_address Specifies the IP address of the CLIP client.
ip_subnet Specifies the subnet mask of the CLIP client.
parent=devnam Specifies the parent device name.
name Specifies a name for the LIS to aid in operations and diagnostics.
type=client Starts up a classical IP only. This is the default.
type=server Starts up a classical IP server. Only one server for each LIS is allowed, and the server needs to be started first.
type=(server,client) Starts up a classical IP server and client.

Keywords and their meaning for /CLIP are as follows:
Keyword Meaning
Enable Joins the logical IP subnet.
Disable Causes a client to leave the logical IP subnet.

/DLL=(enable-option, exclusive-option, size-option, knownclientsonly-option)

Provides the MOP downline load service settings for the device.

Note that defaults apply to creation of an entry in the device database. If an existing entry is being modified, fields not specified remain unchanged.

You can specify the following keywords with this qualifier:

/ELAN

On Alpha systems, the /ELAN qualifier has two values: enable and disable. With /ELAN=ENABLE along with the keyword STARTUP, the LAN emulation is loaded when LANCP starts. With /ELAN=DISABLE, the same parameters used with ENABLE can be invoked.

The /ELAN qualifier's syntax is as follows:


DEFINE DEVICE/ELAN =(parent=parent device, 
                     name="ELAN NAME to join", 
                     size=1516 
                     type=CSMACD 
                     Enable, 
                     Disable, 
                     description = "description string,")                     

The meaning of the syntax for /ELAN is as follows:
Option Meaning
parent The ATM adapter device name. An example of the parent device for ATMworks 350 is: HC n0, where n is the controller number. An example of the parent device for ATMworks 750 is: HW n0, where n is the controller number.
name Optionally specified if you want to join a specific ELAN. The default is null.
size Maximum frame size of the LAN you want to join. Valid sizes are 1516, 4544, or 9234 bytes. The default is 1516.
type Support currently only for CSMACD, which is the default.
description A method of describing the ELAN for display purposes only.

Keywords and their meanings for /ELAN are as follows:
Keyword Meaning
Enable Begins a join on a specified emulated LAN. It also loads the driver, if not already loaded.
Disable Causes a client to leave the emulated LAN.

/PVC=(vci[,...])

/[NO]PVC=(vci[,...])

On Alpha systems, defines the permanent virtual channel (PVC). This is an optional qualifier.

A list of PVCs is defined for use by CLIP clients. This command should be used before enabling the CLIP client. The PVC has to be set up manually in the switch to be used.

The vci is the VCI (Virtual Channel ID) of the PVC (Permanent Virtual Connection) to be used.

/UPDATE

Adds LAN devices that are not currently in the LAN permanent device database to that database. The initial entry for the device uses default values for all parameters. To update the permanent database with current information from the volatile database, use the DEFINE DEVICE command with the /VOLATILE_DATABASE qualifier. You can combine the /UPDATE and /VOLATILE_DATABASE qualifiers in a single DEFINE DEVICE command.

/VOLATILE_DATABASE

Updates the device entries in the LAN permanent device database with any data currently set in the volatile database. This allows you to update the permanent database after changing data in the volatile database, rather than repeating the commands for each updated entry to apply the changes to the permanent database.

Examples

#1

LANCP> DEFINE DEVICE EXA0/MOPDLL=(ENABLE,EXCLUSIVE)
      

This command defines LAN device EXA0 to enable LANACP MOP downline load service in exclusive mode. The setting of the KNOWNCLIENTSONLY and SIZE characteristics are not changed. If the device entry does not currently exist in the LAN permanent device database, these settings are set to the defaults.

#2

LANCP> DEFINE DEVICE/ALL/MOPDLL=NOEXCLUSIVE
      


Previous Next Contents Index

  [Go to the documentation home page] [How to order documentation] [Help on this site] [How to contact us]  
  privacy and legal statement  
6048PRO_029.HTML