Defines or changes the session, batch job, or system values or
characteristics. See the Description of each command for details.
Format
SET option
1 – Description
The following table lists all the SET command options, including
those generally reserved for use by system operators and
managers.
Option Function
ACCOUNTING Controls the current accounting file.
AUDIT Provides the management interface to the
security auditing system.
BOOTBLOCK Initializes the boot block on the target
(Integrity servers) device.
BROADCAST Determines which messages will be broadcast to
SYS$OUTPUT.
CACHE/RESET Resets systemwide I/O caching statistics for
the extended file cache (XFC).
CARD_READER Defines the default ASCII translation mode for
a card reader.
CLUSTER/EXPECTED_ Sets the total expected votes in the OpenVMS
VOTES Cluster to a value that you specify or, if no
value is specified, sets the total votes to a
value determined by the system.
COMMAND Adds commands that are defined in a command
description file to your process command set
or a command tables file.
CONTROL Enables or disables interrupts caused by
Ctrl/T or Ctrl/Y.
CPU Changes the user capabilities associated with
the specified CPUs.
DAY Overrides the default day type specified in
the user authorization file (UAF).
DEFAULT Establishes a device and directory as the
current default for file specifications.
DEVICE Defines device characteristics.
DEVICE/SERVED Lets you make a disk on a local node available
to all the nodes on an OpenVMS Cluster.
DIRECTORY Modifies the characteristics of one or more
directories.
DISPLAY Redirects the output of a DECwindows
application.
ENTRY Changes the current status or attributes of a
job not currently executing in a queue.
FILE Modifies the characteristics of one or more
files.
HOST Connects your terminal (through the current
host processor) to another processor, called
the remote processor.
HOST/DTE Connects your system to a remote system by way
of an outgoing terminal line.
HOST/DUP Connects your terminal to a storage controller
through the appropriate bus for that
controller.
HOST/HSC Connects your terminal to a remote HSC50
disk and tape controller through the computer
interconnect (CI) bus.
HOST/LAT Connects your terminal to a specified service
available in the local area network (LAN),
establishing one session for communication
between your terminal and that service.
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.
HOST/TELNET Connects you to a remote host over a TCP/IP
connection by invoking the TELNET application.
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.
IMAGE Modifies or restores the image attributes of
an OpenVMS ELF format image file.
KEY Changes the current keypad state setting.
LOGINS Allows or disallows users to log in to the
system.
MAGTAPE Defines characteristics of a magnetic tape
device.
MESSAGE Overrides or supplements system messages.
NETWORK Registers the attributes of a network service.
ON Controls whether the command interpreter
checks for an error condition following the
execution of commands in a command procedure.
OUTPUT_RATE Sets the rate at which output is written to a
batch job log file.
PASSWORD Lets users change their own passwords; lets
system managers change the system password.
PREFERRED_PATH Specifies a particular host or preferred path
to access a specific MSCP class disk or TMSCP
class tape device.
PREFIX Allows you to set a prefix control string for
verified command lines.
PRINTER Defines printer characteristics.
PROCESS Defines execution characteristics of the
current process.
PROMPT Defines the DCL prompt.
PROTECTION/DEFAULT Establishes the default protection to be
applied to all files subsequently created.
QUEUE Changes the current status or attributes of
the specified queue.
RESTART_VALUE Establishes a test value for restarting
portions of batch jobs.
RIGHTS_LIST Lets users modify the process rights list;
lets privileged users modify the system rights
list.
RMS_DEFAULT Provides default multiblock and multibuffer
count values to be used by RMS for file
operations.
SECURITY Modifies the security profile of an object.
SERVER ACME Controls starting, stopping, and restarting of
(Alpha/Integrity the ACME server, which controls authentication
servers only) policies for $ACM system service clients.
SERVER REGISTRY Controls starting, stopping, and restarting
(Alpha/Integrity of the Registry server, which provides access
servers only) to the Registry database for $REGISTRY system
service clients.
SERVER SECURITY Controls starting, stopping, and restarting
of the security server, which maintains
information stored in the system intrusion
and proxy databases.
SHADOW Changes the characteristics of shadow sets
(Alpha/Integrity created using Volume Shadowing for OpenVMS.
servers only)
SYMBOL Controls access to local and global symbols in
command procedures.
TERMINAL Defines terminal characteristics.
TIME Resets the system clock to the specified
value.
VERIFY Controls whether the command interpreter
displays lines in command procedures as it
executes them.
VOLUME Modifies the characteristics of one or more
Files-11 volumes.
WORKING_SET Changes the current working set limit or
quota.
2 – ACCOUNTING
Controls the current accounting file.
Requires OPER (operator) privilege.
Format
SET ACCOUNTING
2.1 – Qualifiers
2.1.1 /DISABLE
/DISABLE[=(keyword[,...])]
Prevents the tracking of the resources specified by the keywords.
The following table lists the keywords you can use to specify the
type of resource.
Keyword Type of Resource
IMAGE Resources used by an image
LOGIN_FAILURE Resources used by an unsuccessful attempt to log
in
MESSAGE Unformatted record written to the accounting
file by a call to the $SNDJBC system service
PRINT Resources used by a print job
PROCESS Resources used by a process
You do not need to stop the tracking of all processes and images.
You can prevent resources being tracked for specific types of
process and for images running in these types of process.
The following table lists the keywords you can use to specify the
type of process.
Keyword Type of Process
BATCH Batch process
DETACHED Detached process
INTERACTIVE Interactive process
NETWORK Network process
SUBPROCESS Subprocess (the parent process can be a batch,
detached, network, or interactive process)
If the system is no longer tracking any resources, /DISABLE
closes the current accounting file.
If you use the /DISABLE qualifier and omit the keywords, the
current accounting file does not track any resources, and the
system closes the file.
2.1.2 /ENABLE
/ENABLE[=(keyword[,...])]
Enables the tracking of the specified resources, and opens the
current accounting file if it is not already open.
The following table lists the keywords you can use to specify the
type of resource.
Keyword Type of Resource
IMAGE Resources used by an image
LOGIN_FAILURE Resources used by an unsuccessful attempt to log
in
MESSAGE (Unformatted record written to the accounting
file by a call to the $SNDJBC system service)
PRINT Resources used by a print job
PROCESS Resources used by a process
You do not need to track all processes and images. You can track
resources for specific types of process and for images running in
those types of process.
The following table lists the keywords you can use to specify the
type of process.
Keyword Type of Process
BATCH Batch process
DETACHED Detached process
INTERACTIVE Interactive process
NETWORK Network process
SUBPROCESS Subprocess (the parent process can be a batch,
detached, network, or interactive process)
If you use the /ENABLE qualifier and omit the keywords, the
current accounting file tracks all resources.
2.1.3 /LOG
Writes information to the current SYS$OUTPUT device as the
command executes.
2.1.4 /NEW_FILE
Closes the current accounting file, and starts up a new version
of it.
The name of the new file depends on whether the logical name
ACCOUNTNG is defined in your system logical name table.
If this logical name is not defined, the SET ACCOUNTING command
opens the file SYS$MANAGER:ACCOUNTNG.DAT.
If this logical name is defined, the command opens the file
that this logical name points to. If you omit the directory,
SYS$MANAGER is the default, and if you omit the file type, .DAT
is the default.
The /NEW_FILE qualifier writes a record to the end of the old
file that contains a forward pointer to the new file, and a
record to the beginning of the new file that contains a backward
pointer to the old file. These records contain the names of the
new and old files respectively.
2.2 – Examples
1.$ SET ACCOUNTING /DISABLE /ENABLE=(PROCESS,BATCH,INTERACTIVE)
$ SET ACCOUNTING /ENABLE=IMAGE
This example tells the system to track the resources used only
by batch and interactive processes, and by images running
in batch and interactive processes. It illustrates the
cumulative effect of /ENABLE and /DISABLE qualifiers, and of
SET ACCOUNTING commands.
The /DISABLE qualifier prevents the tracking of all resources.
The /ENABLE qualifier then tells the system to track the
resources used by batch and interactive processes. The second
SET ACCOUNTING command tells the system to track the resources
used by images.
2.$ SET ACCOUNTING /NEW_FILE
$ RENAME SYS$MANAGER:ACCOUNTNG.DAT;-1 WEEK_24_RESOURCES.DAT
This example closes the current accounting file, opens a
new version of it, and changes the name of the old file to
WEEK_24_RESOURCES.DAT.
3 – ACL
The SET ACL command is obsolete. Use the SET SECURITY/ACL
command.
4 – AUDIT
Provides the management interface to the security auditing
system.
Requires the SECURITY privilege.
Format
SET AUDIT/qualifier
There are five categories of qualifiers, grouped by task, for the
SET AUDIT command:
Task Qualifiers Requirements
Define /AUDIT, Specify whether you are defining
auditing /ALARM, alarms (/ALARM), audits (/AUDIT),
events /CLASS, or both. Also specify whether you
/ENABLE, are enabling (/ENABLE) or disabling
/DISABLE (/DISABLE) the reporting of the
event.
Define /DESTINATION, Requires both the /DESTINATION and
auditing /JOURNAL, /JOURNAL qualifiers.
log file /VERIFY
Define /INTERVAL, None.
operational /LISTENER,
character- /SERVER,
istics of /VERIFY
the audit
server and
a listener
mailbox (if
any)
Define /ARCHIVE, None.
secondary /DESTINATION,
log file /VERIFY
Define /BACKLOG, With the /RESOURCE or /THRESHOLD
resource /EXCLUDE, qualifier, include the /JOURNAL
monitoring /JOURNAL, qualifier.
defaults /RESOURCE,
/THRESHOLD,
/VERIFY
4.1 – Qualifiers
4.1.1 /ALARM
Makes the command apply to alarms, which are messages displayed
on an operator terminal. See the description of the DCL command
REPLY/ENABLE for details on how to enable terminals to display
security messages.
4.1.2 /ARCHIVE
/ARCHIVE=[keyword,...]
Specifies which classes of audit event messages are written to
the security archive file. Specify one or more of the following
keywords:
Keyword Description
NONE Disables archiving on the system.
[NO]ALL (default) Enables or disables archiving of all system
security events. By default, no events are
archived.
SYSTEM_ALARM Enables archiving of all security alarm
events.
SYSTEM_AUDIT Enables archiving of all security audit
events.
Archiving should be run on only one node in an OpenVMS Cluster
with its own audit server database because multiple nodes will
try to open the audit file exclusively.
4.1.3 /AUDIT
Makes the command apply to audits, which are messages recorded in
the system security audit log file.
4.1.4 /BACKLOG
/BACKLOG=[keyword[,...]]
Specifies the thresholds for suspending a process that has
exceeded the process message limit. The thresholds include the
total number of messages in memory and the number belonging
to the particular process. To prevent a process from being
suspended, use the /EXCLUDE qualifier. Specify the following
keywords:
Keyword Description
TOTAL=(n1,n2,n3) Thresholds at which flow control is initiated
and accelerated; see description below.
PROCESS=(p1,p2) Thresholds at which process submissions are
controlled.
Total Process
Messages Default Messages Default Action Taken
N1 100 P1 5 When there are 100 messages
in memory, the audit server
suspends any process that has
submitted 5 or more messages
until all messages are written
to disk.
N2 200 P2 2 When there are 200 messages
in memory, the audit server
suspends any process that has
submitted 2 or more messages
until all messages are written
to disk.
N3 300 Any process with messages in
memory is suspended until all
messages are written to disk.
4.1.5 /CLASS
/CLASS=class
Specifies the class of the object whose auditing attributes are
to be modified. If /CLASS is not specified, the command assumes
the class is FILE. Specify one of the following keywords with the
/CLASS qualifier:
CAPABILITY
COMMON_EVENT_CLUSTER
DEVICE
FILE
GROUP_GLOBAL_SECTION
LOGICAL_NAME_TABLE
QUEUE
RESOURCE_DOMAIN
SECURITY_CLASS
SYSTEM_GLOBAL_SECTION
VOLUME
4.1.6 /DESTINATION
/DESTINATION=filespec
When changing the destination of event messages, specifies
the new location of the system security audit log file. The
device, if part of the file specification, must be a disk. The
/DESTINATION qualifier requires the /JOURNAL qualifier in this
case.
Once you have relocated the log file, execute the command SET
AUDIT/SERVER=NEW_LOG to let all the nodes in the cluster know of
the new location. The previous audit log file is closed and all
subsequent audit event messages generated throughout the cluster
are sent to the new audit log file.
When used with /ARCHIVE, specifies the name of the archive log
file. Events can be archived to a local or remote file on any
file-structured disk device. For example, you can use an archive
file to redirect event messages from a satellite to a larger node
in the cluster.
4.1.7 /DISABLE
/DISABLE=(keyword[,...])
Disables alarms or audits for the specified events. To disable
all system events and file access events, specify the keyword
ALL. You must specify at least one of the keywords. For a list of
the keywords to use with the /DISABLE qualifier, see the /ENABLE
qualifier description. You must also specify either the /ALARM or
/AUDIT qualifier, or both, when you use the /DISABLE qualifier.
NOTE
In processing the SET AUDIT command, the system processes
the /DISABLE qualifier last. If you specify both the /ENABLE
and /DISABLE qualifiers for items in the same class on the
same command line, the /DISABLE qualifier disables any
enabled items. VSI recommends that you use separate lines
for commands containing the /ENABLE and /DISABLE qualifiers.
4.1.8 /ENABLE
/ENABLE=(keyword[,...])
Enables alarms or audits for the specified events. To enable all
system events and file access events, specify the keyword ALL.
You must specify at least one keyword. You must also specify
either the /ALARM or /AUDIT qualifier, or both, when you use the
/ENABLE qualifier.
The keywords that you can specify with either the /ENABLE or the
/DISABLE qualifier are as follows:
Keyword Description
ACCESS=(condition Specifies access events for all objects in
a class. (To audit a single object, use an
[:access[,...]] auditing ACE and enable the access control list
[,...]) (ACL) category.)
VSI recommends that when you enable auditing
conditionally, you enable it for all possible
forms of access because the system can check
access rights at several points during an
operation. (For example, a FAILURE might occur
on a read or write access check.)
See the VSI OpenVMS Guide to System Security for
information about the various types of access
permitted on each class. (For example, the
Access keyword, CREATE, is not defined for FILE
objects.)
Condition Description
Keyword
ALL All object access
BYPASS Successful object access due to
the use of the BYPASS privilege
FAILURE Unsuccessful object access
GRPPRV Successful object access due to
the use of the group privilege
(GRPPRV)
READALL Successful object access due to
the use of the READALL privilege
SUCCESS Successful object access
SYSPRV Successful object access due to
the use of the system privilege
(SYSPRV)
Access Description
Keyword
ALL All types of access
ASSOCIATE Associate access
CONTROL Control access to examine or
change security characteristics
CREATE Create access. To audit create
events for files, use the CREATE
keyword.
DELETE Delete access
EXECUTE Execute access
LOCK Lock access
LOGICAL Logical I/O access
MANAGE Manage access
PHYSICAL Physical I/O access
READ Read access
SUBMIT Submit access
WRITE Write access
ACL Specifies an event requested by an audit or
alarm ACE in the access control list (ACL) of
an object. To audit all objects of a class, use
the ACCESS keyword.
ALL Specifies all system events and file access
events. It does not enable access events for
object classes other than FILE.
AUDIT=keyword Specifies events within the auditing subsystem.
Only one keyword is currently defined.
Keyword Description
ILLFORMED Specifies illformed events from
internal calls (identified by
NSA$M_INTERNAL) to $AUDIT_
EVENT, $CHECK_PRIVILEGE,
$CHKPRO, or $CHECK_ACCESS system
services. An illformed event
is caused by an incomplete or
syntactically incorrect argument
being supplied to one of these
system services by a piece of
privileged code.
AUTHORIZATION Specifies the modification of any portion of
the system user authorization file (SYSUAF),
network proxy authorization file (NETPROXY),
or the rights list (RIGHTLIST) (including
password changes made through the AUTHORIZE,
SET PASSWORD, or LOGINOUT commands or the
$SETUAI system service).
BREAKIN=(keyword Specifies the occurrence of one or more classes
[,...]) of break-in attempts, as specified by one or
more of the following keywords:
ALL
DETACHED
DIALUP
LOCAL
NETWORK
REMOTE
CONNECTION Specifies a logical link connection or
termination through DECnet-Plus, DECnet Phase
IV, DECwindows, $IPC, or SYSMAN.
CREATE Specifies the creation of an object. Requires
the /CLASS qualifier if it is not a file.
DEACCESS Specifies deaccess from an object. Requires the
/CLASS qualifier if it is not a file.
DELETE Specifies the deletion of an object. Requires
the /CLASS=DEVICE qualifier.
FILE_ACCESS= This keyword is obsolete and is superseded
(keyword[,...]) by the ACCESS keyword, which is valid on all
OpenVMS Version 6.1 or higher systems. On
Alpha, this keyword specifies the occurrence
of file and global section access events
(regardless of the value given in the object's
access control list [ACL], if any).
IDENTIFIER Specifies that the use of identifiers as
privileges should be audited. For further
information, see the VSI OpenVMS Guide to System
Security.
INSTALL Specifies modifications made to the known file
list through the INSTALL utility.
LOGFAILURE= Specifies the occurrence of one or more
(keyword[,...]) classes of login failures, as specified by
the following keywords:
ALL All possible types of login
failures
BATCH Batch process login failure
DETACHED Detached process login failure
DIALUP Dialup interactive login failure
LOCAL Local interactive login failure
NETWORK Network server task login
failure
REMOTE Interactive login failure
from another network node, for
example, with a SET HOST command
SERVER Server or TCB-based login
failure.
SUBPROCESS Subprocess login failure
LOGIN= Specifies the occurrence of one or more
(keyword[,...]) classes of login attempts, as specified by the
following keywords. See the LOGFAILURE keyword
for further description.
ALL BATCH
DETACHED DIALUP
LOCAL NETWORK
REMOTE SERVER
SUBPROCESS
LOGOUT= Specifies the occurrence of one or more classes
(keyword[,...]) of logouts, as specified by the following
keywords. See the LOGFAILURE keyword for
further description.
ALL BATCH
DETACHED DIALUP
LOCAL NETWORK
REMOTE SERVER
SUBPROCESS
MOUNT Specifies a mount or dismount operation.
NCP Specifies access to the network configuration
database, using the network control program
(NCP).
PRIVILEGE= Specifies successful or unsuccessful use
(keyword[,...]) of privilege, as specified by the following
keywords:
FAILURE [:privilege(,...)] - Unsuccessful
use of privilege
SUCCESS [:privilege(,...)] - Successful use
of privilege
For a listing of privileges, see the
online help for the DCL command SET
PROCESS/PRIVILEGES.
PROCESS= Specifies the use of one or more of the process
(keyword[,...]) control system services, as specified by the
following keywords:
ALL Use of any of the process
control system services
CREPRC All use of $CREPRC
DELPRC All use of $DELPRC
SCHDWK Privileged use of $SCHDWK
CANWAK Privileged use of $CANWAK
WAKE Privileged use of $WAKE
SUSPND Privileged use of $SUSPND
RESUME Privileged use of $RESUME
GRANTID Privileged use of $GRANTID
REVOKID Privileged use of $REVOKID
GETJPI Privileged use of $GETJPI
FORCEX Privileged use of $FORCEX
SETPRI Privileged use of $SETPRI
Privileged use of a process control system
service means the caller used GROUP or WORLD
privilege to affect the target process.
SYSGEN Specifies the modification of a system
parameter with the OpenVMS System Generation
utility.
TIME Specifies the modification of system time.
4.1.9 /EXCLUDE
/EXCLUDE=process-id
/NOEXCLUDE=process-id
Adds a process identification (PID) to the audit server's process
exclusion list. The process exclusion list contains those
processes that will not be suspended by the audit server if a
resource exhaustion reaches the action threshold. By default,
realtime processes and all of the following processes are
included in the process exclusion list and are never suspended:
CACHE_SERVER
CLUSTER_SERVER
CONFIGURE
DFS$COM_ACP
DNS$ADVER
IPCACP
JOB_CONTROL
NETACP
NET$ACP
OPCOM
REMACP
SHADOW_SERVER
SMISERVER
SWAPPER
TP_SERVER
VWS$DISPLAYMGR
VWS$EMULATORS
Use the SET AUDIT/NOEXCLUDE command to remove a process from the
process exclusion list; however, processes listed above cannot
be removed from the exclusion list. Also note that PIDs are
not automatically removed from the process exclusion list when
processes log out of the system.
4.1.10 /FAILURE_MODE
/FAILURE_MODE[=keyword]
This qualifier is obsolete.
On Alpha, specifies how the OpenVMS system proceeds following
a failed attempt to write a security alarm to the operator
communication process's (OPCOM's) mailbox. Specify one of the
following keywords with the /FAILURE_MODE qualifier:
Option Description
CRASH Forces a system failure if security alarms cannot be
written.
IGNORE Indicates that failing security alarms are to be ignored.
The first failed alarm causes an error message to be
written to the operator console and log file. The system
maintains a count of the lost alarms, which can be
displayed with the SHOW AUDIT command.
WAIT Indicates that processes are placed in the MWAIT state to
wait until the resource is available. This is the default.
The /ALARM qualifier is required when specifying an audit failure
mode.
4.1.11 /INTERVAL
/INTERVAL=(keyword[,...])
Specifies the delta times to be used for regular audit server
operations. For information about specifying delta times, see the
OpenVMS User's Manual.
The following table describes keywords for the /INTERVAL
qualifier:
Keyword Description
ARCHIVE_ Specifies the interval at which data collected
FLUSH=time by the audit server is written to the archive
file. The default is 1 minute.
JOURNAL_ Specifies the interval at which data collected
FLUSH=time by the audit server is written to the audit log
file. The default is 5 minutes.
RESOURCE_ Specifies the interval at which the audit server
MONITOR=time retries log file allocation or access. This
interval applies whenever free space in the
log file is below either the warning or action
thresholds, or when the volume holding the log
file is inaccessible. The default interval is 5
minutes.
RESUME_ Specifies the interval at which the audit
SCAN=time server reviews an existing resource exhaustion
condition. The default is 15 minutes.
4.1.12 /JOURNAL
/JOURNAL[=journal-name]
Specifies the name of the audit journal; the name defaults to
SECURITY. (Currently, there is only one journal.)
The /JOURNAL qualifier is required when redefining the audit log
file or when specifying resource monitoring characteristics with
the /RESOURCE or the /THRESHOLD qualifier.
4.1.13 /LISTENER
/LISTENER=device
/NOLISTENER
Specifies the name of a mailbox device to which the audit server
sends a binary copy of all security audit event messages.
Users can create such a mailbox to process system security
events as they occur. For a description of the message formats
written to the listener mailbox, see the Audit Analysis Utility
documentation in the VSI OpenVMS System Management Utilities
Reference Manual.
Use the SET AUDIT/NOLISTENER command to disable a listener
device.
4.1.14 /RESOURCE
/RESOURCE=keyword[,...]
Enables or disables the monitoring of disk volumes to ensure
adequate space for audit journal entries; it also specifies the
monitoring method to use. The /JOURNAL qualifier is required. For
more information about resource monitoring, see the VSI OpenVMS
Guide to System Security.
Keyword Description
DISABLE Disables monitoring on the disk volume
containing the audit journal.
ENABLE Enables resource monitoring on the disk volume
containing the audit journal.
MONITOR_ This keyword is obsolete.
MODE=mode
Specifies the method the audit server uses to
monitor available resources. Specify one of the
following keywords:
COUNT Controls whether resource monitoring
is based on the amount of free disk
space required to store a fixed
number of event messages.
PERCENTAGE Controls whether resource monitoring
is based on the percentage of the
disk volume or volume set available.
SPACE Controls whether resource monitoring
is based on the number of free blocks
on the disk. The is the default
method used for resource monitoring.
TIME Controls whether resource monitoring
is based on the amount of free disk
space needed to store events which
occur over a fixed period of time (in
seconds).
4.1.15 /SERVER
/SERVER=keyword[,...]
Modifies audit server characteristics. The following table
describes keywords for the /SERVER qualifier:
Keyword Description
CREATE_SYSTEM_LOG This keyword is obsolete. Use SET
AUDIT/SERVER=NEW_LOG
On Alpha, causes the audit server to create
a new local system security audit log file.
Other audit servers in the cluster are not
affected. This keyword may be used by sites
operating a multienvironment cluster where
it may be necessary to create a new log file
on a specific node in the cluster. CREATE_
SYSTEM_LOG is synonymous with NEW_LOG for
nonclustered systems.
EXIT Initiates an audit server shutdown. This is
the only method for removing the audit server
process from the system; the audit server
cannot be deleted or suspended.
FINAL_ Specifies the action the audit server should
ACTION=action take when it runs out of memory and cannot
buffer messages. (For more information, see
the discussion of message flow control in the
VSI OpenVMS Guide to System Security.) Specify
one of the following actions:
CRASH - Crash the system if the audit
server runs out of memory.
IGNORE_NEW - Ignore new event messages
until memory is available. New event
messages are lost but event messages in
memory are saved.
PURGE_OLD (default) - Remove old event
messages until memory is available for the
most current messages.
FLUSH Copies all buffered audit and archive records
to the security audit log file and security
archive file, respectively.
INITIATE Enables auditing during system startup.
Ordinarily, auditing is started from
VMS$LPBEGIN in STARTUP.COM but, if a site
redefines the logical name SYS$AUDIT_SERVER_
INHIBIT, the OpenVMS system waits for a SET
AUDIT/SERVER=INITIATE command before enabling
auditing.
NEW_LOG Creates a new clusterwide audit log file.
Typically, this is used daily to generate a
new version of the audit log file.
The following sequence of commands can be used
to reset the space monitoring thresholds and
then to recreate the auditing log, thereby
creating a smaller log file:
$ SET AUDIT /JOURNAL=SECURITY
/THRESHOLD=WARN=200
$ SET AUDIT /SERVER=NEW_LOG
By default, the size of the new auditing log
file is based on the size of the previous
auditing logs.
REDIRECT_SYSTEM_ This keyword is obsolete. Use SET
LOG AUDIT/SERVER=NEW_LOG.
On Alpha, causes the audit server on the local
node to redirect security event messages to a
new audit log file, whose location was defined
previously by the /DESTINATION qualifier.
Audit server processes (and log files) on
other nodes in the cluster are unaffected.
RESUME Requests the audit server process to resume
normal activity on the system, if adequate
disk space is available. Normally, once the
resource monitoring action threshold has been
reached, the audit server process suspends
most system activity and waits 15 minutes
before attempting to resume normal system
activity.
START Starts the audit server process on the
system. In order to fully enable the auditing
subsystem, the SET AUDIT/SERVER=INITIATE
command must be used after the SET
AUDIT/SERVER=START command has completed.
VSI recommends using the following command
procedure to start the audit server:
SYS$SYSTEM:STARTUP AUDIT_SERVER
4.1.16 /THRESHOLD
/THRESHOLD=type=value
Specifies threshold values used in monitoring available space
in the audit log file. The auditing system issues advisory
messages to central and security operators whenever free space
in the audit log file falls below the WARNING threshold. The
auditing system suspends processes that generate audit events
when free disk space is below the action threshold. (See
/RESOURCE=[enable|disable]). The /JOURNAL qualifier is required.
The following table lists the types of thresholds:
Keyword Description
WARNING=value Specifies the threshold at which the audit server
notifies all security operator terminals that
resources are getting low.
ACTION=value Specifies the threshold at which the audit server
starts suspending processes that are generating
audit records. (Certain processes are immune
to this: see the VSI OpenVMS Guide to System
Security).
RESUME=value This keyword is obsolete.
Specifies the threshold at which the audit server
resumes normal system activity.
The following table lists the default warning and action values
for each monitoring mode:
Mode Warning Action
Blocks 100 25
Delta time 2 0:00:00 0 0:30:00
4.1.17 /VERIFY
Do not return the dollar sign ($) prompt until the audit server
completes the command. Associated qualifiers determine which of
the following actions occur:
o Redefinition of auditing events
o Redefinition of the audit log file or the archive file
o Modification of the audit server's operational characteristics
o Modification of resource monitoring attributes
If you do not want to wait for the command to complete, specify
/NOVERIFY.
4.2 – Examples
1.$ SET AUDIT/AUDIT/ENABLE= -
_$ (CREATE,ACCESS=(SYSPRV,BYPASS),DEACCESS)/CLASS=FILE
$ SHOW AUDIT/AUDIT
System security audits currently enabled for:
.
.
.
FILE access:
Failure: read,write,execute,delete,control
SYSPRV: read,write,execute,delete,control
BYPASS: read,write,execute,delete,control
Other: create,deaccess
The SET AUDIT command in this example enables auditing of file
creation and file deaccess; it also enables auditing for any
file access done by using either SYSPRV or BYPASS privilege.
2.$ SET AUDIT/JOURNAL=SECURITY/DESTINATION=AUDIT$:[AUDIT]TURIN
$ SET AUDIT/SERVER=NEW
$ SHOW AUDIT/JOURNAL
List of audit journals:
Journal name: SECURITY
Journal owner: (system audit journal)
Destination: AUDIT$:[AUDIT]TURIN.AUDIT$JOURNAL
The SET AUDIT command in this example demonstrates how to
switch to a new journal.
3.$ SET AUDIT/SERVER=FINAL=CRASH
$ SHOW AUDIT/SERVER
Security auditing server characteristics:
Database version: 4.4
Backlog (total): 100, 200, 300
Backlog (process): 5, 2
Server processing intervals:
Archive flush: 0 00:01:00.00
Journal flush: 0 00:05:00.00
Resource scan: 0 00:05:00.00
Final resource action: crash system
The SET AUDIT command in this example changes the audit
server's final action setting so the system crashes when the
audit server runs out of memory.
4.$ SET AUDIT/ARCHIVE/DESTINATION=SYS$SPECIFIC:[SYSMGR]TURIN-ARCHIVE
$ SHOW AUDIT/ARCHIVE
Security archiving information:
Archiving events: system audits
Archive destination: SYS$SPECIFIC:[SYSMGR]TURIN-ARCHIVE.AUDIT$JOURNAL
The SET AUDIT command in this example enables a node-specific
archive file.
5.$ SET AUDIT/JOURNAL/RESOURCE=ENABLE
$ SHOW AUDIT/JOURNAL
List of audit journals:
Journal name: SECURITY
Journal owner: (system audit journal)
Destination: SYS$COMMON:[SYSMGR]SECURITY.AUDIT$JOURNAL
Monitoring: enabled
Warning thresholds, Block count: 100 Duration: 2 00:00:00.0
Action thresholds, Block count: 25 Duration: 0 00:30:00.0
The SET AUDIT command in this example enables disk monitoring
and switches the mode so the disk space is monitored in terms
of time rather than free blocks.
5 – BOOTBLOCK
Valid on Integrity server systems only.
Initializes the boot block on the target device.
Format
SET BOOTBLOCK [boot-file]
5.1 – Parameters
boot-file
Specifies the filename of the boot file for the target disk.
Architecture-specific defaults are applied for the
boot file. For Integrity servers, the default is
SYS$SYSROOT:[SYS$LDR]SYS$EFI.SYS (SYS$EFI).
The boot file must be contiguous. If the target boot file is
not contiguous, use the DCL command COPY/CONTIGUOUS or another
functionally similar mechanism to recreate a contiguous version
of the boot file.
The boot file must also be marked NOMOVE (using the DCL command
SET FILE/NOMOVE) to avoid a bootstrap failure that could result
from the normal and expected operations of disk defragmentation
tools.
5.2 – Description
The SET BOOTBLOCK command writes a boot block onto the specified
disk.
As an alternative to using the SET BOOTBLOCK command, you can use
RUN to invoke the SETBOOT utility, which then prompts you for all
required input.
5.3 – Qualifier
5.3.1 /BLOCK_SIZE
/BLOCK_SIZE=512 (default)
/BLOCK_SIZE=2048
Specifies the target block size for the bootstrap device, in
bytes.
The 512-byte block size applies for most disk devices. The 2048-
byte block size typically is used only when writing the boot
block to specific OpenVMS Integrity servers CD and DVD devices.
5.3.2 /I64
Specifies OpenVMS Integrity servers as the target architecture
for the boot block. The default boot file for OpenVMS Integrity
servers is SYS$SYSROOT:[SYS$LDR]SYS$EFI.SYS.
5.3.3 /PRESERVE
/PRESERVE=keyword
/PRESERVE=SIGNATURE
/PRESERVE=SIGNATURE maintains the existing GUID disk signature
value. The default is to generate a new signature for the target
volume.
SIGNATURE is the only keyword currently supported.
6 – BROADCAST
Enables you to selectively screen out various kinds of messages
from being broadcast to your terminal.
Format
SET BROADCAST=(class-name[,...])
6.1 – Parameter
class-name[,...]
Specifies the class of message that you want to enable or disable
for broadcast to your terminal. If you specify only one class,
you can omit the parentheses. The class names are as follows:
ALL Enables all message classes.
[NO]DCL Specifies Ctrl/T and SPAWN/NOTIFY messages.
[NO]GENERAL Specifies all normal REPLY messages or
messages from $BRDCST.
[NO]MAIL Specifies notification of mail.
NONE Disables all message classes.
[NO]OPCOM Specifies messages issued by the operator
communication process (OPCOM).
[NO]PHONE Specifies messages from the Phone utility.
[NO]QUEUE Specifies messages referring to print or
batch jobs issued by the queue manager.
[NO]SHUTDOWN Specifies messages issued from the
REPLY/SHUTDOWN command.
[NO]URGENT Specifies messages issued from the
REPLY/URGENT command.
[NO]USER1 to Specifies messages from specific user
[NO]USER16 groups. (For information on setting up
user-written broadcast messages, see the
description of the $BRKTHRU system service
in the VSI OpenVMS System Services Reference
Manual.)
6.2 – Examples
1.$ SET BROADCAST=(NOMAIL, NOPHONE)
.
.
.
$ SET BROADCAST=MAIL
In this example, the first SET BROADCAST command screens out
all mail and phone messages. Later the second SET BROADCAST
command restores mail messages. Phone messages are still
screened.
2.$ SET BROADCAST=NONE
.
.
.
$ SET BROADCAST=(SHUTDOWN, URGENT, DCL, OPCOM)
In this example, the first SET BROADCAST command screens out
all messages. Later the second SET BROADCAST command restores
shutdown, urgent, DCL, and OPCOM messages. General, phone,
mail, queue, and user messages are still screened.
7 – CACHE
7.1 /RESET
Resets systemwide I/O caching statistics for the extended file
cache (XFC).
OPER privilege is required to execute this command.
Format
SET CACHE/RESET
7.1.1 – Example
$ SHOW MEMORY/CACHE
System Memory Resources on 22-AUG-2001 11:22:22.50
Extended File Cache (Time of last reset: 16-AUG-2001 11:16:24.96)
Allocated (Mbytes) 151.39 Maximum size (Mbytes) 1024.00
Free (Mbytes) 0.21 Minimum size (Mbytes) 0.23
In use (Mbytes) 151.18 Write hit rate 0%
Read hit rate 97% Write I/O count 5321
Read I/O count 208052 Write hit count 0
Read hit count 203761 Writes bypassing cache 0
Reads bypassing cache 1787 Vols in Full XFC mode 0
Files cached open 316 Vols in VIOC Compatible mode 1
Files cached closed 300 Vols in No Caching mode 0
Read/Write ratio 97% Vols in Perm. No Caching mode 0
This example shows the cache statistics prior to issuing the
SET CACHE/RESET command.
$ SET CACHE/RESET
This command resets the cache statistics and updates the
timestamp.
$ SHOW MEMORY/CACHE
System Memory Resources on 22-AUG-2001 11:27:41.11
Extended File Cache (Time of last reset: 22-AUG-2001 11:27:37.76)
Allocated (Mbytes) 151.39 Maximum size (Mbytes) 1024.00
Free (Mbytes) 0.21 Minimum size (Mbytes) 0.23
In use (Mbytes) 151.18 Write hit rate 0%
Read hit rate 100% Write I/O count 0
Read I/O count 9 Write hit count 0
Read hit count 9 Writes bypassing cache 0
Reads bypassing cache 0 Vols in Full XFC mode 0
Files cached open 316 Vols in VIOC Compatible mode 1
Files cached closed 300 Vols in No Caching mode 0
Read/Write ratio 100% Vols in Perm. No Caching mode 0
This example shows the reset cache statistics and the modified
timestamp.
8 – CARD_READER
Defines the default translation mode for cards read from a card
reader. All subsequent input read from the specified card reader
is converted using the specified mode.
Format
SET CARD_READER device-name[:]
8.1 – Parameter
device-name[:]
Specifies the name of the card reader for which the translation
mode is to be set. The device must not be currently allocated to
any other user.
8.2 – Qualifiers
8.2.1 /026
Sets the card reader for cards punched on an 026 punch.
8.2.2 /029
Sets the card reader for cards punched on an 029 punch.
8.2.3 /LOG
/LOG
/NOLOG (default)
Controls whether log information is displayed at the terminal to
confirm that the card reader is set.
8.3 – Example
$ ALLOCATE CR:
_CRA0: ALLOCATED
$ SET CARD_READER CRA0:/029
$ COPY CRA0: [PEARLMAN.DATAFILES]CARDS.DAT
The ALLOCATE command requests the allocation of a card reader
by specifying the generic device name. When the ALLOCATE
command displays the name of the device, the SET CARD_READER
command sets the translation mode at 029. Then the COPY command
copies all the cards read by the card reader CRA0 into the file
CARDS.DAT in the directory [PEARLMAN.DATAFILES].
9 – CLUSTER
9.1 /EXPECTED_VOTES
Sets the total expected votes in the OpenVMS Cluster to a value
that you specify or, if no value is specified, sets the total
votes to a value determined by the system.
Requires OPER (operator) privilege.
Format
SET CLUSTER/EXPECTED_VOTES[=value]
9.1.1 – Parameter
value
Specifies the total number of expected votes in the cluster.
9.1.2 – Description
The SET CLUSTER/EXPECTED_VOTES command enables you to adjust the
total number of expected votes in the cluster. Set this value
equal to the number of votes contributed by each node plus the
number of votes contributed by the cluster quorum disk. The
system will automatically calculate the value of the cluster
quorum from the total number of expected votes in the cluster.
You can specify the expected total votes value as part of the
SET CLUSTER/EXPECTED_VOTES command string. If you enter the
command without specifying a value for expected votes, the system
calculates the value for you, using the following formula:
EXPECTED_VOTES=(NODE1_VOTES+NODE2_VOTES+...)+QUORUM_DISK_VOTES
NODEn_VOTES is the value of the system parameter VOTES for each
node in the cluster and QUORUM_DISK_VOTES is the value of the
system parameter QDSKVOTES.
When you enter the SET CLUSTER/EXPECTED_VOTES command without
specifying a value, the system assumes that all nodes that are
expected to be in the cluster are currently members.
In general, you use the SET CLUSTER/EXPECTED_VOTES command only
when a node is leaving the cluster for an extended period of
time. Under normal circumstances, quorum is not reduced when a
node leaves the cluster, because it is assumed that the node may
be rebooted and rejoin the cluster. If a node is removed and is
unable to rejoin the cluster within a reasonable period of time
(for example, if a node crashes due to a hardware problem and
cannot rejoin the cluster for several days), the quorum for the
cluster can safely be reduced by lowering the total expected
votes until that node rejoins.
The purpose of a cluster quorum is to eliminate any possibility
of the cluster partitioning into separate clusters and
simultaneously accessing the same resources (such as disks).
If the sum of the votes for all members of the cluster is smaller
than the cluster quorum, all nodes will block activity until new
nodes join to increase the vote total. Lowering the quorum value
(by reducing the value of the total expected votes) when one or
more nodes leave the cluster for long periods of time reduces
this possibility.
Note that no matter what value you specify for the SET
CLUSTER/EXPECTED_VOTES command, you cannot increase quorum to
a value that is greater than the number of the votes present,
nor can you reduce quorum to a value that is half or fewer of the
votes present.
When you enter the SET CLUSTER/EXPECTED_VOTES command, either
with or without an expected votes value specified, the system
responds with a message indicating the new value that was
actually set. Note that you need to enter this command only on
one node in the cluster, because the new value for total expected
votes is propagated through the cluster. This new expected votes
value should then be stored in the system parameter EXPECTED_
VOTES on each node, so that it remains in effect after the nodes
reboot.
When a node that was previously a member of the cluster is
ready to rejoin, you should increase the system parameter
EXPECTED_VOTES to its original value before bringing the node
back to the cluster. Note that you do not need to use the SET
CLUSTER/EXPECTED_VOTES command to increase the number of expected
votes, because the expected votes value will be increased
automatically when the node rejoins the cluster.
9.1.3 – Examples
1.$ SET CLUSTER/EXPECTED_VOTES
The SET CLUSTER command in this example instructs the system
to calculate the total expected votes value for you, because
no value is specified as part of the command string. The system
uses the NODEn_VOTES + QUORUM_DISK_VOTES formula.
2.$ SET CLUSTER/EXPECTED_VOTES=9
The SET CLUSTER command in this example sets the total expected
votes to 9, which is the value specified in the command string.
10 – COMMAND
Invokes the Command Definition Utility, which adds commands to
your process command table or to a specified command table file.
For a complete description of the Command Definition Utility,
see the VSI OpenVMS Command Definition, Librarian, and Message
Utilities Manual.
Format
SET COMMAND [filespec[,...]]
10.1 – Parameter
[filespec[,...]]
Specifies the name of one or more command definition files. If
you specify more than one name, separate them with commas. The
default file type is .CLD. See the VSI OpenVMS Command Definition,
Librarian, and Message Utilities Manual for more information
about writing a command definition file.
The asterisk (*) and the percent sign (%) wildcard characters
are allowed in the file specification.
10.2 – Qualifiers
10.2.1 /DELETE
/DELETE=(verb[,...])
Specifies /DELETE mode to delete verbs from the command table you
are modifying.
You can use the /DELETE qualifier to delete a verb in either
your process command table or in a command table file specified
with the /TABLE qualifier. If you do not use the /TABLE qualifier
to specify an alternate command table, the default is to delete
verbs from your process command table. If you do not use the
/OUTPUT qualifier to specify an output file, the default is to
return the modified command table to your process.
The verb specifies a verb to be deleted. If you specify two
or more verbs, separate them with commas and enclose the list
in parentheses. If you specify only one verb, you can omit the
parentheses.
You cannot use the /LISTING, /OBJECT, or /REPLACE qualifiers in
/DELETE mode.
10.2.2 /LISTING
/LISTING[=filespec]
/NOLISTING
Controls whether an output listing is created and optionally
provides an output file specification for the listing file.
A listing file contains a listing of the command definitions
along with any error messages. The listing file is similar to a
compiler listing.
If you specify the /LISTING qualifier and omit the file
specification, output is written to the default device and
directory; the listing file will have the same name as the first
command definition file and a file type of .LIS.
You can use the /LISTING qualifier only in /OBJECT or /REPLACE
mode; you cannot create a listing in /DELETE mode. In /OBJECT and
/REPLACE modes, the default is /NOLISTING.
10.2.3 /OBJECT
/OBJECT[=filespec]
Specifies /OBJECT mode to create an object module from a
command definition file and optionally provides an object file
specification. You cannot use the /OBJECT qualifier to create an
object module from a command definition that contains the IMAGE
keyword.
You can specify only one command definition file when you use SET
COMMAND/OBJECT.
If you specify the /OBJECT qualifier and omit the file
specification, output is written to the default device and
directory; the object file will have the same name as the input
file and a file type .OBJ.
You cannot use the /DELETE, /OUTPUT, /REPLACE, or /TABLE
qualifiers in /OBJECT mode.
NOTE
When compiling very large command definition (CLD) files,
you may encounter the following error:
%CDU-F-INTNODESPACE, Internal error: node space exhausted
The default value of virtual memory allocated by the SET
COMMAND/OBJECT command is 384KB. This value may not be
sufficient to process large CLD files. To increase this
size, use the CDU$TABLE_SPACE logical name to specify a
larger value.
For example:
$ DEFINE CDU$TABLE_SPACE 2048
10.2.4 /OUTPUT
/OUTPUT[=filespec]
/NOOUTPUT
Controls where the modified command table should be placed. If
you provide an output file specification, the modified command
table is written to the specified file. If you do not provide an
output file specification, the edited command table replaces your
process table. The /NOOUTPUT qualifier indicates that no output
is to be generated.
You can specify an output file specification with the /OUTPUT
qualifier only when you also use the /TABLE=filespec qualifier to
provide the input tables. The default file type is .EXE.
You can use the /OUTPUT qualifier only in /DELETE or /REPLACE
mode; you cannot use the /OUTPUT qualifier in /OBJECT mode.
In /DELETE and /REPLACE mode, the default is /OUTPUT with no file
specification.
10.2.5 /REPLACE
Specifies /REPLACE mode to add or replace verbs in the command
table you are modifying.
You can use the /REPLACE qualifier to modify either the process
command table or a command table file specified with the /TABLE
qualifier. If you do not use the /TABLE qualifier to specify an
alternate command table, the default is to modify your process
command table. If you do not use the /OUTPUT qualifier to specify
an output file, the default is to return the modified command
table to your process.
You cannot use the /OBJECT or /DELETE qualifiers in /REPLACE
mode.
If you do not explicitly specify /DELETE, /OBJECT, or /REPLACE
mode, the default is /REPLACE.
10.2.6 /TABLE
/TABLE=[filespec]
Specifies the command table that is to be modified. If you
specify the /TABLE qualifier and omit the file specification,
the current process command table is modified. If you include a
file specification, the specified command table is modified. The
default file type is .EXE.
If you use the /TABLE qualifier to provide an input command table
file, you should also use the /OUTPUT qualifier to provide an
output table file; otherwise, the modified command table will
be written to your process and will replace your process command
table.
You can only use the /TABLE qualifier in /DELETE or /REPLACE
mode; you cannot use the /TABLE qualifier in /OBJECT mode.
In /REPLACE and /DELETE mode, the default is /TABLE with no input
file specification.
10.3 – Examples
1.$ SET COMMAND SNAG
This command adds the commands in SNAG.CLD to the command table
in the current process.
2.$ SET COMMAND/OBJECT SNAG
This command creates an object file using the commands in
SNAG.CLD. This object file can then be linked with other object
files to process application defined commands.
3.$ SET COMMAND/TABLE=MYTAB/OUTPUT=MYCLI SNAG
This command adds the commands in SNAG.CLD to the command table
MYTAB.EXE and writes the updated table to MYCLI.EXE.
When you use the /TABLE qualifier to specify an input command
table, you should use the /OUTPUT qualifier to specify an
output file; otherwise, your process command table will be
overwritten.
4.$ SET COMMAND/DELETE=HOLD
This command deletes the definition for the verb HOLD from your
process command table. The modified command table is returned
to your process.
11 – CONTROL
Enables or disables the Ctrl/Y or the Ctrl/T function. Pressing
Ctrl/Y interrupts a command and returns you to the DCL command
level. Pressing Ctrl/T momentarily interrupts a command to print
a line of statistics.
SET CONTROL=T requires that SET TERMINAL/BROADCAST be set for the
information to be displayed at your terminal.
Format
SET CONTROL [=(T,Y)]
SET NOCONTROL [=(T,Y)]
11.1 – Parameter
(T,Y)
Specifies that T (Ctrl/T) or Y (Ctrl/Y) be enabled or disabled.
If you specify only one character, you can omit the parentheses.
If you do not specify either T or Y, Y is the default.
11.2 – Examples
1.$ SET NOCONTROL=Y
The SET CONTROL command in this example disables the Ctrl/Y
function as well as most Ctrl/C functions.
2.$ SET CONTROL=T
The SET CONTROL command in this example enables the Ctrl/T
function.
3.$ SET NOCONTROL=(T,Y)
The SET CONTROL command in this example disables both the
Ctrl/T and Ctrl/Y functions.
4.$ <Ctrl/T>
NODE22::SMITH 16:21:04 (DCL) CPU=00:03:29.39 PF=14802 IO=18652 MEM=68
$ SET NOCONTROL=T
$ <Ctrl/T>
As shown in this example, when you press Ctrl/T, the system
displays the appropriate information. The SET NOCONTROL=T
command disables the Ctrl/T function. Now when you press
Ctrl/T, no information is displayed.
5.$ TYPE CTRLT_LOOP.COM
$ inner=0
$ outer=0
$ loop:
$ loop1:
$ if inner .gt. 20000 then goto end_loop1
$ inner=inner+1
$ dcl$ctrlt=F$FAO("Inner loop count is !SL O !S !SL
Outer loop count is !SL",inner,outer)
$ goto loop1
$ end_loop1:
$ inner=0
$ outer=outer+1
$ goto loop
$ @CTRLT_LOOP
<<Press Ctrl/T>>
NODE1::JSMITH 10:46:37 (DCL) CPU=00:03:42.68 PF=13453 IO=6743 MEM=187
Inner loop count is 12306
Outer loop count is 0
NODE1::JSMITH 10:46:43 (DCL) CPU=00:03:49.19 PF=13455 IO=6744 MEM=187
Inner loop count is 19200
Outer loop count is 2
.
.
.
<<Press Ctrl/C>> <<--- To exit the loop.
$ SET NOCONTROL=T
$ @CTRLT_LOOP
<<Press Ctrl/T>>
<<Nothing is displayed as CTRL/T is disabled.>>
<<Press Ctrl/C>> <<--- To exit the loop.
This example demonstrates the use of DCL$CTRLT within a command
procedure. The command procedure is running in a loop that
updates the symbol DCL$CTRLT to indicate the number of loop
iterations executed so far.
12 – CPU
Changes the user capabilities associated with the specified CPUs.
Requires ALTPRI and WORLD privileges.
Format
SET CPU cpu-id[, . . . ]
12.1 – Parameter
cpu-id
Specifies a decimal value representing the identity of a
processor in an OpenVMS multiprocessing system. On an Alpha 7000
system, the CPU is the backplane slot number of the processor.
12.2 – Qualifiers
12.2.1 /ALL
Applies the specified operation to all CPUs in the active set.
12.2.2 /ASSIGN
/ASSIGN [=option] (Alpha/Integrity servers only)
Assigns the CPU to the current instance if no option is
specified.
If an option is specified, the CPU is assigned to that resource.
Option Description
$$PARTITION The current soft partition of the OpenVMS
instance.
$$HARD_ The hard partition of the OpenVMS instance.
PARTITION
Supported only on AlphaServer systems that support partitioning.
12.2.3 /AUTO_START
/AUTO_START (Alpha/Integrity servers only)
/NOAUTO_START
Sets or clears the instance-specific autostart flag for the
specified CPUs.
When autostart is enabled, that CPU will join the OpenVMS active
set when it is assigned or migrated into the partition. The CPU
will also autostart if a power-up transition is completed while
the CPU is owned by the issuing instance.
Supported only on AlphaServer systems that support partitioning.
12.2.4 /CAPABILITY
/CAPABILITY
/NOCAPABILITY
Allows bits in the process user capability mask to be set or
cleared individually, in groups, or all at once.
NOTE
The SET CPU/[NO]CAPABILITY command will fail if there is
an active process that requires a capability that is not
available on any remaining active CPU.
Specifying the /CAPABILITY qualifier has no direct effect, but
merely indicates the target of the operations specified by the
following secondary qualifiers:
/SET=(n[,..Sets all user capabilities defined by the position
values n, where n has the range of 1 to 16.
/CLEAR=(n[,Clears all user capabilities defined by the position
values n, where n has the range of 1 to 16.
The secondary qualifiers can all be used at once as long as the
user capability bits defined in the /SET and /CLEAR parameters do
not overlap.
The /NOCAPABILITY qualifier clears all user capability bits.
12.2.5 /CLEAR
/CLEAR=(n[,...])
Clears all user capabilities defined by the position values n
specified by the /CAPABILITY qualifier.
12.2.6 /FAILOVER
/FAILOVER=option (Alpha/Integrity servers only)
/NOFAILOVER
Establishes instance-specific failover relationships for each CPU
in the instance's potential set.
When the instance crashes, CPUs with a failover target other than
the current instance will be assigned or migrated to that target.
Specifying the /FAILOVER qualifier has no direct effect; however,
it indicates the target of the operations specified by the
following options:
Option Description
instance_name The name of any valid running instance in the
current hard partition.
partitionID The numeric ID of any partition (reflected in
the configuration tree) in the current hard
partition. An operating system instance is not
required to be running with this identifier.
$$PARTITION Assigns a resource to the current partition of
the current instance.
$$HARD_ Assigns a resource to the hard partition node
PARTITION of the configuration tree. This makes the CPU
available to multiple soft partitions below it.
The /FAILOVER qualifier generates a resource assignment only when
the current instance crashes.
Supported only on AlphaServer systems that support partitioning.
99
12.2.7 /GLOBAL
Modifies the global cell SCH$GL_DEFAULT_CPU_CAP. This global cell
is used to initialize the user capability mask of CPUs that are
brought into the active set for the first time.
12.2.8 /MIGRATE
/MIGRATE=option (Alpha/Integrity servers only)
Transfers ownership of the CPU from the current instance to
another soft partition.
Option Description
instance_name The name of any valid running instance in the
current hard partition.
partitionID The numeric ID of any partition (reflected in
the configuration tree) in the current hard
partition. An operating system instance is not
required to be running with this identifier.
Supported only on AlphaServer systems that support partitioning.
12.2.9 /POWER
/POWER=option (Alpha/Integrity servers only)
Turns the power on or off in one or more CPU slots. Valid options
are ON and OFF.
Supported only on AlphaServer GS series systems.
12.2.10 /OVERRIDE_CHECKS
/OVERRIDE_CHECKS (Alpha/Integrity servers only)
Directs the SET/CPU command to bypass a series of checks that
determine whether the specified processor is eligible for removal
from the active set.
12.2.11 /REFRESH
/REFRESH (Alpha/Integrity servers only)
Examines and updates the OpenVMS context for the specified CPU or
CPUs, using the hardware configuration tree.
12.2.12 /SET
/SET=(n[,...])
Sets all user capabilities defined by the position values n
specified by the /CAPABILITY qualifier.
12.2.13 /START
/START (Alpha/Integrity servers only)
Initiates a request for the specified CPU to join the OpenVMS
active set if it is not already there.
12.3 – Examples
1.$ SET CPU/CAPABILITY/GLOBAL/SET=(2,4)
This command sets user capabilities 2 and 4 in the global cell
SCH$GL_DEFAULT_CPU_CAP.
2.$ SET CPU/CAPABILITY/GLOBAL/SET=(2,4) 0
This command sets user capabilities 2 and 4 in the global cell
SCH$GL_DEFAULT_CPU_CAP, as well in the active CPU 0.
3.$ SET CPU/CAPABILITY/SET=(1,2) 0
$ SHOW CPU/FULL
SYSTEM: EUROS, VSI RX2600 (900MHZ/1.5MB)
SMP EXECLET = 3 : ENABLED : STREAMLINED.
CONFIG TREE = VERSION 6
PRIMARY CPU = 0
HWRPB CPUS = 2
PAGE SIZE = 8192
REVISION CODE =
SERIAL NUMBER = US30464615
DEFAULT CPU CAPABILITIES:
SYSTEM: QUORUM RUN
DEFAULT PROCESS CAPABILITIES:
SYSTEM: QUORUM RUN
CPU 0 STATE: RUN CPUDB: 8901C000 HANDLE: 00005D70
OWNER: 000004C8 CURRENT: 000004C8 PARTITION 0 (EUROS)
CHGCNT: 1 STATE: PRESENT, PRIMARY, REASSIGNABLE
PROCESS: TEST11 PID: 20201185
CAPABILITIES:
SYSTEM: PRIMARY QUORUM RUN RAD0
USER: USR1 USR2
SLOT CONTEXT: 901EB000
CPU - STATE..........: RC, PA, PP, CV, PV, PMV, PL
TYPE...........: ITANIUM MAJOR = 31, MINOR = 0
SPEED..........: 900 MHZ
LID............: 00000000
VARIATION......: IEEE FP, PRIMARY ELIGIBLE
SERIAL NUMBER..: 0001A968930A1A25
REVISION.......:
HALT REQUEST...: 0
SOFTWARE COMP..: 7.0
PALCODE - REVISION CODE..: 1.1
COMPATIBILITY..: 0
MAX SHARED CPUS: 0
BINDINGS: * NONE *
FASTPATH:
FGB0
PKA0
PEA0
EIA0
FEATURES:
AUTOSTART - ENABLED.
FASTPATH - SELECTION ENABLED AS PREFERRED CPU.
CPU 1 STATE: RUN CPUDB: 89163480 HANDLE: 00005E80
OWNER: 000004C8 CURRENT: 000004C8 PARTITION 0 (EUROS)
CHGCNT: 1 STATE: PRESENT, REASSIGNABLE
PROCESS: * NONE *
CAPABILITIES:
SYSTEM: QUORUM RUN RAD0
SLOT CONTEXT: 901EC000
CPU - STATE..........: RC, PA, PP, CV, PV, PMV, PL
TYPE...........: ITANIUM MAJOR = 31, MINOR = 0
SPEED..........: 900 MHZ
LID............: 01000000
VARIATION......: IEEE FP
SERIAL NUMBER..: 000363B4B0C5C862
REVISION.......:
HALT REQUEST...: 0
SOFTWARE COMP..: 7.0
PALCODE - REVISION CODE..: 1.1
COMPATIBILITY..: 0
MAX SHARED CPUS: 0
BINDINGS: * NONE *
FASTPATH:
FGA0
EWA0
PKB0
BG0
FEATURES:
AUTOSTART - ENABLED.
FASTPATH - SELECTION ENABLED AS PREFERRED CPU.
$ SET CPU/CAPABILITY/CLEAR=1 0
$ SHOW CPU/FULL
SYSTEM: EUROS, VSI RX2600 (900MHZ/1.5MB)
SMP EXECLET = 3 : ENABLED : STREAMLINED.
CONFIG TREE = VERSION 6
PRIMARY CPU = 0
HWRPB CPUS = 2
PAGE SIZE = 8192
REVISION CODE =
SERIAL NUMBER = US30464615
DEFAULT CPU CAPABILITIES:
SYSTEM: QUORUM RUN
DEFAULT PROCESS CAPABILITIES:
SYSTEM: QUORUM RUN
CPU 0 STATE: RUN CPUDB: 8901C000 HANDLE: 00005D70
OWNER: 000004C8 CURRENT: 000004C8 PARTITION 0 (EUROS)
CHGCNT: 1 STATE: PRESENT, PRIMARY, REASSIGNABLE
PROCESS: TEST11 PID: 20201185
CAPABILITIES:
SYSTEM: PRIMARY QUORUM RUN RAD0
USER: USR2
SLOT CONTEXT: 901EB000
CPU - STATE..........: RC, PA, PP, CV, PV, PMV, PL
TYPE...........: ITANIUM MAJOR = 31, MINOR = 0
SPEED..........: 900 MHZ
LID............: 00000000
VARIATION......: IEEE FP, PRIMARY ELIGIBLE
SERIAL NUMBER..: 0001A968930A1A25
REVISION.......:
HALT REQUEST...: 0
SOFTWARE COMP..: 7.0
PALCODE - REVISION CODE..: 1.1
COMPATIBILITY..: 0
MAX SHARED CPUS: 0
BINDINGS: * NONE *
FASTPATH:
FGB0
PKA0
PEA0
EIA0
FEATURES:
AUTOSTART - ENABLED.
FASTPATH - SELECTION ENABLED AS PREFERRED CPU.
CPU 1 STATE: RUN CPUDB: 89163480 HANDLE: 00005E80
OWNER: 000004C8 CURRENT: 000004C8 PARTITION 0 (EUROS)
CHGCNT: 1 STATE: PRESENT, REASSIGNABLE
PROCESS: * NONE *
CAPABILITIES:
SYSTEM: QUORUM RUN RAD0
SLOT CONTEXT: 901EC000
CPU - STATE..........: RC, PA, PP, CV, PV, PMV, PL
TYPE...........: ITANIUM MAJOR = 31, MINOR = 0
SPEED..........: 900 MHZ
LID............: 01000000
VARIATION......: IEEE FP
SERIAL NUMBER..: 000363B4B0C5C862
REVISION.......:
HALT REQUEST...: 0
SOFTWARE COMP..: 7.0
PALCODE - REVISION CODE..: 1.1
COMPATIBILITY..: 0
MAX SHARED CPUS: 0
BINDINGS: * NONE *
FASTPATH:
FGA0
EWA0
PKB0
BG0
FEATURES:
AUTOSTART - ENABLED.
FASTPATH - SELECTION ENABLED AS PREFERRED CPU.
$
In this example, the first SET CPU command sets user
capabilities 1 and 2 for CPU 0. The second SET CPU command
clears capability 1.
4.$ SET CPU/REFRESH/ALL
This command updates the OpenVMS context in this instance for
all CPUs physically residing in the current hard partition.
5.$ SET CPU/FAILOVER=WFGLXA 12
This command sets CPU 12 to failover to another instance
(WFGLXA), if the current instance crashes.
6.$ SET CPU/FAILOVER=$$HARD 13
This command assigns CPU 13 to hard partition ownership if
the current instance crashes. Assignment to the hard partition
makes the CPU visible and available to other instances for
assignment.
7.$ SET CPU/ASSIGN=$$HARD 14
This command assigns CPU 14, currently owned by the instance,
to hard partition ownership. Assignment to the hard partition
makes the CPU visible and available to other instances for
assignment.
8.$ SET CPU/ASSIGN 15
This command assigns CPU 15, currently owned by the hard
partition, to this instance. If the CPU is powered, in
the potential set, and autostart enabled, then it will
automatically join the active set.
13 – DAY
Sets the default day type specified in the user authorization
file (UAF) for the current day.
Requires OPER (operator) privilege.
Format
SET DAY
13.1 – Qualifiers
13.1.1 /DEFAULT
/DEFAULT
Overrides any previous SET DAY specification and specifies that
the normal UAF defaults are to be used to determine today's day
type.
13.1.2 /LOG
/LOG
/NOLOG (default)
Controls whether log information is displayed at the terminal to
confirm that the new SET DAY information has been set.
13.1.3 /PRIMARY
/PRIMARY
Sets today until midnight to a primary day.
13.1.4 /SECONDARY
/SECONDARY
Sets today until midnight to a secondary day.
13.2 – Examples
1.$ SET DAY/PRIMARY
The SET DAY command in this example overrides the current
default day type and sets today until midnight to a primary
day.
2.$ SET DAY/DEFAULT
The SET DAY command in this example overrides the previous
SET DAY command and sets today's day type to the UAF-defined
default.
14 – DEFAULT
Sets your default device and directory specifications. The new
default is applied to all subsequent file specifications that do
not explicitly include a device or directory name.
When you change the default device assignment, the system equates
the specified device with the logical name SYS$DISK.
Format
SET DEFAULT [device-name[:]][directory-spec]
14.1 – Parameters
device-name[:]
Specifies the name of the device you want to go to.
NOTE
The SET DEFAULT command will accept a node name with the
device name (that is, node-name::device-name). However, the
results of operations using a default with a node name are
unpredictable. Some utilities and applications do not allow
a node name to be specified in a file specification and will
fail if the default file specification contains a node name.
directory-spec
Specifies the name of the directory you want to go to. A
directory name must be enclosed in brackets ([ ]). Use the minus
sign (-) to specify the next higher directory from the current
default.
On Alpha systems, if the length of the resulting default
directory specification exceeds 255 characters, the SET DEFAULT
attempts to replace the default directory string with a generated
directory specification. If this happens, then in addition to
the normal syntax check, the entire path to that specification,
including the device, is verified and must exist for the call to
succeed.
On Alpha systems, if the process parse style is set to extended,
then the directory specification may include a directory ID
(DID).
You must specify either the device-name parameter or the
directory-spec parameter. If you specify only the device name,
the current directory is the default for the directory-spec
parameter. If you specify only the directory name, the current
device is the default for the device-name parameter.
You can use a logical name but it must constitute at least the
device part of the specification. When you use a search list
logical name as the parameter, the logical name is not translated
by the SET DEFAULT command. Instead, the SET DEFAULT command
retains the logical name so that OpenVMS Record Management
Services (RMS) is able to access the entire search list. If you
enter the SHOW DEFAULT command, the search list logical name
is displayed as the default device, along with its equivalence
strings.
14.2 – Examples
1.$ SET DEFAULT [TANNER]
The SET DEFAULT command in this example changes the default
directory to [TANNER]. The default disk device does not change.
2.$ SET DEFAULT $FLOPPY1:[MOREAU.MEMOS]
The SET DEFAULT command in this example sets your default to
the MOREAU.MEMOS subdirectory on $FLOPPY1.
3.$ SET DEFAULT $FLOPPY1:
The SET DEFAULT command in this example sets the default device
to $FLOPPY1. The directory name does not change.
4.$ SET DEFAULT [-]
The SET DEFAULT command in this example changes the default
directory to the parent directory of the one you are
currently in. For example, if the current directory is
$FLOPPY1:[NIELSEN.MEMOS], this command sets your default to
$FLOPPY1:[NIELSEN]. If you are in $FLOPPY1:[NIELSEN], this
command sets your default to the master directory on the disk-
$FLOPPY1:[000000].
5.$ SAVEDEF = F$ENVIRONMENT("DEFAULT")
$ SET DEFAULT [122001.ZAMORA.APP10]
.
.
.
$ SET DEFAULT 'SAVEDEF'
The command procedure in this example uses the F$ENVIRONMENT
lexical function to save the current default directory in
the symbol named SAVEDEF. The SET DEFAULT command changes
the default directory 122001.ZAMORA.APP10. Later, the symbol
SAVEDEF is used to restore the original default directory.
6.$ SHOW DEFAULT
WORK:[TOP]
$ DEFINE X WORK:[TOP.SUB1],WORK:[TOP.SUB2]
$ SET DEFAULT X
$ SHOW DEFAULT
X:[TOP]
$ DIRECTORY
Directory WORK:[TOP.SUB1]
KUDOS.TMP;1
Total of 1 file.
Directory WORK:[TOP.SUB2]
KUDOS.TMP;1
Total of 1 file.
Grand total of 2 directories, 2 files.
$ DIRECTORY []
Directory WORK:[TOP]
KUDOS.TMP;1 NETSERVER.LOG;2
Total of 2 files.
In this example, the default directory is WORK:[TOP]. X is then
defined to be a search list consisting of two subdirectories.
When the SET DEFAULT X command is entered, the search list (X)
is equated with the logical name SYS$DISK and is entered into
the disk field. The subsequent SHOW DEFAULT command shows both
the search list and the current default directory, followed by
the expanded search list.
If a DIRECTORY command is entered, the directories searched are
those contained in the logical name X; however, if the current
default directory specification ([]) is explicitly entered, the
current default directory, rather than SYS$DISK, is searched.
7.$SET PROCESS/PARSE_STYLE=EXTENDED
$SET DEFAULT WORK:[11,1,0]
$SHOW DEFAULT
WORK:[11,1,0]
$DIRECTORY
Directory WORK:[11,1,0]
X.X;1
Total of 1 file.
On Alpha systems, the SET DEFAULT command in this example uses
a directory ID (DID) in the directory specification.
8.$SET PROCESS/PARSE_STYLE=EXTENDED
$SET DEFAULT -
WORK:[.LONG_DIRECTORY_NAME_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA]
$SET DEFAULT -
WORK:[.LONG_SUBDIRECTORY_NAME_BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB]
$SET DEFAULT -
WORK:[.LONG_SUBDIRECTORY_NAME_CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC]
$SET DEFAULT -
WORK:[.LONG_SUBDIRECTORY_NAME_DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD]
$SET DEFAULT -
WORK:[.LONG_SUBDIRECTORY_NAME_EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE]
$SHOW DEFAULT
MDA0:[15,1,0]
$SET DEFAULT [-]
%RMS-F-DIR, error in directory name
$SET DEFAULT [.TEST]
$SHOW DEFAULT
MDA0:[15,1,0.TEST]
On Alpha systems, because the total length of the default
directory string would exceed 255 characters in this example, a
Directory ID is used in the directory specification. When the
default directory string is replaced with a Directory ID, it is
not possible to use the minus sign to specify the next higher
directory.
15 – DEVICE
Establishes a print device or terminal as a spooled device or
establishes the operational status for a device.
To make a disk on a local node available to all the nodes on an
OpenVMS Cluster, use the /SERVED qualifier.
Requires OPER (operator) privilege.
PHY_IO (physical I/O) privilege is required when specifying the
Alpha-only qualifiers that change the characteristics of shadow
sets. These qualifiers also can be specified using the SET SHADOW
command, which provides additional options for controlling shadow
sets. Qualifier settings for shadow sets remain in effect until
they are changed using either SET DEVICE or SET SHADOW or until
the shadow set or shadow set member is dismounted. If the shadow
set is remounted or a shadow set member is returned to the shadow
set from which it was dismounted, the settings must be specified
again. For more information about volume shadowing, see the VSI
Volume Shadowing for OpenVMS.
Format
SET DEVICE [device-name[:]]
15.1 – Parameter
device-name[:]
Specifies the name of the device whose spooling or operational
status is to change. The device must be a print device or a
terminal if you want to change the spooling status; the device
must be a disk or magnetic tape if you want to change the
operational status.
When you specify qualifiers that act on shadow sets, the device
might be a shadow set member (ddcu:) or the whole shadow set
(DSAnnnn:), as noted in the qualifier format. Depending on the
qualifier, if no device name is supplied, the qualifier applies
to all shadow sets mounted on the node from which the command is
executed.
15.2 – Description
When you specify any of the following qualifiers, the operational
status of the drive is changed: /ABORT_VIRTUAL_UNIT, /AVAILABLE,
/COPY_SOURCE, /DUAL_PORT, /ENABLE, /ERROR_LOGGING, /FORCE_
REMOVAL, /MEMBER_TIMEOUT, /MVTIMEOUT, /POLL, /READ_COST, /SITE,
or /SWITCH.
When you specify the /SPOOLED qualifier, program output that uses
OpenVMS Record Management Services (RMS) or file control system
(FCS) and that specifies the print device name is written onto
an intermediate disk rather than written directly to the print
device or terminal.
15.3 – Qualifiers
15.3.1 /ABORT_VIRTUAL_UNIT
/ABORT_VIRTUAL_UNIT DSAnnnn: (Alpha/Integrity servers only)
Aborts mount verification on a shadow set.
Use this qualifier when you know that the unit cannot be
recovered. When you use this qualifier, the shadow set must be
in mount verification. The shadow set aborts mount verification
immediately on the node from which the command is issued. If the
shadow set is not in mount verification, this command returns the
error %SYSTEM-E-UNSUPPORTED, unsupported operation or function.
After this command completes, the shadow set still must be
dismounted. Use the following command to dismount the shadow
set:
$ DISMOUNT/ABORT DSAnnnn:
15.3.2 /AVAILABLE
/AVAILABLE
/NOAVAILABLE
Controls whether the specified disk or magnetic tape is to be
considered available. You must dismount the specified disk
or magnetic tape before entering the SET DEVICE/[NO]AVAILABLE
command. If you specify the /NOAVAILABLE qualifier, any attempt
to allocate or mount the specified disk or magnetic tape is
prevented. Devices are automatically set /AVAILABLE when brought
online even if the device had been previously set /NOAVAILABLE.
15.3.3 /COPY_SOURCE
/COPY_SOURCE {ddcu: | DSAnnnn:} (Alpha/Integrity servers only)
Specifies which source member of a shadow set will be used as
the source for read data during full copy operations when a third
member is added to the shadow set. This qualifier affects only
copy operations that do not use disk copy data (DCD) commands.
Some storage controllers, such as the HSG80, have a read-ahead
cache, which significantly improves single-disk read performance.
Copy operations normally alternate reads between the two source
members, which effectively nullifies the benefits of the read-
ahead cache. This qualifier lets you force all reads from a
single, specified source member for a copy operation.
If only a shadow set (DSAnnnn:) is specified, all reads for
full copy operations will be performed from the disk that is
the current "master" member, regardless of physical location of
the disk.
If a shadow set member (ddcu:) is specified, that member will
be used as the source of all copy operations. This allows you to
choose a local source member, rather than a remote master member.
15.3.4 /DUAL_PORT
/DUAL_PORT
/NODUAL_PORT
Controls whether the port seize logic in the device driver of
the specified disk is to be enabled. This qualifier should be
used only on disks that contain a dual port kit and have been
dismounted.
15.3.5 /ENABLE
/ENABLE
/NOENABLE
Enables or disables a path to a multipath device; the affected
path is the one named in the /PATH qualifier. All paths are
initially enabled; the current path cannot be disabled.
15.3.6 /ERROR_LOGGING
/ERROR_LOGGING
/NOERROR_LOGGING
Controls whether device errors are logged in the error log file.
When you specify the /ERROR_LOGGING qualifier, all error messages
reported by the device on which error logging is enabled are
recorded in the error log file. Use the SHOW DEVICE/FULL command
to find out the current status.
15.3.7 /FORCE_REMOVAL
/FORCE_REMOVAL ddcu: (Alpha/Integrity servers only)
Expels the specified shadow set member from the shadow set.
If connectivity to a device has been lost and the shadow set is
in mount verification, this qualifier causes the member to be
expelled from the shadow set immediately.
If the shadow set is not currently in mount verification, no
immediate action is taken. If connectivity to a device has
been lost but the shadow set is not in mount verification, this
qualifier lets you flag the member to be expelled from the shadow
set, as soon as it does enter mount verification.
The specified device must be a member of a shadow set that is
mounted on the node where the command is issued.
15.3.8 /LOG
/LOG
/NOLOG (default)
Controls whether log information is displayed at the terminal.
15.3.9 /MEMBER_TIMEOUT
/MEMBER_TIMEOUT=n ddcu: (Alpha/Integrity servers only)
Specifies the timeout value to be used for a shadow set member.
The value supplied by this qualifier overrides the system
parameter SHADOW_MBR_TMO for this specific device. Each member
of a shadow set can be assigned a different MEMBER_TIMEOUT value.
The valid range for n is 1 to 16777215 seconds.
The specified device must be a member of a shadow set that is
mounted on the node where the command is issued.
15.3.10 /MV_INTVL
/MV_INTVL=n
Overrides the system-wide setting of the MVSUPMSG_INTVL system
parameter with the value specified by n (seconds) for the
specified device only. If /MV_INTVL=0, the value for MVSUPMSG_
INTVL is used instead. If MVSUPMSG_INTVL=0 or MVSUPMSG_NUM=0,
all mount verifications are announced. For more information about
MVSUPMSG_INTVL, see Sys_Parameters online help.
15.3.11 /MV_NUM
/MV_NUM=n
Overrides the system-wide setting of the MVSUPMSG_NUM system
parameter with the value specified by n (seconds) for the
specified device only. If /MV_NUM=0, the value for MVSUPMSG_NUM
is used instead. If MVSUPMSG_NUM=0 or MVSUPMSG_INTVL=0, all mount
verifications are announced. For more information about MVSUPMSG_
NUM, see Sys_Parameters online help.
15.3.12 /MVTIMEOUT
/MVTIMEOUT=n DSAnnnn: (Alpha/Integrity servers only)
Specifies the mount verification timeout value to be used for the
shadow set specified by its virtual unit name (DSAnnnn:).
The value supplied by this qualifier overrides the value
specified by the system parameter MVTIMEOUT for this specific
shadow set.
NOTE
You cannot change the value of MVTIMEOUT for a system disk.
Any attempt to do so results in an error.
The valid range for n is 1 to 16777215 seconds.
The specified shadow set must be mounted on the node where the
command is issued.
15.3.13 /PATH
/PATH=path-description-string
(For multipath devices only) Specifies a particular route to
the device. The path description string identifies a path from
the host to the device (for example, PGA0.2343-A855-BC99-876F or
PKC0.5). Wildcard characters have no special meaning. The path
description can be abbreviated to the minimum unique string.
Note that this qualifier does not imply that any action be
taken. To take action, you must also specify one of the following
qualifiers: /(NO)ENABLE, /(NO)POLL, or /SWITCH.
15.3.14 /POLL
/POLL
/NOPOLL
Specifies that the path specified by the /PATH qualifier is to be
polled for continued availability as a path switch destination.
This does not affect any attempt to switch to this path. Its
purpose is only to inform an operator that a path may or may not
be viable as a path switch destination. By default, all device
paths are enabled for polling when they are discovered. Note that
this qualifier applies only to multipath devices.
15.3.15 /PREFERRED_CPUS
/PREFERRED_CPUS=cpu-a[,cpu-b,cpu-c,...]
/NOPREFERRED_CPUS
Allows you to specify a CPU or a set of candidate CPUs from
which the operating system chooses the CPU to assign to the Fast
Path port. The chosen CPU is called the preferred CPU for this
Fast Path port. The Fast Path port's interrupt I/O completion
processing and I/O initiation processing are performed on this
preferred CPU.
In addition to selecting the preferred CPU, the User Preferred
CPU is set for this port. Setting the User Preferred CPU prevents
the port from being reassigned to another CPU unless the User
preferred CPU is being stopped. The qualifier can be negated.
When the /NOPREFERRED_CPUS qualifier is specified, the User
Preferred CPU is cleared for the port, but it remains a Fast
Path port, and the current preferred CPU is not changed.
If both /PREFERRED_CPUS and /NOPREFERRED_CPUS are specified on
the same command line, /NOPREFERRED_CPUS is ignored.
If Fast Path is enabled, you can use the DCL command, SHOW
DEVICE/FULL, to display the current preferred CPU and the User
Preferred CPU.
For more information about using Fast Path features to improve
I/O performance, see the VSI OpenVMS I/O User's Reference Manual.
15.3.16 /READ_COST
/READ_COST=n {ddcu: | DSAnnnn:} (Alpha/Integrity servers only)
Enables you to modify the default cost assigned to each shadow
set member (ddcu:). By modifying the assignments, you can bias
the reads in favor of one member of a two-member shadow set,
or, in the case of three-member shadow sets, in favor of one or
two members of the set over the remaining members. The device
specified must be a shadow set or member of a shadow set that is
mounted on the node where the command is issued.
The valid range for the specified cost is 1 to 65,535 units.
The shadowing driver assigns default READ_COST values to shadow
set members when each member is initially mounted. The default
value depends on the device type and its configuration relative
to the system mounting it. The following list of device types
is ordered by the default READ_COST assignments, from the lowest
cost to the highest cost:
o DECram device
o Directly connected device in the same physical location
o Directly connected device in a remote location
o DECram served device
o Default value for other served devices
The value supplied by the /READ_COST qualifier overrides the
default assignment. The shadowing driver adds the value of the
current queue depth of the shadow set member to the READ_COST
value and then reads from the member with the lowest value.
Different systems in the cluster can assign different costs to
each shadow set member.
When this qualifier specifies a shadow set (DSAnnnn:) instead
of a shadow set member, the /READ_COST qualifier switches the
read cost setting for all shadow set members back to the default
read cost settings established automatically by the shadowing
software. The specified shadow set must be mounted on the node
where the command is issued. In this case, the value specified
for the cost can be any number because it will be ignored.
If the /SITE command qualifier has been specified, the shadowing
driver takes site values into account when it assigns default
READ_COST values. In order for the shadowing software to
determine whether a device is in the category of "directly
connected device in a remote location," the /SITE command
qualifier must have been applied to both the shadow set and the
shadow set member.
Reads requested for a shadow set from a system at site 1 are
performed from a shadow set member that is also at site 1. Reads
requested for the same shadow set from site 2 can read from the
member located at site 2.
15.3.17 /RESET
/RESET=(keyword[,keyword])
Requires CMKRNL and DIAGNOSE privileges.
Resets either or both the error count and the operation count for
a device. You must specify one or both of the following keywords:
ERROR_COUNT Resets the error count.
OPERATION_ Resets the operation count.
COUNT
When either count is reset, a message is sent to the error log.
The message indicates that the count was reset and includes the
value of the counter before the reset.
15.3.18 /SITE
/SITE=n {DSAnnnn: | ddcu:} (Alpha/Integrity servers only)
Indicates to the shadowing driver the site location of the
specified shadow set (DSAnnnn:) or shadow set member (ddcu:). If
the member is removed from the shadow set and later is returned,
this qualifier must be specified again.
The SHADOW_SITE_ID system parameter defines the default site
location of the shadow set. You can override the default location
of the shadow set with the /SITE qualifier.
The valid range for the site location, represented by n, is 1
through 255.
After you apply this qualifier, the setting remains in effect
until you change it either with this command or with the SET
SHADOW/SITE command.
This qualifier can improve read performance because the member
that is physically local to the system will be the preferred disk
from which to read, provided that you specify the /SITE qualifier
for each shadow set member and for the shadow set. (In a Fibre
Channel configuration, shadow set members at different sites
are directly attached to the system. For the Volume Shadowing
and cluster software, there is no distinction between local and
remote in multiple-site Fibre Channel configurations.)
15.3.19 /SPOOLED
/SPOOLED[=(queue-name[:],intermediate-disk-name[:])]
/NOSPOOLED
Controls whether files are spooled to an intermediate disk.
The queue name indicates the printer queue to which a file is
queued. If a queue name is not supplied, the default is the name
of either the printer or terminal.
The intermediate disk name identifies the disk to which the
spooled files are written. If the intermediate disk name is not
supplied, the default is SYS$DISK (the current default disk). The
intermediate disk must be mounted before files can be written to
it.
Once the device has been set spooled to a disk, that disk cannot
be dismounted until the spooled device is set to /NOSPOOLED.
All channels must be deassigned from a print device before its
spooling characteristics can be changed. Also, the queue that is
assigned to the device must be stopped.
15.3.20 /SWITCH
Attempts to switch from the current path of a multipath device
to the path named in the /PATH qualifier. The path switch
is attempted only if the path has not been disabled by SET
DEVICE/NOENABLE. The path switch is initiated but not completed
before returning control to the user; use SHOW DEVICE/MULTIPATH
to verify that the path switching has completed successfully.
This command requires the OPER privilege. Additionally, if the
device is currently allocated by another process, as tape devices
often are, the SHARE privilege is needed.
15.4 – Examples
1.$ SET DEVICE/SPOOLED=(LPA0) LPA0:
In this example, the /SPOOLED qualifier requests that the
printer queue LPA0 be spooled to an intermediate disk before
files directed to the disk are printed. Because no intermediate
disk was specified, the intermediate disk defaults to SYS$DISK.
2.$ SET DEVICE/ERROR_LOGGING DKB2:
The SET DEVICE command in this example requests that all device
errors reported on device DKB2 be logged in the error log file.
3.$ SET DEVICE/NOAVAILABLE DRA0:
The SET DEVICE command in this example prevents any attempt to
mount a disk on device DRA0.
4.$ SET DEVICE/DUAL_PORT DRA0:
The SET DEVICE command in this example enables the dual port
seize logic in device DRA0.
5.$ SET DEVICE/PREFERRED_CPU=1 PNA0
The Fast Path port PNA0 is assigned to CPU 1, and the User
Preferred CPU is set to 1.
6.$ SET DEVICE/NOPREFERRED_CPU PNA0
The port PNA0 will have the User Preferred CPU cleared,
but will remain a Fast Path port, with CPU 1 as its current
preferred CPU.
7.$ SET DEVICE/PREFERRED_CPU=(0,1,2) PNA0
The operating system selects CPU 0,1, or 2 as the preferred CPU
for Fast Path port PNA0, and sets its User Preferred CPU to the
selected CPU.
8.$ SET DEVICE $1$DGA1001:/PATH=PGB0.0123-4567-89AB-CDEF/ENABLE
In this example, a request is made to enable path
PGB0.0123-4567-89AB-CDEF as a switch path destination. No error
is indicated if the path was in the enabled state prior to the
request. Had the /NOENABLE option been used, the path would
have been removed from switch path consideration.
9.$ SET DEVICE $1$DGA1001:/PATH=PGB0.0123-4567-89AB-CDEF/POLL
In this example, a request is made to enable path
PGB0.0123-4567-89AB-CDEF for polling of its continued
availability as a path switch destination. Had the /NOPOLL
option been used, the path would have been removed from path
availability polling consideration.
10$ SET DEVICE $1$DGA1001:/PATH=PGB0.0123-4567-89AB-CDEF/SWITCH
In this example, a request is made to switch from the current
path to path PGB0.0123-4567-89AB-CDEF. Should the path fail,
the switch algorithm of the unspecified path is used.
11$ ! Command sequence used on system 1 at site 1:
$ MOUNT/SYSTEM DSA0:/SHADOW=($1$DGA0:,$1$DGA1:) TEST
$ SET DEVICE/SITE=1 DSA0:
$ !
$ ! Command sequence used on system 2 at site 2:
$ MOUNT/SYSTEM DSA0:/SHADOW=($1$DGA0:,$1$DGA1:) TEST
$ SET DEVICE/SITE=2 DSA0:
$ !
$ ! Commands used on both system 1 and system 2:
$ SET DEVICE/SITE=1 $1$DGA0:
$ SET DEVICE/SITE=2 $1$DGA1:
In this example, the system at site 1 will perform all reads
from $1$DGA0, which is the physically local disk, while the
system at site 2 will perform all reads from its physically
local disk, $1$DGA1.
15.5 /SERVED
Makes a disk on a local node available to all the nodes in an
OpenVMS Cluster.
Applies only to OpenVMS Cluster environments.
You cannot use the SET DEVICE/SERVED command under the following
conditions:
o In service of a Phase II shadow set virtual unit
o On devices that are already mounted
o On system disks
o On quorum disks
Format
SET DEVICE/SERVED node-name$DDcu:
15.5.1 – Parameter
node-name$DDcu:
Specifies the device name of the device that you want to make
available to the cluster.
15.5.2 – Example
$ SET DEVICE/SERVED DRA4:
The SET DEVICE/SERVED command in this example instructs the
MSCP server to make the disk device DRA4 on your local node
available to all other processors on your cluster.
16 – DIRECTORY
Modifies the characteristics of one or more directories.
See the qualifier descriptions for restrictions.
Format
SET DIRECTORY [device-name[:]]directory-spec[,...]
16.1 – Parameters
device-name[:]
Specifies the device on which the directory that you want to
modify is located. The device name parameter is optional.
directory-spec[,...]
Specifies one or more directories to be modified. If you specify
more than one directory, separate the directory specifications
with commas. The asterisk (*) and the percent sign (%) wildcard
characters are allowed.
16.2 – Qualifiers
16.2.1 /BACKUP
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /BACKUP qualifier selects directories according
to the dates of their most recent backups. This qualifier
is incompatible with the /CREATED, /EXPIRED, and /MODIFIED
qualifiers, which also allow you to select directories according
to time attributes. If you specify none of these four time
qualifiers, the default is the /CREATED qualifier.
16.2.2 /BEFORE
/BEFORE[=time]
Selects only those directories dated prior to the specified
time. You can specify time as absolute time, as a combination
of absolute and delta times, or as one of the following keywords:
BOOT, LOGIN, TODAY (default), TOMORROW, or YESTERDAY. Specify
one of the following qualifiers with the /BEFORE qualifier
to indicate the time attribute to be used as the basis for
selection: /BACKUP, /CREATED (default), /EXPIRED, or /MODIFIED.
For complete information on specifying time values, see the
OpenVMS User's Manual or the online help topic Date.
16.2.3 /BY_OWNER
/BY_OWNER[=uic]
Selects only those directories whose owner user identification
code (UIC) matches the specified owner UIC. The default UIC is
that of the current process.
Specify the UIC by using standard UIC format as described in the
VSI OpenVMS Guide to System Security.
The /OWNER_UIC qualifier requires control access, a system UIC,
or privilege.
16.2.4 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
Controls whether a request is issued before each SET DIRECTORY
operation to confirm that the operation should be performed on
that file. The following responses are valid:
YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL
<Return>
You can use any combination of uppercase and lowercase letters
for word responses. Word responses can be abbreviated to one or
more letters (for example, T, TR, or TRU for TRUE), but these
abbreviations must be unique. Affirmative answers are YES, TRUE,
and 1. Negative answers include: NO, FALSE, 0, and pressing
Return. Entering QUIT or pressing Ctrl/Z indicates that you want
to stop processing the command at that point. When you respond by
entering ALL, the command continues to process, but no further
prompts are given. If you type a response other than one of
those in the list, DCL issues an error message and redisplays
the prompt.
16.2.5 /CREATED
/CREATED (default)
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /CREATED qualifier selects directories based on
their dates of creation. This qualifier is incompatible with the
/BACKUP, /EXPIRED, and /MODIFIED qualifiers, which also allow
you to select directories according to time attributes. If you
specify none of these four time qualifiers, the default is the
/CREATED qualifier.
16.2.6 /EXCLUDE
/EXCLUDE=(filespec[,...])
Excludes the specified directories from the SET DIRECTORY
operation. You can include a directory but not a device in the
file specification. The asterisk (*) and the percent sign (%)
wildcard characters are allowed in the file specification;
however, you cannot use relative version numbers to exclude a
specific version. If you specify only one directory, you can omit
the parentheses.
16.2.7 /EXPIRED
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /EXPIRED qualifier selects directories according
to their expiration dates. (The expiration date is set with
the SET FILE/EXPIRATION_DATE command.) The /EXPIRED qualifier
is incompatible with the /BACKUP, /CREATED, and /MODIFIED
qualifiers, which also allow you to select directories according
to time attributes. If you specify none of these four time
qualifiers, the default is the /CREATED qualifier.
16.2.8 /LOG
/LOG
/NOLOG (default)
Controls whether the system displays the directory specification
of each directory that is modified as the command executes.
16.2.9 /MODIFIED
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /MODIFIED qualifier selects directories according
to the dates on which they were last modified. This qualifier is
incompatible with the /BACKUP, /CREATED, and /EXPIRED qualifiers,
which also allow you to select directories according to time
attributes. If you specify none of these four time modifiers, the
default is the /CREATED qualifier.
16.2.10 /OWNER_UIC
/OWNER_UIC[=uic]
Requires control access, a system UIC, or privilege.
Specifies an owner UIC for the directory. The default UIC is that
of the current process.
16.2.11 /SINCE
/SINCE[=time]
Selects only those directories dated on or after the specified
time. You can specify time as absolute time, as a combination of
absolute and delta times, or as one of the following keywords:
BOOT, JOB_LOGIN, LOGIN, TODAY (default), TOMORROW, or YESTERDAY.
Specify one of the following qualifiers with the /SINCE qualifier
to indicate the time attribute to be used as the basis for
selection: /BACKUP, /CREATED (default), /EXPIRED, or /MODIFIED.
For complete information on specifying time values, see the
OpenVMS User's Manual or the online help topic Date.
16.2.12 /STYLE
/STYLE=keyword
Specifies the file name format for display purposes.
The valid keywords for this qualifier are CONDENSED and EXPANDED.
Descriptions are as follows:
Keyword Explanation
CONDENSED Displays the file name representation of what is
(default) generated to fit into a 255-length character string.
This file name may contain a DID or FID abbreviation
in the file specification.
EXPANDED Displays the file name representation of what is
stored on disk. This file name does not contain any
DID or FID abbreviations.
The keywords CONDENSED and EXPANDED are mutually exclusive. This
qualifier specifies which file name format is displayed in the
output message, along with the confirmation if requested.
File errors are displayed with the CONDENSED file specification
unless the EXPANDED keyword is specified.
See the OpenVMS User's Manual for more information.
16.2.13 /SYMLINK
/SYMLINK=keyword
The valid keywords for this qualifier are [NO]WILDCARD and
[NO]ELLIPSIS. Descriptions are as follows:
Keyword Explanation
WILDCARD Indicates that symlinks are enabled during wildcard
searches.
NOWILDCARD Indicates that symlinks are disabled during directory
wildcard searches.
ELLIPSIS Equivalent to WILDCARD (included for command
symmetry).
NOELLIPSIS Indicates that symlinks are matched for all wildcard
fields except for ellipsis.
If the file named in the SET DIRECTORY command is a symlink, the
command operates on the symlink target.
16.2.14 /VERSION_LIMIT
/VERSION_LIMIT[=n]
Specifies the total number of versions that a file in the
specified directory can have. If you do not specify a version
limit, a value of 0 is used, indicating that the number of
versions of a file is limited only to the Files-11 architectural
limit-32,767. If you change the version limit for the directory,
the new value applies only to files created after the change has
been made.
The SET DIRECTORY version limit value refers to the number of
files with the same file name and type that can exist in the
directory at one time. It has no effect on the version number
field of a particular file specification. Use the SET FILE
command to set limits on file version numbers.
To find out the current version limit for a directory, use the
DIRECTORY/FULL command on a directory file and look at the File
Attributes component of the output.
16.3 – Examples
1.$ SET DIRECTORY/VERSION_LIMIT=5/CONFIRM [VERCAMMEN...]
The SET DIRECTORY command in this example sets a version
limit of 5 for all files in the VERCAMMEN directory (the
root directory) and all subdirectories of [VERCAMMEN]. The
/CONFIRM qualifier requests that you confirm whether the
specified directory should actually be modified. Note that this
version limit applies only to files created after the command
is entered.
2.$ SET DIRECTORY/VERSION_LIMIT=8 [.JAIMON...]
In this example, the SET DIRECTORY command sets a version
limit of 8 for all files in the JAIMON subdirectory and any
of its subdirectories (for example, [.JAIMON.ADRIAN]). The
setting for these specific directories overrides any version
limit that might be set for the root directory and its other
subdirectories.
3.$ SET DIRECTORY/OWNER_UIC=[360,020] [WOERTMAN],[MOSER]
The SET DIRECTORY command in this example modifies both the
[WOERTMAN] and [MOSER] directories, changing their owner
UICs. Using the OWNER_UIC qualifier requires SYSPRV (system
privilege).
17 – DISPLAY
Directs the output of an OpenVMS DECwindows application.
Output can be directed from any processor running a DECwindows
application, including workstations, to any DECwindows
workstation.
Both source and destination nodes must be part of the same
network.
Format
SET DISPLAY [display-device]
17.1 – Parameter
display-device
Specifies a logical name for the workstation display you are
creating or modifying. If you are directing application output
to multiple workstation displays, you can use different logical
names to point to each display. If you do not specify a display-
device parameter, the logical name DECW$DISPLAY is used. This
means that, by default, application output will be displayed on
the workstation display device referred to by DECW$DISPLAY.
By entering the command SHOW DISPLAY, you can see the default
workstation node where applications will be displayed, as well as
related device, screen, and transport information.
If you specified your own logical name in the SET DISPLAY/CREATE
command, include that logical name in the SHOW DISPLAY command.
17.2 – Qualifiers
17.2.1 /CREATE
Creates the workstation display device (WSAn:) on which a
DECwindows application is displayed. You must specify the /CREATE
qualifier the first time you use the SET DISPLAY command, but
you need not respecify it if you continue to redirect output from
applications to other workstations with subsequent SET DISPLAY
commands.
When you specify the /CREATE qualifier without the /NODE
qualifier, the workstation device defaults to the current node.
Additionally, if you omit the /TRANSPORT qualifier, the transport
defaults to either the value specified by the DECW$SETDISPLAY_
DEFAULT_TRANSPORT logical, if defined, or to DECNET.
17.2.2 /DELETE
Cancels the redirected display by deassigning the logical name
DECW$DISPLAY and deleting the created display device. If you
specified a logical name as the display-device parameter with
the SET DISPLAY/CREATE command, entering the SET DISPLAY/DELETE
display-device command cancels the redirected display by
deassigning the logical name you specified and deleting the
created display device.
The DECwindows Session Manager defines DECW$DISPLAY in your job
logical name table when you open a terminal (DECterm) window.
When you redirect application output to another workstation
with the SET DISPLAY/CREATE command, an additional DECW$DISPLAY
logical name is defined in your process logical name table. This
definition supersedes the definition in the job logical name
table. Output from applications run from the process in which
you executed the SET DISPLAY/CREATE command will be displayed on
the workstation referred to by the definition of DECW$DISPLAY in
the process logical name table. Enter the SHOW DISPLAY command
to see where this application will be displayed. To see whether
multiple definitions for DECW$DISPLAY exist, enter the command
SHOW LOGICAL DECW$DISPLAY.
If DECW$DISPLAY is still defined (for example, in the job
logical name table) after you specify the /DELETE qualifier, any
DECwindows applications run from this process will be displayed
on the workstation device to which output is now directed. Enter
the SHOW DISPLAY command if you are unsure of the node to which
DECW$DISPLAY refers.
CAUTION
If you modify or delete the definition of DECW$DISPLAY from
the job logical name table, you will be unable to start
another session. Be careful not to specify the /DELETE
qualifier without having first redirected the display with
the SET DISPLAY/CREATE command.
You cannot specify the /DELETE and /CREATE qualifiers on the same
command line.
17.2.3 /EXECUTIVE_MODE
Creates an executive-mode device and assigns the logical name
DECW$DISPLAY to point to it. This qualifier must be used with
the /CREATE qualifier. Devices created with the /EXECUTIVE_MODE
qualifier are deleted only in the following situations:
o They are explicitly deleted with the /DELETE qualifier.
o The system is rebooted.
To modify or delete executive-mode devices, you must have SYSNAM
(system logical name) privilege.
17.2.4 /GENERATE
/GENERATE[=(keyword[=value][,...]) (Alpha/Integrity servers
only)
Requires a trusted network connection to an X display server and
the SECURITY extension must be enabled on that server.
Instructs the display device to connect to the X display
server and generate a new authorization key (consisting of
the authorization protocol name and a magic cookie). This
authorization key is then stored in the X authority file
currently in use. If you do not want to overwrite any previously
existing keys for this display device, use the /XAUTHORITY
qualifier to write the generated key to an alternate X authority
file.
NOTE
The MIT-KERBEROS-5 protocol does not currently support key
generation, as defined by the SECURITY extension. Do not
use the /GENERATE qualifier when connected to an X display
server protected by Kerberos access control.
Each generated key follows the default settings unless
otherwise specified. This means that, by default, each generated
authorization key:
o Follows the MIT-MAGIC-COOKIE-1 protocol
o Grants an untrusted connection to the X server
o Is not associated with a particular application group
o Maintains a timeout period of 60 seconds before which it must
be used (otherwise, it is automatically revoked)
Possible keyword values are as follows:
Value Description
TRUSTED Specifies that the key grant unrestricted access
to the X server. This keyword permits a client
application to perform all actions.
UNTRUSTED Specifies that the key grant restricted access
to the X server. This keyword restricts client
applications to a subset of X server extensions
and prevents access to windows other than those
created by the requesting application.
TIMEOUT=seconds Specifies the number of seconds after which the
key is revoked automatically if not in use. The
timeout period begins immediately, and refreshes
once all connections using this key have closed.
NOTIMEOUT Specifies that the key has no expiration and must
be explicitly revoked.
GROUP=groupid Specifies that the key is associated with a
particular application group and is to be revoked
if that group is deleted. Although the use of
application groups is supported by DECwindows
Motif via the XC-APPGROUP extension, DECwindows
Motif does not currently supply any utilities or
desktop applications to create these groups. To
create an application group, you must use an X
Window System application or utility external to
DECwindows Motif.
PROTOCOL=name Specifies the protocol to be used to authenticate
the key. Valid values are server dependent. For
the DECwindows X display server, the only valid
value for the name parameter is MIT-MAGIC-COOKIE-
1. If you are connecting to a third-party X
server, the names of any additional authorization
protocols on that X server that support the
SECURITY extension and key generation are also
valid.
The keyword sets TRUSTED/UNTRUSTED and TIMEOUT/NOTIMEOUT are
mutually exclusive. Do not enter both values on the same command
line.
17.2.5 /LBXAUTHENTICATE
/LBXAUTHENTICATE=protocol-name (Alpha/Integrity servers only)
/NOLBXAUTHENTICATE (Alpha/Integrity servers only)
Specifies the authorization protocol used to grant the LBX proxy
server access to the X display server. This qualifier is used
with the /PROXY and /CREATE qualifiers when creating an initial
LBX proxy server connection. If a proxy server connection already
exists, these qualifiers are ignored. If you do not specify
/LBXAUTHENTICATE, the authorization protocol is obtained from
the current X authority file. If you specify /NOLBXAUTHENTICATE,
the proxy server defaults to the X authority file of the user who
started the proxy manager application.
Valid values for the protocol-name parameter are MIT-MAGIC-
COOKIE-1 and MIT-KERBEROS-5. If you supply a protocol-name value
of MIT-MAGIC-COOKIE-1, you must also specify the value of the
magic cookie using the /LBXDATA qualifier.
17.2.6 /LBXDATA
/LBXDATA=value (Alpha/Integrity servers only)
Specifies a data value for the authorization protocol used
between the LBX proxy server and the X display server. This
qualifier must be used with the /LBXAUTHENTICATE, /PROXY, and
/CREATE qualifiers.
When you issue a SET DISPLAY/CREATE/PROXY/LBXAUTHENTICATE=MIT-
MAGIC-COOKIE-1 command, use this qualifier to provide a
hexadecimal magic cookie value to the MIT-MAGIC-COOKIE-1
protocol.
17.2.7 /NODE
/NODE=workstation_display
Defines the workstation on which you want to display DECwindows
applications. The node name you provide cannot be a cluster alias
(a name that represents multiple nodes configured in an OpenVMS
Cluster), but must instead identify an actual node.
You must create a workstation display device with the
/CREATE qualifier before you can redirect the output from
applications to other workstations. Do not enter the SET
DISPLAY/NODE=workstation_display command without having
previously specified the /CREATE qualifier.
When you specify the /CREATE qualifier without the /NODE
qualifier, the workstation defaults to the current node.
Make sure that you are authorized to display applications on
the workstation you specify. For more information about using
the DECwindows Session Manager to authorize yourself to display
applications from other nodes, see the DECwindows documentation.
Each node, both source and destination, must be defined in
the other's network node database. For example, to display
applications on node HUBBUB from ZEPHYR, HUBBUB must be entered
in ZEPHYR's network node database, and ZEPHYR must be entered
in HUBBUB's network node database. In addition, users on ZEPHYR
must be authorized in the DECwindows Session Manager to display
applications on HUBBUB. For information about entering nodes
in a network node database, see the DECnet-Plus for OpenVMS
documentation.
17.2.8 /PMPORT
/PMPORT=[port-number] (Alpha/Integrity servers only)
Specifies the port number on which the proxy manager is
listening. This qualifier is used with the /PROXY and /CREATE
qualifiers. The default port is 6500.
17.2.9 /PMTRANSPORT
/PMTRANSPORT=transport-name (Alpha/Integrity servers only)
Specifies the network transport used to connect to the proxy
manager. This qualifier is used with the /PROXY and /CREATE
qualifiers.
Valid values for the transport-name parameter are the same
as those listed for the /TRANSPORT qualifier. If you do not
specify a transport, then the network transport specified by
the /TRANSPORT qualifier is used.
17.2.10 /PROXY
/PROXY[=node] (Alpha/Integrity servers only)
Specifies that a proxy manager application should be used to
locate an LBX proxy server, which serves as an intermediary for
processing client and server connections for a display device.
Use an LBX proxy server when connecting to a remote node located
over a low-bandwidth network connection, such as the Internet.
The proxy manager should run on the local network. This qualifier
is used with the /CREATE qualifier.
When you create a display device using the SET
DISPLAY/CREATE/PROXY command, you can use that device to connect
to an X display server exactly the same as you would with any
other display device. The client connects to the LBX proxy server
returned by the proxy manager, which in turn connects to the X
display server.
The value of the /PROXY qualifier specifies the node on which
the proxy manager is running. The proxy manager is responsible
for starting or locating a proxy server to provide access to the
X display server specified by the transport, node, and server
values. The proxy manager returns the transport, node, and server
values for the selected proxy server to the display device. If
you do not specify a value for the node parameter, the default
location is the current node.
The /PMPORT and /PMTRANSPORT qualifiers can be used to further
specify the proxy manager's location.
17.2.11 /QUOTA
/QUOTA=(quota-name=value[,...]) (Alpha/Integrity servers only)
Requires SYSPRV (system privilege) privilege or the DECW$WS_QUOTA
rights identifier. If using an executive mode device, SYSNAM
(system name) privilege is also required.
Modifies the value of the name count or data space quota
associated with the display device. These quotas influence the
amount of non-paged pool available for storing named properties.
Possible values for the quota-name parameter are as follows:
o NAME_COUNT - The name count quota restricts the total number
of named properties associated with the device. The default
name count quota is the value of the DECW$WS_DEFAULT_NAME_
COUNT logical, or 12 if the logical is not defined.
o DATA_SPACE - The data space quota restricts the total amount
of space available (in bytes) for storing property values.
Note that this space includes some data overhead and may not
total the exact length of the values. The default data space
quota is the value of the DECW$WS_DEFAULT_DATA_SPACE logical,
or 10752 if the logical is not defined.
17.2.12 /REVOKE
/REVOKE (Alpha/Integrity servers only)
Requires a trusted network connection to an X display server and
that the SECURITY extension be enabled on that server.
Revokes an authorization key created with the /GENERATE
qualifier.
If you specify the /REVOKE qualifier, the revoke operation
is performed before the other actions on the SET DISPLAY
command. For example, you can use both the /REVOKE and /GENERATE
qualifiers on the same command line, in any order, to revoke one
key and generate another.
Do not use with the /CREATE qualifier.
17.2.13 /SCREEN
/SCREEN=screen-number
Defines the screen to be associated with this display device. In
some hardware configurations, the system supports more than one
screen. In such a configuration, you can specify the screen to
which the application is directed.
17.2.14 /SERVER
/SERVER=server-number
Defines the server to be associated with the display device
indicated by the display-device parameter to the SET DEVICE
command. Using the transport mechanism, the server passes
data between the user and the application. In some hardware
configurations, the system supports more than one server. In
such a configuration, you can specify the server to which the
application is directed.
On Alpha and Integrity server systems in LBX proxy server
configurations, this qualifier specifies either an X display
server or a standalone LBX proxy server. Standalone LBX proxy
servers are not managed by the proxy manager and are manually
assigned a server number on startup.
If you do not specify the display-device parameter, the SET
DISPLAY/SERVER command associates the server with the display
device indicated by the logical name DECW$DISPLAY.
17.2.15 /SUPERVISOR_MODE
/SUPERVISOR_MODE (default)
Creates a supervisor-mode device and assigns the logical name
DECW$DISPLAY to point to it. This qualifier must be used with the
/CREATE qualifier. When the user logs out, the device is deleted.
17.2.16 /TRANSPORT
/TRANSPORT=transport-name
Defines the transport mechanism, for example, DECnet or
local, that passes information between the application and the
workstation. The transport mechanism is used to send input from
the user to the application and output from the application to
the display device. In proxy manager configurations, the value
specified for this qualifier also acts as a default value for the
/PMTRANSPORT qualifier.
The transport-name parameter can be one of the following values:
o TCPIP or DECNET
Specifies the appropriate network transport for applications
running and displaying on different nodes. You can specify
the default transport value used with the SET DISPLAY/CREATE
command by defining the DECW$SETDISPLAY_DEFAULT_TRANSPORT
logical in the job, process, or system table. The value
of this logical is then used each time you enter the SET
DISPLAY/CREATE command without the /TRANSPORT qualifier. If
you specify neither the qualifier nor the logical, the value
of DECNET is used as default.
o LOCAL
Optimizes the performance of applications running and
displaying on the same node.
On Alpha and Integrity server systems, the valid set of values
for the transport-name parameter is further determined by the
DECwindows logical DECW$IPV6_SUPPORT. This logical specifies
which Internet Protocol version is supported: IPv4 or IPv6. See
the DECwindows Motif documentation for more information about the
DECW$IPV6_SUPPORT logical and support for the IPv6 protocol.
When using a proxy manager on Alpha and Integrity server systems,
this qualifier specifies the transport that the selected LBX
proxy server should use to connect to the X server.
When using a standalone proxy server (specified by the /SERVER
qualifier), this qualifier specifies the transport that the
client should use to connect to the proxy server.
17.2.17 /USER_MODE
Creates a user-mode display device and assigns the logical name
DECW$DISPLAY to point to it. This qualifier must be used with
the /CREATE qualifier. The lifetime of a user-mode device is
one DECwindows image: when the next DECwindows image exits, the
device is deleted.
17.2.18 /VALUE
/VALUE=(NAME=property-name,action[=data]) (Alpha/Integrity
servers only)
Sets, deletes, or modifies a named property value associated with
the display device. Named property values are intended to store
configuration information associated with the display device,
such as the network address of a session manager.
Use the following options to specify the type of action to
perform:
o DELETE - Deletes the specified property value.
o SET=data - Sets the specified property to the supplied value.
o APPEND=data - If the property exists, adds the supplied value
to the end of list of values associated with the property.
If the property does not exist, it is created and set to the
supplied value.
Use the SHOW DISPLAY/VALUES command to display all existing
named properties and their current values. Property names are
restricted to 31 characters. Names that include a dollar sign ($)
are reserved by VSI for use with OpenVMS products and facilities.
For example, names starting with the string DECW$ are reserved
for DECwindows Motif.
17.2.19 /XAUTHORITY
/XAUTHORITY=[filespec] (Alpha/Integrity servers only)
/NOXAUTHORITY (Alpha/Integrity servers only)
Directs the display device to use a specific X authority file
when connecting the X display server. The X authority file
contains data that grants or restricts access to the X display
server depending on the authorization protocol in use. If a file
specification is not entered with this qualifier, the default
of SYS$LOGIN:DECW$XAUTHORITY.DECW$XAUTH is used. If the file
specification is entered and the file does not currently exist,
it is created automatically when an entry is made into the file.
Note that with this qualifier, all X authority file
specifications resolve to a physical device (rather than a
logical device) in order to remain available to other detached
processes. If you specify a search list, and the file is not
found, the X authority file specification resolves to the first
directory in the search list.
Use /NOXAUTHORITY to clear the setting and return to the file
referenced by the DECW$XAUTHORITY logical or the default file if
the logical is not defined.
17.3 – Examples
1.$ SHOW DISPLAY
Device: WSA1: [super]
Node: 0
Transport: LOCAL
Server: 0
Screen: 0
$ SET DISPLAY/CREATE/NODE=ZEPHYR/EXECUTIVE_MODE
$ SHOW DISPLAY
Device: WSA2: [exec]
Node: ZEPHYR
Transport: DECNET
Server: 0
Screen: 0
$ SPAWN/NOWAIT/INPUT=NL: RUN SYS$SYSTEM:DECW$CLOCK
$ SET DISPLAY/DELETE
$ SHOW DISPLAY
Device: WSA1: [super]
Node: 0
Transport: LOCAL
Server: 0
Screen: 0
In this example, you are logged in to your workstation (device
WSA1:), here referred to as node 0. (0 is the standard
shorthand notation for representing your node.) You want to
run the DECwindows Clock on your workstation and display it on
another workstation, ZEPHYR.
Assuming you are authorized to display applications on ZEPHYR,
you redirect the application's output to ZEPHYR with the SET
DISPLAY command. The device created on ZEPHYR is an executive-
mode device. You enter the SHOW DISPLAY command to verify the
location of the redirected display. You then run Clock. When
you finish running Clock, you disable the redirected display
by entering the SET DISPLAY/DELETE command. Finally, you
enter the SHOW DISPLAY command to verify that any applications
subsequently run on your node will also be displayed there.
Note that a new workstation display device, WSA2, is created
when you enter the SET DISPLAY/CREATE command. When you cancel
the redirected display with the SET DISPLAY/DELETE command,
application output is once again displayed on the workstation
display device referred to by WSA1.
2.$ SET DISPLAY/CREATE/NODE=FLOPSY RABBIT
$ SHOW DISPLAY RABBIT
Device: WSA2: [super]
Node: FLOPSY
Transport: DECNET
Server: 0
Screen: 0
$ RUN/DETACHED/OUTPUT=WSA2: SYS$SYSTEM:DECW$CLOCK
$ SET DISPLAY/CREATE/NODE=ZEPHYR ZNODE
$ SHOW DISPLAY ZNODE
Device: WSA3: [super]
Node: ZEPHYR
Transport: DECNET
Server: 0
Screen: 0
$ RUN/DETACHED/OUTPUT=WSA3: SYS$SYSTEM:DECW$CALENDAR
$ RUN SYS$SYSTEM:DECW$BOOKREADER
$ SHOW DISPLAY
Device: WSA1: [super]
Node: 0
Transport: LOCAL
Server: 0
Screen: 0
In this example, you are logged in to your node (device WSA1:),
and want to direct the output from applications to several
workstation displays in the same session. By specifying
different logical names in the SET DISPLAY command, you
can redirect the output without changing the logical name
definition for DECW$DISPLAY. This allows you to display the
output from most applications on your default display but
occasionally display output on another workstation. You can
also continue to run and display applications on your node. In
this example, Clock is displayed on node FLOPSY, Calendar is
displayed on node ZEPHYR, and Bookreader is displayed on your
workstation.
Note that to run your applications with the DCL command
RUN/DETACHED, you must use the device name that equates to the
logical display device name you specified in the SET DISPLAY
command. Use the SHOW DISPLAY command to obtain this device
name.
3.$ SET DISPLAY/CREATE/GENERATE=TRUSTED-
_$ /XAUTHORITY=XAUTHORITY_TEMP/NODE=ZEPHYR
$ PIPE SHOW DISPLAY/EXTR | RSH FLOPSY "XAUTH NMERGE SYS$INPUT"
$ SET HOST FLOPSY
$ SET DISPLAY/NODE=ZEPHYR
$ RUN SYS$SYSTEM:DECW$CLOCK
In this example, you are logged into your workstation (WSA1:)
and want to run the DECwindows Clock application on a remote
node (FLOPSY) and display it on another workstation (ZEPHYR).
Both systems are using Magic Cookie authorization to control
access to the X display server.
Assuming you are already authorized to connect to the server
on node ZEPHYR, you create a display device that connects to
ZEPHYR and generates a new authorization key. This key grants
trusted connections to the server on ZEPHYR within 60 seconds
of key generation. To restrict trusted access to the server,
the key is stored in a new X authority file, XAUTHORITY_
TEMP.DECW$XAUTH.
The authorization key is then extracted and copied to FLOPSY,
and merged with other entries in your X authority file on that
system. You then set host to node FLOPSY and set display to
node ZEPHYR. When you run the clock application from FLOPSY,
it connects to the server on ZEPHYR and is allowed access as
specified by the generated authorization key.
4.$ SET DISPLAY/CREATE/VALUE=-
_$ (NAME=DECW$SESSION_MANAGER,SET="tcpip/zephyr:9510")
$ SHOW DISPLAY/SYMBOLS/ALL
Device: WSA23: [super]
Node: 0
Transport: DECNET
Server: 0
Screen: 0
User-defined values:
"DECW$SESSION_MANAGER" = "tcpip/zephyr:9510"
$ SHOW SYMBOL DECW$DISPLAY__DECW$SESSION_MANAGER
DECW$DISPLAY__DECW$SESSION_MANAGER == "tcpip/zephyr:9510"
$ SET DISPLAY UNTRUSTED/CREATE/XAUTHORITY=TEMP/GENERATE-
_$ /VALUE=(NAME=DECW$SESSION_MANAGER,-)
_$ SET="'DECW$DISPLAY__DECW$SESSION_MANAGER'"
In this example, you create a display device, and set the
DECW$SESSION_MANAGER property to the network address of a
session manager on remote node ZEPHYR using port number 9510.
The SHOW DISPLAY/SYMBOLS command then defines a DCL symbol for
the port value. The symbol is then used to set the port value
for a new display device.
5.$ SET DISPLAY/CREATE/PROXY=GATEWY/NODE=hubbub.company.com-
_$ /PMTRANSPORT=DECNET/NOLBXAUTHENTICATE/TRANSPORT=TCPIP
$ SHOW DISPLAY
Device: WSA23: [super]
Node: HUBBUB.COMPANY.COM
Transport: TCPIP
Server: 0
Screen: 0
Connection will use:
LBX proxy on node: gatewy.company.com
Transport to proxy: TCPIP
Server number: 63
$ RUN SYS$SYSTEM:DECW$CLOCK
In this example, you are logged into a local workstation
(FLOPSY) and want to connect to an external host
(hubbub.company.com), which is outside of your company's
firewall. You use the proxy manager on a gateway host (GATEWY)
to start the LBX proxy server, connect to the external host,
and display the DECwindows Clock application.
Note that DECnet is used within the local area network (LAN)
to communicate to the proxy manager, and TCP/IP is used by
the proxy server to communicate to the X display server on the
external host. When using a managed proxy server, the proxy
server chooses the transport for the client-to-proxy server
connection.
18 – ENTRY
Changes the current status or attributes of a job not currently
executing in a queue.
Requires delete (D) access to the job or manage (M) access to the
queue.
Format
SET ENTRY entry-number[,...]
18.1 – Parameter
entry-number[,...]
Specifies the entry number of the job you want to change. If
you specify more than one entry, separate the entry numbers with
commas (,).
The system assigns a unique entry number to each queued print
or batch job in the system. By default, the PRINT and SUBMIT
commands display the entry number when they successfully queue
a job for processing. These commands also create or update the
local symbol $ENTRY to reflect the entry number of the most
recently queued job. To find a job's entry number, enter the
SHOW ENTRY or the SHOW QUEUE command.
18.2 – Qualifiers
18.2.1 /AFTER
/AFTER=time
/NOAFTER
Requests that the specified job be held until after a specific
time. If the specified time has already passed, the job is
scheduled for processing.
You can specify either absolute time or a combination of absolute
and delta times. For complete information on specifying time
values, see the OpenVMS User's Manual or the online help topic
Date.
NOTE
Releasing or rescheduling a job before its submission time
is not supported for security reasons. Therefore, if you set
the system time to a future time and submit a job on a node
where the queue manager is running, you cannot release or
reschedule that job back to the present time if you reset
the system time.
For example, you can set the system time to a future time of
January 1, 2020 and submit a job to run on January 9, 2020;
however, if you set the system time back to the present time
and try to release the job to the present time, the job will
be released to January 1, 2020.
This situation impacts the following qualifiers: /AFTER,
/NOHOLD, and /RELEASE.
To specify /AFTER for a job on hold, you must also specify
/NOHOLD in order to cause the job to be held only until the
specified time. Jobs can be released before the specified time
by using the /NOAFTER or /RELEASE qualifier with the SET ENTRY
command.
18.2.2 /BURST
/BURST
/NOBURST
Controls whether two file flag pages with a burst bar between
them are printed preceding each file in a job.
Use the /[NO]BURST qualifier to override the /DEFAULT qualifier
options that have been set for the output queue you are using.
The /[NO]BURST qualifier does not override the /SEPARATE
qualifier options set for the queue.
When you specify the /BURST qualifier for a file, the /[NO]FLAG
qualifier does not add or subtract a flag page from the two flag
pages that are printed preceding a file.
18.2.3 /CHARACTERISTICS
/CHARACTERISTICS=(characteristic[,...])
/NOCHARACTERISTICS
Specifies the name or number of one or more characteristics to be
associated with the job. Characteristics can refer to such things
as color of ink. If you specify only one characteristic, you can
omit the parentheses.
A characteristic's number must range from 0 to 127. To see which
characteristics have been defined for your system, use the SHOW
QUEUE/CHARACTERISTICS command. To see which characteristics
are associated with a particular queue, use the SHOW QUEUE/FULL
command.
A print job can be processed on an execution queue if none, some,
or all of the characteristics associated with the queue also are
associated with the job. That is, the job's characteristics must
be a subset of the queue's characteristics. However, if any of
the characteristics associated with the job are not associated
with the queue, the job remains pending until one or more of the
following occurs:
o The characteristics specified with the queue are changed
to make the job's characteristics a subset of the
queue's characteristics (using, for example, the SET
QUEUE/CHARACTERISTICS command).
o The characteristics specified with the job are changed
to make the job's characteristics a subset of the
queue's characteristics (using, for example, the SET
ENTRY/CHARACTERISTICS command).
o The job is moved to a queue on which all the job's
characteristics have been specified (using, for example, the
SET ENTRY/REQUEUE command).
o The job is deleted (using, for example, the DELETE/ENTRY
command).
18.2.4 /CLI
/CLI=filename
Specifies the name of a command language interpreter (CLI) to
use in processing the batch job. The file name specifies that
the CLI be SYS$SYSTEM:filename.EXE. If you do not specify the
/CLI qualifier, the job is run by the CLI specified in the user
authorization file (UAF), or whatever CLI was specified when the
job was originally submitted to the queue.
18.2.5 /COPIES
/COPIES=n
Specifies the number of copies to print. The value of n can be
any number from 1 to 255. When you use the /COPIES qualifier
with the SET ENTRY command, the number of copies can apply
only to the entire print job. You cannot use this qualifier to
specify different numbers of copies for individual files within a
multifile job.
18.2.6 /CPUTIME
/CPUTIME=time
Specifies a CPU time limit for the batch job. You can specify
the time parameter as delta time, the value 0, INFINITE, or NONE.
If the queue on which the job executes has a defined CPUMAXIMUM
value, the smaller of the specified job and queue values is used.
If the queue on which the job executes does not have a specified
maximum CPU time limit, the smaller of the SUBMIT command and
user authorization file (UAF) values is used. If the queue on
which the job executes does not have a specified maximum CPU time
limit and the UAF has a specified CPU time limit of NONE, either
the value 0 or the keyword INFINITE allows unlimited CPU time. If
you specify NONE, the specified queue or UAF value is used. CPU
time values must be greater than or equal to the number specified
by the system parameter PQL_MCPULM.
For information on specifying time values, see the OpenVMS User's
Manual or the online help topic Date.
18.2.7 /FEED
/FEED
/NOFEED
Controls whether form feeds are inserted into the print job when
the printer reaches the bottom margin of the form in use. You can
suppress this automatic form feed (without affecting any of the
other carriage control functions that are in place) by using the
/NOFEED qualifier.
When you use the /FEED qualifier with the SET ENTRY command, the
qualifier applies to all files in the print job. You cannot use
this qualifier to specify form feeds for individual files within
a multifile job.
18.2.8 /FLAG
/FLAG
/NOFLAG
Controls whether a flag page is printed preceding each file in a
print job. The flag page contains the name of the user submitting
the job, the job entry number, and other information about the
file being printed.
Use the /[NO]FLAG qualifier to override the installation-defined
defaults that have been set for the output queue you are using
or to override the qualifier specified in the PRINT command that
queued the job.
18.2.9 /FORM
/FORM=form
Specifies the name or number of the form to be associated with
the print job. If you omit the /FORM qualifier, the default form
for the execution queue is associated with the job.
Forms have attributes such as print image width and length or
paper stock, which the print symbiont associates with a job when
the job is processed. To see which forms have been defined for
your system, use the SHOW QUEUE/FORM command. To find out which
form is mounted currently on a particular queue and which form is
specified as that queue's default form, use the SHOW QUEUE/FULL
command.
The stock of the form associated with the job must match the
stock of the form mounted on the execution queue on which you
want the job to be processed. If the stocks do not match, the job
remains pending until one or more of the following occurs:
o A form with the same stock as the job's form is mounted on
the queue (using, for example, the SET QUEUE/FORM_MOUNTED
command).
o A form with the same stock as the queue's mounted form is
specified with the job (using, for example, the SET ENTRY/FORM
command).
o The job is moved to a queue on which the stock of the mounted
form matches the stock of the job's form (using, for example,
the SET ENTRY/REQUEUE command).
o The job is deleted (using, for example, the DELETE/ENTRY
command).
18.2.10 /HEADER
/HEADER
/NOHEADER
Controls whether a heading line is printed at the top of each
output page in a print job.
18.2.11 /HOLD
/HOLD
/NOHOLD
Controls whether the job is to be made available for processing
or held for processing later. If you specify the /HOLD qualifier,
the job is not released for processing until you enter SET
ENTRY/NOHOLD or SET ENTRY/RELEASE.
You can use the /NOHOLD qualifier to release jobs that have been
held for the following reasons:
o A job was submitted with the /HOLD qualifier.
o A completed job is being retained in a queue.
o A user-written symbiont has refused a job.
NOTE
Releasing or rescheduling a job before its submission time
is not supported for security reasons. Therefore, if you set
the system time to a future time and submit a job on a node
where the queue manager is running, you cannot release or
reschedule that job back to the present time if you reset
the system time.
For example, you can set the system time to a future time of
January 1, 2020 and submit a job to run on January 9, 2020;
however, if you set the system time back to the present time
and try to release the job to the present time, the job will
be released to January 1, 2020.
This situation impacts the following qualifiers: /AFTER,
/NOHOLD, and /RELEASE.
18.2.12 /JOB_COUNT
/JOB_COUNT=n
Requests that an entire print job be printed n times, where n
is a decimal integer from 1 to 255. This qualifier overrides the
/JOB_COUNT qualifier with the PRINT command.
18.2.13 /KEEP
/KEEP
/NOKEEP
Controls whether the batch job log file is deleted after it is
printed.
18.2.14 /LOG_FILE
/LOG_FILE[=filespec]
/NOLOG_FILE
Creates a log file with the specified file specification. You can
specify a different device name, as long as the process executing
the batch job has access to the device on which the log file will
reside. Logical names in the file specification are translated in
the context of the process that executes the SET ENTRY command.
If you omit the /LOG_FILE qualifier and specify the /NAME
qualifier, the log file is written to a file having the same file
name as that specified by the /NAME qualifier; the file type is
.LOG. When you omit the /LOG_FILE qualifier, the job-name value
used with the /NAME qualifier must be a valid file name.
18.2.15 /LOWERCASE
/LOWERCASE
/NOLOWERCASE
Indicates whether the print job must be printed on a printer that
can print both uppercase and lowercase letters. The /NOLOWERCASE
qualifier means that files can be printed on printers that print
only uppercase letters. If all available printers can print both
uppercase and lowercase letters, you do not need to specify the
/LOWERCASE qualifier.
18.2.16 /NAME
/NAME=job-name
Names the job. The job name must be 1 to 39 alphanumeric
characters. The SHOW ENTRY and SHOW QUEUE commands display the
job name. For batch jobs, the job name is also used for the batch
job log file. For print jobs, the job name is also used on the
flag page of the printed output.
The default job name is the name of the first file in the job.
18.2.17 /NOCHECKPOINT
For a batch job, erases the value established by the most
recently executed SET RESTART_VALUE command. For a print job,
clears the stored checkpoint so that the job will restart from
the beginning.
18.2.18 /NODELETE
Cancels file deletion for a job that was submitted with the
/DELETE qualifier. If you did not specify the /DELETE qualifier
when the job was originally submitted to the queue, you cannot
use the SET ENTRY command to establish file deletion at a later
time. You cannot use the /NODELETE qualifier to cancel deletion
of individual files in a multifile job.
18.2.19 /NOTE
/NOTE=string
Specifies a message of up to 255 characters to appear on the
flag page of the print job. Enclose messages containing lowercase
letters, blanks, or other nonalphanumeric characters (including
spaces) in quotation marks (" ").
18.2.20 /NOTIFY
/NOTIFY
/NONOTIFY
Controls whether a message notifies you when your job has been
completed or aborted. Notification is sent to any terminal
session on the same OpenVMS Cluster system to which you are
logged in.
18.2.21 /OPERATOR
/OPERATOR=string
Specifies a message string of up to 255 characters to be sent to
the operator just before the print job begins to print. Enclose
the message in quotation marks (" ") if it contains spaces,
special characters, or lowercase characters.
18.2.22 /PAGES
/PAGES=([lowlim,]uplim)
Specifies the number of pages to print for the specified job.
You can use the /PAGES qualifier to print portions of long files.
By default, all pages of the file are printed. When you use the
/PAGES qualifier with the SET ENTRY command, the qualifier can
apply only to an entire job. You cannot use this qualifier to
specify different numbers of pages to be printed for individual
files within a multifile job.
The lowlim specifier refers to the first page of the file that
you want to print. If you omit the lowlim specifier, the printing
starts on the first page of the file.
The uplim specifier refers to the last page of the file that you
want to print. When you want to print to the end of the file but
do not know how many pages are in the file, use quotation marks
(" ") as the uplim specifier.
You can omit the parentheses when you specify only a value
for the uplim specifier. For example, /PAGES=10 prints the
first 10 pages of the file; /PAGES=(5,10) prints pages 5 to 10;
/PAGES=(5,"") starts printing at page 5 and continues until the
end of the file is reached.
18.2.23 /PARAMETERS
/PARAMETERS=(parameter[,...])
Specifies from one to eight optional parameters to be passed to
the job. Each parameter can have as many as 255 characters. If
you specify only one parameter, you can omit the parentheses.
To specify a parameter that contains any special characters or
delimiters, enclose the parameter in quotation marks.
For batch jobs, the parameters define values to be equated to the
symbols named P1 to P8 in each command procedure in the job. The
symbols are local to the specified command procedures.
18.2.24 /PASSALL
/PASSALL
/NOPASSALL
Specifies whether the symbiont bypasses all formatting of the
print job and sends the output QIO to the driver with format
suppressed. All qualifiers affecting formatting, as well as the
/HEADER, /PAGES, and /PAGE_SETUP qualifiers, are ignored.
When you use the /PASSALL qualifier with the SET ENTRY command,
the qualifier applies to the entire job. You cannot use this
qualifier to specify PASSALL mode for individual files within a
multifile job.
18.2.25 /PRINTER
/PRINTER[=queue-name]
/NOPRINTER
Queues the batch job log file for printing when the job is
completed. The default output queue for the log file is
SYS$PRINT. The /PRINTER qualifier allows you to specify an output
queue. The /NOPRINTER qualifier assumes the /KEEP qualifier.
18.2.26 /PRIORITY
/PRIORITY=n
Requires OPER (operator) or ALTPRI (alter priority) privilege
to raise the priority above the value of the queue's maximum
scheduling priority.
Specifies the job-scheduling priority of the job. The value of
n is an integer in the range of 0 to 255, where 0 is the lowest
priority and 255 is the highest.
The default value for the /PRIORITY qualifier is the value of
the system parameter DEFQUEPRI. No privilege is needed to set the
priority lower than the queue's maximum scheduling priority.
18.2.27 /RAD
/RAD=n (Alpha/Integrity servers)
Specifies the RAD number on which the submitted batch job is to
execute.
When a job is submitted to a batch queue that does not have a
RAD setting, the job will execute using the RAD specified. If the
batch queue has a RAD setting, the job will execute using the RAD
specified on the queue.
RAD is supported on AlphaServer GS series systems and starting
from OpenVMS Version 8.4, support is extended to NUMA capable
Integrity servers.
18.2.28 /RELEASE
You can use the /RELEASE qualifier to release jobs that have been
held for the following reasons:
o A job was submitted with the /AFTER qualifier.
o A job was submitted with the /HOLD qualifier.
o A completed job is being retained in a queue.
o A user-written symbiont has refused a job.
NOTE
Releasing or rescheduling a job before its submission time
is not supported for security reasons. Therefore, if you set
the system time to a future time and submit a job on a node
where the queue manager is running, you cannot release or
reschedule that job back to the present time if you reset
the system time.
For example, you can set the system time to a future time of
January 1, 2020 and submit a job to run on January 9, 2020;
however, if you set the system time back to the present time
and try to release the job to the present time, the job will
be released to January 1, 2020.
This situation impacts the following qualifiers: /AFTER,
/NOHOLD, and /RELEASE.
18.2.29 /REQUEUE
/REQUEUE=queue-name[:]
Requests that the job be moved from the original queue to the
specified queue.
18.2.30 /RESTART
/RESTART
/NORESTART
Specifies whether a batch or print job is restarted after a
system failure or a STOP/QUEUE/REQUEUE command.
18.2.31 /RETAIN
/RETAIN=option
Specifies the circumstances under which you want your jobs to be
retained in a queue. When a job is retained in the queue, you can
issue the SHOW QUEUE command after the job completes to see the
status of the job. Without job retention, no record of a job is
left in a queue after a job completes.
Use the following options to specify job retention:
o ALWAYS-Holds the job in the queue regardless of the job's
completion status.
o DEFAULT-Holds the job in the queue as specified by the queue's
retention policy.
o ERROR-Holds the job in the queue only if the job completes
unsuccessfully.
o UNTIL=time-value--Holds the job in the queue for the specified
length of time, regardless of the job's completion status.
NOTE
You cannot specify a /NORETAIN qualifier with the SET
ENTRY command (as system managers can with the commands
INITIALIZE/QUEUE, START/QUEUE, and SET QUEUE); however, you
can specify /RETAIN=DEFAULT with the SET ENTRY command. The
default option holds the job in the queue as specified by
the queue's retention policy. If the system manager has not
specified retention for the queue, the job is not retained.
How Job Retention Is Determined
Although you can specify job retention options for your own jobs,
the job retention option you specify may be overridden by the job
retention option of the queue on which your job executed. If you
submit or print a job to a generic queue, the generic queue's job
retention setting may also override the job retention option you
specify. This section describes how job retention is determined.
An execution queue's job retention setting takes precedence
over a generic queue's job retention setting; however, if the
job's completion status does not match the job retention setting
(if any) on the execution queue, then the generic queue's job
retention setting attempts to control job retention. If the job's
completion status does not match the job retention setting (if
any) on the generic queue, then the user-specified job retention
setting is used. Jobs submitted directly to execution queues are
not affected by job retention settings on generic queues.
If the execution queue's retention setting applies, the job is
retained on the execution queue. Likewise, if the generic queue's
retention setting applies, the job is retained on the generic
queue. If the user-specified setting applies, the job is retained
in the queue to which it was submitted.
The following example illustrates how the queue manager
determines job retention:
Suppose you submit a job to a generic queue and specify
/RETAIN=ALWAYS, and the job completes successfully.
First, the queue manager compares the job's completion status
to the execution queue's retention setting. Suppose the queue
is set with /RETAIN=ERROR (retains only jobs that complete
unsuccessfully). The job is not retained in the execution queue
because the error condition was not met.
Second, the queue manager compares the job's completion status to
the generic queue's retention setting. Suppose the generic queue
has no retention setting. The queue manager's comparison again
fails to retain the job.
Finally, the queue manager compares the job's completion
status to the retention setting you specified for the job. This
comparison reveals that the job should be retained. Because the
user-specified setting leads the queue manager to retain the job,
the job is held in the queue to which the job was submitted-in
this case, the generic queue.
For more information on types of queues, see the INITIALIZE/QUEUE
command. For more information on setting retention options for
queues, see the INITIALIZE/QUEUE, START/QUEUE, or SET QUEUE
command.
Timed Retention
Timed retention, which you specify using the UNTIL=time-value
option, allows you to retain a job in the queue only as long as
you need it. This eliminates the need to delete the job from the
queue later.
For example, the following command retains job 172 in the queue
until 7:31 on April 19, when the job will automatically be
deleted from the queue.
$ SET ENTRY/RETAIN=UNTIL=19-APR-2001:07:31:0.0 172
However, depending on the queue's job retention policy, the
job might be retained indefinitely. The job retention policy
set on the queue takes precedence over the user-specified job
retention setting. Because system managers cannot specify timed
job retention for a queue, any jobs retained as a result of a
queue's setting are retained indefinitely.
If you specify the /RETAIN=UNTIL=time-value option, you must
supply a time value. The time value is first interpreted as
a delta time, then as a combination time, and finally as
absolute time. If you specify a delta time, the delta begins
when the job completes. For example, if you specify SET
ENTRY/RETAIN=UNTIL="+3:00", the job will be retained for three
hours after the job completes. For information on specifying time
values, see the OpenVMS User's Manual.
18.2.32 /SETUP
/SETUP=module[,...]
Extracts the specified modules from the device control library
(containing escape sequence modules for programmable printers)
and copies the modules to the printer before each file in a print
job is printed.
When you use the /SETUP qualifier with the SET ENTRY command, the
qualifier applies to the entire print job. You cannot use this
qualifier to specify different setup modules for individual files
within a multifile job.
18.2.33 /SPACE
/SPACE
/NOSPACE
Controls whether the output of a print job is double-spaced.
Specifying the /NOSPACE qualifier causes the output to be single-
spaced. When you use the /SPACE qualifier with the SET ENTRY
command, the qualifier applies to the entire job. You cannot use
this qualifier to specify different spacing for individual files
within a multifile job.
18.2.34 /TRAILER
/TRAILER
/NOTRAILER
Controls whether a trailer page is printed at the end of each
file in a print job. The trailer page displays the entry number,
as well as information about the user submitting the job and the
files being printed.
When you use the /TRAILER qualifier with the SET ENTRY command,
trailer pages are placed at the end of each file in a multifile
job.
Use the /[NO]TRAILER qualifier to override the installation-
defined defaults that have been set for the output queue you are
using or the qualifier specified in the PRINT command that queued
the job.
18.2.35 /WSDEFAULT
/WSDEFAULT=n
Defines, for a batch job, a working set default, which is the
default number of physical pages that the job can use.
If the queue on which the job executes has a nonzero default
working set, the smaller of the specified job and queue values
is used. If the queue on which the job executes has a working set
default of zero, the smaller of the specified job value and the
value established in the user authorization file (UAF) is used.
Specify the value of n as a number of 512-byte pagelets on
Alpha. Note that the operating system rounds up this value to the
nearest CPU-specific page so that the actual amount of physical
memory allowed may be larger than the specified amount on Alpha.
If you specify zero or NONE, the specified queue or UAF value is
used. Working set default values must range between the numbers
specified by the system parameters PQL_MWSDEFAULT and WSMAX.
18.2.36 /WSEXTENT
/WSEXTENT=n
Defines, for the batch job, a working set extent, which is the
maximum amount of physical memory that the job can use. The job
uses the maximum amount of physical memory only when the system
has excess free pages. If the queue on which the job executes has
a nonzero working set extent, the smaller of the specified job
and queue values is used. If the queue on which the job executes
has a working set extent of zero, the smaller of the specified
job value and the value established in the user authorization
file (UAF) is used.
Specify the value of n as a number of 512-byte pagelets on
Alpha. Note that the operating system rounds up this value to the
nearest CPU-specific page so that the actual amount of physical
memory allowed may be larger than the specified amount on Alpha.
If you specify zero or NONE, the specified queue or UAF value is
used. Working set extent values must range between the numbers
specified by the system parameters PQL_MWSEXTENT and WSMAX.
18.2.37 /WSQUOTA
/WSQUOTA=n
Defines, for the batch job, a working set quota, which is the
amount of physical memory that the job is guaranteed. If the
queue on which the job executes has a nonzero working set quota,
the smaller of the specified job and queue values is used. If the
queue on which the job executes has a working set quota of zero,
the smaller of the specified job value or the value established
in the user authorization file (UAF) is used.
Specify the value of n as a number of 512-byte pagelets on
Alpha. Note that the operating system rounds up this value to the
nearest CPU-specific page so that the actual amount of physical
memory allowed may be larger than the specified amount on Alpha.
If you specify zero or NONE, the specified queue or UAF value
is used. Working set quota values must range between the numbers
specified by the system parameters PQL_MWSQUOTA and WSMAX.
18.3 – Examples
1.$ PRINT/HOLD MYFILE.DAT
Job MYFILE (queue SYS$PRINT, entry 112) holding
$ SET ENTRY 112/RELEASE/JOB_COUNT=3
The PRINT command in this example requests that the file
MYFILE.DAT be queued to the system printer, but placed in
a hold status. The SET ENTRY command releases the job for
printing and requests that three copies of the job be printed.
2.$ SUBMIT CLIMATE
Job CLIMATE (queue SYS$BATCH, entry 211) pending
$ SET ENTRY 211/HOLD/NAME=TEMP
The SUBMIT command in this example queues the command procedure
CLIMATE.COM for processing as a batch job. The SET ENTRY
command places the job in a hold state and changes the job name
to TEMP, assuming that the job has not yet begun execution.
3.$ PRINT/FLAG=ALL/AFTER=20:00 MEMO.MEM, LETTER.MEM, REPORT.MEM/SPACE
Job MEMO (queue SYS$PRINT, entry 172) holding until 20:00
$ SET ENTRY 172 /BURST/NOSPACE/HEADER
The PRINT command in this example requests that three files be
printed after 8:00 P.M. on the default printer with flag pages
preceding each file. It also requests that the file REPORT.MEM
be double-spaced. Later a SET ENTRY command calls for a burst
page at the beginning of each file and requests that all files
in the job be single-spaced. This command also requests that
headers be printed on each page of each file in the job.
4.$ SUBMIT/HOLD/QUEUE=ANYRADQ TEST.COM
Job TEST (queue ANYRADQ, entry 23) holding
$ SET ENTRY 23 /RAD=1
$ SHOW ENTRY/FULL 23
Entry Jobname Username Blocks Status
----- ------- -------- ------ ------
23 TEST SYSTEM Holding
On idle batch queue ANYRADQ
Submitted 24-JUL-2001 14:19:37.44 /KEEP /NOPRINT /PRIORITY=100 /RAD=0
File: _$1$DKB200:[SWEENEY.CLIUTL]TEST.COM;1
In this example, TEST.COM is submitted to the queue ANYRADQ,
and the SET ENTRY command is used to set the RAD to 1.
19 – FILE
Modifies the characteristics of one or more files.
See the qualifier descriptions for restrictions.
For help about the RMS Journaling SET FILE commands, read the
following subtopics:
o /AI_JOURNAL - Marks one or more RMS files for after-image
journaling.
o /BI_JOURNAL - Marks one or more RMS files for before-image
journaling.
o /RU_ACTIVE - Designates the recoverable facility that controls
active recovery units for the file.
o /RU_FACILITY - Allows you to identify the recoverable facility
that controls active recovery units on the file.
o /RU_JOURNAL - Marks an RMS file for recovery unit journaling.
Format
SET FILE filespec[,...]
19.1 – Parameter
filespec[,...]
Specifies one or more files to be modified. If you specify more
than one file, separate the file specifications with commas (,).
The asterisk (*) and the percent sign (%) wildcard characters
are allowed.
19.2 – Qualifiers
19.2.1 /ATTRIBUTE
/ATTRIBUTE=(file-attribute[,...])
Sets the attributes associated with a file. The following table
lists possible keywords and the relationship to both ACP-QIO and
OpenVMS RMS File attributes:
OpenVMS RMS File
Keyword ACP-QIO File Attribute Attribute
ATTDATE=dateFAT$C_ATTDATE XAB$Q_ATT
ACCDATE=dateFAT$C_ACCDATE XAB$Q_ACC
BAKDATE=dateFAT$C_BAKDATE XAB$Q_BDT
BKS:value FAT$B_BKTSIZE=byte FAB$B_BKS=byte
CREDATE=dateFAT$C_CREDATE XAB$Q_CDT
DEQ:value FAT$W_DEFEXT=word FAB$W_DEQ=word
EBK:value FAT$L_EFBLK=longword XAB$L_EBK=longword
EXPDATE=dateFAT$C_EXPDATE XAB$Q_EDT
FFB:value FAT$W_FFBYTE=word XAB$W_FFB=word
FSZ:value FAT$B_VFCSIZE=byte FAB$B_FSZ=byte
GBC:value FAT$W_GBC=word FAB$W_GBC=word
HBK:value FAT$L_HIBLK=longword XAB$L_HBK=longword
LRL:value FAT$W_RSIZE=word XAB$W_LRL=word
MODDATE=dateFAT$C_MODDATE XAB$Q_MOD
MRS:value FAT$W_MAXREC=word FAB$W_MRS=word
ORG:IDX FAT$V_FILEORG=FAT$C_INDEXED FAB$B_ORG=FAB$C_IDX
ORG:REL FAT$V_FILEORG=FAT$C_RELATIVE FAB$B_ORG=FAB$C_REL
ORG:SEQ FAT$V_FILEORG=FAT$C_SEQUENTIAL FAB$B_ORG=FAB$C_SEQ
RAT:BLK FAT$B_RATTRIB=FAT$M_NOSPAN FAB$B_RAT=FAB$M_BLK
RAT:CR FAT$B_RATTRIB=FAT$M_IMPLIEDCC FAB$B_RAT=FAB$M_CR
RAT:FTN FAT$B_RATTRIB=FAT$M_FORTRANCC FAB$B_RAT=FAB$M_FTN
RAT:MSB FAT$B_RATTRIB=FAT$M_MSBVAR FAB$B_RAT=FAB$M_MSB
RAT:NONE FAT$B_RATTRIB=0 FAB$B_RAT=0
RAT:PRN FAT$B_RATTRIB=FAT$M_PRINTCC FAB$B_RAT=FAB$M_PRN
REVDATE=dateFAT$C_REVDATE XAB$Q_RDT
RFM:FIX FAT$V_RTYPE=FAT$C_FIXED FAB$B_RFM=FAB$C_FIX
RFM:STM FAT$V_RTYPE=FAT$C_STREAM FAB$B_RFM=FAB$C_STM
RFM:STMCR FAT$V_RTYPE=FAT$C_STREAMCR FAB$B_RFM=FAB$C_STMCR
RFM:STMLF FAT$V_RTYPE=FAT$C_STREAMLF FAB$B_RFM=FAB$C_STMLF
RFM:UDF FAT$V_RTYPE=FAT$C_UNDEFINED FAB$B_RFM=FAB$C_UDF
RFM:VAR FAT$V_RTYPE=FAT$C_VARIABLE FAB$B_RFM=FAB$C_VAR
RFM:VFC FAT$V_RTYPE=FAT$C_VFC FAB$B_RFM=FAB$C_VFC
VRS:value FAT$W_VERSIONS=word XAB$W_VERLIMIT=word
19.2.2 /BACKUP
/BACKUP
/NOBACKUP
Specifies that the Backup utility (BACKUP) records the contents
of the file. The /NOBACKUP qualifier causes BACKUP to record the
attributes of the file but not its contents. This qualifier is
valid only for Files-11 Structure On-Disk Level 2 and 5 files.
The /NOBACKUP qualifier is useful for saving files that contain
unimportant data, such as SWAPFILES.
19.2.3 /BEFORE
/BEFORE[=time]
Selects only those files dated prior to the specified time.
You can specify time as absolute time, as a combination of
absolute and delta times, or as one of the following keywords:
BOOT, LOGIN, TODAY (default), TOMORROW, or YESTERDAY. Specify
the /CREATED or the /MODIFIED qualifier to indicate the time
attribute to be used as the basis for selection. The /CREATED
qualifier is the default.
For complete information on specifying time values, see the
OpenVMS User's Manual or the online help topic Date.
19.2.4 /BY_OWNER
/BY_OWNER[=uic]
Selects only those files whose owner user identification code
(UIC) matches the specified owner UIC. The default UIC is that of
the current process.
Specify the UIC by using standard UIC format as described in the
VSI OpenVMS Guide to System Security.
19.2.5 /CACHING_ATTRIBUTE
/CACHING_ATTRIBUTE=keyword
Use this qualifier to control which files are cached by the
Extended File Cache. It sets the caching attribute for a file
or directory in a Files-11 ODS-2 or ODS-5 volume.
The caching attribute of a file is the default caching option
that is used by the Extended File Cache when an application
accesses the file without specifying which caching option it
wants to use.
The keyword can be either WRITETHROUGH or NO_CACHING. Use
WRITETHROUGH for files that you want to be cached. Use NO_CACHING
for files that you don't want to be cached.
The Extended File Cache does not cache directories. The caching
attribute of a directory controls only how the caching attribute
is inherited by new files and subdirectories created in the
directory:
o When you create a new directory or file, it inherits its
caching attribute from its parent directory.
o When you create a new version of an existing file, the new
file inherits its caching attribute from the highest version
of the existing file.
When you use the INITIALIZE command to create a new Files-
11 volume, the caching attribute of its root directory
(000000.DIR;1) is set to write-through. This means that by
default, all the files and directories you create in the volume
will inherit a caching attribute of write-through unless you use
SET FILE /CACHING_ATTRIBUTE.
When you change the caching attribute of a directory, it does
not affect the caching attribute of any existing files and
subdirectories in the directory.
When you change the caching attribute of a file, it does not
affect the type of caching being used by any applications that
are currently accessing the file.
19.2.6 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
Controls whether a request is issued before each SET FILE
operation to confirm that the operation should be performed on
that file. The following responses are valid:
YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL
<Return>
You can use any combination of uppercase and lowercase letters
for word responses. Word responses can be abbreviated to one or
more letters (for example, T, TR, or TRU for TRUE), but these
abbreviations must be unique. Affirmative answers are YES, TRUE,
and 1. Negative answers include: NO, FALSE, 0, and pressing
Return. Entering QUIT or pressing Ctrl/Z indicates that you want
to stop processing the command at that point. When you respond by
entering ALL, the command continues to process, but no further
prompts are given. If you type a response other than one of
those in the list, DCL issues an error message and redisplays
the prompt.
19.2.7 /CREATED
/CREATED (default)
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /CREATED qualifier selects files based on their
dates of creation. This qualifier is incompatible with the
/MODIFIED qualifier, which also allows you to select files
according to time attributes. The /CREATED qualifier is the
default qualifier.
19.2.8 /DATA_CHECK
/DATA_CHECK[=([NO]READ,[NO]WRITE)]
Specifies whether a read data check (rereading each record), a
write data check (reading each record after it is written), or a
combination of the two is performed on the file during transfers.
By default, a write data check is performed.
19.2.9 /END_OF_FILE
Resets the end-of-file (EOF) mark to the highest block allocated.
19.2.10 /ENTER
/ENTER=new-filespec
The new-filespec parameter is used to create either an alias or
a hard link for the file specified in the SET FILE command. For
detailed information about using hard links and aliases, see the
VSI OpenVMS System Manager's Manual.
Normally you would use /ENTER to create an alias or a hard link
in a directory different from the one where the original filename
resides. If the names are not in different directories, you or
another user could subsequently lose data during a delete or
purge operation. The DELETE and PURGE commands and the file
version limit feature can behave unpredictably if the original
name and the new name are in the same directory.
To remove an alias or hard link, use the SET FILE /REMOVE
command. Exercise caution when using the DELETE and SET FILE
/REMOVE commands, or you could end up with either an inaccessible
file that has no name or a name that does not refer to a file.
Follow these guidelines to avoid such problems:
o Use SET FILE /REMOVE to remove an alias; do not use the DELETE
command to remove an alias.
o Do not use SET FILE /REMOVE to remove the original file name.
If you do not follow these guidelines and encounter problems, use
ANALYZE /DISK /REPAIR to move inaccessible files to the SYSLOST
directory and remove names that no longer refer to files.
19.2.11 /ERASE_ON_DELETE
Specifies that the specified files are erased from the disk (not
just written over) when the DELETE or PURGE command is issued for
the files. See the DELETE/ERASE command for more information.
19.2.12 /EXCLUDE
/EXCLUDE=(filespec[,...])
Excludes the specified file from the SET FILE operation. You
can include a directory name but not a device name in the file
specifications. The asterisk (*) and the percent sign (%)
wildcard characters are allowed in the file specification;
however, you cannot use relative version numbers to exclude a
specific version. If you specify only one file, you can omit the
parentheses.
19.2.13 /EXPIRATION_DATE
/EXPIRATION_DATE=date
/NOEXPIRATION_DATE
Requires read (R), write (W), and control access. Being the owner
of the file is one way to get control access.
Controls whether an expiration date is assigned to the specified
files.
Specify the date according to the rules described in the OpenVMS
User's Manual or the online help topic Date. Absolute date
keywords are allowed. If you specify zero as the date, today's
date is used.
19.2.14 /EXTENSION
/EXTENSION[=n]
Sets the extend quantity default for the file. The value of
the parameter n can range from 0 to 65,535. If you omit the
value specification or specify a value of 0, OpenVMS Record
Management Services (OpenVMS RMS) calculates its own value for
the /EXTENSION qualifier.
See the SET RMS_DEFAULT command for a description of the /EXTEND_
QUANTITY qualifier.
19.2.15 /GLOBAL_BUFFER
/GLOBAL_BUFFER[=keyword[=n]]
/NOGLOBAL_BUFFER
For OpenVMS versions prior to Version 8.3, sets the OpenVMS
Record Management Services (OpenVMS RMS) global buffer count (the
number of buffers that can be shared by processes accessing the
file) for the specified files. The value n must be an integer in
the range from 0 to 32,767. A value of 0 disables buffer sharing.
The /SHARE qualifier can be used to enable or disable global
buffers on a file currently being accessed; however, any new
global buffer settings will only be applied to new accessors of
the file. If a file is already open with global buffers, any new
number of global buffers will not take effect until the file is
closed by all accessors of the file.
For OpenVMS V8.3 and later, sets the OpenVMS RMS global buffer
count for the specified files. Note, you can specify only one
type of global buffer qualifier in the same command string.
The keyword can be:
o COUNT=n-The value n sets the longword count of the number of
global buffers.
o PERCENT=p-The value p expresses the size of the global cache
as a percent of the total number of used blocks currently used
in the file.
o DEFAULT-Requests RMS at runtime to recalculate the global
cache size based on an algorithm that makes use of two global
buffer SYSGEN parameters, GB_CACHEALLMAX and GB_DEFPERCENT.
The following qualifiers can also be used with the /SHARE
qualifier:
o /GLOBAL_BUFFER=n
o /GLOBAL_BUFFER=COUNT=n
o /GLOBAL_BUFFER=PERCENT=n
o /GLOBAL_BUFFER=DEFAULT
o /NOGLOBAL_BUFFER
o /[NO]STATISTICS
19.2.16 /LOG
/LOG
/NOLOG (default)
Displays the file specification of each file modified as the
command executes.
19.2.17 /MODIFIED
/MODIFIED
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /MODIFIED qualifier selects files according to
the dates on which they were last modified. This qualifier is
incompatible with the /CREATED qualifier, which also allows
you to select files according to time attributes. If you do not
specify the /MODIFIED qualifier, the default is the /CREATED
qualifier.
19.2.18 /MOVE
/MOVE
/NOMOVE
Controls whether movefile operations are enabled on the specified
file.
When you create a file, movefile operations are enabled on that
file. You should disable movefile operations on specialized
files that are accessed other than through the XQP (such as files
accessed through logical I/O to a disk).
Note that movefile operations are automatically disabled on
critical system files. Do not enable movefile operations on these
files.
19.2.19 /NODIRECTORY
Use with extreme caution. Requires SYSPRV (system privilege).
Removes the directory attributes of a file and allows you to
delete the corrupted directory file even if other files are
contained in the directory. When you delete a corrupted directory
file, the files contained within it are lost.
Use ANALYZE/DISK_STRUCTURE/REPAIR to place the lost files in
[SYSLOST]. You can then copy the lost files to a new directory.
This qualifier is valid only for Files-11 On-Disk Structure Level
2 files. For more information about the Verify utility, see the
VSI OpenVMS System Management Utilities Reference Manual.
19.2.20 /OWNER_UIC
/OWNER_UIC[=uic]
This qualifier has been superseded by the SET SECURITY/OWNER
command.
19.2.21 /PROTECTION
/PROTECTION[=(ownership[:access][,...])]
This command has been superseded by the SET SECURITY/PROTECTION
command.
19.2.22 /REMOVE
Use with caution.
Enables you to remove one of the names of a file that has more
than one name, without deleting the file. If you have created an
additional name for a file with the /ENTER qualifier of SET FILE,
you can use the /REMOVE qualifier to remove either the original
name or the alias. The file still exists and can be accessed by
whatever name or names remain in effect.
However, if you accidentally remove the name of a file that
has only one name, you cannot access that file with most DCL
commands; use the ANALYZE/DISK_STRUCTURE utility to retrieve the
file.
19.2.23 /SEMANTICS
/SEMANTICS=semantics-tag
/NOSEMANTICS
Use the /SEMANTICS qualifier to create or change a semantics
tag. Use the /NOSEMANTICS qualifier to remove a semantics tag
from a file. For more information, see the Guide to OpenVMS File
Applications.
19.2.24 /SHARE
Allows you to enable or disable global buffers or statistics on a
file currently being accessed by other users.
Requires SYSPRV privilege.
Only new accessors of the file acquire the new settings. For
example, if a file is opened with no global buffers specified and
the SET FILE/GLOBAL=n/SHARE command is issued, only new accessors
of the file will use global buffers. If /STATISTICS is enabled on
an active file, only operations performed by new accessors of the
file are measured.
If a file is already open with global buffers, any new number of
global buffers will not take effect until the file is closed by
all accessors of the file.
The /SHARE qualifier is valid only with the following qualifiers:
o /[NO]GLOBAL_BUFFER=n
o /[NO]STATISTICS
19.2.25 /SHELVABLE
/SHELVABLE
/NOSHELVABLE
Controls whether the file is shelvable.
19.2.26 /SINCE
/SINCE[=time]
Selects only those files dated on or after the specified time.
You can specify time as absolute time, as a combination of
absolute and delta times, or as one of the following keywords:
BOOT, JOB_LOGIN, LOGIN, TODAY (default), TOMORROW, or YESTERDAY.
Specify the /CREATED or the /MODIFIED qualifier to indicate
the time attribute to be used as the basis for selection. The
/CREATED qualifier is the default.
For complete information on specifying time values, see the
OpenVMS User's Manual or the online help topic Date.
19.2.27 /STATISTICS
/STATISTICS
/NOSTATISTICS (default)
Enables the gathering of RMS statistics on the specified file.
These statistics can then be viewed by using the Monitor
utility, which is invoked with the DCL command MONITOR. The
SET FILE/STATISTICS command applies an application ACE to the
specified file. The ACE does not affect access control and is
only meaningful to the application assigning it.
The /SHARE qualifier can be used to enable or disable statistics
on a file currently being accessed. However, only statistics of
new accessors of the file will be measured.
19.2.28 /STYLE
/STYLE=keyword
Specifies the file name format for display purposes.
The valid keywords for this qualifier are CONDENSED and EXPANDED.
Descriptions are as follows:
Keyword Explanation
CONDENSED Displays the file name representation of what is
(default) generated to fit into a 255-length character string.
This file name may contain a DID or FID abbreviation
in the file specification.
EXPANDED Displays the file name representation of what is
stored on disk. This file name does not contain any
DID or FID abbreviations.
The keywords CONDENSED and EXPANDED are mutually exclusive. This
qualifier specifies which file name format is displayed in the
output message, along with the confirmation if requested.
File errors are displayed with the CONDENSED file specification
unless the EXPANDED keyword is specified.
See the OpenVMS User's Manual for more information.
19.2.29 /SYMLINK
/SYMLINK=keyword
/NOSYMLINK (default)
If an input file is a symbolic link, the file referred to by the
symbolic link is the file that is set.
The /SYMLINK qualifier indicates that the symbolic link itself is
set.
The valid keywords for this qualifier are [NO]WILDCARD,
[NO]ELLIPSIS, and [NO]TARGET. Descriptions are as follows:
Keyword Explanation
NOWILDCARD Indicates that symlinks are disabled during directory
wildcard searches.
WILDCARD Indicates that symlinks are enabled during wildcard
searches.
NOELLIPSIS Indicates that symlinks are matched for all wildcard
fields except for ellipsis.
ELLIPSIS Equivalent to WILDCARD (included for command
symmetry).
TARGET Indicates that if the target file of the file
specification is a symlink, then the target file
is followed.
NOTARGET Indicates that the command operates on the target
file even if it is a symlink.
If the file named in the SET FILE command is a symlink, the
command by default operates on the symlink target.
19.2.30 /TRUNCATE
Truncates the file at the end of the block containing the end-of-
file (EOF) marker, that is, the qualifier releases allocated but
unused blocks of the file.
19.2.31 /UNLOCK
Clears a file marked as deaccess locked. Deaccess locking is
required by and used by those few applications that maintain
their own locking and consistency, typically without the use
of the OpenVMS distributed lock manager, and potentially also
without the use of RMS. When an application using deaccess
locking does not correctly deaccess the file (often due to an
application or system failure), the file is marked as locked, and
is thus inaccessible until the integrity of the contents of the
file are verified and the SET FILE/UNLOCK command is used.
This command does not affect the state of files that are locked
using RMS or the distributed lock manager.
For details on file deaccess locking, see the VSI OpenVMS I/O
User's Reference Manual, the ACP-QIO interface documentation, and
specifically the FIB$V_DLOCK option available on the IO$_CREATE
and IO$_ACCESS functions.
The SET FILE/UNLOCK command can clear the cause of the following
error message:
%SYSTEM-W-FILELOCKED, file is deaccess locked
However, this command cannot resolve the cause of the error
message:
%RMS-W-FLK, file currently locked by another user
19.2.32 /VERSION_LIMIT
/VERSION_LIMIT[=n]
Specifies the maximum number of versions for the specified file.
If you do not specify a version limit, a value of 0 is used,
indicating that the number of versions of a file is limited only
to the Files-11 architectural limit of 32,767. When you exceed
that limit, the earliest version of the file is deleted from
the directory without notification to the user. For example, if
you set the version limit to three when there are already five
versions of that file in your directory, there will continue to
be five versions of the file unless you specifically delete some
or purge the directory. Once the number of versions is equal
to or less than the current version limit, the version limit is
maintained.
19.3 – Examples
1.$ SET FILE/EXPIRATION_DATE=19-DEC-2001:11:00 BATCH.COM;3
The SET FILE command requests that the expiration date of the
file BATCH.COM;3 be set to 11:00 A.M., December 19, 2001.
2.$ SET FILE/BEFORE=31-DEC/ERASE_ON_DELETE PERSONNEL*.SAL
This SET FILE command calls for all files that match the file
specification PERSONNEL*.SAL and are dated before December
31 of the current year to have their disk locations erased
whenever one of them is deleted with commands such as DELETE or
PURGE.
3.$ SET FILE/OWNER_UIC=[360,020]/VERSION_LIMIT=100 MYFILE.DAT
The SET FILE command modifies the characteristics of the file
MYFILE.DAT, changing the owner user identification code (*).
You must have system privilege (SYSPRV) to change the owner
UIC.
4.$ SET FILE/NOMOVE TEST.FDL
$DIRECTORY/FULL TEST.FDL
Directory SYS$SYSDEVICE:[BERGMANN]
TEST.FDL;1 File ID: (10,8,0)
.
.
.
File attributes: Allocation: s, Extend: 0, Global buffer count: 0
No version limit, MoveFile disabled
.
.
.
Movefile operations are disabled on the file TEST.FDL. A
DIRECTORY/FULL command on the file TEST.FDL affirms that the
file attribute Movefile is disabled.
5.$ SET FILE/ATTRIBUTES=ORG:SEQ -
_$ TEST$:[DATA]SET_ATTRIBUTES.DATA_FILE/LOG
%SET-I-MODIFIED, TEST$:[DATA]SET_ATTRIBUTES.DATA_FILE;1 MODIFIED
The command, SET FILE/ATTRIBUTES, changes the file organization
of the specified file.
6.$ SET FILE/PROTECTION=(S:RWE,O=RWE,G:RE,W:RE) TEMP.DIR
$ DIRECTORY/PROTECTION TEMP.DIR
Directory DKB0:[FULGHUM]
TEMP.DIR;1 (RWE,RWE,RE,RE)
This example sets the protection on the TEMP.DIR file with the
SET FILE command and then displays the protection of the file
with the DIRECTORY command.
7.$ SET FILE/SHARE/GLOBAL_BUFFER=5000/STATISTICS INVENTORY.IDX
This example sets 5000 global buffers on the INVENTORY.IDX file
and enables statistics. If the file is open and the SET FILE
command is issued without the /SHARE qualifier, the following
error is returned: SYSTEM-W-ACCONFLICT (file access conflict).
The /SHARE qualifier allows the global buffers and statistics
to be enabled on an open file; however, these settings only
apply to new accessors of the file.
8.$ SET FILE/GLOBAL_BUFFER=100 NEWFILE.DAT
$ SET FILE/GLOBAL_BUFFER=COUNT=100000 NEWFILE.DAT
In a clustered environment with mixed OpenVMS versions, the
same file can be opened on different nodes with different
global buffer counts. For nodes prior to Version 8.3, use the
old compatibility setting, and for Version 8.3 nodes and later
use the new values.
19.4 /AI_JOURNAL
Requires read (R), write (W), and control access. Being the owner
of the file is one way to get control access.
Marks one or more RMS files for after-image journaling. You can
also specify certain characteristics of the journal with this
command, including its file specification, whether it is to be
created, its initial size, and its default extension quantity.
The SET FILE/NOAI_JOURNAL command unmarks a file for after-image
journaling.
The SET FILE command is not supported for remote files. You
must use the SET FILE command from the system where the file
is located.
For more information, see the RMS Journaling documentation.
Format
SET FILE/[NO]AI_JOURNAL=(FILE=journal-filespec[,...])
data-filespec[,...]
19.4.1 – Parameter
data-filespec[,...]
Identifies the file to be marked for after-image journaling. If
you specify more than one file, separate the file specifications
with commas. The asterisk (*) and the percent sign (%) wildcard
characters are allowed. The file specification cannot include a
node name, since the SET FILE command is not valid for network
access.
19.4.2 – Description
The SET FILE/AI_JOURNAL command marks one or more RMS files
for after-image journaling. You can also specify certain
characteristics of the journal with this command, including its
file specification, whether it is to be created, its initial
size, and its default extension quantity. The SET FILE/NOAI_
JOURNAL command unmarks a file for after-image journaling. After
a data file is marked for after-image journaling with the SET
FILE/AI_JOURNAL command, the following events occur whenever the
file is opened by RMS for write operations:
o The journal is opened.
o All subsequent modifications to the data file are recorded in
the journal.
NOTE
To be able to recover the data file at a later time,
you must make a backup copy of the data file, even if it
contains no data.
You must use the FILE keyword to specify a journal. By default,
any portions of the file specification that you omit will be the
same as the data file that is to be journaled, but with the file
type RMS$JOURNAL. That is, if you issue the following command,
then, by default, the file specification for the after-image
journal is JOURNAL_DISK:PAYROLL.RMS$JOURNAL:
$ SET FILE/AI_JOURNAL=(FILE=JOURNAL_DISK:) FINANCE_DISK:PAYROLL.DAT
You should always keep the journal for after-image applications
on a different volume from that of your data file. If recovery
becomes necessary, you will be able to perform after-image
recovery only if a backup copy of the data file is available.
Use the FILE keyword to specify the journal location.
Use the SET FILE/NOAI_JOURNAL command to unmark a file for after-
image journaling. After you use the SET FILE/NOAI_JOURNAL command
for a file, modifications to that data file will no longer be
written to the journal.
You must use the SET FILE/NOAI_JOURNAL command before you can
delete a file that has been marked for after-image journaling.
19.4.3 – Keywords
Four keywords are used as parameters to the SET FILE/AI_JOURNAL
command: ALLOCATION, [NO]CREATE, EXTENSION, and FILE. You must
always use the FILE keyword; you can also use any, all, or none
of the other three keywords.
Use an equal sign (=) immediately after the SET FILE/AI_JOURNAL
command to use a keyword. If you use more than one of the
keywords, enclose the list in parentheses and separate the items
in the list with commas.
ALLOCATION=n
Specifies the initial size, in blocks, of the journal. The
ALLOCATION keyword is meaningful only when the CREATE keyword
is also used.
The default allocation is 0 blocks.
CREATE
Specifies that a new journal is to be created. If no journal
exists, using this keyword creates a new one. If a journal (with
the file specification given in this command) already exists,
using this keyword creates a new version of the journal. In the
latter instance, the data file named in this SET FILE command
is journaled to the new journal. Any other files that are being
journaled to the previous version of the journal will continue to
be journaled to that previous version.
If a journal does not already exist, be sure to use the CREATE
keyword with the SET FILE/AI_JOURNAL command. If you do not
specify the CREATE keyword and the file that you specify with
the FILE keyword does not exist, a journal will not automatically
be created and an error message is displayed.
When you create a journal for after-image journaling, the file
protection for the journal is determined as follows:
o If a version of the journal that you specify with the CREATE
keyword already exists, then the new version of the journal
has the same file protection and access control list (ACL) as
the most recent version.
o If there is no existing journal (that is, if you are creating
version 1 of the journal), then the file protection and
ACL of the journal are the default file protection for the
process that creates the journal, except that none of the four
ownership categories (system, owner, group, world) is given
delete access.
Also, every time that you use the CREATE keyword, be sure to make
a backup copy of the data file. (If it is the first time that
the data file is marked for after-image journaling, then you must
make a backup copy of the data file, regardless of whether the
CREATE keyword is used.)
NOTE
To be able to recover the data file at a later time, you
must mark the file for journaling, and then make a backup
copy of the data file, even if it contains no data.
In most cases (in particular, when you are using after-image
journaling to protect against loss of data from a device
failure), you should keep the backup copy on a different volume
from the data file. If recovery becomes necessary, you will be
able to perform after-image recovery only if a backup copy of the
data file is available.
If you want to use a single journal for both after-image and
before-image journaling, do not use the CREATE keyword with both
the /AI_JOURNAL and /BI_JOURNAL qualifiers, because that will
create two separate journals. When you create a journal that
will be used for more than one data file or more than one type
of journaling (after-image or before-image), you should first
use a SET FILE command to create the journal for a single type
of journaling and for a single data file. After the journal is
created, then you can use a single SET FILE command for multiple
data files and both after-image and before-image journaling. For
example, you might use the following sequence of commands:
$ SET FILE/AI_JOURNAL=(FILE=JNL_DISK:,CREATE) [WEEKLY]SALES.DAT
$ SET FILE/BI_JOURNAL=(FILE=JNL_DISK:[WEEKLY]SALES) -
_$INVOICES.DAT,COMMISSIONS.DAT
EXTENSION=n
Specifies the default extension quantity, in blocks, for the
journal. You can specify a value from 0 to 65,535.
The EXTENSION keyword is meaningful only when you use the CREATE
keyword. If the file is extended, the value that you specify is
used. If you do not use the EXTENSION keyword when you create a
journal, RMS calculates its own EXTENSION value for the journal.
FILE=journal-filespec
Specifies the journal where all modifications to the named data
file will be recorded. The default file specification for the
journal is the file specification of the data file that you name,
but with a file type of RMS$JOURNAL. If you provide a partial
file specification for the journal, any unspecified portions are
taken from the default file specification. The FILE keyword is
required when you use the SET FILE/AI_JOURNAL command.
If you are using after-image journaling to protect against the
loss of data due to a device failure (such as a head crash),
you should keep the journal on a different volume from the
one on which the data file is kept. Only by keeping the data
file and journals on separate volumes can you use after-image
recovery to restore the data file if its recording medium becomes
corrupted (for example, by a disk head crash). If you issue the
SET FILE/AI_JOURNAL command and the journal is on the same volume
as the data file being marked for after-image journaling, the
INVAIJDEV warning message is issued.
The file specification cannot include a node name, since the SET
FILE command is not valid for network access.
You can use a single journal for multiple data files for after-
image journaling, and you can also use a single journal for both
after-image and before-image journaling.
19.4.4 – Qualifier
19.4.4.1 /LOG
/LOG
/NOLOG (default)
Controls whether the SET FILE command displays the file
specification and the type of journaling that has been set. By
default, this information is not displayed.
19.4.5 – EXAMPLES
1.$ SET FILE /AI_JOURNAL=(FILE=JOURNAL_DISK:,CREATE) -
_$FINANCE_DISK:[PAYROLL]WEEKLY.DAT
In this example, the file FINANCE_DISK:[PAYROLL]WEEKLY.DAT is
marked for after-image journaling. The required FILE keyword
is used to place the journal on the disk JOURNAL_DISK, and
the CREATE keyword generates a new version of the journal.
The file specification for the journal will be JOURNAL_
DISK:[PAYROLL]WEEKLY.RMS$JOURNAL.
The next step in the after-image journaling process after
issuing this command is to back up the data file.
2.$ SET FILE/AI_JOURNAL=(FILE=JOURNAL_DISK:,CREATE)/LOG SALES.DAT
%SET-I-JCREATED, journal JOURNAL_DISK:[REGION_1]SALES.RMS$JOURNAL;1
created
%SET-I-FILMARKAI, FINANCE_DISK:[REGION_1]SALES.DAT;1 marked for RMS
after-image journaling
-SET-I-JFILE, using journal JOURNAL_DISK:[REGION_1]SALES.RMS$JOURNAL;1
%SET-I-MODIFIED, FINANCE_DISK:[REGION_1]SALES.DAT;1 modified
In this example, the file SALES.DAT in default directory
FINANCE_DISK:[REGION_1] is marked for after-image journaling
and the /LOG qualifier causes the result of the SET FILE
command to be displayed on the terminal.
3.$ SET FILE/AI_JOURNAL=(FILE=JNL_DISK:,CREATE)/LOG OVERDUE.DAT
%SET-I-JCREATED, journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
created
%SET-I-FILMARKAI, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
after-image journaling
-SET-I-JFILE, using journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
%SET-I-MODIFIED, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 modified
$ SET FILE/BI_JOURNAL=(FILE=JNL_DISK:)/RU_JOURNAL/LOG OVERDUE.DAT
%SET-I-FILMARKBI, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
before-image journaling
-SET-I-JFILE, using journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
%SET-I-FILMARKRU, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
recovery-unit journaling
%SET-I-MODIFIED, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 modified
In this example, the file OVERDUE.DAT is marked for all three
types of journaling using two SET FILE commands. A single
journal (JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL) will be used
for after-image and before-image journaling.
The first SET FILE command uses the /CREATE
qualifier to create a new after-image journal,
JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL. The file specification
uses the current default directory [PAYABLE] and the default
file extension RMS$JOURNAL.
The second SET FILE command checks the disk JNL_DISK to see
whether a journal already exists, and uses the existing journal
for before-image journaling, as well as after-image journaling.
4.$ SET FILE/NOAI_JOURNAL/NOBI_JOURNAL -
_$ WORK_DISK:[PAYABLE]OVERDUE.DAT,VENDORS.DAT
In this example, the files OVERDUE.DAT and VENDORS.DAT are
unmarked for both after-image and before-image journaling. It
is not necessary to specify the journals that were used. If
more than one journaling type was applied to the data files
(as in the previous example), then you must cancel each of the
journaling types before you can delete the data files.
5.$ SET FILE/AI_JOURNAL=(FILE=JOURNAL_DISK,CREATE)-
_$ /RU_JOURNAL [FIELD]SALARY.DAT
$ SET FILE/AI_JOURNAL=(FILE=JOURNAL_DISK:[FIELD]SALARY)-
_$ /RU_JOURNAL CHECKS.DAT
In this example, the files SALARY.DAT and CHECKS.DAT are both
marked for after-image and for recovery unit journaling. The
after-image journaling for both files is written to the same
journal, JOURNAL_DISK:[FIELD]SALARY.RMS$JOURNAL.
19.5 /BI_JOURNAL
Requires read (R), write (W), and control access. Being the owner
of the file is one way to get control access.
Marks one or more RMS files for before-image journaling. You can
also specify certain characteristics of the journal with this
command, including its file specification, whether it is to be
created, its initial size, and its default extension quantity.
The SET FILE/NOBI_JOURNAL command unmarks a file for before-image
journaling.
The SET FILE command is not supported for remote files. You
must use the SET FILE command from the system where the file
is located.
For more information, see the RMS Journaling documentation.
Format
SET FILE/[NO]BI_JOURNAL[=(keyword[,...])] data-filespec[,...]
19.5.1 – Parameter
data-filespec[,...]
Identifies the file to be marked for before-image journaling. If
you specify more than one file, separate the file specifications
with commas. The asterisk (*) and the percent sign (%) wildcard
characters are allowed. The file specification cannot include a
node name, since the SET FILE command is not valid for network
access.
19.5.2 – Description
The SET FILE/BI_JOURNAL command marks one or more RMS files
for before-image journaling. You can also specify certain
characteristics of the journal with this command, including its
file specification, whether it is to be created, its initial
size, and its default extension quantity. The SET FILE/NOBI_
JOURNAL command unmarks a file for before-image journaling.
After a data file is marked for before-image journaling with the
SET FILE/BI_JOURNAL command, the following events occur whenever
the data file is opened by RMS for write operations:
o The journal is opened.
o All subsequent modifications to the data file are recorded in
the journal.
By default, the journal has the same file specification as
the data file that is to be journaled, but with the file type
RMS$JOURNAL. That is, if you issue the following command, then,
by default, the file specification for the before-image journal
is FINANCE_DISK:PAYROLL.RMS$JOURNAL:
$ SET FILE/BI_JOURNAL FINANCE_DISK:PAYROLL.DAT
If erroneous or corrupt data is introduced into the data file,
you can use the RMS Recovery Utility to "roll back" the data file
that has been marked for before-image journaling. This will allow
you to restore the data file to a previous state by removing data
until a specified time (prior to the introduction of bad data).
Use the SET FILE/NOBI_JOURNAL command to unmark a file for
before-image journaling. After you use the SET FILE/NOBI_JOURNAL
command for a file, modifications to that data file will no
longer be written to the journal.
You must use the SET FILE/NOBI_JOURNAL command before you can
delete a file that has been marked for before-image journaling.
19.5.3 – Keywords
Four keywords are used as optional parameters to the SET FILE/BI_
JOURNAL command: ALLOCATION, [NO]CREATE, EXTENSION, and FILE. You
can use any, all, or none of these keywords.
Use an equal sign (=) immediately after the SET FILE/BI_JOURNAL
command to use a keyword. If you use more than one of the
keywords, enclose the list in parentheses and separate the items
in the list with commas.
ALLOCATION=n
Specifies the initial size, in blocks, of the journal. The
ALLOCATION keyword is meaningful only when the CREATE keyword
is also used.
The default allocation is 0 blocks.
CREATE
Specifies that a new journal is to be created. If no journal
exists, using this keyword creates a new one. If a journal (with
the file specification given in this command) already exists,
using this keyword creates a new version of the journal. In the
latter instance, the data file named in this SET FILE command
is journaled to the new journal. Any other files that are being
journaled to the previous version of the journal will continue to
be journaled to that previous version.
If a journal does not already exist, be sure to use the CREATE
keyword with the SET FILE/BI_JOURNAL command. If you do not
specify the CREATE keyword and a journal does not exist, a
journal is not automatically created and an error message is
displayed.
When you create a journal for before-image journaling, the file
protection for the journal is determined as follows:
o If a version of the journal that you specify with the CREATE
keyword already exists, then the new version of the journal
has the same file protection and access control list (ACL) as
the most recent version.
o If there is no existing journal (that is, if you are creating
version 1 of the journal), then the file protection and
ACL of the journal are the default file protection for the
process that creates the journal, except that none of the four
ownership categories (system, owner, group, world) is given
delete access.
If you want to use a single journal for both after-image and
before-image journaling, do not use the CREATE keyword with both
the /AI_JOURNAL and /BI_JOURNAL qualifiers, because that will
create two separate journals. When you create a journal that
will be used for more than one data file or more than one type
of journaling (after-image or before-image), you should first
use a SET FILE command to create the journal for a single type
of journaling and for a single data file. After the journal is
created, then you can use a single SET FILE command for multiple
data files and both after-image and before-image journaling. For
example, you might use the following sequence of commands:
$ SET FILE/AI_JOURNAL=(FILE=JNL_DISK:,CREATE) [WEEKLY]SALES.DAT
$ SET FILE/BI_JOURNAL=(FILE=JNL_DISK:[WEEKLY]SALES) -
_$INVOICES.DAT,COMMISSIONS.DAT
EXTENSION=n
Specifies the default extension quantity, in blocks, for the
journal. You can specify a value from 0 to 65,535.
The EXTENSION keyword is meaningful only when you use the CREATE
keyword. If the file is extended, the value that you specify is
used. If you do not use the EXTENSION keyword when you create a
journal, RMS calculates its own EXTENSION value for the journal.
FILE=journal-filespec
Specifies the journal where all before-image journal entries for
the data file will be recorded. The default file specification
for the journal is the file specification of the data file that
you name, but with a file type of RMS$JOURNAL. Use the FILE
keyword if you wish to modify this default file specification
for the journal. If you provide a partial file specification for
the before-image journal, any unspecified portions are taken from
the default file specification.
The file specification cannot include a node name, since the SET
FILE command is not valid for network access.
The FILE keyword is optional with the SET FILE/BI_JOURNAL
command.
You can use a single journal for multiple data files for before-
image journaling, and you can also use the same journal for both
before-image and after-image journaling.
19.5.4 – Qualifier
19.5.4.1 /LOG
/LOG
/NOLOG (default)
Controls whether the SET FILE command displays the file
specification and the type of journaling that has been set. By
default, this information is not displayed.
19.5.5 – EXAMPLES
1.$ SET FILE/BI_JOURNAL=(FILE=JOURNAL_DISK:,CREATE) -
_$FINANCE_DISK:[PAYROLL]WEEKLY.DAT
In this example, the file FINANCE_DISK:[PAYROLL]WEEKLY.DAT is
marked for before-image journaling. The FILE keyword, together
with the defaults obtained from the file specification of the
data file, provides the journal with a file specification of
JOURNAL_DISK:[PAYROLL]WEEKLY.RMS$JOURNAL. Because the CREATE
keyword was used, this journal is created when this SET FILE
command is given.
2.$ SET FILE/BI_JOURNAL=CREATE/LOG SALES.DAT
%SET-I-JCREATED,journal FINANCE_DISK:[REGION_1]SALES.RMS$JOURNAL;1
created
%SET-I-FILMARKBI, FINANCE_DISK:[REGION_1]SALES.DAT marked for RMS
before-image journaling
-SET-I-JFILE,using journal FINANCE_DISK:[REGION_1]SALES.RMS$JOURNAL;1
%SET-I-MODIFIED, FINANCE_DISK:[REGION_1]SALES.DAT modified
In this example, the file SALES.DAT in default directory
FINANCE_DISK:[REGION_1] is marked for before-image journaling
and the /LOG qualifier causes the result of the SET FILE
command to be displayed on the terminal.
3.$ SET FILE/BI_JOURNAL=(FILE=JNL_DISK:, CREATE)/LOG OVERDUE.DAT
%SET-I-JCREATED, journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
created
%SET-I-FILMARKBI, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
before-image journaling
-SET-I-JFILE, using journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
%SET-I-MODIFIED, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 modified
$ SET FILE/AI_JOURNAL=(FILE=JNL_DISK:)/RU_JOURNAL/LOG OVERDUE.DAT
%SET-I-FILMARKAI, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
after-image journaling
-SET-I-JFILE, using journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
%SET-I-FILMARKRU, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
recovery-unit journaling
%SET-I-MODIFIED, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 modified
In this example, the file OVERDUE.DAT is marked for all three
types of journaling using two SET FILE commands. A single
journal (JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL) will be used
for after-image and before-image journaling.
The first SET FILE command uses the /CREATE
qualifier to create a new before-image journal,
JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL. The file specification
uses the current default directory [PAYABLE] and the default
file extension RMS$JOURNAL.
The second SET FILE command checks the disk JNL_DISK to see
whether a journal already exists, and uses the existing journal
for after-image journaling, as well as before-image journaling.
4.$ SET FILE/NOBI_JOURNAL/NOAI_JOURNAL-
_$ WORK_DISK:[PAYABLE]OVERDUE.DAT,VENDORS.DAT
In this example, the files OVERDUE.DAT and VENDORS.DAT are
unmarked for both before-image and after-image journaling. It
is not necessary to specify the journals that were used. If
more than one journaling type was applied to the data files
(as in the previous example), then you must cancel each of the
journaling types before you can delete the data files.
5.$ SET FILE/BI_JOURNAL=(FILE=JOURNAL_DISK,CREATE)/RU_JOURNAL
[FIELD]SALARY.DAT
$ SET FILE/BI_JOURNAL=(FILE=JOURNAL_DISK:[FIELD]SALARY)
/RU_JOURNAL CHECKS.DAT
In this example, the files SALARY.DAT and CHECKS.DAT are both
marked for before-image and for recovery unit journaling. The
before-image journaling for both files is written to the same
journal, JOURNAL_DISK:[FIELD]SALARY.RMS$JOURNAL.
19.6 /RU_ACTIVE
Requires read (R), write (W), and control access. Being the owner
of the file is one way to get control access.
Designates the recoverable facility that controls active recovery
units for the file. Alternatively, when used with the /RU_
FACILITY qualifier, the SET FILE/RU_ACTIVE command lets you clear
the designated recoverable facility that controls active recovery
units for the specified file.
The SET FILE command is not supported for remote files. You
must use the SET FILE command from the system where the file
is located.
For more information, see the RMS Journaling documentation.
Format
SET FILE/[NO]RU_ACTIVE=ru-facility data-filespec[,...]
19.6.1 – Parameters
ru-facility
Specifies the number or name of a recoverable facility. It can
be an integer from 0 through 255, or it can be the name of an
VSI-registered recoverable facility.
Facility numbers 1 through 127 are reserved by VSI; facility
numbers 128 through 255 are available for user-written
recoverable facilities. RMS is recoverable facility 1; specifying
the number 1 is equivalent to using the text * corresponds to
no recoverable facility and is equivalent to using the qualifier
/NORU_ACTIVE. Currently, the only VSI-defined recoverable facility
is 1 (RMS).
data-filespec[,...]
Specifies the file that is to be modified. If you specify more
than one file, separate the file specifications with commas. The
asterisk (*) and the percent sign (%) wildcard characters are
allowed. The file specification cannot include a node name, since
the SET FILE command is not valid for network access.
19.6.2 – Description
The SET FILE/RU_ACTIVE command designates the recoverable
facility that controls active recovery units for the file.
Alternatively, when used with the /RU_FACILITY qualifier, the SET
FILE/RU_ACTIVE command lets you clear the designated recoverable
facility that controls active recovery units for the specified
file. This is useful if a data file is unavailable due to active
recovery units and an unavailable recovery unit journal.
CAUTION
When you clear the RU_ACTIVE attribute (using the command
SET FILE/RU_ACTIVE=0/RU_FACILITY=1), the data in the file is
likely to be in an inconsistent state. Do not use the data
file unless you can ensure that the data is consistent.
After clearing the RU_ACTIVE attribute, you can unmark
the file for journaling, delete the file, and re-create a
consistent file using a backup copy.
You can determine the recoverable facility that controls active
recovery units (if any) for the file by entering the DCL command
DIRECTORY/FULL or DUMP/HEADER. You can use the ANALYZE/RMS_
FILE/RU_JOURNAL command to determine the state of any active
recovery units.
19.6.3 – Qualifier
19.6.3.1 /LOG
/LOG
/NOLOG(default)
Controls whether the SET FILE command displays the file
specification and the type of facility that has been specified.
By default, this information is not displayed.
19.6.4 – EXAMPLES
1.$ SET FILE/RU_FACILITY=1/RU_ACTIVE=0-
_$ FINANCE_DISK:[PAYROLL]WEEKLY.DAT
If the file WEEKLY.DAT is unavailable due to active recovery
units and an unavailable recovery unit journal, you can use
this command to gain access to the file. In this example, the
recoverable facility is defined as RMS by the /RU_FACILITY=1
qualifier. The RU_ACTIVE attribute that indicates active RMS
recovery units for the file WEEKLY.DAT is cleared by the /RU_
ACTIVE=0 qualifier.
CAUTION
The data in the file may be inconsistent if there are active
recovery units. VSI recommends that you not use the contents
of the data file unless you can verify that the data is
consistent.
VSI also recommends that you make a new copy of the file
using the Convert Utility and that you use the converted
copy in place of the original.
19.7 /RU_FACILITY
Allows you to identify the recoverable facility that controls
active recovery units on the file.
The SET FILE command is not supported for remote files. You
must use the SET FILE command from the system where the file
is located.
For more information, see the RMS Journaling documentation.
Format
SET FILE/RU_FACILITY=ru-facility data-filespec[,...]
19.7.1 – Parameters
ru-facility
Specifies the number or name of a recoverable facility. It can
be an integer from 0 through 255, or it can be the name of an
VSI-registered recoverable facility.
Facility numbers 1 through 127 are reserved by VSI; facility
numbers 128 through 255 are available for user-written
recoverable facilities. RMS is recoverable facility 1; specifying
the number 1 is equivalent to using the text RMS. The number
0 corresponds to no recoverable facility. Currently, the only
VSI-defined recoverable facility is 1 (RMS).
The recoverable facility that you specify is an input parameter
that is used only to open the file; it does not actually modify
any file attributes.
data-filespec[,...]
Specifies the file that is to be modified. If you specify more
than one file, separate the file specifications with commas. The
asterisk (*) and the percent sign (%) wildcard characters are
allowed. The file specification cannot include a node name, since
the SET FILE command is not valid for network access.
19.7.2 – Description
The SET FILE/RU_FACILITY command allows you to identify the
recoverable facility that controls active recovery units on the
file. You can use any other SET FILE qualifier with the /RU_
FACILITY qualifier.
When a data file has active recovery units and RMS journaling
cannot resolve the recovery units (for example, if the recovery
unit journal is unavailable), the data file cannot be opened
or deleted. The presence of active recovery units prevents you
from unmarking (or marking) a file for any journaling type. With
the SET FILE/RU_FACILITY/RU_ACTIVE command, you can clear the
designated recoverable facility that controls active recovery
units for the data file.
CAUTION
When you clear the RU_FACILITY attribute (with the command
SET FILE/RU_ACTIVE=0/RU_FACILITY=1), the data in the file is
likely to be in an inconsistent state. Do not use the data
file unless you can ensure that the data is consistent.
After clearing the RU_ACTIVE attribute, you can unmark
the file for journaling, delete the file, and re-create a
consistent file using a backup copy.
You can determine the recoverable facility that controls active
recovery units (if any) for the file by entering the DCL command
DIRECTORY/FULL or DUMP/HEADER. You can use the ANALYZE/RMS_
FILE/RU_JOURNAL command to determine the state of any active
recovery units.
19.7.3 – Examples
1.$ SET FILE/RU_FACILITY=1/NORU_JOURNAL/NOAI_JOURNAL/LOG SAVINGS.DAT
%SET-I-FILUNMARKAI, $DISK1:[PERSONAL]SAVINGS.DAT;1 unmarked for RMS
after-image journaling
%SET-I-FILUNMARKRU, $DISK1:[PERSONAL]SAVINGS.DAT;1 unmarked for RMS
recovery-unit journaling
%SET-I-MODIFIED, $DISK1:[PERSONAL]SAVINGS.DAT;1 modified
$ DELETE SAVINGS.DAT;*
This example shows the use of the /RU_FACILITY qualifier to
allow SET FILE access to a data file. The SET FILE command
identifies the recoverable facility holding the file and
it also unmarks the file for recovery unit and after-image
journaling. After these steps, it is then possible to delete
the data file.
CAUTION
If it becomes necessary to use the /RU_FACILITY qualifier
because of active recovery units, the data in the file may
be inconsistent. VSI recommends that you not use the data
file unless you can verify that the data is consistent.
VSI also recommends that you make a new copy of the file
using the Convert Utility and that you use the converted
copy in place of the original.
2.$ SET FILE/RU_FACILITY=RMS/RU_ACTIVE=0 SALES.DAT
In this example, the recoverable facility for the file
SALES.DAT is identified as RMS by the /RU_FACILITY=RMS
qualifier, and the RU active file attribute (which indicates
active RMS recovery units) is cleared by the /RU_ACTIVE=0
qualifier. If the file SALES.DAT is unavailable due to active
recovery units and an unavailable recovery unit journal, you
can use this command to gain access to the file.
As in the previous example, this operation leaves the data
file in an inconsistent state. In general, use this command to
delete the data file, then restore the file from a backup copy.
19.8 /RU_JOURNAL
Requires read (R), write (W), and control access. Being the owner
of the file is one way to get control access.
Marks an RMS file for recovery unit journaling.
The SET FILE command is not supported for remote files. You
must use the SET FILE command from the system where the file
is located.
For more information, see the RMS Journaling documentation.
Format
SET FILE/[NO]RU_JOURNAL[=volume-name] data-filespec[,...]
19.8.1 – Parameters
volume-name
Specifies the volume on which the recovery unit journals will be
located, using one of the following keywords:
o DEVICE=device_name specifies a device name or logical name.
o LABEL=volume-label specifies a volume label.
By default, recovery unit journals are created temporarily in the
[SYSJNL] directory on the same volume as the file that is being
journaled. (If such a directory does not exist, RMS journaling
creates it automatically.) You can change the device on which the
recovery unit journals are created by using either the DEVICE or
LABEL keyword.
Use the DEVICE keyword to specify the location of recovery unit
journals using a device name or a logical name. Use the LABEL
keyword to specify the location of recovery unit journals using a
volume label. You can only use one of these two keywords (LABEL
or DEVICE) to specify the recovery unit journal location. In
either case, only the volume label is actually stored with the
file.
At run time, RMS attempts to translate the logical name
DISK$volume_label when creating a recovery unit journal. This
is the default logical name created by the Mount Utility when you
mount the disk using the /SYSTEM or /CLUSTER qualifier. If you do
not mount the disk using the /SYSTEM or /CLUSTER qualifier, you
must define the logical name DISK$volume_label using the DEFINE
command with the /SYSTEM and /EXECUTIVE_MODE qualifiers. You
must have the SYSNAM (system logical name) or the SYSPRV (system
privilege) privilege to use the /SYSTEM qualifier.
NOTE
The logical name DISK$volume_label can point to any
disk device on the system that is mounted and has for
its volume label an executive-mode logical name in the
form DISK$volume_label with the concealed and terminal
attributes.
data-filespec[,...]
Specifies the file that is to be marked for recovery unit
journaling. If a data file has been marked for recovery unit
journaling with this command, DECdtm transaction services
($START_TRANS, $END_TRANS, and $ABORT_TRANS) must be used by
an application program to define transactions whenever data in
this file is modified.
If you specify more than one file, separate the file
specifications with commas. The asterisk (*) and the percent
sign (%) wildcard characters are allowed. The file specification
cannot include a node name, since the SET FILE command is not
valid for network access.
19.8.2 – Description
The SET FILE/RU_JOURNAL command marks an RMS file for recovery
unit journaling. To use recovery unit journaling for a data file,
a data file must be marked for recovery unit journaling with the
SET FILE/RU_JOURNAL command, and transactions must be defined
in an application program using DECdtm transaction services. You
can also use this command to specify the default volume on which
recovery unit journals will be created for this file.
Use the SET FILE/NORU_JOURNAL command to unmark a file for
recovery unit journaling. After you use the SET FILE/NORU_JOURNAL
command for a file, modifications to that data file will no
longer be written to a recovery unit journal.
If you wish to delete a file that has been marked for recovery
unit journaling, you must use the SET FILE/NORU_JOURNAL command
before you can delete the file.
There is no reason other than performance to keep recovery unit
journals on a different volume from the file being journaled.
Unlike after-image journaling, which protects against a system
failure such as a head crash that causes a loss of data, recovery
unit journaling ensures that a predefined set of operations are
either done in their entirety, or not done at all. In the event
of an abnormal termination of the application, such as a system
crash or a Ctrl/Y, any incomplete transactions are automatically
rolled back (undone). Because all recovery unit journals must
be available before the data files can be rolled back, locating
recovery unit journals on a volume where availability might be
low could reduce the availability of the data files that use
those recovery unit journals.
Specifying a location for recovery unit journals for a file
does not guarantee that the recovery unit journals will always
be located on the named device or volume. For any active
transaction, there is always only one recovery unit journal for
local files. Thus, if many files are involved in a transaction, a
single recovery unit journal is used, even if different locations
for the journals had been specified (for individual files) with
different SET FILE/RU_JOURNAL commands.
Remote files are an exception to this rule. Each remote file
associated with a transaction has its own recovery unit and
recovery unit journal. The recovery unit journal resides on the
remote system. The volume is chosen in the same way as for local
files. Remote files have no effect in determining where the local
recovery unit journal resides.
A journal is not deleted when the transaction has been completed.
Recovery unit journals are automatically deleted only when
all of the files involved in the transaction are closed and
the application exits. RMS journaling automatically creates a
recovery unit journal at run time, whenever the first record
stream associates with a transaction. All record streams in
the process associated with the same transaction share a single
recovery unit journal. Once a recovery unit journal is created,
it can be reused for another transaction by the process that
created it. A recovery unit journal is created only when there is
no available recovery unit journal opened by the process for the
current transaction.
19.8.3 – Examples
1.$ SET FILE/RU_JOURNAL FINANCE_DISK:[PAYROLL]WEEKLY.DAT
This command marks the file WEEKLY.DAT for recovery unit
journaling. Any operation within an application that modifies
this file must be in a defined transaction (defined by DECdtm
transaction services).
2.$ SET FILE/AI_JOURNAL=(FILE=JNL_DISK:, CREATE)-
_$ /RU_JOURNAL/LOG OVERDUE.DAT
%SET-I-JCREATED, journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
created
%SET-I-FILMARKAI, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
after-image journaling
-SET-I-JFILE, using journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
%SET-I-FILMARKRU, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 marked for RMS
recovery-unit journaling
%SET-I-MODIFIED, WORK_DISK:[PAYABLE]OVERDUE.DAT;1 modified
$ SET FILE/AI_JOURNAL=(FILE=JNL_DISK:OVERDUE)-
_$ /RU_JOURNAL/LOG CURRENT.DAT
%SET-I-FILMARKAI, WORK_DISK:[PAYABLE]CURRENT.DAT;1 marked for RMS
after-image journaling
-SET-I-JFILE, using journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL;1
%SET-I-FILMARKRU, WORK_DISK:[PAYABLE]CURRENT.DAT;1 marked for RMS
recovery-unit journaling
%SET-I-MODIFIED, WORK_DISK:[PAYABLE]CURRENT.DAT;1 modified
In this example, the files OVERDUE.DAT and CURRENT.DAT are
marked for after-image and recovery unit journaling using two
SET FILE commands. In this example, a single journal (JNL_
DISK:[PAYABLE]OVERDUE.RMS$JOURNAL) is used for after-image
journaling.
The first SET FILE command uses the /CREATE
qualifier to create a new after-image journal, JNL_
DISK:[PAYABLE]OVERDUE.RMS$JOURNAL, for the file OVERDUE.DAT.
The file specification uses the current default directory
[PAYABLE] and the default file extension RMS$JOURNAL.
The second SET FILE command marks the file CURRENT.DAT for
after-image and recovery unit journaling, checks the disk JNL_
DISK to see whether an after-image journal already exists, and
uses the existing journal JNL_DISK:[PAYABLE]OVERDUE.RMS$JOURNAL
for the file CURRENT.DAT.
20 – HOST
Connects your terminal (through the current host processor)
to another processor, called the remote processor. The command
requires that:
o You must have an account on the remote system to log in.
o The NETMBX (network mailbox) privilege is set.
For more information about using the following qualifiers, see
help for the appropriate subtopic.
Qualifier Type of Connection
/DTE Connects your system to a remote system through an
outgoing terminal line.
/DUP Connects your terminal to a storage controller
through the appropriate bus for that controller.
/HSC Connects your terminal to an HSC disk and tape
controller through the computer interconnect (CI)
bus.
/LAT Connects your terminal to a specified service
available on the local area network (LAN).
/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.
/TELNET Connects you to a remote host over a TCP/IP
connection by invoking the TELNET application.
/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 node-name
20.1 – Parameter
node-name
Specifies the node name of the remote processor to which you will
connect.
20.2 – Qualifiers
20.2.1 /APPLICATION_PROTOCOL
/APPLICATION_PROTOCOL[=protocol]
Specifies the protocol connection, CTERM (CTDRIVER) or RTERM
(RTTDRIVER) on the specified node. CTERM protocol is the default
if no connection is specified.
20.2.2 /BUFFER_SIZE
/BUFFER_SIZE=n
Changes the packet size of the protocol message sent between the
terminal and the remote processor if a connection to the remote
processor is already established. The default buffer size is 1010
bytes; however, the buffer size n can range from 140 bytes to
1024 bytes. The value of the parameter n is reset to 140 bytes if
a value below 140 is specified; a value for n above 1024 bytes is
reset to 1024.
You can force the host node to write to the terminal in smaller
packets, thereby ensuring that write operations to the terminal
are displayed at more frequent intervals, by setting n to a
value just above the minimum of 140 bytes. On slow DECnet links,
setting the buffer size to a smaller value may decrease pauses
between write operations when large amounts of data are being
scrolled to the screen.
20.2.3 /LOG
/LOG[=filespec]
/NOLOG (default)
Controls whether a log file of the entire session is kept. If you
use the /LOG qualifier without the file specification, the log
information is stored in the file SETHOST.LOG.
20.2.4 /MOP
/MOP client-name
Connects your system to a remote system using the MOP protocol.
Note that this qualifier is displayed only if DECnet-Plus is
installed on your system.
For more information, type the following command:
$ HELP DECnet-Plus DCL_Commands SET HOST/MOP
20.2.5 /RESTORE
/RESTORE
/NORESTORE (default)
Saves current terminal characteristics before a remote terminal
session is begun and restores them when the remote session is
terminated.
20.3 – Examples
1.$ SET HOST/APPLICATION_PROTOCOL=CTERM DAKOTA
The /APPLICATION_PROTOCOL qualifier specifies the CTERM
protocol (the default) on node DAKOTA in this command line.
2.$ SET HOST ITALIC
Username: GRESO
Password: <PASSWORD>
Welcome to OpenVMS VAX Version 7.3 on node ITALIC
.
.
.
$ LOGOUT
GRESO logged out at 19-DEC-2001 15:04:25.27
%REM-S-END, Control returned to node _CASLON::
In this example, the name of the local node is CASLON. This SET
HOST command connects the user terminal to the processor at the
network node named ITALIC. The remote processor then prompts
for user name and password. Use the normal login procedure to
log in to the remote processor.
Once you are logged in at a remote node, you can use the SET
HOST command to establish communication with another node.
After logging in to node ITALIC, you could type SET HOST
BODONI.
You would again be prompted for a user name and password. If
you then supply a valid user name and password, you will be
logged in to node BODONI.
Note that when you log out of node BODONI, control is returned
to node ITALIC. You must log out of node ITALIC to return to
your local node, CASLON.
3.$ SET TERMINAL/WIDTH=80
$ SET HOST/RESTORE GENEVA
Username: Jones
Password: <PASSWORD>
$ SET TERMINAL/WIDTH=132
.
.
.
$ logout
JONES logged out at 19-DEC-2001 11:04:51.45
%REM-S-END, control returned to node _ORACLE
This example shows user JONES on node ORACLE logging in to
remote node GENEVA and specifies that the original terminal
screen width be restored to 80 characters when the remote
session is terminated.
20.4 /DTE
Connects your system to a remote system through an outgoing
terminal line.
You must have an account on the remote system in order to log in
to that system after the connection is made.
You must also have the ability to assign a channel to the
terminal port specified. Your system manager can set the device
protection on the terminal port to allow you access.
Format
SET HOST/DTE terminal-name
20.4.1 – Parameter
terminal-name
Specifies the name of an outgoing terminal line, which connects
your system directly to another system or modem.
20.4.2 – Qualifiers
20.4.2.1 /BREAK
/BREAK=break-character
Selects the break character. The break character is used to
generate a break on lines that expect a break rather than a
carriage return. To generate a break, press Ctrl/break-character.
The break character can be any ASCII character between @ and
z, except C, M, Q, S, Y, or the left bracket ([). You cannot
select a character currently defined as either the command
character (see the description of the /COMMAND=command-character
qualifier) or the escape character (see the description of the
/ESCAPE=escape-character qualifier).
The ASCII characters between @ and z include the alphabetic
characters in both upper and lower cases, the at sign (@), the
backslash (\), the right bracket (]), the circumflex (^), the
underscore (_), and the grave accent (`).
By default, the break character is the right bracket (]).
20.4.2.2 /COMMAND
/COMMAND=command-character
Selects the command character. Use the command character to
access DTE command mode by pressing Ctrl/command-character.
The command character can be any ASCII character between @ and z,
except C, M, Q, S, Y, or the left bracket ([). You cannot select
a character currently defined as either the break character (see
the description of the /BREAK=break-character qualifier) or the
escape character (see the description of the /ESCAPE=escape-
character qualifier).
The ASCII characters between @ and z include the alphabetic
characters in both upper and lower cases, the at sign (@), the
backslash (\), the right bracket (]), the circumflex (^), the
underscore (_), and the grave accent (`).
By default, the command character is the at sign (@).
20.4.2.3 /DIAL
/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.
Before you dial a new number, you must log out of the current
remote system.
On Alpha, the MODEM_TYPE keyword defaults to DMCL (any modem that
uses the DIGITAL Modem Command Language).
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).
20.4.2.4 /ECHO
/ECHO
/NOECHO (default)
Determines whether the terminal input is echoed by your local
system. By default, all echoing is performed by the remote
system.
20.4.2.5 /EIGHT_BIT
/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.
20.4.2.6 /ERROR_ACTION
/ERROR_ACTION=CONTINUE (default)
/ERROR_ACTION=EXIT
Specifies the error action by using the EXIT or the CONTINUE
keyword.
When an error is detected on the outgoing terminal line, the
error is reported to the local system and an error message is
displayed on your terminal.
If the error action is CONTINUE, then communication with the
remote system continues uninterrupted.
If the error action is EXIT, then the local system immediately
exits from the remote system.
20.4.2.7 /ESCAPE
/ESCAPE=escape-character
Selects the escape character. You can use the escape character to
exit from DTEPAD by pressing Ctrl/ escape-character.
The escape character can be any ASCII character between @ and z,
except C, M, Q, S, Y, or the left bracket ([). You cannot select
a character currently defined as either the break character (see
the description of the /BREAK=break-character qualifier) or the
command character (see the description of the /COMMAND=command-
character qualifier).
By default, the escape character is a backslash (\).
The ASCII characters between @ and z include the alphabetic
characters in both upper and lower cases, the at sign (@), the
backslash (\), the right bracket (]), the circumflex (^), the
underscore (_), and the grave accent (`).
20.4.2.8 /FLOW_CONTROL
/FLOW_CONTROL (default)
/NOFLOW_CONTROL
Determines whether XON/XOFF flow control is enabled. By default,
flow control is enabled.
XON/XOFF flow control is a means of preventing data-overrun
errors. Incoming data is stored in receive buffers; when these
buffers are full, a signal is sent to the remote system to stop
transmission. Once there is sufficient space in the receive
buffers, another message is sent to restart transmission.
You should disable XON/XOFF flow control when the remote system
has no XON/XOFF flow control.
20.4.2.9 /INIT
/INIT[=filespec] (default)
/NOINIT
Sets the configurable characteristics of DTEPAD according to
values contained in the specified initialization file.
If you use qualifiers in the command line to define the values of
any of the configurable characteristics, these will supersede the
values contained in the initialization file.
By default, DTEPAD tries to translate the logical name DTEPAD$INI
in order to find the appropriate initialization file. If you
use the /INIT qualifier and omit the file specification, DTEPAD
translates the logical name DTEPAD$INI and finds the appropriate
file. If DTEPAD$INI is not defined, then DTEPAD uses /NOINIT as
the default.
An initialization file can contain any combination of any of the
following DTE commands:
o SAVE
o SEND BREAK
o SET DTE
o SPAWN
The following is an example of an initialization file:
SET DTE/MAX_BUFFERS=150
SET DTE/READ_DELAY=100
SEND BREAK
20.4.2.10 /LOG
/LOG[=filespec]
/NOLOG (default)
Controls whether a log file of the session is kept.
If you use the /LOG qualifier and omit the file specification,
then the log information is written to the file DTEPAD.LOG.
When used to log a modem session, the log file contains any noise
that occurred on the phone line. For example, typing a file in
order to get it recorded in the log file could result in noise
being recorded along with the file data. Therefore, the use of a
log file is not recommended for the purpose of file transfers.
VSI recommends that you use asynchronous DECnet to transfer files.
20.4.2.11 /MAX_BUFFERS
/MAX_BUFFERS=number-buffers
Specifies the maximum number of receive buffers. Receive buffers
are buffers used to receive incoming data from the modem port.
They are allocated as they are required.
By default, the maximum number of receive buffers is 100. The
minimum number you can specify is 20.
20.4.2.12 /PARITY
/PARITY=NONE (default)
/PARITY=ODD
/PARITY=EVEN
Selects parity on the outgoing terminal line.
20.4.2.13 /READ_DELAY
/READ_DELAY=delay
Specifies the modem port read delay in milliseconds. The modem
port read delay is the time interval during which data in the
modem port is transferred into receive buffers at the terminal.
By default, the modem port read delay is 50 milliseconds. This is
also the minimum value.
A long modem port read delay slows the rate at which data is
displayed at your terminal, and also increases the risk of data-
overrun errors; however, a longer read delay requires less CPU
overhead.
20.4.2.14 /SPEED
/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 baud rates are as follows:
50 150 1800 4800 38400
75 300 2000 7200 57600
110 600 2400 9600 76800
134 1200 3600 19200 115200
If you select an invalid or unsupported speed, then the terminal
line speed will remain set at its previous value.
20.4.3 – Examples
1.$ SET HOST/DTE TTA2:/DIAL=NUMBER:5551234
Username: SMITH
Password:
This command connects the user terminal to the outgoing
terminal line TTA2:, which is attached to a modem (type DF03
by default) set to autodial the phone number 555-1234. The
remote processor then prompts for user name and password. Use
the normal login procedure to log in to the remote system.
2.$ SET HOST/DTE/DIAL=(NUMBER:5551234#,MODEM_TYPE:DF112) TTA2:
Username: SMITH
Password:
This command accomplishes the same thing as in the first
example, except that it uses the DF112 modem. The number sign
(#) is required to activate the autodialer in the DF112.
3.$ SET HOST/DTE/NOEIGHTBIT TTA2
This command sets the outgoing terminal port, TTA2, to support
7-bit characters.
4.$ SET HOST/DTE/NOFLOW_CONTROL TTA2
This command disables the XON/XOFF flow control.
5.$ SET HOST/DTE/ERROR_ACTION=EXIT TTA2
This command sets the error action to EXIT.
6.$ SET HOST/DTE/MAX_BUFFERS=150 TTA2
This command sets the maximum number of receive buffers to 150.
7.$ SET HOST/DTE/ESCAPE=E TTA2
This command defines the letter E as the escape character. Note
that DTEPAD is not case sensitive.
8.$ SET HOST/DTE/LOG TTA2
This command enables logging of the session. Since no log
file is specified, the log is written to the default log file,
DTEPAD.LOG.
9.$ SET HOST/DTE/INIT=MYFILE.INI TTA2
This command uses the initialization file MYFILE.INI.
10$ <Ctrl/@>
DTEPAD>
This example shows you how to access DTE command mode by
pressing Ctrl/@, where @ is the command character.
11DTEPAD> SAVE MYFILE.INI
This command saves the information on the current configuration
in the file MYFILE.INI.
12DTEPAD> SET DTE/BREAK=G
This command defines the letter G as the break character.
13DTEPAD> SET DTE/ECHO
This command sets the terminal port so that echoing is
performed by the local system.
14DTEPAD> SET DTE/SPEED=4800
This command sets the input and output baud rates to 4800.
15DTEPAD> SET DTE/LOG=myfile.log
This command directs logging to the file MYFILE.LOG.
16DTEPAD> SHOW DTE
Port TXA0 EIGHT_BIT ECHO
Flow control XON/XOFF
Parity NONE
Transmit Speed 4800
Receive Speed 4800
Error action CONTINUE
Break character B
Escape character \
Command character @
Maximum buffers 100
Read delay 50 milliseconds
Log file MYFILE.INI
Number dialed 12345678
Modem type DF03
Bytes transmitted 75
Bytes received 132
Errors 0
This command displays all the current settings of the
configurable characteristics, the number of bytes transmitted
and received, and the number of errors detected.
20.5 /DUP
Connects your terminal to a storage controller through the
appropriate bus for that controller. The /SERVER and /TASK
qualifiers are required.
For use only with storage controllers. Requires the DIAGNOSE
privilege.
Format
SET HOST/DUP/SERVER=server-name
/TASK=task-name node-name
20.5.1 – Parameter
node-name
Specifies the node name of the storage controller.
20.5.2 – Qualifiers
20.5.2.1 /LOG
/LOG[=filespec]
/NOLOG (default)
Controls whether a log file of the entire session is kept. If you
use the /LOG qualifier without the file specification, the log
information is stored in the file HSCPAD.LOG.
20.5.2.2 /SERVER
/SERVER=server-name
Specifies the server name for the target storage controller.
This qualifier is required.
20.5.2.3 /TASK
/TASK=task-name
Specifies the utility or diagnostic name to be executed on the
target storage controller under direction of the server.
This qualifier is required.
20.5.3 – Example
$ SET HOST/DUP/SERVER=MSCP$DUP/TASK=DIRECT R2DH5Y
%HSCPAD-I-LOCPROGEXE, Local program executing -
type ^\ to exit utility
The SET HOST/DUP command in this example connects the user
terminal to the utility program called DIRECT executing on a
storage controller named R2DH5Y under direction of the MSCP$DUP
server.
20.6 /HSC
Connects your terminal to an HSC disk and tape controller through
the computer interconnect (CI) bus.
Used only with HSC controllers. Requires the DIAGNOSE privilege.
Format
SET HOST/HSC node-name
20.6.1 – Parameter
node-name
Specifies the node name of the HSC.
20.6.2 – Qualifier
20.6.2.1 /LOG
/LOG[=filespec]
/NOLOG (default)
Controls whether a log file of the entire session is kept. If you
use the /LOG qualifier without the file specification, the log
information is stored in the file HSCPAD.LOG.
20.6.3 – Example
$ SET HOST/HSC HSC001
%HSCPAD-I-LOCPROGEXE, Local program executing -
type ^\ to exit, ^Y for prompt
HSC>
This SET HOST/HSC command connects the user terminal to the HSC
named HSC001.
20.7 /LAT
Connects your terminal to a specified service available on
the local area network (LAN), establishing one session for
communication between your terminal and that service.
The service node that provides the service must be on the same
extended LAN and must be running at least Version 5.0 of the LAT
protocol.
Format
SET HOST/LAT service-name
20.7.1 – Parameter
service-name
Specifies the name of the service to which you want your terminal
connected. A service is a resource on the LAN. A service often
consists of all of the resources of a computer system. Other
examples of services are a file storage system and an application
program running on a computer system. A computer system that
offers one or more services is called a service node.
If several service nodes offer the same service, and you do not
specify the /NODE=node-name qualifier, your terminal connects to
the service node that is the least busy.
To display a list of services on your LAN, use the LAT Control
Program (LATCP) SHOW SERVICES command. See the VSI OpenVMS System
Management Utilities Reference Manual.
20.7.2 – Qualifiers
20.7.2.1 /AUTOCONNECT
/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.
20.7.2.2 /AUTOPROMPT
/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.
20.7.2.3 /BREAK
/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.
20.7.2.4 /DESTINATION_PORT
/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.
20.7.2.5 /DIAL
/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:
o DMCL (any modem that uses the DIGITAL Modem Command Language)
o DF03 (default)
o DF112
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).
20.7.2.6 /DISCONNECT
/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.
20.7.2.7 /EIGHT_BIT
/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.
20.7.2.8 /FRAME
/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
20.7.2.9 /LOG
/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.
20.7.2.10 /NODE
/NODE=node-name
Specifies the node that offers the service to which you want to
connect. Failover is not performed if the connection fails.
20.7.2.11 /PASSWORD
/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.
20.7.2.12 /QUEUE
/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.
20.7.2.13 /SPEED
/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
20.7.3 – Examples
1.$ SET HOST/LAT SORTER
%LAT-S-CONNECTED, session to SORTER established
%LAT-I-TODISCON, type ^\ to disconnect the session
Username: BARKER
Password:
.
.
.
$ LOGOUT
BARKER logged out at 30-DEC-2001 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 pressing 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.
20.8 /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
{ IPhostname }
SET HOST/RLOGIN { IPaddress }
{ }
NOTE
You can specify the IPhostname or the IPaddress, but not
both.
20.8.1 – Parameter
IPhostname
Specifies the IP host name of the remote host.
IPaddress
Specifies an IP address of the remote host.
20.8.2 – Qualifiers
20.8.2.1 /AUTHENTICATE
Specifies that Kerberos authentication should be used for
acquiring access to the remote node.
20.8.2.2 /TERMINAL_TYPE
/TERMINAL_TYPE=type
Sets the terminal emulator to one of the following terminal
types: VT100, VT200, VT300, VT400, VT500.
20.8.2.3 /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.
20.8.2.4 /USERNAME
/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.
20.8.3 – Example
$ SET HOST/RLOGIN remotehst1
This example creates an RLOGIN connection to remote host
remotehst1 over a TCP/IP connection.
20.9 /TELNET
Connects you to a remote host over a TCP/IP connection by
invoking the TELNET application.
Format
{ IPhostname }
SET HOST/TELNET { IPaddress }
{ }
NOTE
You can specify the IPhostname or the IPaddress, but not
both.
20.9.1 – Parameters
IPhostname
Specifies the IP host name of the remote host.
IPaddress
Specifies an IP address of the remote host.
20.9.2 – Qualifiers
20.9.2.1 /AUTHENTICATE
Specifies that Kerberos authentication should be used for
acquiring access to the remote node.
20.9.2.2 /PORT
/PORT=port
Specifies the remote TCP port to use. The default is 23.
20.9.2.3 /TERMINAL_TYPE
/TERMINAL_TYPE=type
Sets the terminal emulator to one of the following terminal
types: VT100, VT200, VT300, VT400, VT500.
20.9.3 – Example
$ SET HOST/TELNET remotehst2
This example creates a TELNET connection to remote host
remotehst2 over a TCP/IP connection.
20.10 /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
{ IPhostname }
SET HOST/TN3270 { IPaddress }
{ }
NOTE
You can specify the IPhostname or the IPaddress, but not
both.
20.10.1 – Parameters
IPhostname
Specifies the IP host name of the remote host.
IPaddress
Specifies an IP address of the remote host.
20.10.2 – Qualifiers
20.10.2.1 /AUTHENTICATE
Specifies that Kerberos authentication should be used for
acquiring access to the remote node.
20.10.2.2 /PORT
/PORT=port
Specifies the remote TCP port to use. The default is 23.
20.10.2.3 /TERMINAL_TYPE
Sets the terminal emulator to one of the following terminal
types: VT100, VT200, VT300, VT400, VT500.
20.10.3 – 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.
21 – IMAGE
Valid on Alpha and Integrity server systems only.
Modifies the current attributes for the specified image file.
This command can be used to modify the initial values set by the
OpenVMS Integrity servers Linker for certain image attributes.
NOTE
This command can be executed on an Alpha or Integrity
servers system, but it operates only on Integrity servers
images.
Format
SET IMAGE image-filespec
21.1 – Parameters
image-filespec
Specifies the name of an OpenVMS Integrity servers image file to
modify. The command overlays the current image file; it does not
create a new version of the image file.
The asterisk (*) and percent sign (%) wildcard characters are
allowed in the file specification if the /RESTORE qualifier is
used. If you omit the file type extension, the default file type
.EXE is applied.
21.2 – Qualifier
21.2.1 /FLAGS
/FLAGS=(keyword[,...])
Specifies which image attribute flags to turn on or off. The
original flags are set by the OpenVMS Integrity servers Linker
at image link time. The possible keywords are listed below with
a brief description. For more information about the image link
flags, see the VSI OpenVMS Version 8.2 Release Notes.
WARNING
Beware of modifying the flag values unless you are very
knowledgeable about the internals of the image.
Keyword Description
[NO]CALL_DEBUG Call Debugger at startup.
[NO]DBG_IN_DSF Debug records in debug symbol file.
[NO]DBG_IN_IMG Debug records in image file.
[NO]EXE_INIT Image has a pointer to EXE$INITIALIZE.
[NO]IMGSTA Call SYS$IMGSTA.
[NO]INITIALIZE Image has a pointer to LIB$INITIALIZE.
[NO]MAIN Image has a main transfer address.
[NO]MKTHREADS Enable multiple kernel thread use.
[NO]NOP0BUFS No P0 buffers for RMS image I/O.
[NO]P0IMAGE Image is loaded only to P0 space.
[NO]SIGNATURES TIE Signatures are present.
[NO]TBK_IN_DSF Traceback records in debug symbol file.
[NO]TBK_IN_IMG Traceback records in image file.
[NO]UPCALLS User thread upcalls are enabled.
21.2.2 /LOG
Displays a message to the output device indicating whether the
command successfully modified the image.
21.2.3 /RESTORE
Restores the original image attributes of the file-that is, the
initial attributes that were set by the OpenVMS Integrity servers
Linker. You cannot specify the /FLAGS or /SUCCESS qualifier when
/RESTORE is used.
21.2.4 /SUCCESS
Modifies the image link completion code value to SUCCESS. The
run-time behavior of the image remains the same as the original
link.
21.3 – Examples
1.$ SHOW IMAGE WARNING
Show Image Version 1.2 29-SEP-2004 10:15:52.61
WORK1:[SWEENEY.CLIUTL]WARNING.EXE;1
This is an OpenVMS IA64 (Elf format) executable image file
Image Identification Information
Image name: WARNING
Global Symbol Table name: WARNING
Image file identification: X-6
Image build identification: <unavailable>
Link identification: Linker T02-14
Link Date/Time: 12-JUN-2004 10:15:16.46
Patch Date/Time: Never
Manipulation Date/Time: Never
Image Dynamic Data Version: 1.2
Image Completion Code Value: WARNING State: Original
Image Link Flags state: Original
Image Link Flags
--------------------------------------------
CALL_DEBUG : Call debugger
IMGSTA : Call SYS$IMGSTA
MAIN : Image has main transfer
TBK_IN_IMG : Traceback records in image file
DBG_IN_IMG : Debug records in image file
$!
$ SET IMAGE/SUCCESS WARNING.EXE
$ SHOW IMAGE WARNING.EXE
Show Image Version 1.2 29-SEP-2004 11:41:54.93
WORK1:[SWEENEY.CLIUTL]WARNING.EXE;1
This is an OpenVMS IA64 (Elf format) executable image file
Image Identification Information
Image name: WARNING
Global Symbol Table name: WARNING
Image file identification: X-6
Image build identification: <unavailable>
Link identification: Linker T02-14
Link Date/Time: 12-JUN-2004 10:02:53.51
Patch Date/Time: Never
Manipulation Date/Time: 29-SEP-2004 11:26:31.57
Image Dynamic Data Version: 1.2
Image Completion Code Value: SUCCESS State: Manipulated
Image Link Flags state: Original
Image Link Flags
--------------------------------------------
CALL_DEBUG : Call debugger
IMGSTA : Call SYS$IMGSTA
MAIN : Image has main transfer
TBK_IN_IMG : Traceback records in image file
DBG_IN_IMG : Debug records in image file
In this example the SET IMAGE/SUCCESS command is used to change
the link completion code value in the image to SUCCESS. The
output of the second SHOW IMAGE command displays that the image
completion code value has been changed.
2.$ SHOW IMAGE SYS$SYSTEM:DCE$DCED.EXE
Show Image Version 1.2 29-SEP-2004 12:40:04.32
SYS$COMMON:[SYSEXE]DCE$DCED.EXE;199
This is an OpenVMS IA64 (Elf format) executable image file
Image Identification Information
Image name: DCE$DCED
Global Symbol Table name: DCE$DCED
Image file identification: DCE T3.2-040610
Image build identification: <unavailable>
Link identification: Linker I01-68
Link Date/Time: 11-JUN-2004 01:50:11.71
Patch Date/Time: Never
Manipulation Date/Time: Never
Image Dynamic Data Version: 1.1
Image Completion Code Value: SUCCESS State: Original
Image Link Flags state: Original
Image Link Flags
--------------------------------------------
MAIN : Image has main transfer
$ SET IMAGE/FLAGS=(MKTH,UPCALL) SYS$SYSTEM:DCE$DCED.EXE
$!
$ SHOW IMAGE SYS$SYSTEM:DCE$DCED.EXE
Show Image Version 1.2 29-SEP-2004 12:43:34.90
SYS$COMMON:[SYSEXE]DCE$DCED.EXE;1
This is an OpenVMS IA64 (Elf format) executable image file
Image Identification Information
Image name: DCE$DCED
Global Symbol Table name: DCE$DCED
Image file identification: DCE T3.2-040610
Image build identification: <unavailable>
Link identification: Linker I01-68
Link Date/Time: 11-JUN-2004 01:50:11.71
Patch Date/Time: Never
Manipulation Date/Time: 29-SEP-2004 12:43:02.14
Image Dynamic Data Version: 1.1
Image Link Flags state: Manipulated
Current Image Flags Original Link Flags
------------------- -------------------
MKTHREADS MAIN
UPCALLS
MAIN
Image Link Flag Description
--------------- -------------------------------------
MKTHREADS : Multiple kernel threads enabled
UPCALLS : Upcalls enabled
MAIN : Image has main transfer
The SET IMAGE command in this example shows how to enable
multiple kernel threads and thread upcalls in the image
SYS$SYSTEM:DCE$DCED.EXE.
3.$ SHOW IMAGE PATCH.EXE;61
Show Image 30-SEP-2004 09:06:39.57
WORK1:[SWEENEY.PATCH]PATCH.EXE;61
This is an OpenVMS IA64 (Elf format) executable image file
Image name: PATCH
Global Symbol Table name: PATCH
Link Date/Time: 23-SEP-2004 10:22:07.04
Manipulation Date/Time: Never
Link flags state: Original
Link Flags
------------------
CALL_DEBUG
IMGSTA
MAIN
TBK_IN_IMG
DBG_IN_IMG
$ DEFINE PATCH WORK1:[SWEENEY.PATCH]PATCH.EXE;61
$ PATCH X.LIS
OpenVMS Integrity servers Debug64 Version 8.2
%DEBUG-I-INITIAL, Language: BLISS, Module: PATMAIN
DBG>Exit
$ SET IMAGE/FLAGS=NOCALL_DEBUG PATCH.EXE
$ PATCH X.LIS
OpenVMS PATCH Version 8.2
%PATCH-I-NOGBL, some or all global symbols not accessible
%PATCH-I-NOLCL, image does not contain local symbols
PATCH>
This example demonstrates how to modify an image to stop the
debugger from being called when the image is initiated. The
image PATCH.EXE was linked with debugging enabled. The SET
IMAGE /FLAGS=NOCALL_DEBUG command allows the debugger to be
bypassed when the image is run.
22 – KEY
Sets and locks the key definition state for keys defined with the
DEFINE/KEY command.
Format
SET KEY
22.1 – Qualifiers
22.1.1 /LOG
/LOG (default)
/NOLOG
Controls whether the system displays a message indicating that
the key state has been set.
22.1.2 /STATE
/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.
22.2 – 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.
23 – 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
23.1 – Qualifier
23.1.1 /INTERACTIVE
/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.
23.2 – 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.
24 – 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[:]
24.1 – 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.
24.2 – Qualifiers
24.2.1 /DENSITY
/DENSITY=density-value
Specifies the default density for all write operations on the
magnetic tape device when the volume is mounted as a foreign tape
or as an unlabeled tape.
Valid density values are:
Keyword Meaning
DEFAULT Default density
800 NRZI 800 bits per inch (BPI)
1600 PE 1600 BPI
6250 GRC 6250 BPI
3480 IBM 3480 HPC 39872 BPI
3490E IBM 3480 compressed
833 DLT TK50: 833 BPI
TK50 DLT TK50: 833 BPI
TK70 DLT TK70: 1250 BPI
6250 RV80 6250 BPI EQUIVALENT
NOTE: Only the keywords above are understood by TMSCP/TUDRIVER
code prior to OpenVMS Version 7.2. The remaining keywords in this
table are supported only on Alpha and Integrity server systems.
TK85 DLT Tx85: 10625 BPI - Cmpt III - Alpha/Integrity
servers only
TK86 DLT Tx86: 10626 BPI - Cmpt III - Alpha/Integrity
servers only
TK87 DLT Tx87: 62500 BPI - Cmpt III - Alpha/Integrity
servers only
TK88 DLT Tx88: (Quantum 4000) - Cmpt IV - Alpha/Integrity
servers only
TK89 DLT Tx89: (Quantum 7000) - Cmpt IV - Alpha/Integrity
servers only
QIC All QIC drives are drive-settable only -
Alpha/Integrity servers only
8200 Exa-Byte 8200 - Alpha/Integrity servers only
8500 Exa-Byte 8500 - Alpha/Integrity servers only
DDS1 Digital Data Storage 1 - 2G - Alpha/Integrity servers
only
DDS2 Digital Data Storage 2 - 4G - Alpha/Integrity servers
only
DDS3 Digital Data Storage 3 - 8-10G - Alpha/Integrity
servers only
DDS4 Digital Data Storage 4 - Alpha/Integrity servers only
AIT1 Sony Advanced Intelligent Tape 1 - Alpha/Integrity
servers only
AIT2 Sony Advanced Intelligent Tape 2 - Alpha/Integrity
servers only
AIT3 Sony Advanced Intelligent Tape 3 - Alpha/Integrity
servers only
AIT4 Sony Advanced Intelligent Tape 4 - Alpha/Integrity
servers only
DLT8000 DLT 8000 - Alpha/Integrity servers only
8900 Exabyte 8900 - Alpha/Integrity servers only
SDLT SuperDLT1 - Alpha/Integrity servers only
SDLT320 SuperDLT320 - Alpha/Integrity servers only
Note that tape density keywords cannot be abbreviated.
24.2.2 /END_OF_FILE
Writes a tape mark at the current position on the magnetic tape
volume.
24.2.3 /FAST_SKIP
/FAST_SKIP=option
Requires PHY_IO privilege.
Allows you to skip by file mark or by record.
NOTE
This tape positioning qualifier is for use on local SCSI
tape drives only.
PER_IO Allows a local MK device to use the skip-by-
(default) filemarks function. The tape drive must be able
to do a SCSI READ POSITION command and report
blank check at end-of-data. The IO$M_ALLOWFAST
function modifier must be supplied with IO$_
SKIPFILE. Otherwise, the tape will skip files
using the skip-by-records function.
ALWAYS Allows a local MK device to use the skip-by-
filemarks function. The tape drive must be able
to support the skip-by-filemarks function, and
no modifications should be needed to the IO$_
SKIPFILE function.
NEVER Specifies that a local MK device skip only by
records. If you use a utility that depends on the
semantics of skipping with skip-records, you may
also need to use this option because it causes
BACKUP or COPY to use the previous positioning.
24.2.4 /LOG
/LOG
/NOLOG
Displays information about the operations performed on the
magnetic tape volume.
24.2.5 /LOGSOFT
/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.
24.2.6 /MEDIA_FORMAT
/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.
24.2.7 /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.
24.2.8 /REWIND
Requests that the volume on the specified device be rewound to
the beginning of the magnetic tape.
24.2.9 /SKIP
/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 VSI OpenVMS System
Manager's Manual.
RECORD:n Skips the specified number of records up to
32767.
24.2.10 /UNLOAD
Requests that the volume on the specified device be rewound and
unloaded.
24.3 – 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.
25 – 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]
25.1 – 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.
25.2 – Qualifiers
25.2.1 /DELETE
Removes any process-permanent message files currently in effect.
Do not specify the filespec parameter with the /DELETE qualifier.
25.2.2 /FACILITY
/FACILITY (default)
/NOFACILITY
Formats messages so that the facility name prefix appears.
25.2.3 /IDENTIFICATION
/IDENTIFICATION (default)
/NOIDENTIFICATION
Formats messages so that the message identification prefix
appears.
25.2.4 /SEVERITY
/SEVERITY (default)
/NOSEVERITY
Formats messages so that the severity level appears.
25.2.5 /TEXT
/TEXT (default)
/NOTEXT
Formats messages so that the message text appears.
25.3 – Examples
1.$ TYPE XXX
%TYPE-W-OPENIN, error opening DB1:[MARSHALL]XXX.LIS; as input
-RMS-E-FNF, file not found
.
.
.
$ SET MESSAGE/NOIDENTIFICATION
.
.
.
$ TYPE XXX
%TYPE-W, error opening DB1:[MARSHALL]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.
26 – NETWORK
Registers the attributes of a network service.
Requires SYSNAM (system name) privilege.
Format
SET NETWORK network-service
26.1 – Parameter
network-service
Specifies the name of a network service.
26.2 – Qualifiers
26.2.1 /ADDRESS
/ADDRESS=address[es]
Specifies the network address of the local node.
26.2.2 /CONNECTIONS
/CONNECTIONS=
Specifies a command to be executed to display the number of
network connections.
26.2.3 /COUNTERS
/COUNTERS=
Specifies a command to be executed to display the number of
network counters.
26.2.4 /DATA
/DATA=
Specifies a character string provided by the network service
vendor.
26.2.5 /INTERFACE
/INTERFACE=
Specifies the OpenVMS driver for the network service.
26.2.6 /MANUFACTURER
/MANUFACTURER=
Specifies the manufacturer of the network service.
26.2.7 /NETWORK_TYPE
/NETWORK_TYPE=
Specifies the protocol for the network service.
26.2.8 /NODE
/NODE=
Specifies the name of the local node.
26.2.9 /PPPD_CALLOUT
/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.
26.2.10 /REGISTER
Defines a new network service.
26.2.11 /REMOVE
Deletes a network service from the database.
26.2.12 /START
/START=
Specifies an image to be executed when you issue the
START/NETWORK command for the network service.
26.2.13 /STATUS
/STATUS=
Specifies a command to be executed to display additional status
information.
26.2.14 /STOP
/STOP=
Specifies an image to be executed when you issue the STOP/NETWORK
command for the network service.
26.2.15 /UPDATE
Allows you to modify the specified data for the network service.
26.3 – Examples
1.$ SET NETWORK DECnet -
_$ /MANUFACTURER= "VMS Software, Inc." -
_$ /NODE="GALENA" -
_$ /ADDRESS="19.129" -
_$ /NETWORK_TYPE="DNA V" -
_$ /INTERFACE="net 0" -
_$ /DATA="Router: No" -
_$ /STATUS="mcr ncl show node 0 all" -
_$ /CONNECTIONS="mcr ncl show node 0 session control port * all"-
_$ /COUNTERS="mcr ncl show node 0 session control all counters"-
_$ /START="@sys$startup:net$startup" -
_$ /STOP="@sys$manager:net$shutdown"
This command adds the network service DECnet-Plus (Phase V) to
the database, with the specified characteristics.
2.$ SET NETWORK "TCP/IP" /REGISTER -
_$ /MANUFACTURER="Hewlett-Packard Company" -
_$ /NODE="ipv6.ucx.mars.univers.com" -
_$ /ADDRESS="16.20.207.92" -
_$ /NETWORK_TYPE="TCP/IP" -
_$ /STATUS="TCPIP SHOW SERVICE" -
_$ /CONNECTIONS="TCPIP SHOW DEVICE" -
_$ /PPPD_CALLOUT="TCPIP$PPPD_CALLOUT"
This command creates a new TCP/IP network service, adds it
to the database, and enables the PPPD utility by supplying a
logical name that identifies the location of the shareable
image.
3.$ SET NETWORK DECnet -
_$ /MANUFACTURER= "VMS Software, Inc." -
_$ /NODE="EMARET" -
_$ /ADDRESS="12.378" -
_$ /NETWORK_TYPE="DNA IV" -
_$ /INTERFACE="net 0" -
_$ /STATUS="mcr ncp show exec characteristics" -
_$ /CONNECTIONS="mcr ncp show known link" -
_$ /COUNTERS="mcr ncp show exec count" -
_$ /START="@sys$manager:startnet" -
_$ /STOP="mcr ncp set executor state shut"
This command adds the network service DECnet (Phase IV) to the
database, with the specified characteristics.
27 – ON
Enables error checking by the command interpreter after the
execution of each command in a command procedure. Specify SET
NOON to disable error checking.
Format
SET [NO]ON
27.1 – Example
$ SET NOON
$ DELETE *.SAV;*
$ SET ON
$ COPY *.OBJ *.SAV
This command procedure routinely copies all object modules
into new files with the file type .SAV. The DELETE command
first deletes all existing files with the .SAV file type, if
any. The SET NOON command ensures that the procedure continues
executing even if there are no files with the .SAV file type
in the current directory. Following the DELETE command, the SET
ON command restores error checking. Then the COPY command makes
copies of all existing files with .OBJ file type.
28 – OUTPUT_RATE
Sets the rate at which output is written to a batch job log file.
For use only within command procedures that are submitted as
batch or detached jobs.
Format
SET OUTPUT_RATE[=delta-time]
28.1 – Parameter
delta-time
The time interval at which output is written from the output
buffer to the batch job log file. If no delta time is specified,
the information is written in the output buffer to the log file,
but the output rate is not changed from the default of once per
minute. Specify delta-time as [dddd-][hh:mm:ss.cc]. For more
information on delta time, see the OpenVMS User's Manual or the
online help topic Date.
28.2 – Example
$ SET OUTPUT_RATE=:0:30
.
.
.
This command, when executed within a batch job, changes
the default output rate from once a minute to once every 30
seconds.
29 – PASSWORD
Changes a password or system password. Also, can establish a
secondary password or system password, or remove a secondary
password.
A user password can contain up to 32 alphanumeric and special
characters. Unless your system manager has set the PWDMIX flag
in your authorization account record, the only special characters
permitted are the dollar sign ($) and underscore (_). Without
the PWDMIX authorization, all lowercase characters are converted
to uppercase before the password is encrypted. For example,
"eagle" is the same as "EAGLE."
If you have PWDMIX authorization, you can specify uppercase and
lowercase alphabetic characters, and you can use any special
characters in the printable character set. However, avoid using
characters that have special significance for layered products
that accept passwords. For example, a double quotation mark (")
would be unacceptable in a password in a DECnet access control
string.
See the qualifier descriptions for restrictions.
Format
SET PASSWORD
29.1 – Qualifiers
29.1.1 /GENERATE
/GENERATE[=value]
Generates a list of five random passwords. Press Return to repeat
the procedure until a suitable password appears.
Value is a number from 1 to 10 that restricts the length of the
password. For any value n, the SET PASSWORD command generates
passwords of from n to (n+2) characters long.
If no value is specified, SET PASSWORD uses a default value of
6, and generates passwords from 6 to 8 characters long. Values
greater than 10 are not accepted and produce errors.
If your system manager has established a minimum password length
for your account, SET PASSWORD/GENERATE=n compares that length
with the optional value specified with the /GENERATE qualifier,
and uses the larger of the two values. If you do not specify a
value with the /GENERATE qualifier, the account minimum length is
used.
NOTE
If the SET PASSWORD/GENERATE command fails to work properly,
consult your system manager to be sure that either the file
SYS$LIBRARY:VMS$PASSWORD_DICTIONARY.DATA exists, or the
logical name VMS$PASSWORD_DICTIONARY is correctly defined.
29.1.2 /SECONDARY
Creates or allows you to replace a secondary password. The
procedure is the same as setting your primary password.
Once a secondary password has been established, you will receive
two PASSWORD: prompts when logging in. The primary password
should be typed in first, followed by the secondary password.
Secondary passwords make it possible to set up an account that
requires two different people to access it. Each person knows one
of the two passwords, and both passwords are required to log in
successfully.
To remove your secondary password, press Return when SET
PASSWORD/SECONDARY prompts you for a new password and
verification. After you do this, you will receive a single
PASSWORD: prompt when logging in. If you remove the secondary
password, your system manager must restore it.
The /SECONDARY and /SYSTEM qualifiers are incompatible.
29.1.3 /SYSTEM
Requires the SECURITY privilege.
Changes the system password rather than a user password.
A system password can be from 0 to 32 alphanumeric characters.
The dollar sign ($) and underscore (_) are also permitted.
Uppercase and lowercase characters are equivalent. All lowercase
characters are converted to uppercase before the password is
encrypted.
A system password is valid only for the node it is set on. In an
OpenVMS Cluster, each node can have a different system password.
If a terminal line has the system password (SYSPWD)
characteristic set, no terminal prompts are sent to that terminal
until the system password is entered.
The /SYSTEM and /SECONDARY qualifiers are incompatible. For more
information about the use of system passwords, see the VSI OpenVMS
Guide to System Security.
29.2 – Example
$ SET PASSWORD
Old password: HONCHO
New password: BIG_ENCHILADA
Verification: BIG_ENCHILADA
In response to the SET PASSWORD command, the system first
prompts for the old password and then for the new password. The
system then prompts again for the new password to verify it.
The password changes if the user is authorized to change this
account's password, if the old password is given correctly, and
if the new password is given identically twice; otherwise, an
error message appears and the password remains unchanged.
In a real session, neither the old password nor the new
password and its verification appear on the screen or paper.
30 – PREFERRED_PATH
Access to a MSCP/TMSCP class device may be available to an
OpenVMS node from more than one host or storage controller. Use
the SET PREFERRED_PATH command to specify a particular host or
preferred path to access a specific MSCP class disk or TMSCP
class tape device.
If a preferred path is specified, the normal OpenVMS path
selection process is modified to select the user-specified path
over other available paths, assuming the user-specified path is
available.
This command is only meaningful for MSCP/TMSCP class devices that
have more than one path available.
Format
SET PREFERRED_PATH device-name:
30.1 – Parameter
device-name:
Specifies the name of a MSCP class disk or TMSCP class tape
device.
30.2 – Qualifiers
30.2.1 /HOST
/HOST=host_name
Tells the MSCP/TMSCP class driver that you want this host to
be the preferred access path to the specified device. The class
driver remembers this host name until it is changed by taking one
of the following actions:
o Issuing another SET PREFERRED_PATH command specifying a
different host
o Using the /NOHOST qualifier
o Rebooting the system
Note that simply specifying a preferred path does not mean
that it is immediately selected if the disk or tape device is
currently using another path. Use the /FORCE qualifier along
with the /HOST qualifier to force the preferred path to be used
immediately.
The host_name is the name of the host that will be the preferred
path to the disk or tape device.
30.2.2 /FORCE
Tells the class driver to initiate the path selection process
immediately. If this qualifier is omitted when a new host name
is specified, a switch from the current path to the new preferred
path will not occur until some other event initiates the path
selection process.
30.2.3 /NOHOST
Clears any previously defined preferred path assignment. Restores
usual OpenVMS path selection behavior.
30.3 – Examples
1.$ SET PREFERRED_PATH $10$DUA10: /HOST=HSC014
Prior to issuing this command, the $10$DUA10: disk device
has host HSC015 as its primary path and host HSC014 as its
secondary path. Issuing this command selects host HSC014 as the
preferred path.
Note that the preferred path has been recorded by the class
driver; however, the disk will remain on the current path
(HSC015) until the next time the path selection process is
initiated.
2.$ SET PREFERRED_PATH $10$DUA10: /HOST=HSC014 /FORCE
To make the path change occur immediately, include the
/FORCE qualifier on the command line with the preferred path
specification.
3.$ SET PREFERRED_PATH $10$DUA10: /FORCE
Issue this command to initiate path selection processing if
the specified device has a primary path that differs from the
preferred path.
If the preferred path is available, the device moves to that
path.
4.$ SET PREFERRED_PATH $10$DUA10: /NOHOST
Remove the specified preferred path by using the /NOHOST
qualifier if the device should no longer have a preferred path.
31 – PREFIX
Allows you to set a prefix control string for verified command
lines.
Format
SET [NO]PREFIX string
31.1 – Parameter
string
Specifies the FAO control string to be used in generating a
prefix to a verified command line. The following rules apply:
o No more than 64 characters are allowed in the control string.
o The resulting string can be no longer than 64 characters.
o Basic formatting FAO directives can be used ("!/", "!_", "!^",
"!!", "!%F", and "!n*c").
o Time and date FAO directives can be used ("!%T" and "!%D").
o Repeat counts can be used ("!n(DD)").
o Output field length specifications can be used ("!lengthDD").
o Combination of repeat count and output field length can be
used ("!n(lengthDD)").
o FAO directives that require arguments will always receive a
value of zero.
31.2 – Example
$ SET VERIFY
$ @TEST
$ SET DEFAULT SYS$LOGIN
$ SHOW DEFAULT
USER$:[JENSEN]
$ SET PREFIX "(!5%T) "
$ @TEST
(17:52) $ SET DEFAULT SYS$LOGIN
(17:52) $ SHOW DEFAULT
USER$:[JENSEN]
This example demonstrates the difference between having and
not having a prefix for verification. The first command turns
on verification. (Verification must be turned on to see the
prefix.) The second command invokes a test procedure to show
what the output looks like without a prefix. The third and
fourth lines reflect the contents of the test procedure invoked
in the preceding command. The third command sets the prefix to
an FAO control string so that the first five characters of the
standard time will be shown for each command. The last command
invokes the test procedure again to demonstrate what the output
looks like with a prefix.
32 – PRINTER
Establishes the characteristics of a specific line printer. The
default values listed for qualifiers to the SET PRINTER command
are the defaults for an initially bootstrapped system.
Requires OPER (operator) privilege. If the printer is a spooled
device, LOG_IO (logical I/O) privilege is required to modify its
characteristics.
Format
SET PRINTER printer-name[:]
32.1 – Parameter
printer-name[:]
Specifies the name of a line printer to set or modify its
characteristics.
32.2 – Qualifiers
32.2.1 /CR
/CR
/NOCR (default)
Controls whether the printer driver outputs a carriage return
character. Use this qualifier for printers on which line feeds do
not imply carriage returns.
Specify the /NOCR qualifier for printers where the line feed,
form feed, vertical feed, and carriage return characters empty
the printer buffer. The /NOCR qualifier causes carriage return
characters to be held back and output only if the next character
is not a form feed or vertical tab. Carriage return characters
are always output on devices that have the carriage return
function characteristic set.
32.2.2 /FALLBACK
/FALLBACK
/NOFALLBACK (default)
Determines whether the printer attempts to translate characters
belonging to the DEC Multinational character set into 7-bit
equivalent representations. If a character cannot be translated,
an underscore (_) character is substituted.
If the /PASSALL qualifier is in effect, it has precedence over
the /FALLBACK qualifier.
32.2.3 /FF
/FF (default)
/NOFF
Indicates whether the printer performs a mechanical form feed.
Use the /NOFF qualifier when the printer does not automatically
perform mechanical form feeds. This qualifier allows the driver
to convert form feeds into multiple line feeds and to output
them.
32.2.4 /LA11
Specifies the printer as an LA11. This qualifier provides
information for the SHOW PRINTER command, which, in turn,
provides the user with information about specific printers. If
no printer type is specified, LP11 is assumed.
32.2.5 /LA180
Specifies the printer as an LA180. This qualifier provides
information for the SHOW PRINTER command, which, in turn,
provides the user with information about specific printers. If
no printer type is specified, LP11 is assumed.
32.2.6 /LOG
/LOG
/NOLOG (default)
Determines whether information confirming the printer setting is
displayed at the terminal from which the SET PRINTER command was
entered.
32.2.7 /LOWERCASE
/LOWERCASE
/NOLOWERCASE
Indicates whether the printer prints both uppercase and lowercase
letters or only uppercase. When the operator specifies the
/NOLOWERCASE qualifier, all letters are translated to uppercase.
The /[NO]LOWERCASE and /[NO]UPPERCASE qualifiers are
complementary; that is, the /LOWERCASE qualifier is equivalent
to the /NOUPPERCASE qualifier, and the /NOLOWERCASE qualifier is
equivalent to the /UPPERCASE qualifier.
32.2.8 /LP11
/LP11 (default)
Specifies the printer as an LP11. This qualifier provides
information for the SHOW PRINTER command, which, in turn,
provides the user with information about specific printers. LP11
is the default printer type.
32.2.9 /PAGE
/PAGE=lines-per-page
Establishes the number of lines per page on the currently
installed form; the number of lines can range from 1 to 255 and
defaults to 64. The printer driver uses this value to determine
the number of line feeds that must be entered to simulate a form
feed.
32.2.10 /PASSALL
/PASSALL
/NOPASSALL (default)
Controls whether the system interprets special characters or
passes them as 8-bit binary data.
If you specify the /PASSALL qualifier, the printer driver does
not expand tab characters to spaces, fill carriage return or line
feed characters, or recognize control characters.
32.2.11 /POLLED
/POLLED
/NOPOLLED (default)
Instructs the LRDRIVER to run in polled mode instead of interrupt
mode.
In polled mode, the printer is checked on a regular basis to
determine if it is ready to receive additional data. The polling
timer runs only while there is more data to be sent to the
printer.
32.2.12 /PRINTALL
/PRINTALL
/NOPRINTALL (default)
Controls whether the line printer driver outputs printable 8-bit
multinational characters.
32.2.13 /RESET
Resets the USB pipe associated with the USB printer, thereby
canceling all print jobs.
32.2.14 /TAB
/TAB
/NOTAB (default)
Controls how the printer handles TAB characters. The /NOTAB
qualifier expands all tab characters to spaces and assumes tab
stops at 8-character intervals.
Use the /TAB qualifier when you do not want the system to
convert tabs to spaces, but want the printer to process the tab
characters. The OpenVMS system requires that printers expand tabs
at 8-character intervals.
32.2.15 /TRUNCATE
/TRUNCATE (default)
/NOTRUNCATE
Controls whether the printer truncates data exceeding the value
specified by the /WIDTH qualifier. Note that the /TRUNCATE and
/WRAP qualifiers are incompatible.
32.2.16 /UNKNOWN
Specifies the printer as nonstandard. This qualifier provides
information for the SHOW PRINTER command, which, in turn,
provides the user with information about specific printers. If
no printer type qualifier is specified, LP11 is assumed.
32.2.17 /UPPERCASE
/UPPERCASE
/NOUPPERCASE
Indicates whether the printer prints both uppercase and lowercase
letters or only uppercase ones. When you specify the /UPPERCASE
qualifier, all letters are translated to uppercase.
The /[NO]UPPERCASE and /[NO]LOWERCASE qualifiers are
complementary; that is, the /UPPERCASE qualifier is equivalent
to the /NOLOWERCASE qualifier, and the /NOUPPERCASE qualifier is
equivalent to the /LOWERCASE qualifier.
32.2.18 /WIDTH
/WIDTH=n
Establishes the number of characters per output line on currently
installed forms. The width, n, can range from 0 to 65535 for LP11
controllers, and from 0 to 255 for DMF32 controllers. The default
value is 132 characters per line.
32.2.19 /WRAP
/WRAP
/NOWRAP (default)
Controls whether the printer generates a carriage return and a
line feed when it reaches the end of a line.
If the /NOWRAP qualifier is specified, the printer writes
characters out in the last position on the line.
If the /WRAP qualifier is specified, the terminal generates a
carriage return and a line feed whenever the end of a line is
reached.
Note that the /TRUNCATE and /WRAP qualifiers are incompatible.
32.3 – Examples
1.$ SET PRINTER/PAGE=60/WIDTH=80 LPA0:
The SET PRINTER command in this example establishes the size
of an output page as 60 lines and the width of a line as 80
characters for printer LPA0.
2.$ SET PRINTER/LA11 LPB0:
The SET PRINTER command in this example establishes the line
printer LPB0 as an LA11 printer.
3.$ SET PRINTER/LOWERCASE LPA0:
The SET PRINTER command in this example requests that lowercase
printing be enabled on line printer LPA0.
33 – PROCESS
Changes the execution characteristics associated with the
specified process or kernel thread for the current terminal
session or job. If no process is specified, changes are made
to the current process.
Requires GROUP privilege to change other processes in the same
group. Requires WORLD privilege to change processes outside your
group.
Format
SET PROCESS [process-name]
33.1 – Parameter
process-name
Requires that you own the process or that you have GROUP
privilege and that the process is in your group.
Specifies the name of the process for which the characteristics
are to be changed. Process names can be up to 23 alphanumeric
characters long in the following format:
[node-name::]process-name
o The node name can have as many as 6 alphanumeric characters.
o The colons (:) count for 2 characters.
o The process name can have as many as 15 characters.
A local process name can look like a remote process name;
therefore, if you specify ATHENS::SMITH, the system checks for
a process named ATHENS::SMITH on the local node before checking
node ATHENS for a process named SMITH.
The default process is the current process.
Process names are unique only within a particular UIC group.
You cannot specify the process name for a process outside of
your group. To change the characteristics of a process outside
of your group, you must use the qualifier /IDENTIFICATION=pid.
The process name parameter is ignored. If you include neither
the process name nor the /IDENTIFICATION qualifier, the current
process is assumed.
33.2 – Qualifiers
33.2.1 /AFFINITY
/AFFINITY (Alpha/Integrity servers only)
/NOAFFINITY
Allows bits in the kernel thread affinity mask to be set or
cleared individually, in groups, or all at once. This qualifier
is mutually exclusive with the /CAPABILITY qualifier.
NOTE
The SET PROCESS/[NO]AFFINITY command fails if none of the
specified CPUs has the capabilities required by the process.
The /NOAFFINITY qualifier clears all affinity bits currently set
in the current or permanent affinity masks, based on the setting
of the /PERMANENT qualifier. Specifying the /AFFINITY qualifier
has no direct effect, but merely indicates the target of the
operations specified by the following secondary parameters:
/SET=(n[,..Sets affinity for currently active CPUs defined by the
CPU IDs n, where n has the range of 0 to 63.
/CLEAR=(n[,Clears affinity for currently active CPUs defined by
the position values n, where n has the range of 0 to
63.
/PERMANENT Performs the operation on the permanent affinity
mask as well as the current affinity mask, making the
changes valid for the life of the kernel thread. (The
default behavior is to affect only the affinity mask
for the running image.)
The secondary qualifiers can all be used at once as long as the
affinity bits defined in the /SET and /CLEAR parameters do not
overlap.
The privileges required to execute the SET PROCESS/AFFINITY
command match those required by the $PROCESS_AFFINITY system
service. ALTPRI is the base privilege required to make any
modifications, and the only privilege required to modify the
current owner's kernel thread. Modifications within the same UIC
group require GROUP privilege. Modifications to any unrelated
kernel thread require WORLD privilege.
As with the other SET PROCESS qualifiers, the bit operations
occur on the current process if no /IDENTIFICATION qualifier
or explicit process name parameter is specified. Specifying a
process name does not imply that all kernel threads associated
with the process are affected; the SET PROCESS command affects
only the initial kernel thread of a multithreaded process.
33.2.2 /AUTO_UNSHELVE
/AUTO_UNSHELVE
/NOAUTO_UNSHELVE
Controls whether the process automatically unshelves files.
Note that the /NOAUTO_UNSHELVE qualifier does not work across a
cluster. It can be issued only for a process on the same node,
including as the default case, the process from which the command
is issued.
33.2.3 /CAPABILITY
/CAPABILITY
/NOCAPABILITY
Allows bits in the process user capability mask to be set or
cleared individually, in groups, or all at once. This qualifier
is mutually exclusive with the /AFFINITY qualifier.
NOTE
The SET PROCESS/[NO]CAPABILITY command fails if there is no
CPU with the required set of capabilities.
The /NOCAPABILITY qualifier clears all user capability bits
currently set in the current or permanent capability masks,
based on the setting of the /PERMANENT qualifier. Specifying the
/CAPABILITY qualifier has no direct effect, but merely indicates
the target of the operations specified by the following secondary
qualifiers:
/SET=(n[,..Sets all user capabilities defined by the position
values n, where n has the range of 1 to 16.
/CLEAR=(n[,Clears all user capabilities defined by the position
values n, where n has the range of 1 to 16.
/PERMANENT Performs the operation on the permanent user capability
mask as well as the current user capability mask,
making the changes valid for the life of the kernel
thread. (The default behavior is to affect only the
capabilities mask for the running image.)
The secondary qualifiers can all be used at once as long as the
user capability bits defined in the /SET and /CLEAR parameters do
not overlap.
The privileges required to execute the SET PROCESS/CAPABILITY
command match those required by the $PROCESS_CAPABILITIES system
service. ALTPRI is the base privilege required to make any
modifications, and the only privilege required to modify the
current owner's kernel thread. Modifications within the same UIC
group require GROUP privilege. Modifications to any unrelated
kernel thread require WORLD privilege.
As with the other SET PROCESS qualifiers, the bit operations
occur on the current process if no /IDENTIFICATION qualifier
or explicit process name parameter is specified. Specifying a
process name does not imply that all kernel threads associated
with the process are affected; the SET PROCESS command affects
only the initial kernel thread of a multithreaded process.
33.2.4 /CASE_LOOKUP
/CASE_LOOKUP=keyword
The valid keywords for this qualifier are BLIND and SENSITIVE.
VSI strongly recommends that you use caution when enabling case
sensitivity in your processes.
See the Guide to OpenVMS File Applications for additional
information.
33.2.5 /CLEAR
/CLEAR=(n[,...])
Clears all user capabilities or CPU affinities defined by the
position values n specified by the /CAPABILITY or the /AFFINITY
qualifier.
33.2.6 /DUMP
/DUMP[=NOW] [/ID=pid] [process-name]
/NODUMP (default)
Causes the contents of the address space to be written to the
file named (image-name).DMP in the current default directory
(where the image name is the same as the file name) when an image
terminates because of an unhandled error. To specify a target
process, indicate either the process ID or the process name.
Using the NOW option (available on Alpha and Integrity server
systems only) causes the targeted process to dump as soon as
possible. This is especially useful for hung processes.
You can then analyze the dump with the ANALYZE/PROCESS_DUMP
utility, the Debugger, or the System Dump Analyzer (SDA).
33.2.7 /GLOBAL
Modifies the global cell SCH$GL_DEFAULT_PROCESS_CAP. This global
cell is used to initialize the user capability mask of processes
when they are started.
33.2.8 /IDENTIFICATION
/IDENTIFICATION=pid
Requires GROUP or WORLD privilege for processes other than your
own.
Specifies the process identification (PID) value of the kernel
thread for which characteristics are to be changed. The target
process must be on the same node as the process from which the
command is issued. The /IDENTIFICATION qualifier overrides the
process-name parameter.
The PID is assigned by the system when the process is created.
When you specify a PID, you can omit the leading zeros.
If you use the /IDENTIFICATION qualifier, the process-name
parameter is ignored.
NOTE
The /IDENTIFICATION qualifier allows the SET PROCESS command
to affect individual kernel thread PIDs; because each thread
is a separate runnable entity, this command treats them as
discrete entities in terms of affinities and capabilities.
33.2.9 /KERNEL_THREAD_LIMIT
/KERNEL_THREAD_LIMIT=n
Changes the limit of the number of kernel threads that can be
created in the process. If the value specified is higher than
the SYSGEN parameter MULTITHREAD, an error message is returned.
Specifying the value 0 makes the process use the system-wide
limit set by the MULTITHREAD parameter.
33.2.10 /NAME
/NAME=string
Changes the name of the current process to a string of 1 to 15
characters.
33.2.11 /PARSE_STYLE
/PARSE_STYLE=(keyword)
Allows a user to indicate how commands are to be parsed.
Setting a particular parse style tells DCL how it should handle
command syntax. User programs can also examine the state of this
setting if they need to use different parse rules.
The valid keywords for this qualifier are TRADITIONAL and
EXTENDED. These keywords are mutually exclusive and cannot be
negated.
If the /PARSE_STYLE qualifier is not specified, the default is
the TRADITIONAL format.
Keyword Explanation
TRADITIONAL Indicates that commands should be examined using the
(default) former (prior to Version 7.2) rules for DCL syntax.
EXTENDED Indicates that commands should be examined using a
(Alpha/Integrity syntax that allows ODS-5 file specifications.
servers
only)
The main differences for DCL when EXTENDED parse rules are in
effect are:
o Arguments to foreign commands are case preserved. You can get
the command string by calling LIB$GET_FOREIGN.
C/C++ programs that use the argc/argv mechanism will have
unquoted arguments in lowercase unless the C Run-Time
Library logical DECC$ARGV_PARSE_STYLE is set to ENABLE. When
DECC$ARGV_PARSE_STYLE is enabled, case is preserved in command
line arguments when the process is set up for extended DCL
parsing using /PARSE_STYLE=EXTENDED.
o Some characters that were previously treated as token
delimiters are no longer delimiters. The pound sign (#),
circumflex (^), and question mark (?) fall into this category.
o A circumflex (^) is an escape character, which can be used to
indicate that the next character in the command string is to
be treated as if it were quoted, thereby losing its syntactic
significance.
EXTENDED parsing also modifies DCL's rules for parsing a
parameter or qualifier that is defined as a file specification
in a command's definition:
o File specifications will not be in uppercase.
o Any number of commas (,) may be placed between directory
delimiters ([] and <>).
o Directory file ID's (DIDs) can be included in the file
specification.
o Any number of periods (.) or semi-colons (;) may be included
in the file specification.
See the VSI OpenVMS System Manager's Manual, Volume 1: Essentials
for more information.
33.2.12 /PERMANENT
Performs the operation on the permanent affinity or capability
mask as well as the current mask, making the changes valid for
the life of the kernel thread. (The default behavior is to affect
the current mask only for the running image.) The /PERMANENT
qualifier is only valid in conjunction with the /CAPABILITY or
the /AFFINITY qualifier.
33.2.13 /PRIORITY
/PRIORITY=n
Requires ALTPRI (alter priority) privilege to set the priority
higher than the base priority of the specified process.
Changes the priority for the specified kernel thread. If you do
not have the ALTPRI privilege, the value you specify is compared
to your current base priority, and the lower value is always
used.
33.2.14 /PRIVILEGES
/PRIVILEGES=(privilege[,...])
Requires SETPRV (set privilege) privilege as an authorized
privilege to enable any privilege you do not have in your
authorized privilege mask.
Enables the following process privileges:
ACNT ALLSPOOL ALTPRI AUDIT
BUGCHK BYPASS CMEXEC CMKRNL
DETACH DIAGNOSE DOWNGRADE EXQUOTA
GROUP GRPNAM GRPPRV IMPORT
LOG_IO MOUNT NETMBX OPER
PFNMAP PHY_IO PRMCEB PRMGBL
PRMMBX PSWAPM READALL SECURITY
SETPRV SHARE SHMEM SYSGBL
SYSLCK SYSNAM SYSPRV TMPMBX
UPGRADE VOLPRO WORLD
Use the SHOW PROCESS/PRIVILEGES command to determine what
authorized privileges are enabled currently.
33.2.15 /RAD
/RAD=HOME=n
Changes the home resource affinity domain (RAD) of a process.
This command only works on the current process.
RAD is supported on AlphaServer GS series systems and starting
from OpenVMS Version 8.4, support is extended to NUMA capable
Integrity servers.
33.2.16 /RESOURCE_WAIT
/RESOURCE_WAIT
/NORESOURCE_WAIT
Enables resource wait mode so that the process waits for
resources to become available. If you specify the /NORESOURCE_
WAIT qualifier, the process receives an error status code when
system dynamic memory is not available or when the process
exceeds one of the following resource quotas: direct I/O (DIOLM)
limit, buffered I/O (BIOLM) limit, buffered I/O byte (BYTLM)
count limit (buffer space), timer queue quota, mailbox buffer
quota, or pipe quota.
CAUTION
Disabling resource waiting should be performed with caution,
as doing so can have unexpected effects on constituent
sharable images and runtime libraries. See the $SETRWM
service in the VSI OpenVMS System Services Reference Manual
for additional information.
33.2.17 /RESUME
Allows a process suspended by a previous SET PROCESS/SUSPEND
command to resume operation. The /RESUME qualifier is equivalent
to the /NOSUSPEND qualifier.
33.2.18 /SCHEDULING_CLASS
/SCHEDULING_CLASS="class_name"
/NOSCHEDULING_CLASS
Adds a process to, or removes a process from, a scheduling class.
This command does not modify the permanent class scheduling
database file. Therefore, the effect of this command can be
viewed as temporary placement into, or removal from, a scheduling
class.
33.2.19 /SET
/SET=(n[,...])
Sets all user capabilities or CPU affinities defined by the
position values n specified by the /CAPABILITY or the /AFFINITY
qualifier.
33.2.20 /SSLOG
/SSLOG=(STATE={ON | OFF | UNLOAD} [,COUNT=n] [,FLAGS=[NO]ARG])
Valid on Alpha and Integrity server systems only.
Requires CMEXEC, CMKRNL, or SETPRV privilege to log argument
values. The SYSGEN parameter SYSSER_LOGGING must be enabled or
the command will fail.
Enables or disables system service logging, using a log file
(named SSLOG.DAT by default) to log data.
Keywords are as follows:
Keyword Explanation
COUNT=n Specifies how many P2-space buffers to log.
(Default: 2)
FLAGS=[NO]ARG Specifies whether service argument values are to
be logged. (Default: ARG) ARG requires CMEXEC,
CMKRNL, or SETPRV privilege.
STATE=state Turns system service logging on or off. Possible
states are:
ON Enables system service logging.
OFF Disables (turns off) system service
logging; logging can still be reenabled.
UNLOAD Stops logging and closes the log file,
which is named SSLOG.DAT by default.
When enabling SSLOG for a process, you can specify the number of
buffers to be used for logging. Buffers are allocated in P2 space
and are charged against the process's paging file quota. Each
buffer is 65,024(10) bytes or FE00(16) bytes. The buffer space
remains allocated and the quota is charged until the process is
deleted.
Between the time when SSLOG is first enabled and when the log
file is closed, logging can be stopped and resumed.
Before you delete the process, you should stop all logging and
close the log file. The log file does not close automatically.
To analyze the log file, use the DCL command ANALYZE/SSLOG, which
is described in online help and in the System Service Logging
chapter of the VSI OpenVMS System Analysis Tools Manual.
33.2.21 /SUSPEND
/SUSPEND[=SUPERVISOR]
/SUSPEND=KERNEL
/NOSUSPEND
Requires privileges as described in text.
Temporarily stops the process's activities. The process remains
suspended until another process resumes or deletes it. Use the
qualifiers /NOSUSPEND and /RESUME to resume a suspended process.
Specify either of the following keywords with the /SUSPEND
qualifier to produce different results:
Keyword Explanation
SUPERVISOR Specifies that the named process is to be suspended
(default) to allow the delivery of asynchronous system traps
(ASTs) at EXEC or KERNEL mode. Specifying this
keyword is optional.
KERNEL Specifies that the named process is to be suspended
such that no ASTs can be delivered. To specify the
KERNEL keyword, you must be in either KERNEL mode or
EXEC mode, or have CMKRNL (change mode to kernel) and
CMEXEC (change mode to executive) privilege enabled.
Note that this was the default behavior of the SET
PROCESS/SUSPEND command for versions of OpenVMS prior
to VMS Version 5.0.
Depending on the operation, the process from which you specify
the /SUSPEND qualifier requires privileges. You must have GROUP
privilege to suspend another process in the same group, unless
that process has the same user identification code (UIC). You
must have WORLD privilege to suspend any other process in the
system.
When you enter the SET PROCESS/SUSPEND=KERNEL/ID= command in a
cluster environment, the KERNEL keyword is ignored if the target
process and the current process reside on different cluster
nodes. As a result, process suspension is handled as if you had
specified the SUPERVISOR keyword (the default).
Note that you can specify SET PROCESS/SUSPEND=KERNEL
to override a previous SET PROCESS/SUSPEND=SUPERVISOR.
SET PROCESS/SUSPEND=SUPERVISOR does not, however, override SET
PROCESS/SUSPEND=KERNEL.
33.2.22 /SWAPPING
/SWAPPING (default)
/NOSWAPPING
Requires the PSWAPM (process swap) privilege to disable swapping
for your process.
Permits the process to be swapped. By default, a process that is
not currently executing can be removed from physical memory so
that other processes can execute. If you specify the /NOSWAPPING
qualifier, the process is not swapped out of the balance set when
it is in a wait state.
33.2.23 /SYMLINK
/SYMLINK=keyword
Controls the behavior of all directory wildcard searches performed
by the RMS $SEARCH service. DCL commands (such as COPY, SUBMIT,
SET FILE, and so on) internally resolve directory wildcard
arguments using the RMS $SEARCH service.
Keyword options are:
Keyword Explanation
NOWILDCARD Indicates that symlinks are not followed during
directory wildcard searches.
WILDCARD Indicates that symlinks are followed, that is,
target files are included during wildcard
searches.
NOELLIPSIS Indicates that symlinks are followed, that is,
target files are included for all wildcard
fields except for ellipsis.
ELLIPSIS Equivalent to WILDCARD (included for command
symmetry).
33.2.24 /TOKEN
/TOKEN=keyword
Changes the maximum size of tokens (elements) in a DCL command.
(A token is any element in a command line that is bounded by
spaces. For example, the command COPY X.TXT Y.TXT contains three
tokens.) The token size is determined by the setting of bit 1 in
the DCL_CTLFLAGS system parameter. By default, the bit is clear,
indicating that traditional tokens (255 bytes) are being used.
If the bit is set, extended tokens (4000 bytes) are used. The
corresponding keywords for /TOKEN are TRADITIONAL and EXTENDED.
You can use SHOW PROCESS/TOKEN to determine the current token
size setting.
33.2.25 /UNITS
/UNITS[=keyword]
Specifies whether the amount of disk space reported by certain
utilities is to be displayed in blocks or bytes. Keyword options
are:
Keyword Explanation
BLOCKS Displays disk space in blocks.
BYTES Displays disk space in bytes.
Blocks is the default until /UNITS is set to BYTES. If you
specify /UNITS with no keyword, disk space is reported in blocks.
Displays that are affected by changing the value of /UNITS
include output from certain forms of the following commands:
COPY, DELETE, DIRECTORY, PURGE, SHOW DEVICE, SHOW MEMORY, and
SHOW QUOTA. Note that input to these commands can be specified
only in blocks. The DIRECTORY, SHOW DEVICES, and SHOW MEMORY
commands have a qualifier that lets you override the default SET
PROCESS/UNITS setting for a single command.
33.3 – Examples
1.$ SET PROCESS/PRIVILEGE=EXQUOTA
The SET PROCESS command in this example assigns the current
process the privilege of exceeding quotas.
2.$ SET PROCESS/NORESOURCE_WAIT
The SET PROCESS command in this example disables resource wait
mode for the current process.
3.$ RUN/PROCESS_NAME=TESTER CALC
%RUN-S-PROC_ID, identification of created process is 0005002F
$ SET PROCESS/PRIORITY=10 TESTER
The RUN command in this example creates a subprocess and gives
it the name TESTER. Subsequently, the SET PROCESS/PRIORITY
command assigns the subprocess a priority of 10.
4.$ SHOW PROCESS/SUBPROCESS
19-APR-2001 15:17:28.41 User: DAVIS Process ID: 31900218
Node: OCALA Process name: "DAVIS"
Processes in this tree:
DAVIS *
DAVIS_1
DAVIS_2
$ SET PROCESS/SUSPEND DAVIS_1
$
The SET PROCESS/SUSPEND command in this example suspends the
process DAVIS_1 such that ASTs can be delivered to it. Because
no keyword was specified, the /SUSPEND=SUPERVISOR version is
assumed.
5.$ SHOW PROCESS/SUBPROCESS OCALA::TESTA
19-APR-2001 12:17:24.45 User: TESTA Process ID: 31400208
Node: OCALA Process name: "TESTA"
Processes in this tree:
TESTA *
TESTA_1
TESTA_2
$ SET PROCESS OCALA::TESTA_2 /SUSPEND=KERNEL
$
The SET PROCESS/SUSPEND=KERNEL command in this example suspends
the process TESTA_2 on node OCALA such that no ASTs can be
delivered to it.
6.$ SET PROCESS CPUSCHED/AFFINITY/SET=1/PERMANENT
$ SET PROCESS CPUSCHED/CAPABILITY/SET=8/PERMANENT
$ SHOW CPU/FULL
COBRA7, a DEC 4000 Model 620
Multiprocessing is ENABLED. Streamlined synchronization image loaded.
Minimum multiprocessing revision levels: CPU = 1
System Page Size = 8192
System Revision Code =
System Serial Number =
Default CPU Capabilities:
System: QUORUM RUN
Default Process Capabilities:
System: QUORUM RUN
PRIMARY CPU = 00
CPU 00 is in RUN state
Current Process: *** None ***
Serial Number: AY24870417
Revision: A200
VAX floating point operations supported.
IEEE floating point operations and data types supported.
Processor is Primary Eligible.
PALCODE: Revision Code = 5.48
PALcode Compatibility = 0
Maximum Shared Processors = 2
Memory Space: Physical address = 00000000 00000000
Length = 0
Scratch Space: Physical address = 00000000 00000000
Length = 0
Capabilities of this CPU:
System: PRIMARY QUORUM RUN
User bitmask: 00000040
Processes which can only execute on this CPU:
NETACP PID = 0000008E Reason: PRIMARY Capability
CPU 01 is in RUN state
Current Process: CPUSCHED PID = 00000095
Serial Number: AY24870406
Revision: A200
VAX floating point operations supported.
IEEE floating point operations and data types supported.
PALCODE: Revision Code = 5.48
PALcode Compatibility = 0
Maximum Shared Processors = 2
Memory Space: Physical address = 00000000 00000000
Length = 0
Scratch Space: Physical address = 00000000 00000000
Length = 0
Capabilities of this CPU:
System: QUORUM RUN
User bitmask: 00000080
Processes which can only execute on this CPU:
CPUSCHED PID = 00000095 Reason: Affinitized to this CPU
Reason: User capabilities - 00000080)
$ SET PROCESS/NOAFFINITY/PERMANENT
$ SET PROCESS/NOCAPABILITY/PERMANENT
$ SHOW CPU/FULL
COBRA7, a DEC 4000 Model 620
Multiprocessing is ENABLED. Streamlined synchronization image loaded.
Minimum multiprocessing revision levels: CPU = 1
System Page Size = 8192
System Revision Code =
System Serial Number =
Default CPU Capabilities:
System: QUORUM RUN
Default Process Capabilities:
System: QUORUM RUN
CPU 00 is in RUN state
Current Process: *** None ***
Serial Number: AY24870417
Revision: A200
VAX floating point operations supported.
IEEE floating point operations and data types supported.
Processor is Primary Eligible.
PALCODE: Revision Code = 5.48
PALcode Compatibility = 0
Maximum Shared Processors = 2
Memory Space: Physical address = 00000000 00000000
Length = 0
Scratch Space: Physical address = 00000000 00000000
Length = 0
Capabilities of this CPU:
System: PRIMARY QUORUM RUN
User bitmask: 00000040
Processes which can only execute on this CPU:
NETACP PID = 0000008E Reason: PRIMARY Capability
CPU 01 is in RUN state
Current Process: CPUSCHED PID = 00000095
Serial Number: AY24870406
Revision: A200
VAX floating point operations supported.
IEEE floating point operations and data types supported.
PALCODE: Revision Code = 5.48
PALcode Compatibility = 0
Maximum Shared Processors = 2
Memory Space: Physical address = 00000000 00000000
Length = 0
Scratch Space: Physical address = 00000000 00000000
Length = 0
Capabilities of this CPU:
System: QUORUM RUN
User bitmask: 00000080
Processes which can only execute on this CPU:
*** None ***
$ SET PROCESS/NOAFFINITY/PERMANENT
$ SET PROCESS/NOCAPABILITY/PERMANENT
$ SHOW CPU/FULL
System: EUROS, VSI rx2600 (900MHz/1.5MB)
SMP execlet = 3 : Enabled : Streamlined.
Config tree = Version 6
Primary CPU = 0
HWRPB CPUs = 2
Page Size = 8192
Revision Code =
Serial Number = US30464615
Default CPU Capabilities:
System: QUORUM RUN
Default Process Capabilities:
System: QUORUM RUN
CPU 0 State: RUN CPUDB: 8901C000 Handle: 00005D70
Owner: 000004C8 Current: 000004C8 Partition 0 (EUROS)
ChgCnt: 1 State: Present, Primary, Reassignable
Process: * None *
Capabilities:
System: PRIMARY QUORUM RUN RAD0
User: Usr2
Slot Context: 901EB000
CPU - State..........: RC, PA, PP, CV, PV, PMV, PL
Type...........: Itanium Major = 31, Minor = 0
Speed..........: 900 Mhz
LID............: 00000000
Variation......: IEEE FP, Primary Eligible
Serial Number..: 0001a968930a1a25
Revision.......:
Halt Request...: 0
Software Comp..: 7.0
PALCODE - Revision Code..: 1.1
Compatibility..: 0
Max Shared CPUs: 0
Bindings: * None *
Fastpath:
FGB0
PKA0
PEA0
EIA0
Features:
Autostart - Enabled.
Fastpath - Selection enabled as Preferred CPU.
CPU 1 State: RUN CPUDB: 89163480 Handle: 00005E80
Owner: 000004C8 Current: 000004C8 Partition 0 (EUROS)
ChgCnt: 1 State: Present, Reassignable
Process: TEST11 PID: 20201192
Capabilities:
System: QUORUM RUN RAD0
Slot Context: 901EC000
CPU - State..........: RC, PA, PP, CV, PV, PMV, PL
Type...........: Itanium Major = 31, Minor = 0
Speed..........: 900 Mhz
LID............: 01000000
Variation......: IEEE FP
Serial Number..: 000363b4b0c5c862
Revision.......:
Halt Request...: 0
Software Comp..: 7.0
PALCODE - Revision Code..: 1.1
Compatibility..: 0
Max Shared CPUs: 0
Bindings:
TEST11 PID = 20201192 Reason: Affinitized to this CPU
Fastpath:
FGA0
EWA0
PKB0
BG0
Features:
Autostart - Enabled.
Fastpath - Selection enabled as Preferred CPU.
$
In this example, CPU 1 has user capability 8 enabled (user mask
of process CPUSCHED, and CPU affinity is set to 1. Either of
these settings forces the initial kernel thread to run only on
CPU 1, as shown by the SHOW PROCESS command.
Then, the SET PROCESS/NOAFFINITY/NOCAPABILITY command clears
all CPU affinities and user capability requirements for the
initial kernel thread of process (CPUSCHED), and the binding to
CPU 1 disappears.
7.$ SET PROCESS/SSLOG=(STATE=ON,COUNT=4)
This command turns on system service logging with four P2 space
buffers, each having a size of FE00(16) bytes. If the process
has SETPRV, CMKRNL, or CMEXEC privilege, argument values are
logged.
8.$ SET PROCESS/SSLOG=(STATE=UNLOAD)
This command stops logging and closes the log file.
34 – PROMPT
Replaces the default DCL prompt ($ ) with the specified string.
Format
SET PROMPT[=string]
34.1 – Parameter
string
Specifies the new prompt string. The following rules apply:
o All valid ASCII characters can be used.
o No more than 64 characters are allowed.
o To include spaces or lowercase letters, enclose the string
in quotation marks (" "). Otherwise, letters are converted
automatically to uppercase; leading and trailing spaces are
removed.
If you do not specify the string parameter with the SET PROMPT
command, the default DCL prompt ($ ) is restored.
34.2 – Qualifier
34.2.1 /CARRIAGE_CONTROL
/CARRIAGE_CONTROL (default)
/NOCARRIAGE_CONTROL
Inserts carriage return and line feed characters before the
prompt string. Type the qualifier after the string parameter.
34.3 – Example
$ SET PROMPT ="What's next?"
What's next? SHOW TIME
19-APR-2001 14:08:58
The SET PROMPT command in this example replaces the DCL prompt
($ ) with the phrase "What's next?". When you see the prompt
on your screen, you can enter any DCL command. This example
uses the SHOW TIME command.
35 – PROTECTION
Select the /DEFAULT subtopic for details about SET
PROTECTION/DEFAULT.
NOTE
The SET PROTECTION and SET PROTECTION/DEVICE commands have
been replaced with the SET SECURITY /PROTECTION and SET
SECURITY /PROTECTION /CLASS=DEVICE commands.
35.1 /DEFAULT
Establishes the default protection for files created by the
current process.
Format
SET PROTECTION[=(code)]/DEFAULT
35.1.1 – Parameter
code
Specifies the category of protection to be assigned by default
to all files subsequently created by the current process.
To override this protection, you must specify an explicit
protection using either the SET SECURITY /PROTECTION command
or the /PROTECTION qualifier on the CREATE command. If you do not
specify a protection code, the current default remains unchanged.
The protection code is made up of the following components:
o Ownership category-system (S), owner (O), group (G), or
world (W). Each category can be abbreviated to its first
character.
o Access category-Read (R), write (W), execute (E), or delete
(D). The access category is assigned to each ownership
category. A null access specification means no access.
NOTE
Use the SET SECURITY/PROTECTION command to reset security
characteristics of the directory or file.
35.1.2 – Example
$ SET PROTECTION=(GROUP:RWED,WORLD:R)/DEFAULT
The SET PROTECTION/DEFAULT command in this example sets the
default protection to grant unlimited access to other users in
the same group and read (R) access to all users. The default
protections for system and owner are not changed.
36 – QUEUE
Changes the attributes of the specified queue.
Requires manage (M) access to the queue.
Format
SET QUEUE queue-name[:]
36.1 – Parameter
queue-name[:]
Specifies the name of an execution queue or a generic queue.
36.2 – Qualifiers
36.2.1 /BASE_PRIORITY
/BASE_PRIORITY=n
Specifies the base process priority at which jobs are initiated
from a batch execution queue. The base priority specifier can be
any decimal value from 0 to 15.
You also can specify this qualifier for an output execution
queue. In this context the /BASE_PRIORITY qualifier establishes
the base priority of the symbiont process when the symbiont
process is created.
36.2.2 /BLOCK_LIMIT
/BLOCK_LIMIT=([lowlim,]uplim)
/NOBLOCK_LIMIT
Limits the size of print jobs that can be processed on an output
execution queue. This qualifier allows you to reserve certain
printers for certain size jobs. You must specify at least one of
the parameters.
The lowlim parameter is a decimal number referring to the minimum
number of blocks that are accepted by the queue for a print job.
If a print job is submitted that contains fewer blocks than the
lowlim value, the job remains pending until the block limit for
the queue is changed. After the block limit for the queue is
decreased sufficiently, the job is processed.
The uplim parameter is a decimal number referring to the maximum
number of blocks that are accepted by the queue for a print job.
If a print job is submitted that exceeds this value, the job
remains pending until the block limit for the queue is changed.
After the block limit for the queue is increased sufficiently,
the job is processed.
If you specify only an upper limit for jobs, you can omit the
parentheses. For example, /BLOCK_LIMIT=1000 means that only
jobs with 1000 blocks or less are processed in the queue. To
specify only a lower job limit, you must use a null string ("")
to indicate the upper limit. For example, /BLOCK_LIMIT=(500,"")
means any job with 500 or more blocks is processed in the queue.
You can specify both a lower and upper limit. For example,
/BLOCK_LIMIT=(200,2000) means that jobs with less than 200 blocks
or more than 2000 blocks are not processed in the queue.
The /NOBLOCK_LIMIT qualifier cancels the previous block limit
setting for that queue.
36.2.3 /CHARACTERISTICS
/CHARACTERISTICS=(characteristic[,...])
/NOCHARACTERISTICS
Specifies one or more characteristics for processing jobs
on an execution queue. If a queue does not have all the
characteristics that have been specified for a job, the job
remains pending. If you specify only one characteristic, you can
omit the parentheses. Each time you specify the /CHARACTERISTICS
qualifier, all previously set characteristics are canceled. Only
the characteristics specified with the qualifier are established
for the queue.
Queue characteristics are installation specific. The
characteristic parameter can be either a value from 0 to
127 or a characteristic name that has been defined by the
DEFINE/CHARACTERISTIC command.
The /NOCHARACTERISTICS qualifier cancels any characteristics
settings previously established for that queue.
36.2.4 /CLOSE
Prevents jobs from being entered in the queue through PRINT
or SUBMIT commands or as a result of requeue operations. To
allow jobs to be entered, use the /OPEN qualifier. Whether a
queue accepts or rejects new job entries is independent of the
queue's state (such as paused, stopped, or stalled). When a queue
is marked closed, jobs executing continue to execute and jobs
pending in the queue continue to be candidates for execution.
36.2.5 /CPUDEFAULT
/CPUDEFAULT=time
Defines the default CPU time limit for jobs in a batch execution
queue. You can specify time as delta time, 0, INFINITE, or NONE.
You can specify up to 497 days of delta time.
If the queue does not have a defined CPUMAXIMUM time limit and
the value established in the user authorization file (UAF) has
a specified CPU time limit of NONE, either the value 0 or the
keyword INFINITE allows unlimited CPU time. If you specify NONE,
the CPU time value defaults to the value specified either in the
UAF or by the SUBMIT command (if included). CPU time values must
be greater than or equal to the number specified by the system
parameter PQL_MCPULM. The time cannot exceed the CPU time limit
set by the /CPUMAXIMUM qualifier. For information on specifying
delta time, see the OpenVMS User's Manual or the online help
topic Date.
36.2.6 /CPUMAXIMUM
/CPUMAXIMUM=time
Defines the maximum CPU time limit for all jobs in a batch
execution queue. You can specify time as delta time, 0, INFINITE,
or NONE. You can specify up to 497 days of delta time.
The /CPUMAXIMUM qualifier overrides the time limit specified
in the user authorization file (UAF) for any user submitting a
job to the queue. Either the value 0 or the keyword INFINITE
allows unlimited CPU time. If you specify NONE, the CPU time
value defaults to the value specified either in the UAF or by
the SUBMIT command (if included). CPU time values must be greater
than or equal to the number specified by the system parameter
PQL_MCPULM.
For information on specifying delta time, see the OpenVMS User's
Manual or the online help topic Date.
36.2.7 /DEFAULT
/DEFAULT=(option[,...])
/NODEFAULT
Establishes defaults for certain options of the PRINT command.
Defaults are specified by the list of options. If you specify
only one option, you can omit the parentheses. After you set an
option for the queue with the /DEFAULT qualifier, you do not have
to specify that option in your PRINT commands. If you do specify
these options in your PRINT command, the values specified with
the PRINT command override the values established for the queue
with the /DEFAULT qualifier. Possible options are as follows:
[NO]BURST[=keyword] Controls whether two file flag pages with
a burst bar between them are printed
preceding output. If you specify the
value ALL (default), these flag pages
are printed before each file in the job.
If you specify the value ONE, these flag
pages are printed once before the first
file in the job.
[NO]FEED Specifies whether a form feed is inserted
automatically at the end of a page.
[NO]FLAG[=keyword] Controls whether a file flag page is
printed preceding output. If you specify
the value ALL (default), a file flag page
is printed before each file in the job.
If you specify the value ONE, a file flag
page is printed once before the first file
in the job.
FORM=type Specifies the default form for an output
execution queue. If a job is submitted
without an explicit form definition, this
form is used to process the job. If no
form type is explicitly specified with
the FORM keyword, the system assigns the
form "DEFAULT" to the queue. See also
the description of the /FORM_MOUNTED
qualifier.
[NO]TRAILER[=keyword] Controls whether a file trailer page is
printed following output. If you specify
the value ALL (default), a trailer page
is printed with each file in the job. If
you specify the value ONE, a trailer page
is printed once with the last file in the
job.
When you specify the BURST option for a file, the [NO]FLAG option
does not add or subtract a flag page from the two flag pages that
are printed preceding the file.
For information on establishing mandatory queue attributes, see
the description of the /SEPARATE qualifier. For information on
specifying default queue attributes, see the VSI OpenVMS System
Manager's Manual.
36.2.8 /DESCRIPTION
/DESCRIPTION=string
/NODESCRIPTION
Specifies a string of up to 255 characters used to provide
operator-supplied information about the queue.
Enclose strings containing lowercase letters, blanks, or other
nonalphanumeric characters (including spaces) in quotation marks
(" ").
The /NODESCRIPTION qualifier removes any descriptive text that
may have been associated with the queue.
36.2.9 /DISABLE_SWAPPING
/DISABLE_SWAPPING
/NODISABLE_SWAPPING
Controls whether batch jobs executed from a queue can be swapped
in and out of memory.
36.2.10 /ENABLE_GENERIC
/ENABLE_GENERIC
/NOENABLE_GENERIC
Specifies whether files queued to a generic queue that does not
specify explicit queue names can be placed in this execution
queue for processing.
36.2.11 /FORM_MOUNTED
/FORM_MOUNTED=type
Specifies the mounted form for an output execution queue.
If no form type is explicitly specified, the system assigns the
form "DEFAULT" to the queue.
If the stock of the mounted form does not match the stock of the
default form, as indicated by the /DEFAULT=FORM qualifier, all
jobs submitted to this queue without an explicit form definition
enter a pending state and remain pending until the stock of
the queue's mounted form is identical to the stock of the form
associated with the job.
If a job is submitted with an explicit form and the stock of the
explicit form is not identical to the stock of the mounted form,
the job enters a pending state and remains pending until the
stock of the mounted form of the queue is identical to the stock
of the form associated with the job.
To specify the form type, use either a numeric value or a form
name that has been defined by the DEFINE/FORM command. Form
types are installation-specific. You cannot use the /FORM_MOUNTED
qualifier with the /GENERIC qualifier.
36.2.12 /JOB_LIMIT
/JOB_LIMIT=n
Indicates the number of batch jobs that can be executed
concurrently from the queue. Specify a number in the range 1
to 65535.
36.2.13 /NO_INITIAL_FF
/NO_INITIAL_FF
/NONO_INITIAL_FF (default)
Allows user to set or modify whether a form feed should be sent
to a printer device when a queue starts. To suppress the initial
form feed, set the queue with /NO_INITIAL_FF qualifier.
Setting the queue with /NONO_INITIAL_FF qualifier sends a form
feed to the output device before printing begins when the queue
restarts.
36.2.14 /OPEN
Allows jobs to be entered in the queue through PRINT or SUBMIT
commands or as the result of requeue operations. To prevent
jobs from being entered in the queue, use the /CLOSE qualifier.
Whether a queue accepts or rejects new job entries is independent
of the queue's state (such as paused, stopped, or stalled).
36.2.15 /OWNER_UIC
/OWNER_UIC=uic
Requires OPER (operator) privilege or control (C) access to the
queue.
Enables you to change the user identification code (UIC) of the
queue. Specify the UIC by using the standard format as described
in the VSI OpenVMS Guide to System Security.
36.2.16 /PROTECTION
/PROTECTION=(ownership[:access],...)
Requires OPER (operator) privilege to control access to the
queue.
Specifies the protection of the queue. The following rules apply:
o Specify the ownership parameter as system (S), owner (O),
group (G), or world (W).
o Specify the access parameter as read (R), submit (S), manage
(M), or delete (D). A null access specification means no
access.
If you include only one protection code, you can omit the
parentheses.
For more information on specifying protection codes, see the
VSI OpenVMS Guide to System Security. For more information on
controlling queue operations through UIC-based protection, see
the VSI OpenVMS System Manager's Manual.
36.2.17 /RAD
/RAD=n
/NORAD
Specifies the RAD number on which to run batch jobs assigned
to the queue. The RAD value is validated as a positive integer
between 0 and the value returned by the $GETSYI item code, SYI$_
RAD_MAX_RADS.
To eliminate the RAD value for a batch queue, use the /NORAD
qualifier.
Note that when you change the RAD value on a batch queue, the
jobs currently in the batch queue are not dynamically updated
with the new RAD value. Any executing jobs will complete
processing using the original RAD value. Jobs in the pending,
holding, or timed execution states will retain the old RAD value
on the job; however, when such a job becomes executable, the job
is updated with the new RAD value.
RAD is supported on AlphaServer GS series systems and starting
from OpenVMS Version 8.4, support is extended to NUMA capable
Integrity servers.
36.2.18 /RECORD_BLOCKING
/RECORD_BLOCKING
/NORECORD_BLOCKING
Determines whether the symbiont can concatenate (or block
together) output records for transmission to the output device.
If you specify the /NORECORD_BLOCKING qualifier, the symbiont
sends each formatted record in a separate I/O request to the
output device. For the standard OpenVMS system print symbiont,
record blocking can have a significant performance advantage over
single-record mode.
36.2.19 /RETAIN
/RETAIN[=option]
/NORETAIN
Holds jobs in the queue in a retained status after they have
executed. The /NORETAIN qualifier enables you to reset the queue
to the default. Possible options are as follows:
ALL Holds all jobs in the queue after execution (default).
ERROR Holds in the queue only jobs that complete
unsuccessfully.
36.2.20 /SCHEDULE
/SCHEDULE=[NO]SIZE
Specifies whether pending jobs in an output queue are
scheduled for printing based on the size of the job. When the
/SCHEDULE=SIZE qualifier is in effect, shorter jobs print before
longer ones. When the /SCHEDULE=NOSIZE qualifier is in effect,
jobs are printed in the order they were submitted, regardless of
size.
If you enter this command while there are pending jobs in any
queue, its effect on future jobs is unpredictable.
36.2.21 /SEPARATE
/SEPARATE=(option[,...])
/NOSEPARATE
Specifies the mandatory queue attributes or job separation
options for an output execution queue. Job separation options
cannot be overridden by the PRINT command.
The job separation options are as follows:
[NO]BURST Specifies whether two job flag pages with
a burst bar between them are printed at
the beginning of each job.
[NO]FLAG Specifies whether a job flag page is
printed at the beginning of each job.
[NO]RESET=(module[,...]Specifies one or more device control
library modules that contain the job reset
sequence for the queue. The specified
modules from the queue's device control
library (by default SYS$LIBRARY:SYSDEVCTL)
are used to reset the device each time
a job reset occurs. The RESET sequence
occurs after any file trailer and before
any job trailer; therefore, all job
separation pages are printed when the
device is in its RESET state.
[NO]TRAILER Specifies whether a job trailer page is
printed at the end of each job.
When you specify the /SEPARATE=BURST qualifier, the [NO]FLAG
separation option does not add or subtract a flag page from the
two flag pages that are printed preceding the job.
For information on establishing queue attributes that can be
overridden, see the description of the /DEFAULT qualifier.
For more information on specifying mandatory queue attributes,
see the VSI OpenVMS System Manager's Manual.
36.2.22 /WSDEFAULT
/WSDEFAULT=n
Defines for a batch job a working set default, the default number
of physical pages that the job can use.
The value set by this qualifier overrides the value defined in
the user authorization file (UAF) of any user submitting a job to
the queue.
Specify the value of n as a number of 512-byte pagelets on Alpha.
Note that the OpenVMS system rounds up this value to the nearest
CPU-specific page so that actual amount of physical memory
allowed may be larger than the specified amount on Alpha.
If you specify the value 0 or NONE, the working set default
value defaults to the value specified in the UAF or by the SUBMIT
command (if included).
36.2.23 /WSEXTENT
/WSEXTENT=n
Defines for the batch job a working set extent, the maximum
amount of physical memory that the job can use. The job uses
the maximum amount of physical memory only when the system has
excess free pages. The value set by this qualifier overrides the
value defined in the user authorization file (UAF) of any user
submitting a job to the queue.
Specify the value of n as a number of 512-byte pagelets on Alpha.
Note that the OpenVMS system rounds up this value to the nearest
CPU-specific page so that actual amount of physical memory
allowed may be larger than the specified amount on Alpha.
If you specify the value 0 or NONE, the working set extent value
defaults to the value specified in the UAF or by the SUBMIT
command (if included).
36.2.24 /WSQUOTA
/WSQUOTA=n
Defines for a batch job the working set quota, the amount of
physical memory that is available to the job. The value set
by this qualifier overrides the value defined in the user
authorization file (UAF) of any user submitting a job to the
queue.
Specify the value of n as a number of 512-byte pagelets on Alpha
systems. Note that the OpenVMS system rounds up this value to
the nearest CPU-specific page so that actual amount of physical
memory allowed may be larger than the specified amount on Alpha.
If you specify the value 0 or NONE, the working set quota value
defaults to the value specified in the UAF or by the SUBMIT
command (if included).
A working set default size and a working set quota (maximum size)
are included in each user record in the system user authorization
file (UAF). You can specify a working set default and a working
set quota for both individual jobs and for all jobs in a given
queue. The following table shows the action taken for different
combinations of specifications that involve working set size and
working set quota values.
Value
Specified Value
by Specified
the SUBMIT for the
Command? Queue? Action Taken
No No Use the UAF value.
No Yes Use the value for the queue.
Yes Yes Use the smaller of the two values.
Yes No Compare the specified value with
the UAF value; use the smaller.
36.3 – Examples
1.$ INITIALIZE/QUEUE/DEFAULT=BURST/FORM_MOUNTED=LETTER/START SYS$PRINT
.
.
.
$ STOP/QUEUE/NEXT SYS$PRINT
$ SET QUEUE/DEFAULT=BURST/FORM_MOUNTED=MEMO SYS$PRINT
In this example, the queue is initialized with the
INITIALIZE/QUEUE command. The queue has the following
attributes: two file flag pages preceding each file in the job
and the mounted form LETTER. Later the queue is stopped with
the STOP/QUEUE/NEXT command so that the current job finishes
processing before the queue stops. The SET QUEUE command
changes the mounted form to MEMO.
2.$ SET QUEUE/DEFAULT=FORM=LN01_PORTRAIT LN01_PRINT
In this example, the SET QUEUE command changes the default form
to LN01_PORTRAIT for the LN01_PRINT queue.
3.$ SET QUEUE/CLOSE SYS$BATCH
In this example, the batch queue SYS$BATCH is modified to
prevent jobs from being entered in this queue.
4.$ SET/QUEUE/RAD=0 BATCHQ1
$ SHOW QUEUE/FULL BATCHQ1
Batch queue BATCHQ1, idle, on QUEBID::
/BASE_PRIORITY=4 /JOB_LIMIT=3 /OWNER=[SYSTEM]
/PROTECTION=(S:M,O:D,G:R,W:S) /RAD=0
This example modifies the batch queue to run all assigned jobs
on RAD 0 of QUEBID. Any new jobs assigned to the queue will run
on RAD 0. Jobs already executing on the queue will continue to
completion executing on the previous RAD value.
5.$ SET/QUEUE/NORAD BATCHQ1
$ SHOW QUEUE/FULL BATCHQ1
Batch queue BATCHQ1, idle, on QUEBID::
/BASE_PRIORITY=4 /JOB_LIMIT=3 /OWNER=[SYSTEM]
/PROTECTION=(S:M,O:D,G:R,W:S)
This example eliminates the RAD value for a batch queue.
37 – RESTART_VALUE
Assigns a value to the global symbol BATCH$RESTART. This global
symbol defines the location at which a batch job is restarted
after its execution has been interrupted. The SET RESTART_VALUE
command is meaningful only in command procedures.
Format
SET RESTART_VALUE=string
37.1 – Parameter
string
Specifies a string of up to 255 characters, which specifies the
label at which the batch job should begin executing when it is
restarted.
37.2 – Example
$ IF $RESTART THEN GOTO 'BATCH$RESTART'
.
.
.
$ FIRSTPART:
$ SET RESTART_VALUE = FIRSTPART
$ RUN PART1
.
.
.
$ SECONDPART:
$ SET RESTART_VALUE = SECONDPART
$ RUN PART2
.
.
.
In this example, the first command states that, if $RESTART
is true, the procedure is to jump to the value contained in
BATCH$RESTART. ($RESTART is true only if the job has been
executed before, that is, the job is being rerun after a crash
or after having been requeued.)
The first SET RESTART_VALUE command assigns the label FIRSTPART
to be equal to the symbol BATCH$RESTART. The next line contains
the command to run PART1.EXE.
The second SET RESTART_VALUE command assigns the label
SECONDPART to be equal to the symbol BATCH$RESTART. The last
line shown contains the command to run PART2.EXE.
When the job is first submitted using the SUBMIT/RESTART
command, the value of $RESTART is FALSE, so the IF expression
is ignored. If the job is stopped during the run of PART1.EXE,
the value of BATCH$RESTART is FIRSTPART. When the job is
restarted, the value of $RESTART is TRUE; therefore, the IF
expression is processed and transfers control to the FIRSTPART
label in the procedure. PART1.EXE is rerun.
If the job is stopped during the run of PART2.EXE, the value
of BATCH$RESTART is SECONDPART. When the job is restarted,
the value of $RESTART is TRUE. In this instance, the IF-GOTO
command transfers control to the SECONDPART label in the
procedure so that PART2.EXE can be run. PART1.EXE is not rerun.
38 – RIGHTS_LIST
Allows users to modify the process or system rights list. You
must specify either the /DISABLE or the /ENABLE qualifier with
the SET RIGHTS_LIST command.
Format
SET RIGHTS_LIST id-name[,...]
38.1 – Parameter
id-name[,...]
Specifies identifiers to be added to or removed from the process
or system rights list. The id-name parameter is a string of 1 to
31 alphanumeric characters, underscores (_), and dollar signs
($); each name must contain at least one nonnumeric character.
38.2 – Qualifiers
38.2.1 /ATTRIBUTES
/ATTRIBUTES=(keyword[,...])
Specifies attributes to be associated with the identifiers.
Attributes may be added to new or existing identifiers. The
following are valid keywords:
DYNAMIC Allows unprivileged holders of the identifier to
remove and to restore the identifier from the
process rights list by using the DCL command SET
RIGHTS_LIST.
NOACCESS Makes any access rights of the identifier null and
void. If a user is granted an identifier with the No
Access attribute, that identifier has no effect on
the user's access rights to objects. This attribute
is a modifier for an identifier with the Resource or
Subsystem attribute.
RESOURCE Allows holders of an identifier to charge disk space
to the identifier. Used only for file objects.
SUBSYSTEM Allows holders of the identifier to create and
maintain protected subsystems by assigning the
Subsystem ACE to the application images in the
subsystem. Used only for file objects.
To remove an attribute from the identifier, add a NO prefix
to the attribute keyword. For example, to remove the Resource
attribute, specify /ATTRIBUTE=NORESOURCE.
The default uses the current processes in the rights database.
Use the command SHOW PROCESS/RIGHTS to see the attributes of the
current process.
38.2.2 /DISABLE
Removes the identifiers from the process or system rights list.
You cannot use the /DISABLE qualifier with the /ENABLE qualifier.
Note that removing more than ten identifiers in a single command
invocation requires CMKRNL privilege.
38.2.3 /ENABLE
Adds the identifiers to the process or system rights list. You
cannot use the /ENABLE qualifier with the /DISABLE qualifier.
Note that adding more than ten identifiers in a single command
invocation requires CMKRNL privilege.
38.2.4 /IDENTIFICATION
/IDENTIFICATION=pid
Specifies the process identification (PID) value of the process
whose rights list is to be modified. The PID is assigned by the
system when the process is created. When you specify a PID, you
can omit the leading zeros.
If you specify the /IDENTIFICATION qualifier, you cannot use the
/PROCESS qualifier. By default, if neither the /IDENTIFICATION
nor the /PROCESS qualifier is specified, the current process is
assumed. You cannot use the /IDENTIFICATION qualifier with the
/SYSTEM qualifier.
38.2.5 /PROCESS
/PROCESS[=process-name]
Specifies the name of the process whose rights list is to be
modified. The process name can contain from 1 to 15 alphanumeric
characters.
If you specify the /PROCESS qualifier, you cannot use the
/IDENTIFICATION qualifier. By default, if neither the /PROCESS
nor the /IDENTIFICATION qualifier is specified, the current
process is assumed.
You cannot use the /PROCESS qualifier with the /SYSTEM qualifier.
38.2.6 /SYSTEM
Specifies that the desired operation (addition or removal of
an identifier) be performed on the system rights list. You
cannot use the /SYSTEM qualifier with the /PROCESS or the
/IDENTIFICATION qualifier.
38.3 – Examples
1.$ SET RIGHTS_LIST/ENABLE/ATTRIBUTES=RESOURCE MARKETING
The SET RIGHTS_LIST command in this example adds the MARKETING
identifier to the process rights list of the current process.
Specifying the RESOURCE attribute allows holders of the
MARKETING identifier to charge resources to it.
2.$ SET RIGHTS_LIST/ENABLE/SYSTEM PHYSICS101
%SYSTEM-F-NOPRIV, insufficient privilege or object
protection violation
$ SET PROCESS/PRIVILEGES=(CMKRNL,SYSNAM)
$ SET RIGHTS_LIST/ENABLE/SYSTEM PHYSICS101
The SET RIGHTS_LIST command in this example adds the PHYSICS101
identifier to the system rights list. You must have both the
CMKRNL (change mode to kernel) and SYSNAM (system logical name)
privileges to modify the system rights list.
39 – RMS_DEFAULT
Defines default values for multiblock and multibuffer counts,
network transfer sizes, prolog level, extend quantity, and the
query lock option used by OpenVMS Record Management Services
(RMS) for file operations.
If you set the default value for either the multiblock count or
the multibuffer count at 0, RMS tries to use the process default
value or the system default value, in that order. If these are
set at 0, RMS uses a default value of 1. Defaults are set for
sequential, relative, or indexed file organizations on a process-
only basis, unless a systemwide basis is requested.
Format
SET RMS_DEFAULT
39.1 – Qualifiers
39.1.1 /BLOCK_COUNT
/BLOCK_COUNT=count
Specifies a default multiblock count (0 to 255) for record
I/O operations only, where count is the number of blocks to be
allocated for each I/O buffer.
For more information on multiblock count, see the description of
the RAB$B_MBC in the OpenVMS Record Management Services Reference
Manual.
39.1.2 /BUFFER_COUNT
/BUFFER_COUNT=count
Specifies a default multibuffer count (0 to 255) for local file
operations, where count is the number of buffers to be allocated.
If you use the /SYSTEM qualifier to extend the default value
systemwide, the maximum default value is 127.
When you use the /BUFFER_COUNT qualifier, you can use the /DISK,
/INDEXED, /MAGTAPE, /RELATIVE, /SEQUENTIAL, and /UNIT_RECORD
qualifiers to specify the types of file for which the default
is to be applied. If the /BUFFER_COUNT qualifier is specified
without any of these qualifiers, the /SEQUENTIAL qualifier is
assumed. If file type is not specified, the default is applied to
sequential files.
For more information on multibuffer count, see the description
of the RAB$B_MBF field in the OpenVMS Record Management Services
Reference Manual.
39.1.3 /CONTENTION_POLICY
/CONTENTION_POLICY=keyword [/SYSTEM]
Allows you to specify fairness under high contention conditions
for write-shared files at the process or system level. Note that
selecting this option may noticeably increase locking overhead.
This option is disabled by default.
In a mixed cluster environment with high contention for specific
buckets, it is possible for accesses to write-shared files on
nodes using read-mode global bucket locking to dominate access
to a bucket. Nodes without this support might be denied timely
access to the bucket.
Additionally, it is possible to observe comparable behavior on
all OpenVMS versions when dealing with accesses to write-shared
files without global buffers enabled. A similar fairness issue
between lock conversions and new lock requests may be observed in
which the new lock requests may remain ungranted for an extended
period of time. Use the /CONTENTION_POLICY qualifier to specify
fairness under high contention conditions.
The following table lists valid PROCESS keywords (/SYSTEM not
specified):
Keyword Description
NEVER Never use the higher overhead option to improve
fairness for any write-shared files accessed by
this process; minimal overhead.
SOMETIMES Use this option for fairer bucket access (but
higher overhead) to any write-shared files with
global buffers enabled accessed by this process.
ALWAYS Use this option for fairer bucket access (but
higher overhead) to all write-shared files
accessed by this process.
SYSTEM_ Use system setting. Note that this keyword is
DEFAULT disallowed with /SYSTEM.
(default)
The following table lists valid SYSTEM keywords (/SYSTEM also
specified):
Keyword Description
NEVER Never use the higher overhead option to improve
(default) fairness for any write-shared files accessed on
the system; minimal overhead.
SOMETIMES Use this option for fairer bucket access (but
higher overhead) to any write-shared files with
global buffers enabled accessed on the system.
ALWAYS Use this option for fairer bucket access (but
higher overhead) to all write-shared files
accessed on the system.
39.1.4 /DISK
Applies the specified defaults to disk file operations. Values
applied using the /SEQUENTIAL qualifier take precedence over
values applied using the /DISK qualifier.
39.1.5 /EXTEND_QUANTITY
/EXTEND_QUANTITY=n
Specifies the number of blocks n to extend a sequential file
where n can range from 0 to 65535. If you do not specify the
/EXTEND_QUANTITY qualifier, RMS calculates its own extend value.
The /EXTEND_QUANTITY qualifier value is used when the program
does not specify an extent quantity explicitly.
39.1.6 /INDEXED
Applies the multibuffer default to indexed file operations.
39.1.7 /MAGTAPE
Applies the multibuffer default to magnetic tape operations.
Values applied using the /SEQUENTIAL qualifier take precedence
over values applied using the /MAGTAPE qualifier.
39.1.8 /NETWORK_BLOCK_COUNT
/NETWORK_BLOCK_COUNT=count
Specifies a default block count (0 to 127) for network access to
remote files, where count is the number of blocks to be allocated
for each I/O buffer.
For remote file access, the buffer size is negotiated between
RMS and the remote system's file access listener (FAL) with the
smaller of the two sizes being selected.
Thus, the /NETWORK_BLOCK_COUNT value places an upper limit on
the network buffer size that is used. It also places an upper
limit on the largest record that may be transferred to or from
a remote file. The largest record must be less than or equal to
512*network_block_count. (The network_block_count is in block
units and the record is in byte units.)
If you omit the value or specify a value of 0, RMS uses the
systemwide block count value. If this value is also 0, RMS uses a
size of one block.
39.1.9 /PROLOG
/PROLOG=n
Specifies a default prolog level for indexed files where
acceptable values for n are 0, 2, or 3. If 0 (default) is
specified, RMS sets an appropriate prolog level.
39.1.10 /QUERY_LOCK
/QUERY_LOCK=keyword [/SYSTEM]
Enables or disables query locking at the process and system
levels.
The following table lists valid PROCESS keywords (/SYSTEM not
specified):
Keyword Description
DISABLE Disable query locking for the duration of any
file opens done by images within the process for
any read ($GET or $FIND) record operations that
have both RAB$V_NLK (no lock) and RAB$V_RRL (read-
regardless) set in the RAB$L_ROP field of the RAB
(Record Access Block). Disabling query locking
directs RMS not to make any calls to the lock
manager for a read record operation just to find
out whether a record is locked by another stream.
ENABLE Use RMS's default record locking for images run
within this process.
SYSTEM_ Use system setting. Note that this keyword is
DEFAULT disallowed with /SYSTEM.
(default)
The following table lists valid SYSTEM keywords (/SYSTEM also
specified):
Keyword Description
DISABLE Disable query locking for the duration of any
file opens done by images on the system for any
read ($GET or $FIND) record operations that have
both RAB$V_NLK (no lock) and RAB$V_RRL (read-
regardless) set in the RAB$L_ROP field of the RAB
(Record Access Block). Disabling query locking
directs RMS not to make any calls to the lock
manager for a read record operation just to find
out whether a record is locked by another stream.
ENABLE Use RMS's default record locking for images run
(default) within this process.
There is no system parameter associated with the QUERY_LOCK
setting.
39.1.11 /RELATIVE
Applies the multibuffer default to relative file operations.
39.1.12 /SEQUENTIAL
/SEQUENTIAL (default)
Applies the multibuffer default to sequential file operations.
The /SEQUENTIAL qualifier overrides values applied using either
the /DISK, the /MAGNETIC TAPE, or the /UNIT RECORD qualifier.
The /SEQUENTIAL qualifier is the default if you do not specify
either the /RELATIVE or the /INDEXED qualifier.
39.1.13 /SYSTEM
Requires CMKRNL (change mode to kernel) privilege.
Applies specified defaults on a systemwide basis to all file
operations.
Systemwide settings are implemented as system parameters, with
the exception of /QUERY_LOCK. For a systemwide setting to survive
a system reboot, it must be written to the system parameter file
by using SYSGEN.
39.1.14 /UNIT_RECORD
Applies the multibuffer default to file operations on unit record
devices. Values applied using the /SEQUENTIAL qualifier take
precedence over values applied using the /UNIT_RECORD qualifier.
39.2 – Examples
1.$ SET RMS_DEFAULT/BLOCK_COUNT=24
$ SHOW RMS_DEFAULT
MULTI- | MULTIBUFFER COUNTS | NETWORK
BLOCK | Indexed Relative Sequential | BLOCK
COUNT | Disk Magtape Unit Record | COUNT
Process 24 | 0 0 0 0 0 | 0
System 16 | 0 0 0 0 0 | 8
Prolog Extend Quantity QUERY_LOCK
Process 0 0 System
System 0 0 Enabled
CONTENTION_POLICY
Process System
System Never
The SET RMS_DEFAULT command in this example sets the multiblock
count for disk file I/O at 24 for user programs that do not set
the multiblock count explicitly. The command applies only to
the current process.
2.$ SET RMS_DEFAULT/BUFFER_COUNT=8/MAGTAPE
$ SHOW RMS_DEFAULT
MULTI- | MULTIBUFFER COUNTS | NETWORK
BLOCK | Indexed Relative Sequential | BLOCK
COUNT | Disk Magtape Unit Record | COUNT
Process 0 | 0 0 0 8 0 | 0
System 16 | 0 0 0 0 0 | 8
Prolog Extend Quantity QUERY_LOCK
Process 0 0 System
System 0 0 Enabled
CONTENTION_POLICY
Process System
System Never
The SET RMS_DEFAULT command in this example defines the default
multibuffer count for I/O magnetic tape operations at 8.
3.$ SET RMS_DEFAULT/BUFFER_COUNT=7/NETWORK_BLOCK_COUNT=16/SYSTEM
$ SHOW RMS_DEFAULT
MULTI- | MULTIBUFFER COUNTS | NETWORK
BLOCK | Indexed Relative Sequential | BLOCK
COUNT | Disk Magtape Unit Record | COUNT
Process 0 | 0 0 0 0 0 | 0
System 16 | 0 0 7 7 0 | 16
Prolog Extend Quantity QUERY_LOCK
Process 0 0 System
System 0 0 Enabled
CONTENTION_POLICY
Process System
System Never
The SET RMS_DEFAULT command in this example defines the
systemwide default multibuffer count at 7 for all sequential
file operations on disk, magnetic tape, and unit record
devices. The command also sets the network block count at 16.
4.$ SET RMS_DEFAULT/EXTEND=50/INDEXED/BUFFER_COUNT=5
$ SHOW RMS_DEFAULT
MULTI- | MULTIBUFFER COUNTS | NETWORK
BLOCK | Indexed Relative Sequential | BLOCK
COUNT | Disk Magtape Unit Record | COUNT
Process 0 | 5 0 0 0 0 | 0
System 16 | 0 0 0 0 0 | 8
Prolog Extend Quantity QUERY_LOCK
Process 0 50 System
System 0 0 Enabled
CONTENTION_POLICY
Process System
System Never
The SET RMS_DEFAULT command in this example sets the default
multibuffer count for I/O operations on indexed files at 5.
It also defines the default extend quantity for sequential
I/O operations at 50 blocks. These defaults apply only to disk
operations for user programs that do not set the multiblock
count explicitly. These defaults are limited to the current
process.
5.$ SET RMS_DEFAULT/QUERY_LOCK=DISABLE
$ SHOW RMS_DEFAULT
MULTI- | MULTIBUFFER COUNTS | NETWORK
BLOCK | Indexed Relative Sequential | BLOCK
COUNT | Disk Magtape Unit Record | COUNT
Process 0 | 0 0 0 0 0 | 0
System 16 | 0 0 0 0 0 | 8
Prolog Extend Quantity QUERY_LOCK
Process 0 0 Disabled
System 0 0 Enabled
CONTENTION_POLICY
Process System
System Never
The SET RMS_DEFAULT command in this example requests that query
locking be disabled for the duration of any file opens done by
images within this process for any read ($GET or $FIND) record
operations that have both RAB$V_NLK (no lock) and RAB$V_RRL
(read-regardless) set in the RAB$L_ROP field of the RAB (Record
Access Block).
40 – ROOT
Defines the POSIX root for the system.
Format
SET ROOT device-name:directory-spec
40.1 – Parameters
device-name:directory-spec
Defines the root pathname.
40.2 – Description
In POSIX pathname processing mode, RMS and the C Run-Time Library
treat the leading slash (/) of a pathname as referring to the
defined root. By default, the root is SYS$SYSDEVICE:[PSX$ROOT].
The root definition does not persist across a reboot. The SET
ROOT commands requires SYSNAM privilege and has the following
qualifier:
40.3 – Qualifier
40.3.1 /LOG
/LOG (default)
/NOLOG
Controls whether the SET ROOT command displays a success
indication after the root definition is set.
40.4 – Example
$ SHOW ROOT
DISK$ALPHASYS:[000000]
$ SET ROOT DISK$ALPHASYS:[PSX$ROOT]
%SET-I_SXROOSET, system POSIX root set to DISK$ALPHASYS:[PSX$ROOT]
$ SHOW ROOT
DISK$ALPHASYS:[PSX$ROOT]
$
The SHOW ROOT command in this example displays the current root
path. The SET ROOT command changes these defaults, and the next
SHOW ROOT command displays the new default root.
41 – SECURITY
Modifies the security profile of an object.
Format
SET SECURITY object-name
41.1 – Parameter
object-name
Specifies the name of an object, such as a file or device, whose
security profile is to be modified. An object is identified by an
object name and a class name. The default class name is FILE.
An object name of the FILE class (explicitly or implicitly
specified) can include an asterisk (*) or a percent sign (%)
wildcard character, but wildcard characters are not allowed
in any class other than FILE. SET SECURITY does not operate on
remote files and devices, alias directory entries, or directory
names in UIC format (for example, [14,5]).
The following table shows the qualifier categories for the SET
SECURITY command.
ACL- Security File-
General Modifying Class Specific Transfer
Qualifiers Qualifiers Qualifier Qualifiers Qualifiers
/ACL /AFTER /PROFILE /BACKUP /COPY_ATTRIBUTE
/CLASS /DELETE /BEFORE /LIKE
/LOG /EDIT /BY_OWNER
/OWNER /REPLACE /CONFIRM
/PROTECTION /CREATED
/DEFAULT
/EXCLUDE
/EXPIRED
/MODIFIED
/SINCE
/STYLE
41.2 – Qualifiers
41.2.1 /ACL
/ACL[=(ace[,...])]
Identifies one or more access control list entries (ACEs) to
add, replace, or delete. Enclose each ACE in parentheses and
separate multiple ACEs by commas (,). The most common type of
entry, the Identifier ACE, has the format (IDENTIFIER=identifier,
ACCESS=access-type(+...)). By default, SET SECURITY adds an ACE
to the top of the ACL. This behavior changes when you include one
of the positional qualifiers: /AFTER, /DELETE, or /REPLACE. See
the discussion of ACL ordering in the VSI OpenVMS Guide to System
Security.
41.2.2 /AFTER
/AFTER=ace
Positions all ACEs specified with the /ACL qualifier after the
ACE named with the /AFTER qualifier.
41.2.3 /BACKUP
Modifies the time value provided with the /BEFORE or the /SINCE
qualifier. The /BACKUP qualifier selects files according to the
date of their most recent backup (rather than by the creation,
expiration, or modification date). By default, SET SECURITY
selects files according to their creation date.
41.2.4 /BEFORE
/BEFORE[=time]
Selects only those files dated prior to the specified time.
You can specify time as absolute time, as a combination of
absolute and delta times, or as one of the following keywords:
BOOT, LOGIN, TODAY (default), TOMORROW, or YESTERDAY. Specify
the /CREATED or the /MODIFIED qualifier to indicate the time
attribute to be used as the basis for selection. The /CREATED
qualifier is the default.
For complete information on specifying time values, see the
OpenVMS User's Manual or the online help topic Date.
41.2.5 /BY_OWNER
/BY_OWNER[=uic]
Selects files whose owner's UIC matches the UIC specified. The
default UIC is that of the current process.
41.2.6 /CLASS
/CLASS=class-name
Specifies the class of the object whose profile is to be
modified. By default, the command assumes the object class is
FILE.
41.2.7 /CONFIRM
Controls whether SET SECURITY prompts for verification before
performing the operation. Valid responses are YES, NO, TRUE, and
FALSE. Answers are not case sensitive and can be abbreviated to
one letter. To stop processing the command at any point, type
QUIT or press Ctrl/Z. To cancel the verification procedure but to
proceed with the command, type ALL.
41.2.8 /COPY_ATTRIBUTE
/COPY_ATTRIBUTE=(keyword[,...])
Specifies a subset of security elements to transfer from a source
object to a target object. Valid keywords include the following:
Keyword Description
ALL Copy all security elements
(default)
ACL Copy the access control list
OWNER Copy the owner
PROTECTION Copy the protection code
Use the /COPY_ATTRIBUTE qualifier with the /LIKE qualifier. For
example, you can create an ACL for an object and then copy its
ACL to new objects.
41.2.9 /CREATED
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /CREATED qualifier selects files according to the
date they were created (rather than by the backup, expiration,
or modification date). By default, SET SECURITY selects files
according to their creation date.
41.2.10 /DELETE
/DELETE[=ALL]
Deletes ACEs according to the following rules:
o The expression /ACL=aces/DELETE deletes the named ACEs.
o The expression /ACL/DELETE deletes all unprotected ACEs.
o The expression /ACL/DELETE=ALL deletes all ACEs including
protected ACEs.
o The expression /ACL=aces/DELETE=ALL deletes the existing ACL
(if any) and create a new ACL with the ACEs specifies on the
/ACL qualifier.
41.2.11 /DEFAULT
Regenerates the security profile of a file. The default qualifier
changes the protection code, the ACL, and the owner elements of a
file to what it would be if the file had just been created. The
profile is recreated according to the following rules:
o The protection code is propagated from the default protection
ACE on the directory (if one exists), or else it is propagated
from the process default.
o The ACL is propagated from the parent directory for those ACEs
that have the default option.
o The owner is set to the owner of the parent directory.
With subdirectory files, SET SECURITY assigns the owner,
protection, and ACL elements of the parent directory.
SET SECURITY does not copy any ACE on the source object if the
ACE holds the nopropagate attribute nor does it change any ACE
on the target object if the ACE holds the protected attribute. To
apply new elements to all versions of the file, specify ;* in the
object name. See the VSI OpenVMS Guide to System Security for more
information on propagation rules.
41.2.12 /EDIT
Invokes the access control list editor (ACL editor) and allows
you to modify an ACL interactively. The ACL editor does not allow
the asterisk (*) and the percent sign (%) wildcard characters
in an object name. You must specify the object whose ACL you are
editing.
The /EDIT qualifier must be the first qualifier on the command
line; other qualifiers can include /CLASS and, if the class is
SECURITY_CLASS, you can include the /PROFILE qualifier. Whenever
an object does not belong to the FILE class, you also need to
specify /CLASS.
See the ACL editor in the VSI OpenVMS System Management Utilities
Reference Manual for more information.
41.2.13 /EXCLUDE
/EXCLUDE=(filespec[,...])
Excludes the specified files from the SET SECURITY operation.
You can include a directory, but not a device, in the file
specification. You cannot use relative version numbers to exclude
a specific version.
41.2.14 /EXPIRED
Modifies the time specified with the /BEFORE or the /SINCE
qualifier. The /EXPIRED qualifier selects files according to
their expiration dates rather than by the backup, creation,
or modification date. (The expiration date is set with the SET
FILE/EXPIRATION_DATE command.) By default, files are selected
according to their creation date.
41.2.15 /LIKE
/LIKE=(NAME=source-object-name
[,CLASS=source-object-class] [,PROFILE=TEMPLATE=template-name])
Identifies the object from which SET SECURITY should copy
security elements. The /LIKE qualifier replaces an object's
existing elements with those of the source object. Nopropagate
ACEs are not transferred and protected ACEs on the target object
are not deleted. Use the /COPY_ATTRIBUTE qualifier with the /LIKE
qualifier to copy an object's elements. See the VSI OpenVMS Guide
to System Security for information about the special handling of
protected and nopropagate ACEs.
The object class of the source object defaults to the class of
the target object. When the /CLASS qualifier is omitted, the
CLASS keyword defaults to FILE.
The PROFILE keyword applies to security class objects. It
identifies which template of the security class you want to copy
and modify. See /PROFILE for more information.
41.2.16 /LOG
Controls whether the SET SECURITY command displays the name of
the object that has been modified by the command. The qualifier
is invalid with the /EDIT qualifier.
41.2.17 /MODIFIED
Modifies the time value specified with the /BEFORE or the /SINCE
qualifier. The /MODIFIED qualifier selects files according to
the dates on which they were last modified, rather than by the
backup, creation, or expiration date. By default, files are
selected according to their creation date.
41.2.18 /OWNER
/OWNER=identifier
Requires GRPPRV (group privilege) to set the owner to another
member of the same group. Requires SYSPRV (system privilege) to
set the owner to any user identification code (UIC) outside your
group.
Modifies the owner element of an object. Specify the user
identification code (UIC) or general identifier in the standard
format. Modifying the owner element of a file usually requires
privileges. See the VSI OpenVMS Guide to System Security for more
information.
41.2.19 /PROFILE
/PROFILE=TEMPLATE[=template-name]
Identifies which template profile of a security class object
you want to modify. All object classes except FILE have at
least one template profile. These template profiles define the
basis of the profile of new objects. Use the DCL command SHOW
SECURITY/CLASS=SECURITY_CLASS to display template names. When no
value is given for template-name, SET SECURITY uses the template
named DEFAULT.
Include the /CLASS=SECURITY_CLASS qualifier to identify which
profile you want to modify.
41.2.20 /PROTECTION
/PROTECTION=(ownership[:access][,...])
Cannot be used to change the protection on a file by using DECnet
software.
Modifies the protection code of an object. The protection code
defines the type of access allowed to users, based on their
relationship to the object's owner.
Specify the ownership parameter as system (S), owner (O), group
(G), or world (W).
Access types are class specific and are shown in the following
table. For access, use the first letter of the access name.
Object Class Access Types
CAPABILITY (VAX Use, Control
only)
COMMON_EVENT_FLAG_ Associate, Delete, Control
CLUSTER
DEVICE Read, Write, Physical, Logical, Control
FILE (including Read, Write, Execute, Delete, Control
directory file)
GROUP_GLOBAL_ Read, Write, Execute, Control
SECTION
LOGICAL_NAME_TABLE Read, Write, Create, Delete, Control
QUEUE Read, Submit, Manage, Delete, Control
RESOURCE_DOMAIN Read, Write, Lock, Control
SECURITY_CLASS Read, Write, Control, Logical I/O,
Physical I/O
SYSTEM_GLOBAL_ Read, Write, Execute, Control
SECTION
VOLUME Read, Write, Create, Delete, Control
41.2.21 /REPLACE
/REPLACE=(ace[,...])
Eliminates entries listed with the /ACL qualifier and adds
entries listed with the /REPLACE qualifier. SET SECURITY inserts
the entries listed with /REPLACE in the position of the last
deleted ACE.
41.2.22 /SECRECY
Reserved for use by VSI.
41.2.23 /SINCE
/SINCE[=time]
Selects only those files dated on or after the specified time.
You can specify time as absolute time, as a combination of
absolute and delta times, or as one of the following keywords:
BOOT, JOB_LOGIN, LOGIN, TODAY (default), TOMORROW, or YESTERDAY.
Specify the /CREATED or the /MODIFIED qualifier to indicate
the time attribute to be used as the basis for selection. The
/CREATED qualifier is the default.
For complete information on specifying time values, see the
OpenVMS User's Manual or the online help topic Date.
41.2.24 /STYLE
/STYLE=keyword
Specifies the file name format for display purposes.
The valid keywords for this qualifier are CONDENSED and EXPANDED.
Descriptions are as follows:
Keyword Explanation
CONDENSED Displays the file name representation of what is
(default) generated to fit into a 255-length character string.
This file name may contain a DID or FID abbreviation
in the file specification.
EXPANDED Displays the file name representation of what is
stored on disk. This file name does not contain any
DID or FID abbreviations.
The keywords CONDENSED and EXPANDED are mutually exclusive. This
qualifier specifies which file name format is displayed in the
output message, along with the confirmation if requested.
File errors are displayed with the CONDENSED file specification
unless the EXPANDED keyword is specified.
See the VSI OpenVMS System Manager's Manual, Volume 1: Essentials
for more information.
41.2.25 /SYMLINK
/SYMLINK=keyword
The valid keywords for this qualifier are [NO]WILDCARD and
[NO]ELLIPSIS. Descriptions are as follows:
Keyword Explanation
WILDCARD Indicates that symlinks are enabled during wildcard
searches.
NOWILDCARD Indicates that symlinks are disabled during directory
wildcard searches.
ELLIPSIS Equivalent to WILDCARD (included for command
symmetry).
NOELLIPSIS Indicates that symlinks are matched for all wildcard
fields except for ellipsis.
If the file named in the SET SECURITY command is a symlink, the
command operates on the symlink itself.
41.3 – Examples
1.$ SHOW SECURITY LNM$GROUP /CLASS=LOGICAL_NAME_TABLE
LNM$GROUP object of class LOGICAL_NAME_TABLE
Owner: [SYSTEM]
Protection: (System: RWCD, Owner: R, Group: R, World: R)
Access Control List:
(IDENTIFIER=[USER,VARANESE],ACCESS=CONTROL)
$ SET SECURITY LNM$GROUP /CLASS=LOGICAL_NAME_TABLE -
_$ /ACL=((IDENTIFIER=CHEKOV,ACCESS=CONTROL), -
_$ (IDENTIFIER=WU,ACCESS=READ+WRITE)) -
_$ /DELETE=ALL -
_$ /PROTECTION=(S:RWCD, O:RWCD, G:R, W:R)
$ SHOW SECURITY LNM$GROUP /CLASS=LOGICAL_NAME_TABLE
LNM$GROUP object of class LOGICAL_NAME_TABLE
Owner: [SYSTEM]
Protection: (System: RWCD, Owner: RWCD, Group: R, World: R)
Access Control List:
(IDENTIFIER=[USER,CHEKOV],ACCESS=CONTROL)
(IDENTIFIER=[USER,WU],ACCESS=READ+WRITE)
This example shows how to make a straightforward change to the
security elements of an object. The first SHOW SECURITY command
displays the current settings of the LNM$GROUP logical name
table. The SET SECURITY command resets the ACL to allow control
access for user Chekov, and to allow read and write access
for user Wu. Note that without the /DELETE=ALL qualifier,
these ACEs would have been added to the existing ACL rather
than superseding it. The protection is also changed to allow
read, write, create, and delete access for the owner. The last
command displays the results of the changes.
2.$ SHOW SECURITY LNM$GROUP /CLASS=LOGICAL_NAME_TABLE
LNM$GROUP object of class LOGICAL_NAME_TABLE
Owner: [SYSTEM]
Protection: (System: RWCD, Owner: R, Group: R, World: R)
Access Control List:
(IDENTIFIER=[USER,FERNANDEZ],ACCESS=CONTROL)
$ SHOW SECURITY LNM$JOB /CLASS=LOGICAL_NAME_TABLE
LNM$JOB object of class LOGICAL_NAME_TABLE
Owner: [USER,WEISS]
Protection: (System: RWCD, Owner: RWCD, Group, World)
Access Control List: <empty>
$ SET SECURITY LNM$JOB /CLASS=LOGICAL_NAME_TABLE -
_$ /LIKE=(NAME=LNM$GROUP, CLASS=LOGICAL_NAME_TABLE) -
_$ /COPY_ATTRIBUTES=PROTECTION
$ SET SECURITY LNM$JOB /CLASS=LOGICAL_NAME_TABLE -
_$ /ACL=(IDENTIFIER=FERNANDEZ, ACCESS=READ)
$ SHOW SECURITY LNM$JOB /CLASS=LOGICAL_NAME_TABLE
LNM$JOB object of class LOGICAL_NAME_TABLE
Owner: [USER,WEISS]
Protection: (System: RWCD, Owner: R, Group: R, World: R)
Access Control List:
(IDENTIFIER=[USER,FERNANDEZ],ACCESS=READ)
This example shows how to copy security access information
from one object to another and, at the same time, set some
elements explicitly. The first SHOW SECURITY commands display
the current settings for the LNM$GROUP and LNM$JOB logical name
tables. The SET SECURITY command copies the protection code
from the LNM$GROUP logical name table to the LNM$JOB logical
name table and adds an ACE to allow read access to another
user. The final SHOW SECURITY command shows the effect of the
changes.
3.$ SHOW SECURITY SECURITY_CLASS /CLASS=SECURITY_CLASS
SECURITY_CLASS object of class SECURITY_CLASS
Owner: [SYSTEM]
Protection: (System: RWED, Owner: RWED, Group: R, World: R)
Access Control List: <empty>
Template: DEFAULT
Owner: [SYSTEM]
Protection: (System: RWED, Owner: RWED, Group, World: RE)
Access Control List: <empty>
$ SET SECURITY SECURITY_CLASS /CLASS=SECURITY_CLASS -
_$ /PROFILE=TEMPLATE=DEFAULT -
_$ /PROTECTION=(S:RWE, O:RWE, G:RE)
$ SHOW SECURITY SECURITY_CLASS /CLASS=SECURITY_CLASS
SECURITY_CLASS object of class SECURITY_CLASS
Owner: [SYSTEM]
Protection: (System: RWED, Owner: RWED, Group: R, World: R)
Access Control List: <empty>
Template: DEFAULT
Owner: [SYSTEM]
Protection: (System: RWE, Owner: RWE, Group: RE, World: RE)
Access Control List: <empty>
This example demonstrates how to change the security elements
for the template of a security class object. The first command
shows the current settings for the SECURITY_CLASS object. The
second command changes the DEFAULT template of the SECURITY_
CLASS object such that the protection is (S:RWE, O:RWE, G:RE).
The change is shown in the display of the last command. The
world protection of RE remains unchanged.
4.$ DIRECTORY/SECURITY
Directory DKA200:[DATA]
FILE001.DAT;1 [SYSTEM] (RWED,RWED,RE,)
Total of 1 file.
$ SET SECURITY/CLASS=FILE/PROTECTION=(WORLD:RE)/LOG FILE001.DAT
%SET-I-MODIFIED, DKA200:[DATA]FILE001.DAT;1 modified
$ DIRECTORY/SECURITY
Directory DKA200:[DATA]
FILE001.DAT;1 [SYSTEM] (RWED,RWED,RE,RE)
Total of 1 file.
$
This example shows how to set UIC-based protection codes on
an object. The first DIRECTORY command displays the current
security settings on the file FILE001.DAT. The SET SECURITY
command changes the protection codes on the file to allow read
and execute access for all users. The last command displays the
results of the change.
42 – SERVER
42.1 – ACME_SERVER
Valid for Alpha and Integrity server systems only.
Controls the ACME server.
Requires SYSPRV privilege.
Format
SET SERVER ACME_SERVER
42.1.1 – Qualifiers
42.1.1.1 /ABORT
Forces the ACME_SERVER process to terminate without graceful
shutdown of ACME agents. Pending requests are cancelled.
This command can be used if a malfunctioning ACME agent prevents
a graceful shutdown.
42.1.1.2 /CANCEL
Cancels pending dialogue requests. Pending dialogue requests
are outstanding requests to SYS$ACM callers to supply dialogue
response data. Active requests being serviced by the ACME_SERVER
process are allowed to complete normally.
Can be used only if the /EXIT or /DISABLE qualifier is also
specified.
42.1.1.3 /CLUSTER
Issues the SET command to each ACME server in the cluster.
42.1.1.4 /CONFIGURE
/CONFIGURE=(NAME=name [,CREDENTIALS=credentials]
[,FACILITY=facility] [,FILE=file] [,THREAD_MAX=n][,...])
Dynamically loads an ACME agent. An ACME agent is a shareable
image that conforms to the ACME agent plug-in interface
specification.
By default, the ACME server looks for an ACME agent file named
prefix$name_ACMESHR.EXE, where the prefix is VMS by default
and name is the case-insensitive string specified by the NAME
keyword. The prefix can be overridden by the FACILITY keyword.
Otherwise, a complete file specification can be specified with
the FILE keyword.
You must specify the CREDENTIALS keyword if the ACME agent is a
domain of interpretation (DOI) agent capable of authenticating
users and issuing credentials. The CREDENTIALS keyword specifies
the name of the persona extension associated with the ACME
agent (see the $PERSONA_EXTENSION_LOOKUP system service). The
credentials name must match the name registered by the executive
loadable image that implements the persona extension. For
credentials other than "VMS", see the documentation provided
for the ACME agent and the specific persona extension.
A maximum of eight ACME agents can be configured.
THREAD_MAX Keyword: Usage Considerations
An ACME server worker thread is the authentication request
processing thread of execution. The number of worker threads
determines the number of authentication requests the ACME server
can process simultaneously.
The ACME server assigns a request slot to each in-progress
authentication request. The total number of request slots sets
a limit on the maximum number of requests the ACME server can
have outstanding.
The ACME server limits the number of unprivileged authentication
requests it can accept for processing to half the total number of
request slots.
If a process makes a call to $ACM and no request slots are
available, the process remains in resource wait state until a
request slot becomes free.
The number of ACME server worker threads can range from 1 to 32.
The default of 4 satisfies most operating environments in which
authentication processing time is largely spent waiting for I/O.
You may, however, be able to improve throughput by increasing the
number of worker threads if, for example, you have a user-written
ACME agent that requires more CPU time than most.
You can set the maximum number of ACME server worker threads
before you start or restart the server by defining the inner-mode
logical name ACME$THREAD_MAXIMUM in the system-wide logical name
table. For example:
$ DEFINE/SYSTEM/EXECUTIVE_MODE ACME$THREAD_MAXIMUM 8
You can also use the CONFIGURE qualifier to set the maximum
number of server worker threads before you enable the ACME
server. For example:
$ SET SERVER ACME /CONFIGURE=THREAD_MAX=6
The CONFIGURE qualifier overrides the value of the ACME$THREAD_
MAXIMUM logical, if it is defined.
Because most authentication processing is I/O bound, defining
more threads than about one quarter the number of request slots
does not gain more throughput.
The ACME server calculates a default number of request slots
from the value of MAXPROCESSCNT and the number of available CPUs.
You can override the calculated value by defining the inner-mode
logical name ACME$REQUEST_MAXIMUM in the system-wide name table
before you start or restart the ACME server. For example:
$ DEFINE /SYSTEM /EXECUTIVE_MODE ACME$REQUEST_MAXIMUM 64
$ SET SERVER ACME /RESTART
42.1.1.5 /DISABLE
Disables (shuts down) all ACME agents. Additional ACME agents can
be configured.
42.1.1.6 /ENABLE
/ENABLE[=NAME=(name[,...])]
Enables one or more ACME agents in the specified order. Ordering
of ACME agents is significant, as the ACME_SERVER processes user
authentication requests in the order specified. The name variable
is a case-insensitive string argument.
If you do not specify the NAME keyword, the same list of
ACME agents will be enabled that were enabled by a previous
/ENABLE command. If no previous /ENABLE command was issued, all
configured ACME agents are enabled.
42.1.1.7 /EXIT
Requests a graceful shutdown of the ACME agents. The ACME_SERVER
process will be shut down after pending requests are completed.
42.1.1.8 /LOG
/LOG
/NOLOG (default)
Creates and opens a new log file. The log file is named
SYS$MANAGER:ACME$SERVER.LOG. It may be redirected by defining
the system logical name ACME$SERVER.
42.1.1.9 /NODE
/NODE=(node-name[,...])
Issues the SET command to the ACME server on the specified nodes
in the order they are entered. The node names must be located
within the current cluster.
42.1.1.10 /RESTART
Requests a graceful shutdown of the ACME agents. The ACME_SERVER
process will be shut down after pending requests are completed.
The ACME_SERVER is restarted and the SYS$MANAGER:ACME$START.COM
startup procedure runs.
42.1.1.11 /RESUME
Resumes normal operation following use of the /SUSPEND qualifier.
42.1.1.12 /START
/START[=AUTO]
/START cannot be used with the /ABORT, /EXIT, or /RESTART
qualifiers.
Starts the server process.
The optional keyword, AUTO, causes the server to startup and
configure itself using the SYS$MANAGER:ACME$START.COM procedure.
By default, the server starts with only the OpenVMS ACME agent
configured. The following options are available:
To change the default privileges:
/PRIVILEGES=(privilege[,...])
To change the default UIC:
/UIC=uic
To change the default quotas:
/AST_LIMIT=n
/BUFFER_LIMIT=n
/ENQUEUE_LIMIT=n
/EXTENT=n
/FILE_LIMIT=n
/IO_BUFFERED=n
/IO_DIRECT=n
/JOB_TABLE_QUOTA=n
/MAXIMUM_WORKING_SET=n
/PAGE_FILE=n
/QUEUE_LIMIT=n
/SUBPROCESS_LIMIT=n
/WORKING_SET=n
You can use the following alternate syntax to specify a list of
quotas and their values:
/QUOTAS=(quota=n[,...])
quota is a PQL-style quota name (for example: ASTLM, BIOLM)
See the $CREPRC system service in the VSI OpenVMS System Services
Reference Manual for a list of PQL-style quota names and
descriptions.
To change the image dump setting:
/DUMP (default)
/NODUMP
Forces a process dump in the event of an abnormal process
termination. The dump is written to SYS$MANAGER: using the image
filename and .DMP extension.
42.1.1.13 /SUSPEND
Suspends operation after all pending requests are completed.
ACME agents are returned to their initial state (open files are
closed, for example). This permits system management functions,
such as system backups, to be performed without file-open
conflicts.
See also the /RESUME qualifier.
42.1.1.14 /TRACE
/TRACE=n
/NOTRACE
Enables trace mode in the ACME$SERVER log file. Opens the log
file if not already opened.
n is a bit-mask with the following assigned bits:
0 agent Enable agent tracing
1 general General (non-specific) tracing
2 vm VM operations
3 ast AST processing
4 wqe WQE parameter values
5 report Agent status/attributes operations
6 message Messaging operations
7 dialogue Dialogue operations
8 resource Agent resource operations
9 callout Agent callout routine
10 callout_status Agent callout return status
If you specify /NOTRACE, trace mode is disabled and the log file
remains open.
42.1.1.15 /WAIT
/WAIT
/NOWAIT (default)
Returns to caller once the server returns a status other than
ACME$_BUSY.
Can only be used with /EXIT, /DISABLE, and /SUSPEND qualifiers.
42.1.2 – Examples
1.$ SET SERVER ACME_SERVER/START/LOG
This command starts the ACME server and creates and opens a new
log file.
2.$ SET SERVER ACME_SERVER/DISABLE/WAIT/CANCEL
This command disables all configured ACME agents, cancelling
all requests in progress. Control does not return to the
DCL command prompt until the ACME server has completed the
cancellations.
3.$ SET SERVER ACME_SERVER/CONFIGURE=(NAME=VMS,CREDENTIALS=VMS)
This command loads the VMS ACME agent and identifies its
credentials as VMS.
42.2 – REGISTRY_SERVER
Valid for Alpha and Integrity server systems only.
Controls the Registry server.
Requires SYSPRV privilege.
Format
SET SERVER REGISTRY_SERVER
42.2.1 – Qualifiers
42.2.1.1 /ABORT
Aborts the Registry server on the specified node or nodes in the
cluster.
Cannot be used with the /EXIT, /RESTART, or /START qualifiers.
42.2.1.2 /CLUSTER
Issues the SET command to each Registry server in the cluster,
setting the Registry master server last.
Cannot be used with the /MASTER or /NODE qualifiers.
42.2.1.3 /EXIT
Stops the Registry server on the specified node or nodes in the
cluster.
Cannot be used with the /ABORT, /RESTART, or /START qualifiers.
42.2.1.4 /LOG
/LOG
/NOLOG (default)
Closes the current Registry server log file and creates a new
file.
42.2.1.5 /MASTER
Requires SYSLCK privilege.
Issues the command to the Registry master server only.
Cannot be used with the /CLUSTER, /NODE, or /START qualifiers.
42.2.1.6 /NODE
/NODE=(node-name[,...])
Issues the SET command to the Registry servers on the specified
nodes in the order they are entered. The node names must be
within the current cluster.
Cannot be used with the /CLUSTER or /MASTER qualifiers.
42.2.1.7 /RESTART
Restarts the Registry server on the specified node or nodes in
the cluster.
Cannot be used with the /ABORT, /EXIT, or /START qualifiers.
42.2.1.8 /START
/START cannot be used with the /ABORT, /EXIT, or /RESTART
qualifiers.
Starts the server process. The following options are available:
To change the default privileges:
/PRIVILEGES=(privilege[,...])
To change the default UIC:
/UIC=uic
To change the default quotas:
/AST_LIMIT=n
/BUFFER_LIMIT=n
/ENQUEUE_LIMIT=n
/EXTENT=n
/FILE_LIMIT=n
/IO_BUFFERED=n
/IO_DIRECT=n
/JOB_TABLE_QUOTA=n
/MAXIMUM_WORKING_SET=n
/PAGE_FILE=n
/QUEUE_LIMIT=n
/SUBPROCESS_LIMIT=n
/WORKING_SET=n
You can use the following alternate syntax to specify a list of
quotas and their values:
/QUOTAS=(quota=n[,...])
quota is a PQL-style quota name (for example: ASTLM, BIOLM)
See the $CREPRC system service in the VSI OpenVMS System Services
Reference Manual for a list of PQL-style quota names and
descriptions.
To change the image dump setting:
/DUMP
/NODUMP (default)
Forces a process dump in the event of an abnormal process
termination. The dump is written to SYS$MANAGER: using the image
filename and .DMP extension.
42.2.2 – Examples
1.$ SET SERVER REGISTRY_SERVER/RESTART/MASTER
This command restarts the detached Registry server on the
master server.
2.$ SET SERVER REGISTRY_SERVER/LOG/CLUSTER
This command closes the current log files and opens new files
on all systems across the cluster.
3.$ SET SERVER REGISTRY_SERVER/EXIT/NODE=(KAKADU,CAIRNS)
This command stops the detached Registry server process on
nodes KAKADU and CAIRNS.
42.3 – SECURITY_SERVER
Controls the Security server.
Requires SYSPRV privilege.
Format
SET SERVER SECURITY_SERVER
42.3.1 – Qualifiers
42.3.1.1 /EXIT
Stops the detached security server process.
/EXIT cannot be used with any other qualifier.
42.3.1.2 /RESTART
Restarts the detached security server process.
/RESTART cannot be used with any other qualifier.
42.3.1.3 /START
Starts the detached security server process.
/START cannot be used with any other qualifier.
42.3.2 – Examples
1.$ SET SERVER SECURITY_SERVER/EXIT
This command stops the detached security server process.
2.$ SET SERVER SECURITY_SERVER/RESTART
This command restarts the detached security server process.
43 – SHADOW
Valid for Alpha and Integrity server systems only.
Changes the characteristics of shadow sets created using
Volume Shadowing for OpenVMS. For more information about volume
shadowing, see the VSI Volume Shadowing for OpenVMS manual.
Requires SYSPRV privilege.
NOTE
The following qualifiers are used exclusively to manage
host-based minimerge (HBMM) operations and do not apply to
other operations:
/DELETE
/DISABLE
/ENABLE
/NAME
/POLICY
If you specify any other (non-HBMM) qualifiers in a command
that includes HBMM qualifiers, the command will fail.
For more information about HBMM, see the VSI Volume Shadowing
for OpenVMS manual.
Format
SET SHADOW [device-name[:]]
43.1 – Parameter
device-name[:]
Specifies the name of a shadow set (DSAn:) or shadow set member
(ddcu:), depending on the command qualifiers (see parameter
formats specified in some qualifier descriptions).
For most qualifiers that take a shadow set (DSAn:) as a parameter
the /ALL qualifier can be used in place of the shadow set name to
indicate that the requested action applies to all shadow sets on
the system. (Exceptions are noted in the description of /ALL.)
43.2 – Description
The SET SHADOW command and its qualifiers are designed to give
the user greater control over the behavior of shadow sets. These
commands act upon the shadow set (also known as the virtual unit)
or, in some cases, on the individual shadow set member that you
specify.
Unless otherwise noted, the qualifier settings typically remain
in effect until they are changed using either the SET SHADOW
or SET DEVICE command or until the shadow set or shadow set
member is dismounted. If the shadow set is remounted or a shadow
set member is returned to the shadow set from which it was
dismounted, the settings must be specified again.
Some SET SHADOW qualifiers also can be specified using the SET
DEVICE command, where they have the same effect. However, if
your focus is on changing characteristics of shadow sets, the SET
SHADOW command provides more options.
43.3 – Qualifiers
43.3.1 /ABORT_VIRTUAL_UNIT
/ABORT_VIRTUAL_UNIT DSAn:
/ABORT_VIRTUAL_UNIT /ALL
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Aborts mount verification on the specified shadow set or on all
shadow sets in mount verification on the system.
Use this qualifier when you know that the unit cannot be
recovered. When you use this qualifier, the shadow set must be
in mount verification. The shadow set aborts mount verification
immediately on the system from which the command is issued.
If the shadow set is not in mount verification, this command
returns the error %SYSTEM-E-UNSUPPORTED, unsupported operation or
function.
After this command completes, the shadow set still must be
dismounted. Use the following command to dismount the shadow
set:
$ DISMOUNT/ABORT/OVERRIDE=CHECKS DSAn:
43.3.2 /ALL
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Causes the command to operate on all shadow sets that are mounted
on the system from which the command is issued.
/ALL can be used instead of DSAn: in most commands that take a
shadow set device specification as a parameter. Exceptions are
/DEMAND_MERGE, /DELETE, and /EVALUATE=RESOURCES. /ALL also cannot
be specified with /POLICY or any qualifier that operates only on
individual shadow set members (for example, /MEMBER_TIMEOUT and
/FORCE_REMOVAL).
43.3.3 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Specifies whether a query is made before each merge operation to
confirm that the operation should be performed on the designated
shadow set.
This qualifier can be used only in conjunction with the /DEMAND_
MERGE qualifier.
The following responses are valid in response to the query:
o Affirmative: YES, TRUE, or 1
o Negative: NO, FALSE, 0 (zero), or pressing the Return key.
o End the process: QUIT or Ctrl/Z
o When you enter ALL, the command continues to process, but no
further prompts are given.
You can enter word responses in uppercase or lowercase letters,
and words can be abbreviated to one or more letters. If you enter
an illegal response, DCL redisplays the prompt. (See the SET
SHADOW examples.)
43.3.4 /COPY_SOURCE
/COPY_SOURCE ddcu:
/COPY_SOURCE DSAn:
/COPY_SOURCE /ALL
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Specifies which source member of a shadow set to use as the
source for read data during full copy operations when a third
member is added to a shadow set that contains two full members.
This qualifier affects only those copy operations that do not
use disk copy data (DCD) commands. The source specified by this
qualifier persists until the shadow set is dismounted.
Some storage controllers, such as the HSG80, have a read-ahead
cache, which significantly improves a device's read performance.
Copy operations normally alternate reads between the two source
members, which effectively nullifies the benefits of the read-
ahead cache. This qualifier lets you force all reads from a
single, specified source member for the duration of a copy
operation.
In addition to improving copy performance, /COPY_SOURCE can
be used to prevent read operations from a specific shadow set
member that is considered unreliable. By specifying only the
healthy shadow set member, the copy operations can continue to
completion. The unreliable shadow set member can be removed once
the copy operation completes successfully.
If a shadow set (DSAn:) is specified, all reads for full copy
operations are performed from the device that is the current
"master" member, regardless of the physical location of that
device.
If a shadow set member (ddcu:) is specified, that member is used
as the read source for all copy operations. This setting allows
you to choose any source member. For example, you can choose a
source member that is at the same site as the member being added,
rather than using a master member that is not at the same site.
If /ALL is specified, all reads for full copy operations on all
currently mounted virtual units are performed from the master
member.
43.3.5 /DELETE
/DELETE DSAn:
/DELETE /NAME
Note: This qualifier applies to HBMM operations only. If you
specify any non-HBMM qualifiers with this one, the command will
fail.
Used in conjunction with /POLICY=HBMM, /DELETE removes a host-
based minimerge (HBMM) policy from a specified shadow set,
or deletes an HBMM named policy from the entire cluster. For
example, the following command removes the policy that is
currently associated with shadow set DSA1:
$ SET SHADOW /DELETE DSA1 /POLICY=HBMM
In contrast, the following command removes COMPANY_POLICY from
the cluster:
$ SET SHADOW /DELETE /NAME=COMPANY_POLICY /POLICY=HBMM
You cannot delete the NODEFAULT policy.
You cannot specify /ALL with /DELETE.
43.3.6 /DEMAND_MERGE
/DEMAND_MERGE DSAn:
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Initiates a merge operation on the specified shadow set.
This qualifier is useful if the shadow set was created with
the INITIALIZE/SHADOW command without the use of the /ERASE
qualifier. For more information about using /DEMAND_MERGE, see
the VSI Volume Shadowing for OpenVMS manual.
You cannot specify /ALL with /DEMAND_MERGE.
An OPCOM message is displayed for each shadow set indicating
that a demand merge has been invoked and recording the process ID
(PID) of the process that executed the command. For example:
%%%%%%%%%%% OPCOM 9-MAR-2004 10:35:23.24 %%%%%%%%%%%
Message from user SYSTEM on NODE1
Demand Merge requested for _DSA721:, PID: 2760009A
43.3.7 /DISABLE
/DISABLE=HBMM DSAn:
/DISABLE=HBMM /ALL
/DISABLE=SPLIT_READ_LBNS
Disables host-based minimerge (HBMM) on the specified shadow set
or clusterwide on all shadow sets.
/DISABLE=SPLIT_READ_LBNS disables the split behavior of logical
block numbers and as a result the reads are alternated between
the source shadow set members having the same read_cost and
device queue length.
43.3.8 /ENABLE
/ENABLE=HBMM
/ENABLE=SPLIT_READ_LBNS
/ENABLE=HBMM enables host-based minimerge (HBMM) on the
specified shadow set or across the entire cluster if an
applicable HBMM policy exists. This value applies to HBMM
operations only. If you specify any non-HBMM qualifiers
with this value, the command will fail.
/ENABLE=SPLIT_READ_LBNS logically divides the shadow set members
having the same read cost into equal groups of Logical Block
Numbers (LBNs). When a virtual unit performs a read, it does so
by reading from the corresponding LBN group. This results in the
maximum usage of the controller read-ahead cache. To learn more
about HBMM policies and their application, see the VSI Volume
Shadowing for OpenVMS manual.
43.3.9 /EVALUATE
/EVALUATE=RESOURCES
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Forces the system to evaluate whether it should act on most
shadow copy and merge operations currently being managed on the
system. It cancels most operations and then, based on the value
of system parameter SHADOW_MAX_COPY and the copy/merge priority
of each shadow set), it evaluates the order in which the pending
copies and merges should be restarted.
RESOURCES is the only supported value for /EVALUATE, and it must
be included.
/EVALUATE does not apply to MSCP-based minimerge operations.
MSCP-based minimerge operations are not subject to cancellation
and restart by /EVALUATE.
This command is intended to be used after changing the value of
the dynamic system parameter SHADOW_MAX_COPY or after issuing a
SET SHADOW /PRIORITY=n command for a shadow set. After a suitable
delay, all available SHADOW_MAX_COPY slots on the system are
allocated using the priority list.
43.3.10 /FORCE_REMOVAL
/FORCE_REMOVAL ddcu:
/NOFORCE_REMOVAL ddcu:
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Expels the specified shadow set member from the shadow set. The
specified device must be a member of a shadow set that is mounted
on the system where the command is issued. You cannot specify
/ALL with /FORCE_REMOVAL.
If connectivity to a device has been lost and the shadow set is
in mount verification, this qualifier causes the member to be
expelled from the shadow set immediately.
If the shadow set is not currently in mount verification, no
immediate action is taken. If connectivity to a device has
been lost but the shadow set is not in mount verification, this
qualifier lets you flag the member to be expelled from the shadow
set as soon as the shadow set enters mount verification. If no
action has been taken on the specified member and you wish to
clear the flag, use /NOFORCE_REMOVAL.
If the shadow set is dismounted before the member is expelled,
the FORCE_REMOVAL request expires.
43.3.11 /LOG
Instructs the volume shadowing software to Note: Do not include
any HBMM-specific qualifiers in a command with this qualifier;
doing so causes the command to fail.
display a brief message confirming that the SET SHADOW command
completed. If /OUTPUT is also specified, this information is
written to the output file.
43.3.12 /MEMBER_TIMEOUT
/MEMBER_TIMEOUT=n ddcu:
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Specifies the timeout value to be used for a shadow set member.
The specified device must be a member of a shadow set that is
mounted on the system where the command is issued.
The value supplied by this qualifier overrides the system
parameter SHADOW_MBR_TMO for this specific device. Each member
of a shadow set can be assigned a different MEMBER_TIMEOUT value.
The valid range for n is 1 through 16777215 seconds.
The timeout value set by /MEMBER_TIMEOUT does not persist after
the shadow set is dismounted.
43.3.13 /MVTIMEOUT
/MVTIMEOUT=n DSAn:
/MVTIMEOUT=n /ALL
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Specifies the mount verification timeout value to be used for
all shadow sets on the cluster or for the shadow set specified by
its virtual unit name (DSAn:). The specified shadow set must be
mounted on the system where the command is issued.
The value supplied by this qualifier overrides the value
specified by the system parameter MVTIMEOUT for this specific
shadow set.
NOTE
You cannot change the value of MVTIMEOUT for a system disk.
Any attempt to do so results in an error.
The valid range for n is 1 through 16777215 seconds.
The timeout value set by /MVTIMEOUT does not persist after the
shadow set is dismounted.
43.3.14 /NAME
/NAME=policy-name
Note: This qualifier applies to HBMM operations only. If you
specify any non-HBMM qualifiers with this one, the command will
fail.
Used with /POLICY=HBMM to define a named host-based minimerge
(HBMM) policy or used with /DELETE to delete a policy. The policy
is defined clusterwide. See detailed descriptions under /DELETE
and /POLICY.
Policy names are case insensitive and must consist of from 1 to
64 characters. Only letters, numbers, the dollar sign ($), and
the underscore (_) are allowed.
If you create a default policy, you must assign it the name
DEFAULT.
For details about creating and using policy names, see the VSI
Volume Shadowing for OpenVMS manual.
43.3.15 /OUTPUT
/OUTPUT=file-name
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Outputs any messages to the specified file.
43.3.16 /POLICY
/POLICY=HBMM[=policy-name]
/POLICY=HBMM[=policy-specification]
Note: This qualifier applies to HBMM operations only. If you
specify any non-HBMM qualifiers with this one, the command will
fail.
Creates or deletes a policy for host-based minimerge (HBMM).
HBMM is the only supported value for the /POLICY qualifier, and
it must be included. You can optionally specify a named policy,
including DEFAULT, or you can specify NODEFAULT to indicate
that the shadow set to which it is applied is not to use HBMM,
including any DEFAULT policy. For details about specifying
policies and using the DEFAULT and NODEFAULT policy names, see
the VSI Volume Shadowing for OpenVMS manual.
When /POLICY is specified with /DELETE, it removes either a
specified HBMM named policy or the HBMM policy for a specific
shadow set. You cannot delete the NODEFAULT policy.
When /POLICY is specified with /NAME, it defines a clusterwide
named policy. When no qualifiers other than /NAME or /DELETE are
specified, /POLICY defines a policy for a specific shadow set.
Deleting bitmaps with the DELETE/BITMAP command causes a bitmap
to be deleted. However, the shadowing software recognizes this
condition and starts a new bitmap immediately. To disable HBMM
bitmaps, you have to use the command SET SHADOW/DISABLE=HBMM.
When defining a policy, you use five keywords (MASTER_LIST,
COUNT, RESET_THRESHOLD, MULTIUSE, and DISMOUNT) to control
the placement and management of HBMM bitmaps. An HBMM policy
specification consists of a list of these keywords enclosed
within parentheses. Only the MASTER_LIST keyword is required.
If COUNT and RESET_THRESHOLD are omitted, default values are
applied.
The MULTIUSE and DISMOUNT keywords specify the number of bitmaps
to be converted to multiuse bitmaps during the automatic and
manual removal of members respectively. If MULTIUSE is omitted,
then automatic minicopy on volume processing is not enabled.
As a result, no HBMM bitmap is converted to multiuse bitmap. If
DISMOUNT is omitted, only a maximum of 6 HBMM bitmaps can be used
as multiuse bitmaps.
o MASTER_LIST=list
The MASTER_LIST keyword is used to identify a set of systems
as candidates for a master bitmap. The list value can be a
single system name; a parenthesized, comma-separated list
of system names; or the wildcard character, as shown in the
following examples:
MASTER_LIST=NODE1
MASTER_LIST=(NODE1,NODE2,NODE3)
MASTER_LIST=*
When the system list consists of a single system name or the
wildcard character, parentheses are optional.
An HBMM policy must include at least one MASTER_LIST. Multiple
master lists are optional. If a policy has multiple master
lists, the entire policy must be enclosed with parentheses,
and each constituent master list must be separated by a comma
as shown in the following example:
(MASTER_LIST=(NODE1,NODE2), MASTER_LIST=(NODE3,NODE4))
There is no significance to the position of a system name in a
master list.
o COUNT=n
The COUNT keyword specifies how many systems in the master
list can have master bitmaps. Therefore, the COUNT keyword and
its associated MASTER_LIST must be enclosed within a single
parenthetical statement.
The COUNT value specifies the number of systems on which you
want master bitmaps. It does not necessarily mean that the
first n systems in the list will be chosen.
When the COUNT keyword is omitted, the default value is 6
or the number of systems in the master list, whichever is
smaller.
You cannot specify more than one COUNT keyword per master
list.
Examples:
(MASTER_LIST=(NODE1,NODE2,NODE3), COUNT=2)
(MASTER_LIST=(NODE1,NODE2,NODE3),COUNT=2),(COUNT=2,MASTER_LIST=(NODE4,NODE5,N
NODE6))
o RESET_THRESHOLD=n
The RESET_THRESHOLD keyword specifies the number of blocks
that can be set before the bitmap is eligible to be cleared.
Each set bit in a master bitmap corresponds to a set of blocks
to be merged, so this value can affect the merge time.
Bitmaps are eligible to be cleared when the RESET_THRESHOLD
is exceeded. However, the reset is not guaranteed to
occur immediately when the threshold is crossed. For more
information about choosing a value for this attribute, see the
VSI Volume Shadowing for OpenVMS manual.
The reset threshold is associated with a specific HBMM policy,
so the RESET_THRESHOLD keyword can be defined only once in a
policy specification. Because its scope is the entire policy,
the RESET_THRESHOLD keyword cannot be specified inside a
constituent master list when the policy uses multiple master
lists.
When the RESET_THRESHOLD keyword is omitted, the value of
1,000,000 is used by default. See the following example:
(MASTER_LIST=*, COUNT=4, RESET_THRESHOLD=1000000)
Example:
The command in the following example defines the HBMM named
policy POLICY_2, which has two master lists. Having multiple
master lists can be useful in a multiple-site OpenVMS Cluster
configuration because a policy can be defined to ensure that
at least one surviving system has an HBMM bitmap in the event
of an outage at one or more sites.
$ SET SHADOW /POLICY=HBMM=( -
_$ (MASTER_LIST=(NODE1,NODE2,NODE3), COUNT=2), -
_$ (MASTER_LIST=(NODE4,NODE5,NODE6), COUNT=2), -
_$ RESET_THRESHOLD=150000) -
_$ /NAME=POLICY_2
In a policy with multiple master lists, a given system name
can appear in only one master list.
A shadow set need not be mounted to have an HBMM policy
defined for it.
See the SET SHADOW Examples help topic for several more
/POLICY examples. For more information about HBMM policies,
see the VSI Volume Shadowing for OpenVMS manual.
o MULTIUSE=n
The MULTIUSE keyword enables automatic minicopy on volume
processing. n specifies the number of existing HBMM master
bitmaps to be converted to multiuse bitmaps in the event that
a shadow set member is removed from the shadow set by the
shadowing driver.
During a loss of connectivity to a site or controller,
shadowing may remove a member from the shadow set. When the
member is added back to the shadow set, a full shadow copy
occurs.
By converting a few of the HBMM bitmaps to multiuse, all
writes that are performed to the shadow set are recorded.
Thus, when the member is added back to the shadow set, the
multiuse bitmap can be used for a minicopy operation. This is
much faster than a full copy operation.
The value of n cannot exceed the implied or explicit value
of COUNT. If MULTIUSE is not specified, then bitmaps are not
converted to multiuse and a full copy operation is required.
Fatal drive errors that remove a shadow set member do not
cause a multiuse conversion as the drive has to be replaced
and therefore requires a full copy operation.
o DISMOUNT=n
The DISMOUNT keyword allows all the 12 write bitmaps to be
used by Shadowing as multiuse bitmaps, thereby reducing the
single point of failure of single minicopy master bitmaps.
n specifies the number of HBMM bitmaps to be converted to
multiuse bitmaps every time a member is dismounted from a
shadow set with the following command:
DISMOUNT/POLICY=MINICOPY
43.3.17 /PRIORITY
/PRIORITY=n DSAn:
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Overrides the current default priority setting. Priorities range
from 0 (lowest) to 10000 (highest). The default priority is 5000.
A shadow set with a priority of 0 is never considered for a merge
or a copy on the system.
When a recovery operation (that is, either a merge or a copy) is
needed on multiple shadow sets, the shadow sets are recovered in
priority order from highest to lowest. The priority setting is
system specific; any change in priority made on a single system
does not propagate to the entire cluster and does not persist
across a system reboot.
Once this qualifier has been applied to a virtual unit that is
mounted, the setting persists across any subsequent DISMOUNT and
MOUNT commands.
43.3.18 /READ_COST
/READ_COST=n ddcu:
/READ_COST=n DSAn:
/READ_COST=n $n$DGAn:
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Enables you to modify the default cost assigned to each shadow
set member (ddcu:). By modifying the assignments, you can bias
the reads in favor of one member of a two-member shadow set
or, in the case of three-member shadow sets, in favor of one
or two members of the set over the remaining members. The device
specified must be a shadow set or member of a shadow set that is
mounted on the system where the command is issued.
The valid range for the specified cost is 1 through 65,535 units.
The shadowing driver assigns default READ_COST values to shadow
set members when each member is initially mounted. The default
value depends on the device type and its configuration relative
to the system mounting it. The following list of device types
is ordered by the default READ_COST assignments, from the lowest
cost to the highest cost:
o DECram device
o Directly connected device in the same physical location
o Directly connected device in a remote location
o DECram served device
o Default value for other served devices
The value supplied by the /READ_COST qualifier overrides the
default assignment. The shadowing driver adds the value of the
current queue depth of the shadow set member to the READ_COST
value and then reads from the member with the lowest value.
Different systems in the cluster can assign different costs to
each shadow set member.
When this qualifier specifies a shadow set (DSAn:) instead of a
shadow set member, the /READ_COST qualifier switches the read
cost setting for all shadow set members back to the default
read cost settings established automatically by the shadowing
software. The specified shadow set must be mounted on the system
where the command is issued.
You cannot specify a value for /READ_COST when you specify /ALL.
If the /SITE command qualifier has been specified, the shadowing
driver takes site values into account when it assigns default
READ_COST values. In order for the shadowing software to
determine whether a device is in the category of "directly
connected device in a remote location," the /SITE command
qualifier must have been applied to both the shadow set and the
shadow set member.
Reads requested for a shadow set from a system at site 1 are
performed from a shadow set member that is also at site 1. Reads
requested for the same shadow set from site 2 can read from the
member located at site 2.
43.3.19 /RECOVERY_OPTIONS
/RECOVERY_OPTIONS=DELAY_PER_SERVED_MEMBER=n
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Allows the system manager to adjust the rating assigned to a
system based on a delay assessed for each MSCP served shadow
set member on that system. The value specified by this qualifier
overrides the value established by the SHADOW_PSM_RDLY system
parameter. The default delay for each MSCP served member is 30
seconds and the valid range for the specified delay is 0 through
65,535 seconds.
When a copy or merge operation is needed on a shadow set that is
mounted on multiple systems, OpenVMS Volume Shadowing attempts
to perform this work on a system that has a local connection to
all of the shadow set members. Systems are rated with a penalty
(delay time) assessed for each shadow set member that is MSCP
served to the system. No delay is added for local members, so a
system with all locally accessible shadow set members is likely
to perform the work before a system where one or more members is
served.
IF /ALL is also specified, the specified delay is applied to all
currently mounted shadow sets.
See the VSI Volume Shadowing for OpenVMS manual for more
information.
43.3.20 /RESET_COUNTERS
Note: This qualifier applies to HBMM operations only. If you
specify any non-HBMM qualifiers with this one, the command will
fail.
Resets the shadowing specific counters that are maintained for
each shadow set. These counters can be displayed using the SHOW
SHADOW command.
The counters that are reset to 0 are the following:
HBMM Reset Count
Copy Hotblocks
Copy Collisions
SCP Merge Repair Cnt
APP Merge Repair Cnt
The HBMM Reset Count is a running total of the number of times
that the HBMM Reset Threshold was exceeded and therefore, the
number of times the bitmaps were reset. (The threshold is set by
the RESET_THRESHOLD keyword in the /POLICY qualifier.) For more
information, see the VSI Volume Shadowing for OpenVMS.
43.3.21 /SITE
/SITE=n ddcu:
/SITE=n DSAn:
Note: Do not include any HBMM-specific qualifiers in a command
with this qualifier; doing so causes the command to fail.
Indicates to the shadowing driver the site location of the
specified shadow set (DSAn:) or shadow set member (ddcu:).
The SHADOW_SITE_ID system parameter defines the default site
location of the shadow set. You can override the default location
of the shadow set with the /SITE qualifier.
The valid range for the site location, represented by n, is 1
through 255.
If /ALL is specified, all virtual units are assigned the new
value. The shadow set's member site values remain unchanged.
After you apply this qualifier, the setting remains in effect
until you change it using a SET SHADOW/SITE command.
This qualifier can improve read performance because the member
that is physically local to the system will be the preferred disk
from which to read, provided that you specify the /SITE qualifier
for each shadow set member and for the shadow set. (In a Fibre
Channel configuration, shadow set members at different sites are
directly attached to the system. For the Volume Shadowing and
OpenVMS Cluster software, there is no distinction between local
and remote in multiple-site Fibre Channel configurations.)
43.3.22 /STALL
/STALL=WRITES[=nnn]
/NOSTALL=WRITES[=nnn]
Using /STALL=WRITES[=nnn] qualifier, you can stall the write
operations for nnn seconds. nnn is the number of seconds for
which you can stop write operations. If no value is specified
for nnn, the lock is released after SHADOW_MBR_TMO seconds. The
default is SHADOW_MBR_TMO.
/NOSTALL=WRITES[=nnn] releases the lock after nnn seconds so that
write operations can continue on the shadow set.
43.4 – Examples
1.$ ! Command sequence used on system 1 at site 1:
$ MOUNT/SYSTEM DSA0:/SHADOW=($1$DGA0:,$1$DGA1:) TEST
$ SET SHADOW/SITE=1 DSA0:
$ !
$ ! Command sequence used on system 2 at site 2:
$ MOUNT/SYSTEM DSA0:/SHADOW=($1$DGA0:,$1$DGA1:) TEST
$ SET SHADOW/SITE=2 DSA0:
$ !
$ ! Commands used on both system 1 and system 2:
$ SET SHADOW/SITE=1 $1$DGA0:
$ SET SHADOW/SITE=2 $1$DGA1:
In this example, the system at site 1 will perform reads from
$1$DGA0, which is located at that site, while the system at
site 2 will perform reads from $1$DGA1, which is located at
site 2.
2.$ SET SHADOW DSA1: /POLICY=HBMM= -
_$ (MASTER_LIST=(NODE1,NODE2,NODE3), COUNT=2, -
_$ RESET_THRESHOLD=75000)
This command defines an HBMM policy for shadow set DSA1:. The
policy specifies that no more than two systems of the three
systems listed can have an HBMM master bitmap. Once 75000
blocks have been modified on DSA1:, any existing HBMM bitmaps
are zeroed.
3.$ SET SHADOW /POLICY=HBMM=(MASTER_LIST= -
_$ (NODE1,NODE2,NODE3), RESET_THRESHOLD=75000, COUNT=2) -
_$ /NAME=HONESTY_IS_BEST
This command defines the named policy HONESTY_IS_BEST. This
policy is available to all cluster members, but is not applied
to any specific shadow set.
4.$ SET SHADOW DSA1: /POLICY=HBMM=HONESTY_IS_BEST
This command associates the named policy HONESTY_IS_BEST with
shadow set DSA1.
5.$ SET SHADOW /POLICY=HBMM=( -
_$ (MASTER_LIST=(NODE1,NODE2,NODE3), COUNT=2), -
_$ (MASTER_LIST=(NODE4,NODE5,NODE6), COUNT=2), -
_$ RESET_THRESHOLD=150000) -
_$ /NAME=POLICY_2
This command defines the HBMM named policy POLICY_2, which has
two master lists.
6.$ SET SHADOW DSA2: /POLICY=HBMM=POLICY_2
This command associates the named policy POLICY_2 with shadow
set DSA2.
7.$ SET SHADOW /POLICY=HBMM /DELETE /NAME=POLICY_2
This command deletes the named policy POLICY_2. Note that
any shadow set that had acquired the attributes of POLICY_
2 by execution of a SET SHADOW DSAn: /POLICY=HBMM=POLICY_2
command is not affected. Changes made to a named policy are
not retroactive to a mounted shadow set that was assigned the
characteristics of a previous version of that named policy.
8.$ SET SHADOW DSA1: /POLICY=HBMM /DELETE
This command deletes the existing HBMM policy from DSA1:. If
this HBMM policy is enabled on DSA1:, you must first execute
the following command to disable the policy before you can
delete it:
$ SET SHADOW DSA1: /DISABLE=HBMM
9.$ SET SHADOW /DEMAND_MERGE/CONFIRM
Allow merge of _DSA721:? [N]:y
Allow merge of _DSA850:? [N]: TRUE
Allow merge of _DSA1010:? [N]:N
$
In this example, a merge operation is initiated on DSA721: and
DSA850: but not on DSA1010:.
10$ SET SHADOW DSA1/POLICY=HBMM=(MASTER=*,COUNT=12,MULTIUSE=12,DISMOUNT=1)
In this example, a policy is set in which all 12 bitmaps can
be used as multiuse bitmaps. When you execute the command
DISMOUNT/POLICY=MINICOPY, 1 minimerge bitmap is converted to
multiuse bitmap. You can use this multiuse bitmap with the
MINICOPY command to add the dismounted member back to the
shadow set. In other words, it specifies that 12 bitmaps can
be used during the automatic and 1 bitmap during the manual
removal of the shadow set member.
11$SET SHADOW DSA42 /STALL=WRITES
In this example, the writes are stalled to the shadow set for a
period of SHADOW_MBR_TMO seconds.
12$SET SHADOW DSA42 /STALL=WRITES=60
In this example, the writes are stalled to the shadow set for a
period of 60 seconds.
13$SET SHADOW DSA42 /NOSTALL=WRITES=30
In this example, the writes are allowed to the shadow set after
a period of 30 seconds.
44 – SYMBOL
Controls access to local and global symbols in command
procedures.
Format
SET SYMBOL
44.1 – Qualifiers
44.1.1 /ALL
/ALL (default)
Specifies that the values of the /SCOPE qualifier pertain both
to the translation of the first token on a command line and to
general symbol substitution.
The /ALL qualifier is incompatible with the /GENERAL or the /VERB
qualifier.
44.1.2 /GENERAL
Specifies that the values of the /SCOPE qualifier pertain to the
translation of all symbols except the first token on a command
line.
The /GENERAL qualifier is incompatible with the /ALL or the /VERB
qualifier.
44.1.3 /SCOPE
/SCOPE=(keyword,...)
Controls access to local and global symbols. Lets you treat
symbols as being undefined. Possible keywords are as follows:
NOLOCAL Causes all local symbols defined in outer procedure
levels to be treated as being undefined by the current
procedure and by all inner procedure levels.
LOCAL Removes any symbol translation limit set by the current
procedure level.
NOGLOBAL Causes all global symbols to be inaccessible to the
current procedure level and to all inner procedure
levels unless otherwise changed.
GLOBAL Restores access to all global symbols.
44.1.4 /VERB
Specifies that the values of the /SCOPE qualifier pertain
to the translation of the first token on a command line as a
symbol before processing only. It does not affect general symbol
substitution.
NOTE
Caution must be used if the SET SYMBOL/VERB/SCOPE command
is used more than once in a command procedure. Because
DCL uses the translation behavior when looking for a
label or subroutine, execution may be different running
in one mode than in another. VSI recommends that the SET
SYMBOL/VERB/SCOPE command be used once as part of the
command procedure setup and left in that mode for the
duration of the procedure.
The /VERB qualifier is incompatible with the /ALL or the /GENERAL
qualifier.
44.2 – Examples
1.$ SET SYMBOL/SCOPE=NOLOCAL
In this example, all local symbols defined in outer procedure
levels are now undefined for the current procedure level and
all inner procedure levels.
2.$ SET SYMBOL/SCOPE=NOGLOBAL
In this example, all global symbols are now inaccessible to the
current procedure level and all inner procedure levels unless
otherwise changed.
3.$ NOW :== SHOW TIME
$ !
$ NOW
3-NOV-2001 11:48:58
$ !
$ SET SYMBOL /VERB /SCOPE=NOGLOBAL
$ NOW
%DCL-W-IVVERB, unrecognized command verb-check validity and spelling
\NOW\
$ !
$ SHOW SYMBOL NOW
NOW == "SHOW TIME"
This example demonstrates the use of the /VERB qualifier.
The symbol NOW is assigned to the SHOW TIME command. The
next line shows the default behavior, where DCL attempts to
translate the first string on the command line (NOW). Because
NOW translates to the SHOW TIME command, this is used instead
of NOW.
The SET SYMBOL command on the next line changes the behavior
so that DCL does not attempt a translation. When NOW is
subsequently entered, DCL uses the string NOW as the command
verb and cannot find it in the command table. This results in
the error message.
Notice that the scoping of the verb translation has no effect
on general symbol translations, as demonstrated by the SHOW
SYMBOL command in the example.
45 – TERMINAL
Sets the characteristics of a terminal. Entering a qualifier
changes a characteristic; omitting a qualifier leaves the
characteristic unchanged.
Format
SET TERMINAL [device-name[:]]
45.1 – Parameter
device-name[:]
Specifies the device name of the terminal. The default is
SYS$COMMAND if that device is a terminal. If the device is not
a terminal, an error message is displayed.
45.2 – Qualifiers
45.2.1 /ADVANCED_VIDEO
/ADVANCED_VIDEO
/NOADVANCED_VIDEO
Controls whether the terminal has advanced video attributes and
is capable of 132-column video. If the terminal width is set
to 132 columns and you specify the /ADVANCED_VIDEO qualifier,
the terminal page limit is set to 24 lines. If you specify the
/NOADVANCED_VIDEO qualifier, the terminal page limit is set to
14 lines.
45.2.2 /ALTYPEAHD
Causes the terminal driver to create a permanent, alternate type-
ahead buffer. The system parameter TTY_ALTYPEAHD determines the
size of the type-ahead buffer.
To enable /ALTYPEAHD, you must also set the qualifier /TYPE_
AHEAD.
You should specify SETTERMINAL/PERMANENT/ALTYPEAHD in
SYS$STARTUP:SYSTARTUP_VMS.COM for those communication lines that
require this capability.
To use this feature interactively, specify SET
TERMINAL/PERMANENT/ALTYPEAHD. This specification is effective
at your next login.
45.2.3 /ANSI_CRT
/ANSI_CRT (default)
/NOANSI_CRT
Controls whether the terminal conforms to ANSI CRT programming
standards. Because ANSI standards are a proper subset of the DEC_
CRT characteristics, the default for all VT100 family terminals
is /ANSI_CRT.
45.2.4 /APPLICATION_KEYPAD
Specifies that the keypad is to be set to application keypad
mode, which allows you to enter DCL commands defined with the
DEFINE/KEY command. By default, the terminal is set to numeric
keypad mode.
45.2.5 /AUTOBAUD
/AUTOBAUD
/NOAUTOBAUD
Controls whether the terminal baud rate is set when you log in
and sets the default terminal speed to 9600. You must press
Return two or more times at intervals of at least 1 second for
the baud rate to be determined correctly. If you press a key
other than Return, the /AUTOBAUD qualifier may detect the wrong
baud rate. If this happens, wait for the login procedure to time
out before continuing. The /AUTOBAUD qualifier must be used with
the /PERMANENT qualifier.
The valid baud rates are as follows:
50 150 1800 4800 38400
75 300 2000 7200 57600
110 600 2400 9600 76800
134 1200 3600 19200 115200
45.2.6 /BACKSPACE
/BACKSPACE=keyword
Controls how the system responds to the backspace key (Ctrl/H) in
line editing mode. There are two possible keywords:
o BACKSPACE (default) - The terminal driver returns the user
to the beginning of the line. (This is the traditional way
OpenVMS has always worked.)
o DELETE - The terminal driver interprets the backspace key as a
delete character instruction.
Note the following exceptions:
- If the terminal is set in PASSALL or PASTHRU mode, the
backspace key is not interpreted as a delete character
instruction.
- If the user issues an IO$_READVBLK with IO$M_NOFILTR or
IO$_READPBLK, the backspace key is not interpreted as a
delete character instruction.
You can use SYSGEN to make /BACKSPACE=DELETE the default for all
terminals by setting the system parameter TTY_DEFCHAR3 to 16.
If the default is set to DELETE, the user can still go to the
start of a line by pressing F12 or by entering the following
sequence: Ctrl/V Ctrl/H Ctrl/H.
If you use SET HOST, both the local node and the remote node must
be capable of responding to your definition of the BACKSPACE key.
45.2.7 /BLOCK_MODE
/BLOCK_MODE
/NOBLOCK_MODE
Controls whether block mode transmission, local editing, and
field protection are performed.
45.2.8 /BRDCSTMBX
/BRDCSTMBX
/NOBRDCSTMBX
Controls whether broadcast messages are sent to an associated
mailbox if one exists.
45.2.9 /BROADCAST
/BROADCAST (default)
/NOBROADCAST
Controls whether reception of broadcast messages (such as those
issued by MAIL and REPLY) is enabled. Specify the /NOBROADCAST
qualifier when you are using a terminal as a noninteractive
device or when you do not want special output to be interrupted
by messages. Use the SET BROADCAST command to exclude certain
types of messages from being broadcast, rather than eliminating
all messages.
45.2.10 /COLOR
Sets the ANSI_COLOR terminal characteristic and identifies
the terminal as capable of supporting the ANSI color escape
sequences.
45.2.11 /COMMSYNC
/COMMSYNC
/NOCOMMSYNC (default)
Allows connection of asynchronous printers and other devices
to terminal ports, using standard modem control signals as flow
control. Transmission to the device stops if either data set
ready (DSR) or clear to send (CTS) EIA modem control signals are
dropped. Transmission resumes when both signals are present.
The /COMMSYNC qualifier and the /MODEM qualifier are mutually
exclusive.
The COMMSYNC feature has the following limitations:
o Cannot be used on LAT ports
o Can only be used on ports with full modem control
o Should not be used in conjunction with Xon/Xoff flow control
(the port may hang)
CAUTION
The /COMMSYNC qualifier should never be set on a line with
a modem that is intended for interactive use. The qualifier
disables the modem terminal characteristic that disconnects
a user process from the terminal line in case of a modem
phone line failure. With the /COMMSYNC qualifier enabled,
the next call on the terminal line could be attached to the
previous user's process. Security administrators should
be aware that the characteristic should not be used on
interactive terminal ports. In addition, the /COMMSYNC
qualifier is not supported on a port connected to a LAT
line.
45.2.12 /CRFILL
/CRFILL[=fill-count]
Generates the specified number of null characters after each
carriage return before transmitting the next meaningful character
(to ensure that the terminal is ready for reception). The value
must be an integer in the range 0 to 9. The default is the
/CRFILL=0 qualifier.
45.2.13 /DEC_CRT
/DEC_CRT[=(value1,value2,value3)]
/NODEC_CRT[=(value1,value2,value3)]
Controls whether the terminal conforms to DIGITAL VT100-,
VT200-, VT300-, VT400-, or VT500-family standards and supports
the minimum standards, including the additional DIGITAL escape
sequences.
You can specify one of the following values:
1 Requests that the DEC_CRT terminal characteristic be
(default) set.
2 Requests that the DEC_CRT2 terminal characteristic be
set.
3 Requests that the DEC_CRT3 terminal characteristic
be set. A level 3 terminal supports the following
additional features:
o A status line (line 25, at the bottom of the
screen)
o The ISO Latin1 character set
o Terminal state interrogation (describes what state
your terminal is in)
4 Requests that the DEC_CRT4 terminal characteristic
be set. A level 4 terminal supports the following
additional features:
o Extended keyboard
o Key position mode
o Secure reset
o Novice mode
o Selective erase
o On-line transaction processing (OLTP) features:
- Page memory
- Rectangular editing
- Text macros
- Data integrity reports
Note that DEC_CRT2, DEC_CRT3, and DEC_CRT4 are supersets of DEC_
CRT. Clearing DEC_CRT causes DEC_CRT2, DEC_CRT3, and DEC_CRT4
to be cleared. Similarly, setting DEC_CRT4 causes all subsets of
DEC_CRT4 (including ANSI_CRT) to be set.
45.2.14 /DEVICE_TYPE
/DEVICE_TYPE=terminal-type
Informs the system of the terminal type and sets characteristics
according to the device type specified. You can specify any of
the following terminal types:
UNKNOWN LA100 PRO_SERIES VT102 VT200
FT1-FT8 LA120 VT05 VT105 VT300
LA12 LA210 VT52 VT125 VT400
LA34 LN01K VT55 VT131 VT500
LA36 LN03 VT100 VT132
LA38 LQP02 VT101 VT173
The default characteristics for the VT100-, VT102-, and VT125-
series terminals are as follows:
/ADVANCEDVIDEO /NOALTYPEAHD /ANSI_CRT
/NOAUTOBAUD /NOBLOCK_MODE /NOBRDCSTMBX
/BROADCAST /CRFILL=0 /ECHO
/NOEIGHT_BIT /NOESCAPE /NOFORM
/FULLDUP /NOHOSTSYNC /LFFILL=0
/LOWERCASE /NODMA /PAGE=24
/NOPARITY /NOPASTHRU /NOREADSYN
/SPEED=9600 /TAB /TTSYNC
/TYPE_AHEAD /WIDTH=80 /WRAP
45.2.15 /DIALUP
/DIALUP
/NODIALUP (default)
Controls whether the terminal is a dialup terminal.
45.2.16 /DISCONNECT
/DISCONNECT
/NODISCONNECT (default)
Controls whether the process connected to this terminal is
disconnected if the line detects a hangup. The /DISCONNECT
qualifier is valid only when the /PERMANENT qualifier is
specified.
45.2.17 /DISMISS
/DISMISS
/NODISMISS (default)
Controls whether the terminal driver ignores data that causes a
parity error (instead of terminating the currently outstanding
I/O with an error status).
45.2.18 /DMA
/DMA
/NODMA
Controls whether direct memory access (DMA) mode is used on a
controller that supports this feature.
45.2.19 /ECHO
/ECHO (default)
/NOECHO
Controls whether the terminal displays the input it receives.
With the /NOECHO qualifier, the terminal displays only system or
user application output, or both.
45.2.20 /EDIT_MODE
/EDIT_MODE
/NOEDIT_MODE
Controls whether the terminal can perform ANSI-defined advanced
editing functions.
45.2.21 /EIGHT_BIT
/EIGHT_BIT
/NOEIGHT_BIT
Controls whether the terminal uses the 8-bit ASCII protocol
rather than the 7-bit ASCII protocol. You can use the Terminal
Fallback Facility (TFF) to set the 8-bit characteristic on
terminals. If the terminal you specify has the TFF enabled,
the /EIGHT_BIT qualifier has no effect. For more information
on terminal fallback, see the OpenVMS Terminal Fallback Utility
Manual (available on the Documentation CD-ROM).
45.2.22 /ESCAPE
/ESCAPE
/NOESCAPE (default)
Controls whether escape sequences are validated.
45.2.23 /FALLBACK
/FALLBACK
/NOFALLBACK
Controls whether the 8-bit DEC Multinational character set
characters are displayed on the terminal in their 7-bit
representation. The default depends on the /EIGHTBIT setting
of the terminal. If the OpenVMS Terminal Fallback Facility (TFF)
is enabled, it activates the default character conversion tables
for the named terminal. For more information, see the OpenVMS
Terminal Fallback Utility Manual (available on the Documentation
CD-ROM). If TFF is not enabled on your system, the /FALLBACK
qualifier has no effect and no error message is displayed.
45.2.24 /FORM
/FORM
/NOFORM
Controls whether a form feed is transmitted rather than
translated into multiple line feeds.
45.2.25 /FRAME
/FRAME=n
Specifies 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 /EIGHTBIT
qualifiers.
45.2.26 /FULLDUP
/FULLDUP (default)
/NOFULLDUP
Controls whether the terminal operates in full-duplex mode. The
/FULLDUP qualifier is equivalent to the /NOHALFDUP qualifier.
45.2.27 /HALFDUP
/HALFDUP
/NOHALFDUP (default)
Controls whether the terminal operates in half-duplex mode. The
/HALFDUP qualifier is equivalent to the /NOFULLDUP qualifier.
45.2.28 /HANGUP
/HANGUP
/NOHANGUP (default)
May require LOG_IO (logical I/O) or PHY_IO (physical I/O)
privilege depending on system generation parameter settings.
Controls whether the terminal modem is hung up when you log out.
45.2.29 /HARDCOPY
/HARDCOPY
/NOHARDCOPY
Controls whether the device is established as a hardcopy terminal
and outputs a backslash (\) when the Delete key is pressed. The
/HARDCOPY qualifier is equivalent to the /NOSCOPE qualifier.
45.2.30 /HOSTSYNC
/HOSTSYNC
/NOHOSTSYNC (default)
Controls whether system transmission from the terminal is stopped
(by generating a Ctrl/S) when the input buffer is full and
resumed (by generating a Ctrl/Q) when the input buffer is empty.
45.2.31 /INQUIRE
Sets the device type when the /INQUIRE qualifier is specified
and the DEC_CRT characteristic is set. The SET TERMINAL command
reads the current screen size from the terminal and sets the
corresponding page length and page width values appropriately.
The default device type is UNKNOWN. Works only on DIGITAL
terminals, and not on LA36 or VT05 terminals. Some VT100 family
terminals, including the VT101 and VT105, return a VT100 type
response. LA38 terminals respond as LA43 terminals.
NOTE
The SET TERMINAL/INQUIRE command works correctly on DIGITAL
supplied VT100 and later terminals. Some personal computer
terminal emulators may not work correctly, because they
do not correctly emulate all VT100 escape sequences. VSI
recommends that users who experience problems with these
terminal emulators contact the terminal emulator supplier.
You can include the SET TERMINAL/INQUIRE command in your
LOGIN.COM file to detect the terminal type automatically.
If you specify /INQUIRE=OLD, OpenVMS sets the terminal window
to 24 lines by 80 columns and ignores the real terminal size.
(This is the behavior of the SET TERMINAL/INQUIRE command prior
to OpenVMS Version 6.2.)
CAUTION
This qualifier clears the type-ahead buffer. If the response
sequence is unrecognized, no action message or error message
is displayed. The /INQUIRE qualifier should be used only on
DIGITAL terminals; however, the LA36 and VT05 terminals do
not support this feature.
45.2.32 /INSERT
Sets the terminal to insert mode. This feature allows you to
insert characters when editing command lines. The default mode is
overstrike, which allows you to type over the current character
when editing a command line. Press Ctrl/A to switch from one mode
to the other.
45.2.33 /LFFILL
/LFFILL[=fill-count]
Transmits to the terminal the specified number of null characters
after each line feed before transmitting the next meaningful
character (to ensure that the terminal is ready for reception).
The value must be an integer in the range 0 to 9. The default is
installation dependent.
45.2.34 /LINE_EDITING
/LINE_EDITING
/NOLINE_EDITING
Controls whether advanced line-editing features are enabled for
editing command lines: pressing Return and pressing Ctrl/Z are
recognized as line terminators, as are escape sequences.
45.2.35 /LOCAL_ECHO
/LOCAL_ECHO
/NOLOCAL_ECHO (default)
Controls whether the terminal echoes characters locally (rather
than the host echoing them) for command level terminal functions.
(Do not use the /LOCAL_ECHO qualifier with utilities that require
control over echoing, such as line editing or EDT's screen mode.)
CAUTION
When logging in to terminals with the LOCAL_ECHO
characteristic, the OpenVMS system has no control over the
echoing of passwords.
45.2.36 /LOWERCASE
/LOWERCASE
/NOLOWERCASE
Controls whether lowercase characters are passed to the terminal.
The /NOLOWERCASE qualifier translates all input to uppercase. The
/LOWERCASE qualifier is equivalent to the /NOUPPERCASE qualifier.
45.2.37 /MANUAL
Indicates manual switching of terminal lines to dynamic
asynchronous DDCMP lines when your local terminal emulator does
not support automatic switching. The /MANUAL qualifier should be
specified with the /PROTOCOL=DDCMP and /SWITCH=DECNET qualifiers.
45.2.38 /MODEM
/MODEM
/NOMODEM
Specifies whether the terminal is connected to a modem or
a cable that supplies standard EIA modem control signals.
If your terminal has the MODEM characteristic, entering SET
TERMINAL/NOMODEM automatically logs you out. The /MODEM qualifier
and the /COMMSYNC qualifier are mutually exclusive.
45.2.39 /NUMERIC_KEYPAD
/NUMERIC_KEYPAD (default)
Specifies whether the keys of the numeric keypad are used
to type numbers and punctuation marks (/NUMERIC_KEYPAD) or
to enter DCL commands defined with the DEFINE/KEY command
(/APPLICATION_KEYPAD).
45.2.40 /OVERSTRIKE
/OVERSTRIKE (default)
Sets the terminal to overstrike mode. This feature allows you to
type over the current character when you are editing a command
line. Set your terminal to insert mode if you want to insert
characters when editing command lines. Press Ctrl/A to switch
from one mode to the other.
45.2.41 /PAGE
/PAGE[=lines-per-page]
Specifies the number of print lines between perforations for
hardcopy terminals. (When the terminal reads a form feed, it
advances the paper to the next perforation.) The value of the
lines-per-page parameter can be from 0 to 255 and defaults to 0
(which treats a form feed as a line feed).
45.2.42 /PARITY
/PARITY[=option]
/NOPARITY (default)
Controls whether the terminal passes data with only odd or even
parity, where option equals ODD or EVEN. If you specify the
/PARITY qualifier without an option, the value defaults to EVEN.
45.2.43 /PASTHRU
/PASTHRU
/NOPASTHRU (default)
Controls whether the terminal passes all data (including tabs,
carriage returns, line feeds, and control characters) to an
application program as binary data. The setting of /TTSYNC is
allowed.
Make sure that you spell both these qualifiers exactly as they
appear in the text.
45.2.44 /PERMANENT
Requires LOG_IO (logical I/O) or PHY_IO (physical I/O) privilege.
Sets characteristics on a permanent basis, that is, over terminal
sessions; however, the characteristics revert to their initial
values if the system is halted and restarted. Use in a system
startup file to establish characteristics for all terminals on
the system.
45.2.45 /PRINTER_PORT
/PRINTER_PORT
/NOPRINTER_PORT
Specifies whether the terminal has a printer port (an attribute
not set by the SET TERMINAL/INQUIRE command). The default is
installation dependent.
45.2.46 /PROTOCOL
/PROTOCOL=DDCMP
/PROTOCOL=NONE (default)
On VAX, controls whether the terminal port specified is changed
into an asynchronous DDCMP line. The /PROTOCOL=NONE qualifier
changes an asynchronous DDCMP line back into a terminal line.
Note that /PROTOCOL=DDCMP is a permanent characteristic;
therefore, the /PERMANENT qualifier is not required.
45.2.47 /READSYNC
/READSYNC
/NOREADSYNC (default)
Controls whether the terminal uses the Ctrl/S and Ctrl/Q
functions to synchronize data transmitted from the terminal.
CAUTION
SET TERMINAL/READSYNC should not be used on LAT terminal
lines. Setting this characteristic may cause unexpected
results.
The default is the /NOREADSYNC qualifier; the system does not
use the Ctrl/S and Ctrl/Q functions to control reads to the
terminal. The /READSYNC qualifier is useful for certain classes
of terminals that demand synchronization or for special-purpose
terminal lines where data synchronization is appropriate.
45.2.48 /REGIS
/REGIS
/NOREGIS
Specifies whether the terminal understands ReGIS graphic
commands.
45.2.49 /SCOPE
/SCOPE
/NOSCOPE
Controls whether the device is established as a video terminal.
The /SCOPE qualifier is equivalent to the /NOHARDCOPY qualifier.
45.2.50 /SECURE_SERVER
/SECURE_SERVER
/NOSECURE_SERVER (default)
Requires either LOG_IO (logical I/O) or PHY_IO (physical I/O)
privilege.
Controls whether the Break key on the terminal logs out the
current process (except on a virtual terminal). With the /SECURE_
SERVER qualifier in effect, pressing the Break key when there
is no current process initiates the login sequence. With the
/NOSECURE_SERVER qualifier in effect, the break is ignored.
On terminals with the AUTOBAUD and SECURE_SERVER characteristics,
pressing the Break key disconnects the current process, but
is not required to start a new login sequence. However,
when the NOAUTOBAUD characteristic is set, the SECURE_SERVER
characteristic requires a break to initiate a new login sequence.
45.2.51 /SET_SPEED
/SET_SPEED
/NOSET_SPEED
Requires either LOG_IO (logical I/O) or PHY_IO (physical I/O)
privilege.
Controls whether the /SPEED qualifier can be used to change the
terminal speed.
45.2.52 /SIXEL_GRAPHICS
/SIXEL_GRAPHICS
/NOSIXEL_GRAPHICS
Specifies whether the terminal is capable of displaying graphics
using the sixel graphics protocol. The default is device
dependent.
45.2.53 /SOFT_CHARACTERS
/SOFT_CHARACTERS
/NOSOFT_CHARACTERS
Specifies whether the terminal is capable of loading a user-
defined character set. The default is device dependent.
45.2.54 /SPEED
/SPEED=(input-rate,output-rate)
Sets the baud rate at which the terminal receives and transmits
data. If the input and output rates are the same, specify
/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:
50 150 1800 4800 38400
75 300 2000 7200 57600
110 600 2400 9600 76800
134 1200 3600 19200 115200
45.2.55 /SWITCH
/SWITCH=DECNET
On VAX, causes the terminal lines at each node to be switched
to dynamic asynchronous DDCMP lines, when specified with
the /PROTOCOL=DDCMP qualifier. Note that /SWITCH=DECNET is a
permanent characteristic; therefore, the /PERMANENT qualifier is
not required.
45.2.56 /SYSPASSWORD
/SYSPASSWORD
/NOSYSPASSWORD (default)
Requires LOG_IO (logical I/O) privilege.
Determines whether the terminal requires that a system password
be entered before the Username: prompt.
45.2.57 /TAB
/TAB
/NOTAB
Controls whether tab characters are converted to multiple blanks.
The /NOTAB qualifier expands all tab characters to blanks and
assumes tab stops at 8-character intervals. The default is device
dependent.
45.2.58 /TTSYNC
/TTSYNC (default)
/NOTTSYNC
Controls whether transmitting to the terminal is stopped when
Ctrl/S is pressed and resumes transmission when Ctrl/Q is
pressed.
45.2.59 /TYPE_AHEAD
/TYPE_AHEAD (default)
/NOTYPE_AHEAD
Controls whether the terminal accepts unsolicited input to the
limit of the type-ahead buffer.
When you specify the /NOTYPE_AHEAD qualifier, the terminal
accepts input only when a program or the system issues a read
to the terminal, such as for user input at the DCL prompt ($).
When you specify the /TYPE_AHEAD qualifier, the amount of data
that can be accepted is governed by the size of the type-ahead
buffer. That size is determined by system generation parameters.
45.2.60 /UNKNOWN
Specifies a terminal type that is unknown to the system, which
then uses the default terminal characteristics for unknown
terminals.
45.2.61 /UPPERCASE
/UPPERCASE
/NOUPPERCASE
Controls whether lowercase characters are translated to
uppercase. The /UPPERCASE qualifier is equivalent to the
/NOLOWERCASE qualifier.
45.2.62 /WIDTH
/WIDTH=characters-per-line
Specifies the maximum characters per line. This value must be
an integer in the range 1 to 511. With the /WRAP qualifier, the
terminal generates a carriage return and line feed when the width
specification is reached.
If the specified width on an ANSI terminal is 132, the screen is
set to 132-character mode. If the terminal does not have advanced
video option (AVO), the page length limit is set to 14 lines.
45.2.63 /WRAP
/WRAP (default)
/NOWRAP
Controls whether a carriage return and line feed are generated
when the value of the /WIDTH qualifier is reached.
45.3 – Examples
1.$ SET TERMINAL/DEVICE=VT102
In this example, the SET TERMINAL command establishes the
current terminal as a VT102 terminal and sets the default
characteristics for that terminal type.
2.$ SET TERMINAL/WIDTH=132/PAGE=60/NOBROADCAST
$ TYPE MEMO.DOC
.
.
.
$ SET TERMINAL/DEVICE=LA36
In this example, the first SET TERMINAL command indicates
that the width of terminal lines is 132 characters and that
the size of each page is 60 lines. The /NOBROADCAST qualifier
disables the reception of broadcast messages while the terminal
is printing the file MEMO.DOC. The next SET TERMINAL command
restores the terminal to its default state.
46 – TIME
Resets the system clock, which is used as a timer to record
intervals between various internal events and as a source clock
for displaying the time of day.
Requires both OPER (operator) and LOG_IO (logical I/O)
privileges.
Format
SET TIME[=time]
46.1 – Parameter
time
Specifies a date in the format day-month-year, or a time in the
format hour:minute:second.hundredth, or both. These fields accept
the following values:
Field Type Values
Day Integer 1 to 31
Month String JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP,
OCT, NOV, or DEC
Year Integer 1858 to 9999
Hour Integer 0 to 23
Minute Integer 0 to 59
Second Integer 0 to 59
Hundredth Integer 0 to 99
The hyphens (-), colons (:), and period (.) are required
delimiters. Separate the date and time, when both are specified,
with a colon. The syntax is sometimes specified as follows:
[dd-mmm-yyyy[:]] [hh:mm:ss.cc]
Alpha systems also allow a 2-digit year format:
[dd-mmm-yy[:]] [hh:mm:ss.cc]
The century applied to the 2-digit year format is determined by
the corresponding year in the supported Alpha date range (1957-
2056). A 2-digit year in the range 57-99 is assumed to mean the
years 1957-1999; a 2-digit year in the range 00-56 is assumed to
mean the years 2000-2056. (To specify years outside the 1957-2056
range, you must enter a 4-digit year.)
If the explicit time value is not specified, the interval system
clock is automatically reset according to the time-of-year clock.
For further information about the time-of-year clock, see the
hardware documentation for your computer.
NOTE
Alpha systems maintain system time during power failures
and system down time. When a system is booted, if the time
is known to be earlier than the time value of the last time
modification, or greater than five years in the future, you
are prompted to enter the time at the console prompt.
46.2 – Description
Resets the system clock, which is used as a timer to record
intervals between various internal events and as a source clock
for displaying the time of day.
NOTE
The SET TIME command will not work if there is a time
service available on your system or OpenVMS Cluster.
46.3 – Qualifier
46.3.1 /CLUSTER
Requires OPER and LOG_IO privilege, and in an OpenVMS Cluster
environment, SYSLCK privilege.
Sets the time on all nodes in a cluster to the same system time.
The format of the SET TIME /CLUSTER command is the following:
Format
SET TIME[=time] [/CLUSTER]
46.4 – Examples
1.$ SET TIME=14-DEC-2001:19:31:0.0
The SET TIME command in this example sets the date and time to
December 14, 2001, 7:31 P.M.
2.$ SET TIME
$ SHOW TIME
14-DEC-2001 03:21:27.53
The SET TIME command in this example sets the system time
according to the time-of-year clock. The SHOW TIME command
requests a display of the current time.
3.$ SET TIME=14-DEC-2001:15:31:0.0/CLUSTER
This example sets the date and time to December 14, 2001, 3:31
P.M. on all nodes in the cluster where the command was entered.
47 – VERIFY
Controls whether command lines and data lines in command
procedures are displayed at the terminal or are printed in
a batch job log. The information displayed by the SET VERIFY
command can help you in debugging command procedures.
Format
SET VERIFY [=([NO]PROCEDURE, [NO]IMAGE)]
SET NOVERIFY
47.1 – Parameter
([NO]PROCEDURE, [NO]IMAGE)
Specifies one or both types of verification. Procedure
verification causes each DCL command line in a command procedure
to be written to the output device. Image verification causes
data lines (input data that is included as part of the SYS$INPUT
input stream) to be written to the output device.
By default, both types of verification are set or cleared with
SET VERIFY and SET NOVERIFY. If you specify only one keyword, the
other is not affected. If you specify only one keyword, omit the
parentheses.
47.2 – Examples
1.$ SET VERIFY = PROCEDURE
In this example, procedure verification is turned on. If image
verification was on, it remains on; if image verification was
off, it remains off.
2.$ SET VERIFY
$ INDEX == "$INDEX.EXE"
$ CONTENTS == "$CONTENTS.EXE"
$ TABLE == "$TABLE.EXE"
$ SET NOVERIFY
$ EXIT
Procedure and image verification are turned on at the beginning
of the command procedure so that the system displays all the
command and data lines in the procedure as it reads them. At
the end of the procedure, the SET NOVERIFY command restores the
system default (no procedure or image verification).
3.$ PROC_VER = F$ENVIRONMENT("VERIFY_PROCEDURE")
$ IMAGE_VER = F$ENVIRONMENT("VERIFY_IMAGE")
$ HOLD_PREFIX = F$ENVIRONMENT("VERIFY_PREFIX")
$ SET PREFIX "(!%T)"
$ SET VERIFY
.
.
.
$ TEMP = F$VERIFY(PROC_VER, IMAGE_VER)
$ SET PREFIX "''HOLD_PREFIX'"
This command procedure uses the F$ENVIRONMENT lexical function
to save the current procedure and image verification setting,
as well as the current verification prefix string. The SET
PREFIX command sets the verification prefix to be used in
the current command procedure. It uses an FAO control string
to produce the time each command is read by the command
interpreter (DCL), surrounded by parentheses. Then the SET
VERIFY command turns on both procedure and image verification.
Subsequently, the F$VERIFY lexical function is used to restore
the original verification settings. The SET PREFIX command
returns the verification prefix to its previous setting. Note
how the symbol HOLD_PREFIX is used in the SET PREFIX command.
This preserves casing and special characters in the stored
string.
4.$ SET VERIFY
$ @TEST
$ RUN AVERAGE
1
2
3
$ EXIT
In this example, the SET VERIFY command turns procedure and
image verification on. When the command procedure TEST.COM is
executed interactively, the command lines and the data lines
for the program AVERAGE are displayed on the terminal. The data
lines were entered in the command procedure on lines that did
not begin with the DCL prompt.
5.$ SET VERIFY
$ COUNT = 1
$ IF P'COUNT' .NES. "" THEN GOTO &P'COUNT'
.
.
.
$ EXIT
When this command procedure is executed interactively, the
SET VERIFY command causes the command and data lines to be
displayed. Symbols that are substituted during the first
phase of symbol substitution (such as 'COUNT') are displayed
by the SET VERIFY command, but other symbols are not. The
following lines are displayed when this procedure is executed
interactively:
$ COUNT = 1
$ IF P1 .NES. "" THEN GOTO &P1
.
.
.
Although these values are not displayed, the value for P1 is
substituted during the third phase of symbol substitution, and
the value for &P1 is substituted during the second phase.
48 – VOLUME
Changes the characteristics of one or more mounted Files-11
volumes. The SET VOLUME command affects only the node on which
the command is issued, and will not affect any other nodes, even
when a volume is mounted on multiple nodes in an OpenVMS Cluster
configuration.
If you are not the owner of the volume, requires control access
to the volume.
Format
SET VOLUME device-name[:][,...]
48.1 – Parameter
device-name[:][,...]
Specifies the name of one or more mounted Files-11 volumes.
48.2 – Qualifiers
48.2.1 /ACCESSED
/ACCESSED[=n]
Requires OPER (operator) privilege.
Specifies the number of directories to be maintained in system
space for ready access. You can specify a value n in the range
of 0 to 255. If you specify the qualifier /ACCESSED and omit
the number of directories, a default value of 3 is used. If you
specify a value greater than the current value, the new value is
effective immediately; otherwise, the new value is not effective
until the next time the volume is mounted.
48.2.2 /CACHE
/CACHE=(option[,...])
Enables or disables XFC caching for the volume. If CLEAR_DATA
option is specified, then contents of the volume already in cache
are cleared. (If you do not specify the /CACHE qualifier, XFC
caching attributes of the volume as well as the contents of
the volume already in cache are not affected.) Keywords are as
follows:
Keyword Description
DATA Enables XFC caching for the volume.
[NO]DATA Disables XFC caching for the volume.
CLEAR_DATA Clears contents of the volume present in the XFC
cache (if any).
48.2.3 /DATA_CHECK
/DATA_CHECK[=(option[,...])]
Defines a default for data check operations following all read
and write operations to the specified volume. (If you do not
specify the /DATA_CHECK qualifier, no checks are made.) Keywords
are as follows:
[NO]READPerforms checks following all read operations.
[NO]WRITPerforms checks following all write operations (default).
48.2.4 /ERASE_ON_DELETE
/ERASE_ON_DELETE
/NOERASE_ON_DELETE (default)
Determines whether the space occupied by a file is overwritten
with a system-specified pattern when a file on the volume is
deleted.
48.2.5 /EXTENSION
/EXTENSION[=n]
Specifies the number of blocks to be used as a default extension
size for all files on the volume. You can specify a value n in
the range of 0 to 65,535. If you specify the /EXTENSION qualifier
without specifying a value, a default value of 0 (the OpenVMS RMS
default) is used.
For example, during an update operation, the extension default
is used when a file increases to a size greater than its initial
default allocation.
48.2.6 /FILE_PROTECTION
/FILE_PROTECTION=(ownership[:access][,...])
Sets the default protection to be applied to all files on the
specified disk volume. Specify the ownership parameter as system
(S), owner (O), group (G), or world (W) and the access parameter
as read (R), write (W), execute (E), or delete (D). A null access
specification means no access.
NOTE
This attribute is not used while the volume is in use on an
OpenVMS system, but the attribute is provided to control
the process use of the volume on RSX-11M systems. The
OpenVMS system always uses the default file protection;
the protection can be changed with the DCL command SET
PROTECTION/DEFAULT.
48.2.7 /HIGHWATER_MARKING
/HIGHWATER_MARKING
/NOHIGHWATER_MARKING
Determines whether the file highwater mark (FHM) volume attribute
is set. The FHM attribute guarantees that a user cannot read data
that was not written by the user. Applies to Files-11 On-Disk
Structure Level 2 (ODS-2) and 5 (ODS-5) volumes only.
48.2.8 /LABEL
/LABEL=volume-label
Specifies a 1- to 12-character ANSI name to be encoded on the
volume. The specified label remains in effect until it is changed
explicitly; dismounting the volume does not affect the label. VSI
strongly recommends that a volume label should consist of only
alphanumeric characters, dollar signs ($), underscores (_), and
hyphens (-).
NOTE
Changing the volume label does not change other structures
that used the original volume label. For example, the
DISK$label logical volume name is not changed nor is the
device-lock name that is kept internally by OpenVMS. As a
result, if you attempt to access another disk that has the
same volume label as the original volume of this device,
you may get error messages such as the following: "%MOUNT-F-
VOLALRMNT, another volume of same label already mounted".
VSI recommends that, if you change a disk volume label,
you also dismount and remount the disk on all nodes in the
cluster so that the names and locks are consistent.
If you change the volume label on a nonsystem disk and the
PRODUCT INSTALL command has been used to install software
products on that disk, you must update the software product
database to reflect this change. To accomplish this, first
dismount and remount the disk. Then use the PRODUCT REGISTER
VOLUME command to replace all occurrences of the old DISK$label
with the new logical volume name that was created by the MOUNT
command.
NOTE
You do not need to take this action when you change
the label of the system disk. The POLYCENTER Software
Installation Utility continues to use the old logical
volume name until the system is rebooted. After reboot (when
the system disk is remounted), the utility automatically
identifies the system disk using its new logical volume
name.
48.2.9 /LIMIT
/LIMIT[=n]
Specifies that the volume is to be enabled for volume expansion.
n specifies the upper limit of the expansion (in blocks). If no
value is specified, the maximum expansion potential is set up.
The maximum expansion size depends on the cluster size defined
for the volume using the INITIALIZE/CLUSTER_SIZE command. If
the cluster size is 8 or more, the current maximum expansion
supported on OpenVMS (1TB) is set up. If the cluster size is less
than 8, the expansion limit is set to 65535*4096*Cluster-size
because the maximum size of the bitmap is 65535 blocks. For more
information about volume expansion, see the VSI Volume Shadowing
for OpenVMS manual.
This command must be executed while the disk is mounted
privately.
If you add additional physical storage in the future, you can use
the /SIZE qualifier to increase the volume size.
48.2.10 /LOG
/LOG
/NOLOG (default)
Determines whether the volume specification of each volume is
displayed after the modification.
48.2.11 /MOUNT_VERIFICATION
/MOUNT_VERIFICATION
/NOMOUNT_VERIFICATION
Determines whether mount verification is enabled. Mount
verification prevents interruption to user input/output
operations and notifies the operator of problems with the disk.
48.2.12 /OWNER_UIC
/OWNER_UIC[=uic]
Sets the owner user identification code (UIC) of the volume
to the specified UIC. The default UIC is that of the current
process. Brackets ([]) are required around the UIC. Specify the
UIC by using standard UIC format as described in the VSI OpenVMS
Guide to System Security.
48.2.13 /PROTECTION
/PROTECTION=(ownership[:access][,...])
Specifies the protection to be applied to the volume. The
following rules apply:
o Specify the ownership parameter as system (S), owner (O),
group (G), or world (W).
o Specify the access parameter as read (R), write (W), create
(C), or delete (D).
The default protection is all types of access by all categories
of user.
48.2.14 /REBUILD
/REBUILD[=FORCE]
Recovers caching limits for a volume that was dismounted
improperly. If a disk volume was dismounted improperly (such
as during a system failure), and was then remounted with the
MOUNT/NOREBUILD command, you can use SET VOLUME/REBUILD to
recover the caching that was in effect at the time of the
dismount. The FORCE option forces the disk to be rebuilt
unconditionally, thus updating the free block count in the disk
volume's lock value block.
48.2.15 /RETENTION
/RETENTION=(min[,max])
Specifies the minimum and maximum retention times to be used by
the file system to determine the expiration date for files on
the volume. When a file is created, its expiration date is set
to the current time plus the maximum time. Each time the file is
accessed, the current time is added to the minimum time. If the
sum is greater than the expiration date, a new expiration date is
computed.
If you omit the maximum value, a default value that
is the smaller of (2 x min) or (min + 7) days is
used. For example, /RETENTION=3- is the same as
/RETENTION=(3-,6-), while /RETENTION=10- is the same as
/RETENTION=(10-,17-).
The command SET VOLUME/RETENTION=0 disables retention times on
the volume.
48.2.16 /SIZE
/SIZE[=nnn]
Specifies the amount of disk space (in blocks) that is usable for
the file system. This value must be greater than the current
logical volume size and less than or equal to the physical
size of the disk or the expansion limit (specified by /LIMIT),
whichever is smaller.
If the value is omitted, the usable space is increased to the
physical size of the disk or the expansion limit, whichever is
smaller.
48.2.17 /STRUCTURE_LEVEL
/STRUCTURE_LEVEL=n
Sets the structure level of the volume. Use the value 5 to set
the volume to ODS-5.
When the /STRUCTURE_LEVEL qualifier is used with other
qualifiers, the volume structure level is set prior to the other
qualifiers being performed.
You cannot use the SET VOLUME command to change a volume from
ODS-5 to ODS-2. To reset a volume to ODS-2, see the instructions
in the VSI OpenVMS System Manager's Manual, Volume 1: Essentials.
48.2.18 /SUBSYSTEM
/SUBSYSTEM
/NOSUBSYSTEM
Enables the processing of subsystem ACEs. Requires the SECURITY
privilege. By default, the disk from which you boot has protected
subsystems enabled but other disks do not. For further details on
subsystems, see the VSI OpenVMS Guide to System Security.
48.2.19 /UNLOAD
/UNLOAD (default)
/NOUNLOAD
Specifies whether the volume is unloaded (spun down) when the DCL
command DISMOUNT is entered.
48.2.20 /USER_NAME
/USER_NAME[=user-name]
Specifies a user name of up to 12 alphanumeric characters to be
recorded on the volume. The default name is the current process
user name.
48.2.21 /VOLUME_CHARACTERISTICS
/VOLUME_CHARACTERISTICS=([[NO]HARDLINKS,] [[NO]ACCESS_
DATES[=delta-time]])
Enables or disables hardlinks and automatic updates of access
dates on ODS-5 volumes.
To limit the performance impact if a file is accessed frequently,
you can suppress update of the access time if the change is
small. A delta time is used to determine when a new access time
is significant. The default value for delta-time is 1 second,
chosen to comply with the "seconds since EPOCH" time interface
required by POSIX st_atime. A site can choose a larger delta time
to reduce overhead if 1-second granularity is not required.
To disable access date support on a volume, use the SET
VOLUME/VOLUME_CHARACTERISTICS=NOACCESS_DATES command. This
command affects only the node on which the command is issued.
Other nodes are not affected by the change until the next time
the volume is mounted.
For additional information about ODS-5 volumes, see the Guide to
OpenVMS File Applications and to the sections about File Service
Extensions in the OpenVMS Alpha Version 7.3-1 New Features and
Documentation Overview. This archived manual is on the OpenVMS
documentation Web site:
http://www.hp.com/go/openvms/doc
Click on "Archived documents" in the left sidebar to link to this
manual.
48.2.22 /WINDOWS
/WINDOWS[=n]
Specifies the number of mapping pointers to be allocated for file
windows.
The value of n can be from 7 to 80; the default value is 7.
48.2.23 /WRITETHROUGH
/WRITETHROUGH
/NOWRITETHROUGH
This qualifier only affects applications such as PATHWORKS that
can request deferred writes to file headers. You use it to
control whether these applications can use the deferred write
feature.
Use /NOWRITETHROUGH to allow these applications to use the
deferred write feature. When one of these applications explicitly
requests a deferred write when updating a file header, control
returns to the application when the I/O request has been queued;
the application does not have to wait until the data is on disk.
Note that although the SHOW DEVICES/FULL command shows the volume
status as write-back caching enabled, the extended file cache
(XFC) will still be in write-through mode.
Use /WRITETHROUGH to disable the deferred write feature, so that
no applications can use it. The SHOW DEVICES/FULL command shows
the volume status as write-through caching enabled.
The deferred write feature is not available on Files-11 ODS-1
volumes.
48.3 – Examples
1.$ SET VOLUME/DATA_CHECK=(READ,WRITE) DKA5
The SET VOLUME command in this example requests that data
checks be performed following all read and write operations
to DKA5.
2.$ SET VOLUME/FILE_PROTECTION=(S:RWED,O:RWED,G:RE,W:RE) DKA5
The SET VOLUME command in this example sets the default
protection to be applied to all files created on volume DKA5.
System (S) and owner (O) are granted all types of access;
group (G) and world (W) are permitted only to read and execute
files on DKA5.
3.$ SET VOLUME/LABEL=LICENSES DKA5
The SET VOLUME command in this example encodes the label
LICENSES on the volume DKA5. Note that if characters in labels
are entered in lowercase, they are changed to uppercase by the
/LABEL qualifier.
4.$ SET VOLUME/ACCESSED=25/USER_NAME=MANAGER/LOG DKA0:
The SET VOLUME command in this example specifies that 25
directories are to be maintained in system space for ready
access for the volume DKA0. The command also assigns the
user name MANAGER to the volume and displays the volume
specification after the volume is modified.
5.$ SET VOLUME/REBUILD/LOG NODE$DKA2:
%SET-I-MODIFIED, _NODE$DKA2: modified
The SET VOLUME command in this example causes a rebuild
operation to begin on the volume that is mounted on NODE$DKA2.
The /LOG qualifier directs the SET VOLUME command to display a
notification message.
6.$ DISMOUNT/CLUSTER/NOUNLOAD $252$DUA716:
$ MOUNT $252$DUA716: TST716
$ SET VOLUME/LIMIT $252$DUA716:
$ DISMOUNT/NOUNLOAD $252$DUA716:
$ MOUNT/CLUSTER $252$DUA716: TST716
This example shows how to increase the expansion limit of a
volume mounted in a cluster.
7.$ SET VOLUME SYS$DISK/VOLUME_CHARACTERISTICS=NOHARDLINKS
This command disables hard links on SYS$DISK.
8.$ SET VOLUME $DKA100/CACHE=CLEAR_DATA
This command clears the contents of the volume $DKA100 present
in the XFC cache (if any). The caching mode of the volume
$DKA100 is not altered.
9.$ SET VOLUME $DKA100/CACHE=DATA
This command enables XFC caching for the volume $DKA100. The
contents of the volume $DKA100 already present in the XFC cache
is not affected in anyway.
10$ SET VOLUME $DKA100/CACHE=(DATA,CLEAR_DATA)
This command enables XFC caching for the volume $DKA100 and
clears the contents of the volume $DKA100 present in the XFC
cache (if any).
49 – WORKING_SET
Redefines the default working set size for the process, or sets
an upper limit to which the working set size can be changed by an
image that the process executes. Working set limits cannot be set
to exceed those defined in the user authorization file (UAF).
Specify the value of n as a number of 512-byte pagelets on Alpha.
Note that the OpenVMS system rounds up this value to the nearest
CPU-specific page so that the actual amount of physical memory
allowed may be larger than the specified amount on Alpha.
Format
SET WORKING_SET
49.1 – Qualifiers
49.1.1 /ADJUST
/ADJUST (default)
/NOADJUST
Controls whether the system can automatically adjust the size of
the process working set.
49.1.2 /EXTENT
/EXTENT=n
Specifies the maximum number of physical pages that can be
resident in the working set during image execution.
The extent value must be greater than the minimum working set
defined at system generation, and it must be less than or equal
to the authorized extent defined in the UAF.
If you specify a value greater than the authorized extent, the
command sets the working set limit at the maximum authorized
value.
49.1.3 /LIMIT
/LIMIT=n
Specifies the size to which the working set is to be reduced at
image exit.
If you specify a value greater than the current quota, the quota
value is also increased.
49.1.4 /LOG
/LOG
/NOLOG (default)
Determines whether confirmation of the SET WORKING_SET command is
displayed.
49.1.5 /QUOTA
/QUOTA=n
Specifies the maximum number of physical pages that any image
executing in the process context can request. An image can set
the working set size for the process by calling the $ADJWSL
(Adjust Working Set Limit) system service.
If you specify a quota value that is greater than the authorized
quota, the working set quota is set to the authorized quota
value.
49.2 – Examples
1.$ SHOW WORKING_SET
Working Set /Limit= 150 /Quota= 700 /Extent= 700
Adjustment enabled Authorized Quota= 700 Authorized Extent= 700
$ SET WORKING_SET/QUOTA=1000
%SET-I-NEWLIMS, new working set: Limit = 150 Quota = 700 Extent = 700
The SHOW WORKING_SET command in this example displays the
current limit, quota, and extent, as well as the authorized
quota and authorized extent. The SET WORKING_SET command
attempts to set a quota limiting the maximum number of pages
any image can request that is greater than the authorized
quota. Note from the response that the quota was not increased.
2.$ SHOW WORKING_SET
Working Set /Limit= 150 /Quota= 350 /Extent= 350
Adjustment enabled Authorized Quota= 350 Authorized Extent= 350
$ SET WORKING_SET/LIMIT=100
%SET-I-NEWLIMS, new working set: Limit = 100 Quota = 350 Extent = 350
$ SHOW WORKING_SET
Working Set /Limit= 100 /Quota= 350 /Extent= 350
Adjustment enabled Authorized Quota= 350 Authorized Extent= 350
The SET WORKING_SET command in this example sets the working
set size for any image in the process to 100.