The name of a specific drive to allocate, which must already have been created with a CREATE DRIVE command. This parameter is optional: drives can also be allocated on the basis of volume, media type, location or node, and jukebox, or certain combinations thereof.

The maximum length of the drive name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

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.

The right MDMS_ASSIST is required unless /NOASSIST is specified.

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 drive name and allocated VMS device name in a search list; as such, both MDMS and non-MDMS commands (e.g. MOUNT) can be issued on the logical name.

When used with /MEDIA_TYPE, you can specify 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.

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

The name of the jukebox from which the drive will be selected.

The maximum length of the jukebox name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

If /MEDIA_TYPE is also specified, the drive must support the specified media type as well as being in the jukebox.

This qualifier requires the right MDMS_ALLOCATE_ALL.

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

This qualifier requires the right MDMS_ALLOCATE_ALL.

The distinct media type that the drive must support. 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.

When used with /MEDIA_TYPE, you can specify 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.

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 drive selection.

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 REPLY/ABORT command. The maximum length of a symbol name is 31 characters.

This qualifier is only applicable when the /ASSIST qualifier is specified.

Specifies if MDMS should retry the operation if no drive is available and /ASSIST is not specified. /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.

The default is /RETRY_LIMIT=0, which means that no retries are performed.

The volume ID of the volume for which an appropriate drive will be selected that can support the volume's media type and placement. If a volume is specified that 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. Valid characters are " ,!,",%-?,A-Z,_".

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

The default is WRITE.

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

The maximum length of the volume ID is 6 characters. Valid characters are " ,!,",%-?,A-Z,_".

The default /ASSIST qualifier outputs an operator request to allocate a volume if there is a problem allocating a volume. 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 fails if there is a problem allocating a volume.

The right MDMS_ASSIST is required unless /NOASSIST is specified.

The new allocated volume or volume set is appended to the volume set specified by the volume-id. The volume-id specifies the selection criteria for allocating the new volumes.

The maximum length of the volume ID is 6 characters. Valid characters are " ,!,",%-?,A-Z,_".

When the /BIND qualifier is used, the following attributes must match:

The BIND volume must be allocated.

This qualifier requires the right MDMS_BIND_OWN, or MDMS_BIND_ALL if the /USER_NAME qualifier is used.

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_OWN or MDMS_SET_POOL. It requires MDMS_SET_ALL or MDMS_SET_VOLUME if the /USER_NAME qualifier is used.

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.

Modifies comments about the object in the volume 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 "". If not specified, the volume description is not changed.

This qualifier requires the right MDMS_SET_OWN or MDMS_SET_POOL. It requires MDMS_SET_ALL or MDMS_SET_VOLUME if the /USER_NAME qualifier is used.

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

This qualifier requires the right MDMS_SET_OWN or MDMS_SET_POOL. It requires MDMS_SET_ALL or MDMS_SET_VOLUME if the /USER_NAME qualifier is used.

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

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

When specified with /MEDIA_TYPE, specifies the location from which to allocate volumes. If a volumes placement is OFFSITE then the off-site location is used. Otherwise the volume's ONSITE location is used. If not specified, other selection criteria are used to allocate the volumes.

Specifies that the volumes are allocated with the specified media type. If not specified, other selection criteria are used to allocate the volumes. This qualifier is required when allocating a specific volume that currently has multiple media types defined for it.

The pool from which the volumes will be selected.

The maximum length of the pool name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

The user must be authorized for the pool unless they have MDMS_ALLOCATE_ALL.

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 volume (set) specified in the /BIND qualifier.

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

This qualifier requires the right MDMS_SET_OWN or MDMS_SET_POOL. It requires MDMS_SET_ALL or MDMS_SET_VOLUME if the /USER_NAME qualifier is used.

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 REPLY/ABORT command. The maximum length of a symbol name is 31 characters.

This qualifier is only applicable when the /ASSIST qualifier is specified.

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 time). 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_OWN or MDMS_SET_POOL. It requires MDMS_SET_ALL or MDMS_SET_VOLUME if the /USER_NAME qualifier is used.

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 volumes will remain in the TRANSITION state before going into the FREE state.

Use the standard OpenVMS delta time format to specify a delta time for the duration.

If /NOTRANSITION_TIME is specified, the volume goes directly into the FREE state on deallocation. If not specified, the transition time in the volume record is not changed.

This qualifier requires the right MDMS_SET_OWN or MDMS_SET_POOL. It requires MDMS_SET_ALL or MDMS_SET_VOLUME if the /USER_NAME qualifier is used.

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.

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 specify the volume ID of the first member of the volume set to bind. 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.

The maximum length of a volume ID is 6 characters. Valid characters are " ,!,",%-?,A-Z,_".

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. Valid characters are " ,!,",%-?,A-Z,_".

If the volume-id command parameter is not specified, then a volume similar to the volume in the /TO_SET qualifier is allocated and bound to the end of that volume set.

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.

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

Specifies the name of the archive.

The maximum length of the archive name is 63 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of archive names may be entered.

Access control allows the system administrator to restrict access to the object to all, or specific users on particular nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier, and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

The archive type specifies the type of archive media associated with the archive. The options are:

The default is TAPE.

The /CATALOG qualifier specifies the name of the catalog used by the archive and a list of nodes and/or groups that can directly access the catalog. Specify a local catalog name representing a catalog object in the MDMS database. With the NODES keyword, you may specify nodes, groups, or a combination thereof. If you specify NONODES, the local execution node on which a save or restore is performed is used as the catalog node.

By default, the catalog name "ABS_CATALOG" is used. For an archive named "DISASTER_RECOVERY", the default is no catalog name.

The default for nodes is NONODES.

The /CONSOLIDATION qualifier specifies the criteria under which new volume sets are created for this archive. You may specify one or more of the following options:

A new volume set is created when any one of the consolidation criteria expire. By default, the consolidation criteria is set to the following:

INTERVAL=7-00:00:00, SAVESETS=0, VOLUMES=0

If no consolidation criteria are specified, new volume sets are not created unless an error occurs. This qualifier is allowed only with archive type TAPE.

