ADDVOLUME: Adding volume information

Purpose

Before you begin: To use the RMM ADDVOLUME subcommand, you need either CONTROL access to the STGADMIN.EDG.MASTER resource profile, or CONTROL access to the STGADMIN.EDG.AV.status.volser profiles, depending on the security roles you have implemented.

Use the ADDVOLUME subcommand to add one or more volumes to DFSMSrmm. Use the MEDINF operand to connect a volume to the media information defined in DFSMSrmm parmlib member EDGRMMxx.

You must supply a volume serial number and volume status. If you are adding more than one volume, you must supply an initial volume serial number and how many volumes you want to add (COUNT). If you are adding a volume with a volume serial number that is less than six characters, you must also include a rack number or a pool prefix.

When you are adding volumes that reside in a manual tape library, you must specify the MEDIATYPE operand.

You can use the RMM ADDVOLUME subcommand to define volumes to DFSMSrmm. When you are defining WORM tapes to DFSMSrmm, allow DFSMSrmm to record the volume WWID when the volume is first used on the system rather than specifying the WWID yourself. This ensures that the WWID for the volume is recorded correctly.

Use the TYPE operand to indicate the type of volume that is being added. When you add a volume that resides in a system-managed library, you do not have to specify the TYPE operand because DFSMSrmm can identify the volume type. If you are adding a stacked volume or a logical volume to a location other than a system-managed VTS, we recommend that you always specify the TYPE operand.

Use the MEDIANAME operand to indicate the name or type of media. If you add the volume to a pool, the media name you use must match the type of media defined for the pool or your ADDVOLUME request fails.

Use the LOCATION operand to indicate where the volume resides: either a shelf location in a non-system-managed tape library, or a system-managed tape library defined by your installation. This also sets the volume's home location, which is where you want a volume returned when it is no longer retained by a vital record specification.

Use the NUMBER, FEATCD, and LEVEL operands to associate the volume with a software product. The software product already defined to DFSMSrmm before you can associate it with a volume.

When you specify ADDVOLUME STATUS(VOLCAT), DFSMSrmm uses information in the TCDB to update the DFSMSrmm control data set. The control data set information that can be updated includes: COMPACTION, CONTAINER, EXPDT, HOME, LOCATION, MEDIATYPE, READDATE, RECORDINGFORMAT, SPECIALATTRIBUTES, STATUS, STORAGEGROUP, TYPE, and WRITEDATE.

If you use any non-scratch operands when adding scratch volumes, DFSMSrmm ignores the non-scratch operands.

Parameters

ACCESS(NONE|READ|UPDATE)

Specifies user access to a volume. Supply a value to define the access level for users defined in the list of users who can access this volume (USERS). You can use one of these:

NONE

Users do not have access to the volume

READ

Users have only read access to the volume

UPDATE

Users have write access to the volume

The default is NONE. This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

ACCOUNT(account_information)

Specifies accounting information. Accounting information is one to forty characters enclosed in single quotation marks if it contains any special characters or blanks.

If you do not use ACCOUNT, DFSMSrmm obtains the information when it records information about the first data set on the volume. At that time, DFSMSrmm gets the accounting information from either the account number of the job or job step that creates the first data set, or from the account number of the job that reads the data set.

There is no default.

ASDATE(assigned_date)

Specifies the date when a master volume or user volume was assigned. For a scratch volume, ASDATE specifies the date when the volume returned to scratch status.

Supply the year and day in one of two forms. We recommend that you use the yyyy/ddd format rather than the yyddd format for dates.

• yyyy/ddd, where yyyy is the four-digit number for the year. The maximum allowable value for yyyy is 9799. ddd is the three-digit number for the day of the year, such as 2012/001. The slash is required.
• yyddd, where yy is the last two-digit number for the year and ddd is the three-digit number for the day of the year, such as 12001. When you use the yyddd format, DFSMSrmm determines the century by using a date window:
  • DFSMSrmm uses the current century if the difference between the current year and the specified year is not greater than 50.
  • DFSMSrmm uses the previous or next century if the difference between the current year and the specified year is greater than 50.

The default is the date you issue the ADDVOLUME subcommand.

ASTIME(assigned_time)

Specifies the time the volume was assigned to a user

For a master or user volume, ASTIME specifies the time when the volume was assigned to a user. For a scratch volume, ASTIME specifies the time when the volume returned to scratch status. ASTIME format is hhmmss where:

• hh is hours
• mm is minutes
• ss is seconds

For example, nine o'clock in the morning is 090000.

The default is the time when you issue the ADDVOLUME subcommand.

CAPACITY(medinf | nn-mb)

Use this operand to specify the volume capacity in megabytes (MB). DFSMSrmm normally sets the capacity of a volume based on the media type and the recording format, or you can manually set the capacity if the capacity cannot be determined using the media type and recording format. The MEDINF parmlib commands define the capacity of different combinations of media type and recording formats. There are built-in capacity values for IBM® media types.

Specify a value between 0 and 4294967295.

COMPACTION(*|NONE|IDRC|YES)

Specifies the compaction technique used to record data on tape volumes. Use one of these:

*

The compaction is not known; or the volume is not a tape volume, and compaction does not apply.

NONE

No compaction was used to record data on the volume.

IDRC

IDRC compaction which DFSMSrmm displays as a compaction value of YES was used.

YES

The data on the master or user tape volumes being added is compacted.

This operand is ignored if you use STATUS(SCRATCH). If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB.

The default is *.

CONTAINER(container_name)

Use this operand to define a volume as an exported logical volume. Specify the volser of the stacked volume as the container_name if you define an exported logical volume. The value can be any alphanumeric or special characters up to 6 characters in length.

