Purpose

Related Reading: See z/OS DFSMSrmm Implementation and Customization Guide for information about using the DFSMSrmm parmlib OPTION COMMANDAUTH command and authorizing the use of the DFSMSrmm subcommands.

Use the SEARCHVOLUME subcommand to create a list of volumes matching the search criteria you specify. For example, you can display lists of volumes based on ownership, assigned date, status, movement, action, pool, media name, and many others.

Use the ACTION operand to list those volumes with actions pending before they are released and returned to the scratch pool or an owner. You can specify the STATUS operand to tailor the list based on volume type.

Use the LIMIT operand to restrict how many volumes DFSMSrmm lists. DFSMSrmm searches until it reaches the limit you specify or until it lists all volumes matching your search criteria. DFSMSrmm lists a maximum of ten volumes if you do not specify a limit.

Use the TYPE(LOGICAL) and CLIST operands to create an output file that can help you to prepare an import list.

Parameters

ABEND(YES | NO)

Specifies to limit the search to volumes containing a data set that was closed as a result of ABEND processing.

ACTION

Specifies one or more actions DFSMSrmm uses as a search criteria. DFSMSrmm lists only volumes with the indicated pending release action. Use the ACTION(pending_actions) operand to search for volumes that have the specified release action set. Volumes are returned if any of the values you specify are set in the volume.

Specify one or more of the following values for pending_actions, separated by commas:

ALL

To list all volumes with any pending action.

ERASE

To list only volumes that require erasing.

INIT

To list only volumes that require initialization.

NOTIFY

To list only volumes for which owners notified.

REPLACE

To list only volumes that replaced by new volumes and returned to the scratch pool.

RETURN

To list only volumes that should be returned to their owner.

SCRATCH

To list all volumes to be returned to scratch status.

NOERASE

Used in combination with ALL or other operands to exclude volumes that require erasing.

NOINIT

Used in combination with ALL or other operands to exclude volumes that require initialization.

NONOTIFY

Used in combination with ALL or other operands to exclude volumes for which owners notified.

NOREPLACE

Used in combination with ALL or other operands to exclude volumes that replaced by new volumes and returned to the scratch pool.

NORETURN

Used in combination with ALL or other operands to exclude volumes that should be returned to their owner.

NOSCRATCH

Used in combination with ALL or other operands to exclude volumes to be returned to scratch status.

ONLY

Used in combination with other operands to limit the list to a specific combination. For example, ACTION(RETURN,NOTIFY,ONLY) will list only those volumes for which both the RETURN and NOTIFY pending release action apply. If ONLY were omitted, then DFSMSrmm would list all the volumes for which either pending release action applied.

When you specify ONLY with no other operand value, DFSMSrmm selects volumes that have no pending release action set. This is the same as specifying NOERASE, NOINIT, NONOTIFY, NOREPLACE, NORETURN, NOSCRATCH.

ADD

Specify this operand to request that new records written to the CLIST data set are added after any existing records in the data set. When the CLIST data set is empty or DFSMSrmm creates the CLIST data set during command execution, specifying ADD is the same as specifying START.

ADD is mutually exclusive with START.

You can easily build a set of commands from CLIST processing using multiple SEARCH subcommands of the same or different resource types. For variable length records, the minimum record length can cause the LRECL to be increased. For fixed length records, if the minimum length cannot be accommodated, the subcommand fails.

ASDATE

Lists the volumes whose assigned date matches the specified date criteria. ASDATE is mutually exclusive with the SINCE operand. ASDATE may be specified as any of the following:

ASDATE

Only volumes whose assigned date is the current date are listed

ASDATE(START(start_date))

Only volumes whose assigned date is on or after the specified start date are listed, where start_date is either an absolute date or relative date.

ASDATE(END(end_date))

Only volumes whose assigned date is on or before the specified end date are listed, where end_date is either an absolute date or relative date. Note that because START defaults to the current date, the specified end date equal to or greater than the current date when START is omitted.

ASDATE(START(start_date)END(end_date))

Only volumes whose assigned date is within the range delimited by the specified start and end dates are listed, where both start_date and end_date are either an absolute date or relative date. The specified end date equal to or greater than the specified start date.

Each of the start_date and end_date values can be absolute or relative dates.

Absolute dates are specified as either yyyy/ddd or yyddd format. For example, January 3, 2011 may be specified as 2011/003 or 11003.

Relative Dates are specified as a number of days, months, or years prior to the current date.

-0

specifies the current day, current month, current year.

-n

specifies that the date is n days before the current date

-nM

specifies that the date is n months before the current month and the current day in the month is as the current date.

-nY

specifies that the date is n years before the current year and the current day in the year is as the current date.

The value range for n is 0 to 99999, with a required leading ‘-‘ and an optional suffix of M or Y.

Examples: To list volumes whose assigned date is:

Today

specify: SV ASDATE

Three days ago

specify: SV ASDATE(START(-3) END(-3))

Before January 1, 2000

specify: SV ASDATE(START(0000/001) END(1999/365))

On or after January 2, 2005

Specify: SV ASDATE(START(2005/002))

AUTOMOVE

Specifies a list of volumes that have a move mode of AUTOMOVE which indicates that DFSMSrmm automatic movement processing is in effect.

BYSET(YES | NO)

Specifies a list of volumes based on the setting of the "set retained" attribute in the record, which is set when a volume is retained only because it is part of a multivolume set and one or more other volumes in the set are retained. Refer to the RETAINBY parmlib option. Specify BYSET(YES) to list volumes that have the "set retained" attribute set. Specify BYSET(NO) to list volumes that do not have the "set retained" attribute set.