Comments about the object. 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 "".

If the archive type is DISK, the /DESTINATION qualifier specifies the disk and directory where the archive data resides. If no destination is specified for archive type DISK, the following is used by default:

ABS$ROOT:[000000]

This qualifier is allowed only with archive type DISK.

The /DRIVES qualifier specifies a list of tape drives to be used by the archive. Specify one or more drive names. By default, no drives are specified, meaning that any drive satisfying other compatibility criteria may be used.

This qualifier is allowed only with archive type TAPE.

The /EXPIRATION_DATE qualifier specifies the date that saved data will expire. Specify an absolute or delta date/time, or a reserved word such as TODAY or TOMORROW. Alternatively, use the relative /RETENTION_DAYS qualifier to specify the number of days the saved data should be retained. /NOEXPIRATION_DATE means that the data is retained indefinitely.

By default, data is retained for 365 days.

This qualifier allows you to specify an existing archive 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 Archive Name.

The /LOCATION qualifier specifies the location to be used to allocate a drive to load a scratch volume (for example, HELP MDMS ALLOCATE DRIVE/LOCATION). Specify a location name specified in the database. This qualifier is applicable only for archive type TAPE. /NOLOCATION removes location as a selection criterion for volume allocation.

By default, the domain default on-site location is used.

The /MAXIMUM_SAVES qualifier specifies the maximum number of save operations that can execute simultaneously using this archive. For example, you can create three save requests and schedule them to run simultaneously, assuming that there are enough resources (e.g. drives) available. Valid values are 1–36. The default is 1.

The /MEDIA_TYPE qualifier specifies the media type of tape volumes used for this archive. By default, the domain default media type is used if the archive type is TAPE, otherwise none.

This qualifier is allowed only with archive type TAPE.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

The /POOL qualifier specifies the pool from which volumes will be allocated. Specify a pool name that exists in the database. If you specify /NOPOOL, then only volumes with no pool definition may be used (equivalent to the SCRATCH pool).

By default, no pool is defined.

This qualifier is allowed only with archive type TAPE.

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

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

The /RETENTION_DAYS qualifier specifies the number of days to retain data for this archive. Either this qualifier or /EXPIRATION_DATE may be used to specify this information. If neither an expiration date nor retention days are specified, then the data is retained indefinitely.

By default, a retention of 365 days is used.

The /VOLUME_SETS qualifier specifies the active volume sets being used (for write) by the archive. Each volume-id should represent the first volume in the volume set.

/NOVOLUME_SETS clears the volume sets, and forces a new volume set to be allocated when the archive is next used.

Setting of volume sets is not recommended as ABS normally assigns volume sets to archives. This is a protected field.

This qualifier requires the right MDMS_SET_PROTECTED.

This qualifier is allowed only with archive type TAPE.

Specifies the name of the catalog.

The maximum length of the catalog name is 26 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier, and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

Only ONE access control entry is allowed for a catalog object.

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

The /DIRECTORY qualifier specifies the disk and directory specification where the catalog files are created.

If no directory is specified, the default is ABS$CATALOG.

If the catalog files already exist no newer versions are created.

The directory must be included in the search list for the ABS$CATALOG logical name.

The /NODE qualifier specifies on which node the new catalog will be created.

The default is the node on which the CREATE CATALOG command is entered.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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

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

The /STAGING qualifier turns on the use of a staging catalog during saves. Using a staging catalog can greatly speed up a save operation by deferring update of the full catalog to an off-line operation. However, a restore cannot be performed until the full catalog is updated. Use of staging is highly recommended.

The /NOSTAGING qualifier turns off use of a staging catalog.

Staging is only used on catalog types FILES and VOLUME_SETS.

By default, staging is enabled.

The /TYPE qualifier defines the type of catalog being used. Select one of the following options:

The default and recommended value is FILES.

Specifies the name of the drive. 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.

The maximum length of a drive name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of drive names may be entered.

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

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.

The default is ALL.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

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

The default is /AUTOMATIC_REPLY.

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

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 specify a node specification (NODE::name) in the vms-device-name parameter. Instead use the /NODES or /GROUPS qualifier.

The default device name is the drive name.

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.

The default is /ENABLED.

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

The default is drive number 0.

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

The default is /ENABLED.

Specifies the names of groups of nodes that share common access to this device. Usually, only one group is specified. If neither the /NODES nor /GROUPS qualifier is specified, then the node from which the command was issued is used as the node name. Groups can also be specified with the /NODES qualifier.

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 maybe inherited with the exception of the following: Drive Name, Device Name, State.

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

Specifies one or more distinct media types that the drive can support for read-write access. The /REMOVE or /REPLACE qualifier can be used to remove or replace objects in the list, 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.

Specifies one or more distinct nodes that have direct access to the drive. The /REMOVE or /REPLACE qualifier 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 the /NODES nor /GROUPS qualifier is specified, then the node from which the command was issued is used as the node name.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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.

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

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

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.

The default is /NOSHARED.

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.

The default is /NOSTACKER.

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, and Unloading.

This qualifier requires the right MDMS_SET_PROTECTED.

Specifies the name of the environment.

The maximum length of the environment name is 63 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of environment names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

The /ACTION qualifier specifies an operation to perform on files or data being saved using this environment. Select one of the following options:

If not specified, the default is RECORD_DATE.

The /ADD qualifier works in conjunction with certain qualifiers that accept lists and adds the specified attributes to the existing list.

This is the default when specifying list items.

The /ASSIST qualifier specifies whether saves and restores using this environment utilize operator assistance (using OPCOM) when needed to continue the operation.

If /ASSIST is specified and operator intervention is needed an OPCOM message will be output. If /NOASSIST is specified and an operator intervention is needed, the operation will fail and the next operation will be performed (if possible).

The default is /ASSIST.

The /DATA_SAFETY qualifier specifies one or more options that the backup agent uses to ensure the integrity of the data being saved. The qualifier is applicable to archive type TAPE and when using OpenVMS Backup as the backup agent. Select one or more of the following options:

