Document revision date: 30 March 2001

## OpenVMS System Management Utilities Reference Manual

Previous | Contents | Index

## @ (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:

> - To allow connection to nodes that do not support Request ID messages
> - As a means of getting around implementation problems with one of the formats

###

#### 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 Classical IP over 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, defines the Classical Internet Protocol (CLIP) over ATM (RFC1577). The CLIP qualifier implements a data-link level device as a client and/or a server in a logical IP subnet (LIS). This allows the IP protocol to transmit Ethernet frames over the ATM network. The /CLIP = ENABLE command causes the system to join the LIS. 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. 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 client 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:

> - enable-option
>     ENABLE
>     DISABLE (default)
>   Specify ENABLE or DISABLE to indicate that MOP downline load service should be enabled or disabled for the device.
> - exclusive-option
>     EXCLUSIVE
>     NOEXCLUSIVE (default)
>   Specify EXCLUSIVE to indicate that no other provider of MOP downline load service is allowed on the specified LAN device at the same time as LANACP. Specify NOEXCLUSIVE to indicate that the LAN MOP downline load service can coexist with other implementations (in particular, the DECnet Phase IV implementation that operates the MOP protocol in shared mode).
> - size-option
>     SIZE=value
>   Use SIZE=value to specify the size in bytes of the file data portion of each downline load message. The permitted range is 246 to 1482 bytes. The default value is 246 bytes, which should allow any client to load properly. Note that some clients may not support the larger size.
>   The recommended size for better load performance and less server overhead is the largest size that results in successful loads of all clients. The 1482 value is derived from the maximum packet size for CSMA/CD (Ethernet) of 1518 bytes less the 802e header and CRC (26 bytes) and MOP protocol overhead (10 bytes).
>   You can override the size on a per-node basis. See the DEFINE NODE and SET NODE commands for details.
> - knownclientsonly-option
>     KNOWNCLIENTSONLY
>     NOKNOWNCLIENTSONLY (default)
>   Specify KNOWNCLIENTSONLY to indicate that MOP downline load requests should be serviced only for clients defined in the LAN permanent node database. When NOKNOWNCLIENTSONLY is selected, LANACP searches the LAN$DLL directory for any images requested by clients that are not defined in the LAN permanent node database.

> #### /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 LANACP 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 DAPCA is: HW n0, where n is the controller number. An example of the parent device for DGLTA is: HC 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 circuit (PVC) to be used by a Classical IP over ATM client. 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 ATM switch.

> The vci is the VCI (Virtual Circuit ID) of the PVC 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

> This command sets all LAN devices defined in the LAN permanent device database to nonexclusive mode for LANACP MOP downline load service.

#3
    LANCP> DEFINE DEVICE/ALL/UPDATE/VOLATILE_DATABASE

> This command enters all Ethernet devices into the LAN permanent device database and updates the entry to include the current parameter values.

## DEFINE NODE

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

### Format

> DEFINE NODE node-name

### Parameter

> #### node-name

> Supplies the name of a node to be added to the LAN permanent node database or an entry to be modified. Typically, the node name is the same as that given in the system parameter SCSNODE, but it does not need to be. The node name is limited to 63 characters in length.

### Qualifiers

> #### /ADDRESS=node-address

> #### /NOADDRESS (default)

> Associates a LAN address with the node name. Specify the address as 6 bytes in hexadecimal notation, separated by hyphens. The address does not have to be unique (as might be the case when the address is not known, so a nonexistent address is specified).

> If multiple node addresses are to be associated with a node name, each combination may be given as a node name with an extension, for example, VAXSYS.EXA for the EXA device on node VAXSYS, or VAXSYS_1 for the first LAN device on node VAXSYS.

> If you do not specify the /ADDRESS qualifier, the setting remains unchanged. The /NOADDRESS qualifier clears the field.

> #### /ALL

> Defines data for all nodes in the LAN permanent node database. If you specify a node name, all matching nodes are selected; for example, A/ALL selects all nodes beginning with A.

> #### /BOOT_TYPE=boot-option

> #### /NOBOOT_TYPE

> Indicates the type of processing required for downline load requests. You can specify one of the following keywords with this qualifier:
> - VAX_SATELLITE---an OpenVMS Cluster VAX satellite boot
> - ALPHA_SATELLITE---an OpenVMS Cluster Alpha satellite boot
> - OTHER---the specified image; a noncluster satellite load that does not require additional data
> The distinction is necessary, because OpenVMS Cluster satellite loads require additional cluster-related data be appended to the load image given by the /FILE qualifier. The default value is OTHER.

