Order Number: AA-R8EXD-TE

This manual contains the command reference information for HSM and Media and Device Management Services (MDMS).

Compaq Computer Corporation
Houston, Texas

Preface vii

1 The HSM Command Environment

1.1 DCL Commands 1-3

DIRECTORY 1-4

HSM$BACKUP 1-5

PRESHELVE 1-7

SET FILE 1-10

SET PROCESS 1-11

SHELVE 1-12

UNPRESHELVE 1-15

UNSHELVE 1-18

1.2 The Shelf Management Utility 1-20

1.3 Shelf Management Utility Commands 1-21

SMU ANALYZE 1-22

SMU CHECKPOINT 1-25

SMU COPY 1-27

SMU EXIT 1-29

SMU HELP 1-30

SMU LOCATE 1-31

SMU RANK 1-35

SMU REPACK 1-37

SMU SET ARCHIVE 1-41

SMU SET CACHE 1-44

SMU SET DEVICE 1-47

SMU SET FACILITY 1-51

SMU SET POLICY 1-53

SMU SET SCHEDULE 1-58

SMU SET SHELF 1-60

SMU SET VOLUME 1-64

SMU SHOW ARCHIVE 1-68

SMU SHOW CACHE 1-70

SMU SHOW DEVICE 1-71

SMU SHOW FACILITY 1-73

SMU SHOW POLICY 1-74

SMU SHOW REQUESTS 1-76

SMU SHOW SCHEDULE 1-77

SMU SHOW SHELF 1-79

SMU SHOW VERSION 1-81

SMU SHOW VOLUME 1-82

SMU SHUTDOWN 1-84

SMU SPAWN 1-85

SMU STARTUP 1-86

2 MDMS DCL Commands

MDMS ALLOCATE DRIVE 2-2

MDMS ALLOCATE VOLUME 2-6

MDMS BIND VOLUME 2-10

MDMS CANCEL REQUEST 2-12

MDMS CREATE DRIVE 2-14

MDMS CREATE GROUP 2-18

MDMS CREATE JUKEBOX 2-20

MDMS CREATE LOCATION 2-25

MDMS CREATE MAGAZINE 2-27

MDMS CREATE MEDIA_TYPE 2-30

MDMS CREATE NODE 2-32

MDMS CREATE POOL 2-36

MDMS CREATE VOLUME 2-38

MDMS DEALLOCATE DRIVE 2-46

MDMS DEALLOCATE VOLUME 2-47

MDMS DELETE DRIVE 2-49

MDMS DELETE GROUP 2-50

MDMS DELETE JUKEBOX 2-51

MDMS DELETE LOCATION 2-52

MDMS DELETE MAGAZINE 2-53

MDMS DELETE MEDIA_TYPE 2-54

MDMS DELETE NODE 2-55

MDMS DELETE POOL 2-56

MDMS DELETE VOLUME 2-57

MDMS INITIALIZE VOLUME 2-58

MDMS INVENTORY JUKEBOX 2-61

MDMS LOAD DRIVE 2-64

MDMS LOAD VOLUME 2-66

MDMS MOVE MAGAZINE 2-68

MDMS MOVE VOLUME 2-71

MDMS REPORT VOLUME 2-74

MDMS SET DOMAIN 2-78

MDMS SET DRIVE 2-82

MDMS SET GROUP 2-85

MDMS SET JUKEBOX 2-87

MDMS SET LOCATION 2-91

MDMS SET MAGAZINE 2-93

MDMS SET MEDIA_TYPE 2-95

MDMS SET NODE 2-97

MDMS SET POOL 2-100

MDMS SET SERVER 2-102

MDMS SET VOLUME 2-103

MDMS SHOW DOMAIN 2-110

MDMS SHOW DRIVE 2-112

MDMS SHOW GROUP 2-114

MDMS SHOW JUKEBOX 2-116

MDMS SHOW LOCATION 2-118

MDMS SHOW MAGAZINE 2-120

MDMS SHOW MEDIA_TYPE 2-122

MDMS SHOW NODE 2-124

MDMS SHOW POOL 2-126

MDMS SHOW REQUEST 2-128

MDMS SHOW SERVER 2-130

MDMS SHOW VERSION 2-132

MDMS SHOW VOLUME 2-133

MDMS - Start An MDMS Session 2-137

MDMS UNBIND VOLUME 2-139

MDMS UNLOAD DRIVE 2-141

MDMS UNLOAD VOLUME 2-142

A MDMS Files and Logical Names

A.1 MDMS File Names A-1

A.2 MDMS Logical Names A-3

B MDMS Rights and Privileges

B.1 MDMS Rights - Types B-1

B.1.1 High Level Rights B-1

B.1.2 Low-level rights B-2

B.1.3 ABS Rights B-4

B.2 Default High-Level to Low-Level Mapping B-5

B.2.1 MDMS_USER: B-5

B.2.2 MDMS_OPERATOR Rights: B-6

B.2.2.1 Domain Commands for Mapping Privileges B-6

Preface

1

Format

Parameters

[file_spec[,...]]

Specifies one or more files. To specify two or more files, separate them with commas. Wildcard characters are allowed.

Qualifiers

/SELECT=keyword

The /SELECT qualifier accepts the following additional keywords:

[NO]ONLINE The ONLINE keyword selects files that are online or preshelved.
The NOONLINE keyword selects files that are shelved.

[NO]SHELVABLE The SHELVABLE keyword selects files that are shelvable.
The NOSHELVABLE keyword selects files that are not
shelvable, as set by the SET FILE /NOSHELVABLE command.

/SHELVED_STATE

Displays the state of the file as shelved or online. Preshelved files are displayed as online.

Example

The following example shows the DIRECTORY /SHELVED_STATE command:

$ DIRECTORY /SHELVED_STATE

DIRECTORY MYDISK:[SMITH]

MYFILE.TXT;2 Online
NOT_SHELVED.TXT;1 Online
SHELVED.TXT;1 Shelved

Format

HSM$BACKUP input_spec output_spec

Parameters

input_spec

Specifies files to be backed up, or source saveset for a restore operation.

output_spec

Specifies destination output spec for files to be backed up, or destination location for files on a restore.

Qualifiers

/PRESHELVED (default)

/NOPRESHELVED

/NOPRESHELVED backs up only the headers of preshelved files. /PRESHELVED (default) backs up the data of preshelved files. This is applicable to IMAGE and file backup operations and not applicable to restore.

/SHELVED (default)

/NOSHELVED

/NOSHELVED backs up only the headers of shelved files. SHELVED (default) unshelves the file and backs up the data. Applicable to non-image backup operations; not applicable to restore.

Examples

The following example shows how to use HSM$BACKUP to perform image and incremental backups, which back up only the headers of shelved and preshelved files.

$ SET COMMAND SYS$SYSTEM:HSM$BACKUP.CLD
$ HSM$BACKUP/IMAGE/IGNORE=INTERLOCK/RECORD/LOG/NOPRESHELVED - $ $1$DKA100: $1$MUA100:DKA100_AUG23_IMAGE.BCK/SAVESET
$ HSM$BACKUP/RECORD/SINCE=BACKUP/LOG/NOSHELVED/NOPRESHELVED - $ $1$DKA100: $1$MUA100:DKA100_AUG24.BCK/SAVESET

The following example shows how to use HSM$BACKUP to copy shelved file data from one disk to a saveset on another using /IMAGE. The /INITIALIZE qualifier on the output disk is required.

$ MOUNT/FOREIGN $12$DKA400:
$ HSM$BACKUP/IMAGE/IGNORE=INTERLOCK/RECORD/NOPRESHELVED/LOG - $ $1$DKA100: $12$DKA400:DKA100_AUG30_IMAGE.BCK/SAVESET/INITIALIZE

Format

PRESHELVE file_spec[,...]

Parameters

file_spec[,...]

Specifies one or more files to be preshelved. If two or more files are specified, separate them with commas. Wildcard characters are allowed.

Qualifiers

/BACKUP

Uses the backup date for selection criteria when using the /BEFORE and /SINCE qualifiers. If a file has no backup date, it is not selected for the operation.

/BEFORE[=time]

Selects only those files dated prior to the specified time. Specify the time as an absolute time, a delta time, or a combination time, or as one of the following keywords:

TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

/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. If not specified, all UICs are eligible.

/CANCEL

Cancels any outstanding command requests for the files.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a question is asked before each PRESHELVE 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

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/CREATED

Uses the creation date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/EXCLUDE=(file_spec[,...])

Excludes the specified files from the command operation. Wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you provide only one file specification, you can omit the parentheses.

/EXPIRED

Uses the expiration date for selection criteria when using the /BEFORE and /SINCE qualifiers. The file expiration date is used in conjunction with the volume retention functionality.
When volume retention has been enabled for a volume, the expiration date is updated whenever a file is accessed (read or write). Each time a file is accessed, the current time is added to the minimum retention time. If the sum is greater than the current expiration date, a new expiration date is computed. Updating the expiration date depends on the settings of the retention time for the volume.

Refer the OpenVMS SET VOLUME/RETENTION command for further details.

If a file has no expiration date, it is not selected for the operation.

/KEEP[=number_of_versions]

Specifies that the latest n versions of the file are not processed. If /KEEP is specified without a number of versions value, then all versions of the file except the highest version are processed.

/LOG

/NOLOG (Default)

Specifies that a command acknowledgment is displayed. If the command is specified with the
/WAIT qualifier or if the shelf handler can process the command immediately, the log output contains the final result of the operation. If the command is specified with the /NOWAIT qualifier, a message indicating that the request is queued may be displayed on success for long-running operations.

/MODIFIED (Default)

Uses the modification date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/NOTIFY

/NONOTIFY (Default)

Specifies whether a message is sent to the user upon completion of the command operation for each file in the request. The message is sent to all terminals on which the user is logged-in that have BROADCAST enabled.

/SELECT=(keyword[,...])

Allows selection of files according to size or shelved state. Choose one of the following keywords:

SIZE=MAXIMUM=n Selects files that have fewer blocks than the value of n,
which defaults to 1,073,741,823. Use with MINIMUM=n to
specify a size range for files to be selected.

SIZE=MINIMUM=n Selects files that have blocks equal to or greater than the value
of n, which defaults to 0. Use with MAXIMUM=n to
specify a size range for files to be selected.

NOONLINE Selects only files that are shelved. Use this keyword
to copy shelved file data to additional archive classes.

ONLINE (Default) Selects only files that are online or preshelved. This is the
default file selection.

(ONLINE, NOONLINE) Selects files regardless of their shelved state.

By default, file selection is not based on file size criteria.

/SINCE[=time]

Selects only those files dated after the specified time. Specify the time as an absolute time, a delta time, or a combination time, or as one of the following keywords:

• TODAY (default),
• TOMORROW, or
• YESTERDAY.

Specify one of the following qualifiers with /SINCE to indicate the time attribute to be used as the basis for selection:

/BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

/WAIT (Default)

/NOWAIT

Specifies whether to wait for the operation to complete. The default is /WAIT. Files moved to the cache typically take the same amount of time as a similar COPY command. Files shelved directly to nearline/offline storage may take anywhere from tens of seconds to tens of minutes. Multiple files take correspondingly longer.

Example

The following example shows the PRESHELVE/NOTIFY command:

$ PRESHELVE/NOTIFY JLRM_DATA.DAT
%HSM-S-PRESHELVED, file $1$DKA0:[BUTLER.DB_FILES]JLRM_DATA.DAT;1 preshelved

Format

Parameters

Qualifiers

/SHELVABLE

/NOSHELVABLE

The /SHELVABLE qualifier sets the file named by file_spec to be shelvable. By default, all user files are shelvable. Use the /NOSHELVABLE qualifier to prevent the file from being shelved or preshelved.

Example

The following example shows the SET FILE /NOSHELVABLE command, which ensures that the file cannot be shelved or preshelved:

$ SET FILE /NOSHELVABLE AARDVARKS.TXT;3

Format

Parameters

Qualifiers

/AUTO_UNSHELVE (default)

/NOAUTO_UNSHELVE

The /AUTO_UNSHELVE qualifier enables the process to generate a file fault upon read, write, extend or truncate access to a shelved file. The process stalls while the file is unshelved, then proceeds normally.
The /NOAUTO_UNSHELVE qualifier disables file faults: accessing a shelved file returns an error message instead. By default, all processes are started with /AUTO_UNSHELVE enabled.

Example

The following example shows the SET PROCESS /AUTO_UNSHELVE command:

$ SET PROCESS /AUTO_UNSHELVE SMITH_1

Format

Parameters

Qualifiers

/BACKUP

Uses the backup date for selection criteria when using the /BEFORE and /SINCE qualifiers.
If a file has no backup date, it is not selected for the operation.

/BEFORE[=time]

Selects only those files dated prior to the specified time. Specify the time as an absolute time, a delta time, or a combination time, or as one of the keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

/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. If not specified, all UICs are eligible.

/CANCEL

Cancels any outstanding command requests for the files.

/CONFIRM
/NOCONFIRM (Default)

Controls whether a request is issued before each SHELVE 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

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/CREATED

Uses the creation date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/EXCLUDE=(file_spec[,...])

Excludes the specified files from the command operation. Wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you provide only one file specification, you can omit the parentheses.

/EXPIRED

Uses the expiration date for selection criteria when using the /BEFORE and /SINCE qualifiers. The file expiration date is used in conjunction with the volume retention functionality.
When volume retention has been enabled for a volume, the expiration date is updated whenever a file is accessed (read or write).
Each time a file is accessed, the current time is added to the minimum retention time. If the sum is greater than the current expiration date, a new expiration date is computed. Updating the expiration date depends on the settings of the retention times for the volume. Refer the OpenVMS SET VOLUME/RETENTION command for further details.
If a file has no expiration date, it is not selected for the operation.

/HIGH_PRIORITY

Specifies a request priority as HIGH. HSM pushes the request to the top of the queue of requests at that time. In case of multiple /HIGH requests, each request is moved to the top of the queue and execution starts with the latest /HIGH request. This prioritizing of requests does not affect urgent requests like:

• file faults
• make space requests

/KEEP[=number_of_versions]

Specifies that the latest n versions of the file are not processed. If /KEEP is specified without a number of versions value, then all versions of the file except the highest version are processed.

/LOG

/NOLOG (Default)

Specifies that a command acknowledgment is displayed. If the command is specified with the
/WAIT qualifier or if the shelf handler can process the command immediately, the log output contains the final result of the operation. If the command is specified with the /NOWAIT qualifier, a message indicating that the request is queued may be displayed on success for long-running operations.

/MODIFIED (Default)

Uses the modification date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/NOTIFY

/NONOTIFY (Default)

Specifies whether a message is sent to the user upon completion of the command operation for each file in the request. The message is sent to all terminals on which the user is logged-in that have BROADCAST enabled.

/SELECT=(keyword[,...])

Allows selection of files according to size or shelved state. Choose one of the following keywords:

SIZE=MAXIMUM=n Selects files that have fewer blocks than the value of n,
which defaults to 1,073,741,823. Use with MINIMUM=n to
specify a size range for files to be selected.

SIZE=MINIMUM=n Selects files that have blocks equal to or greater than the
value of n, which defaults to 0. Use with MAXIMUM=n to
specify a size range for files to be selected.

NOONLINE Selects only files that are shelved. Use this keyword
to copy shelved file data to additional archive classes.

ONLINE (Default) Selects only files that are online or preshelved. This is the
default file selection.

(ONLINE, NOONLINE) Selects files regardless of their shelved state.

By default, file selection is not based on file size criteria.

/SINCE[=time]

Selects only those files dated after the specified time.

Specify the time as an absolute time, a delta time, or a combination time, or as one of the keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /SINCE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

/WAIT (Default)

/NOWAIT

Specifies whether to wait for the operation to complete. The default is /WAIT. Files moved to the cache typically take the same amount of time as a similar COPY command. Files shelved directly to nearline/offline storage may take anywhere from tens of seconds to tens of minutes. Multiple files take correspondingly longer.

Example

The following example shows the SHELVE/NOTIFY command:

$ SHELVE/NOTIFY JLRM_DATA.DAT
%HSM-S-SHELVED, file $1$DKA0:[BUTLER.DB_FILES]JLRM_DATA.DAT;1 shelved

Format

Parameters

Qualifiers

/BACKUP

Uses the backup date for selection criteria when using the /BEFORE and /SINCE qualifiers.
If a file has no backup date, it is not selected for the operation.

/BEFORE[=time]

Selects only those files dated prior to the specified time. Specify the time as an absolute time, a delta time, or a combination time, or as one of the keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.
Time must be specified using the OpenVMS formats for absolute and delta times.

/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. If not specified, all UICs are eligible.

/CANCEL

Cancels any outstanding command requests for the files.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a request is issued before each UNSHELVE 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

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/CREATED

Uses the creation date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/EXCLUDE=(file_spec[,...])

Excludes the specified files from the command operation. Wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you provide only one file specification, you can omit the parentheses.

/EXPIRED

Uses the expiration date for selection criteria when using the /BEFORE and /SINCE qualifiers. The file expiration date is used in conjunction with the volume retention functionality. When volume retention has been enabled for a volume, the expiration date is updated whenever a file is accessed (read or write). Each time a file is accessed, the current time is added to the minimum retention time. If the sum is greater than the current expiration date, a new expiration date is computed. Updating the expiration date depends on the settings of the retention times for the volume. Refer the OpenVMS SET VOLUME/RETENTION command for further details.

If a file has no expiration date, it is not selected for the operation.

/LOG

/NOLOG (Default)

Specifies that a command acknowledgment is displayed. If the command is specified with the
/WAIT qualifier or if the shelf handler can process the command immediately, the log output contains the final result of the operation. If the command is specified with the /NOWAIT qualifier, a message indicating that the request is queued may be displayed on success for long-running operations.

/MODIFIED (Default)

Uses the modification date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/NOTIFY

/NONOTIFY (Default)

Specifies whether a message is sent to the user upon completion of the command operation for each file in the request. The message is sent to all terminals on which the user is logged-in that have BROADCAST enabled.

/SELECT=keyword[,...]

Allows selection of files according to size or shelved state. Choose one of the following keywords:

SIZE=MAXIMUM=n Selects files that have fewer blocks than the value of n, which
defaults to 1,073,741,823. Use with MINIMUM=n to
specify a range for files to be selected.

SIZE=MINIMUM=n Selects files that have blocks equal to or greater than the
value of n, which defaults to 0. Use with MAXIMUM=n to
specify a size range for files to be selected.

By default, file selection is not based on file size criteria.

/SINCE[=time]

Selects only those files dated after the specified time. Specify the time as an absolute time, a delta time, or a combination time, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /SINCE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

/WAIT (Default)

/NOWAIT

Specifies whether to wait for the operation to complete. The default is /WAIT. Files moved from the cache typically take the same amount of time as a similar COPY command. Files unshelved from nearline/offline storage may take anywhere from tens of seconds to tens of minutes. Multiple files take correspondingly longer.

Example

The following example shows the UNPRESHELVE/NOTIFY command:

$ UNPRESHELVE/NOTIFY JLRM_DATA.DAT
%HSM-S-UNPRESHELVED, file $1$DKA0:[BUTLER.DB_FILES]JLRM_DATA.DAT;1 unpreshelved

Format

Parameters

Qualifiers

/BACKUP

Uses the backup date for selection criteria when using the /BEFORE and /SINCE qualifiers. If a file has no backup date, it is not selected for the operation.

/BEFORE[=time]

Selects only those files dated prior to the specified time. Specify the time as an absolute time, a delta time, or a combination time, or as one of the keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

/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. If not specified, all UICs are eligible.

/CANCEL

Cancels any outstanding command requests for the files.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a request is issued before each UNSHELVE 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

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/CREATED

Uses the creation date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/EXCLUDE=(file_spec[,...])

Excludes the specified files from the command operation. Wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you provide only one file specification, you can omit the parentheses.

/EXPIRED

Uses the expiration date for selection criteria when using the /BEFORE and /SINCE qualifiers. The file expiration date is used in conjunction with the volume retention functionality. When volume retention has been enabled for a volume, the expiration date is updated whenever a file is accessed (read or write). Each time a file is accessed, the current time is added to the minimum retention time. If the sum is greater than the current expiration date, a new expiration date is computed. Updating the expiration date depends on the settings of the retention times for the volume. Refer the OpenVMS SET VOLUME/RETENTION command for further details.

If a file has no expiration date, it is not selected for the operation.

/HIGH_PRIORITY

Specifies a request priority as HIGH. HSM pushes the request to the top of the queue of requests at that time. In case of multiple /HIGH requests, each request is moved to the top of the queue and execution starts with the latest /HIGH request. This prioritizing of requests does not affect urgent requests like:

• file falults
• make space requests

/KEEP[=number_of_versions]

Specifies that the latest n versions of the file are not processed. If /KEEP is specified without a number of versions value, then all versions of the file except the highest version are processed.

/LOG

/NOLOG (Default)

Specifies that a command acknowledgment is displayed. If the command is specified with the
/WAIT qualifier or if the shelf handler can process the command immediately, the log output contains the final result of the operation. If the command is specified with the /NOWAIT qualifier, a message indicating that the request is queued may be displayed on success for long-running operations.

/MODIFIED (Default)

Uses the modification date for selection criteria when using the /BEFORE and /SINCE qualifiers.

/NOTIFY

/NONOTIFY (Default)

Specifies whether a message is sent to the user upon completion of the command operation for each file in the request. The message is sent to all terminals on which the user is logged-in that have BROADCAST enabled.

/OVERRIDE

Overrides the consistency checking performed by HSM and forces the file(s) to be unshelved. This qualifier requires BYPASS privilege on files with inconsistent HSM metadata.

Following an UNSHELVE/OVERRIDE, the file's data should be carefully checked for accuracy, because HSM detected an inconsistency between the online file state and the contents of the HSM catalog, and the file data may not be correct.

/SELECT=keyword[,...]

Allows selection of files according to size or shelved state. Choose one of the following keywords:

SIZE=MAXIMUM=n Selects files that have fewer blocks than the value of n,
which defaults to 1,073,741,823. Use with MINIMUM=n
to specify a size range for files to be selected.

SIZE=MINIMUM=n Selects files that have blocks equal to or greater than the
value of n, which defaults to 0. Use with MAXIMUM=n to
specify a size range for files to be selected.

By default, file selection is not based on file size criteria.

/SINCE[=time]

Selects only those files dated after the specified time. Specify the time as an absolute time, a delta time, or a combination time, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /SINCE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

/WAIT (Default)

/NOWAIT

Specifies whether to wait for the operation to complete. The default is /WAIT. Files moved from the cache typically take the same amount of time as a similar COPY command. Files unshelved from nearline/offline storage may take anywhere from tens of seconds to tens of minutes. Multiple files take correspondingly longer.

Example

The following example shows the UNSHELVE/NOTIFY command:

$ UNSHELVE/NOTIFY JLRM_DATA.DAT
%HSM-S-UNSHELVED, file $1$DKA0:[BUTLER.DB_FILES]JLRM_DATA.DAT;1 unshelved