By default, data safety options are added. However, you can use the /REMOVE qualifier to remove any option, and the /REPLACE qualifier to replace the option list. If you specify /NODATA_SAFETY, then all options are removed.

If not specified, the default options are: (CRC, FULL_VERIFY, XOR).

Comments about the object. 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 "".

The /DRIVE_COUNT qualifier specifies the number of drives to use for each save or restore using this environment. If there are at least as many drives available as the drive count, that number of drives are allocated for each save and restore request. If not, a reduced number of drives are allocated.

The default and highly recommended value is 1. The number of drives may range from 1 to 32.

The /EPILOGUE qualifier specifies a string to execute after an entire save or restore operations completes. The string may be up to 80 characters and must be enclosed in quotes.

By default, no epilogue command is executed.

This qualifier allows you to specify an existing environment 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 Environment Name.

The /INTERVAL qualifier specifies the time between retries if a save or restore operation fails. This is used in association with the /RETRY_LIMIT qualifier. The interval range must be between 1–60 minutes.

If /RETRY_LIMIT is greater than zero, then the default interval applied is 00:15:00 (15 minutes).

The /LISTING_OPTION qualifier specifies the level of detail in the list file for a save or restore operation. Select one of the following options:

If not specified, the default is NONE.

The /LOCK qualifier specifies the action to take when data usage conflicts occur. If /LOCK is specified, data is saved even if other applications have the data locked for write access. If /NOLOCK is specified, the data is not saved if other applications have the data locked for write access.

The default is /NOLOCK.

The /NOTIFICATION qualifier specifies options to use for notifying mail user or OPCOM classes when using this environment. Select one or more of the following options:

Only one notification entry can be entered per command. Use the /ADD, /REMOVE, and /REPLACE qualifiers to add, remove or replace mail users, OPCOM classes or when definitions. The usernames in an entry must match exactly to successfully modify or remove an entry.

If not specified, the default is:

(OPCOM=TAPES, TYPE=BRIEF, WHEN=FATAL)

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

The /PROFILE specifies the execution user context when running saves or restore in this environment.

A profile must contain a username, and one or more of the following options:

If the username is not specified, the existing username in the profile is assumed. The username must not contain a node or cluster name, and must be a valid OpenVMS user on the node or cluster specified.

If the profile is not specified, the following defaults are applied:

• USER=ABS
• CLUSTER=*
• NODE=*
• PRIVILEGES=NONE (will use ABS privileges on execution node)
• RIGHTS=NONE (will use ABS rights on execution node)

If just a username is provided, the default node is the node in which the command is entered. The privileges and rights are obtained from the UAF file for the specified user on the specified node (or the command node if none).

User name can also be specified as a special keyword, <REQUESTER>. This means that the user profile in the associated save or restore request is used. This is the normal situation for user backups. The other profile fields are not used in this case.

The /PROLOGUE qualifier specifies a string to execute before an entire save or restore operations starts. The string may be up to 80 characters and must be enclosed in quotes.

By default, no prologue command is executed.

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

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

The /RETRY_LIMIT qualifier specifies the number of retries performed if a save or restore operation fails. If you specify a retry limit of 0, no retries are attempted. /NORETRY_LIMIT means that there is no limit on the number of retries.

If not specified, the default value is 3.

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

The maximum length of the group name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of group names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

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

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

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.

When specifying nodes, the node names are the MDMS node names, which should have an equivalent node object (not the DECnet-Plus or TCP/IP fullnames).

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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

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

Specifies the name of the jukebox. The jukebox must be unique in the MDMS domain.

The maximum length of the jukebox name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of jukebox names may be entered.

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

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

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

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

For DCSC-controlled 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.

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

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

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.

Places the jukebox 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.

Specifies the names of groups of nodes that share common access to this device. Normally, only one group is specified. The /REMOVE or /REPLACE qualifier 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 the /NODES nor /GROUPS qualifier is specified, then the node from which the request was issued is used as the node name. Groups can also be specified with the /NODES qualifier.

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 Jukebox name, Robot name, and State.

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.

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

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

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 the /NODES nor /GROUPS qualifier is specified, then the node from which the request was issued is used as the node name.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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

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

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.

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.

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:

This qualifier requires the right MDMS_SET_PROTECTED.

Specifies that an OPCOM message is output when the number of free volumes in the jukebox falls below the specified number. The default value is zero, which disables the feature. The OPCOM message is output on a node that can directly access the jukebox.

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)

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.

Specifies the name of the location.

The maximum length of the location is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of locations may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

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.

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.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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.

Specifies the name of the magazine.

The maximum length of the magazine name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of magazine names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

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 Magazine name, Jukebox name, Placement, Position, and Start slot.

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.

This qualifier specifies the date that the magazine is to be taken off site and the off-site 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 off-site date specify /NOOFFSITE.

The default off-site location is that stored in the domain object.

This qualifier specifies the date that the magazine is to be brought back on site and the on-site 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 on-site date, specify /NOONSITE.

The default on-site location is that stored in the domain object.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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 operation. This qualifier defines the current placement of the magazine. Select one of the following options:

• JUKEBOX
• OFFSITE
• ONSITE
• MOVING

This qualifier requires the right MDMS_SET_PROTECTED.

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 operation. The /POSITION qualifier specifies the position in the jukebox that the magazine resides.

The tower, face and level specification represent the relative number of the tower, face and level, starting from 0. So for 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.

The /SLOT_COUNT qualifier specifies the number of slots in a magazine to store volumes. The default slot count is 32 which can be used for all magazines, but you should specify the actual value for best results.

This qualifier specifies the spaces 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.

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 operation. This qualifier specifies the starting jukebox slot when the magazine is placed in a jukebox.

This qualifier requires the right MDMS_SET_PROTECTED.

Specifies the name of the media type.

The maximum length of the media type name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of media types may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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.

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.

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.

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.

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 for media type name.

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

By default, length is set to zero.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

Specifies the name of the node. Do not append colons to the node name. The node name should be the DECnet Phase IV node name (i.e. logical SYS$NODE) if DECnet Phase IV is supported on the node.