CHAIN

Specifies all volumes in the same multivolume data set. You must specify a specific volume serial number for any volume in the data set. DFSMSrmm retrieves the volume information from the control data set. DFSMSrmm uses the previous and next volume chain to return all volumes in the data set in volume sequence order, starting from the first volume in the data set.

When you use the CHAIN operand, DFSMSrmm ignores all other operands you specify except for the ADD, CLIST, LIST, NOLIST, START operands.

This operand is optional and has no default.

CLIST(prefix_string,suffix_string)

Specifies a CLIST to create a data set of executable commands or to prepare an import list. You can edit the data set to remove any volumes you do not want in the list. Then you can run the CLIST at your convenience.

DFSMSrmm returns the volume serial number for each record if you do not specify (prefix_string and suffix_string). When the volume serial number contains special characters the value is returned within quotation marks.

You can add RMM TSO subcommands and operands to the records in the CLIST data set by specifying (prefix_string and suffix_string). These text strings cannot exceed 255 characters. Separate the prefix_string and suffix_string using a blank or a comma between the text strings. Insert blanks in the prefix and suffix values to prevent DFSMSrmm from concatenating the strings with the data that DFSMSrmm returns. To enter a null prefix_string, add a pair of separator characters such as '' to the text string (for example, CLIST('','suffix_string')).

When you specify the TYPE(LOGICAL) operand and CLIST, DFSMSrmm returns more information in the output file if obtained logical volume resides on a stacked volume. In such a case, DFSMSrmm returns the first six characters of the container name, the logical volume serial number, and the status value. The status value can be:

• SCRATCH if the volume is in scratch status or ready to return to scratch with the SCRATCHIMMEDIATE release option set.
• INITIALIZE if the volume is in scratch status and contains no valid data.
• Blank if status is not available.

See Creating CLISTs of executable subcommands for information about the data set used for the CLIST output.

COMPACTION(* | NONE | IDRC | YES)

Specifies the compaction technique used to record data on tape volumes. DFSMSrmm limits the list it returns to those volumes that match the specified value. Use one of these:

*

The compaction is unknown or the volume is not a tape volume, and compaction does not apply. This is the default.

NONE

No compaction was used to record data on the volume.

IDRC

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

YES

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

CONTAINER(* |container_name)

Specifies to search for all volumes that are assigned to a container. Use * to select all volumes in any container or use a container name to select the volumes that are assigned to a specific container. If you do not specify the CONTAINER operand, DFSMSrmm selects all volumes that reside in and out of containers. CONTAINER can be any volume that is defined to DFSMSrmm. The value can be any alphanumeric or special characters up to 6 characters in length.

CONTINUE(VOLUME(volser))

Specify the CONTINUE operand without any value to notify DFSMSrmm SEARCH subcommand processing that you want to break down the search results based on the LIMIT value and request that DFSMSrmm return the search continue information for use with the next command. For TSO, the continue information is returned either as a REXX variable or as a line mode message. When the subcommand is issued from the DFSMSrmm API, the continuation information may be either a line mode message or an SFI or XML attribute.

CONTINUE is an optional operand.

Use the LIMIT operand to control the maximum number of entries to be returned each time you start or continue the search.

To continue a previous search subcommand, the CONTINUE operand value includes this value to identify the current search position:

VOLUME(volser)

volser is one to six characters enclosed in single quotation marks if it contains any special characters, or blank.

The information required to continue a search subcommand is returned by each search subcommand that specifies the CONTINUE operand and passed back to DFSMSrmm unchanged in order to continue the previous search. You should specify the exact same subcommand unchanged. To do this, just change the CONTINUE operand value on each additional command required.

CRDATE(date_range)

Lists the volumes whose volume creation date matches the specified date criteria. The date criteria can be specified using the START and END suboperands. See the description of the SEARCHVOLUME ASDATE operand for a description of how to use the START and END suboperands and examples of their use.

CRSYSID(system_ID)

Specifies to list volumes that were created on the named system_ID. Specify a system name that is one-to-eight characters long.

CRSYSID can be abbreviated as SYSID.

CURRENTLABELVERSION(1 | 3 | 4)

Limits the output to those volumes that have the requested current label version.

There is no default.

DENSITY(* | 1600 | 3480 | 6250)

Specifies to list volumes with a specific recording density. For a 3420 tape reel, you can specify DENSITY as 1600 or 6250. For a 3480 tape cartridge, specify a value of 3480. Specify an asterisk if you do not want to use density as a search criteria.

DESTINATION(* | SHELF | LOCAL | DISTANT | REMOTE | library_name | LOCDEF_location_name)

Specifies a list of volumes moving to a specific destination. If you specify DESTINATION(*), and you do not specify the LOCATION operand, DFSMSrmm lists all volumes that currently require moving.

Use these values to identify the volume moves you want DFSMSrmm to list:

DISTANT

To list volumes moving to the DISTANT storage location

LOCAL

To list volumes moving to the LOCAL storage location

REMOTE

To list volumes moving to the REMOTE storage location.

LOCDEF_location_name

To list volumes moving to a storage location that was defined using the LOCDEF command.

You can enter any value as no checking is done against the current list of locations defined to DFSMSrmm.

library_name

To list volumes moving to a shelf location in a system-managed library

Library names one-to-eight alphanumeric characters, $, #, or @, starting with a non-numeric character.

