6. NTYCP Command Reference

 

This chapter describes the Network Terminal Device Control Program (NTYCP) commands you can use to create terminal devices.

To invoke NTYCP as an OpenVMS "foreign" command:

$ NTYCP := $MULTINET:NTYCP

To invoke NTYCP interactively:

$ RUN MULTINET:NTYCP
NTYCP> CREATE PORT NTYnnnn /NODE=host-name /PORT=port-number
NTYCP> EXIT

To set up the terminal characteristics:

$ SET TERMINAL NTYnnn:/PERMANENT/NOBROADCAST/NOTYPEAHEAD/NOWRAP

To set up spooling:

$ SET DEVICE/SPOOLED=(queue-name,SYS$SYSDEVICE:) NTYnnnn:

To initialize and start the queue:

$ INITIALIZE/QUEUE/ON=NTYnnnn: queue-name /PROCESSOR=MULTINET_NTYSMB/START

This example shows how to set up a print queue connected to an HP LaserJet printer with a JetDirect card:

$ NTYCP := $MULTINET:NTYCP
$ NTYCP CREATE PORT NTY1001/NODE=hp-laserjet/PORT=9100
%NTYCP-S-CREPORT, device _NTY1001: created to host 192.1.1.5, port 9100
$ SET TERMINAL/PERMANENT NTY1001:/NOBROADCAST/NOTYPEAHEAD/NOWRAP
$ INITIALIZE/QUEUE/ON=NTY1001: HP_LASERJET/PROCESSOR=MULTINET_NTYSMB/START

Command Summary

The below table lists the NTYCP commands.

NTYCP Command

Description

CREATE PORT

Creates a new network terminal port device.

DELETE PORT

Deletes an NTY device created by the CREATE_PORT command.

EXIT

Exits from NTYCP to DCL command mode.

HELP

Displays help text about NTYCP commands.

MODIFY PORT

Modifies (changes) an existing network terminal port device.

 

 

 

 

 


 

CREATE PORT

Creates a new network terminal port device. The device links the VMS terminal driver to a TCP/IP network connection directed to the destination address specified by the /HOST qualifier and the /PORT or /SERVICE qualifier.

You can use network terminal (NTY) devices with the MULTINET_NTYSMB print symbiont to provide VMS print queue support for network-connect printers. You can also use them with user-written applications that need a simple terminal-style I/O interface to a remote terminal, plotter, etc.

 

FORMAT

CREATE PORT device-name

 

Command Qualifiers

Defaults

/[NO]LOG
/LOGICAL=(logical-name-options...)
/NODE=node-name-or-address
/PORT=port-number
/SERVICE=service-name

/LOG

 

PARAMETER

device-name

Name of the NTY port device to be created. If specified, the device name must be of the form NTYn, where n is a device unit number, which must be in the range 1-9999. The specified device must not already exist. If omitted, the next available unit number will be used.

 

QUALIFIERS

/LOG

/NOLOG

Controls whether a log message is generated on successful completion of the command. The default is /LOG.

 

/LOGICAL=(logical-name-options...)

Causes NTYCP to create a logical name for the created NTY device. This qualifier takes one or more of the keyword options specified in the below table. If you specify multiple options, separate them by commas. You must have access to the specified logical name table and sufficient privilege to create the logical name.

Keyword

Description

NAME=logical-name

The logical name to be created. You must specify this option if you use /LOGICAL.

TABLE=table-name

Specifies the logical name table in which the logical name should be created. This can be the actual name of a table, or one of the key-words PROCESS, GROUP, SYSTEM. The default is TABLE=PROCESS.

MODE=mode-name

Specifies the access mode in which the logical name should be created. The keywords are EXECUTIVE, SUPERVISOR, USER. The default is MODE=SUPERVISOR.

 

/NODE=node-name-or-address

Specifies the name or numeric IP address of the remote node. You must specify this qualifier.

If you specify a node name, it is translated into an IP address. Only one IP address may be configured per NTY device. If the destination system is a host with multiple IP addresses, and not all addresses are directly reachable from your local system, you should specify the IP address numerically to ensure that a reachable address is configured.

 

/PORT=port-number

Specifies a TCP port number on the remote node to which the connection will be made. You must specify either the /PORT qualifier or the /SERVICE qualifier with the command.

 

/SERVICE=service-name

Specifies the name of a TCP service that translates to a port number to which the connection will be made. You may specify any TCP service name present in the local hosts/services table. You must specify either the /PORT qualifier or the /SERVICE qualifier with the command.

 

 

 

 


 

DELETE PORT

Deletes an NTY device created by the NTYCP CREATE PORT command.

 

FORMAT

DELETE PORT device-name

Command Qualifiers

Defaults

/[NO]LOG

 /LOG

 

PARAMETER

device-name

Name of the NTY port device to be deleted.

 

QUALIFIER

/LOG

/NOLOG

Controls whether a log message is generated on successful completion of the command. The default is /LOG.

 

 

 

 


 

EXIT

Causes NTYCP to exit back to DCL command mode.

 

FORMAT

EXIT

 

 

 

 


 

HELP

Displays help text about NTYCP commands.

 

FORMAT

HELP [topic]

 

PARAMETER

topic

A command name or other topic in the NTYCP help library. If omitted, a list of topics displays.

 

 

 

 


 

MODIFY PORT

Modifies (changes) an existing network terminal port device. The device links the VMS terminal driver to a TCP/IP network connection directed to the destination address specified by the /HOST qualifier and the /PORT or /SERVICE qualifier.

 

FORMAT

MODIFY_PORT device-name

Command Qualifiers

Defaults

/[NO]LOG

/LOGICAL=(logical-name-options...)

/NODE=node-name-or-address

/PORT=port-number

/SERVICE=service-name

/LOG

 

PARAMETERS

modify-object

Name of the NTY object to be modified (changed).

 

port-name

Name of the NTY port device to be modified (changed).

 

QUALIFIERS

/LOG

/NOLOG

Controls whether a log message is generated on successful completion of the command. The default is /LOG.

 

/LOGICAL=(logical-name-options...)

This is the logical name for the NTY device you want to modify. This qualifier takes one or more of the keyword options specified in the below table. If you specify multiple options, separate them by commas. You must have access to the specified logical name table and sufficient privilege to modify the logical name.

Keyword

Description

NAME=logical-name

The logical name to be created. You must specify this option if you use /LOGICAL.

TABLE=table-name

Specifies the logical name table in which the logical name should be created. This can be the actual name of a table, or one of the keywords PROCESS, GROUP, SYSTEM. The default is TABLE=PROCESS.

MODE=mode-name

Specifies the access mode in which the logical name should be created. The keywords are EXECUTIVE, SUPERVISOR, USER. The default is MODE=SUPERVISOR.

 

/NODE=node-name-or-address

Specifies the name or numeric IP address of the remote node. You must specify this qualifier.

If you specify a node name, it is translated into an IP address. Only one IP address may be configured per NTY device. If the destination system is a host with multiple IP addresses, and not all addresses are directly reachable from your local system, you should specify the IP address numerically to ensure that a reachable address is configured.

 

/PORT=port-number

Specifies a TCP port number on the remote node to which the connection will be made. You must specify either the /PORT qualifier or the /SERVICE qualifier with the command.

 

/SERVICE=service-name

Specifies the name of a TCP service that translates to a port number to which the connection will be made. You may specify any TCP service name present in the local hosts/services table. You must specify either the /PORT qualifier or the /SERVICE qualifier with the command.