Otherwise, it should be a unique name chosen by the MDMS administrator and it should match the SYSGEN parameter SCSNODE. If SCSNODE is not defined, the node name has to match the host or node name portion of the DECnet-Plus or TCP/IP fullname. If SCSNODE name is not defined and no network name is available, the server starts up with a name of "MDMS$SERVER".

If DECnet-Plus and/or TCP/IP are used, the appropriate fullnames should be stored as attributes of the node. Do not use the node name to specify fullnames.

The maximum length of the node name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of node names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

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

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

This qualifier allows you to specify the DECnet-Plus fullname for a node. The fullname 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 name.

The DECNET_PLUS_FULLNAME has to be defined in order for this node to be fully enabled when the DECnet transport has been enabled and DECnet-Plus is running on the system. The fullname can be specified in upper or lower case.

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.

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.

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

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_Plus fullname, and TCPIP fullname.

The /LOCATION qualifier specifies the location of the node, which is used when allocating volumes and drives. If not specified, or if /NOLOCATION is specified, the default on-site location from the domain record is used as the node location.

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 qualifier 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:

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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

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

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 the logical name "*INET_HOST", then 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 the 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.

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:

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.

Specifies the name of the pool.

The maximum length of the pool name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of pool names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

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.

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.

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.

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 me be inherited.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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

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

Specifies that an OPCOM message is output when the number of free volumes in the pool falls below the specified number. The default value is zero, which disables the feature. The OPCOM message is output on the database server node.

Specifies the name of the restore.

The maximum length of the restore name is 39 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of restore names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

The /ARCHIVE qualifier allows you to specify one or two archives associated with the restore. The first archive name is applicable to full and selective threads in restores. If specified, the second archive name is associated with incremental threads in restores. If a second name is not specified, incremental threads use the first archive name. For any thread, the catalog name from the first archive is always used. At least one archive name must be supplied for a restore. If an archive is not specified, the archive "SYSTEM_BACKUPS" is used by default.

The base date is used as a starting point for restores that have a repeating schedule frequency. Subsequent schedules are applied by adding the multiples of the frequency to the base date. If the restore is not to be repeated, then no base date is needed.

By default, if a base date is not specified but a start date is, the base date is set to the start date. If neither is specified, the base date is not set and the restore is not scheduled for execution.

You can select files for restore based on the date archived before a certain date. If specified, the restore will apply to the latest date archived before the specified date. /NOBEFORE_DATE clears the before date and uses other date criteria to select files, as follows:

The /CATALOG qualifier specifies the name of the catalog used by the restore, and a list of nodes and groups that can directly access the catalog. This catalog overrides the catalog defined in the first archive specified in the restore. If you specify /NOCATALOG, then the catalog in the first restore archive is used.

Specify a local catalog name representing a catalog object in the MDMS database. With the NODES keyword, you may specify nodes, groups or a combination thereof. If you specify NONODES, the local execution node on which the restore is performed is used as the catalog node.

The default is /NOCATALOG.

The /DATA_SELECT_TYPE qualifier specifies the type of data to restore in the default selection. Select one of the following options:

If not specified, MDMS attempts to determine the data select type based on the include file syntax. If MDMS cannot determine this, VMS_FILES is used. The data select type specification is stored in the default selection.

You can select files for restore based on the date archived. If specified, the restore will apply to the latest copy of the data on the date archived. /NODATE_ARCHIVED clears the date archived and uses other date criteria to select files, as follows:

The /DELETE_INTERVAL qualifier specifies the duration of certain restore requests after their start of execution. The qualifier is applicable only to restores with a scheduling frequency of ONE_TIME_ONLY. For these restores, the restore object (and any associated schedules and selections) are deleted after the delete interval has passed following the start of the restore execution. If you do not wish the restore to be deleted, specify /KEEP.

If not specified, the delete interval is 03-00:00:00 (3 days) for restores of frequency ONE_TIME_ONLY, and 0 for all other frequencies.

Comments about the object. 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 "".

The /DESTINATION qualifier specifies the target destination disk/directory location for the restore. Specify a disk and directory combination. If destination is not specified, then restore data is restored to the original disk location from where the data was saved. To clear the destination, enter "".

The default is /NODESTINATION, and the original save destination is used.

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 with in quotation marks). The disk name specified in the /DESTINATION qualifier can be a logical name or a physical device name. The logical name must be defined before creating/executing the restore request. For example:

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

The equivalent MDMS command is as follows:

MDMS> CREATE RESTORE BOUND_RESTORE_MDMS
/DESTINATION="DISK$USER1:,DISK$USER2:,DISK$USER3:"

Before executing the restore request, you must either dismount these output disks or mount them using the /FOREIGN qualifier.

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 option (using the ABS GUI) or using the /DESTINATION qualifier (using the DCL command ABS RESTORE).

Concealed Logical Names:

If the data to be restored has a concealed logical name as part of the data include specification, the concealed logical name must be a system-wide logical name or physical device name. Restore request translates the logical name 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 restore operation fails.

The /ENVIRONMENT qualifier specifies the environment object to use for the restore. Specify an environment name in the MDMS database.

If no environment is specified, one of the following defaults is used, in order of priority:

The /EPILOGUE qualifier specifies a string to execute after each restore thread (i.e. each include list item specification in the restore). The string may be up to 80 characters and must be enclosed in quotes.

By default, no epilogue command is executed.

The /EXCLUDE qualifier is used to exclude files that otherwise would be included with the /INCLUDE qualifier. This is used to exclude files for save or restore when a more general wildcard specification is specified for the include. The exclude specification is stored in the default selection.

By default, no files are excluded.

The /EXECUTION_NODES qualifier specifies one or more node names on which the restore request can be executed. Any one of the nodes can be the execution node for the request. /GROUPS may also be specified.

If no nodes or groups are specified, the include specification uses the node on which the restore was created.

When using scheduler type SCHEDULER you can specify the scheduling frequency using /EXPLICIT_INTERVAL. Enter a string in a format known to the scheduler.