Format

Parameters

Qualifiers

/CACHE={CACHE_DEVICE_LIST}

The /CACHE qualifier specifies that the SMU ANALYZE operation should run only on those files of the specified input volume that were cached to the device specified in /CACHE.
Different cache devices can be used at different points of time for a given volume.
For Analyze to run, files that have been cached to devices in the volume set list specified with the /CACHEqualifier, should be present in the device specified as the volume list.
/CACHE supports a comma separated volumeset list. A single volume is treated as a volumeset with one volume.

/CONFIRM

/NOCONFIRM (Default)

When the /REPAIR option is given, /CONFIRM prompts the user to allow repair of each file.
A default of "YES" or "NO" is provided for each confirmation, and this varies on the type of repair. The user can confirm each operation with (YES, 1, TRUE) to proceed for the specific repair, (NO, 0, FALSE) to inhibit the specific repair, (ALL) to proceed with the repair and subsequent repairs with the default confirm answer, and (^Z, QUIT) to stop the analysis/repair.
/NOCONFIRM does not prompt the user on repair and applies repairs with a default confirmation answer of "YES", and does not apply repairs with a default confirmation of "NO". The default is /NOCONFIRM. The following responses are valid:

YES NO QUIT
TRUE FALSE Crtl/Z
1 0 ALL

/OUTPUT[=file_specification]

The /OUTPUT qualifier specifies where to write the output of the command.
The default is /OUTPUT=SYS$OUTPUT. The output can optionally be sent to a file.
If /REPAIR/CONFIRM is specified with /OUTPUT=file_spec, the output is also sent to SYS$OUTPUT in order for the system manager perform the confirmation.
/CONFIRM questions are not sent to the output file, but always to SYS$OUTPUT.

By default, the output is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

/REPAIR

/NOREPAIR (Default)

The /REPAIR qualifier repairs the catalog entries and/or HSM metadata for consistency. Repairs are applied when the user specifies "YES" to a repair confirm question, or according to the default confirm answer when /NOCONFIRM or /CONFIRM answer "ALL" is entered. /NOREPAIR simply scans the files and reports errors, but no updates are made. The default is /NOREPAIR.

SMU ANALYZE/REPAIR command now repairs entries corresponding to PRESHELVED files whose online allocation size and the allocation size in the catalog do not match. If there is an allocation size mismatch and if the revision date of the online file and that recorded in the catalog are same then a new entry with the online allocation size is created for the file. Else the entry is marked unrepairable.

Examples

This example analyses volume $1$DKB500 with no repair:

$ SMU ANALYZE $1$DKB500:

This example analyses volume $1$DKB500 and applies the default repair. Note that this means that some errors are not repaired.

$ SMU ANALYZE/REPAIR $1$DKB500:

This example analyses volume $1$DKB500 and prompts the user for each repair. The default repair can be applied by entering <return> to each prompt. This is the only way that non-default repairs can be applied.

$ SMU ANALYZE/REPAIR/CONFIRM $1$DKB500:

The following examples demonstrate the use of /cache qualifier with SMU ANALYZE.

$ SMU ANALYZE dkb200,dka0 /cache=(dka100,dkb300)

$ smu show cache
Cache device _$1$DUA15: is enabled, Cache flush is held until after
11-JUN-1999 16:30:52.70, Backup is performed at flush intervals,
Cached files are held on delete of online file
Block size: 50000
Highwater mark: 80%
Flush interval: <none>
Cache device _$1$DUA17: is enabled, Cache flush is held until after
11-JUN-1999 16:28:28.64, Backup is performed at flush intervals,
Cached files are held on delete of online file
Block size: 50000
Highwater mark: 80%
Flush interval: <none>
$ shelve Y.Y;1
$ smu locate y.y;1/full
$1$DUA15:[000000]

Y.Y;1 (21,2,0)
File Shelved:
Y.Y;1 5/0 4-MAY-1999 19:23:50.19
Cache copy: _$1$DUA17:
Y.Y$9291950631;1 5/8 4-MAY-1999 19:23:50.19
Shelved on 12-JUN-1999 13:44:28.83

In the above example the file y.y;1 is cached in $1$dua17:

In the following example SMU ANALYZE without /CACHE is used if the header
information for this file is corrupted.

$ smu analyze $1$dua15
%SMU-I-PROCESSING, processing input device $1$DUA15
%SMU-I-STARTSCAN, scanning for shelved files on disk volume _$1$DUA15:
File (19,2,0) "$1$DUA15:[000000]Z.Z;16"
No catalog entry found - file not repairable
File (21,2,0) "$1$DUA15:[000000]Y.Y;1"
Allocation size mismatch - entry not repairable
Current: 0
Catalog: 8
%SMU-I-ENDSCAN, completed scan for shelved files on disk volume _$1$DUA15:
%SMU-I-ERRORS, 2 error(s) detected, 0 error(s) repaired
$ smu analyze $1$dua15/cache=$1$dua15
%SMU-I-PROCESSING, processing input device $1$DUA15
%SMU-I-STARTSCAN, scanning for shelved files on disk volume _$1$DUA15:
No catalog entry for Cached file...$1$DUA15:[000000]Z.Z;16
%SMU-I-ENDSCAN, completed scan for shelved files on disk volume _$1$DUA15:
%SMU-I-ERRORS, 0 error(s) detected, 0 error(s) repaired

Also note that in the above case y.y;1 is not analyzed since it is not cached in $1$dua15:

$ smu analyze $1$dua15/cache=($1$dua15,$1$dua17)
SMU-I-PROCESSING, processing input device $1$DUA15
%SMU-I-STARTSCAN, scanning for shelved files on disk volume _$1$DUA15:
No catalog entry ...$1$DUA15:[000000]Z.Z;16
File $1$DUA15:[000000]Y.Y;1 is cached in _$1$DUA17: will be analyzed
File (21,2,0) "$1$DUA15:[000000]Y.Y;1"
Allocation size mismatch - entry not repairable
Current: 0
Catalog: 8
%SMU-I-ENDSCAN, completed scan for shelved files on disk volume _$1$DUA15:
%SMU-I-ERRORS, 1 error(s) detected, 0 error(s) repaired

In the above example y.y;1 is analyzed since it is present in one of the cache devices specified in the list.

Format

Parameters

Restrictions

The SMU CHECKPOINT command should not be entered during a repack operation, since the repack is controlling the archive class shelving volume. An attempt to do so results in an error on the checkpoint.

Examples

The following example shows the SMU CHECKPOINT command used for HSM Basic mode. Assuming that the current shelving volume label is HS1005 for archive class 2, the command directs future (pre)shelve operations to volume HS1006, and dismounts and unloads the volume HS1005 from any device on which it is loaded.

$ SMU SHOW ARCHIVE 2

HSM$ARCHIVE02 has been used
Identifier: 2
Media type: CompacTape III
Label: HS1005
Position: 1293
Device refs: 1
Shelf refs: 2

$ SMU CHECKPOINT 2

$ SMU SHOW ARCHIVE 2

HSM$ARCHIVE02 has been used
Identifier: 2
Media type: CompacTape III
Label: HS1006
Position: 0
Device refs: 1
Shelf refs: 1

The following example shows the SMU CHECKPOINT command as used for HSM Plus mode.

$ SMU SHOW ARCHIVE 1

HSM$ARCHIVE01 has been used
Identifier: 1
Media type: TZ87
Density: <NONE>
Label: PLS400
Position: 963
Device refs: 1
Shelf refs: 1
Current pool: HSM-POOL
Enabled pools: HSM-POOL

$ SMU CHECKPOINT 1

$ SMU SHOW ARCHIVE 1

HSM$ARCHIVE01 has been used
Identifier: 1
Media type: TZ87
Density: <NONE>
Label: PLS500
Position: 0
Device refs: 1
Shelf refs: 1
Current pool: HSM-POOL
Enabled pools: HSM-POOL

Format

Parameters

source

A full file specification (including disk and directory) of files to be copied.

• Wildcards are allowed
• A file list is not allowed

destination

A disk and directory optional specification for the output location of the files. The original filenames are preserved. If wildcards are used in the destination directory, the semantics of processing are the same as BACKUP, rather than OpenVMS COPY. In particular, if a whole disk is being copied, the output directory specification should be [*...] rather than [000000...].

Restrictions

• The source and destination devices must be difference devices. Attempts to SMU COPY files to the same device will fail. Use the DCL RENAME command to "copy" files on the same device without unshelving files.
• Nodenames are not allowed in the source or destination specifications.
• The source and destination devices must exist.
• You cannot specify a filename or extension in the destination specification, just the device and directory.
• If the catalog server is enabled on the facility, then the SMU COPY command must be entered from the shelf server node. Use the SMU SHOW FACILITY command to determine the current server node before entering SMU COPY.

Qualifiers

/DELETE

/NODELETE

Specifies whether the input file(s) should be deleted after the copy. If so, deleted shelved files are marked in the catalog for later delete.

/LOG

/NOLOG

Specifies if a log of each file copied is made to SYS$OUTPUT.

Examples

The following example shows how to perform a group move of files from one location to another while preserving shelved files across the move. The source files are deleted after the copy.

$ SMU COPY/DELETE DISK$USER1:[JONES...]*.*;* DISK$USER10:[JONES...]

The following example copies all files from one disk to another, and retains the original files.

$ SMU COPY $1$DKA100:[000000...]*.*;* $12$DKA400:[*...]

Format

Example

The following example shows the SMU EXIT command:

SMU> EXIT
$

Format

Example

The following example shows the SMU HELP command:

$ SMU HELP SHOW CACHE

SHOW

CACHE

The SHOW CACHE subcommand displays the configuration associated with the cache on the specified volumes.

Note:
The SMU SHOW CACHE command requires SYSPRV privilege.

Format

SMU SHOW CACHE [volume_name,...]

Additional information available:

Additional information available:

Parameters Qualifiers
/OUTPUT

SMU SHOW CACHE Subtopic?

Format

Parameters

[file_spec[,...]]

Specifies one or more files to locate. If two or more files are specified, separate them with commas. Wildcard characters are allowed.

The file specifications (including wildcards) apply to the file names as they are stored in the catalog at the time of shelving, which is not necessarily the same as the current online file name.

If you do not provide a file specification, the default *:[000000...]*.*;* is used. Any part of a file specification limits the Wildcard specification from *:[000000...]*.*;*. The concept of default device and directory do not apply.

Restrictions

• NODE specifications are ignored because this information is not stored in the HSM catalog.
• Version specifications for latest versions or related versions do not work. For example, [mydir]*.*; or [mydir]*.*;-1 do not work.

Qualifiers

/ARCHIVE=archive_id[,...]

Displays catalog entries of the specified archive_id(s).

/BRIEF (Default)

Displays the catalog file name and file identifier (FID) of the specified files.

/CACHE=device_name[,...]

Displays catalog entries of the specified device name(s).

/CATALOG=file_spec[,...]

Displays catalog entries of the specified catalog file name(s).

/DUMP

Displays all fields of the catalog entries.

/FID=file_identifier

Locates a file by file identifier instead of file specification. The /FID qualifier overrides any file specification on the command line. The specified FID may find a match on more than one file if the files are located on different devices.

/FULL

Displays a complete list of information about the specified file. Once the file is located, it can be restored manually using a BACKUP command.

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

/VOLUME=volume_label [,...]

Displays catalog entries of the specified tape volume label(s).

Examples

The following example shows how to display the contents of the entire HSM catalog using the SMU LOCATE command:

$ SMU LOCATE

$1$DKA0:[000000]
CF5.DAT;1 (6542,14636,0)
CF6.DAT;1 (6542,14637,0)
FURROW.DAT;1 (5989,24877,0)
FOOL.DAT;1 (7293,49830,0)

$1$DKA0:[HSM]
LAURA.TXT;1 (6386,55397,0)

$1$DKA100:[BAILEY.CODE.EXE]
BIG.DAT;1 (503,99,0)
F10.DAT;1 (265,56,0)
F11.DAT;1 (267,76,0)
F12.DAT;1 (269,41,0)
F15.DAT;1 (276,72,0)

$1$DKA100:[SAMPLE]
X.C;1 (1435,38,0)

$1$DKA200:[BUCKLEY]
LOGIN.COM;1 (2316,1,0)
MYFILE.TXT;1 (18117,25594,0)
X.TXT;1 (18051,5,0)
X.X;1 (18116,25591,0)

$1$DKA200:[JENSEN.HSM.CLASS]
SHP_REQUEST.LIS;2 (18600,1,0)

$1$DKA200:[JENSEN.HSM]
X.X;4 (18792,1,0)

$1$DKA200:[JENSEN]
TESTFILE.TXT;1 (12551,9,0)
X.X;3 (18539,1,0)
X.X;7 (18119,25600,0)

$1$DKA200:[WELLS.HSM.WORK]
LOGIN.COM;83 (5038,5,0)
LOGIN.COM;84 (13147,1,0)
UNSHELVE_FILE.TMP;1 (108,270,0)
UNSHELVE_FILE.TMP;1 (102,150,0)
UNSHELVE_FILE.TMP;2 (173,42,0)
UNSHELVE_FILE.TMP;3 (241,44,0)

The following example shows how use SMU LOCATE to locate and recover a deleted file from the shelf copy:

$ DIRECTORY SMU_SRC.MMS
%DIRECT-W-NOFILES, no files found

$ SMU LOCATE SMU_SRC.MMS/FULL

$1$DKA200:[WELLS.HSM.WORK.TEMP]

SMU_SRC.MMS;1 (2538,39,0)
<online file not found>
Shelf copy:
Volume: HS0001 Saveset: 2DDB74A67.BCK Position: 4116
14/15 19-MAY-1994 14:11:53.16
Media type: CompacTape III, Loader
Shelved on 19-MAY-1994 14:11:53.16

$ MOUNT/FOREIGN $1$MUA0: HS0001
%MOUNT-I-MOUNTED, HS0001 mounted on _$1$MUA0:
$ BACKUP $1$MUA0:2DDB74A67.BCK/SAVE_SET SMU_SRC.MMS
$ DIRECTORY SMU_SRC.MMS

Directory $1$DKA200:[WELLS.HSM.WORK.TEMP]

SMU_SRC.MMS

Total of 1 file.

The following examples show how SMU LOCATE interprets file specifications with respect to the Wildcard default.

1.

$ SMU LOCATE X.TMP

Is interpreted as:

$ SMU LOCATE *:[000000...]X.TMP;*

2.

$ SMU LOCATE DISK1:X.TMP;5

Is interpreted as:

$ SMU LOCATE DISK1:[000000...]X.TMP;5

3.

$ SMU LOCATE [DIR1]X

Is interpreted as:

$ SMU LOCATE *:[DIR1]X.*;*

Format

Parameters

Qualifiers

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

/UIC=[uic]

Selects only those files belonging to the specified owner user identification code (UIC).
You must specify a valid UIC qualifier value, enclosed in brackets, as described in the VMS DCL Concepts Manual. Use this qualifier to emulate a policy triggered by an exceeded quota event.

Examples

The following examples show usage of the SMU RANK command.
The first example shows the /UIC qualifier:

$ SMU RANK SYS$DISK HSM$DEFAULT_OCCUPANCY/UIC=[SMITH]

Volume capacity: 649040 blocks
Current utilization: 396380 blocks
Volume lowwater mark: 324520 blocks
Blocks to be reclaimed: 71860

Executing primary policy definition
DISK$USER1:[SMITH.V12]TEST.EXE;1
date: 4-JAN-1996 size: 13281

DISK$USER1:[SMITH]LSTARV032.A;1
date: 11-JUL-1995 size: 3564

DISK$USER1:[JONES.TMS.LIB]TEST.OLB;1

DISK$USER1:[SMITH.CODE.LIB]PROD_V2.OLB;1
date: 8-MAR-1996 size: 16218

DISK$USER1:[SMITH.CHECKOUT]TMSA012.B;1
date: 26-JAN-1996 size: 7020
date: 26-JAN-1996 size: 7020

DISK$USER1:[JONES.LST]LST$MAIN_DEBUG.EXE;1
date: 9-JAN-1996 size: 3306

DISK$USER1:[SMITH]TMSA012.C;1
date: 16-MAR-1996 size: 10386

Total of 8 files ranked which will recover 80205 blocks

The following example shows the SMU RANK command with no qualifiers:

$ SMU RANK SYS$DISK HSM$DEFAULT_OCCUPANCY

Policy HSM$DEFAULT_OCCUPANCY is enabled for shelving
Policy History:
Created: 9-JUN-1994 11:01:56.85
Revised: 9-JUN-1994 11:01:56.85
Selection Criteria: State: Enabled
Action: Shelving
File Event: Modification date
Elapsed time: 180 00:00:00
Before time: <none>
Since time: <none>
Low Water Mark: 80 %
Primary Policy: Space Time Working Set (STWS)
Secondary Policy: Least Recently Used (LRU)
Verification:
Mail notification: <none>
Output file: <none>

Quota capacity: 10000 blocks
Current utilization: 5745 blocks
Quota lowwater mark: 5000 blocks
Blocks to be reclaimed: 745

Executing primary policy definition
DISK$USER2:[SMITH]AUDIT.C960214-390;1
date: 11-MAR-1996 size: 20568

Total of 1 files ranked which will recover 20568 blocks

Quota lowwater mark can be reached

Format

Parameters

Restrictions

This command requires BYPASS privilege. The /FROM_ARCHIVE and /TO_ARCHIVE qualifiers are mutually exclusive. If the /FROM_ARCHIVE qualifier is specified, the /THRESHOLD qualifier is ignored.

Qualifiers

/CANCEL

Cancels the current repack operation.

/LIST[=file_specification]

/NOLIST

List all files repacked in the specified file, or to the default HSM$LOG:HSM$REPACK.LIS if no file specification is supplied. The supplied file specification must not exceed 140 characters.

/FROM_ARCHIVE=archive_id

You can repack an archive class using the data from a different (but duplicate) archive class.
Use this option to restore lost or destroyed shelf volumes.

/REPORT

If REPORT option is specified, Repack will only perform the analysis phase of a repack and not actual repacking. This feature would be extremely useful for a system manager to:

• analyze repacking requirements/benefits
• select the most useful threshold values
• and schedule repacks at convenient times

If used with the /SAVE option, the resultant candidates file will be saved and can be used in subsequent repack/s if the system manager wants the entire repack, as analyzed, to proceed.

/RESTART

Since repacks can take several hours/days to complete, it would be useful to allow the continuation of a repack that had been interrupted for any reason. The /RESTART qualifier would utilize the current candidates file and restart the repack from where it left off, without a further analysis or repacking files/volumes that had already been repacked.

/SAVE

Repack deletes the candidates file when it completes normally and in case of error (or on /CANCEL). With a /SAVE qualifier, the candidates file would be retained, and a subsequent repack could continue the repack from where it left off with a REPACK/RESTART. In addition, the candidates file could be retained from a REPACK/REPORT/SAVE command, which performs just the analysis phase. Subsequently the data moving phase could be initiated by a
REPACK/RESTART.

/THRESHOLD[=percent]

/NOTHRESHOLD

Defines a threshold of deleted and obsolete data for consideration on whether to repack a particular volume or volume set. The default is a threshold of 50%, meaning that a volume (set) will only be repacked if its percentage of obsolete data (determined by the number of obsolete files) is 50% or more of the total number of files on the tapes.
The /NOTHRESHOLD qualifier (or /THRESHOLD=0) repacks all associated volumes in the archive class. A threshold of 100% repacks only volumes that contain no valid data.

/TO_ARCHIVE=archive_id

Defines a different archive class, possibly containing different media types, as the output of the repack. Use this qualifier to copy data from one archive class to another, or to upgrade to new tape technology.

/VOLUME[=volume_name[,...]]

Specifies specific volumes in an archive class to be repacked. A volume list is supported but wildcards are not allowed. If a specified volume is a member of a volume set, the entire volume set is eligible for packing. The volume list can contain up to 9 volumes.

Examples

In this example, perform a repack of volumes containing files shelved to archive class 1. Select from all volumes in the archive class, and repack only those in which the percentage of records belonging to obsolete files exceeds the default threshold of 50%. New volumes are allocated to the archive class and repacked volumes are released from the archive class automatically.

$ SMU REPACK 1

In this example, perform a repack of volumes containing files shelved to archive class 2. Select from all volumes in the archive class, and repack only those in which the percentage of obsolete files exceeds 80%. New volumes are allocated to the archive class and repacked volumes are released from the archive class automatically. List all files which are moved to new volumes in HSM$LOG:HSM$REPACK.LIS.

$ SMU REPACK 2/THRESHOLD=80/LIST

In this example, perform a repack of volumes containing files shelved to archive class 11. Select from volumes in the volume set which contains volume AFA200, and repack all volumes in the volume set, regardless of the percentage of records that belong to obsolete files. New volumes are allocated to the archive class and repacked volumes are released from the archive class automatically.

$ SMU REPACK 11/VOLUME=AFA200/NOTHRESHOLD

In this example perform a repack of volumes containing files shelved to archive class 21 onto volumes compatible with those in archive class 22. Repack all volumes in the archive class, regardless of the percentage of records which belong to obsolete files. New volumes are allocated to archive class 22 while repacked volumes are released from the archive class 21 automatically. List all files which are moved to new volumes in REPACK_21.LOG in the current directory.

$ SMU REPACK 21/TO_ARCHIVE=22/LIST=REPACK_21.LOG/NOTHRESHOLD

In this example, replace the non-obsolete shelved file data on volumes in archive class 16 which are members of the volume set which contains volume HSM001, using shelved file data on volumes in archive class 32. New volumes are allocated to the destination archive class; no volumes are released from the archive class.

$ SMU REPACK 16/FROM_ARCHIVE=32/VOLUME=HSM001

Format

Parameters

Qualifiers

/ADD_POOL=(pool_name[,...]) (Plus mode only)

Adds a volume pool to the list of pools for the archive class. The pool_name must be assigned in MDMS. This qualifier is valid only for HSM Plus mode.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a question is asked before each SET ARCHIVE operation to confirm that the operation should be performed on that archive class. The following responses are valid:

YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/DELETE

Deletes an archive class. This qualifier is valid only if no files have been shelved to this archive class.

/DENSITY=density (Plus mode only)

If a value is assigned to the DENS_n value in TAPESTART.COM for the media type to be used for this archive class, then you must use this qualifier and specify the exact same string as is specified in TAPESTART.COM. This qualifier is valid only for HSM Plus mode.

Once an archive class has been used, you cannot modify the density.

/LABEL=volume_label (Basic mode only)

Explicitly sets the desired volume label for the HSM Basic mode archive class. Use this command only if there has been a system failure, or if HSM cannot determine the correct volume label. This command provides an emergency reset for recovery purposes only. The next shelve operation for the archive class is performed on the specified volume. The volume label must conform to the HSM Basic mode volume label convention of HSxnnn.