> If you do not specify the /BOOT_TYPE qualifier, the setting remains unchanged. The /NOBOOT_TYPE qualifier clears the field.

> #### /DECNET_ADDRESS=value

> #### /NODECNET_ADDRESS

> Associates a DECnet address with the node name. Specify the address in DECnet notation, xx.xxxx.

> If you do not specify the /DECNET_ADDRESS=value qualifier, then the setting remains unchanged. The /NODECNET_ADDRESS qualifier clears the field.

> #### /FILE=file-spec

> #### /NOFILE

> Supplies the file name of a boot file to be used when the downline load request does not include a file name (for example, with OpenVMS Cluster satellite booting). The file specification is limited to 127 characters.

> If no file name is specified, OpenVMS Cluster satellite loads default to APB.EXE where the boot type is set to ALPHA and NISCS_LOAD.EXE where the boot type is set to VAX.

> If you do not specify the /FILE qualifier, the setting remains unchanged. The /NOFILE qualifier clears the field.

> #### /IP_ADDRESS=value

> #### /NOIP_ADDRESS

> Associates an IP address with the node name. Specify the address in the standard dotted notation, xxx.xxx.xxx.xxx.

> If you do not specify the /IP_ADDRESS=value qualifier, the setting remains unchanged. The /NOIP_ADDRESS qualifier clears the filed.

> #### /ROOT=directory-specification

> #### /NOROOT

> Supplies the directory specification to be associated with the file name. For cluster satellite service, the /ROOT qualifier specifies the satellite root directory. For noncluster service, this qualifier specifies the location of the file. If the file specification or the file name given in the boot request includes the directory name, this qualifier is ignored. The directory specification is limited to 127 characters.

> If you do not specify the /ROOT qualifier, the setting remains unchanged. The /NOROOT qualifier clears the field.

> #### /SIZE=value

> #### /NOSIZE

> Specifies the size in bytes of the file data portion of each downline load message. The default is the load data size specified for the device. The permitted range is 246 to 1482 bytes. Use a larger size for better load performance and less server overhead.

> If you do not specify the /SIZE qualifier, the setting remains unchanged. The /NOSIZE qualifier clears the setting.

> #### /V3

> #### /NOV3

> Indicates that only MOP Version 3 formatted messages are to be used for downline load purposes, regardless of the requested format. This allows systems that have a problem with MOP Version 4 booting to load. This qualifier causes the requesting node to fail over from MOP Version 4 to MOP Version 3 when no response has been made to a MOP Version 4 load request.

> If you do not specify the /V3 qualifier, the setting remains unchanged. The /NOV3 qualifier clears the setting.

> #### /VOLATILE_DATABASE

> Updates the node entries in the LAN permanent node 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 NODE GALAXY/ADDRESS=08-00-2B-11-22-33 -
                      /FILE=NISCS_LOAD.EXE -
                      /ROOT=$64$DIA14:<SYS10.> -
                      /BOOT_TYPE=VAX_SATELLITE

> This command sets up node GALAXY in the LAN permanent node database for booting as a VAX satellite into an OpenVMS Cluster.

> The NISCS_LOAD.EXE file is actually located on $64$DIA14: <SYS10.SYSCOMMON.SYSLIB>. The <SYSCOMMON.SYSLIB> is supplied by the LANACP LAN Server process and is not included in the root definition.

#2
    LANCP> DEFINE NODE ZAPNOT/ADDRESS=08-00-2B-11-22-33 -
                      /FILE=APB.EXE -
                      /ROOT=$64$DIA14:<SYS10.> -
                      /BOOT_TYPE=ALPHA_SATELLITE

> This command sets up node ZAPNOT for booting as an Alpha satellite into an OpenVMS Cluster.

> The APB.EXE file is actually located on $64$DIA14: <SYS10.SYSCOMMON.SYSEXE>. Note that the <SYSCOMMON.SYSEXE> is supplied by the LANACP LAN Server process and is not included in the root definition.

#3
    LANCP> DEFINE NODE CALPAL/ADDRESS=08-00-2B-11-22-33 -
                      /FILE=APB_061.EXE

> Previous | Next | Contents | Index

> | privacy and legal statement |
> 6048PRO_030.HTML