SHELF

To list volumes moving to shelf locations in a non-system-managed library

DSNCRSYSID(system_ID)

Specifies to list volumes where the first file was created on the named system ID.

END(end_point)

Specify END as an alternative to the LIMIT operand to enable you to specify both the starting and ending point of the volume search. You do not need to know how many volumes are to be returned. The starting point is the volume serial number you provide and can be a specific volume serial number or a generic volume serial number. VOLUME(*) starts from the first volume. VOLUME(ABC*) starts with volume ABC or the next volume in collating sequence. END(end_point) identifies the last entry that DFSMSrmm returns. If the entry does not exist, DFSMSrmm does not return any entry with a volume serial number higher in collating sequence.

END is mutually exclusive with LIMIT.

DSNCRSYSID can be abbreviated as DSNSYSID.

EXPDT(date_range)

Lists the volumes whose retention expiration date matches the specified date criteria. The date criteria can be specified using the START and END suboperands. See the description of the SEARCHVOLUME ASDATE operand for a description of how to use the START and END suboperands and examples of their use.

FORCE(YES | NO)

Specifies a list of volumes based on the setting of the "force" attribute in the record, which is set when the CHANGEVOLUME subcommand has been used with the FORCE operand and the requested change was made only because FORCE was specified.. Specify FORCE(YES) to list volumes that have the "force" attribute set. Specify FORCE(NO) to list volumes that do not have the "force" attribute set.

HOLD | NOHOLD

HOLD

Specify the HOLD operand to select volumes with the volume HOLD attribute. HOLD and NOHOLD are mutually exclusive.

NOHOLD

Specify the NOHOLD operand to select volumes without the volume HOLD attribute. HOLD and NOHOLD are mutually exclusive.

HOME(SHELF |library_name | LOCDEF_location_name)

Specifies to list volumes with the same home location name, whether they are currently stored in that location or not. The home location is where the volume resides when it is not stored in a storage location. HOME can be a shelf location in a system-managed tape library or location SHELF. Home location can be a storage location that is defined as a home location.

You can enter any value, as no checking is done against the current list of locations defined to DFSMSrmm.

INSET(value)

Specifies a list volumes based on whether or not a volume is part of a multivolume chain or set. The INSET operand checks the previous and next volume information in the volume record. Specify one of the following values for INSET:

FIRST

List only volumes that are the first in a chain or set

LAST

List only volumes that are at the end of a multivolume set or chain.

NO

List only volumes that are not part of a multivolume chain or set; they have neither a previous nor a next volume.

YES

Lists all volumes that have a previous or next volume in the chain or set of volumes.

For example, to list all complete multivolume chains, use RMM SV VOLUME(*) OWNER(*) LIMIT(*) INSET(FIRST) CLIST("RMM SV VOLUME(",") CHAIN") EXEC EXEC.RMM.CLIST

INTRANSIT(YES | NO)

List volumes based on whether they have started to move. If a volume has been ejected from a system-managed library, DFSMSrmm lists it as "in transit". DFSMSrmm lists volumes in non-system-managed libraries as "in transit" as soon as the volume destination is set. Specify INTRANSIT(YES) to list only those volumes that DFSMSrmm has identified as "in transit". Specify INTRANSIT(NO) to list only those volumes that DFSMSrmm has not identified as "in transit".

Use the INTRANSIT operand together with LOCATION to limit the list to only those volumes residing in or moving from a specific location.

JOBNAME(jobname)

List volumes created by the specified job name. A job name is one-to-eight alphanumeric characters or $, #, or @. You can also use a generic job name. Use % in your generic job name mask to match any one character and * to match any character string in the job name.

If you do not specify JOBNAME, the job name is not used as a selection.

If you specify JOBNAME(*), DFSMSrmm returns all volumes that match the search values specified and that have a job name. Volumes that do not have a job name are not listed. JOBNAME is mutually exclusive with NOJOBNAME.

If you have volumes with job names that include symbols other than alphanumeric and national characters, use a generic job name to find them.

LABEL(label_type)

Specifies to list volumes of a specific volume type. You can specify any of these values:

SL

IBM® standard labels

NL

No label

AL

ISO/ANSI labels

SUL

Standard user label

AUL

Both ISO/ANSI and user header or trailer labels

BLP

Bypass label processing

LASTCHANGEDATE(date_range)

Lists the volumes whose last changed date matches the specified date criteria. The date criteria can be specified using the START and END suboperands. See the description of the SEARCHVOLUME ASDATE operand for a description of how to use the START and END suboperands and examples of their use.

LASTREFDATE(date_range)

Lists the volumes based on both the last read date and last write date, using the most recent of both dates. The most recent of the two values within the date range for a volume to be selected. The date criteria can be specified using the START and END suboperands. See the description of the SEARCHVOLUME ASDATE operand for a description of how to use the START and END suboperands and examples of their use.

LIMIT(search_limit)

Specifies the number of entries that DFSMSrmm lists. The maximum allowable decimal value is 9999. Specify an asterisk to request a list of all entries matching your search criteria.

LIMIT is mutually exclusive with END.

The default value is 10.

LIST

Specifies that DFSMSrmm produce a list when the CLIST operand is used.

LIST is mutually exclusive with the NOLIST operand. LIST is the default.

LOANLOCATION(loan_location_name)

Specifies a loan location name. DFSMSrmm only lists volumes that reside in the specified loan location. Specify a specific loan location name to list volumes that reside in that particular location. A loan location is one to eight characters which enclosed in single quotation marks if it contains any blanks or special characters. Specify an * to list all volumes that reside in any loan location.