Compaq recommends you use the SMU CHECKPOINT command instead of
SET ARCHIVE /LABEL for removal of shelving volumes under normal circumstances.
When you reset the volume label with SET ARCHIVE /LABEL, the shelving tape position is reset to zero.

/LOG

/NOLOG (Default)

Specifies that a command acknowledgment is displayed. If the command is specified with the
/WAIT qualifier or if the shelf handler can process the command immediately, the log output contains the final result of the operation. If the command is specified with the /NOWAIT qualifier, a message indicating that the request is queued may be displayed on success for long-running operations.

/MEDIA_TYPE=media_type (Plus mode only)

Required qualifier for HSM Plus mode that identifies the media type defined in TAPESTART.COM to use for this archive class. The media type must exactly match a defined media type in TAPESTART.COM. This qualifier is valid only for HSM Plus mode.

Once an archive class has been used, you cannot modify the media type.

/REMOVE_POOL=pool_name (Plus mode only)

Removes a volume pool from the list of pools for the archive class. This qualifier is valid only for HSM Plus mode.

/SAVESET_SIZE=Saveset_size in MB

Specifies the maximum SAVESET_SIZE that will be used in a shelving operation. Multiple files upto the maximum SAVESET_SIZE specified or 1000 files will be combined to make a single saveset to improve performance.

Examples

The following example shows the SMU SET ARCHIVE command for HSM Basic mode:

$ SMU SHOW ARCHIVE 1

%SMU-W-ARCHID_NF, archive class id 1 not found
%RMS-E-RNF, record not found

$ SMU SET ARCHIVE 1

$ SMU SHOW ARCHIVE 1

HSM$ARCHIVE01 has not been used
Identifier: 1
Media type: Unknown Type
Label: HS0001
Position: 0
Device refs: 0
Shelf refs: 0
SAVESET_SIZE:40 MB

The following example shows the SMU SET ARCHIVE command for HSM Plus mode:

$ SMU SHOW ARCHIVE 2

%SMU-W-ARCHID_NF, archive class id 2 not found
%RMS-E-RNF, record not found

$ SMU SET ARCHIVE 2 /MEDIA_TYPE=TZ87

$ SMU SHOW ARCHIVE 2

HSM$ARCHIVE02 has not been used

Identifier: 2
Media type: TZ87
Density: <NONE>
Label: <NONE>
Position: 0
Device refs: 0
Shelf refs: 0
Current pool: <NONE>
Enabled pools: <NONE>

Format

Parameters

Qualifiers

/AFTER[time]

Requests that the cache flush operation be held until after a specific time. If no time value is specified, an immediate cache flush begins. Use this qualifier without a value to trigger an immediate cache flush at any time.

Specify the time as either an absolute time, a delta time, or a combination time. For more information on specifying time values, see the OpenVMS DCL Concepts Manual.

/BACKUP

/NOBACKUP (Default)

Controls whether copies to the shelf archive classes are made when the file is moved to the cache at shelving time (/BACKUP), or when the cache is flushed at a later time (/NOBACKUP). The default is /NOBACKUP, which provides fast shelving and unshelving, but only provides one copy of the shelved data until a cache flush is performed.

The /BACKUP qualifier creates the shelf copies concurrently with the cache copy, resulting in slow shelving but fast unshelving. The shelve operation is not completed until all copies are made. Use this option when a cache device is used as a permanent repository rather than a staging area.

/BLOCK_SIZE[=BLOCK_SIZE]

The maximum number of blocks HSM can use for caching on the volume. The default is 50,000 blocks. If any shelve operation would exceed the block size of the cache, the file is shelved directly to the shelf archive classes instead.

If the /BLOCK_SIZE is set to zero the entire disk may be used for the cache.

/CONFIRM (Default)

/NOCONFIRM

Controls whether a request is issued before each SET CACHE operation to confirm that the operation should be performed on that disk volume. The following responses are valid:

YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/DELETE

Removes the cache entry from the database and causes an immediate flush of any files in the cache to the shelf archive classes.

/DISABLE

Disables the devices for use as an online shelf cache. However, no cache flush is triggered when a device is disabled.

/ENABLE (Default)

Enables the devices for use as an online shelf cache.

/HIGHWATER_MARK=percentage

Specifies a high water mark usage capacity for the cache, at which point cache flushing is initiated. Files can continue to be shelved to the cache above the high water mark as long as the
/BLOCK_SIZE value is not exceeded. The default for the /HIGHWATER_MARK qualifier for the cache is 80 percent of the block size.

If you wish to disable cache flushing based upon capacity, set the high water mark to 100 percent.

/HOLD (Default)

/NOHOLD

Specified whether the cache file is deleted when the online file is deleted or modified. /HOLD is the default and keeps the file in the cache when the online file is deleted or modified. /NOHOLD allows the file to be deleted from cache when the online file is deleted or modified. This reduces cache space in permanent caches and avoids unnecessary flushes of deleted or modified files.
If you use the /NOHOLD option, HSM cannot recover deleted or modified files from cache.

/INTERVAL[=delta_time]

/NOINTERVAL

Requests that the cache flush operation be performed at regular intervals. If no interval qualifier or value is specified, the default interval is six hours.

If /NOINTERVAL is specified, the cache is not flushed at regular intervals.
If a /HIGHWATER_MARK value of less than 100 percent is specified, the cache is flushed based on usage only.

If the high water mark is set to 100 percent and /NOINTERVAL is specified, the cache is never flushed. Use this option when using the cache as an alternative shelf.

Delta time is expressed as dddd-hh:mm:ss.cc. The value used cannot be less than one minute.

/LOG

/NOLOG (Default)

Displays the device specification of each cache device modified as the command executes.

Examples

The following examples show the SMU SET CACHE command.

The first command sets up an online disk volume as a staging area, with a maximum usage of 100,000 blocks, and a flush interval of one day to begin at 4:00 am. By default, the cache is enabled, and a high water mark of 80 percent applies.

$ SMU SET CACHE _$15$DKA100: /BLOCK=100000/INTERVAL=1-
$ /AFTER=04:00:00
$ SMU SHOW CACHE _$15$DKA100:

Cache device _$15$DKA100: is enabled, Cache flush is held until
after 15-JUN-1995 04:00:00.00, Backup is performed at flush
intervals, Cached files are held on delete of online file
Block size: 100000
Highwater mark: 80%
Flush interval: 1 00:00:00.00

The second example sets up a magneto-optical volume as an alternative shelf. Shelf archive copies are made at shelving time, the entire volume may be used for caching, and there is no flushing.

$ SMU SET CACHE _$1$JKA0: /BLOCK=0/BACKUP/NOINTERVAL -
$ /HIGHWATER_MARK=100
$ SMU SHOW CACHE _$1$JKA0:

Cache device _$1$JKA0: is enabled, Cache flush is held until
after 14-JUN-1995 09:53:42.55, Backup is performed at
shelving time, Cached files are held on delete of online
file Block size: 0 Highwater mark: 100%
Flush interval: <none>

Format

Parameters

Restrictions

In HSM Plus mode, for any devices that are not visible across the VMScluster (for example, SCSI devices that are not TMSCP served), SMU SET DEVICE must be entered on the node from which the devices are visible.

Qualifiers

/ARCHIVE_ID=(archive_id[,...])

/NOARCHIVE_ID

Defines the identifiers for archive classes that are supported by this device. Up to 36 archive class identifiers may be listed. If only one archive class identifier is provided, you can omit the parentheses. The archive classes must already be defined prior to entering this qualifier.

The /NOARCHIVE_ID qualifier means there are no archive classes defined for the device.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a request is issued before each SET DEVICE operation to confirm that the operation should be performed on that device. The following responses are valid:

YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/DEDICATE=keyword

Allows you to dedicate a nearline or offline device exclusively to HSM. A device can be selected to service shelve, unshelve, or all operations. The possible keywords are as follows:

ALL Dedicates the device for shelve, (Default) preshelve and unshelve
operations.
This is the default if you do not specify either /DEDICATE or
/SHARE.

SHELVE Dedicates the device exclusively for shelve and preshelve operations.

UNSHELVE Dedicates the device exclusively for unshelve operations.

The /DEDICATE and /SHARE qualifiers are mutually exclusive.
The /DEDICATE qualifier cannot be used with the /REMOTE qualifier.

/DEFAULT

Updates the default device record HSM$DEFAULT_DEVICE.

/DELETE

Removes the storage device entry from the database. Pending requests for the device are requeued to other devices. If a volume is mounted on the device, it will take about one minute for that volume to be dismounted after you issue this directive.

/DISABLE

Disables the devices for use by HSM.

/ENABLE (Default)

Enables the devices for use by HSM.

/LOG

/NOLOG (Default)

Displays the device specification of each device modified as the command executes.

/REMOTE (Plus Mode only)

Required to tell HSM the device is remote (not directly connected to the VMScluster).
The device specification must include the node name or the node name must be included in a logical name assignment for the device. The device must be identified through MDMS with the same exact specification as is used here.

The /DEDICATE qualifier cannot be used with the /REMOTE qualifier. You cannot dedicate remote devices for HSM use.

/ROBOT_NAME=robot_name (Basic mode only)

/NOROBOT_NAME (default)

In Basic mode, if the device is a robot-controlled loader (for example, a TZ877 loader), you must specify a robot name for the device to be treated as a loader.

The robot name must be specified for the loader to be robotically controlled.
If /NOROBOT_NAME (the default) is specified, any loaders will be treated as sequentially loadable stackers. Only non-loader standalone tapes should be specified with
/NOROBOT_NAME.

This qualifier is not supported in Plus mode.

/SHARE=keyword

Allows the system administrator to share a nearline or offline device between HSM and other users. A device can be selected to share shelve, unshelve, or all operations with system users. Sharing devices with HSM allows the system administrator to allow multiuser access to the device. When enabled, the shelf handler relinquishes control of the device after the series of operations is completed.

The possible keywords are as follows:

ALL (Default) Shares the device on shelve, preshelve, and unshelve
operations with other system users.

SHELVE Shares the device on shelve and preshelve operations with
other system users.

UNSHELVE Shares the device on unshelve operations with other system
users.

The /DEDICATE and /SHARE qualifiers are mutually exclusive.

Examples

The following example sets the device $11$MUA0:, a magazine loader, for shared use with archive classes HSM$ARCHIVE01 and HSM$ARCHIVE02 for HSM Basic mode. The device is connected to an HSJ controller with the robot name equal to the HSJ command disk name:

$ SMU SET DEVICE/ARCHIVE_ID=(1,2)/LOG/SHARE=ALL $11$MUA0:-
/ROBOT_NAME=$1$DUA204:
%SMU-I-DEVICE_CREATED, device _$11$MUA0: created
$ SMU SHOW DEVICE

HSM drive _$11$MUA0: is enabled.
Shared access: < shelve, unshelve >
Drive status: Configured
Media type: CompacTape III, Loader
Robot name: _$1$DUA204:
Enabled archives: HSM$ARCHIVE01 id: 1
HSM$ARCHIVE02 id: 2

The following Plus mode example sets the device NODE1$MKB300 for dedicated shelving and unshelving, using archive classes 4 and 5:

$ SMU SET DEVICE/ARCHIVE_ID=(4,5)
/DEDICATE=ALL NODE1$MKB300:
$ SMU SHOW DEVICE NODE1$MKB300:

HSM drive _NODE1$MKB300: is enabled.
Dedicated access: <shelve, unshelve>
Drive status: Configured
Enabled archives: HSM$ARCHIVE04 id: 4
HSM$ARCHIVE05 id: 5

The following Plus mode example sets the remote device $1$MUA23 on a remote node for shared shelving and unshelving, using archive classes 2 and 3.

$ SMU SET DEVICE/ARCHIVE_ID=(2,3)/REMOTE YOURNODE::$1$MUA23:
$ SMU SHOW DEVICE YOURNODE::$1$MUA23:

HSM remote drive YOURNODE::_$1$MUA23: is enabled.
Shared access: < shelve, unshelve >
Drive status: Configured
Enabled archives: HSM$ARCHIVE02 id: 2
HSM$ARCHIVE03 id: 3

Format

Qualifiers

/CATALOG_SERVER

/NOCATALOG_SERVER (Default)

Determines whether all cache operations and catalog updates are performed by the shelf server node. /CATALOG_SERVER restricts all cache operations and catalog updates to the current shelf server node. /NOCATALOG_SERVER (default) allows cache operations and catalog updates to be performed by the requesting client node. This does not affect tape operations which are always performed on the shelf server node.

/DISABLE=keyword

Disables HSM from performing specified operations on the VMScluster. The command applies to all volumes on all shelves on all nodes. This qualifier also disables in- progress cache flushing.
ALL Disables the facility for preshelve, shelve, unshelve and cache flush operations.
SHELVE Disables the facility for preshelve, shelve, and cache flush operations.
UNSHELVE Disables the facility for unshelve operations.

/ENABLE=keyword

Enables HSM to perform specified shelving operations. If neither /ENABLE nor /DISABLE are specified, HSM defaults to /ENABLE=ALL. The possible keywords are as follows:

ALL Enables the facility for preshelve, shelve, unshelve and cache flush
operations.
SHELVE Enables the facility for preshelve, shelve and cache flush operations.
UNSHELVE Enables the facility for unshelve operations.

/EVENT_LOGGING=keyword

Enables and disables HSM event logging. The possible keywords are as follows:
[NO]ALL Enables/disables the facility for all types of logging.
[NO]AUDIT Enables/disables audit logging.
[NO]ERROR Enables/disables error logging.
[NO]EXCEPTION Enables/disables exception logging.
By default, all logging is enabled.

/NOLOG (Default)

Displays the facility that was modified as the command executes.

/MODE=mode_type

Tells HSM the mode in which to operate. Valid keywords for this qualifier are:
Basic Operate HSM in Basic mode, which provides limited device support.

Plus Operate HSM in Plus mode, which provides enhanced device support
through the Media and Device Management Services for Open VMS (MDMS)
software.

The initial default value for the mode depends on the mode in which HSM is installed. Once you run in HSM Plus mode, you cannot go back to HSM Basic mode. For information on converting from HSM Basic mode to HSM Plus mode, see HSM for OpenVMS Guide to Operations.

/REENABLE

Reenables all operations for the facility. If the shelf handler is failing too often, HSM may disable the facility for shelving, unshelving, disk full, or quota error conditions. This command can be used to reenable the facility once the error condition is corrected.

/RESET_LOGS

Closes the current audit and error logs, then starts writing to a new version. The closed logs can be subsequently reviewed, shelved or deleted.

/SERVER=(server_name[,...])

/NOSERVER

Specifies which nodes can function as shelf servers.

Nodes are entered as a comma-separated list. Up to ten nodes can be entered as potential servers. Shelf server nodes must have access to all nearline/offline tape devices in Basic mode.

If /NOSERVER is entered, all nodes in the VMScluster are eligible to be a shelf server.

Example

The following example enables HSM for all error logging, and designates nodes SYS001 and SYS004 as shelf servers:

$ SMU SET FACILITY/EVENT_LOGGING=ALL/SERVER=(SYS001,SYS004)

$ SMU SHOW FACILITY

HSM for OpenVMS is enabled for Shelving and Unshelving
Facility History:
Created: 22-MAY-1994 10:36:34.96
Revised: 22-MAY-1994 13:49:37.50
Designated servers: SYS001
SYS004
Current server: SYS001
Catalog server: Disabled
Event logging: Audit
Error
Exception
HSM mode: Basic
Remaining license: 500 gigabytes

Format

Parameters

Qualifiers

/BACKUP

Uses the backup date for selection criteria when using the /BEFORE and /SINCE qualifiers and the STWS and LRU policy algorithms. If a file has no backup date, it is not selected for the operation.

The /BACKUP, /CREATED, /EXPIRED, and /MODIFIED qualifiers are mutually exclusive. The default is /EXPIRED if none of the above are entered. If you specify one of these qualifiers without the /BEFORE, /ELAPSED, or /SINCE qualifiers, /BEFORE, /ELAPSED, and /SINCE values are unaffected.

If a file has no backup date, it is not selected for shelving by the predefined algorithms.

/BEFORE[=time] /NOBEFORE

Selects only those files dated prior to the specified time. Specify the time as an absolute time, a combination time, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection:

/BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

The values specified by the /BEFORE qualifier are translated to absolute values that do not change between policy runs. To specify a relative before time, use the /ELAPSED qualifier instead. The /BEFORE qualifier is mutually exclusive of the /ELAPSED qualifier.

The /NOBEFORE qualifier clears any previously issued SET POLICY/BEFORE values.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a request is issued before each SET POLICY operation to confirm that the operation should be performed on that policy.

The following responses are valid:

YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/CREATED

Uses the creation date for selection criteria when using the /BEFORE and /SINCE qualifiers and the STWS and LRU policy algorithms.

The /BACKUP, /CREATED, /EXPIRED, and /MODIFIED qualifiers are mutually exclusive. The default is /EXPIRED if none of the above are entered. If you specify one of these qualifiers without the /BEFORE, /ELAPSED, or /SINCE qualifiers, /BEFORE, /ELAPSED, and /SINCE values are unaffected.

/DEFAULT

Sets or modifies the system policy defaults. When a new volume definition is created, all default attributes are set from this default volume definition.

The /DEFAULT qualifier cannot be used with a parameter value.

/DELETE

Deletes the entry from the policy database.

/DISABLE

The policy is disabled from execution until it has been reactivated by the /ENABLE qualifier.

/ELAPSED=delta_time

/NOELAPSED

Selects only those files that are equal to or older than the specified delta time. The time is expressed as a relative value and applied as such at each policy run.

Delta time is an offset (a time interval) from the current date and time to a time in the past.
The general format for a delta time is as follows:

"[dddd-][hh:mm:ss.cc]"

The fields are as follows:

dddd Number of days an integer in the range 0 to 9999
hh Number of hours an integer in the range 0 to 23
mm Number of minutes an integer in the range 0 to 59
ss Number of seconds an integer in the range 0 to 59
cc Number of hundredths of seconds in the range 0-99

The following table shows some examples of delta time specifications:

The /ELAPSED qualifier is mutually exclusive of the /SINCE and /BEFORE qualifiers.
The /NOELAPSED qualifier clears any previously issued SET POLICY/ELAPSED values.

/ENABLE (Default)

The policy is enabled for execution. The policy remains enabled until it is explicitly disabled.

/EXPIRED (Default)

Uses the effective date of last access for selection criteria when using the /BEFORE, /SINCE and /ELAPSED qualifiers, and the STWS and LRU policy algorithms. This qualifier uses the file's expiration date and the volume's retention time to determine the date of last access according to the following formula:

date_of_last_access = expiration_date - maximum_volume_retention

While specifying date and time values in the associated /BEFORE, /SINCE and /ELAPSED qualifiers, you should specify the date of last access rather than simply the expiration date, which is likely to be in the future.

If volume retention is not enabled on the volume, HSM will select no files for shelving when the policy is run. Therefore, to use file selection based on expiration date (the default), you must first enable volume retention on the volume (see HSM for OpenVMS Guide to Operations).
HSM will automatically initialize expiration dates on all files on the volume to the current date plus the maximum retention time when the policy is first run.

The /BACKUP, /CREATED, /EXPIRED, and /MODIFIED qualifiers are mutually exclusive. The default is /EXPIRED if none of the above is entered. If you specify one of these qualifiers without the /BEFORE, /ELAPSED, or /SINCE qualifiers, /BEFORE, /ELAPSED, and /SINCE values are unaffected.

/LOG

/NOLOG (Default)

Displays a message for each schedule definition as the command executes.

/LOWWATER_MARK=[percentage]

The /LOWWATER_MARK qualifier establishes a threshold where policy execution terminates. It is set to the desired percentage of volume capacity that HSM attempts to reach while executing a policy.
Possible percentages range from zero to 100 percent. The shelving policy continues to shelve dormant files until the low water mark is reached.
For instance, if the low water mark is set to 20 percent, then HSM shelves dormant files until the disk usage is 20 percent or less. The default low water mark is 80 percent.

/MAIL=destination

/NOMAIL (Default)

Sets notification upon completion of the operation through user mail. The destination can be a specific user, such as SOCCR::SMITH, or a distribution list contained in a command procedure, such as @POLICY.DIS.

The mail header indicates success or failure. The message body contains a brief summary of shelving operations that were executed.

/MODIFIED

Uses the modification date for selection criteria when using the /BEFORE and /SINCE qualifiers and the STWS and LRU policy algorithms.

The /BACKUP, /CREATED, /EXPIRED, and /MODIFIED qualifiers are mutually exclusive. The default is /EXPIRED if none of the above are entered. If you specify one of these qualifiers without the /BEFORE, /ELAPSED, or /SINCE qualifiers, the /BEFORE, /ELAPSED, and
/SINCE values are unaffected.

/OUTPUT[=file_spec]

/NOOUTPUT (Default)

Records all shelving activities caused by the execution of the volume policy definition.

The /OUTPUT qualifier controls where the output record of the volume policy execution is sent. By default, no output file is created. No Wildcard characters are allowed.
If you enter the /OUTPUT qualifier with a partial file specification (for example, /OUTPUT=[JONES]), the policy_ name parameter is used as the file name with a default file extension of .LOG. The output is suppressed if you enter the /NOOUTPUT qualifier.

/PRESHELVE

/NOPRESHELVE

If /PRESHELVE is specified, the LRU and STWS algorithms preshelve files instead of shelving them. The /PRESHELVE qualifier is applicable only to periodically scheduled policies and should not be applied to volume occupancy full, high water mark exceeded or exceeded disk quota policies, as preshelving does not make disk space available.

/PRIMARY_POLICY=keyword

/NOPRIMARY_POLICY

The /PRIMARY_POLICY qualifier sets the primary policy for selecting dormant files to be shelved. The primary policy is executed until the low water mark is reached or until no further candidates are found. If the low water mark is not reached, then the secondary policy is executed to select additional candidates. Typically, the secondary policy is set to a different algorithm than the primary. This algorithm is then executed until the low water mark is reached.

Setting the /NOPRIMARY_POLICY qualifier effectively disables policy execution. For example, this can be used to disable any action on volume occupancy full or disk quota exceeded events.

The possible policy keywords are as follows:

STWS Space-Time Working Set-Selects files based on the time since the
last reference and the size of the file. Large files are selected with a
higher priority than small files.

LRU Least Recently Used-Selects files with the greatest time since
the last reference.

SCRIPT=filename A filename containing DCL shelving commands. This file is
then used to select files for shelving, preshelving or unshelving.
Note that scripts are run to completion and are not terminated
when the low water mark has been reached.

When you use a script, HSM ignores the file selection qualifiers /BACKUP,
/CREATED, /MODIFIED, or /EXPIRED, /BEFORE, /ELAPSED, or /SINCE.

SMU does not check for the existence of the script file until the policy execution time is reached.

If the specified date field has no value (for example, no backup or expiration date), the STWS and LRU algorithms do not select the file for shelving.

