Preface ix

1 ABS Commands

ABS CREATE ENVIRONMENT 1-12

ABS CREATE STORAGE_CLASS 1-18

ABS DELETE ENVIRONMENT 1-112

ABS DELETE RESTORE 1-113

ABS DELETE SAVE 1-114

ABS DELETE STORAGE_CLASS 1-115

ABS EXIT 1-116

ABS HELP 1-117

ABS LOOKUP 1-118

ABS REPORT SAVE_LOG 1-124

ABS RESTORE 1-128

ABS SAVE 1-138

ABS SET ENVIRONMENT 1-150

ABS SET RESTORE 1-152

ABS SET SAVE 1-154

ABS SET STORAGE_CLASS 1-156

ABS SHOW ENVIRONMENT 1-158

ABS SHOW REQUEST_STATUS 1-160

ABS SHOW RESTORE 1-161

ABS SHOW SAVE 1-163

ABS SHOW STORAGE_CLASS 1-165

ABS SHOW VERSION 1-167

ABS SPAWN 1-168

ABS SYNCHRONIZE 1-169

2 MDMS DCL Commands

MDMS ALLOCATE DRIVE 2-12

MDMS ALLOCATE VOLUME 2-16

MDMS BIND VOLUME 2-110

MDMS CANCEL REQUEST 2-112

MDMS CREATE DRIVE 2-114

MDMS CREATE GROUP 2-118

MDMS CREATE JUKEBOX 2-120

MDMS CREATE LOCATION 2-125

MDMS CREATE MAGAZINE 2-127

MDMS CREATE MEDIA_TYPE 2-130

MDMS CREATE NODE 2-132

MDMS CREATE POOL 2-136

MDMS CREATE VOLUME 2-138

MDMS DEALLOCATE DRIVE 2-146

MDMS DEALLOCATE VOLUME 2-147

MDMS DELETE DRIVE 2-149

MDMS DELETE GROUP 2-150

MDMS DELETE JUKEBOX 2-151

MDMS DELETE LOCATION 2-152

MDMS DELETE MAGAZINE 2-153

MDMS DELETE MEDIA_TYPE 2-154

MDMS DELETE NODE 2-155

MDMS DELETE POOL 2-156

MDMS DELETE VOLUME 2-157

MDMS EXIT 2-158

MDMS INITIALIZE VOLUME 2-159

MDMS INVENTORY JUKEBOX 2-162

MDMS LOAD DRIVE 2-165

MDMS LOAD VOLUME 2-167

MDMS MOVE MAGAZINE 2-169

MDMS MOVE VOLUME 2-172

MDMS REPORT VOLUME 2-175

MDMS SET DOMAIN 2-179

MDMS SET DRIVE 2-183

MDMS SET GROUP 2-186

MDMS SET JUKEBOX 2-188

MDMS SET LOCATION 2-192

MDMS SET MAGAZINE 2-194

MDMS SET MEDIA_TYPE 2-196

MDMS SET NODE 2-198

MDMS SET POOL 2-1101

MDMS SET SERVER 2-1103

MDMS SET VOLUME 2-1104

MDMS SHOW DOMAIN 2-1111

MDMS SHOW DRIVE 2-1113

MDMS SHOW GROUP 2-1115

MDMS SHOW JUKEBOX 2-1117

MDMS SHOW LOCATION 2-1119

MDMS SHOW MAGAZINE 2-1121

MDMS SHOW MEDIA_TYPE 2-1123

MDMS SHOW NODE 2-1125

MDMS SHOW POOL 2-1127

MDMS SHOW REQUEST 2-1129

MDMS SHOW SERVER 2-1131

MDMS SHOW VERSION 2-1133

MDMS SHOW VOLUME 2-1134

MDMS - Start An MDMS Session 2-1138

MDMS UNBIND VOLUME 2-1140

MDMS UNLOAD DRIVE 2-1142

MDMS UNLOAD VOLUME 2-1144

A MDMS V3 Rights and Privileges

A.1 MDMS Rights - Types A-11

A.1.1 High Level Rights A-11

A.1.2 Low-level rights A-12

A.1.3 ABS Rights A-14

A.2 Default High-Level to Low-Level Mapping A-14

A.2.1 MDMS_USER: A-15

A.2.2 MDMS_OPERATOR Rights: A-15

A.2.2.1 Domain Commands for Mapping Privileges A-16

B MDMS Files and Logical Names

B.1 MDMS File Names B-11

B.2 MDMS Logical Names B-14

Table 1-1 Entering the Correct Syntax for the ABS LOOKUP Command 1-118

Table 1-2 Entering the Correct Syntax for ABS RESTORE Command 1-129

Table 1-3 Type of Restore Request Options 1-136

Table 1-4 Entering the Correct Syntax for ABS SAVE Command 1-138

Table 1-5 Type of Save Request Options 1-149

Table 1-6 Symbols 1-162

Table 1-7 Symbols 1-164

Table 2-1 Report Volume Field - Attributes 2-175

Preface

 

 

Format

 

 

ABS CREATE ENVIROMENT

[/ACCESS_CONTROL] [/ACTION] [/COMPRESSION] [/DATA_SAFETY] [/DRIVE_COUNT] [/EPILOGUE] [/INTERVAL_FOR_RETRY] [/LINKS_ONLY] [/LISTING_OPTION] [/LOCKING_OPTION] [/NOTIFICATION] [/OWNER] [/PROFILE] [/PROLOGUE] [/RETRY_COUNT] [/SPAN_FILESYSTEMS]

{name}

 

Parameters

name

The name of the environment policy that you want to create.

Restrictions

• The creating process must have ABS_CREATE_EXECUTION_ENV access right identifier enabled to create an execution policy.
• The creating process must be logged into ABS server node.
• To create an execution environment with user profile information (/PROFILE=option[,...]), the requesting process must have the following OpenVMS privileges enabled:
• SYSPRV
• CMKRNL
• The default for the username in the profile is <REQUESTER>. This means that the backups will run under a user. If you want the backups to run under ABS, then you must set the username field in the profile to ABS.

Qualifiers

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Enables you to set up the access controls by user name or by access right identifier. The following access options are available:

• Read - Users with Read access control can restore data using the environment policy.
• Write - Users with Write access control can save data using the environment policy.
• Delete - Users with Delete access control can delete the environment policy object if the number of catalog references is set to zero (0).
• Set - Users with Set access control can modify any attribute of the environment policy object, including access control.
• Show - Users with Show access control can show the environment policy object.
• Control - Users with Control access control can modify the access control for the environment policy object, but not any of its other attributes.

Requirement:
The access control must be enclosed within quotation marks, and, if you are assigning multiple access controls per user, they must be listed as a comma-separated or plus-separated list enclosed within quotation marks.

/ACTION=option

Specifies the action to take when saving data using this environment policy. Select one of the following supported options:

• RECORD_DATE - Modifies the saved date when the save operation has completed
  
  Restriction:
  This option is not valid for UNIX or NT client backup operations.
• NO_CHANGE - Does not change any of the original data.
• DELETE_OBJECT - Deletes the data once the save operation has completed. This is typically used for long-term archive operations.

Default:
If you do not specify this qualifier, the RECORD_DATE is used.

/COMPRESSION=option

ABS supports different types of compression for UNIX clients:

• UNIX_COMPRESSION
• GZIP_COMPRESSION
• NONE

Restriction:
This qualifier is valid only for UNIX client operations.

Default:
NONE.

/DATA_SAFETY=(option[,...])

Specifies the list of data safety options to use when saving or restoring data using this environment policy. ABS supports the following data safety options:

• FULL_VERIFY - Rereads all saved data and compares the results with what is on disk.
• CRC - Performs a cyclic redundancy check (CRC) and writes it for each data block on the tape.
• XOR Redundancy Groups - If the CRC check detects a bad block during a restore operation, the XOR mechanism allows recovery of the block by using redundancy groups of blocks (written during the save operation). The OpenVMS Backup Utility is the only backup agent currently provided by ABS that provides an XOR mechanism. It is enabled by default with a redundancy group size of 10 blocks. To disable the XOR mechanism, specify /GROUP_SIZE=0 within the /AGENTS_QUALIFIERS option of the save request.
• None - Deletes all DATA_SAFETY options.

Restriction:
These options are valid only for OpenVMS backup operations.

Default:
If you do not specify this qualifier, ABS uses all data safety options that are supported by the backup agent.

/DRIVE_COUNT=number

Use this qualifier to set the number of drives to use for each save or restore request using this environment policy. If there are same number of drives available set by this qualifier, ABS allocates those drives for save or restore request. If the number of drives set by this qualifier is not available, ABS will use the amount of drives available.

For example, if you create a save request that uses an environment policy where the / DRIVE_COUNT is set to 3, ABS allocates three drives when the save request job begins. This means those three drives are unavailable for other operations during the time save request is executing.

Default:
The default value is 1. This value cannot be 0 (zero).

Recommendation:
Use the default value of 1. Allocating more than one drive per save request will constrain the resources and therefore, those resources (drives or volumes) would not be available for additional operations.

/EPILOGUE="string"

/NOEPILOGUE (default)

Specifies to execute a command string after the entire save or restore request completes.

Restriction:
The string for this qualifier is limited to 80 characters and must be enclosed in quotes.

Default:
If you do not specify this qualifier, or you specify /NOEPILOGUE no epilogue command is executed.

/INTERVAL_FOR_RETRY=number

Specifies the number of minutes between retry attempts.

Default:
If you do not specify this qualifier, ABS retries the save or restore request every 15 minutes.

/LINKS_ONLY (default)
/NOLINKS_ONLY

Provides the ability from ABS to either back up the UNIX symbolic links only, or to follow the UNIX symbolic links and back up the data as well.

Restriction:
This qualifier is valid only for UNIX client operations.

/LISTING_OPTION=option

Specifies the listing file option to use when saving or restoring data using this environment policy.

Choose one of the following options:

• NONE - Does not generate listing file.
• FULL - Generates a full listing file which contains full file names and file information provided by the backup agent.
• BRIEF - Generates a brief listing file.

Default:
If you do not specify this qualifier, ABS uses NONE.

/LOCK_OPTION=option

/NOLOCK_OPTION (default)

Specifies the action to be taken when data usage conflicts occur. Select one of the following supported options:

• HOT_BACKUP - ABS saves data even if other applications are accessing the same data at the same time. Use this qualifier for Rdb Oracle databases or storage area save requests.
  
  Restriction:
  This option is not valid for UNIX or NT client save requests.
• IGNORE_WRITERS - IGNORE_WRITERS is a synonym for HOT_BACKUP. Use this qualifier for OpenVMS, UNIX, and NT save requests.
  
  Restriction:
  This option is not valid for Rdb Oracle database save requests.

Default:
If you do not specify this qualifier, the save operation fails if other applications are accessing the same data.

/NOTIFICATION=(option[,...])
/NONOTIFICATION

Specifies the notification options to use when using this environment policy. ABS supports the following options:

• RECEIVER="string"
  
  A valid device name or username of the person who will receive the notification. This can be one of the standard VMS OPCOM devices (such as TAPES) or a list of valid VMS mail addresses, depending upon which METHOD is specified.
• METHOD=OPCOM,MAIL,NONE
  
  The form of the notification.

The method and receiver must match. For example, if the METHOD is:

OPCOM - Receiver must be a valid OpenVMS OPCOM device, such as TAPES.

MAIL - Receiver must be a list of valid OpenVMS mail addresses, such as NODE1::USER1.

If the RECEIVER string is illegal for the specified method, the save or restore request fails with the error from the MAIL or OPCOM facility

• WHEN=START, COMPLETE, WARNING, ERROR, FATAL
  
  Determines under what condition during the save or restore request to notify Receiver. You can specify more than one option as a list:

$ ABS CREATE ENVIRONMENT MY_ENV/NOTIFICATION=WHEN=(START,FATAL)

• TYPE=BRIEF,NORMAL,FULL
  
  The type of notification message to return.

Restriction:
If you select METHOD=OPCOM, you cannot select TYPE=FULL or TYPE=NORMAL.

Defaults:
ABS uses the following default values: RECEIVER=TAPES, METHOD=OPCOM, WHEN=FATAL, TYPE=BRIEF.

/OWNER=user-name

Specifies the owner of the environment policy object. The owner is always granted SHOW and CONTROL access.

/PROFILE=option[,...]

Specify this qualifier to create a user profile other than the default user profile. Valid options are:

• CLUSTER="string"
• NODE="string"
• PRIVS=(string[,...])
• RIGHTS_LIST=(string[,...])
• USERNAME="string"

Defaults:

• If you do not supply a username, ABS assigns USERNAME=<REQUESTER>.
• ABS uses the current node name unless you specify an OpenVMS Cluster name. If you specify an OpenVMS Cluster name, ABS uses an asterisk (*) for the node name.
• For PRIVS and RIGHTS_LIST, if the combination of USERNAME, NODE, and CLUSTER specifies a legal user name on the local OpenVMS Cluster or node, ABS assigns the user's authorized privileges and rights list.

/PROLOGUE="string"

NOPROLOGUE (default)

Instructs ABS to execute a command string prior to the entire save or restore request.

Restriction:
The string for this qualifier is limited to 80 characters and must be enclosed within quotes.

Default:
If you do not specify this qualifier, or you specify /NOPROLOGUE no prologue command is executed.

/RETRY_COUNT=number

Specifies the number of retries to attempt for the save or restore request using this execution environment. To disable retry specify 0.

Default:
If you do not specify this qualifier, ABS retries the save or restore request three times.

/SPAN_FILESYSTEMS=option