The LOANLOCATION operand has no default. If you do not specify LOANLOCATION, all volumes are listed whether or not they reside in a loan location.

LOCATION

Specify to list volumes residing in a specific location. Specify one of these:

Specify	To list
SHELF	Volumes stored in shelf locations in a non-system-managed library.
LOCAL, DISTANT, or REMOTE	DFSMSrmm built-in storage locations. Use the LOCATION operand together with INTRANSIT to limit the list to only those volumes residing in or moving from the specific location. Use the LOCATION operand together with HOME to limit the list to only those volumes residing in a specific location which have the same home location.
library_name	Volumes stored in shelf locations in a specific system-managed library. A library name is one-to-eight alphanumeric characters starting with a non-numeric character.
LOCDEF_location_name	Volumes moving to a storage location that was defined using the LOCDEF command. You can enter any value as no checking is done against the current list of locations defined to DFSMSrmm.
generic_location_name	You can use a generic location name. You can use % in your generic mask to match any one character and * to match any character string.

MANUALMOVE

Specifies a list of volumes that have a move mode of MANUALMOVE.

MEDINF(medinf_name)

Specifies to list volumes with the given media information name. If you omit the MEDINF operand, no selection based on MEDINF name is performed.

You can use MEDINF(IBM) regardless of which MEDINF commands are defined in parmlib. Any other MEDINF name is validated against the MEDINF definitions.

Use this operand either on its own to select certain subsets of your media, or use it together with the MEDIATYPE and RECORDINGFORMAT operands to enable those operands to specify values that are either defined to DFSMSrmm by MEDINF commands in parmlib or are built in values using MEDINF(IBM).

When you do not specify MEDINF, but do specify one or more of the MEDIATYPE and RECORDINGFORMAT operands, DFSMSrmm matches the media type or recording format to the first MEDINF table entry that includes the specified external value, then to the built-in values.

Use the LISTCONTROL MEDINF subcommand to list your existing media information name entries.

MEDIANAME(medianame)

Specifies a list limited to volumes belonging to the same media name. Media name allows you to specify the type or shape of media. They are defined by your installation and one to eight characters.

Use the LISTCONTROL subcommand to display media names defined for your location. See LISTCONTROL: Displaying parmlib options and control information for more information.

MEDIATYPE(media_type)

Specifies the volume's physical media type to limit the volume search. You can specify media type values that match to those defined to DFSMSrmm by the MEDINF commands in parmlib. Use one of these values:

*

The volume is not a cartridge. This is the default.

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

MOVEDATE(date_range)

Lists the volumes whose movement tracking date matches the specified date criteria. The date criteria can be specified using the START and END suboperands. MOVEDATE may be specified as STOREDATE. See the description of the SEARCHVOLUME ASDATE operand for a description of how to use the START and END suboperands and examples of their use.

MOVETYPE(type)

Specify MOVETYPE(READYTOSCRATCH) to limit the list to volumes that are in ready to return to scratch status. Specify MOVETYPE(NOTREADYTOSCRATCH) to list volumes that are not pending release or are pending release with actions other than scratch.

NOJOBNAME

Use this operand to list volumes that have no creating job name.

NOLIST

Specifies that DFSMSrmm should neither produce a list nor set REXX variables for resources when the CLIST operand is used. DFSMSrmm produces only the CLIST output file.

NOLIST is mutually exclusive with the LIST operand. LIST is the default.

NOOEXPDT

Specifies a list of volumes with no original expiration date. NOOEXPDT is mutually exclusive with the OEXPDT operand.

NOVOL1

Specifies a list of volumes that do not have a VOL1 recorded by DFSMSrmm.

OPEN

Specifies a list limited to volumes with an open condition. Specify OPEN(YES) for physical or logical volumes to find volumes left open by an application. Specify OPEN(NO) with TYPE(STACKED) to list stacked volumes that can be moved.

OEXPDT(date)

Specifies a list of volumes based on the original expiration date. You can search using a specific date or for volumes with any original expiration date.

Specify one of the following values for OEXPDT:

*

Use an asterisk to search for volumes with any original expiration date.

date

A specific original expiration date. A specific date can be an absolute date in either yyyy/ddd or yyddd format.

Use the NOOEXPDT operand to list volumes with no original expiration date.

OWNER(owner)

Specifies an owner ID. DFSMSrmm only lists volumes belonging to the owner ID you specify. Specify a specific owner ID to list volumes belonging to that owner. Specify an asterisk to list all volumes that match the other search criteria regardless of their owner. An owner ID is one-to-eight alphanumeric characters or to six alphanumeric characters, $, #, or @. The first character must not be a number. The default is the ID of the command issuer.

POOL(pool_ID)

Specifies the pool ID for a group of shelf locations that DFSMSrmm uses to list volumes. DFSMSrmm only lists volumes that are associated with the pool that you specify. A pool ID is one-to-five alphanumeric, national, or special characters that are followed by an asterisk. Pool IDs defined by your installation. Enclose it in single quotation marks if it contains any special characters.

Use the LISTCONTROL subcommand with the VLPOOL operand to see the pool IDs that are defined for your installation.

READDATE(date_range)

Lists the volumes whose volume last read date matches the specified date criteria. The date criteria can be specified using the START and END suboperands. See the description of the SEARCHVOLUME ASDATE operand for a description of how to use the START and END suboperands and examples of their use.