/NOEXPLICIT_INTERVAL clears the explicit interval.

This qualifier is only applicable when the /FREQUENCY=EXPLICIT qualifier is specified.

By default, no explicit interval is defined.

The /FREQUENCY qualifier specifies the scheduling frequency for this restore. Select one of the following options:

Specifies the names of groups of execution nodes on which this restore can be run. Usually, only one group is specified. If neither the /EXECUTION_NODES nor /GROUPS qualifier is specified, then the node from which the command was issued is used as the node name.

The /INCLUDE qualifier allows you to enter a list of up to 24 data specifications to restore. The data specifications can be OpenVMS disks or files. However, all specifications must be of the same data select type, as specified in the /DATA_SELECT_TYPE qualifier.

The include, exclude, and source node specifications, together with the data select type, are stored in a default selection object that has the name restore-name_REST_SEL_DEF.

This selection object can be modified independently to add such refinements as exclude lists, and additional selections can be added to any restore.

/NOINCLUDE removes the include file specification.

By default, there is no include specification.

The /INCREMENTAL qualifier specifies that the restore should be an incremental restore. If not specified, the restore will be a full restore or selective restore based on the data-specification in the associated include specification or selections. /NOINCREMENTAL clears the incremental specification.

The default is /NOINCREMENTAL.

This qualifier allows you to specify an existing restore 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 Restore Name.

For restores only, you can also inherit most attributes from a corresponding save. This is most useful if you want to restore everything that was saved in a specific save request. All attributes can be inherited except for the following:

With both types of inherit, the show only attributes of Job Number and Transaction Status are not inherited.

The /KEEP qualifier indicates that the restore is not to be automatically deleted, and clears the delete interval.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

The /PROLOGUE qualifier specifies a string to execute before each restore thread (i.e. each include list item specification in the restore). The string may be up to 80 characters and must be enclosed in quotes.

By default, no prologue command is executed.

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

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

When using the default selection, this qualifier is not needed, as MDMS adds it automatically.

However, if you want to add your own selections to this restore, you add them with the /SELECTION qualifier. By default a selection is added, but you can also remove selections with the /REMOVE qualifier, and replace selections with the /REPLACE qualifier. /NOSELECTIONS removes all selections from the restore.

The /SEQUENCE_OPTION qualifier defines the type of sequencing used during the restore operation. Select one of the following options:

The default is SEQUENTIAL.

You can select files for restore based on the date archived after a certain date. If specified, the restore will apply to the first date archived after the specified date. You can specify date as an absolute date, as a combination of absolute and delta times, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

/NOSINCE_DATE clears the since date and uses other date criteria to select files, as follows:

It is possible to run a restore at any time, including times when it is not normally scheduled. You may, for example, want to run a restore three hours early, or you may want to run an extra restore for some reason.

By default, if you run a restore at an unscheduled time, MDMS will also run it at its regularly scheduled time as well. If you do not want this, then enter a skip time when starting the restore at the non-scheduled time. The skip time will be added to the start time, and MDMS will not schedule the restore until at least after the skip_time value.

The default is /NOSKIP_TIME.

The /START_DATE qualifier is used to schedule a restore to start at an unscheduled time. The /BASE_DATE is used to specify the normal scheduled times. By default, the start date is set to the base date if not separately specified.

The date value for the /START_DATE is optional. If not specified, the default is now.

/NOSTART_DATE clears the next start date, and the restore will not be scheduled.

Specifies the name of the save.

The maximum length of the save name is 39 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of save names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

The /ARCHIVE qualifier allows you to specify one or two archives associated with the save. The first archive name is applicable to full and selective threads in saves. If specified, the second archive name is associated with incremental threads in saves. If a second name is not specified, incremental threads use the first archive name. For any thread, the catalog name from the first archive is always used. At least one archive name must be supplied for a save.

If an archive is not specified, the archive "SYSTEM_BACKUPS" is used by default.

The base date is used as a starting point for saves that have a repeating schedule frequency. Subsequent schedules are applied by adding the multiples of the frequency to the base date. If the save is not to be repeated, then no base date is needed.

By default, if a base date is not specified but a start date is, the base date is set to the start date. If neither is specified, the base date is not set and the save is not scheduled for execution.

The /DATA_SELECT_TYPE qualifier specifies the type of data to save in the default selection. Select one of the following options:

If not specified, MDMS attempts to determine the data select type based on the include file syntax. If MDMS cannot determine this, VMS_FILES is used. The data select type specification is stored in the default selection.

The /DELETE_INTERVAL qualifier specifies the duration of certain saves after their start of execution. The qualifier is applicable only to saves with a with a scheduling frequency of ONE_TIME_ONLY.

For these saves, the save object (and any associated schedules and selections) are deleted after the delete interval has passed following the start of the save execution. If you do not wish the save to be deleted, specify /KEEP.

If not specified, the delete interval is 03-00:00:00 (3 days) for saves of frequency ONE_TIME_ONLY, and 0 for all other frequencies.

Comments about the object. 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 "".

The /ENVIRONMENT qualifier specifies the environment object to use for the save. Specify an environment name in the MDMS database.

If no environment is specified, one of the following defaults is used, in order of priority:

The /EPILOGUE qualifier specifies a string to execute after each save thread (i.e. each include list item specification in the save). The string may be up to 80 characters and must be enclosed in quotes.

By default, no epilogue command is executed.

The /EXCLUDE qualifier is used to exclude files that otherwise would be included with the /INCLUDE qualifier. This is used to exclude files for save or restore when a more general wildcard specification is specified for the include. The exclude specification is stored in the default selection.

By default, no files are excluded.

The /EXECUTION_NODES qualifier specifies one or more node names on which the save request can be executed. Any one of the nodes can be the execution node for the request. /GROUPS may also be specified.

If no nodes or groups are specified, the include specification uses the node on which the save was created.

When using scheduler type SCHEDULER, you can specify the scheduling frequency using /EXPLICIT_INTERVAL. Enter a string in a format known to the external scheduler. /NOEXPLICIT_INTERVAL clears the explicit interval.