/SECONDARY_POLICY=keyword

/NOSECONDARY_POLICY

Secondary policy is used whenever the primary policy fails to reach the low water mark for the volume. It should be set to a different policy algorithm than the primary so different file selection criteria are used.

If no secondary policy is specified, the secondary policy from the default periodic policy is used.

The keywords for the /SECONDARY_POLICY qualifier are the same as those used for the /PRIMARY_POLICY qualifier.

/SINCE=time

/NOSINCE

Selects only those files dated after the specified time. Specify the time as an absolute time, as a combination of absolute and delta times, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

Specify one of the following qualifiers with /SINCE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED, /EXPIRED, or /MODIFIED.

Time must be specified using the OpenVMS formats for absolute and delta times.

The /SINCE qualifier is mutually exclusive of the /ELAPSED qualifier.

The /NOSINCE qualifier clears any previously issued SET POLICY/SINCE values.

The /BACKUP, /CREATED, /EXPIRED, and /MODIFIED qualifiers are mutually exclusive. The default is /EXPIRED if none of the above are entered. If you specify one of these qualifiers without the /BEFORE, /ELAPSED, or /SINCE qualifiers, /BEFORE, /ELAPSED, and /SINCE values are unaffected.

Example

The following example changes the default occupancy policy to shelve files that have not been accessed for read or write for 100 days. The shelving algorithms to be used are STWS as the primary policy and a user-defined script as the secondary policy, with a low water mark goal of 70 percent. At completion of the policy, mail confirmation is sent to the SYSTEM account. The example also illustrates that the attributes can be specified in multiple commands, as well as in a single command.

$ SMU SET POLICY HSM$DEFAULT_OCCUPANCY - _
$ /ELAPSED=100-0 -
$ /MAIL=SYSTEM -
$ /LOWWATER_MARK=70 -
$ /EXPIRED

$ SMU SET POLICY HSM$OCCUPANCY_POLICY -
$ /PRIMARY_POLICY=STWS -
$ /SECONDARY_POLICY=SCRIPT=DISK$USER1:[SMITH]SECPOL.COM -

$ SMU SHOW POLICY HSM$DEFAULT_OCCUPANCY
Policy HSM$DEFAULT_OCCUPANCY is enabled for shelving
Policy History:
Created: 22-MAY-1994 10:36:36.45
Revised: 28-MAY-1994 11:26:21.09
Selection Criteria:
State: Enabled
Action: Shelving
File Event: Expiration date
Elapsed time: 100 00:00:00
Before time: <none>
Since time: <none>
Low Water Mark: 70 %
Primary Policy: Space Time Working Set(STWS)
Secondary Policy: SCRIPT
DISK$SLOPER1:[SMITH]SECPOL.COM;
Verification:
Mail notification:
SYSTEM
Output file: <none>

Format

Parameters

Qualifiers

/ALL

Used in conjunction with wildcard volume names to select all matching volumes found on the system. If /ALL is not specified, Wildcard matching applies only to volumes defined with SET VOLUME in the SMU database.

/AFTER[=time]

Requests that the shelving policy execution be held until after a specific time. If no time value is specified, execution begins immediately.

Specify the time as either an absolute time or as a combination of absolute and delta times. For more information on specifying time values, see the OpenVMS DCL Concepts Manual.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a request is issued before each schedule operation to confirm that the operation should be performed. The following responses are valid:

YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/DELETE

Deletes the entry from the scheduling database.

/INTERVAL=delta_time

Requests that the shelving policy be executed at regular intervals. This qualifier specifies the minimum time between shelving policy executions for the online volume. Delta time is expressed as dddd-hh:mm:ss.cc. If no interval value is specified, the default interval is one day.

If the /AFTER qualifier is specified with the /INTERVAL qualifier, the first shelving policy execution begins at or after the /AFTER time. All subsequent policy executions occur at the specified time.

Specify the time as either an absolute time or as a combination of absolute and delta times. For more information on specifying time values, see the OpenVMS DCL Concepts Manual.

The policy can be executed only if the policy definition has been enabled.

/ENTRY=number

When a policy is scheduled for execution, an entry number is associated with it. Use the entry number when modifying an existing policy schedule event. Use SHOW SCHEDULE to determine the entry number.

/LOG

/NOLOG (Default)

Displays the policy specification of each policy modified as the command executes.

/OUTPUT[=filespec]

/NOOUTPUT (Default)

The /OUTPUT qualifier controls where the output record of the set schedule activity is sent. By default, no output file is created. No Wildcard characters are allowed.

/REQUEUE=server_name

In conjunction with the /ENTRY qualifier, the /REQUEUE qualifier requeues the policy for execution on a different shelf server node.

/SERVER=node_name

Specify the node name of the HSM shelf server on which to execute the policy. This does not have to be the current shelf server, but any eligible shelf server. If you do not specify a server node name, the default server becomes the first entry listed under Designated Servers in the SHOW FACILITY command display.

Example

The following example shows the SMU SET SCHEDULE command. In this example, a preventative policy DAILY_OCCUPANCY is run on a daily basis on volumes $1$DKA100: and $1$DKA200:, starting at 2:00 am, on shelf server node SYS001.

$ SMU SET SCHEDULE $1$DKA100:, $1$DKA200: DAILY_OCCUPANCY -
$ /INTERVAL=1-0/AFTER=02:00:00/SERVER=SYS001

$ SMU SHOW SCHEDULE/FULL

Volume Policy Entry Status
_$1$DKA100: DAILY_OCCUPANCY 517 PENDING
Server node: SYS001
Scheduled after: 28-MAY-1994 02:00:00.00
Scheduled interval: 1 00:00:00.00
Output file <none>

Volume Policy Entry Status
_$1$DKA200: DAILY_OCCUPANCY 517 PENDING
Server node: SYS001
Scheduled after: 28-MAY-1994 02:00:00.00
Scheduled interval: 1 00:00:00.00
Output file <none>

Format

Parameters

Qualifiers

/ARCHIVE_ID=(archive_id[,...])

/NOARCHIVE_ID

Identifies archive class identifiers to be used by this shelf. Archive classes must be defined using SMU SET ARCHIVE before they can be identified for use with the shelf. HSM transfers the file's data to each archive class in the list. This can be used to create multiple copies of the shelved file's data content.

This archive list specifies the archive classes to be written during shelving operations. The restore archive list specifies the archive classes to be read during unshelving operations. When a shelf is first created, the restore archive list is initialized to the archive list specified by this qualifier. Thereafter, the two lists are maintained separately.

Up to ten archive classes may be specified in this list.

/NOARCHIVE_ID removes all existing archive class references.

/CANCEL

Cancels a split-merge operation for the specified catalog.

/CATALOG=file_spec

Specifies the file specification of the catalog file to be used for this shelf. A full specification can be supplied, otherwise default elements are taken from the logical name HSM$CATALOG. A logical name may also be supplied.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a request is issued before each SET SHELF operation to confirm that the operation should be performed on that shelf. The following responses are valid:

YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/DEFAULT

Sets or modifies the system shelf defaults. When a new shelf definition is created, all default attributes are set from this default shelf definition.

The /DEFAULT qualifier cannot be used with a parameter value.

/DELETE

Deletes the entry from the shelf database.

/DISABLE=keyword

Disables shelving operations on all volumes associated with the shelf. The shelf can be configured to perform individual or all shelving operations. The possible keywords are as follows:

ALL Disables the shelf for shelve, preshelve, and unshelve
opera tions.

SHELVE Disables the shelf for shelve and preshelve operations.

UNSHELVE Disables the shelf for unshelve operations.

/ENABLE[=keyword]

Enables operations on volumes associated with the shelf. The shelf can be configured to perform only individual or all shelving operations. By default, the shelf is enabled for all shelve, preshelve, and unshelve operations. The possible keywords are as follows:

ALL (Default) Enables the shelf for shelve, preshelve, and unshelve operations
(Default).

SHELVE Enables the shelf for shelve and preshelve operations.

UNSHELVE Enables the shelf for unshelve operations.

/LOG

/NOLOG (Default)

Displays the shelf specification of each shelf modified as the command executes.

/RESTORE_ARCHIVE=(archive_id[,...])

/NORESTORE_ARCHIVE

Identifies which archive classes are used by HSM on a restore operation. Archive classes must be defined using SMU SET ARCHIVE before they can be identified for use with the shelf. The order of this list is significant. On an UNSHELVE operation the first archive class in restore list is used to attempt to unshelve the file. If the restore attempt in unsuccessful, the next archive class in the restore list is attempted, and so on. Up to 36 archive classes may be specified in this list. This list should normally include the current archive list, plus any archive classes that have ever been defined for this shelf.

If you don't specify a restore archive ID when the shelf is created, the save archive class specified by the /ARCHIVE_ ID command is used as the restore archive. Thereafter, the two lists must be maintained separately.

/NORESTORE_ARCHIVE

removes all restore archive class references.

/SAVE_TIME[=delta_time]
NOSAVE_TIME

Specifies that the shelf file data and catalog entries are saved in the HSM subsystem for the specified delta_ time after the online file is deleted. If no delta_time is specified, a default value of 30 days is applied. With /NOSAVE_TIME, no delay is applied.

While repacking obsolete files are determined based on the value of SAVE_TIME.

When a delete is attempted on a cache file if cache is set as /NOHOLD, the catalog entry is always deleted irrespective of SAVE_TIME. Similarly, if the cache is set as /HOLD, the catalog entry is not deleted irrespective of SAVE_TIME.

During a preshelve operation, if /HOLD is set on the Cache and /SAVE_TIME is used

If /HOLD is set:
and /SAVETIME is used: The entry is not deleted
and /NOSAVE is used: The entry is not deleted.

If /NOHOLD is set:
and /SAVETIME is used: The entry is deleted
and /NOSAVE is used: The entry is deleted.

/VERIFY

/NOVERIFY (Default)

Specifies whether shelving and unshelving operations to tape volumes are performed using BACKUP/VERIFY. The /VERIFY option slows down shelving operations, but provides increased reliability for shelving.

/UPDATES=n

Specifies the number of updates of a shelved file that should be saved on shelf media and in the catalog. For example, for /UPDATES=2, a file that has been:
shelved /unshelved/modified/shelved 10 times will retain the latest two updates on shelf media and in the catalog.
Use /UPDATES=0 to specify that all updates should be retained. Note that this has nothing to do with the OpenVMS version of the file, but rather files that are updated in place.

Example

The following example creates the shelf named CRITICAL_SHELF for use with archive classes 1 and 2, and associates a separate catalog with the shelf.

$ SMU SET SHELF CRITICAL_SHELF -
_$ /ARCHIVE_ID=(1,2) -
_$ /CATALOG=DISK$USER1:[HSM.CATALOG]HSM$CAT1.SYS
$ SMU SHOW SHELF CRITICAL_SHELF

Shelf CRITICAL_SHELF is enabled for Shelving and Unshelving
Catalog File: DISK$USER1:[HSM.CATALOG]HSM$CAT1.SYS
Shelf history:
Created: 15-JUN-1995 12:32:24.70
Revised: 15-JUN-1995 12:32:24.70

Backup Verification: Off
Save Time <none>
Updates Saved: All
Archive Classes:
Archive list: HSM$ARCHIVE01 id: 1
HSM$ARCHIVE02 id: 2
Restore list: HSM$ARCHIVE01 id: 1
HSM$ARCHIVE02 id: 2

Format

Parameters

Qualifiers

/CANCEL

Cancels a split-merge operation for the specified shelf.

/ALL

Used in conjunction with wildcard volume names to match with all online disks on the system.
If /ALL is not specified, the wildcard only matches with the volumes already defined in the SMU database.

/CONFIRM

/NOCONFIRM (Default)

Controls whether a request is issued before each SET VOLUME operation to confirm that the operation should be performed on that volume. The following responses are valid:

YES NO QUIT
TRUE FALSE Ctrl/Z
1 0 ALL

Refer the OpenVMS DCL Concepts Manual for more information on the /CONFIRM qualifier.

/CONTIGUOUS

/NOCONTIGUOUS (Default)

Controls the eligibility of files marked contiguous on the volume to be shelved. The default is /NOCONTIGUOUS, meaning that contiguous files are never shelved. If /CONTIGUOUS is specified and contiguous files are shelved, then they are always restored contiguously. If a file cannot be restored contiguously, an error occurs. This qualifier does not affect preshelving.

/DEFAULT

Sets or modifies the system volume defaults. When a new volume definition is created, all default attributes are set from this default volume definition.
This qualifier cannot be used with a volume_name parameter value.

/DELETE

Deletes the entry from the volume database. HSM attributes for the specified online disk volume reverts to those defined in the default volume record HSM$DEFAULT_VOLUME. The volume must be first set to use the shelf specified by the default volume before a delete is allowed.

/DISABLE [=keyword]

The volume is disabled from specified HSM operations until it is reactivated by the /ENABLE qualifier. The volume can be configured to disable individual or all shelving operations.

By default, the volume is enabled for preshelving, shelving and unshelving operations, and disabled for high water mark detection, occupancy full and exceeded quota events.

The possible keywords are as follows:

ALL Disables the volume for all HSM operations.
HIGHWATER_MARK Disables the volume for handling high water mark
conditions.
OCCUPANCY Disables the volume for handling volume occupancy full
conditions.
QUOTA Disables the volume for handling disk quota exceeded
conditions.
UNSHELVE Disables the volume for UNSHELVE operations.

/ENABLE[=keyword]

Enables HSM operations on the volume. The volume can be configured to perform individual or all shelving operations. By default, the volume is enabled for preshelving, shelving and unshelving operations, and disabled for high water mark detection, occupancy full and exceeded quota events.

The possible keywords are as follows:

HIGHWATER_MARK Enables the volume for handling high water mark conditions.
OCCUPANCY Enables the volume for handling volume occupancy full
conditions.
QUOTA Enables the volume for handling disk quota exceeded
conditions.
SHELVE Enable the volume for SHELVE and PRESHELVE
operations.
UNSHELVE Enables the volume for UNSHELVE operations.
ALL Enables the volume for all HSM operations.

/HIGHWATER_MARK=percent

The /HIGHWATER_MARK qualifier establishes a threshold where reactive occupancy policy execution is triggered. It is set to a usage percentage of the volume capacity. Possible percentages range from 0 to 100 percent. HSM periodically checks the device capacity and compares it to the high water mark. If it has been exceeded, and high water mark operations are enabled, a volume occupancy full event is triggered, and the volume's occupancy policy is executed.
If no high water mark processing is desired, specify the high water mark as 100 percent, or disable high water mark operations.

/LOG

/NOLOG (Default)

Displays the volume specification of each volume modified as the command executes.

/OCCUPANCY[=policy_name]

/NOOCCUPANCY

This policy is executed whenever the online device has insufficient allocatable space or the volume high water mark has been exceeded. HSM then executes this occupancy policy.
Policy execution is terminated when enough space has been freed to satisfy the request, or no candidates were found.

• If no occupancy full policy name is specified, HSM applies a predefined default occupancy policy definition (HSM$DEFAULT_OCCUPANCY).
• If /NOOCCUPANCY is specified, then no policy is run on volume occupancy full and high water mark conditions.

/PLACEMENT (Default)

/NOPLACEMENT

Defines the eligibility of files marked with placement attributes to be shelved.
The default is /PLACEMENT, meaning that placed files can be shelved. Files that have been shelved are not guaranteed to be restored with identical placement as before. This qualifier does not affect preshelving.

/QUOTA[=policy_name]

/NOQUOTA

This policy is executed whenever a disk quota exceeded event is encountered. When a disk quota exceeded event is encountered, HSM then executes the volume's quota policy.

If no quota policy name is specified, HSM applies a predefined default quota policy definition (HSM$DEFAULT_QUOTA).

If /NOQUOTA is specified, then no policy is run on disk quota exceeded conditions.

/SHELF_NAME=shelf_name

The shelf to associate the volume with. If no shelf qualifier is entered, the default shelf HSM$DEFAULT_SHELF is used. The shelf must exist prior to associating a volume with it.

Example

The following example shows the SMU SET VOLUME command. In this example, volumes $1$DKA100: and $1$DKA200: are assigned to the default shelf. All operations are enabled for the volume, and user-defined reactive policies are set up. The high water mark is set to 95 percent.

$ SMU SET VOLUME $1$DKA100:,$1$DKA200: - $ /ENABLE=ALL /HIGHWATER_MARK=95 -
$ /OCCUPANCY_POLICY = CRITICAL_OCC_POL - $ /QUOTA_POLICY = CRITICAL_QUOT_POL

$ SMU SHOW VOLUME $1$DKA100:, $1$DKA200 /FULL

Volume _$1$DKA100: on Shelf HSM$DEFAULT_SHELF, Shelving is enabled,
Unshelving is enabled, Highwater mark detection is enabled, Occupancy full detection is enabled, Disk quota exceeded detection is enabled
Created: 15-JUN-1995 12:37:07.50
Revised: 15-JUN-1995 12:37:07.50
Ineligible files: <CONTIGUOUS>
High Water Mark: 95%
OCCUPANCY Policy: CRITICAL_OCC_POL
QUOTA Policy: CRITICAL_QUOT_POL

Volume _$1$DKA200: on Shelf HSM$DEFAULT_SHELF, Shelving is enabled,
Unshelving is enabled, Highwater mark detection is enabled, Occupancy full
detection is enabled, Disk quota exceeded detection is enabled
Created: 15-JUN-1995 12:37:07.64
Revised: 15-JUN-1995 12:37:07.64
Ineligible files: <CONTIGUOUS>
High Water Mark: 95%
OCCUPANCY Policy: CRITICAL_OCC_POL
QUOTA Policy: CRITICAL_QUOT_POL

Format

Parameters

Qualifiers

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

Examples

The following example shows the SMU SHOW ARCHIVE command for Basic mode on a system where only two archive classes are defined:

$ SMU SHOW ARCHIVE
HSM$ARCHIVE01 has been used
Identifier: 1
Media type: CompacTape III, Loader
Label: HS0004
Position: 1350
Device refs: 1
Shelf refs: 1

HSM$ARCHIVE02 has not been used
Identifier: 2
Media type: CompacTape III,
Loader Label: HS1001
Position: 0
Shelf refs: 0
SAVESET_SIZE: 40 MB

The following example shows the SMU SHOW ARCHIVE command for a specific archive class for Plus mode:

$ SMU SHOW ARCHIVE 1

HSM$ARCHIVE01 has been used
Identifier: 1
Media type: TK85K
Density: COMP
Label: ACW401
Position: 21
Device refs: 2
Shelf refs: 3
Current pool: HSM-POOL
Enabled pools: HSM-POOL

Format

Parameters

Qualifiers

/OUTPUT[=file_spec]

/NOOUTPUT (Default)

Controls where to write the output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

If you enter the /OUTPUT qualifier with a partial file specification (for example, /OUTPUT=[JONES]), HSM$CACHE is the default file name and .LIS is the default file extension. The output is suppressed if you enter the /NOOUTPUT qualifier.

Example

The following example shows the SMU SHOW CACHE command display.

$ SMU SHOW CACHE _$15$DKA100:

Cache device _$15$DKA100: is enabled, Cache flush is held until
after 15-JUN-1995 04:00:00.00, Backup is performed at flush
intervals, Cached files are held on delete of online file
Block size: 100000
Highwater mark: 80%
Flush interval: 1 00:00:00.00

Format

Parameters

Qualifiers

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

Examples

The following example shows the SMU SHOW DEVICE display for Basic mode:

$ SMU SHOW DEVICE _$10$MIA5:

HSM drive _$10$MIA5: is enabled.
Shared access: < shelve, unshelve >
Drive status: Configured
Media type: CompacTape III, Loader
Robot name: _$1$DUA406:
Enabled archives: HSM$ARCHIVE01 id: 1
HSM$ARCHIVE02 id: 2

The following example shows the SMU SHOW DEVICE display for Plus mode:

$ SMU SHOW DEVICE _NODE2$MKA500:
HSM drive _NODE2$MKA500: is enabled.
Shared access: <shelve, unshelve>
Drive status: Configured
Enabled archives: HSM$ARCHIVE01 id: 1
HSM$ARCHIVE03 id: 3

Format

Qualifiers

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

If you enter the /OUTPUT qualifier with a partial file specification
(for example, /OUTPUT=[JONES]), HSM$FACILITY is the default file name and .LIS is the default file extension. The output is suppressed if you enter the /NOOUTPUT qualifier.

Example

The following example shows the SMU SHOW FACILITY command display.

$ SMU SHOW FACILITY

HSM for OpenVMS is enabled for Shelving and Unshelving
Facility history:
Created: 22-MAY-1994 10:36:34.96
Revised: 1 5-FEB-1995 12:27:51.87
Designated servers: SYS001
SYS002
Current server: SYS001
Catalog server: Disabled
Event logging: Audit
Error
Exception
HSM mode: Plus
Remaining license: 500 gigabytes

Format

Parameters

Qualifiers

/BRIEF (Default)

Displays one line of information for each specified policy.

/DEFAULT

Shows the default policy record HSM$DEFAULT_POLICY. When a new policy definition is created, all default attributes are set from this default policy definition.

The /DEFAULT qualifier cannot be used with a parameter value.

/FULL

Displays complete information about each specified policy.

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

If you enter the /OUTPUT qualifier with a partial file specification
(for example, /OUTPUT=[JONES]), HSM$POLICY is the default file name and .LIS is the default file extension. The output is suppressed if you enter the /NOOUTPUT qualifier.

Examples

The following examples show the SMU SHOW POLICY display.

$ SMU SHOW POLICY

Policy HSM$DEFAULT_OCCUPANCY is enabled for shelving
Policy HSM$DEFAULT_POLICY is enabled for shelving
Policy HSM$DEFAULT_QUOTA is enabled for shelving

$ SMU SHOW POLICY/FULL HSM$DEFAULT_QUOTA

Policy HSM$DEFAULT_QUOTA is enabled for shelving
Policy History:
Created: 22-MAY-1994 10:36:36.47
Revised: 22-MAY-1994 10:36:36.47
Selection Criteria:
State: Enabled
Action: Shelving
File Event: Expiration date
Elapsed time: 180 00:00:00
Before time: <none>
Since time: <none>
Low Water Mark: 80 %
Primary Policy: Space Time Working Set (STWS)
Secondary Policy: Least Recently Used (LRU)
Verification:
Mail notification: <none>
Output file: <none>

Format

Qualifiers

/BRIEF (Default)

Writes a line to the display device to indicate the number of requests in progress.

/FULL

Writes a line to the display device to indicate the number of requests in progress. In addition, if there is at least one active request, the requests are dumped to the file HSM$LOG:HSM$SHP_ACTIVITY.LOG.

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

Example

The following example shows the SMU SHOW REQUESTS command:

$ SMU SHOW REQUESTS/FULL
%HSM-S-DMPACTREQS, shelving facility active with 3 requests
%HSM-I-DMPFILE, active requests dumped to file
HSM$LOG:HSM$SHP_ACTIVITY.LOG