RECORDINGFORMAT(format_list)

Specifies the basic recording format for tape volumes. You can specify media type values that match to those defined to DFSMSrmm by the MEDINF commands in parmlib. DFSMSrmm limits the list it returns to those volumes that match the specified value.

Specify one or more of the following values for RECORDINGFORMAT:

*

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. Recording format 18TRACK can be specified with MEDIATYPE(CST) and MEDIATYPE(ECCST) only.

36TRACK

Data has been written to the volume in 36 track format. Recording format 36TRACK can be specified with MEDIATYPE(CST) and MEDIATYPE(ECCST) only.

128TRACK

Data has been written to the volume in 128 track format. Recording format 128TRACK can be specified with MEDIATYPE(EHPCT) and MEDIATYPE(HPCT) only.

256TRACK

Data has been written to the volume in 256 track format. Recording format 256TRACK is valid with MEDIATYPE(EHPCT) and MEDIATYPE(HPCT) only. Use the 256TRACK operand to limit your search to volumes that are 3590 16-track bi-directional recording with 16 passes.

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.

RELEASEACTION(action_list)

Release actions are those that will be set as pending actions when a volume is released. Use the RELEASEACTION operand to search for volumes that have the specified release action set. Volumes are returned if any of the values you specify are set in the volume. Also see the ACTION operand for how to search for volumes with pending actions.

RELEASEACTION may also be specified as RA.

Specify one or more of the following values for RELEASEACTION, separated by commas:

ALL

To list all volumes with any release action.

ERASE

To list only volumes that require erasing.

INIT

To list only volumes that require initialization.

NOTIFY

To list only volumes for which owners notified.

REPLACE

To list only volumes that replaced by new volumes and returned to the scratch pool.

RETURN

To list only volumes that should be returned to their owner.

SCRATCH

To list all volumes to be returned to scratch status.

NOERASE

To list only volumes that do not require erasing. May be used in combination with ALL or other operands to exclude volumes that require erasing.

NOINIT

To list only volumes that do not require initialization. May be used in combination with ALL or other operands to exclude volumes that require initialization.

NONOTIFY

To list only volumes for which owners are not notified. May be used in combination with ALL or other operands to exclude volumes for which owners notified.

NOREPLACE

To list only volumes that do not need to be replaced by new volumes and returned to the scratch pool. May be used in combination with ALL or other operands to exclude volumes that replaced by new volumes and returned to the scratch pool.

NORETURN

To list only volumes that should not be returned to their owner. May be used in combination with ALL or other operands to exclude volumes that should be returned to their owner.

NOSCRATCH

To list all volumes that are not to be returned to scratch status. May be used in combination with ALL or other operands to exclude volumes to be returned to scratch status.

ONLY

Can be used in combination with other operands to limit the list to a specific combination. For example, RELEASEACTION(RETURN,NOTIFY,ONLY) will list only those volumes for which both the RETURN and NOTIFY release action apply. If ONLY were omitted, then DFSMSrmm would list all the volumes for which either release action applied.

When you specify ONLY with no other operand value, DFSMSrmm selects volumes that have no release action set. This is the same as specifying RELEASEACTION(NOERASE, NOINIT, NONOTIFY, NOREPLACE, NORETURN, NOSCRATCH).

RELEASEOPTION(option_list)

List volumes based on their release options. Release options are set by VRSEL processing when data sets match to, or are retained by, a VRS. Refer to Defining Release Policies for more details about how release options are handled.

RELEASEOPTION also may be specified as RO.

Specify one or more of the following values for RELEASEOPTION, separated by commas:

ALL

List all volumes that have any release options of any kind. Specifying the ALL operand value is the same as specifying RELEASEOPTION(EXPIRYDATEIGNORE,SCRATCHIMMEDIATE).

EXPIRYDATEIGNORE

List all volumes that have the "expiry date ignore" release option. EXPIRYDATEIGNORE may be specified as XI.

NOSI

List all volumes that do not have the "scratch immediate" release option. Can be used in combination with ALL or other operands to exclude volumes that have the "scratch immediate" release option.

NOXI

List all volumes that do not have the "expiry date ignore" release option. Can be used in combination with ALL or other operands to exclude volumes that have the "expiry date ignore" release option.

ONLY

Can be used in combination with other operands to limit the list to a specific combination. For example, RELEASEOPTION(SI,XI,ONLY) will list only those volumes for which both the SI and XI release options apply. If ONLY were omitted, then DFSMSrmm would list all the volumes for which either release option applied.

When you specify ONLY with no other operand value, DFSMSrmm selects volumes that have no release options set. This is the same as specifying RELEASEOPTION(NOSI,NOXI).

SCRATCHIMMEDIATE

List all volumes that have the "scratch immediate" release option. SCRATCHIMMEDIATE may be specified as SI.

REQUIRED(required_list)

Specifies a list of volumes that are required to be moved to a specific destination. If you specify REQUIRED(*), and you do not specify the LOCATION operand, DFSMSrmm lists all volumes that currently have a required location. DFSMSrmm does not check if the volume is already in the required location or is already moving to the required location. Use the LOCATION operand to further restrict the list of returned volumes.

Use these values to identify the volume movement you want DFSMSrmm to display.

DISTANT

To list volumes moving to the DISTANT storage location.

LOCAL

To list volumes moving to the LOCAL storage location.

REMOTE

To list volumes moving to the REMOTE storage location.

LOCDEF_location_name

