[Digital logo]
[HR]

OpenVMS DCL Dictionary

Previous | Contents

Some services are password protected. You are prompted for a password unless you specify the password with the /PASSWORD qualifier.

Once the connection to the service is made, you can interact with the service as if your terminal is directly connected to it. Some services will prompt you. For example, if the service is an OpenVMS system, it prompts you for a user name and password. You must have an account on the service node to log in.

Press the disconnect character to end the LAT session and return to DCL command level on your local system. With some services, such as general timesharing services like OpenVMS, you can end the LAT session by logging out of the service. The default disconnect character is Ctrl/\. Use the /DISCONNECT qualifier to change the default disconnect character.

You cannot use SET HOST/LAT to connect to the local node.

QUALIFIERS

/AUTOCONNECT

/NOAUTOCONNECT

Specifies whether connection attempts should be retried automatically when a connection fails because a service is unknown or unavailable, or because a node is unknown or unreachable. Also specifies that reconnects should be attempted automatically if a service has disconnected abnormally. The default is /NOAUTOCONNECT.

/AUTOPROMPT (default)

/NOAUTOPROMPT

Causes an OpenVMS Username: prompt to appear with no user action when a SET HOST/LAT command is issued.

On a terminal server port, you can configure the port to have AUTOPROMPT disabled (/NOAUTOPROMPT) so that you are required to press Return when connecting to a node to get the Username: prompt. However, when connecting to a reverse LAT service, the AUTOPROMPT characteristic should be disabled.

/BREAK=break-character

Defines a character that generates a break on lines that expect a break rather than a carriage return. To generate a break, press the Ctrl and break-character keys together. The default break-character value is the tilde (~).