The following example shows how to use the OpenVMS SYSMAN command to show the requests on all nodes in the cluster.

$ MCR SYSMAN SYSMAN> SET ENVIRONMENT/CLUSTER
%SYSMAN-I-ENV, current command environment:
Clusterwide on local cluster
Username PETER will be used on nonlocal nodes

SYSMAN> DO SMU SHOW REQUESTS
%SYSMAN-I-OUTPUT, command execution on node HERSHY
%HSM-S-DMPACTREQS, shelving facility active with 1 requests
%SYSMAN-I-OUTPUT, command execution on node MINT
%HSM-S-DMPACTREQS, shelving facility active with 1 requests
%SYSMAN-I-OUTPUT, command execution on node CHOCO
%HSM-S-DMPACTREQS, shelving facility active with 4 requests

Format

Parameters

Qualifiers

/BRIEF (Default)

Displays a one-line summary for each scheduled entry.

/ENTRY=entry_number

Displays a specific scheduled entry only, and should be entered with no parameters on the command line.

/FULL

Displays complete information for each scheduled entry.

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

/SERVER=server_name

Displays only those entries scheduled on a specific server node.

Examples

The following examples show the SMU SHOW SCHEDULE command:

$ SMU SHOW SCHEDULE _$1$DKA100:, _$1$DKA200:

Volume Policy Entry status
------ ------ ----- ------
_$1$DKA100: HSM$DEFAULT_OCCUPANCY 517 PENDING

Volume Policy Entry status
------ ------ ----- ------
_$1$DKA200: HSM$DEFAULT_OCCUPANCY 518 PENDING

$ SMU SHOW SCHEDULE/ENTRY=518/FULL

Volume Policy Entry status
------ ------ ----- ------
_$1$DKA200: HSM$DEFAULT_OCCUPANCY 518 PENDING
Server node: SLIPPER
Scheduled after: 28-MAY-1994 02:00:00.00
Scheduled interval: 1 00:00:00.00
Output file <none>

Format

Parameters

Qualifiers

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

If you enter the /OUTPUT qualifier with a partial file specification
(for example, /OUTPUT=[JONES]), HSM$SHELF is the default file name and .LIS is the default file extension. The output is suppressed if you enter the /NOOUTPUT qualifier.

Example

The following example shows the SMU SHOW SHELF command display.

$ SMU SHOW SHELF HSM$DEFAULT_SHELF

Shelf HSM$DEFAULT_SHELF is enabled for Shelving and Unshelving
Catalog File:$1$DKA0:[HSM$SERVER.CATALOG]HSM$CATALOG.SYS
Shelf history:
Created: 8-JUN-1996 12:39:30.86
Revised: 14-JUN-1996 13:17:58.87
Backup Verification: Off
Save Time <none>
Updates Saved: All
Archive Classes:
Archive list: HSM$ARCHIVE01 id: 1
HSM$ARCHIVE02 id: 2
Restore list: HSM$ARCHIVE01 id: 1
HSM$ARCHIVE02 id: 2

Format

Qualifiers

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

If you enter the /OUTPUT qualifier with a partial file specification (for example, /OUTPUT=[JONES]), HSM$VERSION is the default file name and .LIS is the default file extension. The output is suppressed if you enter the /NOOUTPUT qualifier.

Example

The following example shows the SMU SHOW VERSION command display.

$ SMU SHOW VERSION

HSM Shelf Handler version - V3.1 (BL24), July 2000
HSM Shelving Driver version - V3.1 (BL24),July 2000
HSM Policy Execution version - V3.1 (BL24), July 2000
HSM Shelf Management version - V3.1 (BL24), July 2000

Format

Parameters

Qualifiers

/BRIEF (Default)

Displays brief information about the specified volume.

/DEFAULT

Shows the system volume defaults. When a new volume definition is created, all default attributes are set from this default volume definition.

The /DEFAULT qualifier cannot be used with a parameter value.

/FULL

Displays a complete list of information about the volume.

/OUTPUT[=filespec]

/NOOUTPUT

Controls where to write output of the command. By default, the display is written to the current SYS$OUTPUT device. No Wildcard characters are allowed.

If you enter the /OUTPUT qualifier with a partial file specification
(for example, /OUTPUT=[JONES]), HSM$VOLUME is the default file name and .LIS is the default file extension. The output is suppressed if you enter the /NOOUTPUT qualifier.

Examples

The following examples show the SMU SHOW VOLUME command display.

$ SMU SHOW VOLUME

Volume HSM$DEFAULT_VOLUME on Shelf HSM$DEFAULT_SHELF, Shelving is enabled, Unshelving is enabled, Highwater mark detection is disabled,Occupancy full
detection is disabled, Disk quota exceeded detection is disabled

Volume _$1$DKA100: on Shelf HSM$DEFAULT_SHELF, Shelving is enabled,
Unshelving is enabled, Highwater mark detection is enabled, Occupancy full detection is enabled, Disk quota exceeded detection is enabled

Volume _$1$DKA200: on Shelf HSM$DEFAULT_SHELF, Shelving is enabled,
Unshelving is enabled, Highwater mark detection is enabled, Occupancy full detection is enabled, Disk quota exceeded detection is enabled

$ SMU SHOW VOLUME /DEFAULT /FULL

Volume HSM$DEFAULT_VOLUME on Shelf HSM$DEFAULT_SHELF, Shelving is enabled, Unshelving is enabled, Highwater mark detection is disabled, Occupancy full
detection is disabled, Disk quota exceeded detection is disabled
Created: 8-JUN-1995 12:39:33.07
Revised: 8-JUN-1995 12:39:33.07
Ineligible files: <CONTIGUOUS>
High Water Mark: 90%
OCCUPANCY Policy: HSM$DEFAULT_OCCUPANCY
QUOTA Policy: HSM$DEFAULT_QUOTA

Format

Qualifiers

/FORCE

Shut down HSM immediately on the requesting node only. HSM will continue to run on other nodes in the VMScluster. Pending requests are not processed but will be recovered when HSM starts up later.

/NOW

Shut down HSM immediately across the VMScluster. Pending requests are not processed but will be recovered when HSM starts up later.

Example

The following example shows the SMU SHUTDOWN command as should be applied in the system shutdown command procedure, to shut HSM down on one node:

$ SMU SHUTDOWN/FORCE

Format

Examples

The following examples show the SMU SPAWN command:

$ SMU
SMU> SPAWN SET PROCESS/NOAUTO_UNSHELVE
SMU>

alternatively, you could use the following commands:

S SMU
SMU> SPAWN
$ SET PROCESS/NOAUTO_UNSHELVE
$ LOGOUT
SMU>

Format

Examples

The following example shows the SMU STARTUP command:

$ SMU STARTUP
%SMU-S-SHP_STARTED, shelf handler process started 22E0193B
%SMU-S-PEP_STARTED, policy execution process started 22E011BC

Format

Parameters

drive_name

The name of a specific drive to allocate, which must already have been created with a CREATE DRIVE command. The maximum length of the drive name is 31 characters. This parameter is optional. Drives can also be allocated on the basis of other selection criteria

Description

The MDMS ALLOCATE DRIVE command selects and allocates a drive based on one of the following:

• a specified drive
• a specified volume
• a specified media type and optionally location, node or group
• a specified jukebox

The selected local OpenVMS device name and the drive name are assigned to the optional logical name in a search list. Both MDMS and non-MDMS DCL commands may be issued using the logical name. The logical name remains assigned until:

• it is deassigned,
• the allocating process terminates,
• or the MDMS DEALLOCATE DRIVE command specifying the logical name is issued.

The MDMS ALLOCATE DRIVE command allocates the selected drive to the current process. After the MDMS ALLOCATE DRIVE command is issued, the name of the selected drive is displayed on the terminal screen. The DCL SHOW LOGICAL command also displays the OpenVMS local device name and the drive name.

MDMS supports allocation of both local drives and remote drives (using the RDF software). However, allocation of remote drives through RDF is not available if you are running with the ABS-OMT license.

MDMS attempts to allocate a drive local to the node performing the allocation, if one matches the selection criteria. Failing that, a TMSCP-accessible drive is chosen next. If that fails, an RDF-accessible remote drive is chosen.

Privileges

The request requires MDMS_ALLOCATE_ALL or MDMS_ALLOCATE_OWN.

MDMS_ALLOCATE_OWN requires the specification of an owned volume for selection.
All other selections including the drive name parameter, require MDMS_ALLOCATE_ALL.

MDMS_ASSIST is also required unless /NOASSIST is specified.

Restrictions

The drive_name parameter cannot be used with the /MEDIA_TYPE, /JUKEBOX, /LOCATION, /NODE, /GROUP, or /VOLUME qualifiers.

The /JUKEBOX qualifier cannot be used with /GROUP, /LOCATION, /NODE, /VOLUME, or the drive_name parameter.

The /MEDIA_TYPE qualifier cannot be used with /VOLUME or the drive_name parameter.

The /VOLUME qualifier cannot be used with /GROUP, /LOCATION, /MEDIA_TYPE, /NODE, /JUKEBOX or the drive_name parameter.

The /GROUP, /JUKEBOX, /LOCATION and /NODE qualifiers are mutually exclusive. If one is specified, then /MEDIA_TYPE must also be specified (except for /JUKEBOX).

The /[NO]PREFERRED qualifier is ignored if /VOLUME is not supplied.

Qualifiers

/ASSIST (D)

/NOASSIST

The default /ASSIST qualifier outputs an operator request to allocate a drive, if there is a problem allocating a drive immediately. If the operator responds positively to the operator message, the request is retried, otherwise the request fails. The /NOASSIST qualifier performs the operation without operator assistance, and uses the /RETRY and /INTERVAL qualifiers to perform retries. If all retries are exhausted the command fails.

This qualifier requires the right MDMS_ASSIST

/DEFINE=logical_name

Specifies the logical name to be assigned for the drive. The logical name is a process logical name. The maximum length of the logical name is 31 characters. The logical name is assigned to an equivalence string containing the allocated VMS device name and drive name in a search list - as such, both MDMS and non-MDMS commands (e.g. MOUNT) can be issued on the logical name.

/GROUP=group_name

When used with /MEDIA_TYPE, this qualifier specifies the name of the group (of nodes supporting the drive) from which to select and allocate the drive. Only one group may be specified.

This qualifier requires the right MDMS_ALLOCATE_ALL.

/INTERVAL=delta_time

Specifies the interval between retries when no drives are available. If not specified, the default interval is one minute.

/JUKEBOX=jukebox_name

Specifies the name of the jukebox from which the drive will be selected for allocation. The maximum length of the jukebox name is 31 characters. If /MEDIA_TYPE is also specified, the drive to be allocated must be in the jukebox and support the specified media type

This qualifier requires the right MDMS_ALLOCATE_ALL.

/LOCATION=location

When used with /MEDIA_TYPE, this qualifier specifies the location from which to select and allocate the drive. Only one location may be specified.

This qualifier requires the right MDMS_ALLOCATE_ALL.

/MEDIA_TYPE=media_type

Specifies the distinct media type that the drive must support to be allocated. This media type must match one defined for a drive in the media type attribute (for read/write allocation), or in the read only media type attribute (for read-only allocation).

This qualifier requires the right MDMS_ALLOCATE_ALL

/NODE=node_name

When used with /MEDIA_TYPE, this qualifier specifies the name of the node from which to select and allocate the drive. Only one node may be specified.

This qualifier requires the right MDMS_ALLOCATE_ALL

/PREFERRED

/NOPREFERRED (D)

The /PREFERRED qualifier tries to allocate the preferred drive for a volume, when /VOLUME is entered; this is the last drive that the volume was loaded in, if that drive is available. The default /NOPREFERRED forces a round-robin selection.

/REPLY=symbol

Specifies the name of the symbol to receive the operator's reply when operator intervention is needed. The symbol will contain the operator reply to the DCL REPLY/TO or DCL REPLY/ABORT commands. The maximum length of a symbol name is 31 characters.
This qualifier is only applicable when /ASSIST is specified.

/RETRY_LIMIT=number

/NORETRY_LIMIT

Specifies if MDMS should retry the operation if no drive is available and /ASSIST is not specified. The default is /RETRY_LIMIT=0 which means that no retries are performed.
/NORETRY_LIMIT means that there is no limit on the number of retries. Retries are performed at the delta time specified by /INTERVAL. If all retries are exhausted the operation fails.

/VOLUME=volume_id

Specifies if the volume ID of the volume for which an appropriate drive will be selected, can support the volume's media type and placement. If the volume specified currently resides in a jukebox, the drive selected will be from the same jukebox if the drives in the jukebox support the media type of the volume.

The maximum length of the volume ID is 6 characters.

/WRITE (D)

/NOWRITE

Specifies that the drive is to be allocated only for read-only operations. This potentially makes a larger pool of drives available for allocation for certain media types.

Examples

$ MDMS ALLOCATE DRIVE $1$MUA5 /DEFINE=MYDRIVE

This command allocates the drive $1$MUA5 and assigns the drive name to the MYDRIVE logical name. Note that the drive name is the same as the VMS device name in this case.

$ MDMS ALLOCATE DRIVE JUKE_2_DRIVE_1 /ASSIST /REPLY=ALLOC_REPLY

This command allocates drive JUKE_2_DRIVE_1, and requests operator assistance if the allocation fails, and stores the operator's reply message in symbol ALLOC_REPLY.

$ MDMS ALLOCATE DRIVE /VOLUME=LAB003 /NOWRITE /NOPREFERRED

This command allocates a drive that supports volume LAB003 for read-only operations, and requests a round-robin drive selection rather than use the preferred drive.

$ MDMS ALLOCATE DRIVE /JUKEBOX=TESTJUKE /DEFINE=MYDRIVE

This command allocates one of the drives in jukebox TESTJUKE and assigns the device name and drive name to the MYDRIVE logical name.

$ MDMS ALLOCATE DRIVE /MEDIA_TYPE=TK85K /NODE=CRUMBS -
/INTERVAL=00:00:10 /NORETRY_LIMIT

This command allocates a drive that supports the TK85K media type on node CRUMBS, and specifies a retry interval of 10 seconds if a drive is not immediately available with no limit on retries.

Format

Parameters

volume_id

Specifies the volume to allocate. The maximum length of the volume_id is 6 characters.
This parameter is optional, and volumes can be allocated on the basis of
/BIND, /JUKEBOX, /LIKE_VOLUME, /LOCATION, /MEDIA_TYPE or /POOL instead.

Description

The MDMS ALLOCATE VOLUME command allocates available free volumes to the username of the requesting process. The newly allocated volume(s) can also be appended to the end of a volume set. A volume set is defined to be one or more allocated volumes.

When the volume_id parameter is used, that specific volume will be assigned if it is in the Free state. If the volume_id parameter is not used, a Free volume will be selected based on one or more of the following selection criteria:

• Bind volume
• Jukebox
• Like volume
• Location
• Pool
• Media type

Privileges

The request requires MDMS_ALLOCATE_ALL or MDMS_ALLOCATE_POOL.

MDMS_ALLOCATE_POOL requires the volume to be allocated from a named pool to which the calling user is authorized. All other allocations, including allocation from the scratch (unnamed) pool and the specification of /USER_NAME, require MDMS_ALLOCATE_ALL.

The /BIND qualifier requires MDMS_BIND_ALL if the /USER_NAME qualifier is specified, or MDMS_BIND_OWN.

The /BLOCK_FACTOR, /DESCRIPTION, /FORMAT, /RECLENGTH, [NO]SCRATCH_DATE and /[NO]TRANSITION_TIME qualifiers require MDMS_SET_ALL if the /USER_NAME qualifier is specified, or MDMS_SET_OWN or MDMS_SET_POOL.

Restrictions

• The volume_id parameter cannot be used with the /BIND, /JUKEBOX,
  /LIKE_VOLUME, /LOCATION, /MEDIA_TYPE, /POOL, or /QUANTITY qualifiers.
• /BIND cannot be used with the /JUKEBOX, /LIKE_VOLUME, /LOCATION, /POOL,
  /MEDIA_TYPE or /QUANTITY qualifier.
• /LIKE_VOLUME qualifier cannot be used with the /BIND, /JUKEBOX, /LOCATION,
  /MEDIA_TYPE, or /POOL qualifiers.
• /MEDIA_TYPE is required when either /JUKEBOX or /LOCATION are specified.

Qualifiers

/BIND=volume_id

Specifies that the new allocated volume or volume set be appended to the volume set marked by the volume_id. The volume_id specifies selection criteria for allocating the new volume(s). The maximum length of the volume_id is 6 characters.
When the /BIND qualifier is used, the following attributes must match.

• Media Type
• Pool
• Placement (in same jukebox, magazine, or location)
• The BIND volume must be allocated

This qualifier requires the right MDMS_BIND_*

/BLOCK_FACTOR=number

Modifies the block factor attribute of the allocated volume records. If not specified, the block factor attribute is not changed.

This qualifier requires the right MDMS_SET_*

/DEFINE=logical_name

Specifies a logical name to be assigned for the volume allocated. The logical name is a process logical name. If the /QUANTITY qualifier is used, the returned volume will be the first volume in the volume set. The maximum length of the logical name is 31 characters.

/DESCRIPTION="text"

Modifies comments about the object in the volume record. If the text contains spaces, it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters.
To clear the existing description, specify "". If not specified, the volume description is not changed. This qualifier requires the right MDMS_SET_*

/FORMAT=keyword

Modifies the format field in the volume record.
If not specified, the format attribute is not changed.
Valid values are:

• ASCII
• BACKUP
• EBCDIC
• NONE
• RMUBACKUP

This qualifier requires the right MDMS_SET_*

/JUKEBOX=jukebox_name

When specified with /MEDIA_TYPE, allocates a volume that resides in the specified jukebox.

/LIKE_VOLUME=volume_id

Indicates that the allocated volume has attribute values identical to those specified. The following attributes define a "like volume":

• Media type
• Pool
• Placement (in the same jukebox, magazine, or location)

/LOCATION=location

When specified with /MEDIA_TYPE, specifies the location from which to allocate volume(s). If not specified, other selection criteria are used to allocate the volume(s).

/MEDIA_TYPE=media_type

Specifies that the volume(s) are allocated with the specified media type. If not specified, other selection criteria are used to allocate the volume(s).

/POOL=pool_name

Specifies the pool from which the volume(s) will be selected. The maximum length of the pool name is 31 characters.

/QUANTITY=number

Specifies the number of volumes to allocate. Use this qualifier to allocate more than one volume.
The default value is 1. If you enter a number greater than 1, the allocated volumes are bound together in one volume set. If you use the /BIND qualifier, these allocated volumes are bound to the end of the set specified in the /BIND qualifier.

/RECLENGTH=number

Modifies the volume's record length attribute. If not specified, the record length attribute is not changed.

This qualifier requires the right MDMS_SET_*

/SCRATCH_DATE=date

/NOSCRATCH_DATE

Modifies the scratch date in the volume record. The scratch date is the date that the volume is placed in the TRANSITION state (or FREE state if the volume has no transition duration).
If /NOSCRATCH_DATE is specified, the volume will never be automatically deallocated. If not specified, the volume's scratch date is not changed.

This qualifier requires the right MDMS_SET_*

/TRANSITION_TIME=delta_time

/NOTRANSITION_TIME

Modifies the amount of time, as a delta time, that will be applied to the current scratch date to form the length of time the volume(s) will remain in the TRANSITION state before going into the FREE state. Use the standard OpenVMS delta time format to specify a delta time for the duration. If /NOTRANSITION_TIME is specified, the volume goes directly into the FREE state on deallocation. If not specified, the transition time in the volume record is not changed.

This qualifier requires the right MDMS_SET_*

/USER_NAME=username

Specifies the user for whom the volume is being allocated. The username must exist on the system where the command is entered. The maximum length of the username is 31 characters.

This qualifier requires the right MDMS_ALLOCATE_ALL

Examples

$ MDMS ALLOCATE VOLUME /QUANTITY=3 /MEDIA_TYPE=TK85K

This command allocates three TK85K volumes to the current user. The volumes are bound in a new volume set.

$ MDMS ALLOCATE VOLUME /MEDIA=TK85K /LOCATION=CXO

This command allocates one TK85K volume at location CXO to the current user.

$ MDMS ALLOCATE VOLUME /BIND=TEST01

This command allocates one volume with the same attributes as TEST01 to the current user. The new volume is bound to the end of the volume set containing TEST01.

$ MDMS ALLOCATE VOLUME USER30 /DESCRIPTION="MAY REPORTS"

This command allocates volume USER30 to the current user and modifies the volume's description to "MAY REPORTS".

$ MDMS ALLOCATE VOLUME /LIKE_VOLUME=AGW500 /USER_NAME=SYSTEM

This command allocates a volume with similar attributes to volume AGW500, for user SYSTEM

Format

Parameters

volume_id

Specifies the volume ID of the volume to bind.
If an existing volume set is to be bound to another volume or volume set, then the volume ID of the first member of the volume set to bind should be specified. The maximum length of a volume ID is 6 characters. If the volume_id parameter is omitted, a volume with similar characteristics to those in the set will be allocated and bound to the end of the volume set.

Description

The MDMS BIND VOLUME command binds a volume to another volume or volume set or binds a volume set to another volume set. When binding to a volume or volume set, all involved volumes must be allocated and be of the same media type.

While binding a volume set to another volume or volume set, the volume_id parameter must be the first member of the volume set.
To append to the end of a volume set, use the /TO_SET qualifier. Volumes in the volume set must already be allocated to the same user (username and UIC). When a new volume is bound to a volume set the scratch dates of all volumes in the set will be set to the scratch date of the newly bound volume.

Privileges

The request requires MDMS_BIND_ALL or MDMS_BIND_OWN.

If the /USER_NAME qualifier is not specified, MDMS_BIND_OWN allows the user to bind volumes which are allocated to that user. Binding on behalf of another user with the /USER_NAME qualifier requires MDMS_BIND_ALL.

Restrictions

None

Qualifiers

/TO_SET=volume_id

Specifies the volume ID of a volume or volume set member. The volume (set) specified in the volume_id parameter is appended to the end of the volume set containing this volume. The maximum length of the volume ID is 6 characters.
If the volume_id parameter is not provided, then a similar volume to the volume specified in the /TO_SET qualifier is allocated and bound to the end of that volume set.

/USER_NAME=username

Specifies the user for whom the volume is being bound. The username must exist on the system where the command is entered. The maximum length of the username is 31 characters.

This qualifier requires the right MDMS_BIND_ALL

Examples

$ MDMS BIND VOLUME VOL001/TO_SET=VOL006

Volume set 1 contains VOL001, VOL002 and VOL003. Volume set 2 contains VOL004, VOL005 and VOL006. This command binds the volume set containing VOL001 to the volume set containing VOL006. The created volume set will contain volumes VOL004, VOL005, VOL006, VOL001, VOL002, VOL003.
Volumes in both volume sets must have compatible attributes.