To list volumes moving to a storage location that was defined using the EDGRMMxx parmlib LOCDEF command. You can enter any location name you want because DFSMSrmm does no checking of the location name.

library_name

To list volumes moving to a shelf location in a system-managed library. Library names one-to-eight alphanumeric characters, $,#, or @, starting with a non-numeric character.

SHELF

To list volumes moving to shelf locations in non-system-managed libraries.

REQUIREDLABELVERSION(0|3|4)

REQUIREDLABELVERSION(n) specifies a list limited to volumes that contain the requested required ISO/ANSI label version to be used in the VOL1 label for the volume. Specify 0, 3, or 4. Specify 0 for volumes with no required label version.

There is no default.

RETAINBY(FIRSTFILE | SET | SETORFIRSTFILE | VOLUME)

RETAINBY specifies a list limited to EXPDT retained volumes based on their RETAINBY attribute. Specify:

FIRSTFILE or F

To select volumes with RETAINBY = FIRSTFILE

SET or S

To select volumes with RETAINBY = SET.

SETORFIRSTFILE

To select volumes with RETAINBY = SET or FIRSTFILE

VOLUME or V

To select volumes with RETAINBY = VOLUME.

RETAINBY can be specified as RB.

There is no default for RETAINBY. If RETAINBY is not specified, DFSMSrmm will display volumes without regard to their RETAINBY attribute.

RETDATE(retention_date)

RETDATE specifies that DFSMSrmm lists only MASTER and USER volumes that will expire up to and including the specified date. You can specify a specific date as RETDATE(retention_date). You can also specify the DFSMSrmm special date formats; CATRETPD, PERMANENT, WHILECATLG, or CYCL/nnnnn, where "nnnnn" is five numeric digits. When you specify one of the special dates, DFSMSrmm lists only those volumes that are VRS retained with that special retention date. When you specify the special cycles format date, CYCL/nnnnn, DFSMSrmm lists volumes that are VRS retained and have a cycles retention date and the same number or fewer cycles. For example; RETDATE(CYCL/00255) searches for all data sets with a retention date set to CYCL/00255 or lower, such as CYCL/00001. For volumes not retained by a vital record specification, DFSMSrmm uses the expiration date for the search. To obtain a list of volumes that have a permanent expiration date and that are not retained by vital record specifications, specify the expiration dates 1999/365 or 1999/366.

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

A volume's retention date is the latest of all the data sets on the volume. If you do not specify the RETDATE operand, DFSMSrmm searches all volumes, regardless of their retention date. See Defining retention policies for data sets and volumes for information about how DFSMSrmm calculates retention dates.

RETENTIONMETHOD(EXPDT | VRSEL)

Specifies a list limited to volumes that have a specified retention method. Specify EXPDT to select volumes with the EXPDT retention method. Specify VRSEL to select volumes with the VRSEL retention method.

There is no default for RETENTIONMETHOD. If RETENTIONMETHOD is not specified, DFSMSrmm will display volumes without regard to their retention method.

RETENTIONMETHOD can be abbreviated as RM.

SINCE(assigned_date)

Specifies a list limited to volumes assigned to a user or volumes returned to scratch status after the assigned_date.

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.

If you do not specify the SINCE operand DFSMSrmm searches all volumes, regardless of the date when they were assigned to a user.

SINCE and ASDATE are mutually exclusive.

SPECIALATTRIBUTES(NONE | RDCOMPAT)

Specifies a list limited to volumes with special attributes associated with the tape volume.

RDCOMPAT

To list only those volumes with the RDCOMPAT special attribute

NONE

To list only those volumes with no special attributes

START

Specify this operand to request that records written to the CLIST data set start from the beginning of the data set.

START is mutually exclusive with ADD.

START is the default value.

STATUS(status)

Specify to list only volumes having the indicated status. status can be: ALL, EMPTY, ENTRY, INITIALIZE, MASTER, RELEASE, SCRATCH, USER, VRS, NOTEMPTY, NOTENTRY, NOTINITIALIZE, NOTMASTER, NOTLOAN, NOTRELEASE, NOTSCRATCH, NOTUSER, or NOTVRS. Specify a value of ALL, or one or more of these values separated by commas:

ALL

To list all volumes. ALL is the default.

EMPTY

To list volumes that are empty. A stacked volume is empty when it contains no volumes. Any other type of volume is empty when it contains no data sets.

ENTRY

To list volumes already defined to DFSMSrmm before being entered into an automated tape library for use as scratch volumes.

INITIALIZE

To list volumes waiting for initialization before becoming available for use as scratch volumes.

MASTER

To list volumes currently in master status.

RELEASE

To list volumes that are pending release and might require action, such as initializing.

SCRATCH

To list scratch volumes. This list does not include scratch volumes waiting for initialization or waiting for entry into an automated tape library before becoming available for use as scratch volumes.

USER

To list volumes currently in user status.

VRS

To list volumes retained by a vital record specification.

NOTEMPTY

To exclude stacked volumes that contain no volumes or other volumes that contain no data sets.

NOTENTRY

Specifies a list that excludes volumes already defined to DFSMSrmm. These volumes are ones that have not yet been entered into an automated tape library for use as scratch volumes.

NOTINITIALIZE

Specify to exclude volumes that initialized before they are available for use as scratch volumes.

NOTMASTER

Specify to exclude volumes that are currently in master status.

NOTLOAN

Specify to exclude volumes that are currently stored in loan locations.

NOTRELEASE

Specify to exclude volumes that are pending release and might require a release action before they can be released.