You can select any ASCII character between @ and Z, except C, M, Q, S, Y, and the left bracket ([). You cannot select a character that is already defined as the disconnect character.

/DESTINATION_PORT=port-name

Specifies the port on a node to which you want to connect. The /NODE qualifier is required when you specify the /DESTINATION_PORT qualifier. The port must be available and must offer the service you specify. OpenVMS and certain other LAT service node systems ignore the /DESTINATION_PORT qualifier.

/DIAL=(NUMBER:number[,MODEM_TYPE:modem-type])

Allows a modem attached to the outgoing terminal line to be autodialed using the autodial protocol of that modem. The NUMBER keyword is the telephone number to be autodialed and is a required parameter.

The MODEM_TYPE keyword is optional. It can be used to specify any of the following modem types:

Each modem type requires a specific modem dialer code. Check with your system manager to see which modem dialer codes are installed on your system.

In addition, the MODEM_TYPE keyword can be used to specify a modem type other than DF03, DF112, or DMCL. A template is provided for users interested in supporting other modems with autodial capabilities (see SYS$EXAMPLES:DTE_DF03.MAR).

/DISCONNECT=disconnect-character

Defines the character that you can use to disconnect from a remote session. To generate a disconnect, press the Ctrl and disconnect-character keys together. The default disconnect-character is the backslash (\).

You can select any ASCII character from @ through Z, except C, M, Q, S, Y, and the left bracket ([). For example, if you specify /DISCONNECT=A, Ctrl/A will be the disconnect character. You cannot select a character that is already defined as the break character.

/EIGHT_BIT (default)

/NOEIGHT_BIT

Determines whether the outgoing terminal line supports 8-bit or 7-bit characters. By default, 8-bit characters are supported. If you specify /NOEIGHT_BIT, then 7-bit characters are supported.

Note

To change the number of bits per character on the remote terminal server port, that port must have the REMOTE MODIFICATION characteristic enabled.

/FRAME=n

The /FRAME=n qualifier allows a user making a LAT connection to a remote system to specify the number of data bits that the terminal driver expects for every character that is input or output. The value of n can be from 5 to 8. The default value depends on the settings for the terminal established by the /PARITY and /EIGHT_BIT qualifiers. The following example specifies a character frame size of 7 bits per character: 
$ SET HOST/LAT /FRAME=7 DIAL_OUT_SVC

/LOG[=log-file]

Logs all data that is delivered during the LAT session. If you do not specify a log file, the data is stored in the file SETHOST_LAT.LOG.

/NODE=node-name

Specifies the node that offers the service to which you want to connect. The node you specify must be a remote node. Failover is not performed if the connection fails.

/PASSWORD=password

Specifies the password required by a service that is password protected. If you do not specify the /PASSWORD qualifier when requesting a connection to a password-protected service, you are prompted for a password.

/QUEUE

/NOQUEUE (default)

When connecting to a reverse LAT service that is already in use (such as a dial out modem), you are notified that the service is in use and the SET HOST/LAT command terminates. However, LAT can allow incoming connections to be queued to any reverse LAT service that supports service queueing, which enables users to be placed on a queue when using reverse LAT services.

LAT reports your position in the queue. When the resource becomes available, you are immediately notified. You can cancel the queued connection by pressing Ctrl/Y and terminating the SET HOST /LAT command.

/SPEED=(output-rate,input-rate)

Sets the baud rate at which the terminal receives and transmits data. If the input and output rates are the same, specify the qualifier as /SPEED=rate.

Not all terminals support different input and output baud rates. For specific information on baud rates for your terminal, consult the manual for that terminal.

The default transmission rates are installation dependent.

The valid values for input and output baud rates are as follows: 

300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600

If you select an invalid or unsupported speed, the terminal line speed will remain set at its previous value.

Note

To change the speed on the terminal server port, the REMOTE MODIFICATION characteristic must be enabled on that terminal server port.

When initiating a connection, SET HOST/LAT may attempt to set terminal server port characteristics, such as the speed and the default speed for a LAT device. If the device connected to the terminal server port has a fixed speed (such as a dial-out modem) and you do not want the host to try to change this, disable the REMOTE MODIFICATION characteristic on that port using the following command: 

Local> DEFINE PORT x REMOTE MODIFICATION DISABLE 
Local> LOGOUT PORT x

Use the following command for terminal servers that support the CHANGE command: 

Local> CHANGE PORT x REMOTE MODIFICATION DISABLE

Examples

#1 
$ SET HOST/LAT SORTER
%LAT-S-CONNECTED, session to SORTER established
%LAT-I-TODISCON, type ^\ to disconnect the session
Username: SMITH
Password:
   .
   .
   .
 
$ LOGOUT
SMITH logged out at 30-DEC-1994  11:04:51.45
%LAT-I-DISCONNECTED, session disconnected from SORTER
-LAT-I-END, control returned to node HOME
$

This SET HOST/LAT command connects the user to the service SORTER, which is a computer system. The first message confirms that the user has been connected to that service. The second message informs the user how to disconnect the session. (The user can also disconnect the session by logging out from SORTER.) SORTER then prompts for the username and password. Use the normal login procedure to log in to the system. When the user logs out of the service SORTER, the terminal displays the DCL command prompt of the user's local processor system (HOME).

#2 
$ SET HOST/LAT/DESTINATION_PORT=BOSTON-
_$ /NODE=STATE/DISCONNECT=F BUDGET

This command connects the user's terminal to the service BUDGET that is offered on port BOSTON, on service node STATE. The user can disconnect the session by typing Ctrl/F.

#3 
$ SET HOST/LAT PURSE
Password:

This command attempts to connect the user's terminal to the service PURSE. The service PURSE is password protected, so the user is prompted for a password. The user could have specified the password within the SET HOST/LAT command, as shown in the next example.

#4 
$ SET HOST/LAT/PASSWORD=BEOR PURSE

This command connects the user's terminal to the password-protected service PURSE. The password is BEOR.

SET HOST/RLOGIN

Allows you to log in to a remote host over a TCP/IP connection and start an interactive terminal session by accessing the RLOGIN application.

Format

SET HOST/RLOGIN

Note

You can specify the IPhostname or the IPaddress, but not both.

PARAMETER

IPhostname

Specifies the IP host name of the remote host.

IPaddress

Specifies an IP address of the remote host.

DESCRIPTION

The SET HOST/RLOGIN command allows you to log in to a remote host by invoking RLOGIN client software that runs on your system. Once you start the terminal session, you can enter commands interactively on the remote host. The parameter that specifies the remote host is either an IP host name or an IP address.

QUALIFIERS

/AUTHENTICATE

Specifies that Kerberos authentication should be used for acquiring access to the remote node.

/PASSWORD=password

Optional qualifier that specifies the password of the user logging in to the remote host.

/TERMINAL_TYPE=type

Sets the terminal emulator to one of the following terminal types: VT100, VT200, VT300, VT400, VT500.

/TRUNCATE_USERNAME

Specifies that the current user name should be truncated to 8 characters before attempting to connect to the remote node. The qualifier is required for communication with systems that limit the size of their login names to 8 characters. The /TRUNCATE_USERNAME qualifier is ignored if /USERNAME is specified.

/USERNAME=username

Specifies the user name for logging in to the remote node. The user name can be enclosed in quotes to preserve the case of the user name for case-sensitive systems such as UNIX systems. If the /USERNAME qualifier is not specified, the default is the current user's user name.

Example

$ SET HOST/RLOGIN remotehst1

This example creates an RLOGIN connection to remote host remotehst1 over a TCP/IP connection.

SET HOST/TELNET

Connects you to a remote host over a TCP/IP connection by invoking the TELNET application.

Format

SET HOST/TELNET

Note

You can specify the IPhostname or the IPaddress, but not both.

PARAMETER

IPhostname

Specifies the IP host name of the remote host.

IPaddress

Specifies an IP address of the remote host.

DESCRIPTION

The SET HOST/TELNET command allows you to connect to a server on a remote system by invoking the TELNET client software that runs on your system. The parameter that specifies the remote host is either an IP host name or an IP address. Most of the attributes are negotiated with the remote node. The qualifiers are used only in exception cases (for example, cases where a remote server does not support a negotiated parameter but requires a certain characteristic for the connection).

QUALIFIERS

/AUTHENTICATE

Specifies that Kerberos authentication should be used for acquiring access to the remote node.

/PORT=port

Specifies the remote TCP port to use. The default is 23.

/TERMINAL_TYPE=type

Sets the terminal emulator to one of the following terminal types: VT100, VT200, VT300, VT400, VT500.

Example

$ SET HOST/TELNET remotehst2

This example creates a TELNET connection to remote host remotehst2 over a TCP/IP connection.

SET HOST/TN3270

Connects you to a remote IBM host over a TCP/IP connection, causing the local keyboard to emulate an IBM 3279-class terminal keyboard by invoking the TN3270 terminal emulator.

Format

SET HOST/TN3270

Note

You can specify the IPhostname or the IPaddress, but not both.

PARAMETER

IPhostname

Specifies the IP host name of the remote host.

IPaddress

Specifies an IP address of the remote host.

DESCRIPTION

The SET HOST/TN3270 command allows you to connect with a TELNET server on a remote IBM system by invoking the TN3270 terminal emulator TELNET client program on the local host. The parameter that specifies the remote host is either an IP host name or an IP address. The TN3270 client will automatically determine the terminal type (IBM-3278-2, IBM-3278-3, IBM-3278-4, or IBM-32798-5).

QUALIFIERS

/AUTHENTICATE

Specifies that Kerberos authentication should be used for acquiring access to the remote node.

/PORT=port

Specifies the remote TCP port to use. The default is 23.

/TERMINAL_TYPE

Sets the terminal emulator to one of the following terminal types: VT100, VT200, VT300, VT400, VT500.

Example

$ SET HOST/TN3270 remotehst3

This example creates a connection to a TELNET server on the remote IBM system remotehst3 over a TCP/IP connection.

SET KEY

Sets and locks the key definition state for keys defined with the DEFINE/KEY command.

Format

SET KEY

DESCRIPTION

When you define keypad keys using the DEFINE/KEY command, you can assign a specific state name to the key definition. If that state is not set when you press the key, the definition is not processed. Use the SET KEY command to change the current state to the appropriate state.

QUALIFIERS

/LOG (default)

/NOLOG

Controls whether the system displays a message indicating that the key state has been set.

/STATE=state-name

/NOSTATE

Specifies the name of the state. The state name can be any alphanumeric string. If you omit the /STATE qualifier or use the /NOSTATE qualifier, the current state is left unchanged. The default state is DEFAULT.

Example

$ SET KEY /STATE=EDITING

The SET KEY command in this example sets the key state to the state EDITING. You can now use the key definitions that were defined for the state EDITING.

SET LOGINS

Sets the interactive limit (number of interactive users allowed on the system), or displays the interactive limit and the current number of interactive users.

Requires OPER (operator) privilege to set the login limit.

Format

SET LOGINS

PARAMETERS

None.

DESCRIPTION

The SET LOGINS command is not retroactive. All users logged in to the system before you enter the SET LOGINS command are not affected by the command. However, once the limit you set is reached, no more users can log in to the system until someone else logs out. Users with the OPER privilege are not affected by the limit.

If you do not specify a parameter value with the /INTERACTIVE=n qualifier, the SET LOGINS command displays the following information: 

Login quotas - Interactive limit=x, Current interactive value=y

The value x represents the current interactive limit, and the value y represents the number of users currently logged in to the system.

QUALIFIER

/INTERACTIVE[=n]

Establishes the number of interactive users allowed to gain access to the system. If the parameter n is specified, the interactive limit is set to the value n. If the parameter n is not specified, the SET LOGINS command displays the current interactive limit and the number of interactive users.

Examples

#1 
$ SET LOGINS/INTERACTIVE=5
%SET-I-INTSET, login interactive limit=5, current interactive value=3

In this example, the SET LOGINS command specifies that only five interactive users can be logged in to the system.

#2 
$ SET LOGINS/INTERACTIVE
%SET-I-INTSET, login interactive limit=9, current interactive value=6

When the SET LOGINS command is entered without a parameter, as shown in this example, the /INTERACTIVE qualifier requests that the current status of the login quotas be displayed. The message returned indicates that the maximum number of interactive users allowed on the system is 9 and that the number of interactive users currently logged in is 6. No change is made.

SET MAGTAPE

Defines the default characteristics associated with a specific magnetic tape device for subsequent file operations.

The SET MAGTAPE command is valid for magnetic tape devices mounted with foreign volumes.

Format

SET MAGTAPE device-name[:]

PARAMETER

device-name[:]

Specifies the name of the magnetic tape device for which the characteristics are to be set. The device must not be currently allocated to any other user.

QUALIFIERS

/DENSITY=density

Specifies the default density, in bits per inch (bpi), for all write operations on the magnetic tape device when the volume is mounted as a foreign tape or as an unlabeled tape. The density can be specified as 800, 1600, or 6250, if supported by the magnetic tape drive.

/END_OF_FILE

Writes a tape mark at the current position on the magnetic tape volume.

/LOG

/NOLOG

Displays information about the operations performed on the magnetic tape volume.

/LOGSOFT (default)

/NOLOGSOFT

Controls whether soft errors on the specified device are to be logged in the error log file. Soft errors are errors corrected by the hardware without software intervention. This qualifier affects only devices that support hardware error correction, such as the TU78 magnetic tape drive. When used with other devices, this qualifier has no effect.

/MEDIA_FORMAT=[NO]COMPACTION

Controls whether data records are automatically compacted and blocked together on a TA90E tape drive. Data compaction and record blocking increase the amount of data that can be stored on a single tape cartridge.

Note that once data compaction or noncompaction has been selected for a given cartridge, that same status applies to the entire cartridge.

/RETENSION

Moves a TZK10 tape cartridge to the end of the tape, and then back to the beginning of the tape. Use the /RETENSION qualifier on a regular basis to help maintain the integrity of TZK10 tape cartridges.

The /RETENSION qualifier must be used in conjunction with the /REWIND or /UNLOAD qualifier. The /RETENSION qualifier completes its action before /REWIND or /UNLOAD. Use /RETENSION/REWIND when you want the tape cartridge to remain loaded in the drive. Use /RETENSION/UNLOAD when you want to unload the tape cartridge after the retension operation.

This qualifier only affects TZK10 tape cartridge drives and has no effect on non-SCSI drives.

/REWIND

Requests that the volume on the specified device be rewound to the beginning of the magnetic tape.

/SKIP=option

Requests that the magnetic tape volume be positioned according to any of the following options:
BLOCK: n Skips the specified number of blocks.
END_OF_TAPE Positions the volume at the end-of-tape (EOT) mark.
FILES: n Skips the specified number of tape marks (not files).

The tape is positioned just past the nth tape mark. If n is negative, the tape is still positioned after the nth tape mark, not before it. If the tape is already positioned immediately after a tape mark, a skip of -1 results in no net movement. (The tape moves to the preceding mark, but is then repositioned to the end of the mark, where it began.) For more information on tape marks and files, see the OpenVMS System Manager's Manual.

RECORD: n Skips the specified number of records up to 32767.

/UNLOAD

Requests that the volume on the specified device be rewound and unloaded.

Examples

#1 
$ MOUNT MTB1:/FOREIGN
$ SET MAGTAPE MTB1: /DENSITY=800

The MOUNT command in this example mounts a foreign tape on the device MTB1. The SET MAGTAPE command defines the density for writing the magnetic tape at 800 bpi.

#2 
$ MOUNT MTA0:/FOREIGN
$ SET MAGTAPE MTA0:/SKIP=FILES:4

The MOUNT command in this example mounts a foreign tape on the device MTA0; the SET MAGTAPE command directs the magnetic tape position to skip four files.

SET MESSAGE

Sets the format for system messages or specifies a process level message file. Lets you override or supplement the system messages.

Format

SET MESSAGE [filespec]

PARAMETER

filespec

Specifies the name of the process level message file. Messages in this file supersede messages for the same conditions in the system message file or in an existing process message file. The file type defaults to .EXE. The asterisk (*) and the percent sign (%) wildcard characters are not allowed. If you do not specify this parameter, the qualifiers apply to the system message file.

DESCRIPTION

The SET MESSAGE command specifies which message fields the OpenVMS system displays. The message format is as follows: 
%FACILITY-L-IDENT, text

When a process is created, the default is to display all four message fields: facility, severity, identification, and text. To control which fields of a message are displayed, specify the appropriate qualifiers. For example, to omit the FACILITY field in message displays, specify SET MESSAGE /NOFACILITY.

By including the SET MESSAGE command in your login command file, you can select specific portions of the messages for your process.

Use the SET MESSAGE command, also, to override or supplement system messages. Whenever any software detects an error and invokes the $GETMSG system service, the message files are searched in the following order: image message sections first, process-permanent message files second, and the system message file last. Thus, with the SET MESSAGE command, you can introduce messages earlier in the searching order; you can either override or supplement the system messages. (Note that the new message definitions affect only your process.)

If a process-permanent message file exists when you specify the SET MESSAGE command with a file specification, the old file is removed and the new file is added.

The message definitions you specify must result from a successful compilation with the MESSAGE command. For full details on how to create your own messages with the Message utility, see the OpenVMS Command Definition, Librarian, and Message Utilities Manual.

QUALIFIERS

/DELETE

Removes any process-permanent message files currently in effect. Do not specify the filespec parameter with the /DELETE qualifier.

/FACILITY (default)

/NOFACILITY

Formats messages so that the facility name prefix appears.

/IDENTIFICATION (default)

/NOIDENTIFICATION

Formats messages so that the message identification prefix appears.

/SEVERITY (default)

/NOSEVERITY

Formats messages so that the severity level appears.

/TEXT (default)

/NOTEXT

Formats messages so that the message text appears.

Examples

#1 
$ TYPE XXX
%TYPE-W-OPENIN, error opening DB1:[MALCOLM]XXX.LIS; as input
-RMS-E-FNF, file not found
   .
   .
   .
$  SET MESSAGE/NOIDENTIFICATION
   .
   .
   .
$ TYPE XXX
%TYPE-W, error opening DB1:[MALCOLM]XXX.LIS; as input
-RMS-E, file not found

When the first TYPE command is entered in this example, the error messages include all fields. Later, the SET MESSAGE command establishes that the IDENT portion (the abbreviation for the message text) is omitted in future messages.

#2 
$ SET MESSAGE NEWMSG

The SET MESSAGE command in this example specifies that the message text in NEWMSG.EXE supplements the existing system messages.

SET NETWORK

Registers the attributes of a network service.

Requires SYSNAM (system name) privilege.

Format

SET NETWORK network-service

PARAMETER

network-service

Specifies the name of a network service.

DESCRIPTION

The SET NETWORK command allows you to control information about network services on an OpenVMS system. This information is contained in structures pointed to by executive mode logical names SYS$NET_SERVICES_1 to SYS$NET_SERVICES_12. Each structure defines a particular network service and contains the following information: The following items are required for network registration: product name, manufacturer, type of network, node name, address. For each network service that supports the Point-to-Point Protocol (PPP), the file name of the PPPD shareable image must also be specified using the /PPPD_CALLOUT qualifier.

The SET NETWORK command allows you to perform the following actions on the information on network services:

The /REGISTER qualifier is the default, if you do not specify an action.

QUALIFIERS

/ADDRESS=address[es]

Specifies the network address of the local node.

/CONNECTIONS=

Specifies a command to be executed to display the number of network connections.

/COUNTERS=

Specifies a command to be executed to display the number of network counters.

/DATA=

Specifies a character string provided by the network service vendor.

/INTERFACE=

Specifies the OpenVMS driver for the network service.

/MANUFACTURER=

Specifies the manufacturer of the network service.

/NETWORK_TYPE=

Specifies the protocol for the network service.

/NODE=

Specifies the name of the local node.

/PPPD_CALLOUT=image-name

Specifies the name of the protected shareable image activated by PPPD. This image contains the routine PPPD$OPEN_CONNECT, which notifies the network service that a new physical transport exists that supports PPP. If the image resides in the SYS$SHARE directory, enter the file name of the image without the suffix (such as, PPPD_CALLOUT instead of PPPD_CALLOUT.EXE). Otherwise, enter the system logical that identifies the location of the image.

/REGISTER

Defines a new network service.

/REMOVE

Deletes a network service from the database.

/START=

Specifies an image to be executed when you issue the START/NETWORK command for the network service.

/STATUS=

Specifies a command to be executed to display additional status information.

/STOP=

Specifies an image to be executed when you issue the STOP/NETWORK command for the network service.

/UPDATE

Allows you to modify the specified data for the network service.

Previous | Next | Contents | [Home] | [Comments] | [Ordering info] | [Help]

[HR] 

  9996P045.HTM
  OSSG Documentation
  26-NOV-1996 11:18:10.93

Copyright © Digital Equipment Corporation 1996. All Rights Reserved.

Legal