This qualifier is only applicable when the /FREQUENCY=EXPLICIT qualifier is specified.

By default, no explicit interval is defined.

The /FREQUENCY qualifier specifies the scheduling frequency for this save. Select one of the following options:

Specifies the names of groups of execution nodes on which this save can be run. Usually, only one group is specified. If neither the /EXECUTION_NODES nor /GROUPS qualifier is specified, then the node from which the command was issued is used as the node name.

The /INCLUDE qualifier allows you to enter a list of up to 24 data specifications to restore. The data specifications can be OpenVMS disks or files. However, all specifications must be of the same data select type, as specified in the /DATA_SELECT_TYPE qualifier. The include specification is stored in the default selection.

The include, exclude, and source node specifications, together with the data select type, are stored in a default selection object that has the name save-name_SAVE_SEL_DEF.

This selection object can be modified independently to add such refinements as exclude lists, and additional selections can be added to any save.

/NOINCLUDE removes the include file specification.

By default, there is no include specification.

The /INCREMENTAL qualifier specifies that the save should be an incremental save. If not specified, the save will be a full save or selective save based on the data-specification in the associated include specification or selections. /NOINCREMENTAL clears the incremental specification.

The default is /NOINCREMENTAL.

This qualifier allows you to specify an existing save 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 Save Name.

The /KEEP qualifier indicates that the save is not to be automatically deleted, and clears the delete interval.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

The /PROLOGUE qualifier specifies a string to execute before each save thread (i.e. each include list item specification in the save). The string may be up to 80 characters and must be enclosed in quotes.

By default, no prologue command is executed.

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

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

When using the default selection, this qualifier is not needed, as MDMS adds it automatically. However, if you want to add your own selections to this save, you add them with the /SELECTION qualifier. By default a selection is added, but you can also remove selections with the /REMOVE qualifier, and replace selections with the /REPLACE qualifier. /NOSELECTIONS removes all selections from the save.

The /SEQUENCE_OPTION qualifier defines the type of sequencing used during the save operation. Select one of the following options:

The default is SEQUENTIAL.

It is possible to run a save at any time, including times when it is not normally scheduled. You may, for example, want to run a save three hours early, or you may want to run an extra save for some reason.

By default, if you run a save at an unscheduled time, MDMS will also run it at its regularly scheduled time as well. If you do not want this, then enter a skip time when starting the save at the non-scheduled time. The skip time will be added to the start time, and MDMS will not schedule the save until at least after the skip_time value.

The default is /NOSKIP_TIME.

The /START_DATE qualifier is used to schedule a save to start at an unscheduled time. The /BASE_DATE is used to specify the normal scheduled times. By default, the start date is set to the base date if not separately specified.

The date value for the /START_DATE is optional. If not specified, the default is now. /NOSTART_DATE clears the next start date, and the save will not be scheduled.

Specifies the name of the schedule.

The maximum length of the schedule name is 63 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of schedule names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

The /AFTER_SCHEDULE qualifiers specifies that this schedule is scheduled for execution after the AFTER_SCHEDULE name, under the circumstances defined in WHEN. This can be used to serialize a series of operations one after the other, and conditionally execute this schedule depending on the status of the AFTER_SCHEDULE.

The SCHEDULE should be a schedule name defined in the MDMS database. For WHEN, select one of the following:

If an /AFTER_SCHEDULE name is specified, the default WHEN option is ALL.

/NOAFTER_SCHEDULE removes the dependency to execute after another schedule.

There is a restriction with using the /AFTER_SCHEDULE qualifier. Only those schedules (created automatically by MDMS) that have an associated save can be assigned to the /AFTER_SCHEDULE qualifier. Schedules that do NOT have an associated save cannot be assigned to the /AFTER_SCHEDULE qualifier. Hence, any schedule (one with an associated save, or one which executes DCL commands) can have a dependency on a schedule with an associated save, but not on a schedule which executes DCL commands. This is a current MDMS design limitation.

The /COMMAND qualifier specifies the command to submit to DCL when the schedule executes. Specify a valid DCL command line in quotes. This qualifier must be entered for the schedule to do any useful work.

The /DATES qualifier specifies on which days of the month you wish the schedule to execute. Valid values are 1-31. You can enter a date, a list of dates, a range of dates and a list of ranges (e.g. 1-7, 15-21). /NODATES indicates that all dates are valid (1-31) and other criteria are used for scheduling. You can use the /ADD, /REMOVE, and /REPLACE qualifiers to manipulate the dates list.

The default is /NODATES.

The /DAYS qualifier specifies on which days of the week you wish the schedule to execute. Valid values use at least the first three letters of the days of the week (English only). You can enter a day, a list of days, a range of days and a list of ranges (e.g. MON-WED, SAT-SUN). /NODAYS indicates that all day are valid (MON-SUN) and other criteria are used for scheduling. You can use the /ADD, /REMOVE, and /REPLACE qualifiers to manipulate the days list.

The default is /NODAYS.

Comments about the object. 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 "".

The /EXCLUDE qualifier specifies specific dates that you wish to exclude from execution, even though the other scheduling parameters would normally schedule on that date. This can be used to exclude scheduled operations on holidays for example. Enter one or more dates in OpenVMS date format (04-JUL-2001), separated by commas. You can specify dates up to 9 years in the future. /NOEXCLUDE removes all dates from the exclude list. You can use the /ADD, /REMOVE, and /REPLACE qualifiers to manipulate the exclude list.

By default, no exclude dates are defined.

The /INCLUDE qualifier specifies specific dates that you wish to include for execution, even though the other scheduling parameters would normally not schedule on that date. This can be used to include operations on special days that require special attention. Enter one or more dates in OpenVMS date format (31-DEC-2001), separated by commas. You can specify dates up to 9 years in the future. /NOINCLUDE removes all dates from the include list. You can use the /ADD, /REMOVE, and /REPLACE qualifiers to manipulate the include list.

By default, no include dates are defined.

This qualifier allows you to specify an existing schedule 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 Schedule Name.