NOTSCRATCH

Specify to exclude volumes that are currently in scratch status.

NOTUSER

Specify to exclude volumes from the list returned by the SEARCHVOLUME request that are currently in user status.

NOTVRS

Specify to exclude volumes that are retained by vital record specifications.

STORAGEGROUP(storage_group_name)

Specifies the storage group name in order to select a subset of volumes based on the assigned storage group name. You can enter any value, as no checking is done. 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.

DFSMSrmm accepts the abbreviation STORGRP.

Use the STORAGEGROUP operand to build lists of exportable volumes that are in the same VTS physical volume pool.

STOREDATE

An alternate keyword for MOVEDATE. See the description of the SEARCHVOLUME MOVEDATE operand.

TYPE(LOGICAL | PHYSICAL | STACKED)

Specifies a list of volumes based on volume type:

LOGICAL

Limits the list to logical volumes.

Logical volumes have a many-to-one association with physical tape media and are used indirectly by z/OS® applications. They reside in a Virtual Tape Server or on exported stacked volumes. Applications can access the data on these volumes only when they reside in a Virtual Tape Server which makes the data available through its tape volume cache or after the data has been copied to a physical volume through the use of special utilities.

PHYSICAL

Limits the list to physical volumes.

A physical volume is a volume that has a one-to-one association with physical tape media and which is used directly by z/OS applications. It may reside in an automated tape library dataserver or be kept on shelf storage either at vault sites or within the data center where it can be mounted on stand-alone tape drives.

STACKED

Limits the list to stacked volumes.

A stacked volume is a volume that has a one-to-one association with physical tape media and which is used in a virtual tape server to store logical volumes. A stacked volume is not used by z/OS applications, but by the virtual tape server and its associated utilities. It may be removed from a virtual tape server to allow transportation of logical volumes to a vault or to another virtual tape server.

You can specify TYPE(LOGICAL) for VTS volumes only. When you specify the CLIST operand and TYPE(LOGICAL), DFSMSrmm returns more information in the output file if obtained logical volume resides on a stacked volume. In such a case, DFSMSrmm returns the first six characters of the container name, the logical volume serial number, and the status value. The status value can be:

• SCRATCH if the volume is in scratch status or ready to return to scratch with the SCRATCHIMMEDIATE release option set.
• INITIALIZE if the volume is in scratch status and contains no valid data.
• Blank if status is not available.

USE(systems)

Specifies a list volumes based on the systems on which the volumes can be used. Specify one or more of the following values for systems. If more than one value is specified, separate them with commas:

IRMM

To list volumes that can be used on open systems, managed by IRMM

ALL

To list all volumes. ALL can be used with one or more NOTxxx options to restrict which volumes are selected. ALL is the default.

MVS™

To list volumes that can be used on MVS systems such as z/OS

NOTIRMM

To exclude volumes used on open systems managed by IRMM

NOTMVS

To exclude volumes used on MVS systems

NOTVM

To exclude volumes used on VM systems

VM

To list volumes that can be used on VM systems such as z/VM®

VENDOR(full_or_generic_vendor_name|*)

Specifies a list of volumes that have a vendor name provided. A full vendor name is one-to-eight alphanumeric, national, or special characters. Enclose it in single quotation marks if it contains any special characters. A generic vendor name is one-to-seven alphanumeric, national, or special characters followed by an asterisk. Specify VENDOR(*) to obtain a list of all volumes with any provided vendor name.

There is no default.

VOLUME(full_or_generic_volume_serial|*)

Specifies the serial number of the volume that is being searched. A full volume serial number is one-to-six alphanumeric, national, or special characters. Enclose it in single quotation marks if it contains any special characters. A generic volume serial is one-to-five alphanumeric, national, or special characters followed by an asterisk. Specify an asterisk to search all volumes that match the specified search criteria.

VOL1(full_or_generic_volume_serial|*)

Specifies a list of volumes that have a VOL1 recorded by DFSMSrmm. A full volume serial number is one-to-six alphanumeric, national, or special characters. Enclose it in single quotation marks if it contains any special characters. A generic volume serial is one-to-five alphanumeric, national, or special characters followed by an asterisk. Specify VOL1(*) to obtain a list of all volumes with any VOL1 values.

WORM(NO|YES)

Specifies to list volumes that are identified to DFSMSrmm as WORM type volumes. Volumes are selected solely on whether they have been identified as WORM or recorded as WORM volumes. There is no selection based on media type, such as EWTC.

WRITEDATE

Lists the volumes whose volume last write date matches the specified date criteria. The date criteria can be specified using the START and END suboperands. See the description of the SEARCHVOLUME ASDATE operand for a description of how to use the START and END suboperands and examples of their use.

  RMM SEARCHVOLUME VOL1(*)

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                       date       date
------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
R00001 D044412  R00001 2002/182   2002/187   SHELF    0     M
R00002 D044412  R00002 2002/182   2002/187   SHELF    0     M
R00003 D044412  R00003 2002/182   2002/187   SHELF    0     M
EDG3012I 3          ENTRIES LISTED

  RMM SEARCHVOLUME OWNER(WEISSENB) ACTION(ALL) SINCE(91055) LIMIT(*)

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                       date       date
------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
VOL600 WEISSENB RAC500 06/11/2004 11/11/2002 SHELF    0     UR SI
EDG3011I 1 ENTRY LISTED

  RMM SEARCHVOLUME VOLUME(*) OWNER(*) LOCATION(ATL) -
       DESTINATION(*) -
       INTRANSIT(NO) LIMIT(*) CLIST('RMM CHANGEVOLUME ',' EJECT(BULK)')

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                        date       date
 ------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
 9990A5 ZWT01    9990A5 15/01/2003 20/01/2003 ATL      1     M        SHELF
 9990A6 ZWT01    9990A6 15/01/2003 20/01/2003 ATL      1     M        SHELF
 EDG3012I 2          ENTRIES LISTED