When you specify a container_name, DFSMSrmm sets the default volume type for the volume as TYPE(LOGICAL). If the volume type is TYPE(PHYSICAL), you must change the volume type to TYPE(LOGICAL) before volume import processing can start.

There is no default.

COUNT(number_of_volumes)

Specifies the number of volumes to be added. The maximum allowable decimal value is 99999.

The default is 1.

CRDATE(create_date|current_date)

Specifies the date when the volume was created.

Supply the year and day in one of two forms. We recommend that you use the yyyy/ddd format rather than the yyddd format for dates.

• yyyy/ddd, where yyyy is the four-digit number for the year. The maximum allowable value for yyyy is 9799. ddd is the three-digit number for the day of the year, such as 2012/001. The slash is required. You can specify a date in the range between 0000/000 to 9799/365.
• yyddd, where yy is the last two-digit number for the year and ddd is the three-digit number for the day of the year, such as 12001. When you use the yyddd format, DFSMSrmm determines the century by using a date window:
  • DFSMSrmm uses the current century if the difference between the current year and the specified year is not greater than 50.
  • DFSMSrmm uses the previous or next century if the difference between the current year and the specified year is greater than 50.

You can specify a date in the range between 00000 to 99366.

The default is the date you issue the ADDVOLUME subcommand.

CRDATE can be abbreviated as DATE.

CRSYSID(RMM_sysID)

Specifies the ID of the system on which the volume was created. Specify a unique system name one-to-eight characters long.

The default value is the DFSMSrmm OPTION SYSID value.

CRSYSID can be abbreviated as SYSID.

CRTIME(create_time|current_date)

Specifies the time when the volume was created. The CRTIME format is hhmmss where:

• hh is hours
• mm is minutes
• ss is seconds

For example, nine o'clock in the morning is 090000.

You can specify a time in the range between 000000 to 235959.

The default is the time when you issue the ADDVOLUME subcommand.

CRTIME can be abbreviated as TIME.

CURRENTLABELVERSION(1|3|4)

Specifies the ISO/ANSI label version for the volume that you are adding.

There is no default.

DENSITY(*|1600|3480|6250)

Specifies the volume's recording density. For a 3420 tape reel, you can use DENSITY as 1600 or 6250. For a 3480 tape cartridge, use a value of 3480. Use an asterisk if you do not know the density.

There is no default.

DESCRIPTION(text)

Specifies descriptive text about the volume. Descriptive text is one to thirty characters enclosed in single quotation marks if it contains any special characters or blanks.

The default is blanks.

DSNAME(data_set_name)

Specifies the name of the first data set on the volume.

Note: DFSMSrmm does not fold data set names to uppercase letters when you specify quoted data set names. When you specify data set names or data set name masks, be sure to specify the correct case for each character. If you create VRS data set name masks with lowercase or mixed case letters, these will not match to data sets with all uppercase characters.

DFSMSrmm does not check quoted data set names for valid characters. Any string of up to 44 characters is accepted, except those that start with a blank or x'00'. Data set names without quotes must pass the following data set naming rules:

• A data set name can have one or more qualifiers.
• Each qualifier is one to eight characters. The first character alphabetic (A to Z) or national (# @ $). The remaining seven characters can be either alphabetic, numeric (0 - 9), national, or a hyphen (-).
• Qualifiers are separated by a period.
• DFSMSrmm adds your TSO PROFILE PREFIX value as the high-level qualifier.
• The data set name must not include a member name.

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

There is no default.

ERROR(READ(count),WRITE(count))

Use this operand to specify new error count values for read and write errors. These are assumed to be the permanent errors for the volume.

When you add a volume, the error counts are initially set to zero.

EXPDT(expiration_date)

Specifies the date the volume should be considered for release. The expiration date cannot exceed the maximum retention period MAXRETPD set by your installation in the DFSMSrmm EDGRMMxx parmlib member.

Supply the year and day in one of two forms. We recommend that you use the yyyy/ddd format rather than the yyddd format for dates.

• yyyy/ddd, where yyyy is the four-digit number for the year. The maximum allowable value for yyyy is 9799. ddd is the three-digit number for the day of the year, such as 2012/001. The slash is required.
• yyddd, where yy is the last two-digit number for the year and ddd is the three-digit number for the day of the year, such as 12001. When you use the yyddd format, DFSMSrmm determines the century by using a date window:
  • DFSMSrmm uses the current century if the difference between the current year and the specified year is not greater than 50.
  • DFSMSrmm uses the previous or next century if the difference between the current year and the specified year is greater than 50.

When you specify the expiration date for a volume that is a part of a multivolume set managed by the EXPDT retention method retained by SET, DFSMSrmm updates the expiration date and time for all the volumes of the multivolume set. If you try to specify the expiration date for a volume managed by the EXPDT retention method retained by FIRSTFILE, the command will be rejected. The expiration date of the volume will be set to the expiration date of the first data set record on a single volume or on a volume set

When you specify the expiration date for a data set record representing one part of a multivolume data set on volumes managed by the EXPDT retention method, DFSMSrmm updates the expiration date and time for all the data set records for the data set. When you do not specify an expiration date, DFSMSrmm copies the expiration from the preceding data set record in the multivolume data set chain.

To use the dates 99365 and 99366, which mean permanent retention, you must specify the MAXRETPD NOLIMIT operand in the DFSMSrmm EDGRMMxx parmlib member.

EXPDT is mutually exclusive with RETPD.

This operand is ignored if you use STATUS(SCRATCH). If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB.

If you do not specify EXPDT or RETPD, DFSMSrmm uses the default retention defined in the RETPD operand of the DFSMSrmm EDGRMM xx parmlib member.

FEATCD(feature_code)

Specifies the software product's feature code on the volume. A feature code is one-to-four alphanumeric characters. Use this operand when you associate a volume with a software product already defined to DFSMSrmm. This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

There is no default.

INITIALIZE(Y|N)

Specifies whether the volume initialized before it can be used. Specify Y to request initialization. Specify N to indicate that the volume does not need to be initialized. If you use INITIALIZE(Y), the volume is not available for use until initialization is confirmed. INITIALIZE(Y) is not supported for a stacked volume.

DFSMSrmm accepts INIT as an abbreviation.

If you request initialization for a scratch volume, and the initialize action is still pending when you enter the volume into an automated tape library, DFSMSrmm defers initialization to DFSMSdfp labeling support. If the volume is later ejected without being initialized, DFSMSrmm reinstates the initialize action.

The default is N.

JOBNAME(job_name)

Specifies the name of the job that created the first data set on the volume. A job name is one-to-eight characters other than blank, comma, and semicolon. You cannot use a generic jobname. Any jobname you use specific.

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

There is no default.

KEYENCODE1(H|L)

Specifies the encoding mechanism used for KEYLABEL1.

H

Public key hash

L

Label

When KEYLABEL1 is specified, the default value is L.

KEYENCODE2(H|L)

Specifies the encoding mechanism used for KEYLABEL2.

H

Public key hash

L

Label

When KEYLABEL2 is specified, the default value is L.

KEYLABEL1(keylabel1_name)

Specifies the key encryption key label number 1 for a non-scratch volume that is encrypted. A key label is 1-to-64 characters with blanks padding the field on the right. A key label contains alphanumeric, national, or special characters with some additional characters also allowed. Enclose it in single quotation marks if it contains any blanks or special characters.

When a volume is rewritten in a non-encryption format, DFSMSrmm does not clear the encryption key label related fields. Instead, the fields continue to be displayed until the volume is reused from scratch, or a release action causes them to be cleared.

When you specify this optional operand, you can also specify a value for the key encoding mechanism using the KEYENCODE1 operand.

KEYLABEL2(keylabel2_name)

Specifies the key encryption key label number 2 for a non-scratch volume that is encrypted. A key label is 1-to-64 characters with blanks padding the field on the right. A key label contains alphanumeric, national, or special characters with some additional characters also allowed. Enclose it in single quotation marks if it contains any blanks or special characters.

When a volume is rewritten in a non-encryption format, DFSMSrmm does not clear the encryption key label related fields. Instead, the fields continue to be displayed until the volume is reused from scratch, or a release action causes them to be cleared.

When you specify this optional operand, you can also specify a value for the key encoding mechanism using the KEYENCODE2 operand.

LABEL(SL|NL|AL)

Specifies the volume's label type, which can be:

SL

IBM standard labels

NL

No label

AL

ISO/ANSI labels

SL is the default.

Use the LISTVOLUME subcommand to obtain label information for a volume. DFSMSrmm automatically records label type when a data set on the volume is opened. See LISTVOLUME: Displaying information about a volume for more information.

LEVEL(version)

Specifies the version of the software product on the volume. Supply the version in the form, VnnRnnMnn, indicating the version, release, and modification level. 'nn' is two alphanumeric or national characters. Use this operand to associate a volume with a software product already defined to DFSMSrmm.

The default value is V01R01M00, Version 1, Release 1, Modification 0, when NUMBER is specified. This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

LOANLOC(loan_location)

Specifies the location where the volume resides other than in the removable media library or a storage location. A loan location is one to eight characters enclosed in single quotation marks if it contains any special characters or blanks. For example, if you remove the volume from the removable media library and are storing it in your office, you can use your owner ID as the LOANLOC value to let others know where the volume is.

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

There is no default.

LOCATION(SHELF|library_name|LOCDEF_location_name)

Specifies the location where the volume is stored and sets the home location for the volume. Use one of these values:

SHELF

Indicates that the volume is stored in a shelf location in a non-system-managed library.

library_name

Indicates the system-managed library in which the volume is stored. This library can be either a manual tape library, or an automated tape library such as the IBM TotalStorage Enterprise Automated Tape Library (3495). A library name is one-to-eight alphanumeric characters, $, #, or @, starting with a non-numeric character.

DFSMSrmm validates this library name by ensuring that the library has been defined in the TCDB. If the library is a manual tape library, DFSMSrmm adds the volume to the TCDB; if the library is an automated tape library and the volume is not currently resident in that library, DFSMSrmm sets the volume move in progress to get the volume moved to the automated tape library. DFSMSrmm does not add the volume to the TCDB since the system does this when the volume enters the automated tape library. You can specify a distributed library name only if the library is an IBM Virtualization Engine.

If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB.

LOCDEF_location_name

Indicates that the volume is stored in a storage location. When you store volumes in a storage location as their home location, you enable volumes to return to scratch in the named storage location. Storing volumes in this way allows you to avoid using the location SHELF.

When you use a shelf-managed storage location as a home location, DFSMSrmm sets the required location to the specified location. DFSMSrmm sets the current location to SHELF and enables the next inventory management DSTORE run to assign an available bin number.

The default is SHELF.

MEDIANAME(medianame)

Specifies the physical shape of a volume or the type of a volume. Specify a one-to-eight character name. To help you identify the media, you can use media names that describe size or shape. Using size or shape to describe the media rather than using a specific media name, gives you more flexibility in the media that can reside in a pool. Some examples of MEDIANAME that you might define include: CART, ROUND, SQUARE, 3420, 3480, TAPE, OPTICAL, and CASSETTE.

You can use any name for a MEDIANAME because DFSMSrmm does not check that the media name is a device type that has been defined to z/OS®. Use MEDIANAME to identify different types of physical shelf space for different media or to distinguish different media characteristics such as cartridge tape and enhanced capacity cartridge system tape.

The default MEDIANAME is the value you define with the EDGRMMxx parmlib OPTION MEDIANAME operand. For more information on how to set this value, see z/OS DFSMSrmm Implementation and Customization Guide

MEDIATYPE(* | CST | ECCST | EHPCT | HPCT | MEDIA5 | MEDIA6 | MEDIA7 | MEDIA8 | MEDIA9 | MEDIA10 | MEDIA11 | MEDIA12 | MEDIA13 | medinf_mediatype)

Specifies the volume's physical media type. Use one of these:

*

The volume is not a cartridge.

CST

Cartridge System Tape

ECCST

Enhanced Capacity Cartridge System Tape

EHPCT

Extended High Performance Cartridge Tape

HPCT

High Performance Cartridge Tape

MEDIA5/ETC

IBM Enterprise Tape Cartridge

MEDIA6/EWTC

IBM Enterprise WORM Tape Cartridge 3592

MEDIA7/EETC

IBM Enterprise Economy Tape Cartridge 3592

MEDIA8/EEWTC

IBM Enterprise Economy WORM Tape Cartridge 3592

MEDIA9/EXTC

IBM Enterprise Extended Tape Cartridge 3592

MEDIA10/EXWTC

IBM Enterprise Extended WORM Tape Cartridge 3592

MEDIA11/EATC

IBM Enterprise Advanced Tape Cartridge

MEDIA12/EAWTC

IBM Enterprise Advanced WORM Tape Cartridge

MEDIA13/EAETC

IBM Enterprise Advanced Economy Tape Cartridge

medinf_mediatype

Specify a non-IBM media type if your installation definition contains media information for medinf_mediatype that matches the media information assigned to the volume.

You must specify the MEDIATYPE operand when you are adding volumes that reside in a manual tape library.

If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB.

See Table 2 for information about how DFSMSrmm assigns MEDIATYPE and RECORDINGFORMAT.

The default value is *.

MEDINF(medinf_name)

Specifies the assigned installation-defined media information to the volume. This value is one-to-eight alphanumeric characters and defined once in your installation. You can use the LISTCONTROL subcommand with the MEDINF operand to display the media information. For more information about MEDINF, see z/OS DFSMSrmm Implementation and Customization Guide.

Default: IBM.

NOWORM

Use this operand to identify that the volume is not a WORM volume. You cannot specify this operand for a volume recorded automatically by DFSMSrmm during open processing.

Use the WORM operand to set the WORM attribute.

NOWORM is the default value.

NUMBER(product_number)

Specifies the number of the software product associated with the volume. A software product number is one to eight characters enclosed in single quotation marks if it contains any special characters or blanks. Use this operand when you associate a volume with a software product already defined to DFSMSrmm.

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

There is no default.

OPENCOUNT(count)

Use this operand to specify how many times any data set on the volume has been opened.

When you add a volume, the open count is initially set to zero.

The value range is 0 to 65535.

ORIGINALEXPDT(expiration_date)

Specifies the original JCL expiration date of the volume. It should be the highest original expiration date of all the files on the volume.

Supply the year and day in one of two forms. We recommend that you use the yyyy/ddd format rather than the yyddd format for dates.

• yyyy/ddd, where yyyy is the four-digit number for the year. The maximum allowable value for yyyy is 9799. ddd is the three-digit number for the day of the year, such as 2012/001. The slash is required.
• yyddd, where yy is the last two-digit number for the year and ddd is the three-digit number for the day of the year, such as 12001. When you use the yyddd format, DFSMSrmm determines the century by using a date window:
  • DFSMSrmm uses the current century if the difference between the current year and the specified year is not greater than 50.
  • DFSMSrmm uses the previous or next century if the difference between the current year and the specified year is greater than 50.

There is no default.

ORIGINALEXPDT can be abbreviated as OEXPDT.

OWNER(owner)

Specifies the owner ID of the volume's owner. An owner ID is one-to-eight alphanumeric characters, $, #, or @; normally a RACF® user ID or RACF group name.

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

The default is the user ID of the command issuer.

OWNERACCESS(ALTER|READ|UPDATE)

Specifies the type of access the owner has to the volume.

When the RACF TAPEVOL class is active, and TPRACF(P) or TPRACF(A) is in effect, DFSMSrmm uses the OWNERACCESS information to build the RACF TAPEVOL access list. OWNERACCESS can be used together with OWNER to define the initial RACF TAPEVOL volume profile access, specifying the type of access the volume owner has to a volume.

The OWNERACCESS value can be one of these:

ALTER

The volume owner is allowed to read from the tape volume, to write add and delete data sets to the volume, and to create or destroy tape volume labels through OPEN or end-of-volume operations. For discrete tape volume profiles, the volume owner is allowed to change the profile, including the access list.

ALTER is the default value.

READ

The volume owner has only read access.

UPDATE

The volume owner is allowed to read from the tape volume, and to write additional data sets to the volume.

This operand is ignored for scratch volumes.

For more information, refer to the topic Maintaining the User Access List in z/OS DFSMSrmm Implementation and Customization Guide.

PERCENT(0 | percent)

Use this operand to specify how full the volume is. You can specify a value between 0 and 100.

When you add a volume, the percent full is initially set to zero.

POOL(pool_prefix)

Specifies a pool prefix where DFSMSrmm stores the volume in the removable media library. The value is one-to-five alphanumeric, national, or special characters followed by an asterisk. Enclose it in quotation marks if it contains any special characters.

Pool prefixes are defined by your installation. You can view information about your pools by using the LISTCONTROL subcommand with the VLPOOL operand. See LISTCONTROL: Displaying parmlib options and control information for more information.

If you do not supply either a pool prefix or a rack number, DFSMSrmm assigns the volume a rack number as described in Table 1. Do not use a pool prefix if you are adding the volume to an automated tape library, because the external volume serial number must match the internal volume serial number in an automated tape library. You cannot specify POOL when TYPE(LOGICAL) is specified. POOL cannot be used with RACK.

PREVVOL(previous_volser)

Specifies the volume serial number of the previous volume for a multivolume data set. A previous volume serial number is one-to-six alphanumeric, national, or special characters. Enclose it in single quotation marks if it contains any special characters.

Restriction: You must add the volumes in a multivolume data set in their correct sequence. You must add the first volume of a multivolume data set before you can add the rest of the volumes in their correct sequence.

PREVVOL is mutually exclusive with RETENTIONMETHOD and RETAINBY.

There is no default.

RACK(rack_number)

Specifies a shelf location in the removable media library where DFSMSrmm stores the volume. A rack number is one-to-six alphanumeric, national, or special characters. Enclose it in single quotation marks if it contains any special characters. The rack number that you use previously defined and empty.

If you do not supply a pool prefix or a rack number, DFSMSrmm assigns the volume a rack number as described in Table 1. RACK cannot be used with POOL. RACK cannot be specified when TYPE(LOGICAL) is specified.

READDATE(last_read_date)

Specifies when the volume was last read.

Supply the year and day in one of two forms. We recommend that you use the yyyy/ddd format rather than the yyddd format for dates.

• yyyy/ddd, where yyyy is the four-digit number for the year. The maximum allowable value for yyyy is 9799. ddd is the three-digit number for the day of the year, such as 2012/001. The slash is required.
• yyddd, where yy is the last two-digit number for the year and ddd is the three-digit number for the day of the year, such as 12001. When you use the yyddd format, DFSMSrmm determines the century by using a date window:
  • DFSMSrmm uses the current century if the difference between the current year and the specified year is not greater than 50.
  • DFSMSrmm uses the previous or next century if the difference between the current year and the specified year is greater than 50.

There is no default.

This operand is ignored if you use STATUS(SCRATCH). If you use STATUS(VOLCAT), DFSMSrmm overrides the value you specify with information from the TCDB.

RECORDINGFORMAT(* | 18TRACK | 36TRACK | 128TRACK | 256TRACK | 384TRACK | EFMT1 | EFMT2 | EEFMT2 | EFMT3 | EEFMT3 | EFMT4 | EEFMT4 | medinf_recordingformat)

Specifies the basic recording format for tape volumes.

*

An asterisk indicates that the format is unknown or that the volume is not a tape volume.

18TRACK

Data has been written to the volume in 18-track format. A recording format of 18TRACK is valid with MEDIATYPE(CST) and MEDIATYPE(ECCST) only.

36TRACK

Data has been written to the volume in 36-track format. A recording format of 36TRACK is valid with MEDIATYPE(CST) and MEDIATYPE(ECCST) only.

128TRACK

Data has been written to the volume in 128-track format. A recording format of 128TRACK is valid with MEDIATYPE(EHPCT) and MEDIATYPE(HPCT) only.

256TRACK

Data has been written to the volume in 256-track format. A recording format of 256TRACK is valid with MEDIATYPE(EHPCT) and MEDIATYPE(HPCT) only.

384TRACK

Data has been written to the volume in 384-track format. A recording format of 384TRACK is valid with MEDIATYPE(EHPCT) and MEDIATYPE(HPCT) only.

EFMT1

Data has been written to the volume in Enterprise Format 1 recording technology. You can only specify EFMT1 with MEDIATYPE(MEDIA5), MEDIATYPE(MEDIA6), MEDIATYPE(MEDIA7), and MEDIATYPE(MEDIA8).

EFMT2

Data has been written to the volume in Enterprise Format 2 recording technology. You can only specify EFMT2 with MEDIATYPE(MEDIA5), MEDIATYPE(MEDIA6), MEDIATYPE(MEDIA7), MEDIATYPE(MEDIA8), MEDIATYPE(MEDIA9) and MEDIATYPE(MEDIA10).

EEFMT2

Data has been written to the volume in Enterprise Encrypted Format 2 recording technology. You can only specify EEFMT2 with MEDIATYPE(MEDIA5), MEDIATYPE(MEDIA6), MEDIATYPE(MEDIA7), MEDIATYPE(MEDIA8), MEDIATYPE(MEDIA9) and MEDIATYPE(MEDIA10).

EFMT3

Data has been written to the volume in EFMT3 (enterprise format 3) recording format. A recording format of EFMT3 is valid with MEDIATYPE(MEDIA5, MEDIA6, MEDIA7, MEDIA8, MEDIA9, and MEDIA10) only.

EEFMT3

Data has been written to the volume in EEFMT3 (enterprise encrypted format 3) recording format. A recording format of EEFMT3 is valid with MEDIATYPE(MEDIA5, MEDIA6, MEDIA7, MEDIA8, MEDIA9, and MEDIA10) only.

EFMT4

Data has been written to the volume in EFMT4 (enterprise format 4) recording format. A recording format of EFMT4 is valid with MEDIATYPE(MEDIA9, MEDIA10, MEDIA11, MEDIA12, and MEDIA13) only.

EEFMT4

Data has been written to the volume in EEFMT4 (enterprise encrypted format 4) recording format. A recording format of EEFMT4 is valid with MEDIATYPE(MEDIA9, MEDIA10, MEDIA11, MEDIA12, and MEDIA13) only.

medinf_recordingformat

Specify a non-IBM media recording format if your installation definition contains media information for medinf_recordingformat that matches the media information assigned to the volume.

Recommendation: Specify the known recording format for system-managed, non-scratch volumes. If you use an incorrect value, the volume can be mounted on a tape drive that can neither read nor write to the volume. If you do not specify a value, DFSMSrmm sets a default value that is valid for the media type you specify.

If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB. For scratch volumes, DFSMSrmm lets the system set this value when the volume is first used.

See Table 2 for information about how DFSMSrmm assigns MEDIATYPE and RECORDINGFORMAT.

The default value is *.

RELEASEACTION(SCRATCH,REPLACE,RETURN,INIT,ERASE,NOTIFY)

Specifies the action to be taken when the volume is eligible for release. RELEASEACTION can be given as a list of keywords separated by commas. The first operand describes what should happen to the volume when it is released and can be one of these:

SCRATCH

To indicate that the volume should be returned to scratch status. SCRATCH is mutually exclusive with RETURN.

REPLACE

To indicate that the volume should be replaced with a new volume and returned to scratch status.

RETURN

To indicate that the volume should be returned to its owner. RETURN is mutually exclusive with SCRATCH.

The default is SCRATCH.

After the first operand, you can specify actions to be performed for the released volume. You can use one or more of these operands, separated from the first operand and from each other by commas.

INIT

To request that DFSMSrmm initialize the volume.

ERASE

To request that DFSMSrmm erase the volume.

NOTIFY

To request that DFSMSrmm notify the owner that the volume is being released.

For example, you can request that DFSMSrmm notify you when it is releasing your volume, and that the volume be initialized and returned to scratch by using these operands:

    RELEASEACTION(SCRATCH,INIT,NOTIFY)

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

REQUIREDLABELVERSION(0|3|4)

Specifies the ISO/ANSI label version to be used in the VOL1 label for the volume when creating or rewriting the volume labels on an AL type volume. Specify 0 when you have no required label version.

The default is 0.

RETAINBY( FIRSTFILE | SET | VOLUME)

Specifies how DFSMSrmm is to retain an EXPDT-retained volume or multivolume set:

FIRSTFILE

The expiration date of the first file is used to set the expiration date of a single volume or a multivolume set. All volumes in a multivolume set will have exactly the same expiration date and will be released to scratch in the same run of DFSMSrmm inventory management.

Additional data sets added later to a volume or to a multivolume set can have different expiration dates that are independent of the volume expiration date.

SET

DFSMSrmm uses the highest expiration date of all volumes in the set and each file on a volume set can increment it. All volumes in the set will have exactly the same expiration date and will be released to scratch on the same run of DFSMSrmm inventory management.

VOLUME

The expiration date of the volume is considered for each volume separately and each file on a volume can increment the volume expiration date.

Specify this operand for the first volume in a multivolume sequence. All other volumes added to the set will assume the same RETAINBY value.

Note:

1. The RETAINBY operand cannot be specified for a volume managed by the VRSEL retention method. Use the RETAINBY operand only for volume sets that use the EXPDT retention method.
2. When a RETAINBY value is defined for a non-scratch volume, it is not overridden to the default during OPEN output processing, but can be changed using CHANGEVOLUME subcommand.
3. The RETAINBY operand cannot be specified if the PREVVOL operand is specified.
4. The RETAINBY operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

Default: If RETAINBY is omitted, the RETENTIONMETHOD(EXPDT(RETAINBY(value)) specified in parmlib is used.

RETENTIONMETHOD(EXPDT | VRSEL)

Use this operand to set the retention method for a tape volume set. Specify this operand for the first volume in a multivolume sequence. All other volumes added to the set assume the same retention method.

Once a retention method is defined for a non-scratch volume, it is not overridden to the system-wide default during OPEN output processing, but can be changed by installation exit EDG_EXIT100. Volumes in a set always assume the retention method of the first volume in the set.

Specify EXPDT to set the retention method for a tape volume set to be based on EXPDT. Data sets and volumes managed by this retention method are never processed by VRSEL inventory management. If the retention method is changed from VRSEL to EXPDT, then the RETAINBY field is set from the AV command, if specified, or from the parmlib. The expiration date of the volume or multivolume set is updated according to the RETAINBY value.

Specify VRSEL to set the retention method for a tape volume set to be VRSEL. This option enables DFSMSrmm inventory management to attempt to match data sets and volumes to vital record specifications, and if a match is found, to determine if the data set or volumes are to retained by VRS.

See Retention methods for considerations for selecting a retention method.

RETENTIONMETHOD is mutually exclusive with PREVVOL. RETENTIONMETHOD is ignored if used with STATUS(SCRATCH) or STATUS(VOLCAT).

RETENTIONMETHOD can be abbreviated as RM.

Default: If RETENTIONMETHOD is omitted, the retention method specified in parmlib is used.

RETPD(retention_period)

Specifies the number of days that DFSMSrmm retains the volume before considering it for release. retention_period is a decimal number from 0 to 93000. The retention period is added to today's date to create the expiration date. The expiration date cannot exceed the maximum retention period (multivolume) set by your installation in the DFSMSrmm EDGRMMxx parmlib member.

When you specify the retention period for a volume that is a part of a multivolume set managed by the EXPDT retention method and retained by SET, DFSMSrmm updates the expiration date for all the volumes of the multivolume set.

When you specify the retention period for a volume managed by the EXPDT retention method and retained by FIRSTFILE, the specified retention period will be ignored. The retention period of the volume will be set to the retention period of the first data set record on a single volume or on a volume set.

When you do not specify a retention period, DFSMSrmm copies the retention period from the preceding data set record in the multivolume data set chain.

RETPD is mutually exclusive with EXPDT.

If you do not specify RETPD or EXPDT, DFSMSrmm uses the default retention period from the parmlib member EDGRMMxx.

SECLEVEL(security_class)

Specifies the volume's security class. This value is one to eight characters, and one defined for your installation.

You can use the LISTCONTROL subcommand with the SECCLS operand to display the security classes defined for your location. See LISTCONTROL: Displaying parmlib options and control information for more information.

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

There is no default.

SPECIALATTRIBUTES(NONE|RDCOMPAT)

Specifies any special attributes associated with the tape volume.

NONE

The tape volume has no special attributes.

RDCOMPAT

The tape volume was created using one format and can be mounted on a drive that supports reading but not writing of that format.

For example, a volume recorded at 18TRACK can be read by a device that writes at 36TRACK and also has the ability to read 18TRACK tape volumes.

If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB.

STATUS

STATUS(SCRATCH|MASTER|USER|VOLCAT) specifies the volume's status. Use one of these:

SCRATCH

Indicates that the volume is free and available for use.

MASTER

Indicates that this is a private volume which cannot be overwritten unless the data set names match.

USER

Indicates that this is a private volume which can be overwritten by any data set.

VOLCAT

Specifies that DFSMSrmm obtain the volume's status from the TCDB. If the TCDB contains no record for a volume, DFSMSrmm sets the volume's status to scratch. If you use any ADDVOLUME operands that do not apply to the volume's status as defined in the TCDB, DFSMSrmm overrides those operands with values in the TCDB. DFSMSrmm uses any ADDVOLUME operands that you give that apply to the volume's status to supplement information from the TCDB. If you do not use STATUS(VOLCAT), the values you provide using the ADDVOLUME subcommand are used to override values in the TCDB, except for STATUS and STORGRP values which can never be used to override values in the TCDB.

There is no default.

STORAGEGROUP

STORAGEGROUP(storage_group_name) specifies the SMS-defined storage group to which the volume belongs. A storage group name is one-to-eight characters other than blank, comma, and semicolon. A storage group name can be a value that matches to a VLPOOL NAME value but does not need to be defined on a VLPOOL definition. STORAGEGROUP may be abbreviated as STORGRP.

For volumes in a system-managed library, DFSMSrmm uses the current location or the location specified on the command to validate the specified storage group. For volumes with a system-managed home location defined, DFSMSrmm uses the home location for validation. For other volumes, any value you specify is accepted as long as the value is valid in the current SMS configuration.

You can set the storage group even if the TCDB already contains a storage group name.

A storage group name can be assigned to any volume, even a scratch volume. The storage group name can be used for scratch pooling, except when the volume is in a system-managed automated tape library. For system-managed scratch volumes, the storage group name is not maintained in the TCDB because it is not supported by SMS tape processing.

For system-managed manual tape library volumes, the storage group name is used for scratch pool validation only when you request that a specific storage group name is used for pooling. For all non-system managed scratch pooling validation, the storage group name is significant and is always used to ensure that a volume from the correct pool is mounted.

When you do not specify a storage group name, DFSMSrmm assigns a storage group name by using the matching EDGRMMxx VLPOOL NAME value. If the VLPOOL NAME value is a valid storage group name, DFSMSrmm uses the VLPOOL NAME value as the default value for volumes added to the pool.

If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB. It is ignored if the volume is already defined in a TCDB with a different storage group name.

TYPE(LOGICAL|PHYSICAL|STACKED)

Specifies the volume type. When you do not specify a volume type, DFSMSrmm sets the volume type based on the location where the volume resides. DFSMSrmm sets the default volume type to TYPE(PHYSICAL) for volumes that do not reside in a VTS. DFSMSrmm sets the default volume type for volumes that reside in a VTS as TYPE(STACKED) when the volume is known to the VTS as a stacked volume. DFSMSrmm sets the default volume type to TYPE(LOGICAL) for any volumes in a VTS that are not stacked volumes.

TYPE(PHYSICAL) can be used for volumes that do not reside in a VTS. Non system- managed virtual tape libraries can use either TYPE(PHYSICAL) or TYPE(LOGICAL). However, TYPE(LOGICAL) and TYPE(STACKED) cannot be specified for volumes in a system-managed tape library that is not a VTS. which includes a non-IBM VTS that is being managed as a manual tape library.

When you specify TYPE(STACKED) or DFSMSrmm sets the default to stacked, DFSMSrmm forces the volume status to master status. DFSMSrmm also sets these values for stacked volumes.

• Assign date and time each time a stacked volume becomes empty and each time the first volume is added into it as a container.
• Last read date each time a volume is imported or removed from the stacked volume.
• Last write date each time a volume is exported or added to the stacked volume.
• Security level each time the stacked volume has the first volume added. Security level is set to the added volume's security level. Each time a volume is added to a stacked volume, DFSMSrmm sets the stacked volume's security level to the maximum of the existing and new volume security level.
• Use count each time the stacked volume has the first volume added. Use count is reset each time a new export is started and incremented each time a volume is added to the stacked volume.
• Usage, which is the sum of all the volumes added to the stacked volume. Usage is reset each time a new export is started and incremented each time a volume is added to the stacked volume.

TZ({+|-}HH[:MM[:SS]])

Specifies the time zone offset when date and time values are specified. The format is {+|-}HH[:MM[:SS]] where:

• +|- is the offset direction. Specify + to indicate that the offset is East of the zero median (UT). Specify - to indicate that the offset is West of the zero median (UT). The offset direction is required.
• HH is hours
• MM is minutes
• SS is seconds

An optional colon (:) separates hours from optional minutes and optional seconds.

You can specify a time in the range between 00:00:00 to 15:00:00 for HH:MM:SS. MM and SS value range is 00 to 59.

USE(IRMM,MVS,VM)

Specifies the operating systems where the volume can be used. You can select one or more of IRMM, MVS™, and VM. To indicate multiple operating systems are valid, enter the values with a comma as a separator. The default is MVS.

USERS(user_ID,user_ID...)

Specifies the user IDs and group names of users that are allowed to access the volume. The type of access they have is defined by the ACCESS operand. You can supply a maximum of twelve user IDs, separated by blanks or commas.

This operand is ignored if you use STATUS(SCRATCH) or STATUS(VOLCAT).

There is no default.

VENDOR(vendor_name)

Specifies the manufacturer or supplier of the volume. The vendor value is 1 to 8 alphanumeric or special characters that you can set or change at any time. Vendor information enclosed in single quotation marks if it contains any special characters or blanks. DFSMSrmm never changes or uses this value. You can use it for reporting purposes and tracking supplier information for batches of volumes.

There is no default.

volser

Specifies the volume serial number. A volume serial number is one-to-six alphanumeric, national, or special characters. Enclose it in single quotation marks if it contains any special characters. When you add volumes into a system-managed library, you can only specify volume serial numbers consisting of alphanumeric characters. You cannot use a generic volume serial number.

volser is required and must follow the ADDVOLUME subcommand.

VOL1(volser)

Specifies a standard label volume serial number. Use this operand to define a duplicate volume when the VOL1 label volume serial number does not match the volume you are defining to DFSMSrmm. The variable volser is one-to-six alphanumeric, national, or special characters.

There is no default.

WMC(count)

Use this operand to set the write mount count for any volume. The write mount count reflects how many times the volume has been mounted for output and actually written to while mounted.

When you add a volume, the write mount count is initially set to zero.

For WORM volumes mounted and processed under DFSMSrmm control on z/OS, the WMC value is obtained from the tape drive and can then no longer be changed by commands.

The value range is 0 to 65535.

WORLDWIDEID(world_wide_identifier)

Use this operand to specify the unique world wide identifier set on the volume by the manufacturer. The world wide ID is 12 characters in hexadecimal. You can specify the value as 12 characters, a hex string of 24 characters (x'...'), or as a binary string (b'....'). When entered in hex, you specify 24 characters 0-9, A-F. An example of a world wide identifier is WWID(x’12345678ABCDEF090000FFEE’). When you specify a character string, it can be any string of 12 alphanumeric, national, special, or EBCDIC text characters, enclosed in quotes when special or EBCDIC text characters are specified. DFSMSrmm converts your character string to hex.

WORLDWIDEID can be abbreviated as WWID.

The WWID is maintained and displayed as a hexadecimal value and is displayed using 24 characters.

In some publications, the world-wide unique cartridge identifier (WWCID) may also be referred to as the world-wide identifier (WORLDWIDEID or WWID).

There is no default.

Do not use the DFSMSrmm subcommands to set or change the WWID value. Instead, add volumes as you normally would do, and DFSMSrmm records the value when the volume is first used. Subsequent use of the volume causes DFSMSrmm to ensure that the recorded WWID and the WWID obtained from the mounted volume both match. If the values do not match, the volume is rejected. Once the WWID is set by command or recorded by DFSMSrmm when the volume was used while mounted, you cannot change the value in the DFSMSrmm control data set. If the WWID is incorrect in DFSMSrmm, your choice is to either delete and then re-add the volume, or to use RMM REPLACE processing. If DFSMSrmm already has data set details for the volume, keep a record of these so they can be added back by using the DFSMSrmm subcommands.

WORM

Use this operand to identify that the volume is a WORM volume. When you set the WORM attribute and the volume is OPENed for input or output on z/OS, DFSMSrmm volume validation checks that the write mount count and worldwide unique volume ID values recorded in DFSMSrmm match those obtained from the cartridge and maintained by the drive.

You cannot specify this operand for a WORM volume recorded automatically by DFSMSrmm during open processing.

NOWORM is the default value.

WRITEDATE(last_write_date)

Specifies when the volume was last written to.

Supply the year and day in one of two forms. We recommend that you use the yyyy/ddd format rather than the yyddd format for dates.

• yyyy/ddd, where yyyy is the four-digit number for the year. The maximum allowable value for yyyy is 9799. ddd is the three-digit number for the day of the year, such as 2007/001. The slash is required.
• yyddd, where yy is the last two-digit number for the year and ddd is the three-digit number for the day of the year, such as 12001. When you use the yyddd format, DFSMSrmm determines the century by using a date window:
  • DFSMSrmm uses the current century if the difference between the current year and the specified year is not greater than 50.
  • DFSMSrmm uses the previous or next century if the difference between the current year and the specified year is greater than 50.

There is no default.

This operand is ignored if you use STATUS(SCRATCH). If you use STATUS(VOLCAT), the value you specify is overridden by information in the TCDB.

Return codes

See DFSMSrmm return codes and reason codes for DFSMSrmm reason codes.

0

Subcommand completed normally.

4

Warning. Subcommand completed but some operands could have been ignored or modified. DFSMSrmm sets a reason code.

8

User not authorized.

12

Subcommand ended with an error. DFSMSrmm sets a reason code.

16

Error. The DFSMSrmm subsystem is not active.

20

Error. The data is incomplete or incorrect and the TSO user has set NOPROMPT.

24

The TSO subcommand is not APF authorized.

28

The user pressed the attention key.