Optional parameters

DEVTYPE=tape-device-selection-information-address
Specifies the name of a variable that contains the address of the tape device selection information to be associated with the data sets written on this tape volume. The TDSI is mapped by the structure CBRTDSI (see Tape device selection information (CBRTDSI macro)), and consists of four 1-byte fields that specify recording technology, media type, compaction indicator, and special attribute to be associated with the volume.
The following fields in the TDSI may be specified on a CUA request:
  • Recording technology may be specified as unknown, 18TRACK, 36TRACK, 128TRACK, 256TRACK, 384TRACK, EFMT1, EFMT2, EEFMT2, EFMT3, EEFMT3, EFMT4, or EEFMT4.
  • Media type may be specified as unknown, MEDIA1, MEDIA2, MEDIA3, MEDIA4, MEDIA5, MEDIA6, MEDIA7, MEDIA8, MEDIA9, MEDIA10, MEDIA11, MEDIA12, or MEDIA13.
  • Compaction may be specified as unknown, none, or compacted.
  • Special attribute may be specified as none or read compatible.

Any nonzero TDSI field specified for input is merged with the tape device selection information recorded on the volume record. If incompatible tape device selection attributes, such as 36TRACK recording technology and MEDIA4 media type, result from merging the input, an error is returned and CUA processing is not performed. If CUA processing is successful, the TDSI in the volume record in the TCDB is updated with the new, merged values.

DEVTYPE is used only when USE=PRIVATE is specified, and is otherwise ignored.

EXPDATE=volume-expiration-date
Specifies the name of a variable (four-byte length), which contains the expiration date assigned to the volume. The expiration date should be specified in TIME DEC format; for example, packed decimal digits of the form 0CYYDDDF. This field is only used when USE=PRIVATE is specified, and is otherwise ignored. If the change use attribute installation exit is invoked, the value specified by the exit may override the volume expiration date.
GRPNAME=storage-group-name
Specifies the name of a character variable (8-byte length) that contains the name of the storage group to which the volume belongs. The storage group name must be left-justified in the field and padded on the right with blanks, if necessary. This field is only used when USE=PRIVATE is specified, and is otherwise ignored. If a nonblank storage group name is specified on a change to PRIVATE, the storage group must be a tape storage group that is defined in the active configuration. Additionally, if the volume is library-resident, the library must also be defined to the storage group. If a storage group name is specified and there is a change from PRIVATE to PRIVATE, the existing storage group name in the volume record is updated. On a change from PRIVATE to PRIVATE, if no storage group name is specified, the existing storage group name in the TCDB is retained. On a change from SCRATCH to PRIVATE, if no storage group name is specified, the field is set to blanks. If the change use attribute installation exit is invoked, the value specified by the exit may override the storage group name. To be consistent with the existing or resulting storage group name in the TCDB, the storage group name is also assigned as the private volume's outboard storage group policy, if the library supports outboard policy management.
WRTDATE=YES
Specification of this keyword requests the update of the date when a data set was last opened for OUTPUT. The tape volume record is updated with the current date, as returned by the MVS TIME macro, translated into ISO format (YYYY-MM-DD). When this keyword is specified the last mounted date is also set to the current date. This field is only used when USE=PRIVATE is specified, and is otherwise ignored. If the change use attribute installation exit is invoked, it may override the last written date and last mounted date.
WRTPROT=write-protection-status
Specifies the name of a character variable (1-byte length) which contains the volume write protection status. If the write-protect tab is set on the tape cartridge, this field should be set to "Y"; if the write-protect tab is not set, this field should be set to "N"; if the tab setting is unknown, it should be set to blank. This field is only used when USE=PRIVATE is specified, and is otherwise ignored. If the change use attribute installation exit is invoked, the value specified by the exit may override the write protection status.
EXITINFO=installation-exit-information
Specifies the name of a character variable (16-byte length) that contains a customer specified free-form value to be passed to the change use attribute installation exit (CBRUXCUA).
GETPOLICY=YES
Specifies a request to retrieve the current outboard policy names for a volume from the library. The library policy names are stored in the CBRUXCPL parameter list in the UXCLMSG, UXCLMSC, UXCLMMC, and UXCLMDC fields and passed to the CBRUXCUA installation exit. Blanks in a policy field indicate that the volume has the default policy for that construct assigned to it. If GETPOLICY=YES is specified, the CBRUXCUA installation exit can examine the UXCVLOPM indicator to determine if the policy names have been retrieved and stored in the UXCLMOPM fields.

If one or more of the UXCLMSC, UXCLMMC, and UXCLMDC fields is changed by the CBRUXCUA installation exit and the volume use attribute is PRIVATE (PRIVATE to PRIVATE invocation), constructs that are changed are updated in the library. Blanks specified in a policy field indicate that the default policy is requested. The storage group for the TCDB volume record and the outboard storage group policy is specified in UXCGROUP. The UXCLMSG is an input-only variable.

If GETPOLICY=YES is not specified, the library manager policy names are not retrieved and passed to the exit. The GETPOLICY option is ignored if outboard policy management is not supported in the library in which the volume resides. It is also ignored on SCRATCH-to-SCRATCH, PRIVATE-to-SCRATCH, and SCRATCH-to-PRIVATE CUA invocations and all CUA invocations for shelf-resident volumes.

GETPOLICY=YES and the GRPNAME, SCNAME, MCNAME, and DCNAME parameters are mutually exclusive.

SCNAME=storage-class-name
Specifies a request to set a construct name in the library where the specified volume resides as its outboard storage class policy. The storage-class-name is an 8-byte character variable, left justified, and padded on the right with blanks, if necessary. If blanks are specified, the request is to set the volume's storage class library policy to the default policy. If a nonblank storage class name is specified, it is only validity checked against Storage Management Subsystem (SMS) naming convention standards and is not checked to see if it is defined in the active configuration.

The SCNAME option is ignored if outboard policy management is not supported in the library in which the volume resides, if USE=SCRATCH, or if the volume is shelf-resident.

MCNAME=management-class-name
Specifies a request to set a construct name in the library where the specified volume resides as its outboard management class policy. The management-class-name is an 8-byte character variable, left justified, and padded on the right with blanks, if necessary. If blanks are specified, the request is to set the volume's management class library policy to the default policy. If a nonblank management class name is specified, it is only validity checked against SMS naming convention standards and is not checked to see if it is defined in the active configuration.

The MCNAME option is ignored if outboard policy management is not supported in the library in which the volume resides, if USE=SCRATCH, or if the volume is shelf-resident.

DCNAME=data-class-name
Specifies a request to set a construct name in the library where the specified volume resides as its outboard data class policy. The data-class-name is an 8-byte character variable, left justified, and padded on the right with blanks, if necessary. If blanks are specified, the request is to set the volume's data class library policy to the default policy. If a nonblank data class name is specified, it is only validity checked against Storage Management Subsystem (SMS) naming convention standards and is not checked to see if it is defined in the active configuration.

The DCNAME option is ignored if outboard policy management is not supported in the library in which the volume resides, if USE=SCRATCH, or if the volume is shelf-resident.

Rule: The values that you specify for the GRPNAME, SCNAME, MCNAME, and DCNAME parameters must meet the following SMS naming convention standards:
  • Alphanumeric and national characters only
  • Name must begin with an alphabetic or national character ($*@#%)
  • No leading or embedding blanks
  • Eight characters or less