Allows ABS to back up only the root file system (such as the disk the root directory resides on), or an entire file system type if the file system spans physical devices. ABS supports the following options:

• ALL
• NONE

Restriction:
This qualifier is valid only for UNIX client backup operations. It is not valid for NT or OpenVMS client backup operations.

Default:
The default is NONE, or not to span file systems

Example:

$ ABS CREATE ENV/SPAN_FILESYSTEM=ALL/NOLINKS_ONLY UNIX_SPAN_ENV

Examples

1. To create an environment policy that executes a prologue and an epilogue command, see the following example:
   
   ABS> CREATE ENVIRONMENT/PROLOGUE="@SHUTDOWN_DB.COM" -
   _ABS> /EPILOGUE="@STARTUP_DB.COM" MULTIPLE_DRIVES_ENV
2. To create an execution environment with a user profile, see the following example:
   
   ABS> CREATE -
   _ABS> ENVIRONMENT/PROFILE=(USERNAME="USER1",CLUSTER="CLSTR1",-
   _ABS> NODE="NODE01") USER1_BACKUP_ENV
3. To create an environment policy with notification options, see the following example:
   
   $ ABS CREATE ENVIRONMENT MY_ENV/NOTIFICTION=(RECEIVER="TAPES", -
   _$ METHOD=OPCOM,WHEN=(WARNING,COMPLETE),TYPE=BRIEF)

Format

 

 

ABS CREATE STORAGE_CLASS

[/ACCESS_CONTROL] [/ARCHIVE_TYPE] [/CATALOG] [/CONSOLIDATION] [/DRIVE_LIST] [/EXECUTION_NODE] [/EXPIRATION] [/LOCATION] [/MAXIMUM_SAVES] [/MEDIA_LOCATION] [/OWNER] [/RETAIN] [/TAPE_POOL] [/TYPE_OF_MEDIA] [/VOLUME_SET]

{name}

 

Parameters

name

The name of the storage policy that you want to create.

Restrictions

• The creating process must be logged into ABS server node.
• The creating process must have the ABS_CREATE_STORAGE_CLASS access rights identifier enabled.

Qualifiers

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Enables you to set up the access controls by user name or by access right identifier. Access controls permit all or specific users to access to the storage policy for save and restore operations. The following access control options are available:

• Read - Users with Read access control can restore data using the storage policy.
• Write - Users with Write access control can save data using the storage policy.
• Delete - Users with Delete access control can delete the storage policy object if the number of catalog references is set to zero (0).
• Set - Users with Set access control can modify any attribute of the storage policy object, including access control.
• Show - Users with Show access control can show the storage policy object.
• Control - Users with Control access control can modify the access control for the storage policy object, but not any of its other attributes.

Requirement:
The access control must be enclosed within quotation marks, and, if you are assigning multiple access controls per user, they must be listed as a comma-separated or plus-separated list enclosed within quotation marks.

/ARCHIVE_TYPE=type

Use this qualifier to specify the type of archive file system to use for the storage policy. ABS supports the following archive file system types:

• MDMS
• FILES_11

Default:
If you do not specify this qualifier, ABS uses MDMS.

/CATALOG=catalog-name

Assigns the catalog to be used to store save request information that uses this storage policy.

Default:
If you do not specify this qualifier, ABS assigns the default catalog named ABS_CATALOG.

/CONSOLIDATION=(option[,...])

Specifies the criteria under which new volume sets are created for a save request that uses this storage policy. The following options are valid:

• INTERVAL=delta_time - The time interval to elapse before a new volume set is created.
• COUNT=number - The number of save sets to be housed on a volume set before a new volume set is created
• SIZE=number - The number of volumes to be added to the current volume set before creating a new volume set

Default:
If you do not specify this qualifier, ABS assigns the following default values:

Count=0, Size=0, Interval= "7 00:00:00"

/DRIVE_LIST=(device-name[,...])

/NODRIVE_LIST (default)

Use this qualifier to specify the drive or list of drives to use for the storage policy. To specify a list of drives, enter them in a comma-separated list. You must specify the drive name as the MDMS drive name rather than as the VMS device name.

Example:

$ ABS CREATE STORAGE MY_STORAGE /DRIVE_LIST=(DRIVE2,DRIVE3,DRIVE4)

Where:

• DRIVE2 = $4$MUA892
• DRIVE3 = $4$MUA893
• DRIVE4 = $4$MUA894

Default:
If you do not specify this qualifier, the MDMS software allocates a drive compatible with the media type used by the storage policy.

/EXECUTION_NODE=node name

Specifies the node name on which the save or restore request will execute. For the save or restore of VMS files or Oracle Rdb databases or storage areas, the execution node is ignored. For UNIX or NT files, the execution node is determined by this node name supplies for this qualifier.

/EXPIRATION=date
/NOEXPIRATION

Specifies the date on which the saved data should expire. Reserved words of TODAY and TOMORROW can be specified for the date value.

The /NOEXPIRATION qualifier specifies that the data will expire 9999 days in future.

Restriction:
If you specify this qualifier, you cannot specify the /RETAIN qualifier in the same CREATE STORAGE_CLASS command.

Default:
If you do not specify this qualifier, ABS uses the number of days assigned to the retention period, or a default retention period of 365 days.

/LOCATION=directory-specification

The directory specification into which ABS save sets will be written.

Default:
If you do not specify this qualifier, the default location is based upon the /ARCHIVE_TYPE qualifier. If the archive type is FILES_11, the default location is ABS$ROOT:[000000].

/MAXIMUM_SAVES=number

This qualifier allows you to specify the maximum number of save requests that can execute simultaneously using the same storage class.

For example, if you create three save requests that are scheduled to start simultaneously, those save requests can run simultaneously provided there are enough media management resources (such as tape drives and free volumes) to support multiple backup operations. Valid values range from 1 to 36. This qualifier also implies that you can use this number of volume sets for the storage class.

Default:
If you do not specify this qualifier, ABS assigns a value of 1.

/MEDIA_LOCATION=name

/NOMEDIA_LOCATION (default)

Specifies the name of the location from which to select media for the save request. The media location is defined in MDMS.

Restriction:
You can specify this qualifier only when you assign MDMS to the /ARCHIVE_TYPE qualifier.

Default:
If you do not specify this qualifier, ABS uses the location defined as the default for the MDMS domain.

/OWNER=user-name

Specifies the owner of the storage policy object. The owner is always granted SHOW and CONTROL access.

/RETAIN=number

Specifies the number of days the data will be retained in the storage policy.

Restriction:
If you specify this qualifier, you cannot specify the /EXPIRATION qualifier in the same CREATE STORAGE_CLASS command.

Default:
ABS assigns a value of 365 days for the retention period.

/TAPE_POOL=name

/NOTAPE_POOL (default)

Specifies the name of the tape pool to use for save requests that use this storage class.

Restriction:
You can only specify this qualifier if you specify MDMS as the archive file system
(/ARCHIVE_TYPE=MDMS).

Default:
If you do not specify this qualifier, ABS selects volumes that do not belong to a specific tape pool.

/TYPE_OF_MEDIA=name

/NOTYPE_OF_MEDIA (default)

Use this qualifier to specify the media type for the storage policy. The media type is defined in MDMS.

Requirement:
You must specify this qualifier if the archive file system is MDMS
(/ ARCHIVE_TYPE=MDMS).

/VOLUME_SET=name

/NOVOLUME_SET (default)

Specifies the name of the volume set to use for save requests using this storage policy.

The volume set name must be one that ABS has previously created. If the values specified for the /CONSOLIDATION qualifier have been exceeded, ABS will create a new volume set anyway.

Default:
If you do not specify this qualifier, ABS attempts to add its save sets to the last volume set used by ABS for this storage policy.

Examples

1. To create a storage policy named PROJ_X and to have the saved data expire on a certain date, see the following example:
   
   ABS> CREATE STORAGE PROJ_X/EXPIRATION=01-JAN-1999/ TYPE_OF_MEDIA=TK85
2. To create a storage policy to retain data for five years, and to select the volume from a specific pool of volumes, see the following example:
   
   ABS> CREATE STORAGE_CLASS 5_YEAR_STORAGE/RETAIN=1825/TAPE_POOL
   _ABS>=5YEAR_POOL/TYPE_OF_MEDIA=TK85
3. To create a storage policy for UNIX or NT operations that uses a specific node for its save requests, see the following example:
   
   $ ABS CREATE STORAGE_CLASS UNIX_STORAGE/EXECUTION_NODE=NODE01
   _$ /MEDIA_TYPE=TK85

Format

 

 

ABS DELETE ENVIRONMENT

[/CONFIRM] [/OVERRIDE] [/VERSION]

{ name }

 

Parameters

name

The name of the execution environment that you want to delete.

Restrictions

• The user process must have the DELETE access right enabled on the environment policy.
• The requesting process must be logged into ABS server node.
• The environment policy cannot contain any catalog references. This provides an accurate history of save operations of the environment policy used during those operations.

Qualifiers

/CONFIRM
/NOCONFIRM (default)

Specify the /CONFIRM qualifier to prompt the user for confirmation before deleting the environment policy.

/OVERRIDE_REFERENCE_COUNT

This qualifier allows you to delete the environment policy even though there may be references to it. Use with caution.

/VERSION=number

Use this qualifier to specify the version of the environment policy that you want to delete.

Default:
If you do not specify this qualifier, ABS deletes all versions.

Example

To delete the environment policy named USER1_ENV and to confirm the delete operation, see the following example:

ABS> DELETE ENVIROMENT USER1_ENV/CONFIRM

Format

 

 

ABS DELETE RESTORE