DFSMSrmm also creates a CLIST data set containing the records shown in Figure 4.

RMM CHANGEVOLUME 9990A5 EJECT(BULK)
 RMM CHANGEVOLUME 9990A6 EJECT(BULK)

RMM SEARCHVOLUME OWNER(*) VOLUME(*) RETDATE(2002/300)

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                        date       date
 ------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
 KIM002 KIMBERLY ABC002 06/04/1993 10/01/2012 SHELF    1     M
 KIM006 KIMBERLY DAMW08 06/04/1993 10/01/2012 SHELF    1     M
 111001 LESLEY01 D65B35 06/18/1994 10/01/2012 SHELF    1     M        REMOTE
 111013 LESLEY01 D65B36 06/18/1994 10/01/2012 SHELF    1     M        REMOTE

RMM SEARCHVOLUME VOLUME(*) OWNER(*) DESTINATION(ATL1)-
      TYPE(LOGICAL) CLIST

A00099 LESLEY01 07/30/1999 08/26/1999 SHELF 1 M VTS1

CONT01,A00099

RMM SEARCHVOLUME VOLUME(*) LIMIT(*) LOCATION(ATL1)-
      CLIST('RMM CHANGEVOLUME ',' TYPE(LOGICAL)')
EXEC EXEC.RMM.CLIST

RMM CHANGEVOLUME RFA050 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA051 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA052 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA053 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA054 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA055 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA056 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA057 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA058 TYPE(LOGICAL)
RMM CHANGEVOLUME RFA059 TYPE(LOGICAL)

RMM SEARCHVOLUME VOLUME(*) LIMIT(*) LOCATION(LIB1)-
      OWNER(*) INTRANSIT(NO)-
      CLIST('RMM CHANGEVOLUME ',' LOCATION(LIB2)')

RMM CHANGEVOLUME RFA050 LOCATION(LIB2)
RMM CHANGEVOLUME RFA051 LOCATION(LIB2)
RMM CHANGEVOLUME RFA052 LOCATION(LIB2)
RMM CHANGEVOLUME RFA053 LOCATION(LIB2)
RMM CHANGEVOLUME RFA054 LOCATION(LIB2)
RMM CHANGEVOLUME RFA055 LOCATION(LIB2)
RMM CHANGEVOLUME RFA056 LOCATION(LIB2)
RMM CHANGEVOLUME RFA057 LOCATION(LIB2)
RMM CHANGEVOLUME RFA058 LOCATION(LIB2)
RMM CHANGEVOLUME RFA059 LOCATION(LIB2)

RMM SEARCHVOLUME VOLUME(*) LOCATION(LIB1) DESTINATION(LIB2) -
      INTRANSIT(Y) CLIST('RMM CHANGEVOLUME ',' CMOVE') OWNER(*) LIMIT(*)

RMM CHANGEVOLUME RFA199 CMOVE

RMM SEARCHVOLUME VOLUME(XWW126) END(XXW131) OWNER(*)

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                       date       date
------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
XWW126 TRISH           1999/307   1999/312   SHELF    0     M
XWW127 TRISH           1999/307   1999/312   SHELF    0     M
XXW130 TRISH           1999/307   1999/312   SHELF    0     U
XXW131 TRISH           1999/307   1999/312   SHELF    0     U
EDG3012I 4          ENTRIES LISTED

RMM SEARCHVOLUME VOLUME(XWW*) END(XXW) OWNER(*)

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                       date       date
------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
XWW125 TRISH           1999/307   1999/312   SHELF    0     M
XWW126 TRISH           1999/307   1999/312   SHELF    0     M
XWW127 TRISH           1999/307   1999/312   SHELF    0     M
EDG3012I 3          ENTRIES LISTED

RMM SEARCHVOLUME OWNER(TRISH) END(123456)

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                       date       date
------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
XWW125 TRISH           1999/307   1999/312   SHELF    0     M
XWW126 TRISH           1999/307   1999/312   SHELF    0     M
XWW127 TRISH           1999/307   1999/312   SHELF    0     M
XXW130 TRISH           1999/307   1999/312   SHELF    0     U
XXW131 TRISH           1999/307   1999/312   SHELF    0     U
XXW132 TRISH           1999/307   1999/312   SHELF    0     U
123456 TRISH           1999/307   1999/312   SHELF    0     U
EDG3012I 7          ENTRIES LISTED

RMM SEARCHVOLUME VOLUME(*) LIMIT(*) LOCATION(ATLBA035) REQUIRED(MAZ) -
     OWNER(*) CLIST('',',MAZ') INTRANSIT(N)

Volume Owner    Rack   Assigned   Expiration Location Dsets St Act   Dest.
                       date       date
------ -------- ------ ---------- ---------- -------- ----- -- ----- --------
RFA055 MTHUM           02/24/2003 03/01/2003 ATLBA035 1     UV
RFA056 MTHUM           02/24/2003 03/01/2003 ATLBA035 1     UV
2          ENTRIES LISTED

RFA055,MAZ
RFA056,MAZ

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.