The /MONTHS qualifier specifies on which months of the year you wish the schedule to execute. Valid values use at least the first three letters of the months of the year (English only). You can enter a month, a list of months, a range of months and a list of ranges (e.g. JAN-MAR, JULSEP). /NOMONTHS indicates that all months are valid (JAN-DEC) and other criteria are used for scheduling. You can use the /ADD, /REMOVE, and /REPLACE qualifiers to manipulate the months list.

The default is /NOMONTHS.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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

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

The /TIMES qualifier specifies the times of the day you wish the schedule to execute. Enter from 1 to 100 times in OpenVMS format, separated by commas. For example (08:00, 10:00, 12:00, 14:00, 16:00). /NOTIMES clears out all times and effectively disables the schedule from execution. /TIMES=00:00 signifies midnight.

By default, no times are set.

The /WEEKS qualifier specifies on which weeks of the year you wish the schedule to execute. Valid values are 1-53. You can enter a week, a list of weeks, a range of weeks and a list of ranges (e.g. 1-7, 15-21, 31-53). /NOWEEKS indicates that all weeks are valid (1-53) and other criteria are used for scheduling. You can use the /ADD, /REMOVE, and /REPLACE qualifiers to manipulate the weeks list.

The default is /NOWEEKS.

Specifies the name of the selection.

The maximum length of the selection name is 63 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of selection names may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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

The /AGENT_QUALIFIERS qualifier allows you to specify a backup-agent specific qualifier or set of qualifiers. This qualifier is valid for all data select types. Specify up to 80 characters enclosed in quotes. /NOAGENT_QUALIFIERS removes all the agent qualifiers.

By default, no agent qualifiers are defined.

The /BEFORE_DATE is used to select files that have a date before the specified date. The type of date in question is specified by the /DATE_TYPE qualifier. If /NOBEFORE_DATE is specified, files are not selected using a before date.

/BEFORE_DATE is applicable only to saves.

The default is that no before date is specified.

The /CONFLICT_OPTIONS is used to determine the disposition of a file if an existing file already exists. This qualifier is applicable only to restores. Select one of the following:

If not specified, the default is RETAIN_VERSION.

The /DATA_SELECT_TYPE qualifier specifies the type of data to restore in the default selection.

Select one of the following options:

If not specified, MDMS attempts to determine the data select type based on the include file syntax. If MDMS cannot determine this, VMS_FILES is used.

The /DATE_TYPE qualifier specifies which date in a file is used using the /BEFORE_DATE and/or /SINCE_DATE in a selection. Select one of the following date types:

If not specified, MODIFIED is the default.

Comments about the object. 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 "".

The /EXCLUDE qualifier is used to exclude files that otherwise would be included with the /INCLUDE qualifier. This is used to exclude files for save or restore when a more general wildcard specification is specified for the include.

By default, no files are excluded.

The /INCLUDE qualifier allows you to enter a list of up to 24 data specifications to restore. The data specifications can be OpenVMS disks or files. However, all specifications must be of the same data select type, as specified in the /DATA_SELECT_TYPE qualifier.

/NOINCLUDE clears the include specification.

See MDMS CREATE RESTORE for the note on maintaining file directory structure during the Restore operation.

This qualifier allows you to specify an existing selection 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 Selection Name.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

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

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

The /SINCE_DATE is used to select files that have a date after the specified date. The type of date in question is specified by the /DATE_TYPE qualifier. If /NOSINCE_DATE is specified, files are not selected using a since date.

You can specify date as an absolute date, as a combination of absolute and delta times, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY.

/SINCE_DATE is applicable only to saves.

The default is that no since date is specified.

Specifies the volume ID of the volume to be added. The volume ID is the external label for the volume. Alternatively, a volume range (separated by a dash) may be specified. A volume range is a numeric range for up to the last five characters of the volume ID. Example ranges are (ABC001-ABC250) and (T20120-T20125).

The maximum length of the volume ID is 6 characters. Valid characters are " ,!,",%-?,A-Z,_".

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.

A comma-separated list of volume IDs or ranges may be entered.

Access control allows the system administrator to restrict access to the object to all or specific users on specific nodes or groups. Select one or more of the following options to allow the operation:

By default, access controls are added to the list of access controls; only one user can be added per command. However, you can remove users using the /REMOVE qualifier and replace the entire access control using the /REPLACE qualifier. You can remove all access controls on the object by specifying /NOACCESS_CONTROL.

The user-id should be in the format node::username or group::username. Wildcards are supported in the node, group, and username portions.

Access control restrictions are in addition to the normal MDMS rights allowing operations on an object. If no access control is defined, then the default domain access control is applied.

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 qualifier requires the right MDMS_SET_PROTECTED.

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

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.

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.

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

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

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.

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.

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.

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.

This is a protected field that should be modified only to recover on error. Use the LOAD and UNLOAD commands to manipulate the drive name under normal operation. 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.

Specifies the format of the tape. Possible values are as follows:

• ASCII
• BACKUP
• EBCDIC
• NONE (Default)
• RMUBACKUP

Specifies the date the volume was last freed (i.e. put in the FREE state). Specify an OpenVMS 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.

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:

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.

This qualifier allows you to set the number of I/O errors on the volume. The default value is zero.

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 be enclosed in quotation marks. Specify "" to clear the job name.

This qualifier requires the right MDMS_SET_PROTECTED.

This is a protected field that should be modified only to recover on error. Use the MOVE VOLUME command to manipulate the jukebox name under normal operation. 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. Valid characters are "$,-,0-9,A-Z,_,a-z".

This is normally set up by MDMS. To clear the jukebox name, specify /NOJUKEBOX.

This qualifier requires the right MDMS_SET_PROTECTED.

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.

This is a protected field that should be modified only to recover on error. Use the MOVE VOLUME command to manipulate the magazine name under normal operation. This qualifier specifies the magazine name if the volume resides in a magazine. This is normally set up by MDMS. To clear the magazine name, specify /NOMAGAZINE.

This qualifier requires the right MDMS_SET_PROTECTED.