[/CONFIRM] [/OVERRIDE_REFERENCE_COUNT] [/VERSION

{ name }

 

Parameters

name

The name of the restore request that you want to delete.

Restrictions

• The user process must have the DELETE access rights identifier enabled on the restore request.

Qualifiers

/CONFIRM
/NOCONFIRM (default)

Specify this qualifier to prompt the user for confirmation before ABS deletes the restore request.

/OVERRIDE_REFERENCE_COUNT

Deletes the restore request even though there is an active archive reference count for the restore request.

Requirement:
You must have the ABS_BYPASS access right identifier enabled to invoke this qualifier.

/VERSION=number

Use this qualifier to specify the version of the restore request that you want to delete.

Default:
If you do not specify this qualifier, ABS deletes all versions.

Example

To delete the restore request named USER1__01-JAN-1994_12_00_00_00 and to confirm the delete operation, see the following example:

ABS> DELETE RESTORE/CONFIRM USER1__01-JAN-1994_12_00_00_00

Format

 

 

ABS DELETE SAVE

[/CONFIRM] [/OVERRIDE_REFERENCE_COUNT] [/VERSION]

{name}

 

Parameters

name

The name of the save request that you want to delete.

Restrictions

The user process must have the DELETE access right identifier enabled on the save request.

Qualifiers

/CONFIRM
/NOCONFIRM (default)

Specify this qualifier to prompt the user for confirmation before deleting the save request.

/OVERRIDE_REFERENCE_COUNT

Deletes the save request even though there is an active archive reference count for the save request.

Requirement:
You must have ABS_BYPASS access right identifier enabled to invoke this qualifier.

/VERSION=number

Use this qualifier to specify the version of save request that you want to delete.

Default:
If you do not specify this qualifier, ABS deletes all versions.

Example

To delete a save request named USER1__01-JAN-1994_12_00_00_00 and to confirm the delete operation, see the following example:

ABS> DELETE SAVE/CONFIRM USER1__01-JAN-1994_12_00_00_00

Format

 

 

ABS DELETE STORAGE_CLASS

[/CONFIRM] [/OVERRIDE] [/VERSION]

{ name }

 

Parameters

name

The name of the storage policy that you want to delete.

Restrictions

• The user process must have the DELETE access right enabled on the storage policy.
• The requesting process must be logged into ABS server node.
• The storage policy cannot contain any catalog references. This provides an accurate history of save operations and of the storage policies used during those operations.

Qualifiers

/CONFIRM
/NOCONFIRM (default)

Specify this qualifier to prompt the user for confirmation before deleting the storage policy.

/OVERRIDE_REFERENCE_COUNT

This qualifier allows you to delete the storage policy object even though there may be reference to it. Use this qualifier with extreme caution. If you delete a storage policy that contains references to it, you will not be able to restore any data that was saved using the storage policy.

/VERSION=number

Use this qualifier to specify the version of the storage policy that you want to delete.

Default:
If you do not specify this qualifier, ABS deletes all versions.

Example

To delete the storage policy named USER1 and to confirm the delete operation, see the following example:

ABS> DELETE STORAGE_CLASS USER1_STORAGE/CONFIRM

Format

 

 

ABS EXIT

 

Parameters

None.

Restrictions

None.

Qualifiers

None.

Format

 

 

ABS HELP

{keyword}

 

Parameters

keyword

ABS command to invoke OpenVMS Online Help for ABS product.

Restrictions

None.

Qualifiers

None.

Format

 

 

ABS LOOKUP

[/ALL] [/BRIEF] [/FULL] [/OUTPUT] [/SUMMARY]

{data object}

[/BEFORE] [/CATALOG] [/DATE_ARCHIVED] [/EXPIRATION] [/OBJECT_TYPE] [/NODE] [/SINCE] [/STORAGE_CLASS]

[...,]

 

Parameters

data_object

A single or comma-separated list of disk or disk and file names to search for in the catalog.

Entering the Correct Syntax for ABS LOOKUP Command shows how to correctly enter the syntax according to the file type you are looking up.

 

1. Entering the Correct Syntax for the ABS LOOKUP Command

 

 

File Type	Syntax
VMS_FILES	Wildcards can be used for any part of the file specification. A missing part of the file specification defaults to `all'. For example:: $ ABS LOOKUP LOGIN.COM Lists all versions of LOGIN.COM for all disks and all directories.   If you want to look up the highest version of an individual file, enter the exact file name without a specific version number: $ ABS LOOKUP DISK$USER1:[USER]LOGIN.COM;
Oracle Rdb Database	If you want to look up an Oracle Rdb database, select the Oracle Rdb version specific file type and enter the syntax in the following type of format: $ ABS LOOKUP DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB - _$/OBJECT_TYPE=RDB_V6.0_DATABASE
Oracle Rdb Storage Area	If you want to look up an Oracle Rdb storage area, select the Oracle Rdb version specific file type, and enter the syntax in the following format: $ ABS LOOKUP "DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB /AREA=ACCOUNTING" /OBJECT_TYPE=RDB_V6.0_STORAGE_AREA
UNIX_FILES_GTAR	To find a UNIX directory, enter the following syntax: $ ABS LOOKUP "/usr/users/abs" - _$ /OBJECT_TYPE=UNIX_FILES_GTAR Object of type UNIX_FILES_GTAR found /usr/users/abs/12-APR-1996 10:16:59.68 /usr/users/abs/11-APR-1996 18:44:48.8 Result: The lookup operation finds only the entry for the directory /usr/users/ abs/.   You can use wildcards "*" and "%" to find UNIX files. For example: $ ABS LOOKUP "/usr/users/*"/OBJECT_TYPE=UNIX_FILES_GTAR Result: This example will find all files and directories saved under the directories /usr/us*.   To lookup a specific UNIX file, enter the complete UNIX pathname: $ ABS LOOKUP "/usr/users/smith/login" - _$ /OBJECT_TYPE=UNIX_FILES_GTAR Object of type UNIX_FILES_GTAR found /usr/users/smith/login 12-APR-1996 10:16:59.68 /abs/users/smith/login 11-APR-1996 18:44:48.82   Note: UNIX file names are case-sensitive. You must enter the file name exactly as it was created.
WINDOWS_NT_FILES_ GTAR	To find an NT file, use the following syntax: $ ABS LOOKUP "C:\USERS\SMITH\TEMP.TXT" - _$ /OBJECT_TYPE=WINDOWS_NT_FILES_GTAR To find an NT directory, use the following syntax: $ABS LOOKUP - _$ "C:\USERS\SMITH\"/ OBJECT_TYPE=WINDOWS_NT_FILES_GTAR To find NT files you can use wildcard character "*" and "%". For example: $ ABS LOOKUP "C:\USERS\*.DAT" - _$ /OBJECT_TYPE=WINDOWS_NT_FILES_GTAR Result: This example will find all files and directories saved under the directory C:\USERS\ with an extension of ".DAT".   Note: NT file names are not case-sensitive.

 

Restrictions

• To view information about archived data that you do not own, your user process must:
• Have ABS_LOOKUP_ALL access right identifier granted
• Have SYSPRV privilege enabled
• To view information on a VMS client, you need to have access to the storage class in the save request.
• If you do not specify the storage class while viewing information, ABS defaults to SYSTEM_BACKUPS storage class.
• You cannot specify more than eight data disk or file names per ABS LOOKUP command.
• Each disk or file name cannot exceed 255 characters.
• You cannot mix file types in the same ABS LOOKUP command.

Qualifiers

Nonpositional Qualifiers

The following nonpositional qualifiers are applied to the entire ABS LOOKUP command.

/ALL

Use this qualifier to list all copies of the file(s). When using /ALL with /SINCE all copies of a saved file are listed in chronological order. In all other cases /ALL lists the files in reverse chronological order.

Default:
Only one entry is listed per file.

/BRIEF (default)

Use this qualifier to display only the most important information about the include specification. This information includes the device name, object name, object version, node name, and date archived. For the ABS REPORT SAVE_LOG command, this information is displayed in a bulleted list format.

Default:
This is the default behavior for ABS LOOKUP command.

/FULL

Displays all information about the data and includes the disk name, file names, file version, node name, date archived, file type names, creation date, revision date, save set UID, owner, expiration date, file section number, archive transaction UID, storage policy UID, transaction status, and transaction severity. For the ABS REPORT SAVE_LOG command, this information is displayed in a bulleted list format.

Restriction:
You cannot specify the /FULL qualifier if the catalog type is SLS.

Default:
If you do not specify this qualifier, ABS uses the /BRIEF qualifier.

/OUTPUT=file_spec
/NOOUTPUT

Use this qualifier to specify an output location (file name) for the information about the data.

The /NOOUTPUT qualifier suppresses the information.

Default:
If you do not specify a file name for this qualifier, ABS displays the information to SYS$OUTPUT.

/SUMMARY (default)
/NOSUMMARY

Use the /NOSUMMARY qualifier to suppress the summary information line at the bottom of the output information.

Default:
ABS prints a summary information line at the bottom of the output information.

Positional Qualifiers

The following positional qualifiers can be applied to the disk or file name specified in the include_spec parameter. You can specify up to eight separate include_ spec parameters per ABS LOOKUP command.

/BEFORE[=time]

Selects only those files archived prior to the specified time. You can specify 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 /ALL with the /BEFORE qualifier to list all entries for a file in reverse chronological order.

Restriction:
If you specify this qualifier, you cannot specify the /DATE_ARCHIVED or the /SINCE qualifier.

Default:
If you do not specify any date, the current date and time is used.
If you do not specify any date selection qualifier /SINCE is the default.

/CATALOG=*

Use this qualifier to search all the catalogs

/CATALOG=catalog-name

Use this qualifier to constrain ABS LOOKUP command to a specific catalog.

Restriction:
If you specify this qualifier, you cannot specify the /STORAGE_CLASS qualifier in the same ABS LOOKUP command. Usage of wildcards are not supported.

Default:
If you do not specify this qualifier or the /STORAGE_CLASS qualifier, ABS searches through all catalogs.

/DATE_ARCHIVED[=date]

Selects only those files archived on the day of the specified date. You can specify the date 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 /ALL with the / DATE_ARCHIVED qualifier to list all entries for a file on this day in reverse chronological order.

Restriction:
If you specify this qualifier, you cannot specify the /BEFORE or /SINCE qualifier for the same ABS LOOKUP command.

Default:
If you do not specify any date, the current date and time is used. If you do not specify any date selection qualifier /SINCE is the default.

/EXPIRATION[=date]

Selects only those files archived with an expiration date before the specified time. You can specify 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 /ALL with the / EXPIRATION qualifier to list all entries for an expired file in reverse chronological order.

Default:
If you do not specify a date value, ABS uses the current date.

/OBJECT_TYPE=object-type-name

Specify this qualifier to constrain the ABS LOOKUP command to search only for a specific object type. ABS supports the following file types:

• RDB_Vn.n_DATABASE ( n.n = 4.2, 5.1, 6.0, 6.1,7.0 )
• RDB_Vn.n_STORAGE_AREA ( n.n = 4.2, 5.1, 6.0, 6.1,7.0 )
• UNIX_FILES_GTAR
• VMS_FILES
• VMS_SAVESET
• WINDOWS_NT_FILES_GTAR

Storage area restrictions:

• You cannot specify any wildcard characters if the object type is an Oracle Rdb storage area.
• If the file type is an Oracle Rdb storage area, you must specify the device name, the directory name, and the storage area name in the include_spec parameter:

$ ABS LOOKUP "DISK$:[DIRECTORY]database_name/AREA=storage_area_name"

Default:
If you do not specify this qualifier, ABS searches for VMS_FILES archive objects only.

/NODE=node-name

Use this qualifier to constrain the search for a disk or file name by a specific node name.

Default:
If you do not specify a node name or if you use a wildcard character (*), ABS does not use the node name selection criteria.

/SINCE[=time]

Selects only those files archived after the specified time. You can specify 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 /ALL with the /SINCE qualifier to list all entries for an expired file in chronological order.

Restriction:
If you specify this qualifier, you cannot specify the /DATE_ARCHIVED or the /BEFORE qualifier in the same ABS LOOKUP command.

Default:
If you do not specity any date, the current date and time is used. If you do not specify any date selection qualifier /SINCE is the default.

/STORAGE_CLASS=storage-policy-name

The name of storage policy to reference for ABS LOOKUP command. If you specify a storage policy name, the search is constrained to the catalog referenced by the specified storage policy.

Important Note:
You can assign the same catalog name to multiple storage polices. When more than one storage policy contains the same data, and those storage policies reference the same catalog name, ABS reports all the information from the catalogs regardless of which storage policy was used to save data.

Restriction:
If you specify this qualifier, you cannot specify the /CATALOG qualifier in the same ABS LOOKUP command.

Default:
If you do not specify this qualifier or the /CATALOG qualifier, ABS searches through all catalogs.

Example

To look up the file named LOGIN.COM that was saved on or before January 1, 1994, and to constrain the search to the storage policy named SYSTEM_BACKUPS, see the following example:

ABS> LOOKUP/BRIEF DEVICE:[DIR]LOGIN.COM/OBJECT_TYPE=VMS_FILES/BEFORE=01-JAN-1994 -
_ABS>/STORAGE_CLASS=SYSTEM_BACKUPS

or

ABS> LOOKUP/BRIEF DEVICE:[*...]LOGIN.COM/OBJECT_TYPE=VMS_FILES/BEFORE=01-JAN-1994 -
_ABS>/STORAGE_CLASS=SYSTEM_BACKUPS

 

Format

 

 

ABS REPORT SAVE_LOG

[/BEFORE] [/BRIEF] [/CATALOG] [/DATE_ARCHIVED] [/FULL] [/INCLUDE] [/OUTPUT] [/REQUEST] [/SINCE] [/STORAGE_CLASS] [/SUMMARY] [/VOLUME]

 

Parameters

None

Restrictions

• To view information about transactions that you do not own, you must have the ABS_LOOKUP_ALL, ABS_SHOW_ALL, or ABS_BYPASS access right identifier enabled.
• You cannot specify an SLS catalog for this command.

Qualifiers

/BEFORE[=time]

Reports only those save operations executed prior to the specified time. You can specify 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.

Restriction:
If you specify this qualifier, you cannot specify the /DATE_ARCHIVED or /SINCE qualifier.

Default:
If you do not specify any date, the current date and time is used. If you do not specify any date selection qualifier /SINCE is the default.

/BRIEF (default)

This qualifier displays only the brief information about the log entries. This information includes the date and time the save request was executed, the name of the disk or file that ABS attempted to save, and the current status of the save operation.

Default:
This is the default behavior for the REPORT SAVE_LOG command.

/CATALOG=(catalog_name[,... ])

Use this qualifier to search only the specified catalog(s). Use '*' for the catalog name to search all catalogs.

Restriction:
If you specify this qualifier, you cannot specify the /STORAGE_CLASS qualifier in the same ABS REPORT SAVE_LOG command.

Default:
If you do not specify this qualifier or the /STORAGE_CLASS qualifier, ABS searches through all catalogs.

/DATE_ARCHIVED[=date]

Reports only those save operations executed on the day of the specified date. You can specify the date as an absolute time, as a combination of absolute and delta times, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

Restriction:
If you specify this qualifier, you cannot specify either the /BEFORE or /SINCE qualifiers in the same ABS REPORT SAVE_LOG command.

Default:
If you do not specify any date, the current date and time is used. If you do not specify any date selection qualifier /SINCE is the default.

/FULL

Displays all the information about the log entries. This is displayed in a bulleted list format and includes the following information:

• The date and time save request was executed
• The storage policy and environment policy used for save request
• The disk or file name
• The status of the save request
• The number of files or disks saved
• A detailed description of the name and location of the save set file produced as a result of the save operation

Default:
If you do not specify this qualifier, ABS uses the /BRIEF qualifier.

/INCLUDE=(include_spec[,...])

Constrains the reported information to the file name or disk name specified for the include_spec parameter on the original save request.

Restriction:
You must specify this string exactly as it was specified in the include_spec parameter on the original save request.

Default:
If you do not specify this qualifier, ABS reports on all data saved using ABS.

/OUTPUT=file-spec
/NOOUTPUT

Specifies the output file specification for the report. Error and informational messages are still displayed to SYS$OUTPUT.

The /NOOUTPUT qualifier displays the report to SYS$OUTPUT.

Default:
If you do not specify a file name for this qualifier, ABS displays the information to SYS$OUTPUT.

/REQUEST=(name[,...])

Constrains the reported information to the transactions that were initiated by the specified save request name or list of save request names. Wildcard characters are allowed.

/SINCE[=time]

Reports only those save operations executed after the specified time. You can specify 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.

Restriction:
If you specify this qualifier, you cannot specify either the /DATE_ARCHIVED or the /BEFORE qualifier in the same REPORT SAVE_LOG command.

Default:
If you do not specify any date, the current date and time is used. If you do not specify this qualifier or any other date selection qualifier /SINCE is the default.

/STORAGE_CLASS=(storage-policy-name[,...])

Constrains the reported information to the catalog used by the specified storage policy name or list of storage policy names. Wildcard characters are permitted.

Important Note:
You can assign the same catalog name to multiple storage polices. When more than one storage policy contains the same data, and those storage policies reference the same catalog name, ABS reports all the information from the catalogs regardless of which storage policy was used to save data.

Example:

ABS> REPORT SAVE_LOG/STORAGE_CLASS=(ABS*,*USER1*)

Restriction:
If you specify this qualifier, you cannot specify the /CATALOG qualifier in the same ABS REPORT SAVE_LOG command.

Default:
If you do not specify this qualifier, or the /CATALOG qualifier, ABS searches through all catalogs.

/SUMMARY (default)
/NOSUMMARY

Specifies to print the summary information at the bottom of the output information.

Default:
If you do not specify this qualifier, summary information is printed at the bottom of the output

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

Constrains the reported information to the specified volume name or list of volume names.

Example:

$ ABS REPORT SAVE_LOG/VOLUME=(ABS000,ABS001)

Example

To report information about a specific save request that was executed before January 1, 1994, and to constrain the reported information to the catalog used by the SYSTEM_BACKUPS storage policy, and to suppress summary information, see the following example:

ABS> REPORT SAVE_LOG/REQUEST=MY_SAVE -
_ABS> /BEFORE=01-JAN-1994/STORAGE_CLASS=SYSTEM_BACKUPS/NOSUMMARY

Format

 

 

ABS RESTORE

[/ACCESS_CONTROL] [/BEFORE] [/CATALOG ] [/DATE_ARCHIVED] [/DESTINATION] [/ENVIRONMENT [/EPILOGUE] [/FULL] [/INCREMENTAL] [/LATEST_COPY] [/NAME] [/OWNER] [/PROLOGUE] [/SELECTIVE] [/SEQUENCE_OPTION] [/SINCE] [/START_TIME] [/STORAGE_CLASS]

{include_spec}

[/AGENT_QUALIFIERS] [/CONFLICT_OPTIONS] [/OBJECT_TYPE] [/TARGET_NODE]

[...,]

 

Parameters

include_spec

The disk or disk and file that you want to restore. The following wildcard characters are permitted in the include_spec parameter for VMS files:

• Asterisk (*)
• Percent sign (%)

Table 1-2 shows how to enter the syntax correctly for the file type you are restoring.

 

 

 

 

 

 

 

 

 

1. Entering the Correct Syntax for ABS RESTORE Command

 

 

File Type	Syntax
VMS_FILES	If you want to restore an entire OpenVMS disk, enter the disk name exactly as it was entered on the original save request: $ ABS RESTORE/NAME=VMS_RESTORE - _$ DISK$USER1:/OBJECT_TYPE=VMS_FILES/FULL or $ ABS RESTORE/NAME=VMS_RESTORE DISK$USER1: _$ /OBJECT_TYPE=VMS_FILES/INCREMENTAL If you want to restore an individual file, enter the file name using the following syntax: $ ABS RESTORE/NAME=REST_MY_FILE DISK$USER1:LOGIN.COM - _$ /OBJECT_TYPE=VMS_FILES
Oracle Rdb Database	If you want to restore an Oracle Rdb database, select the Oracle Rdb version-specific file type and use the following syntax: $ ABS RESTORE/NAME=RDB_RESTORE - _$ DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB - _$ /OBJECT_TYPE=RDB_V6.0_DATABASE
Oracle Rdb Storage Area	If you want to restore an Oracle Rdb storage area, specify the Oracle Rdb version specific file type and use the following syntax: $ ABS RESTORE/NAME=RDB_RESTORE - _$ "DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB/ AREA=ACCOUNT- _$ING"/OBJECT_TYPE=RDB_V6.0_STORAGE_AREA
UNIX_FILES_GTAR	To restore all directory structures and file under the directory ABS, use the following syntax: $ ABS RESTORE/NAME=UX_RESTORE "/usr/users/abs/" - _$ /OBJECT_TYPE=UNIX_FILES_GTAR/TARGET_NODE=unix1 Result: The example restores files on ../abs/ and below. To restore a specific file, enter the complete UNIX pathname: $ ABS RESTORE/NAME=REST_UNIX_FILE "/usr/users/smith/login" - _$ /OBJECT_TYPE=UNIX_FILES_GTAR/TARGET_NODE=unix1 Note: UNIX file names are case-sensitive. You must enter the file name exactly as it was created on the system.
WINDOWS_NT_ FILES_GTAR	To restore an NT directory and all the files it contains, enter the following syntax: $ ABS RESTORE/NAME=NT_REST "C:\USERS\SMITH\" - _$ /OBJECT_TYPE=WINDOWS_NT_FILES_GTAR/TARGET_NODE=nt1 Result: The example restores the file on and below ..\SMITH\. To restore an individual NT file, use the following syntax: $ ABS RESTORE/NAME=NT_REST "C:\USERS\SMITH\TEMP.TXT" - _$ /OBJECT_TYPE=WINDOWS_NT_FILES_GTAR/TARGET_NODE=nt1 Note: NT file names are not case-sensitive.

 

 

Restrictions

• You must have WRITE access to the storage policy where the data is located.
• You must have WRITE access to the environment policy used to restore the data.
• You cannot mix file types in the same restore request.
• You cannot specify more than eight disk or file names per ABS RESTORE command.
• Each disk or file name cannot exceed 255 characters.
• If you are creating a FULL or INCREMENTAL restore operation, you must enter the file or disk name exactly the same as you entered it for the save request.
• If you are restoring a bound volume set, you must enter the disk or file name exactly as you entered it on the save request, and you must enter the /DESTINATION qualifier that specifies the list of the disk devices in the bound volume set (a comma-separated list of disk names enclosed within quotation marks).

Example:

ABS> RESTORE/NAME=BOUND_RESTORE DISK$USER1:/OBJECT_TYPE=VMS_FILES -
_ABS>/DESTINATION="DISK$USER1:,DISK$USER2:,DISK$USER3:"

Qualifiers

Nonpositional Qualifiers

The following nonpositional qualifiers are applied to the entire restore operation.

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Enables you to set up the access controls by user name or by access right identifier. The following access control options are available:

• Read - Users with Read access control can show the restore request.
• Write - Users with Write access control can modify the restore request.
• Delete - Users with Delete access control can delete the restore request.
• Set - Users with Set access control can modify any attribute of the restore request, including access control.
• Show - Users with Show access control can show the restore request
• Control - Users with Control access control can modify the access control for the restore request, but not any of its other attributes.

Requirement:
The access control must be enclosed within quotation marks, and, if you are assigning multiple access controls per user, they must be listed as a comma-separated or plus-separated list enclosed within quotation marks.

/BEFORE

/BEFORE[=time]

Restores only those files archived prior to the specified time. You can specify 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.

Restrictions:
If you specify this qualifier, you cannot specify the /DATE_ARCHIVED, or the
/LATEST_COPY, or the /SINCE qualifier.

Default:
If you do not specify any date, the current date and time is used. If you do not specify any date selection qualifier /LATEST_COPY is the default.

/CATALOG=catalog-name

Constrains restoring the data from the specified catalog name. This overrides the catalog name in the STORAGE_CLASS.

Restrictions:

• If you specify this qualifier, you cannot specify the /STORAGE_CLASS qualifier in the same ABS RESTORE command.
• You cannot specify the /FULL qualifier if the catalog is an SLS type catalog.

Default:
If you do not specify this qualifier, ABS searches the catalog referenced by the storage class specified in /STORAGE_CLASS.

/DATE_ARCHIVED

/DATE_ARCHIVED[=date]

Restores only those files archived on the day of the specified date. You can specify the date as an absolute time, as a combination of absolute and delta times, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

Restriction:
If you specify this qualifier, you cannot specify the /BEFORE, or the /LATEST_COPY, or the
/SINCE qualifier.

Default:
If you do not specify any date, the current date and time is used. If you do not specify any date selection qualifier /LATEST_COPY is the default.

/DESTINATION=disk-directory-specification

Use this qualifier to specify where you want to restore the data to. Specify the disk and directory name, but not the file name. ABS will assign the original file name. This qualifier is valid for OpenVMS files, Oracle Rdb files, and UNIX files.

Restrictions:

• Do not specify a file name. ABS assigns the original file name to the restored data.
• Do not specify this qualifier for NT restore operations. NT files can only be restored to their original location.

Default:
If you do not specify this qualifier, ABS restores the data to its original location.

/ENVIRONMENT=environment-policy-name

Specifies the name of the environment policy to use for the restore operation.

Default:
If you do not specify this qualifier, ABS uses the storage policy name (determined by the disk name or file name specified in the include_spec parameter) appended with _ENV. If that environment is not found, ABS uses the default execution environment named DEFAULT_ENV.

/EPILOGUE="string"

/NOEPILOGUE (default)

Specifies executing a DCL command after restoring each disk or file name specified in the include_spec parameter.

Restriction:
The string for this qualifier is limited to 80 characters and must be enclosed within quotation marks.

Default:
If you do not specify this qualifier, no epilogue command is executed.

/FULL

Defines the type of restore operation. A full restore operation restores the FULL backup for an entire volume or Oracle Rdb database.

Requirement:
If you specify a full restore operation, you must specify the disk or file name(s) in the include_spec parameter exactly as it was specified in the save request include_spec parameter. See Table 1-3 for an example of creating a full restore request.

/INCREMENTAL

Defines the type of restore operation. An incremental restore operation restores the FULL backup and includes any necessary INCREMENTAL backups.

Restriction:
If you specify an incremental restore operation, you must enter the file or disk names in the include_spec parameter exactly as they were entered on the save request include_spec parameter. See Table 1-3 for an example of creating an incremental restore request.

/LATEST_COPY (default)

Restores only the most recently archived copy of files.

Restriction:
If you specify this qualifier, you cannot specify the /BEFORE, or the /DATE_ARCHIVED, or the /SINCE qualifier.

You may not get the latest saveset if you are doing selective restores. See the restriction under the /SELECTIVE qualifier for more information.

Default:
If you do not specify any date selection qualifier /LATEST_COPY is the default.

/NAME=restore-request-name

Specify this qualifier to assign a unique name to the restore request.

Restriction:
You can use any supported characters for the restore request name. However, the restore request name cannot exceed 40 characters.

Default:
If you do not specify this qualifier, the default restore request name is the user name and current time of the creating process. For example, if the user name is SMITH, and the current day and time is 15-FEB-1994 11:22:21, the default restore request name would be SMITH_15-FEB-1994_11_ 22_21.

/OWNER=user-name

Specifies the owner of the restore request. The owner is always granted SHOW and CONTROL access.

/PROLOGUE="string"

/NOPROLOGUE

Specifies executing a DCL command before restoring each disk or file name specified in the include_spec parameter.

Restriction:
This qualifier is limited to a 80 character string and must be enclosed within quotation marks.

Default:
If you do not specify this qualifer, no prologue command is executed.

/SELECTIVE (default)

Defines the type of restore request for ABS to perform. A selective restore request restores only the data specified in the include_spec parameter, such as DISK$USER1:[USER01]*.DAT;*. See Table 1-3 for an example of creating a selective restore request.

Restriction:
When you are restoring selective data using a wildcard character, you may not get the saveset you desire. This is because ABS will locate the first saveset that matches the wildcard file specification and use that saveset in the restore. Multiple savesets will not be used, and some of the data you require may not be restored. To be sure that you will get the files you require, use ABS LOOKUP to find the files and the save dates. Then use the /BEFORE or /AFTER qualifiers to specify a date for the restore. You may need to do multiple restores to restore the required data. Another alternative is to use an INCREMENTAL restore if you have full and incremental savesets to restore.

Default:
By default, ABS performs a selective restore operation if you do not specify either the /FULL or /INCREMENTAL qualifier.

/SEQUENCE_OPTION=option

Defines the type of sequencing to use during the restore operation. ABS supports the following options:

• SEQUENTIAL-Performs the restore operation sequentially. The first restore operation must complete before the next one begins.
• OVERLAPPED-Starts the next restore operation as soon as the backup device is available for use.

Default:
If you do not specify this qualifier, ABS performs a sequential restore operation.

/SINCE

/SINCE[=time]

Restores only those files archived after the specified time. You can specify 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.

Restriction:
If you specify this qualifier, you cannot specify the /BEFORE, or /DATE_ARCHIVED, or the
/BEFORE qualifier.

Default:
If you do not specify any date selection, the default is /LATEST_COPY. If you do not specify any date, the current date and time is used.

/START_TIME=time

/NOSTART_TIME

The time that you want to start the restore request. You can specify time as an absolute time, as a combination of absolute and delta times, or as one of the standard OpenVMS keywords such as TODAY or TOMORROW. If the specified time is earlier than current time, the request is scheduled for current time. If you specify /NOSTART_TIME, the request will not be started until you modify the start time using the SET RESTORE command.

Examples:

1. /START_TIME=01-JAN-1997
2. /START_TIME=12:00:00
3. /START_TIME="01-JAN-1997 12:00:00"

Default:
If you do not specify this qualifier or if you specify the qualifier with no time value, ABS uses the current date and time.

/STORAGE_CLASS=storage-policy-name

The name of storage policy to reference for the restore operation. If you specify a storage policy name, the restore operation is constrained to the catalog referenced by the storage policy, unless you have specified /CATALOG. In that case, the catalog specified will be used.

Important Note:
You can assign the same catalog name to multiple storage polices. When more than one storage policy contains the same data, and those storage policies reference the same catalog name, ABS restores the most recent data regardless of which storage policy the data is located in.

Restriction:
If you specify the /STORAGE_CLASS qualifier, you cannot specify the /CATALOG qualifier in the same ABS RESTORE command.

Default:
If you do not specify this qualifier or the /CATALOG qualifier ABS searches the catalog referenced by the SYSTEM_BACKUPS storage class.

Positional Qualifiers

The following positional qualifiers are applied to each file or disk name that you specify in the include_spec parameter. You can specify up to eight separate file or disk names for each restore request you create.

/AGENT_QUALIFIERS="string"

This qualifier enables you to specify a backup agent-specific qualifier or set of qualifiers. This qualifier is valid for all file types: VMS_FILES, RDB_n_DATABASE, RDB_n_STORAGE_AREA, UNIX_FILES_GTAR, or WINDOWS_NT_FILES_ GTAR.

Restriction:

• The string supplied for this qualifier must be enclosed within quotation marks.
• The AGENT_QUALIFIER string is limited to 80 characters.

Using this qualifier may supersede qualifiers set by ABS. Use this qualifier with extreme caution.

/CONFLICT_OPTIONS=option

Specifies the manner in which to restore data that already exists on line. This qualifier is positional and is paired with a disk or file name specified in the include_spec parameter. ABS supports the following options:

• OVERLAY_VERSION-Overwrites the online version with the restored version of the data
• RETAIN_VERSION-Retains the online version and does not restore the conflicting version of the data
• NEW_VERSION-Restores the data and creates a new version

/OBJECT_TYPE=object-type-name

Specifies the type of data to restore. This positional qualifier is paired with a file or disk name specified in the include_spec parameter. ABS supports the following object types:

• RDB_Vn.n_DATABASE ( n.n = 4.2, 5.1, 6.0, 6.1, 7.0 )
• RDB_Vn.n_STORAGE_AREA ( n.n = 4.2, 5.1, 6.0, 6.1, 7.0 )
• UNIX_FILES_GTAR
• VMS_FILES
• VMS_SAVESET
• WINDOWS_NT_FILES_GTAR

Restrictions:

• If you specify the /OBJECT_TYPE=RDB_Vn.n_DATABASE, you cannot use wildcard characters. You must fully specify the disk name, directory specification, and the Oracle Rdb database file name:

$ ABS RESTORE/NAME=DATABASE_RESTORE DISK$USER1:[USER1_RDB] -
_$ SITE_PERSONNEL.RDB/OBJECT_TYPE=RDB_V6.1_DATABASE

• If you specify /OBJECT_TYPE=RDB_Vn.n_STORAGE_AREA, you must enclose the disk name, the directory specification, and the storage area name within quotation marks:

$ ABS RESTORE/NAME=STORAGE_AREA_RESTORE "DISK$:[DIRECTORY] -
-$ database_name/AREA=area_name" /OBJECT_TYPE=RDB_V6.1_STORAGE_AREA

Default:
If you do not specify this qualifier, ABS uses /OBJECT_TYPE=VMS_FILES.

/TARGET_NODE=node-name

For OpenVMS files and Oracle Rdb databases or storage areas, use this qualifier to specify the node where the restore request will execute. For NT and UNIX files, use this qualifier to specify the node name where you want to restore the data. This positional qualifier is paired with a disk or file name in the include_spec parameter.

Restrictions:

• You can specify only one target node per restore request. ABS applies the first target node to the entire restore request. If you include other nodes, ABS ignores them.
• For NT files, you cannot specify a different node than the node specified on the save request.

Default:
If you do not specify this qualifier, ABS uses the current node of the requesting process.

Examples

1. To perform a full restore operation for DISK$USER1, see the following example:

ABS> RESTORE/NAME=FULL_RESTORE/FULL DISK$USER1:/OBJECT_TYPE=VMS_FILES

1. To perform a selective restore operation of the file LOGIN.COM on DISK$USER1:[USER1], to overwrite any existing versions, and to reference the SYSTEM_BACKUPS storage policy, see the following example:

ABS> RESTORE/NAME=SELECTIVE_RESTORE/SELECTIVE -
_ABS> DISK$USER1:[USER1]LOGIN.COM/OBJECT_TYPE=VMS_FILES -
_ABS> /CONFLICT_OPTIONS=OVERLAY/STORAGE_CLASS=SYSTEM_BACKUPS

1. If you are using a DCL command procedure file and you need to know when the restore operation has completed, use the ABS SYNCHRONIZE command and the restore request name

$ ABS RESTORE/NAME=MY_RESTORE TEST_DAT.*
$ ABS SYNCHRONIZE MY_RESTORE

See Table 1-3 to determine how to create a selective, incremental, or full restore operation.

 

1. Type of Restore Request Options

 

 

Type of Option	OpenVMS Restore Operations	Oracle RMU Restore Operations	UNIX or NT Restore Operations
Selective	Restores only selective data.   Note: ABS restores only the first saveset that it finds that contains the selected data. Only one saveset is restored, no incremental savesets will be restored during a selective restore. Use caution when using wildcards in a selective restore as you may not get all the files you desire. Use ABS LOOKUP to find the dates of the files you wish to restore and use /BEFORE or /SINCE to ensure that you get the correct savesets.	Use this option to restore an Rdb storage area. Specify only the disk and storage area name in the include_spec parameter: $ ABS RESTORE / -_$NAME=STG_RESTORE -_$DISK$USER1:ACCOU -_$NTING/OBJECT_TYPE-_$=RDB_V6.1_STOR -_$AGE_AREA	A selective restore operation is determined by the path name entered for the include_spec parameter. To restore the directory /usr and all of the subdirectoires and files underneath it, use one of the syntaxes described in Table 1-2.
Full	Performs a restore operation of the disk or file name entered in the include_spec parameter. For example, if you specify only an OpenVMS disk name, ABS restores both the full and incremental save sets of that disk: $ ABS RESTORE /NAME=FULL_RESTORE _$ DISK$USER1:_$/ OBJECT_TYPE= - _$ VMS_FILES   Result: ABS restores the most recent full backup and the required incremental backups to restore the most recent version of DISK$USER1:.   Restriction: ABS does not allow you to specify a full restore operation for a SLS file.	Performs a restore operation for a full Rdb database including the most recent incremental backups.	The type of restore operation for UNIX and NT files is determined by the pathname entered for the include_spec paremeter. ABS automatically turns a full restore operation into a selective restore operation for UNIX and NT files.
Incremental	Not recommended. Incremental restore operations are accomplished as part of a full restore operation. See Table 1-5 for more information.	Not recommended. Incremental restore operations are accomplished as part of a full restore operation. See Table 1-5 for more information.	Not recommended. Incremental restore operations are accomplished as part of a full restore operation.See Table 1-5 for more information.

 

Format

 

 

ABS SAVE

[/ACCESS_CONTROL] [/ENVIRONMENT] [/EPILOGUE] [/FULL] [/INCREMENTAL] [/NAME] [/OWNER] [/PROLOGUE] [/SCHEDULE_OPTION] [/SELECTIVE] [/SEQUENCE_OPTION] [/START_TIME] [/STORAGE_CLASS]

{include_spec}

[/AGENT_QUALIFIERS] [/BEFORE] [/EXCLUDE] [/OBJECT_TYPE] [/SINCE] [/SOURCE_NODE ]

[...,]

 

Parameters

include_spec

The disk or file name that you want to save. The following wildcard characters are permitted in the include_spec parameter for VMS files:

• Asterisk (*)
• Percent sign (%)

Table 1-4 shows how to correctly enter the syntax for the file type you are saving.

 

1. Entering the Correct Syntax for ABS SAVE Command

 

 

File Type	Include_spec Syntax
VMS_FILES	If you want to save an entire OpenVMS disk, enter the disk name and include the trailing colon: $ ABS SAVE/NAME=VMS_SAVE DISK$USER1:/ OBJECT_TYPE=VMS_FILES If you want to save an individual file or set of files, use the following type of syntax: $ ABS SAVE/NAME=MY_FILE DISK$USER1:LOGIN.COM - _$ /OBJECT_TYPE=VMS_FILES
Oracle Rdb Database	If you want to save an Oracle Rdb database, specify the Oracle Rdb version-specific file type and use the following syntaxes: $ ABS SAVE/NAME=RDB_SAVE - _$ DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB - _$ /OBJECT_TYPE=RDB_V6.0_DATABASE
Oracle Rdb Storage Area	If you want to save an Oracle Rdb storage area, specify the Oracle Rdb version specific file type and use the following syntax: $ ABS SAVE/NAME=STORAGE_SAVE "DISK$USER1:[USER1_RDB]SITE- _$_PERSONNEL.RDB/INCLUDE=ACCOUNTING" - _$ /OBJECT_TYPE=RDB_V6.0_STORAGE_AREA
UNIX_FILES_GTAR	To save all directory structures and files under the directory ABS, use the following syntax: $ ABS SAVE/NAME=UX_SAVE "/abs/" /OBJECT_TYPE= - _$ UNIX_FILES_GTAR/SOURCE=unix1 Result: The example save files on and below ../abs/.   To save an individual file, enter the complete UNIX pathname: $ ABS SAVE/NAME=SAVE_UNIX_FILE"/usr/users/smith/ _$ login.com"/OBJECT_TYPE=UNIX_FILES_GTAR/SOURCE=unix1 If you want to save multiple files, use the following syntax: $ ABS SAVE/NAME/MY_UNIX_FILE "/usr/users/smith/login.com" - _$ /OBJECT_TYPE=UNIX_FILES_GTAR/SOURCE=unix1 - _$ "/usr/users/jones/login.com" - _$ /OBJECT_TYPE=UNIX_FILES_GTAR/SOURCE=unix1 Note: UNIX file names are case-sensitive. You must enter the file name exactly as it was created on the system.
WINDOWS_NT_FIL ES_GTAR	To save the NT directory named \usr and all of the subdirectories and files underneath it, enter the following syntax: $ ABS SAVE/NAME=NT_SAVE "C:\USR\SMITH\" - _$/OBJECT_TYPE=WINDOWS_NT_FILES_GTAR/SOURCE=nt1 Result: This example saves all files on and below ..\SMITH\.   Note: NT file names are not case-sensitive.

 

Restrictions

• You must have ABS_CREATE_STORAGE_CLASS access right identifier enabled on your process.
• You must have WRITE access to the storage policy to create a save request.
• You must have WRITE access to the environment policy used to save the data.
• Do not mix VMS_FILES or RDB object types with NT or UNIX file types in the same save request. It is recommended that you create a separate save request for each file type.
• All UNIX backup operations must be performed as a system backup operation. The environment policies used for UNIX backup operations must specify the user on the user profile as ABS. UNIX backup operations cannot be performed as a user backup operation. This means the environment policy cannot have a user profile that specifies the user as <REQUESTER>.
• Do not specify more than twenty four disk or file names per ABS SAVE command.
• A disk name or file name cannot exceed 255 characters.
• Do not specify more than one OpenVMS client nodename in a single save request.
  
  For example, do not create a save request that specifies NODEA::DISK$USER and NODEB::DISK1. In this example, ABS starts the save operation on NODEA and then attempts to save the disk named DISK1 (not located on NODEA), and the save request fails.
• Include the colon as part of the OpenVMS disk name specified for a full save request in the include_spec parameter.

Example:

DISK$USER1:

• If you are creating a save request for a bound volume set, enter only the volume set name or the first disk device name in the bound volume set. ABS will recognize each disk name assigned to the bound volume set.

If you are restoring a bound volume set, you must enter each disk name in the bound volume set. See ABS RESTORE command for details about restoring a bound volume set.

• Wildcard characters-Wildcard characters are only valid for backup agents that support them, such as the VMS BACKUP Utility or gtar for UNIX or NT files.
• Wildcard characters are not valid for an Oracle Rdb database or storage area specification:
• Oracle Rdb database-An Oracle Rdb database requires the disk name, the directory specification, and the Oracle Rdb database file name.

Example:

$ ABS SAVE/NAME=DB_SAVE DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB -
_$ /OBJECT_TYPE=RDB_V6.0_DATABASE

- Oracle Rdb storage area-An Oracle Rdb storage area requires you to specify the / INCLUDE qualifier that includes the disk name, the directory specification, the Oracle Rdb database file name, and the storage area name.

Example:

$ ABS SAVE/NAME=SA_SAVE -
_$"DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB/INCLUDE=ACCOUNTING" -
_$/OBJECT_TYPE=RDB_V6.0_STORAGE_AREA

Recommendation:
Unless you are creating a full save or restore request, specify the full path name for the data you are going to save. Include the device name, directory name, and file name.

Example:

$ ABS SAVE/NAME=MY_SAVE DISK$USER1:[USER1]LOGIN.COM/OBJECT_TYPE=VMS_FILES

• Full disk-If you are doing a full backup operation on an OpenVMS disk, you must include the trailing colon as part of the include_spec parameter:

$ ABS SAVE/NAME=FULL_SAVE DISK$USER1:/OBJECT_TYPE=VMS_FILES

• Concealed logical names-If the include specification contains a concealed logical name, the concealed logical name must be a system-wide logical name or physical device name. Save and restore requests translate the logical names to the first concealed logical name found. However, if this concealed logical name is in the process table, access to the logical name is not available to ABS, and the save or restore operation will fail.
• Bound volume sets-When specifying a bound volume set, only specify the volume set name or the first disk name assigned to the bound volume set. ABS recognizes each disk assigned to the bound volume set.
  
  However, if you perform a restore operation on a bound volume set, you must specify each disk in the bound volume set in either the Restore To option (using the ABS GUI) or using the /DESTINATION qualifier (using the DCL command ABS RESTORE). See Table 1-3 for instructions about restoring a bound volume set.

Qualifiers

Nonpositional Qualifiers

The following nonpositional qualifiers are applied to the entire save request.

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Enables you to set up the access controls by user name or by access right identifier. The following access control options are available:

• Read - Users with Read access control can show a save request.
• Write - Users with Write access control can show a save request.
• Delete - Users with Delete access control can delete the save request.
• Set - Users with Set access control can modify any attribute of the save request, including access control.
• Show - Users with Show access control can show the save request.
• Control - Users with Control access control can modify the access control for the save request, but not any of its other attributes.

Requirement:
The access control must be enclosed within quotation marks and, if you are assigning multiple access controls per user, they must be listed as a comma-separated or plus-separated list enclosed within quotation marks.

/ENVIRONMENT=environment-policy-name

Specifies the name of the environment policy to use for the save operation.

Default:
ABS uses the storage policy name appended with _ENV. If that environment policy is not found, ABS uses the default environment policy named DEFAULT_ENV.

/EPILOGUE="string"

/NOEPILOGUE

Use this qualifier to execute a DCL command after saving each file or disk specified in the include_spec parameter.

Restriction:
This qualifier is limited to 80 character string and must be enclosed within quotation marks.

Default:
If you do not specify this qualifier, no epilogue command is executed.

/EXPLICIT=interval

Use this qualifier to specify an explicit interval valid for the current scheduler interface option.

Requirement:
The /EXPLICIT qualifier is only valid when used with the /SCHEDULE_ OPTION=EXPLICIT qualifier.

/FULL

Defines the type of save request. A full save request saves an entire disk, or for an Oracle Rdb database, performs a full and complete save operation of the database.

Default:
If you do not specify a type of save request, ABS creates a selective save request. However, if you specify only a disk name in the include_spec parameter, such as DISK$USER1:, by default ABS creates a full save request. This ensures that you can perform a full restore operation on the disk.

See Table 1-5 for an example of creating a full save request.

/INCREMENTAL

Defines the type of backup operation. An save request saves any data modified since the last full or incremental save operation.

However, if you specify only a disk name in the include_ spec parameter, for example DISK$USER1:, and there has not been a full save of the disk, ABS performs a full save operation the first time the save request executes. After that, it performs incremental save operations. This ensures that you can perform a full restore operation on the disk.

Default:
If you do not specify a type of save request, ABS creates a selective save request. However, if you specify only a disk name in the include_spec parameter, such as DISK$USER1:, ABS creates a full save request. This ensures that you can perform a full restore operation on the disk.

See Table 1-5 for an example of creating an incremental save request.

/NAME=save-request-name

Use this qualifier to assign the name of the save request.

Restriction:
You can use any supported characters for the save request name. However, the save request name cannot exceed 40 characters.

Default:
If you do not specify this qualifier, the default save request name is the user name and current time of the creating process. For example, if the user name is SMITH, and the current day and time is 15-FEB-1194 11:22:21, the default save request name would be SMITH_15_FEB_1994_11_22_ 21.

/OWNER=user-name

Specifies the owner of the save request. The owner is always granted SHOW and CONTROL access.

/PROLOGUE="string"

/NOPROLOGUE

Use this qualifier to execute a DCL command or command procedure before saving each disk or file name specified in the include_spec parameter.

Restriction:
This qualifier is limited to 80 character string and must be enclosed within quotation marks.

Default:
If you do not specify this qualifier, no prologue command is executed.

/SCHEDULE_OPTION=option

Use this qualifier to select the scheduling option for the save request.

Choose one of the following options:

• ONE_TIME_ONLY-Executes the save request once, at the time specified for the / START_TIME qualifier.
• After a successful operation and 72 hours have passed, the job is deleted from ABS database and the scheduler database by the Database Cleanup Utility. See Archive/Backup System for OpenVMS Guide to Operations for details about ABS Cleanup Utilities.
• ON_DEMAND-For scheduler interface options INT_QUEUE_MANAGER and EXT_QUEUE_MANAGER the request will be submitted as an OpenVMS batch job at the time specified for the /START_TIME qualifier. To resubmit this save request, you must set a new start time.
• For scheduler interface options DECSCHEDULER and EXT_SCHEDULER the save request is submitted to the scheduler. The save request executes once at the time specified for the /START_TIME qualifier. However, the save request is not deleted and remains as a job in the scheduler. To resubmit the save request, you must release it using the appropriate scheduler command.
• DAILY-Executes a save request once per day, at the time specified for the /START_TIME qualifier.
• DAILY_FULL_WEEKLY-This scheduling option enables you to create a single save request that executes a full backup operation once per week on the day specified, and an incremental backup operation for each subsequent day after the full backup operation is successful. ABS performs the full backup operation on a fixed day of the week during the 7-day cycle.
  
  The DAILY FULL WEEKLY Process
  
  If the save request specifies to start the full backup operation on Monday, ABS will always perform the full backup operation on Monday for that particular save request. This happens even if some of the subsequent incremental backup operations (levels) fail. See Example A.
  
  Example A:

 

 

Day	Type
Monday	Full
Tuesday	Level 1
Wednesday	Level 2
Thursday	Level 3
Friday	Level 4
Saturday	Level 5
Sunday	Level 6
Monday	Full

 

If the full backup operation fails, ABS retries the full backup operation on the next day. If that full backup operation fails, the cycle is repeated until a successful, full backup operation is achieved. ABS considers success and qualified success as a successful completed operation. ABS considers all other status as a failed operation.

Example B:

 

 

Day	Date and Time Run	Type	Result
Monday	31-MAR-1997 02:00	Full	Failure
Tuesday	01-APR-1997 02:00	Full	Failure
Wednesday	02-APR-1997 02:00	Full	Success
Thursday	03-APR-1997 02:00	Level 3	Success
Friday	04-APR-1997 02:00	Level 4	Failure
Saturday	05-APR-1997 02:00	Level 5	Success
Sunday	06-APR-1997 02:00	(Assume skipping this day using special setting in the scheduler being used.)
Monday	07-APR-1997 02:00	Full	Success

 

If you are manually setting up the scheduler being used to skip special days, ABS skips the next level of an incremental backup operation. In Example B, ABS skips Sunday and does not perform the Level 6 incremental backup operation. ABS resumes the full backup operation again on Monday, and the schedule once again repeats itself.

Notice also in Example B that ABS repeats the full backup operation until a successful full backup operation is achieved on Wednesday. If one of the incremental backup operations fail, ABS skips to the next level of the incremental backup operations. Unlike repeating the full backup operation, ABS does not repeat the same level of incremental backup operations during the 7-day cycle.

In Example B, the Level 4 incremental backup operation failed on Friday. On Saturday, ABS resumes with a Level 5 incremental backup operation. However, the contents of the incremental backup operations are correct because ABS will back up all new or modified files since the last successful full backup operation or the last successful lower level incremental backup operation.

The save log file will contain the following backup command issued by ABS for Saturday, 05-APR-1997:

$ BACKUP/.../SINCE="03-APR-1997 02:00:00.00"

Because the last successful lower level incremental backup operation was performed on 03-APR-1997, all changes to any file since the date and time specified in the BACKUP command are included in the backup operation.

• WEEKLY-Executes the save request once per week, at the time specified for the / START_TIME qualifier.
• BIWEEKLY-Executes the save request once every two weeks at the time specified for the / START_TIME qualifier.
• MONTHLY-Executes the save request once per month, at the time specified for the / START_TIME qualifier.
• QUARTERLY-Executes the save request once every three months, at the time specified for the /START_TIME qualifier.
• SEMI_ANNUALLY-Executes the save request two times per year, at the time specified for the /START_TIMEqualifier.
• ANNUALLY-Executes the save request once per year, at the time specified for the / START_TIME qualifier.
• LOG_2-Executes a full backup operation on day 1, and an incremental backup operation on day 2. On day 3, an extended incremental backup operation is executed.

An extended incremental backup operation saves any data modified since the last full or extended incremental backup operation.

• LOG_3-Executes a full backup operation on day 1, and an incremental backup operation on days 2 and 3. Executes an extended incremental backup operation on day 4.

An extended incremental backup operation saves any data modified since the last full or extended incremental backup operation.

More Information:
See Archive/Backup System for OpenVMS Guide to Operations for an illustrated view of the LOG_n descriptions.

• NEVER-Never submits the save request for execution and no job is created for the request. You may need to create one or more save requests before you determine their schedule. To submit the save request, modify the save request and change the /SCHEDULE_OPTION qualifier.
• EXPLICIT-Executes the save request per the time value assigned to the /EXPLICIT qualifier.
  
  Default:
  If you do not specify a scheduling options, ABS uses ONE_TIME_ONLY.

/SELECTIVE

Defines the type of save operation. A selective save request saves only the data specified in the include_spec parameter, such as DISK$USER1:[USER01]*.DAT;*. See Table 1-5 for an example of creating a selective save request.

Default:
If you do not specify a type of save request, by default, ABS creates a selective save request. However, if you specify only a disk name in the include_spec parameter, such as DISK$USER1:, ABS creates a full save request. This ensures that you can perform a full restore operation on the disk.

/SEQUENCE_OPTION=option

Defines the type of sequencing option to use during the save operation. Choose one of the following options:

• SEQUENTIAL-Performs the backup operation sequentially. The first backup operation must complete before the next one can begin.
• OVERLAPPED-Starts the next backup operation as soon as the backup device is available for use. ABS begins the next backup operation during the recording pass.

Default:
If you do not specify this qualifier, ABS performs a sequential backup operation.

/START_TIME=time

/NOSTART_TIME

The time that you want to start the save request. You can specify time as an absolute time, as a combination of absolute and delta times, or as one of the standard OpenVMS keywords such as TODAY or TOMORROW. If the specified time is earlier than current time, the request is scheduled for current time. If you specify /NOSTART_TIME, the request will not be started until you modify the start time using the SET SAVE command.

Examples:

1. /START_TIME=01-JAN-1997
2. /START_TIME="TOMORROW+02:00"
3. /START_TIME="01-JAN-2000 12:00:00"

Default:
If you do not specify this qualifier or if you specify the qualifier with no time value, ABS uses the current date and time.

/STORAGE_CLASS=storage-policy-name

The name of storage policy to use for the save operation. If you specify a storage policy name, all disk names or file names entered in the include_spec parameter will reside in this storage policy.

Default:
If you do not specify this qualifier, ABS uses the default storage policy named SYSTEM_BACKUPS.

Positional Qualifiers

The following positional qualifiers are applied to each file or disk name entered in the include_spec parameter. You can specify up to eight separate file or disk names per save request.

/AGENT_QUALIFIERS="string"

This qualifier enables you to specify a backup agent-specific qualifier or set of qualifiers. This qualifier is valid for all file types: VMS_FILES, RDB_n_DATABASE, RDB_n_STORAGE_AREA, UNIX_FILES_GTAR, and WINDOWS_NT_FILES_ GTAR.

Restriction:

• The string supplied for this qualifier must be enclosed within quotation marks.
• The AGENT_QUALIFIER string is limited to 80 characters.

Using /AGENT_QUALIFIERS qualifier may supersede the qualifiers set by ABS. Use this qualifier with extreme caution.

/BEFORE=date
/NOBEFORE

Constrains the save request to select data (disk name or file name) with a date before the entered date. This positional qualifier is paired with a disk or file name entered in the include_spec parameter. Reserved words of TODAY (default), TOMORROW, or YESTERDAY can be specified for the date value.

If you specify the /NOBEFORE qualifier, ABS does not use any before date selection criteria.

Restriction:
This qualifier is not valid for UNIX or NT save requests.

Default:
If you do not specify any date selection, files are not selected based on a date. If you do not specify a date, the current date and time will be used.

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

Use this qualifier to exclude specific data from the save request. This positional qualifier is paired with a file name entered in the include_spec parameter.

Restriction:
This qualifier is not valid for UNIX or NT save requests. This qualifier should not be used in a FULL backup. Do not include the device name in the file_spec.

Default:
If you do not specify this qualifier, ABS saves all data entered in the include_spec parameter.

/OBJECT_TYPE=object-type-name

Specifies the type of data to save. This positional qualifier is paired with a disk or file name entered in the include_spec parameter. ABS supports the following file type names:

• RDB_Vn.n_DATABASE ( n.n = 4.2, 5.1, 6.0, 6.1, 7.0 )
• RDB_Vn.n_STORAGE_AREA ( n.n = 4.2, 5.1, 6.0, 6.1, 7.0 )
• UNIX_FILES_GTAR
• VMS_FILES
• VMS_SAVESET
• WINDOWS_NT_FILES_GTAR

Restrictions:

• If you specify /OBJECT_TYPE=RDB_Vn.n_DATABSE, you cannot use wildcard characters. You must fully specify the disk name, directory specification, and the Oracle Rdb database file name:

$ ABS SAVE/NAME=RDB_SAVE DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB-
_$ /OBJECT_TYPE=RDB_V7.0_DATABASE

• If you specify /OBJECT_TYPE=RDB_Vn.n_STORAGE_AREA, you cannot use any wildcard characters. You must specify the /INCLUDE qualifier that encloses the disk name, the directory specification, the Oracle Rdb database filename, and the storage area name within quotation marks:

$ ABS SAVE/NAME=AREA_SAVE -
_$"DISK$USER1:[USER1_RDB]SITE_PERSONNEL.RDB/INCLUDE=ACCOUNTING" -
_$/OBJECT_TYPE=RBD_V6.0_STORAGE_AREA

• /OBJECT_TYPE=VMS_SAVESET is only to be used to catalog savesets created outside of ABS (from VMS Backup or Saveset Manager). When you use this object, you should follow the instructions in the ABS Guide to Operations.

Default:
The default object type is VMS_FILES.

/SINCE=date
/NOSINCE

Use this qualifier to save data that was created or modified after a specific date. This positional qualifier is paired with a disk or file name entered in the include_spec parameter. Reserved words of TODAY (default), TOMORROW, or YESTERDAY can be specified for the date value.

Restriction:
This qualifier is not valid for UNIX or NT save requests.

Default:
If you do not specify any date selection, files are not selected based on a date. If you do not specify any date, the current date and time is used.

/SOURCE_NODE=node name

For NT and UNIX files, this positional qualifier defines the node name where the data to save resides. For VMS Files and Oracle Rdb databases or storage areas, the source node is the node where the save request will execute.

Restriction:
For OpenVMS clients, you can specify only one source node per save request. ABS recognizes the source node specified for the first disk or file name, and applies it to the entire save request.

Default:
The default source node is the node on which ABS SAVE command is issued.

Examples

1. To save any file with an extension of .DAT in your current default directory, see the following example:

ABS> SAVE/SELECTIVE/NAME=MY_SAVE *.DAT;*

1. To specify the node on which to execute the save request for VMS files, see the following example:
2. $ ABS SAVE/NAME=user1_SAVE USER01:[USER1]:*.*;*/SOURCE_NODE=NODE01
3. To create a save request with a scheduling interval of DAILY_FULL_WEEKLY for DISK$USER1, DISK$USER1, and DISK$USER3, and to start the operation today at 10:00p.m., see the following example:
4. ABS> SAVE/SCHEDULE_OPTION=DAILY_FULL_WEEKLY/START_TIME="TODAY+22:00"
   _ABS>/NAME=DISK123_WFULL_DINCR DISK$USER1:,DISK$USER2:,DISK$USER3:
5. To create a save request that spans a UNIX file system, see the following example:

ABS> SAVE/NAME=UNIX_SPAN "/dir/file"/OBJECT_TYPE=UNIX_FILES_GTAR -
_ABS> /SPAN_FILESYSTEM=ALL/SOURCE=unix1

1. If you are using a DCL command procedure file and you need to know when the save request has completed, use ABS SYNCHRONIZE command and reference the save request name:

$ ABS SAVE/NAME=MY_BACKUP TEST_DAT.*
$ ABS SYNCHRONIZE MY_BACKUP

1. To demonstrate using both positional and nonpositional qualifiers, see the following example:

$ ABS SAVE/NAME=MIDNIGHT_SAVE_REQUEST/FULL/START=00:00 -
_$ DISK$USER1:/OBJECT_TYPE=VMS_FILES/EXCLUDE=*.COM

1. See Table 1-5 to determine how to create a selective, incremental, or full save request.

 

1. Type of Save Request Options

 

 

Type of Option	OpenVMS Save Operations	Oracle RMU Save Operations	UNIX or NT Save Operations
Selective	Saves only selective data.	Use this option to save a storage area. If you use the /INCLUDE qualifier, only the specified storage areas are saved.	A selective save operation is determined by the path name entered for the include_spec parameter. To save a directory and all of the subdirectoires and files underneath it, use one of the syntaxes described in Table 1-4.
Full	Performs a full save operation on an entire OpenVMS disk. This is equivalent to using the / IMAGE qualifier using the VMS BACKUP Utility. For this type of save request, enter only the OpenVMS disk name and include the trailing colon (a): $ ABS SAVE - _$/ NAME=FULL_DAILY- _$ DISK$USER1: - _$/ OBJECT_TYPE=VMS_ _$FILES	Performs a full and complete backup operation of an Oracle Rdb database. Enter the Rdb Oracle database file name for the include_spec parameter: $ ABS SAVE - _$/NAME=DB_SAVE - _$DISK$USER:[RDB]- _$PER.RDB - _$OBJECT_TYPE=RDB_ V6.0_DATABASE	The type of save operation for UNIX and NT files is determined by the pathname entered for the include_spec parameter. ABS automatically turns a full save operation into a selective save operation for UNIX and NT files.
Incremental	Not recommended because of the amount of effort required to restore individual incremental backup operations. Instead, one of the combined scheduling options such as DAILY_INCREMENTA L_WEEKLY_FULL, LOG- 2, or LOG-3 as previously described.	Not recommended because of the amount of effort required to restore individual incremental backup operations. Instead, use one of the combined scheduling options such as DAILY_INCREMENTAL _ WEEKLY_FULL, LOG-2, or LOG-3 as previously described.	Not recommended because of the amount of effort required to restore individual incremental backup operations. Instead, use one of the combined scheduling options such as DAILY_INCREMENTA L_WEEKLY_FULL, LOG- 2, or LOG-3 as previously described.

 

a.) If you specify the /FULL qualifier and enter a disk name plus a file name, ABS strips off the file name and performs a full backup operation on the OpenVMS disk.

Format

 

 

ABS SET ENVIROMENT

[/ACCESS_CONTROL] [/ACTION] [/COMPRESSION] [/CONFIRM] [/DATA_SAFETY] [/DRIVE_COUNT] [/EPILOGUE] [/INTERVAL_FOR_RETRY] [/LINKS_ONLY] [/LISTING_OPTION] [/LOCKING_OPTION] [/NOTIFICATION] [/OWNER] [/PROFILE] [/PROLOGUE] [/RETRY_COUNT] [/SPAN_FILESYSTEMS]

{name}

 

Parameters

name

The name of the environment policy that you want to modify.

Restrictions

• The requesting process must have the following privileges enabled:
• SYSPRV
• CMKRNL
• The requesting process must be logged into ABS server node.
• The requesting process must have the SET access control enabled on the environment policy.

Qualifiers

The qualifiers for ABS SET ENVIRONMENT command are exactly the same as for ABS CREATE ENVIRONMENT command with the exception of the following qualifiers:

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Adds an access control entry in the policy's access control list. If the user_id matches any of the existing user_ids in the access control entries, the access rights are replaced for the user.

The /REMOVE in conjuction with this qualifier will remove the access control entry for the user.

/CONFIRM
NOCONFIRM (default)

Specify the /CONFIRM qualifier to prompt the user for confirmation before ABS modifies the environment policy.

/REMOVE

This qualifier works in conjunction with /ACCESS_CONTROL qualifier that accepts a user name to remove the Access Control Entries for the specified user. If this operation results in no Access Control Entries being associated with the object, ABS will grant all the Access Rights to the owner of the object.

Examples:

To remove Access Control Entry for the user NODE1::USER1 from an existing EXECUTION ENVIRONMENT named ENVIR1, see the following example:

$ ABS SET ENVIRONMENT ENVIR1/ACCESS_CONTROL= -
_$(USER=NODE1::USER1)/REMOVE

More Information:
See ABS CREATE ENVIRONMENT command for the remaining qualifier descriptions.

Example

1. To remove the prologue and epilogue commands from an existing environment policy named SITE_BACKUP_ENV, see the following example:

$ ABS SET ENVIRONMENT/NOPROLOGUE/NOEPILOGUE SITE_BACKUP_ENV

Format

 

 

ABS SET RESTORE

{name}

[/ACCESS_CONTROL] [/BEFORE] [/CONFIRM] [/DATE_ARCHIVED ] [/DESTINATION] [/ENVIRONMENT] [/EPILOGUE] [/INCREMENTAL] [/LATEST_COPY] [/OWNER] [/PROLOGUE] [/SELECTIVE] [/SEQUENCE_OPTION] [/SINCE] [/START_TIME]

{include_spec}

[/ADD] [/AGENT_QUALIFIERS] [/CATALOG] [/CONFLICT_OPTIONS [/OBJECT_TYPE] [/REMOVE] [/STORAGE_CLASS] [/TARGET_NODE]

[...,]

 

Parameters

name

The name of the restore request that you want to modify.

include_spec

This optional parameter enables you to modify the include specification on an existing restore request. You can add or remove a disk or file name using the /ADD or /REMOVE qualifiers.

Restrictions

• The requesting process must have the SET access control enabled on the restore request.
• You cannot modify the name of the restore request.

Qualifiers

The qualifiers for ABS SET RESTORE command are exactly the same as for the ABS RESTORE command with the exception of the following qualifiers:

Nonpositional Qualifiers

The following nonpositional qualifiers are applied to the entire ABS SET RESTORE command.

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Adds an access control entry in the policy's access control list. If the user_id matches any of the existing user_ids in the access control entries, the access rights are replaced for the user.

The /REMOVE in conjunction with this qualifier will remove the access control entry for the user.

/CONFIRM
/NOCONFIRM (default)

Specify the /CONFIRM qualifier to prompt for confirmation before modifying the restore request.

Positional Qualifiers

The following positional qualifiers are applied to each file or disk name entered in the include_spec parameter.

/ADD

Use this qualifier to add a disk or file name to the include_spec parameter for the existing restore request.

Restriction:
You cannot specify more than eight disk or file names per restore request. If you attempt to add more than eight disk or file names, ABS generates an error.

/REMOVE

Use this qualifier to remove a disk or file name from the include_spec on an existing restore request.

This qualifier also works in conjunction with /ACCESS_CONTROL qualifier that accepts a user name to remove the Access Control Entries being associated with the object, ABS will grant all the Access Rights to the owner of the object.

Examples:

To remove Access Control Entry for the user NODE1::USER1 from an existing RESTORE request named REST1, see the following example:

$ ABS SET RESTORE REST1 /ACCESS_CONTROL = -
_$(USER=NODE1::USER1)/REMOVE

Restriction:
You must have at least one disk or file name remaining in the include_spec parameter. If you attempt to remove all the disk or file names, ABS generates an error.

More Information:
See ABS RESTORE for the remaining qualifier descriptions.

Examples

1. To remove the prologue and epilogue commands from an existing restore request named USER1_RESTORE, see the following example:

$ ABS SET RESTORE USER1_RESTORE/NOPROLOGUE/NOEPILOGUE

1. To add an OpenVMS disk to the restore request, see the following example of the original ABS RESTORE and the ABS SET RESTORE commands:
   
   Original restore request:

$ ABS RESTORE/NAME=DISK_RESTORE DISK$USER2:/OBJECT_TYPE=VMS_FILES

Modified restore request:

$ ABS SET RESTORE DISK_RESTORE DISK$USER1:/ADD

Format

 

 

ABS SET SAVE

{name}

[/ACCESS_CONTROL ] [/CONFIRM] [/ENVIRONMENT] [/EPILOGUE] [/EXPLICIT] [/INCREMENTAL] [/OWNER] [/PROLOGUE] [/SCHEDULE_OPTION] [/SELECTIVE] [/SEQUENCE_OPTION] [/START_TIME]

{include_spec}

[/ADD] [/AGENT_QUALIFIERS] [/BEFORE] [/EXCLUDE] [/OBJECT_TYPE] [/REMOVE] [/SINCE] [/SOURCE_NODE ] [/STORAGE_CLASS]

[...,]

 

Parameters

name

The name of the save request that you want to modify.

include_spec

This optional parameter enables you to modify the include_spec on an existing save request. You can add or remove a disk or file name using /ADD or /REMOVE qualifiers.

Restrictions

• The requesting process must have the SET access control enabled on the save request.
• You cannot modify the name of a save request.

Qualifiers

The qualifiers for ABS SET SAVE command are exactly the same as for ABS SAVE command with the exception of the following qualifiers:

Nonpositional Qualifiers

The following nonpositional qualifiers are applied to the entire ABS SET SAVE command.

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Adds an access control entry in the policy's access control list. If the user_id matches any of the existing user_ids in the access control entries, the access rights are replaced for the user.

The /REMOVE in conjunction with this qualifier will remove the access control entry for the user.

/CONFIRM
/NOCONFIRM (default)

Specify the /CONFIRM qualifier to prompt the user for confirmation before modifying the save request.

Positional Qualifiers

The following positional qualifiers are applied to each disk or file name in the include_spec parameter

/ADD

Use this qualifier to add a disk or file name to the include_spec parameter for an existing save request.

Restriction:
You cannot specify more than twenty four disk or file names per save request. If you attempt to add more than twenty four disk or file names, ABS generates an error.

/REMOVE

Removes a disk for file name from the include_spec parameter on an existing save request.

This qualifier also works in conjunction with /ACCESS_CONTROL qualifier that accepts a user name to remove the Access Control Entries for the specified user. If this operation results in no Access Control Entries being associated with the object, ABS will grant all the Access Rights to the owner of the object.

Examples:

To remove Access Control Entry for the user NODE1::USER1 from an existing SAVE request named SAVE1, see the following example:

$ ABS SET SAVE SAVE1 /ACCESS_CONTROL=(USER=NODE1::USER1)/REMOVE

Restriction:
You must have at least one disk or file name remaining in the include_spec parameter. If you attempt to remove all the disk or file names, ABS generates an error.

More Information:
See ABS SAVE for the remaining qualifier descriptions.

Examples

1. To remove the prologue and epilogue commands from an existing save request named USER1_SAVE, see the following example:

$ ABS SET SAVE USER1_SAVE/NOPROLOGUE/NOEPILOGUE

1. To change the object type, see the following example of the original ABS SAVE and the ABS SET SAVE commands:

Original Save Request:

$ ABS SAVE/NAME=USER1_SAVE DISK$USER1:[USER1]ACCOUNTING.RDB -
/OBJECT_TYPE=RDB_V6.0_DATBASE

Modified Save Request:

$ ABS SET SAVE USER1_SAVE DISK$USER1:[USER1]ACCOUNTING.RDB -
/OBJECT_TYPE=RDB_V6.1_DATABASE

1. To add a file name to an existing save request, see the following example:

$ ABS SET SAVE MY_SAVE LOGIN.COM/ADD

1. To remove a file name froman existing save request, see the following example:

$ ABS SET SAVE MY_SAVE LOGIN.COM/REMOVE

Format

 

 

ABS SET STORAGE_CLASS

[/ACCESS_CONTROL] [/ARCHIVE_TYPE] [/CATALOG] [/CONFIRM] [/CONSOLIDATION] [/DRIVE_LIST] [/EXECUTION_NODE] [/EXPIRATION] [/LOCATION] [/MAXIMUM_SAVES] [/MEDIA_LOCATION] [/OWNER] [/REMOVE] [/RETAIN] [/TAPE_POOL] [/TYPE_OF_MEDIA] [/VOLUME_SET]

{name}

 

Parameters

name

The name of the storage policy that you want to modify.

Restrictions

• The requesting process must have the SET access control enabled on the storage policy.
• The requesting process must be logged into ABS server node.

Qualifiers

The qualifiers for ABS SET STORAGE_CLASS command are exactly the same as for ABS CREATE STORAGE_CLASS command with the exception of the following qualifiers:

/ACCESS_CONTROL=(user_id=user-name,access="option[,...]")

Adds an access control entry in the policy's access control list. If the user_id matches any of the existing user_ids in the access control entries, the access rights are replaced for the user.

The /REMOVE in conjuction with this qualifier will remove the access control entry for the user.

/CONFIRM
/NOCONFIRM (default)

Specify the /CONFIRM qualifier to prompt the user for confirmation before modifying the storage policy.

/REMOVE

This qualifier works in conjunction with /ACCESS_CONTROL qualifier that accepts a user name to remove the Access Control Entries for the specified user. If this operation results in no Access Control Entries being associated with the object, ABS will grant all the Access Rights to the owner of the object.

Examples:

To remove Access Control Entry for the user NODE1::USER1 from an existing EXECUTION ENVIRONMENT named ENVIR1, see the following example:

$ ABS SET ENVIRONMENT ENVIR1/ACCESS_CONTROL= -
_$(USER=NODE1::USER1)/REMOVE

More Information:

See ABS CREATE S TORAGE_CLASS for the remaining qualifier descriptions.

Example

1. To change the retention period and to remove the drive list from an existing storage policy named 3_YEAR, see the following example:

$ ABS SET STORAGE_CLASS 3_YEAR/RETENTION=1095/NODRIVE_LIST

Format

 

 

ABS SHOW ENVIROMENT

[ /BRIEF] [ /FULL] [ /OUTPUT] [ /VERSION ]

{name}

 

Parameters

name

The name of the environment policy that you want to show. The following wildcard characters are permitted:

• Asterisk (*)
• Percent sign (%)

Restrictions

• You must have the SHOW access right identifier enabled on the environment policy that you want to show, or you must enable the access rights identifier ABS_SHOW_ALL or ABS_BYPASS on your user process.

Qualifiers

/BRIEF (default)

Displays only the most important information about the environment policy.

Default:
This is the default behavior for ABS.

/FULL

Displays all the information about the environment policy.

Default:
If you do not specify this qualifier, ABS uses the /BRIEF qualifier.

/OUTPUT=file-spec

Specifies the name of the file to output the information to instead of to SYS$OUTPUT.

Default:
If you do not specify a file name for this qualifier, ABS displays the information to SYS$OUTPUT.

/VERSION=number

Use this qualifier to specify the version of the environment policy that you want to show.

Default:
If you do not specify this qualifier, ABS displays the most recent version.

Format

 

 

ABS SHOW REQUEST_STATUS

{request_name}

 

Parameter

request_name

The name of the save request.

Restrictions

None.

Qualifiers

None.

Example

To use this command, you must define the following logical name:

$ DEFINE/SYSTEM ABS$MONITOR_UPDATE_INTERVAL 30

Where:

30 is the number of seconds that you desire between updates.

1. To show the status of a save request, enter the following command at the system prompt:

$ ABS SHOW REQUEST_STATUS MY_SAVE

TimeStamp: 21-AUG-1998 10:08:37.37
FileSaved: Information Currently Not Available
Status of request: Getting tape drives and volumes.

$ ABS SHOW REQUEST_STATUS MY_SAVE

TimeStamp: 21-AUG-1998 10:11:39.23
Files Saved: 2
Last file saved: DISK$USER:[TEST]FILE1.DAT

Format

 

 

ABS SHOW RESTORE

[ /BRIEF] [ /FULL] [ /OUTPUT] [ /SYMBOLS] [ /VERSION ]

{name}

 

Parameters

name

The name of the restore request that you want to show. The following wildcard characters are permitted:

• Asterisk (*)
• Percent sign (%)

Restrictions

You must have the SHOW access right identifier enabled on the restore request that you want to show, or you must enable the access rights identifier ABS_SHOW_ALL or ABS_BYPASS on your user process.

Qualifiers

/BRIEF (default)

Displays only the most important information about the restore request.

Default:
This is the ABS default behavior.

/FULL

Displays all the information about the restore request.

Default:
If you do not specify this qualifier. ABS uses the /BRIEF qualifier.

/OUTPUT=file-spec

Specifies the name of the file to output the information to instead of the SYS$OUTPUT.

Default:
If you do not specify a file name for this qualifier, ABS displays the information to SYS$OUTPUT.

/SYMBOLS

Stores selected RESTORE set information in process symbols. The following table contains the symbols that are created:

 

1. Symbols

 

 

Symbols	Description
ABS_EXCUTION_NODE	Execution node that will run the job
ABS_NAME	Name of the restore request. See /NAME
ABS_OBJECT_TYPE	Specifies the type of data to restore. See /OBJECT_TYPE
ABS_START_TIME	Time the restore requested was set to start. See /START_TIME
ABS_STORAGE_CLASS	Name of the storage class used for this restore operation.
ABS_TARGET_NODE	Target node for the restore. See /TARGET_NODE
ABS_UID	Unique id used by ABS to identify the specific restore request
ABS_USER_NAME	Currently set as "ABS"
ABS_VMS_COMMAND	ABS command to execute the restore, uses the UID

 

Restrictions:

The wild card character "*" is not allowed as the object name. The qualifiers /BRIEF or /FULL are not allowed when specifying /SYMBOLS.

Default:
If you do not specify the qualifier, no process symbols are created.

/VERSION=number

Use this qualifier to specify the version of the restore request that you want to show.

Default:
If you do not specify this qualifier, ABS displays the most recent version.

Format

 

 

ABS SHOW SAVE

[ /BRIEF] [ /FULL] [ /OUTPUT] [ /SYMBOLS] [ /VERSION ]

{name}

 

Parameters

name

The name of the save request that you want to show. The following wildcard characters are permitted:

• Asterisk (*)
• Percent sign (%)

Restrictions

You must have the SHOW access right identifier enabled on the save request that you want to show, or you must enable the access rights identifier ABS_SHOW_ALL or ABS_BYPASS on your process.

Qualifiers

/BRIEF (default)

Displays only the most important information about the save request.

Default:
This is ABS default behavior.

/FULL

Displays all the information about the save request.

Default:
If you do not specify this qualifier. ABS uses the /BRIEF qualifier.

/OUTPUT=file-name

Specifies the name of the file to output the information to instead of to SYS$OUTPUT.

Default:
If you do not specify a file name for this qualifier, ABS displays the information to SYS$OUTPUT.

/SYMBOLS

Stores selected SAVE information in process symbols. The following table contains the symbols that are created:

 

1. Symbols

 

 

Symbols	Description
ABS_EXECUTION_NODE	Execution node that will run the job
ABS_EXPLICIT	Contains a time formatted explicit scheduler interval. See /EXPLICIT
ABS_NAME	Name of the save request. See /NAME
ABS_OBJECT_TYPE	Specifies the type of data to save. See /OBJECT_TYPE
ABS_SCHEDULE_OPTION	Displays the scheduling option for the save request. See / SCHEDULE_OPTION
ABS_SOURCE_NODE	Source node for the save. See /SOURCE_NODE
ABS_START_TIME	Time the save requested was set to start. See /START_TIME
ABS_STORAGE_CLASS	Name of the storage class used for this save operation. See / STORAGE_CLASS
ABS_UID	Unique id used by ABS to identify the specific save request
ABS_USER_NAME	Currently set as "ABS"
ABS_VMS_COMMAND	ABS command to execute the save, uses the UID

 

Restrictions:

The wild card character "*" is not allowed as the object name. The qualifiers /BRIEF or /FULL are not allowed when specifying /SYMBOLS.

Default:
If you do not specify the qualifier, no process symbols are created.

/VERSION=number

Use this qualifier to specify the version of the save request that you want to show.

Default:
If you do not specify this qualifier, ABS displays the most recent version.

Format

 

 

ABS SHOW STORAGE_CLASS

[ /BRIEF] [ /FULL] [ /OUTPUT] [ /VERSION ]

{name}

 

Parameters

name

Specifies the name of the storage policy to show. The following wildcard characters are supported:

• Asterisk (*)
• Percent sign (%)

Restrictions

You must have the SHOW access right identifier enabled on the storage policy that you want to show, or you must enable the access rights identifier ABS_SHOW_ALL or ABS_BYPASS on your user process.

Qualifiers

/BRIEF (default)

Displays only the most important information about the storage policy.

Default:
This is default behavior for ABS.

/FULL

Displays all the information about the storage policy.

Default:
If you do not specify this qualifier. ABS uses the /BRIEF qualifier.

/OUTPUT=file-name

Specifies the output file name for the information about the SHOW STORAGE_CLASS command.

Default:
If you do not specify a file name for this qualifier, ABS displays the information to SYS$OUTPUT.

/VERSION=number

Use this qualifier to specify the version of the storage policy that you want to show.

Default:
If you do not specify this qualifier, ABS displays the most recent version.

Format

 

 

ABS SHOW VERSION

 

Parameter

None.

Restrictions

The version of ABS$SYSTEM:ABSPOLICY_ENGINE.EXE is not displayed on ABS client system as this file is not supplied on ABS clients.

Qualifiers

None.

Format

ABS SPAWN [DCL Command]

Parameters

DCL Command

Enter any valid DCL command.

Restrictions

None.

Qualifiers

None.

Examples

To spawn out of ABS process and enter a DCL command, use the following format:

ABS> SPAWN DIRECTORY A.*

Result:

ABS returns you to the system prompt and executes the DIRECTORY DCL command.

ABS> SPAWN DIRECTORY A.*

Directory DISK$USER:[USER]
A.COM;1 A.EXE;1

Total of 2 files

After the DCL command has completed, you are automatically reattached to ABS process.

ABS>

Format

 

 

ABS SYNCHRONIZE

[ /SERVERITY] [ /STATUS]

{name}

 

Parameters

name

Specifies the name of the save or restore request to synchronize with. This name must match the save or restore request name returned when the save or restore request was created.

In a user-written command procedure, the save or restore request name returned through a process symbol named ABS$REQUEST_NAME by ABS SAVE, ABS RESTORE, ABS SET SAVE, ABS SET RESTORE commands can be used. However, if you know the name of the save or restore request, use the request name to synchronize with.

Restrictions

None.

Qualifiers

/SEVERITY=symbol

Specifies the name of the symbol to use to return the severity of the completing save or restore request.

Default:
If you do not specify this qualifier, ABS does not create a severity symbol.

/STATUS=symbol

Specifies the name of the symbol to use to return the status of the completing save or restore request.

Default:
If you do not specify this qualifier, ABS does not create a status symbol.

Examples

1. To enable the command procedure to wait for the completion of a save request, enter the following commands:

ABS> SAVE TEST.DAT/NAME=MY_BACKUP
ABS> SYNCHRONIZE MY_BACKUP

1. To enable the command procedure to wait for the completion of a restore request, enter the following commands:

ABS> RESTORE TEST.DAT/NAME=MY_REQUEST
ABS> SYNCHRONIZE MY_REQUEST

1. If you have more than one drive available to perform simultaneous save operations, you can synchronize with each of those save requests.

For example, if you have three drives and you want to use them simultaneously, enter the following lines in your command procedure:

$ ABS SAVE DISK$USER1/NAME=DISK$USER1_BACKUP
$ ABS SAVE DISK$USER2/NAME=DISK$USER2_BACKUP
$ ABS SAVE DISK$USER3/NAME=DISK$USER3_BACKUP
$ ABS SYNCHRONIZE DISK$USER1_BACKUP
$ ABS SYNCHRONIZE DISK$USER2_BACKUP
$ ABS SYNCHRONIZE DISK$USER3_BACKUP

1. If you want to synchronize save/restore requests in your scheduling product, you can utilize a command procedure which executes the request, followed by a synchronize, followed by the execution of the next request.

In this command procedure, Job2 will be executed when job1 completes:

$ <Execute> job1
$ ABS SYNCHRONIZE job1
$ <Execute> job2

"Execute" should be replaced with the appropriate command for your scheduling product.

 

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 acquires the default transition time from the domain object. 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

It is important to note that there is no need to use magazines for loader-type jukeboxes. Users may instead choose to treat volumes separately and move them into and out of jukeboxes individually.

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=10-JUL-2001) -
/OFFSITE=(LOCATION=DPS, DATE=10-JUL-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 10-Jul-2001 to location DPS, and back onsite on 10-Jul-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 denity 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 dataase 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:

 

CARDS	NETWORK	OPER6	OPER12
CENTRAL	OPER1	OPER7	PRINTER
CLUSTER	OPER2	OPER8	SECURITY
DEVICES	OPER3	OPER9	TAPES
DISKS	OPER4	OPER10
LICENSE	OPER5	OPER11

 

/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 acquires the default transition time from the domain object.

/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 /NOTRANSITION_TIME is specified, the volume goes directly into the free state on deallocate. 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

None

Description

The EXIT command exits from the MDMS prompt and returns to the DCL command line. An exit can also be accomplished by typing Ctrl/Z.

Privileges

None

Restrictions

None

Qualifiers

None

Example

MDMS> EXIT

$

 

This command exits from the MDMS prompt.

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 /OVERRIDE 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

/DRIVE=drive_name

This qualifier indicates the volume to be initialized is already in the specified drive and should not be loaded or unloaded. This supports an initialize in place. Only one volume may be specified with this option.

/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.