$ MDMS BIND VOLUME VOL002 /TO_SET=VOL005 /USER_NAME=SYSTEM

Volume VOL002 is a single volume and VOL005 is part of a volume set that contains VOL004, VOL005 and VOL006. This command binds the volume VOL002 to the volume set containing VOL005. The created volume set will contain volumes VOL004, VOL005, VOL006, VOL002. All the volumes involved are allocated to user SYSTEM.

Format

Parameters

request_id

Specifies the request ID(s) of the request(s) to cancel. If the request ID is not known, the user can issue a SHOW REQUESTS command, which displays the request ID of all outstanding requests.

Description

The MDMS CANCEL REQUEST command cancels the specified outstanding request(s).

Privileges

The request requires MDMS_CANCEL_ALL, MDMS_CANCEL_OWN or MDMS_CANCEL_POOL.

If you are canceling your own request, MDMS_CANCEL_OWN or MDMS_CANCEL_POOL is required. If you are canceling any other request, MDMS_CANCEL_ALL is required.

Restrictions

None

Qualifiers

None

Example

$ MDMS CANCEL REQUEST 812

This command cancels the request with ID 812.

Format

Parameters

drive_name

Specifies the name of the drive. The maximum length of the drive name is 31 characters. The OpenVMS device name must also be specified with the /DEVICE qualifier if it is different from the drive name. The drive name must be unique in the MDMS domain. You should not specify a node in the drive name; rather you should specify either a list of nodes or groups that have access to the drive in the /NODES or /GROUPS qualifiers.

Description

The MDMS CREATE DRIVE command creates a new drive definition in the MDMS configuration database.

While creating a new object record, MDMS supplies default values on attributes that are not specified. Alternatively, they can be inherited from a specified drive using the /INHERIT qualifier.

Privileges

The request requires MDMS_CREATE_ALL.

The /STATE qualifier also requires MDMS_SET_PROTECTED since this attribute is normally managed by MDMS. You should not modify this attribute unless you are trying to recover from an abnormal situation.

Restrictions

The /NODES and /GROUPS qualifiers are mutually exclusive. The MDMS server will refuse this command if both qualifiers are used in the affirmative forms.

The /ADD, /REMOVE and /REPLACE qualifiers are mutually exclusive. If none of them is specified, attributes are added to the list attributes by default.

Qualifiers

/ACCESS=keyword (ALL)

This qualifier defines the type of access to the drive, which can be one of the following keywords:

• ALL - supports local node/cluster access and remote (RDF) access - default
• LOCAL - supports local node/cluster access only
• REMOTE - supports remote (RDF) access only

Access to drives is restricted on allocate requests - for example, it is not possible to allocate a drive designated as local access remotely using RDF. However, with the proper rights, it is possible to issue other MDMS commands (such as LOAD) both locally and remotely.

/ADD

The /ADD qualifier works in conjunction with certain qualifiers that accept lists and adds specified attributes. This is the default while specifying list attributes.

/AUTOMATIC_REPLY (D)

/NOAUTOMATIC_REPLY

Specifies that MDMS automatically replies to all OPCOM messages that can be polled for completion on requests for this particular drive.

/DESCRIPTION="text"

Comments about the drive. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. To clear the description, specify "".

/DEVICE=vms_device_name

Specifies the OpenVMS device name of the drive. This qualifier is required if the OpenVMS device name is different from the drive name. Do not include a node specification (NODE::drive) in the device name - instead, use the /NODES or /GROUPS qualifier.

/DISABLED

Places the drive in the disabled state. This prevents the drive from being selected and allocated for use. This takes effect immediately. However, if the drive is already in use, operations on that drive will continue until the drive is deallocated.

/DRIVE_NUMBER=number

This qualifier defines the drive number for robot commands if the drive is in a jukebox. The default is zero. This qualifier must be specified for multi-drive MRD-controlled jukeboxes.

/ENABLED (D)

Places the drive in the enabled state. This allows the drive to be selected and allocated for use. This takes effect immediately. This is the default.

/GROUPS=(group_name[,...])

/NOGROUPS

Specifies the names of groups of nodes that share common access to this device. Usually, only one group is specified. If neither /NODES or /GROUPS is specified on CREATE, the node from which the command was issued is used as the node name

/INHERIT=drive_name

This qualifier allows you to specify an existing drive record from which the new object record inherits attribute values. MDMS supplies default values if you specify none. All attributes may be inherited with the exception of the following:

• Drive name
• Device name
• State

/JUKEBOX=jukebox_name

If the drive is in a jukebox, this qualifier specifies the jukebox name.

/MEDIA_TYPE=(media_type[,...])

/NOMEDIA_TYPE

Specifies one or more distinct media types that the drive can support for read-write access.
The /REMOVE or /REPLACE qualifiers can remove or replace items in the listing, rather than adding them by default. The /NOMEDIA_TYPES qualifier removes all media types. When a drive is created with no media types, the default media type from the domain is used.

/NODES=(node_name[,...])

/NONODES

Specifies one or more distinct nodes that have direct access to the drive. The /REMOVE or
/REPLACE qualifiers can be used to remove or replace objects in the list, rather than adding them by default. The /NONODE qualifier removes all nodes. If neither /NODES or /GROUPS is specified, the node from which the command was issued is used as the node name

/READONLY=(media_type[,...])

/NOREADONLY

Specifies one or more distinct media types that the drive can support for read-only access.
The /REMOVE or /REPLACE qualifiers can be used to remove or replace objects in the list, rather than adding them by default. The /NOREADONLY qualifier removes all read-only media types.

/REMOVE

The /REMOVE qualifier works in conjunction with certain qualifiers that accept lists and removes specified attributes from them.

/REPLACE

The /REPLACE qualifier works in conjunction with certain qualifiers that accept lists and replaces the existing attributes list with the specified attributes list. By default, list attributes are added to the existing list.

/SHARED

/NOSHARED (D)

The /SHARED qualifier defines that the drive may be used by non-MDMS clients and that the drive is only partially managed. If the drive is set to the default /NOSHARED, the MDMS server allocates the drive at all times it is not used by an application or user. Setting the drive to /SHARED clears this allocation.

/STACKER

/NOSTACKER (D)

The /STACKER qualifier indicates that the drive is to be treated as a stacker gravity loader. The default /NOSTACKER indicates that the drive is to be treated as a standalone drive, or a robotically-controlled jukebox, as appropriate.

/STATE=state

This is a protected field that should be modified only to recover on error. Use the LOAD and UNLOAD commands to manipulate the state field under normal operation. The /STATE qualifier sets the current drive state. The valid keywords are:

• Empty:
• Full
• Loading
• Unloading

This qualifier requires the right MDMS_SET_PROTECTED.

Examples

$ MDMS CREATE DRIVE $1$MUA5:

This command creates a local drive called $1$MUA5 with default parameters supplied by MDMS. In this example, the drive name is equivalent to the OpenVMS device name and the current node is used as the drives node name.

$ MDMS CREATE DRIVE DRIVE_1 /DEVICE=$1$MUA5: /NODE=FARLFT

This command creates a local drive called DRIVE_1 for $1$MUA5 on node FARLFT.

$ MDMS CREATE DRIVE JUKE_1_DRIVE_1 /MEDIA_TYPES=(TK85K, -
TK88K) /DEVICE=$1$MKA500 /GROUPS=COOKIE /SHARE /JUKEBOX=JUKE_1 -
/DRIVE_NUMBER=1 /ACCESS=ALL

This command creates a drive with drive name JUKE_1_DRIVE_1 and OpenVMS device name

$ $1$MKA500 in group COOKIE, for local and remote access, shared by non-MDMS users, and supporting media types TK85K and TK88K. The drive is part of jukebox JUKE_1 with drive number 1.

$ MDMS CREATE DRIVE FRED /ACCESS=REMOTE

This command creates a drive object record named FRED for remote access. MDMS supplies all default attribute values.

$ MDMS CREATE DRIVE SPARKY_5 /DEVICE=$1$MUA5 /NODE=SPARKY -
/DISABLE /MEDIA_TYPES=TK85K /ACCESS=ALL

This command defines drive SPARKY_5 , device $1$MUA5 on node SPARKY, that supports media type TK85K, supports both local and remote access, and is located on remote node SPARKY. The drive is not available for immediate use.

Format

MDMS CREATE GROUP group_name

Parameters

group_name

Specifies the name of the group. A group includes nodes that share a common storage device or some other relationship. There is no limit to the number of groups you may specify, and any node may appear in any number of groups. Groups may or may not be equivalent to clusters in your environment. Groups may be used instead of nodes in drive and jukebox definitions, and also as authorized or default users in pool definitions.

Description

The MDMS CREATE GROUP command creates a new group definition in the MDMS configuration database.

When creating a new object record, the user can specify attribute values or allows for MDMS default value assignments. Alternatively, values can be inherited from a specified group using the /INHERIT qualifier.

Privileges

The request requires MDMS_CREATE_ALL.

Restrictions

The /ADD, /REMOVE and /REPLACE qualifiers are mutually exclusive. If none are specified, attributes are added to list attributes by default.

Qualifiers

/ADD

The /ADD qualifier works in conjunction with certain qualifiers that accept lists and adds specified attributes. This is the default while specifying list attributes.

/DESCRIPTION="text"

Comments about the group. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. To clear the description, specify "".

/INHERIT=group_name

This qualifier allows you to specify an existing group record to inherit attribute values. All attributes may be inherited except for group name.

/NODES=(node_name[,...])

/NONODES

Specifies one or more distinct nodes that are members of the group.
The /REMOVE or /REPLACE qualifiers can be used to remove or replace objects in the list, rather than adding them by default. The /NONODES qualifier removes all nodes. While specifying nodes, the node names are the MDMS node names, which should have an equivalent node object (not the DECnet-Plus (Phase V) or TCP/IP fullnames).

/REMOVE

The /REMOVE qualifier works in conjunction with certain qualifiers that accept lists and removes specified attributes from them.

/REPLACE

The /REPLACE qualifier works in conjunction with certain qualifiers that accept lists and replaces the existing attributes list with the specified attributes list. By default, list attributes are added to the existing list.

Examples

$ MDMS CREATE GROUP HOSER /NODES=(TOOKUS, GREAT, NORTH)

This command creates a group named HOSER and includes the nodes TOOKUS, GREAT, and NORTH.

$ MDMS CREATE GROUP MOUNTIE /INHERIT=HOSER /NODES=LABATT /ADD

This command creates a new group that includes the nodes in the group HOSER and adds node LABATT to the node list. You might use this command if the group HOSER includes all nodes in an OpenVMS Cluster, and you want to manage a device shared between that cluster and node LABATT (which could be a member of a different OpenVMS Cluster)

Format

Parameters

jukebox_name

Specifies the name of the jukebox, which can be up to 31 characters in length. The jukebox name must be unique in the MDMS domain.

Description

The MDMS CREATE JUKEBOX command creates a new jukebox definition in the MDMS configuration database. MDMS supplies attribute values when creating a new object record. Alternatively, they can be inherited from a specified jukebox using the /INHERIT qualifier.

An MDMS jukebox may be controlled by the MRD subsystem if it accepts direct SCSI robotic operations. Each MRD-controlled jukebox contains a set of slots, drives and robotics configured with a single robotic device name, regardless of whether the jukebox is:

• a loader
• a single-tower library or
• a multi-tower library

A robot name must be associated with each MRD-controlled jukebox. For a multi-tower configuration, a topology field may optionally be associated with the jukebox if the jukebox supports direct magazine moves.

Certain other types of jukeboxes, specifically silos manufactured by StorageTek, require the DCSC subsystem for control. With this model, each MDMS jukebox object maps to a Library Storage Module (LSM) containing a carousel of cells, drives and robotics.

One or more LSMs are contained within an Automated Cartridge System (ACS) and one or more ACS's are managed by a UNIX-based system called a library. For each DCSC-controlled jukebox, the library, ACS ID and LSM ID must be specified.

In addition, each LSM contains one or more Cartridge Access Points (CAPS) that are used to move volumes into and out of the jukebox (LSM). Each CAP may contain a different number of cells, so the CAP size should be specified for each CAP for optimal performance. A value of 40 is used if CAP size is not defined for a particular CAP.

Privileges

The request requires MDMS_CREATE_ALL.

The /STATE qualifier also requires MDMS_SET_PROTECTED since this attribute is normally managed by MDMS. Users should not modify this attribute unless they are trying to recover from an abnormal situation.

Restrictions

The /NODES and /GROUPS qualifiers are mutually exclusive. The MDMS server will refuse this command if both qualifiers are used in the affirmative forms.

The /ADD, /REMOVE and /REPLACE qualifiers are mutually exclusive. If no qualifier is specified, attributes are added to list attributes by default.

Qualifiers

/ACCESS=keyword (ALL)

This qualifier defines the type of access to the jukebox, which can be one of the following keywords:

• ALL - supports local node/access and remote access - default
• LOCAL - supports local node/cluster access only
• REMOTE - supports remote access only

/ACS=acs_id

This qualifier specifies the Automated Cartridge System (ACS) Identifier for the jukebox. The default value is zero. Each MDMS jukebox maps to one Library Storage Module (LSM), and requires specification of the library, ACS and LSM identifiers. Valid for DCSC-controlled jukeboxes only.

/ADD

The /ADD qualifier works in conjunction with certain qualifiers that accept lists and adds specified attributes. This is the default when specifying list attributes.

/AUTOMATIC_REPLY (D)

/NOAUTOMATIC_REPLY

Specifies that MDMS automatically replies to all OPCOM messages that can be polled for completion on requests for this particular jukebox.

/CAP_SIZE=(number[,...])

For DCSC jukeboxes equipped with Cartridge Access Points (CAPS), this attribute specifies the number of cells for each CAP. The first number is the size for CAP 0, the next for CAP 1 etc.
If a size is not specified for a CAP, a default value of 40 is used. Specifying the CAP size optimizes the movement of volumes to and from the jukebox by filling the CAP to capacity for each move operation. When specifying CAP sizes, the specified numbers always replace any previous sizes in the database. Valid for DCSC-controlled jukeboxes only.

/CONTROL=keyword

This qualifier specifies the robot control facility used to control the jukebox's robot. The valid keywords are:

• MRD (D) - The robot is controlled with the MRD facility
• DCSC - The jukebox is a silo controlled by the DCSC facility - for StorageTek ® silos only. This option is not available when running with the ABS-OMT license: control is hard-coded to MRD.

/DESCRIPTION="text"

Defines comments about the object in the record. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. To clear the existing description, specify "".

/DISABLED

Places the jukebox in the disabled state. This prevents all drives in the jukebox from being selected and allocated for use. This takes effect immediately. However, any drives in use will continue to be used until they are deselected.

/ENABLED (D)

Places the drive in the enabled state. This allows drives in the jukebox to be selected and allocated for use. This takes effect immediately. This is the default.

/GROUPS=(group_name[,...])

/NOGROUPS

Specifies the names of groups of nodes that share common access to this device. Normally, only one group is specified. The /REMOVE or /REPLACE qualifiers can be used to remove or replace objects in the list, rather than adding them by default. The /NOGROUPS qualifier removes all groups. If neither /NODES nor /GROUPS is specified on CREATE, the node from which the request was issued is used as the node name.

/INHERIT=jukebox_name

This qualifier allows you to specify an existing jukebox record to inherit attributes. MDMS supplies values for attributes you do not specify on creation. All attributes may be inherited except for the following:

• Jukebox name
• Robot name
• State

/LIBRARY=library_id

This qualifier specifies the library identifier for a silo. Valid values are 1, 2, 3, 4, and the default is 1 when the jukebox is controlled by DCSC and 0 (not applicable) when controlled by MRD. Each MDMS jukebox maps to one Library Storage Module (LSM), and requires specification of the library, ACS and LSM identifiers.

/LSM=lsm_id

This qualifier specifies the Library Storage Module (LSM) Identifier for the jukebox. The default value is zero. Each MDMS jukebox maps to one LSM, and requires specification of the library, ACS and LSM identifiers. Valid only for DCSC-controlled jukeboxes.

/LOCATION=location_name

/NOLOCATION

This qualifier specifies the location of the jukebox, which is used when moving volumes into and out of the jukebox. If not specified, or /NOLOCATION is specified, the default onsite location from the domain record is used as the jukebox location.

/NODES=(node_name[,...])

/NONODES

Specifies one or more nodes that can directly access the jukebox.
The /REMOVE or /REPLACE qualifiers can be used to remove or replace objects in the list, rather than adding them by default. The /NONODES qualifier removes all nodes.
If neither /NODES nor /GROUPS is specified on CREATE, the node from which the request was issued is used as the node name.

/REMOVE

The /REMOVE qualifier works in conjunction with certain qualifiers that accept lists and removes specified attributes from them.

/REPLACE

The /REPLACE qualifier works in conjunction with certain qualifiers that accept lists and replaces the existing attributes list with the specified attributes list. By default, list attributes are added to the existing list.

/ROBOT=robot_name

/NOROBOT

The /ROBOT qualifier defines the OpenVMS device name of the robot. Required for, and applicable to MRD-controlled jukeboxes only. Do not specify a node name in the robot name.

/SHARED

/NOSHARED (D)

The /SHARED qualifier defines that the jukebox may be used by non-MDMS clients and that the jukebox is only partially managed. The default, /NOSHARED, indicates that all access to the jukebox is through MDMS.

/SLOT_COUNT=number

The /SLOT_COUNT qualifier specifies the total number of slots in the entire jukebox. For any jukebox, either the slot count or topology must be specified. Valid for MRD-controlled jukeboxes only.

/STATE=keyword

This is a protected field that should be modified only to recover on error. Use the LOAD, UNLOAD or MOVE commands to manipulate the state field under normal operation. The /STATE qualifier specifies the usage state of the jukebox. The keyword values are:

• Available - The jukebox is available for use
• In_use - The jukebox is in use

This qualifier requires the right MDMS_SET_PROTECTED.

/TOPOLOGY=(TOWERS=(number[,...]), FACES=(number[,...]), -
LEVELS=(number[,...]), SLOTS=(number[,...]))

Specifies topology of jukebox, when a TL820-class jukebox is being used as a magazine. Valid for MRD-controlled jukeboxes only.
The topology specification allows OPCOM messages to move magazines to be specified with TOWER, FACE, LEVEL rather than slot range. The specification of topology is optional.
For each tower in the configuration, a corresponding entry must also be placed in FACES LEVELS and SLOTS that reflects the configuration of that tower.
The tower numbers start at zero and additional towers must be the next number in sequence (i.e. 0,1,2 etc.). Other specifications are absolute counts of the entity being specified for each tower (i.e. the total number of faces, levels and slots in each tower).
For example, for a three-tower jukebox, each tower having 8 faces, the first tower having two levels and the other two towers having three levels, and support of 11-slot bin-packs, the topology specification would be:

/TOPOLOGY=(TOWERS=(0,1,2), /FACES=(8,8,8), LEVELS=(2,3,3), SLOTS=(11,11,11)

/USAGE=[NO]MAGAZINE

The /USAGE=MAGAZINE qualifier specifies that the jukebox is configured for magazines, and that the movement of volumes may be performed using magazines. The /USAGE=NOMAGAZINE qualifier does not support magazine use. The default is NOMAGAZINE. You must specify /USAGE=MAGAZINE when defining the /TOPOLOGY attribute. Note that you can use the jukebox for non-magazine moves even when the usage is magazine, but the reverse is not true. Valid for MRD-controlled jukeboxes only.

Examples

$ MDMS CREATE JUKEBOX JUKE_1 /SLOT_COUNT=7 /ROBOT=$1$DUA512: -
/USAGE=MAGAZINE

This command creates a jukebox JUKE_1 with 7 slots and controlled by robot $1$DUA512: and supports magazines. The control type is MRD by default, and the current node is used as the node name supporting the jukebox.

$ MDMS CREATE JUKEBOX JUKE_2 /SLOT_COUNT=140 -
/ROBOT=$1$DUA600 /USAGE=NOMAGAZINE /GROUPS=COOKIE

This command creates a jukebox JUKE_2 with a 140 slots range and controlled by robot $1$DUA600 in group COOKIE. The control type is MRD by default and magazines are not supported.

$ MDMS CREATE JUKEBOX JUKE_3 /CONTROL=DCSC /LIBRARY=1 /ACS=0 /LSM=0, -
/CAP_SIZE=(20,30)

This command creates a jukebox JUKE_3 with a library number of 1, ACS ID of 0 and LSM ID of 0. In addition there are two CAPS with sizes of 20 for CAP 0, and 30 for CAP 1. The control type is DCSC meaning this is a silo, does not support magazines, and other default attribute values are supplied by MDMS.

$ MDMS CREATE JUKEBOX JUKE_4 /CONTROL=MRD /ROBOT=$1$DUA510: -
/TOPOLOGY=(TOWERS=(0,1),FACES=(8,8),LEVELS=(3,2),SLOTS=(11,11))

This command creates a multi-tower jukebox, controlled by MRD with robot name $1$DUA510: Its topology is: TOWER 0 with 8 faces, 3 levels and 11 slots; TOWER 1with 8 faces, 2 levels and 11 slots.

Format

Parameters

location

Specifies the name of the location. The maximum length of the location is 31 characters.

Description

The MDMS CREATE LOCATION command creates a new location definition in the MDMS configuration database. MDMS supplies attribute values you do not define on creation. Alternatively, they can be inherited from a named location object using the /INHERIT qualifier.

Privileges

The request requires MDMS_CREATE_ALL.

Restrictions

None

Qualifiers

/DESCRIPTION="text"

Defines comments about the object in the record. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. To clear the existing description, specify "".

/INHERIT=location

This qualifier allows you to specify an existing location record to inherit default attributes. The default is that MDMS supplies the default values. All attributes may be inherited except for location name.

/LOCATION=location

/NOLOCATION (D)

The /LOCATION qualifier allows you to specify a parent location, thus creating a location hierarchy. If there is no parent location, specify /NOLOCATION. Use parent locations to allow selection of volumes or drives in compatible locations. One location is compatible with another if it has a common parent location in the hierarchy. If you do not wish to utilize the compatible location feature, do not specify parent locations. Locations with common parents are most useful where the parents and siblings are in close proximity to one another (e.g. rooms 101 and 102, with parent location floor 1), and selection of volumes or drives from any of the locations is desired. Do not use parent locations across larger distances.

/SPACES=(range[,...])

/NOSPACES

The /SPACES qualifier defines individual spaces for volumes or magazines at the location. Spaces are alphanumeric strings of up to 8 characters. The spaces can be specified as a range - only a single range is supported. When specifying a range, the first and last spaces in the range must have the same number of characters (as in the example), and there is a limit of 1000 spaces per location. The /NOSPACES qualifier removes all spaces.

Examples

$ MDMS CREATE LOCATION SHELF_40 /SPACES=(40:S001-40:S100)

This command creates a shelf location for volumes with 100 spaces, named 40:S001 to 40:S100.

$ MDMS CREATE LOCATION VAULT_1

This command creates a location named VAULT_1 with no spaces

Format

Parameters

magazine_name

Specifies the name of the magazine. The maximum length of the magazine name is 31 characters.

Description

The MDMS CREATE MAGAZINE command creates a new magazine definition in the MDMS configuration database. Magazines are used for two reasons:

• For compatibility with previous versions of MDMS, where loader-type jukeboxes could only be supported using magazines
• To support a set of volumes in a physical magazine whose placement is the same for all volumes in the magazine. In other words, if a volume is in a magazine, it is moved with all the other volumes in the magazine

Privileges

The request requires MDMS_CREATE_ALL.

Several protected qualifiers also require MDMS_SET_PROTECTED since these attributes are normally managed by MDMS. You should not modify these attributes unless you are trying to recover from an abnormal situation.

The /JUKEBOX, /PLACEMENT, /POSITION and /START_SLOT are qualifiers that also require MDMS_SET_PROTECTED.

Restrictions

None

Qualifiers

/DESCRIPTION="text"

Defines comments about the object in the record. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. To clear the existing description, specify "".

/INHERIT=magazine_name

This qualifier allows you to specify an existing magazine record to inherit default attributes. The default is that MDMS supplies values you do not specify. All attributes may be inherited except for the following:

• Magazine name
• Jukebox name
• Placement
• Position
• Start Slot

/JUKEBOX=jukebox_name

This is a protected field that should only be modified to recover on error. Use the MOVE MAGAZINE command to set up the jukebox name under normal operations. This qualifier specifies the name of the jukebox in which the magazine resides. The maximum length of the jukebox name is 31 characters.

This qualifier requires the right MDMS_SET_PROTECTED.

/OFFSITE=([LOCATION=location][,[NO]DATE[=date]])

/NOOFFSITE(D)

This qualifier specifies the date that the magazine is to be taken offsite and the offsite location. The location field is required when using the /OFFSITE qualifier if no location has been previously specified. The LOCATION keyword cannot be negated and if specified must point to a valid location object. Specify a VMS absolute or delta time in the date field. The NODATE keyword may be used to remove the date. This has the effect of disabling the schedule for the magazine, while retaining the location. To clear the offsite date and location, specify /NOOFFSITE.

/ONSITE=([LOCATION=location][,[NO]DATE[=date]])

/NOONSITE(D)

This qualifier specifies the date that the magazine is to be brought back onsite and the onsite location. The location field is required when using the /ONSITE qualifier if no location has been previously specified. The LOCATION keyword cannot be negated and if specified must point to a valid location object. Specify a VMS absolute or delta time in the date field. The NODATE keyword may be used to remove the date. This has the effect of disabling the schedule for the magazine, while retaining the location. To clear the onsite date and location, specify /NOONSITE.

/PLACEMENT=keyword

This is a protected field that should only be modified to recover on error. Use the MOVE MAGAZINE command to set up the placement under normal operations. This qualifier defines the current placement of the magazine. The following options are available:

• JUKEBOX
• OFFSITE
• ONSITE
• MOVING

This qualifier requires the right MDMS_SET_PROTECTED.

/POSITION=(tower,face,level)

This is a protected field that should only be modified to recover on error. Use the MOVE MAGAZINE command to set up the position under normal operations. The /POSITION qualifier specifies the position in the jukebox where the magazine resides.
The `tower, face and level' specification, represents the relative number of the tower, face and level, starting from 0. So for the absolute jukebox slot of zero, the corresponding position is (0,0,0). The next position in the jukebox would be (0,0,1) and so on, according to the topology defined for the jukebox.

This qualifier requires the right MDMS_SET_PROTECTED.

/SLOT_COUNT=number

The /SLOT_COUNT qualifier specifies the number of slots in a magazine to store volumes.

/SPACES=(range)

/NOSPACES

This qualifier specifies the space(s) in a location in which the magazine is stored when not in a jukebox. Spaces are alphanumeric strings of up to 8 characters. The /NOSPACES qualifier removes all spaces.

/START_SLOT=number

This is a protected field that should only be modified to recover on error. Use the MOVE MAGAZINE command to set up the start slot under normal operations. This qualifier specifies the starting jukebox slot when the magazine is placed in a jukebox.

This qualifier requires the right MDMS_SET_PROTECTED.

Examples

$ MDMS CREATE MAGAZINE MYMAG01 /SLOT_COUNT=7 -
/ONSITE=(LOCATION=SHELF1) /SPACE=2

This command creates a magazine called MYMAG01 with 7 slots, which is stored in location space 2 in location shelf 1 when not in a jukebox.

$ MDMS CREATE MAGAZINE MAG002 /SLOT_COUNT=32 /SPACES=(SA001-SA032)-
/ONSITE=(LOCATION=HEADQUARTERS, DATE=01-JAN-2001) -
/OFFSITE=(LOCATION=DPS, DATE=01-JAN-2000)

This command creates a magazine MAG002, with 32 slots, which is stored in onsite location HEADQUARTERS in spaces SA001-SA032, due to be moved offsite on 01-Jan-2001 to location DPS, and back onsite on 01-Jan-2001.

$ MDMS CREATE MAGAZINE MAG003 /SLOT_COUNT=32 /SPACES=SPC001 -
/JUKE=JUKE_1 /POSITION=(0,1,2)

This command creates a magazine MAG003, with 32 slots, which is stored in space SPC001. When in a jukebox, the magazine resides in jukebox JUKE_1 in the position tower 0, face 1, level 2. Note that jukebox and position should not normally be specified rather, these are set up when moving the magazine into the jukebox with a MOVE MAGAZINE command.

Format

Parameters

media_type

Specifies the name of the media type. The maximum length of the media type name is 31 characters.

Description

The MDMS CREATE MEDIA_TYPE command creates a new media type definition in the MDMS configuration database. A media type definition consists of a required density, and optional compaction length and capacity, if applicable.

Privileges

The request requires MDMS_CREATE_ALL.

Restrictions

None

Qualifiers

/CAPACITY=number

The /CAPACITY qualifier specifies the capacity in megabytes of the tape. This is used by some MDMS clients to estimate end-of-tape conditions. By default, capacity is set to zero.

/COMPACTION (D)

/NOCOMPACTION

The /COMPACTION qualifier specifies that the media type should use compaction when writing to tape. This is the default. If you do not wish to use compaction, then specify /NOCOMPACTION.

/DENSITY=density

Specifies a density string between 1 and 31 characters in length that the media type supports. Note that the COMP keyword for compaction should be specified in the /COMPACTION attribute, not density.

/DESCRIPTION="text"

Defines comments about the media type. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description is can range from 0 to 255 characters. Specify to clear the description.

/INHERIT=media_type

This qualifier allows you to specify an existing media type record to inherit default attributes. The default is that MDMS supplies values you do not specify on creation. All attributes may be inherited except media type name.

/LENGTH=length

The /LENGTH qualifier specifies the length of a 9-track magnetic tape, and is expressed in feet. By default, length is set to zero.

Examples

$ MDMS CREATE MEDIA_TYPE TK85K_COMP /DENSITY=TK85 /COMPACTION

This command creates a new media type called TK85K_COMP, which supports the TK85 density with compaction.

$ MDMS CREATE MEDIA_TYPE TAPE_800 /DENSITY=800 /LENGTH=2400

This command creates a new media type called TAPE_800, a 9-track media type with 800 bpi density and a length of 2400 feet.

$ MDMS CREATE MEDIA_TYPE TAPE_1600 /INHERIT=TAPE_800 /DENSITY=1600

This command creates a new media type called TAPE_1600, a 9-track media type with 1600 bpi density and a length of 2400 feet. (inherited from media type TAPE_800).

Format

Parameters

node_name

Specifies the name of the node. The maximum length of the node name is 31 characters - do not append colons to the node name. The node name should be the DECnet (Phase IV) node name (i.e. SYS$NODE) if DECnet (Phase IV) is supported on the node - otherwise it should be a unique name chosen by the MDMS administrator. If DECnet-Plus (Phase V) and/or TCP/IP are supported, the appropriate full names should be stored as attributes of the node. Do not use the node name to specify the full names.

Description

The MDMS CREATE NODE command creates a new node definition in the MDMS configuration database. A node record must exist for each node that can act as a client to the database server. In addition, a node record must exist for each node capable of being a database server.

When creating a new object record, default attributes are supplied by MDMS. Alternatively, they can be inherited from a specified node using the /INHERIT qualifier.

Privileges

The request requires MDMS_CREATE_ALL.

Restrictions

The /ADD, /REMOVE and /REPLACE qualifiers are mutually exclusive. If no qualifier is specified, attributes are added to list attributes by default.

Qualifiers

/ADD

The /ADD qualifier works in conjunction with certain qualifiers that accept lists and adds specified attributes. This is the default while specifying list attributes.

/DATABASE_SERVER (D)

/NODATABASE_SERVER

The /DATABASE_SERVER qualifier means the node can be a database server, supporting fail-over operations. To be a database server, the node must have direct access to the MDMS database files.

In addition, this node name should be added to the definition of the logical name MDMS$DATABASE_SERVERS in SYS$STARTUP:MDMS$SYSTARTUP.COM on all nodes in the domain

/DECNET_PLUS_FULLNAME=node_fullname

This qualifier allows you to specify the DECnet-Plus (Phase V) full name for a node. This full name may be up to 255 characters. If this node has a DECnet-Plus name defined by logical name "SYS$NODE_FULLNAME" then the DECNET_PLUS_FULLNAME has to be defined for this node and has to exactly match the DECnet-Plus (Phase V) name.

The DECNET_PLUS_FULLNAME has to be defined for this node to be fully enabled when the DECnet transport has been enabled if the node is running DECnet-Plus. The full name can be specified in upper or lower case.

/DESCRIPTION="text"

Defines comments about the node. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. Specify "" to clear the description.

/DISABLED

Places the node in the disabled state. This prevents the node from participating in the MDMS domain as either a server or a client. This takes effect immediately.

/ENABLED (D)

Places the node in the enabled state. This allows the node to participate in MDMS operations. This takes effect immediately. This is the default.

/INHERIT=node_name

This qualifier allows you to specify an existing node record to inherit attributes. The default is that MDMS supplies attribute values you do not supply on creation. All attributes may be inherited except for:

• Node name
• DECnet fullname
• TCPIP fullname

/LOCATION=location

/NOLOCATION

This qualifier specifies the location of the node, which is used when allocating volumes and drives. If not specified, or /NOLOCATION is specified, the default onsite location from the domain record is used as the node location.

/OPCOM=(class[,...])

/NOOPCOM

The /OPCOM qualifier adds the specified classes used for notifying operators. All OPCOM for devices on the node are sent to all specified classes on the node. The /REMOVE or /REPLACE qualifiers can be used to remove or replace classes in the list, rather than adding them by default. Specify /NOOPCOM to disable OPCOM notification. By default, the node acquires OPCOM classes from the domain record. The following classes are valid:

/REMOVE

The /REMOVE qualifier works in conjunction with certain qualifiers that accept lists and removes specified attributes from them.

/REPLACE

The /REPLACE qualifier works in conjunction with certain qualifiers that accept lists and replaces the existing attributes list with the specified attributes list. By default, list attributes are added to the existing list.

/TCPIP_FULLNAME=node_fullname[:low_port-high_port]

This qualifier allows you to specify the TCP/IP full name for a node. The full name may be up to 255 characters.
If this node has a TCP/IP name defined by logical name "*INET_HOST" the TCPIP_FULLNAME has to be defined and has to exactly match the full IP name as "<INET_HOST>.<INET_DOMAIN>".
For INET_DOMAIN see logical name "*INET_DOMAIN".
The TCPIP_FULLNAME has to be defined in order for this node to be fully enabled when the TCPIP transport has been enabled. The fullname can be specified in upper or lower case.

The low_port and high_port numbers specify the range of TCP/IP port numbers used by the server to listen for incoming requests. The default is 2501-2510. If this conflicts with other applications, a new range above 1023 can be specified. The range should contain at least 10 port numbers for the MDMS server to select one at a time.

Note that the MDMS GUI requires TCP/IP running on all GUI nodes, and on the MDMS server nodes to which the GUI may connect.

/TRANSPORT=(keyword[,...])

Specifies the network transports to be used, as a prioritized ordered list.
The /REMOVE or /REPLACE qualifiers can be used to remove or replace objects in the list, rather than adding them by default. Enter one or more of:

• DECNET - listen to incoming requests from other MDMS servers on DECnet (Phase IV) or DECnet-Plus (Phase V)
• TCPIP - listen to incoming requests from other MDMS servers on TCP/IP

Setting a new transport will automatically start the listener for this transport on the database server node. Likewise, removing a transport will take place within 10 seconds on the database server node. For client nodes, transport changes will take place the next time network connections time out (usually within 10 minutes). If the change needs to take place immediately, the client node server process must be restarted. The node name and/or the node full names have to be set accordingly for a transport to work correctly.

Examples

1. MDMS CREATE NODE TABLES /LOCATION=COMPUTER_LAB_1 -
/TRANSPORT=(DECNET,TCPIP) /OPCOM=(CENTRAL,TAPES) -
/TCPIP_FULLNAME=TABLES.CXO.DEC.COM

This command creates a new node definition named "TABLES" with a location, transport protocols and OPCOM classes. The node supports DECnet (node name TABLES) and TCP/IP with a fullname of TABLES.CXO.DEC.COM.

2. MDMS CREATE NODE CHAIRS /INHERIT=TABLES -
/DECNET_PLUS_FULLNAME=DEC:CHAIRS.CXO.DEC.COM -
/TCPIP_FULLNAME=CHAIRS.CXO.DEC.COM:3000-3050

This command creates a new node named CHAIRS, which inherits location, OPCOM classes and transport definitions from node TABLES, with specified DECnet-Plus and TCPIP full names. The TCP/IP connections may be received over ports 3000 - 3050.

Format

Parameters

pool_name

Specifies the name of the pool. The maximum length of the pool name is 31 characters.

Description

The MDMS CREATE POOL command creates a new pool definition in the MDMS pool configuration database. A pool definition consists of a list of authorized users, and users for whom the pool is the default pool. If a user is listed in either list, he/she is authorized for the pool.

Privileges

The request requires MDMS_CREATE_ALL.

Restrictions

The /ADD, /REMOVE and /REPLACE qualifiers are mutually exclusive. If no qualifier is specified, attributes are added to list attributes by default.

Qualifiers

/ADD

The /ADD qualifier works in conjunction with certain qualifiers that accept lists and adds specified attributes. This is the default while specifying list attributes.

/AUTHORIZED_USERS=(node/group_name::username[,...])

/NOAUTHORIZED_USERS

Specifies one or more distinct users to the pool specified by node or group name and user name. Only authorized or default users can allocate volumes belonging to the pool. The /REMOVE or
/REPLACE qualifiers can be used to remove or replace users in the list, rather than adding them by default.

/DEFAULT_USERS=(node/group_name::username[,...])

/NODEFAULT_USERS

Specifies one or more distinct users to the pool as the users' default pool. Only authorized or default users can allocate volumes belonging to the pool. The /REMOVE or /REPLACE qualifiers can be used to remove or replace users in the list, rather than adding them by default. A particular node/group::user combination should only be defined with the /DEFAULT qualifier for one pool.

/DESCRIPTION="text"

Defines comments about the pool. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. Specify "" to clear the description.

/INHERIT=pool_name

This qualifier allows you to specify an existing pool record to inherit attributes. The default is that MDMS supplies values you do not supply on creation. All attributes except pool name may be inherited.

/REMOVE

The /REMOVE qualifier works in conjunction with certain qualifiers that accept lists and removes specified attributes from them.

/REPLACE

The /REPLACE qualifier works in conjunction with certain qualifiers that accept lists and replaces the existing attributes list with the specified attributes list. By default, list attributes are added to the existing list.

Examples

$ MDMS CREATE POOL TEST_POOL/AUTHORIZE=COOKIE::ABS

This command creates a pool called TEST_POOL with one authorized user.

$ MDMS CREATE POOL JIMS_POOL /DEFAULT=(OREO::JIM, CRUMBS::JIM, DSORDS::JIM)

This command adds default users to pool JIMS_POOL. The names before the double colons are a mixture of node names and group names.

Format

Parameters

volume_id

Specifies the volume ID of the volume to be added. The volume ID is the external label for the volume. The maximum length of the volume ID is 6 characters. Alternatively, a volume range, separated by a dash, may be specified. A volume range is a numeric range for up to the last three characters of the volume ID. Example ranges are (ABC001-ABC250), (ABC120-ABC125).

There is a limit of 1000 volumes in a valid range and ranges must be numerically increasing.

Either a volume ID or a volume range must be entered in the command, unless the /VISION qualifier is used to automatically determine volume identifiers in a jukebox.

Description

The MDMS CREATE VOLUME command creates a new volume definition in the MDMS volume database. The external label will be used to track the volume in the database. The external label must match the on-tape internal volume label when the volume is initialized.

Privileges

The request requires MDMS_CREATE_ALL or MDMS_CREATE_POOL.

If the user is creating a volume in a named pool to which he is authorized, MDMS_CREATE_POOL is sufficient. The /POOL qualifier must be specified. Otherwise the request requires MDMS_CREATE_ALL.

Several of the qualifiers are designated protected, and require the right MDMS_SET_PROTECTED.
These fields are normally set up by MDMS, and modification is not recommended since you could put the database into an inconsistent state.

Restrictions

The /VISION qualifier is incompatible with the volume_id parameter.

The /ADD, /REMOVE and /REPLACE qualifiers are mutually exclusive. If no qualifier is specified, attributes are added to list attributes by default.

Qualifiers

/ACCOUNT="text"

Defines the account name of the volume. The account name may be up to 31 characters. If it contains spaces, it must be enclosed in quotation marks. Specify " " to clear the account name.

This attribute is protected by MDMS_SET_PROTECTED.

/ADD

The /ADD qualifier works in conjunction with certain qualifiers that accept lists and adds specified attributes. This is the default when specifying list attributes.

/ALLOCATED_DATE=date

/NOALLOCATED_DATE

Specifies the date the volume was allocated. Normally this is set by MDMS. Specify a VMS absolute date and time. Specify /NOALLOCATED_DATE to clear the allocated date.

This qualifier requires the right MDMS_SET_PROTECTED.

/AVAILABLE

The /AVAILABLE qualifier moves a volume from the UNAVAILABLE state to the state it was previously in prior to the UNAVAILABLE state. The volume may then be moved into the TRANSITION or FREE state if the scratch date and/or transition time have expired.

/BLOCK_FACTOR=number

Specifies the block factor the volume. The default is a block factor of zero.

/BRAND="text"

The media manufacturer. The maximum length of the brand name is 31 characters. If it contains spaces it must be contained in quotation marks. Specify "" to clear the description.

/CLEANED_DATE=date

/NOCLEANED_DATE

This qualifier specifies the date the volume was last cleaned and is entered as a VMS absolute time. Specify /NOCLEANED_DATE to clear the cleaned date. The default cleaned date is the date/time the volume was created.

/CREATION_DATE=date

/NOCREATION_DATE

The date the volume is created. This attribute is set by MDMS, but may be overridden if necessary. The default creation date is the date/time the volume was created.

This qualifier requires the right MDMS_SET_PROTECTED.

/DEALLOCATED_DATE=date

/NODEALLOCATED_DATE

This qualifier specifies the actual deallocation date for the volume. Specify a VMS absolute time. This date is normally set by MDMS.

This qualifier requires the right MDMS_SET_PROTECTED.

/DESCRIPTION="text"

Comments about the volume. If the text contains spaces, then it must be enclosed within quotation marks. The length of the description can range from 0 to 255 characters. Specify "" to clear the description.

/DRIVE=drive_name

/NODRIVE

This is a protected field that should only be modified to recover on error. Use the LOAD and UNLOAD commands to set up the drive under normal operations. This qualifier specifies the drive that the volume currently resides in or last resided in. This is normally set up by MDMS. To clear the drive, specify /NODRIVE.

This qualifier requires the right MDMS_SET_PROTECTED.

/FORMAT=keyword

Specifies the format of the tape. Possible values are:

• ASCII
• BACKUP (D)
• EBCDIC
• NONE
• RMUBACKUP

/FREED_DATE=date

/NOFREED_DATE

Specifies the date the volume was last freed (i.e. put in the FREE state). Specify a VMS absolute date and time. This is normally set up by MDMS. To clear the freed date, specify /NOFREED_DATE.

This qualifier requires the right MDMS_SET_PROTECTED.

/INHERIT=volume_id

This qualifier allows you to specify an existing volume record to inherit default attributes. The default is that MDMS supplies values you do not supply on creation. All attributes may be inherited with the exception of the following protected fields:

• Account
• Allocated date
• Accessed date
• Available state
• Creation date
• Deallocated date
• Drive name
• Freed date
• Initialized date
• Job name
• Jukebox name
• Magazine name
• Owner
• Placement
• Slot
• State
• User Name
• Next and previous volumes (cannot be set)

/INITALIZED_DATE=date

/NOINITIALIZED_DATE

Specifies the date the volume was last initialized. Specify a VMS absolute date and time. This is normally set up by MDMS. To clear the initialized date, specify /NOINITIALIZED_DATE.

This qualifier requires the right MDMS_SET_PROTECTED.

/IO_ERROR_COUNT=number

This qualifier allows you to set the number of I/O errors on the volume. The default value is zero.

/JOB_NAME="text"

This qualifier allows you to specify the last job that accessed the volume. The job name can be from 0 to 31 characters. If it contains spaces, it must enclosed in quotation marks. Specify "" to clear the job name.

This qualifier requires the right MDMS_SET_PROTECTED.

/JUKEBOX=jukebox_name

/NOJUKEBOX

This is a protected field that should only be modified to recover on error. Use the MOVE VOLUME command to set up the jukebox name under normal operations. This qualifier allows you to specify that the volume is currently residing or last resided in the specified jukebox. The maximum length of a jukebox name is 31 characters. To clear the jukebox name, specify /NOJUKEBOX.

This qualifier requires the right MDMS_SET_PROTECTED.

/LAST_ACCESS_DATE=date

/NOLAST_ACCESS_DATE

Specifies the date the volume was last loaded by MDMS. Specify a VMS absolute date and time. This is normally set up by MDMS. To clear the last access date, specify /NOLAST_ACCESS_DATE.

This qualifier requires the right MDMS_SET_PROTECTED.

/MAGAZINE=magazine_name

/NOMAGAZINE

This is a protected field that should only be modified to recover on error. Use the MOVE VOLUME command to set up the magazine name under normal operations. This qualifier specifies the magazine name if the volume resides in a magazine. To clear the magazine name, specify /NOMAGAZINE.

This qualifier requires the right MDMS_SET_PROTECTED.

/MEDIA_TYPES=(media_type[,...])

/NOMEDIA_TYPES

The media type qualifier allows you to add the media type(s) that the volume can support. Multiple media types are supported prior to the volume being initialized. After initialization, a volume can only support one media type.
The /REMOVE or /REPLACE qualifiers can be used to remove or replace objects in the list, rather than adding them by default. To specify the volume supports no media types, enter /NOMEDIA_TYPES. If a volume is created with no media types, the default media type from the domain record is used.

/MOUNT_COUNT=number

Specifies the number of times the volume has been loaded by MDMS. Normally set up by MDMS. The default mount count is zero.

/OFFSITE=([LOCATION=location][, [NO]DATE[=date]])

/NOOFFSITE(D)

This qualifier specifies the date that the volume is to be taken offsite and the offsite location. The location field is required when using the /OFFSITE qualifier if no location has been previously specified. The LOCATION keyword cannot be negated and if specified must point to a valid location object. Specify a VMS absolute or delta time in the date field.

The NODATE keyword may be used to remove the date. This has the effect of disabling the schedule for the volume, while retaining the location. To clear the offsite date and location, specify /NOOFFSITE. If a volume is under magazine control, the /OFFSITE qualifier is not allowed. The volume inherits these values from the magazine object. If /MAGAZINE is used on the SET VOLUME command when an existing /OFFSITE location and date are set, the values are cleared.

/ONSITE=([LOCATION=location][, [NO]DATE=date]])

/NOONSITE (D)

This qualifier specifies the date that the volume is to be brought back onsite and the onsite location. The location field is required when using the /ONSITE qualifier if no location has been previously specified. The LOCATION keyword cannot be negated and if specified must point to a valid location object. Specify a VMS absolute or delta time in the date field. The NODATE keyword may be used to remove the date. This has the effect of disabling the schedule for the volume, while retaining the location. To clear the onsite date and location, specify /NOONSITE. If a volume is under magazine control, the /ONSITE qualifier is not allowed. The volume inherits these values from the magazine object. If /MAGAZINE is used on the SET VOLUME command when an existing /ONSITE location and date are set, the values are cleared.

/OWNER=uic

/NOOWNER

This qualifier specifies the owner of a volume. The owner field must be a UIC in the format [USER] or [group, user]. This is normally set up by MDMS on allocate volume. To clear the owner field, specify /NOOWNER.

This qualifier requires the right MDMS_SET_PROTECTED.

/PLACEMENT=keyword

This is a protected field that should only be modified to recover on error. Use the MOVE VOLUME command to set up the placement under normal operations. This qualifier defines the current placement of the volume. The following options are available:

• DRIVE
• ONSITE
• MAGAZINE
• JUKEBOX
• OFFSITE
• MOVING

If a magazine name is specified on the /MAGAZINE qualifier, the volume placement can be in one of three states:

• MAGAZINE
• DRIVE
• MOVING

During a MOVE, LOAD or UNLOAD, a volume's placement may be set to MOVING indicating that the volume is being moved. If a volume is in a magazine, it is set to MOVING when the volume is being loaded or unloaded to/from a drive.

This qualifier requires the right MDMS_SET_PROTECTED.

/POOL=pool_name

/NOPOOL (D)

The pool to which the volume belongs. The maximum length of the pool name is 31 characters. Spaces are not allowed in the pool name. If no pool is specified, the volume is considered to be part of a scratch pool and can be allocated by any user.

/PREINITIALIZED

/NOPREINITIALIZED (D)

This qualifier specifies whether the volume has been initialized before creation. If /PREINITIALIZED is specified, the volume is placed in the FREE state rather than the UNINITIALIZED state.

/PROTECTION=protection

The protection code for the volume. Use the standard OpenVMS protection code format. This protection is written to volumes when initialized by MDMS. If not specified, the default protection from the domain record is used.

/PURCHASED_DATE=date

/NOPURCHASED_DATE

The date when the volume was purchased. The date should be specified as an OpenVMS absolute time. Specify /NOPURCHASED_DATE to clear the purchased date. The default purchased date is the date/time that the volume was created.

/RECLENGTH=number

This qualifier specifies the record length used on the volume. The default record length is zero.

/RELEASE

This qualifier puts the volume into the FREE state from the TRANSITION state. It is not valid to release an allocated volume.

/REMOVE

The /REMOVE qualifier works in conjunction with certain qualifiers that accept lists, and removes specified attributes from them.

/REPLACE

The /REPLACE qualifier works in conjunction with certain qualifiers that accept lists, and replaces the existing attributes list with the specified attributes list. By default, list attributes are added to the existing list.

/RETAIN

This qualifier puts the volume that is in the FREE state or TRANSITION state back into the ALLOCATED state with the former owner as the current owner. If the volume was in a volume set, the volume set relationships are retained.

/SCRATCH_DATE=date

/NOSCRATCH_DATE

The /SCRATCH_DATE qualifier specifies the planned date to return the volume from the ALLOCATED state to either the TRANSITION state or the FREE state.
Specify /NOSCRATCH_DATE if the volume should not automatically transition from the allocated state.

/SLOTS=(range[,...])

/NOSLOTS

This qualifier specifies the jukebox or magazine slot that the volume currently resides in. Specify a number in the range of the jukebox or magazine. This is normally set up by MDMS. If the volume does not currently reside in a jukebox or magazine slot, specify /NOSLOTS.
If no volume ID is specified, or if a volume range is specified, a slot range can be included, so that each volume in the range will get placed in individual slots in order. For a single volume, a single slot should be specified.

This qualifier requires the right MDMS_SET_PROTECTED.

/SPACES=(range[,...])

/NOSPACES

This qualifier specifies the non-jukebox space in the specified location that the volume resides in. If the volume does not reside in a location space, specify /NOSPACES.
Use a space range only when modifying multiple volumes - each volume will be placed in individual spaces in order. For a single volume, a single space should be specified.

/STATE=keyword

This is a protected field that should only be modified to recover on error. Use the ALLOCATE VOLUME and DEALLOCATE VOLUME commands to set up the state under normal operations. This qualifier allows you to modify the state of the volume. This is normally set up by MDMS and manual modification is not recommended.

The keyword values are:

• ALLOCATED
• FREE
• TRANSITION
• UNAVAILABLE
• UNINITIALIZED

This qualifier requires the right MDMS_SET_PROTECTED.

/TIMES_CLEANED=number

This qualifier allows you to specify the number of times the volume has been cleaned. The default is zero.

/TRANSITION_TIME=delta_time

/NOTRANSITION_TIME

The /TRANSITION_TIME qualifier specifies that the volume enters the TRANSITION state when the scratch date is reached, and is to stay in the TRANSITION state for the specified delta time. When the TRANSITION time has expired, the volume enters the FREE state.
The /NOTRANSITION_TIME qualifier specifies that the volume enters the FREE state directly at the scratch date.

/UNAVAILABLE

Puts the volume in the UNAVAILABLE state. The previous state is retained for when the volume is made AVAILABLE again.

/USER_NAME=username

/NOUSER_NAME

Specifies the user for the volume. The username can be from 1-31 characters, and must reflect an authorized VMS username. To clear the username, enter /NOUSER.

This qualifier requires the right MDMS_SET_PROTECTED.

/VISION

This qualifier specifies that volume IDs are to be read using a vision system in a suitably-equipped jukebox. No volume ID or volume range should be specified when using this qualifier. Valid only for MRD jukeboxes equipped with a VISION system.

Examples

$ MDMS CREATE VOLUME ABC001 /MEDIA=TK85K /ONSITE=(LOCATION=SHELF2) /SPACES=1

This command creates a new volume definition for volume ABC001, of media type TK85K, which is stored in the location SHELF2 space 1.

$ MDMS CREATE VOLUME /INHERIT=DEF000 /JUKEBOX=JUKE_1 /SLOTS=(0-50) /VISION

This command creates volume records for the newly imported volumes in slots 0-50 of the jukebox JUKE_1, and the volume labels are generated using the vision system, and other attributes are inherited from volume DEF000.

$ MDMS CREATE VOLUME HS0001-HS0007 /INHERIT=TK85MG /MAGAZINE=TX877A /SLOTS=(0-6)

This command creates seven volume records HS0001-HS0007, which are stored in magazine TX877A in slots 0-6 respectively, and other attributes are inherited from template volume TK85MG.

Format

Parameters

drive_name

Specifies the drive name to be deallocated. Specify a drive name or the logical name previously defined in the allocate. The maximum length of the drive name or logical name is 31 characters.

Description

The MDMS DEALLOCATE DRIVE command deallocates a drive. If a logical name is supplied for the drive_name parameter, the logical name will be deassigned.

Privileges

The request requires MDMS_DEALLOCATE_ALL or MDMS_DEALLOCATE_OWN.

Restrictions

Can only be issued by the process that allocated the drive. If that process terminates, the drive is automatically deallocated.

Qualifiers

None

Examples

$ MDMS DEALLOCATE DRIVE MYDRIVE

This command deallocates the drive assigned to the MYDRIVE logical and deassigns the logical name MYDRIVE.

$ MDMS DEALLOCATE DRIVE $1$MUA1

This command deallocates drive $1$MUA1.

Format

Parameters

volume_id

Specifies the volume ID of the volume to deallocate. The maximum length of a volume ID is 6 characters. This parameter is required except when the /SCHEDULE qualifier is given, in which case it must be omitted.

Description

The MDMS DEALLOCATE VOLUME command puts an allocated volume in either the TRANSITION state or the FREE state, depending on volume attributes, which can be overridden in the command.

In addition, this command will update the state of the volume to FREE if the deallocated date plus transition time has expired, or if you issue a DEALLOCATE VOLUME/STATE=FREE command. If you deallocate a volume set, the volume set relationships are invalidated, but can be recovered on a SET VOLUME/RETAIN. The volume set relationships are deleted on the next allocation of the volume.

Privileges

The request requires MDMS_DEALLOCATE_ALL or MDMS_DEALLOCATE_OWN.

If the user is deallocating a volume owned by him, MDMS_DEALLOCATE_OWN is sufficient. If the user is deallocating on behalf of another user with the /USER_NAME qualifier, then the request requires MDMS_DEALLOCATE_ALL.

If the /STATE or /TRANSITION_TIME qualifiers are entered, the user needs MDMS_SET_ALL if the /USER_NAME qualifier is specified, or MDMS_SET_OWN or MDMS_SET_POOL.

Restrictions

• The /SCHEDULE and volume_id parameters are incompatible.
• The /SCHEDULE and /NOVOLSET qualifiers are incompatible

Qualifiers

/SCHEDULE

The /SCHEDULE qualifier selects volumes whose scratch dates or freed dates have expired, and moves them into the TRANSITION state or FREE state respectively. No volume_id parameter is allowed when this qualifier is given.

/STATE=state

Specifies the state in which to place the deallocated volume. The valid state values are FREE and TRANSITION. If the state is not specified and no transition time is specified, the deallocation state in the domain record is used.

This qualifier requires the right MDMS_SET_*

/TRANSITION_TIME=delta_time

/NOTRANSITION_TIME

Modifies the amount of time, as a delta time, that a volume will remain in the TRANSITION state before moving to the FREE state. Use the standard OpenVMS delta time format to specify a delta time for the transition duration.
If not specified, the existing transition time in the volume record is used, and if none, the default transition time in the domain record is used.

This qualifier requires the right MDMS_SET_*

/USER_NAME=username

Deallocate a volume which is owned by the specified user. The maximum length of the username is 31 characters.

This qualifier requires the right MDMS_DEALLOCATE_ALL

/VOLSET (D)

/NOVOLSET

Indicates that the entire volume set which contains the volume ID is to be deallocated. The default of /VOLSET deallocates all volumes in the volume set. If /NOVOLSET is specified, the specified volume is deallocated. This qualifier is ignored if the volume is not in a set. You cannot deallocate the first volume in a volume set using /NOVOLSET.

Examples

$ MDMS DEALLOCATE VOLUME VOL008 /NOVOLSET /STATE=FREE

This command deallocates volume VOL008 for the current user and places the volume in the FREE state.

$ MDMS DEALLOCATE VOLUME ACF342 /USER_NAME=SMITH

This command deallocates volume ACF342 which was allocated to user SMITH.

$ MDMS DEALLOCATE VOLUME VOL002 /VOLSET

This command deallocates all volumes in the set that contains volume VOL002 for the current user. The volumes are also unbound from the volume set.

$ MDMS DEALLOCATE VOLUME VOL3 /NOVOLSET

A volume set contains volumes VOL1, VOL2, VOL3, VOL4, VOL5. This command deallocates volume VOL2 for the current user and leaves two volume sets: VOL1, VOL2 and VOL4, VOL5.

$ MDMS DEALLOCATE VOLUME/SCHEDULE

Deallocates all volumes whose scratch date has expired. Also, moves volumes into the FREE state if the freed date has expired.

Format

Parameters

drive_name

Specifies the name of the drive. The maximum length of the drive name is 31 characters.

Description

The MDMS DELETE DRIVE command deletes a specified drive definition from the MDMS configuration database.

Privileges

The request requires MDMS_DELETE_ALL.

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE DRIVE $1$MUA5

This command deletes the drive definition for $1$MUA5.

Format

MDMS DELETE GROUP group_name

Parameters

group_name

Specifies the name of the group. The maximum length of the drive name is 31 characters.

Description

The MDMS DELETE GROUP command deletes a specified group definition from the MDMS configuration database.

Privileges

The request requires MDMS_DELETE_ALL.

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE GROUP HOSER

This command deletes the group definition for HOSER.

Format

Parameters

jukebox_name

Specifies the name of the jukebox. The maximum length of the jukebox name is 31 characters.

Description

The MDMS DELETE JUKEBOX command deletes a specified jukebox definition from the MDMS configuration database. Before deleting a jukebox, it is highly recommended that all drives defined as being in the jukebox are also deleted (or modified), and volumes and magazines are moved out of the jukebox.

Privileges

The request requires MDMS_DELETE_ALL.

While deleting a volume that is in a pool to which the user is authorized, MDMS_DELETE_POOL is sufficient. All other volume deletes require MDMS_DELETE_ALL

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE JUKEBOX JUKE_1

This command deletes the definition for jukebox JUKE_1.

Format

Parameters

location

Specifies the name of the location. The maximum length of the location is 31 characters.

Description

The MDMS DELETE LOCATION command deletes a specified location definition from the MDMS configuration database.

Privileges

The request requires MDMS_DELETE_ALL.

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE LOCATION ROOM_1

This command deletes the location definition for ROOM_1.

Format

Parameters

magazine_name

Specifies the name of the magazine. The maximum length of the magazine name is 31 characters.

Description

The MDMS DELETE MAGAZINE command deletes a specified magazine definition from the MDMS configuration database.

Privileges

The request requires MDMS_DELETE_ALL.

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE MAGAZINE MAG001

This command deletes the magazine MAG001.

Format

Parameters

media_type

Specifies the name of the media type. The maximum length of the media type is 31 characters.

Description

The MDMS DELETE MEDIA_TYPE command deletes a specified media type definition from the MDMS configuration database.

Privileges

The request requires MDMS_DELETE_ALL.

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE MEDIA_TYPE TK87K

This command deletes the definition for media type TK87K.

Format

Parameters

node_name

Specifies the name of the node. The maximum length of the node name is 31 characters.

Description

The MDMS DELETE NODE command deletes a specified node definition from the MDMS configuration database.

Privileges

The request requires MDMS_DELETE_ALL.

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE NODE FUDGE

This command deletes the node name FUDGE.

Format

Parameters

pool_name

Specifies the name of the volume pool. The maximum length of the pool name is 31 characters.

Description

The MDMS DELETE POOL command deletes a specified pool definition from the MDMS configuration database.

Privileges

The request requires MDMS_DELETE_ALL.

Restrictions

None

Qualifier

None

Example

$ MDMS DELETE POOL SLSPOOL

This command deletes pool SLSPOOL.

Format

Parameters

volume_id

Specifies the name of the volume. The maximum length of a volume ID is 6 characters. Alternatively, a volume range, separated by a dash, may be specified. A volume range is a numeric range for up to the last three characters of the volume ID. Example ranges are (ABC001-ABC250), (ABC120-ABC125).

Description

The MDMS DELETE VOLUME command deletes a specified volume definition from the MDMS volume database. Volumes must be in the UNINITIALIZED or FREE states prior to being deleted.

Privileges

The request requires MDMS_DELETE_ALL or MDMS_DELETE_POOL.

If the user is deleting a volume that is in a pool to which he is authorized, MDMS_DELETE_POOL is sufficient. All other volume deletes require MDMS_DELETE_ALL.

Restrictions

None

Qualifiers

None

Example

$ MDMS DELETE VOLUME ABC001-ABC099

This command deletes the records for volumes ABC001 to ABC099.

Format

Parameters

volume_id

Specifies the name(s) of the volume(s) to initialize. The maximum length of a volume ID is 6 characters. Alternatively, a volume range, separated by a dash, may be specified. A volume range is a numeric range for up to the last three characters of the volume ID. Example ranges are (ABC001-ABC250), (ABC120-ABC125). There is a maximum of 1000 volumes in a range.

This parameter is required except when /JUKEBOX and /SLOTS are specified.
The /JUKEBOX and /SLOTS option is valid only for MRD-controlled jukeboxes equipped with a vision system. For all other jukeboxes, the volume_id parameter is required.

Description

The MDMS INITIALIZE VOLUME command initializes a volume or a range of volumes by writing the volume ID to tape as the tape label. The volume records must be created prior to the initialization. In addition, the volumes must be in the FREE or UNITIALIZED states in order to be initialized.

If the volume(s) are contained in a jukebox, MDMS automatically loads and unloads the volumes. Otherwise, operator assistance is required.

In order to initialize volumes, the MDMS database server allocates a free drive that can handle the volumes. All volumes in a single command must support the specified media type (or the media type already in the volume record). Do not allocate a drive or load a volume for the initialization - this must be done by MDMS.

Each initialize volume command utilizes a single tape drive for all volumes. To utilize multiple drives, issue multiple initialize volume commands specifying a different volume or slot range, and use the /NOWAIT qualifier.

By default, volumes that have a different label than expected and have data written on them are not initialized. However, you can override this check and allow the initialization with the
/OVERWRITE qualifier. Note that volumes with labels that are flagged as allocated or in the transition state cannot be initialized under any circumstances.

Privileges

The request requires MDMS_INITIALIZE_ALL or MDMS_INITIALIZE_POOL.

If the user is initializing a volume that is in a pool to which he is authorized, MDMS_INITIALIZE_POOL is sufficient. All other initializations require MDMS_INITIALIZE_ALL.

MDMS_ASSIST is also needed unless /NOASSIST is specified.

Restrictions

The /JUKEBOX and /SLOTS qualifiers must be used together, and are incompatible with the volume_id parameter.

Qualifiers

/ASSIST (D)

/NOASSIST

The default /ASSIST qualifier is used to output an operator message if the volume requires operator intervention. You can use /ASSIST even if no assistance is needed - MDMS will perform the operation automatically if it can.
If you specify /NOASSIST and assistance is needed, the operation fails.

This qualifier requires the right MDMS_ASSIST

/JUKEBOX=jukebox_name

Indicates the volumes to be initialized are in the specified jukebox. A slot range should also be specified with this qualifier. Valid only for MRD jukeboxes equipped with a vision system.

/MEDIA_TYPE=media_type

Modifies the volume record to support only this media type. The volume must already support this media type, but may support others as well. After the initialization, the other media types are removed.

/OVERWRITE

/NOOVERWRITE (D)

The /OVERWRITE qualifier allows initialization if the requested volume label is different from the current label, and the volume has already been initialized and contains data. The default /NOOVERWRITE qualifier indicates that the volume should not be initialized if the label does not match and the volume contains data. Under no circumstances will the volume be initialized if the volume (according to the current label) is allocated or in the transition state.

/REPLY=symbol

Specifies the name of the symbol to receive the operator's reply when operator intervention is needed. The symbol will contain the operator reply to the DCL REPLY/TO or DCL REPLY/ABORT commands.

/SLOTS=(range[,...])

Specifies the slots containing volumes to initialize, when used with the /JUKEBOX qualifier.
Valid only for MRD jukeboxes equipped with a vision system.

/WAIT (D)

/NOWAIT

The /NOWAIT qualifier returns an informational message indicating that the initialize is being queued. The /WAIT qualifier causes the MDMS INITIALIZE VOLUME command to wait until the initialization is complete.

Examples

$ MDMS INITIALIZE VOLUME WOR001 /MEDIA_TYPE=TK85K

This command loads, initializes and unloads volume WOR001 and modifies the volume record to set media type TK85K only.

$ MDMS INITIALIZE VOLUME/JUKEBOX=JUKE_1/SLOTS=(0-10)/OVERWRITE

This command loads, initializes and unloads the volumes contained in slots 0-10 of jukebox JUKE_1, and allows initialization even if the tapes have unexpected labels and have already been written.

$ MDMS INITIALIZE VOLUME ABC001-ABC050

This command loads, initializes and unloads all 50 volumes in the range ABC001 to ABC050.

Format

Parameters

jukebox_name

Specifies the name of the jukebox. The maximum length of the jukebox name is 31 characters.

Description

The MDMS INVENTORY JUKEBOX command verifies the contents of a jukebox. This command is used for both MRD and DCSC controlled jukeboxes.

For MRD controlled jukeboxes:

• Both the volume range and slot range options are supported, but only one per command.
• If a volume range is specified, all volumes in the range will be inventoried and their slot positions verified and updated as needed. If the volume is not detected in the jukebox, the volume's placement will be according to the /MISSING qualifier (or placed in the onsite location by default). The volume range option is only available on jukeboxes supporting a VISION system, and /VISION is specified or defaulted in the command.
• If a slot range is specified, all volumes found in the specified slots are verified and the slot position updated as needed. No other volume record is modified.
• For systems with vision systems, the inventory is performed by querying the jukebox firmware as to slot/drive/port contents. A physical inventory is not performed. Volumes detected in ports will be considered missing (not in the jukebox). It is recommended that all ports are empty during an inventory.
• For small, single-magazine jukeboxes, like the TZ877, each volume is loaded, mounted, examined and unloaded in order to read the volume label. This can be time consuming depending on the hardware involved. Inventorying a 7-slot TZ877 jukebox takes about 20 minutes.
• Full or partial inventories are supported.

For DCSC controlled jukeboxes:

• Only the volume range option is supported.
• The inventory simply checks to see if the specified volumes are in the jukebox. This is slightly different behavior than the inventory performed on an MRD-controlled jukebox. If a volume is not in the jukebox, the volume's placement will be according to the /MISSING qualifier (or placed in the onsite location by default).

Privileges

The request requires MDMS_INVENTORY_ALL.

Restrictions

/SLOTS and /VOLUME_RANGE are mutually exclusive.

/SLOTS is unsupported for DCSC jukeboxes - /VOLUME_RANGE is required

Qualifiers

/CREATE

Specifies that any volume that is found that is not defined is created using either the /INHERIT, and/or /MEDIA_TYPES qualifier.

/INHERIT=volume_id