The media type qualifier allows you to add the media types 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.

Specifies the number of times the volume has been loaded by MDMS. Normally set up by MDMS. The default mount count is zero.

This qualifier specifies the date that the volume is to be taken off site and the off-site 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 off-site date specify /NOOFFSITE. If a volume is under magazine control, the /OFFSITE qualifier is not allowed. The volume uses the values in the magazine.

The default off-site location is that stored in the domain object.

This qualifier specifies the date that the volume is to be brought back on site and the on-site 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 on-site date specify /NOONSITE. If a volume is under magazine control, the /ONSITE qualifier is not allowed. The volume uses the values in the magazine.

The default on-site location is that stored in the domain object.

The /OWNER_NAME qualifier specifies the owner of the object. Specify an owner as node::username or group::username.

The node, group, and username portions may be wildcarded.

The owner of an object has default access control of all allowances to the object, regardless of whether a specific access control entry is present or the state of the default domain access control. If you wish to remove this unconditional owner access, specify /NOOWNER_NAME. Note that being an owner of an object overrides only the access control; the appropriate MDMS rights for a request on the object must still be honored.

By default, the owner of an object is the cluster-name::username of the user entering the CREATE command on the object from a node in the cluster.

This qualifier specifies the owner UIC of a volume. The owner UIC 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 UIC field, specify /NOOWNER_NAME_UIC.

This qualifier requires the right MDMS_SET_PROTECTED.

This is a protected field that should be modified only to recover on error. Use the MOVE, LOAD, or UNLOAD commands to manipulate the placement field under normal operation. This qualifier defines the current placement of the volume. This is normally managed by MDMS. Select one of the following options:

• 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, or MOVING.

During a MOVE, LOAD, or UNLOAD operation, 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.

The pool in 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.

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.

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.

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.

This qualifier specifies the record length used on the volume. The default record length is zero.

This qualifier puts the volume into the FREE state from the TRANSITION state. It is not valid to release an allocated volume.

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

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

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.

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.

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 a volume range is specified, you can specify a slot range, and each volume will be placed in each slot in order. For a single volume, specify a single slot. This qualifier requires the right MDMS_SET_PROTECTED.

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 creating multiple volumes—each volume will be placed in each space in order. For a single volume, specify a single space.

This is a protected field that should be modified only to recover on error. Use the ALLOCATE VOLUME or DEALLOCATE VOLUME command to manipulate the state field under normal operation. 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.

This qualifier allows you to specify the number of times the volume has been cleaned. The default is zero.

The /TRANSITION_TIME qualifier specifies that the volume enters the TRANSITION state when the scratch date is reached, and is to stay in the TRANSITION state for the specified delta time. When the transition time has expired, the volume enters the FREE state. The /NOTRANSITION_TIME qualifier specifies that the volume enters the FREE state directly at the scratch date.

Puts the volume in the UNAVAILABLE state. The previous state is retained for when the volume is made available again.

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

This qualifier requires the right MDMS_SET_PROTECTED.

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.

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. Valid characters are "$,-,0-9,A-Z,_,a-z".

Specifies the volume ID of the volume to deallocate. This parameter is required except when the /SCHEDULE qualifier is given, in which case it must be omitted.

The maximum length of a volume ID is 6 characters. Valid characters are " ,!,",%-?,A-Z,_".

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.

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_OWN or MDMS_SET_POOL, or MDMS_SET_ALL if the /USER_NAME qualifier is used.

Modifies the amount of time, as a delta time, that a volume will remain in the TRANSITION state before moving to the FREE state. Use the standard OpenVMS delta time format to specify a delta time for the transition duration. If not specified, the existing transition time in the volume record is used, and if none, the default transition time in the domain record is used.

This qualifier requires the right MDMS_SET_OWN or MDMS_SET_POOL, or MDMS_SET_ALL if the /USER_NAME qualifier is used.

Deallocate a volume which is owned by the specified user. The maximum length of the username is 31characters. This qualifier requires the right MDMS_DEALLOCATE_ALL.

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.

Specifies the name of the archive.

The maximum length of the archive name is 63 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of archive names may be entered.

The /OVERRIDE qualifier allows you to delete the archive even with outstanding references to it. This is not recommended unless you are sure that the archive will no longer be needed.

Specifies the name of the catalog.

The maximum length of the catalog name is 26 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of catalog names may be entered.

The /NODE qualifier specifies on which node the catalog will be deleted.

The default is the node on which the DELETE CATALOG command is entered.

The /OVERRIDE qualifier allows you to delete the catalog even with outstanding references to it. This is not recommended unless you are sure that the catalog will no longer be needed.

Specifies the name of the drive.

The maximum length of the drive name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of drive names may be entered.

Specifies the name of the environment.

The maximum length of the environment name is 63 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of environment names may be entered.

The /OVERRIDE qualifier allows you to delete the environment even with outstanding references to it. This is not recommended unless you are sure that the environment will no longer be needed.

Specifies the name of the group.

The maximum length of the group name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of group names may be entered.

Specifies the name of the jukebox.

The maximum length of the jukebox name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of jukebox names may be entered.

Specifies the name of the location.

The maximum length of the location is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of locations may be entered.

Specifies the name of the magazine.

The maximum length of the magazine name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of magazine names may be entered.

Specifies the name of the media type.

The maximum length of the media type name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of media types may be entered.

Specifies the name of the node.

The maximum length of the node name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of node names may be entered.

Specifies the name of the volume pool.

The maximum length of the pool name is 31 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of pool names may be entered.

Specifies the name of the restore.

The maximum length of the restore name is 39 characters. Valid characters are "$,-,0-9,A-Z,_,a-z".

A comma-separated list of restore names may be entered. If /SCHEDULE is entered, a wildcard restore name may be specified.

The /OVERRIDE qualifier allows you to delete the restore even with outstanding references to it. This is not recommended unless you are sure that the restore will no longer be needed.

Deletes the restore request only if its frequency is marked as ONE_TIME_ONLY and its delete interval has expired. Usable with a wildcard restore name.