DVT (Display VTOC)

Purpose
Display or print a list of the data sets on a disk volume obtained from the disk VTOC.
Usage notes
Use this function to display or print information about data sets and free space on a disk volume. The information is obtained from the disk VTOC. In the list, you can scroll forward and backward, select the alternate display, and locate specific data set names. You can print this list.

You can sort the information by any one of several criteria (see following description for the DVT function variable, sortdsnby). The listing also shows free extents on the disk.

Alternatively, you can request that only a VTOC summary, similar to that shown in Figure 1, is produced. You can sort the summary list by any one of several criteria (see following description for the DVT function variable, sortvolby).

You can also request for a combined data set and summary list report to be produced.

Note: DVT shows “never to expire” expiration dates of 99/999 and 99/366 as 9999.999 and 9999.366, respectively. An expiration date that was explicitly specified as 99/365 is also considered “never to expire”, and is shown as 9999.365. However, an expiration date of 99/365 that was calculated from a specified retention period (current date + number of days = 99/365) will expire, and is shown as 1999.365. If you sort the list by expiration date, values beginning with 9999 appear first.
Options
Use a fully-qualified or generic file ID, or search patterns to limit the output. The list can be sorted by entry name, creation date, expiration date, or disk extent.
Return codes
The default return codes from the DVT function have the following modified meanings:
4
No data sets found
4
No data set matches pattern on selected volumes
4
No volume matches pattern
16
Volume not mounted
16
Insufficient storage available
16
DVT abended
16
Other serious error that stops processing occurred (for example an input or output error)
Note: Return codes can be customized during installation. If you receive return codes that do not match those listed above, your site might have customized the return codes for this function. Z Data Tools may also issue the 999 abend, if the return code in batch is equal to or greater than the ABENDCC value. Contact your Z Data Tools systems administrator for details.
Related function
DSX
Display the extents of a data set
Read syntax diagramSkip visual syntax diagram
Syntax

                       .-DSNAME=**------.   
>>-DVT--VOLSER=volser--+----------------+----------------------->
                       '-DSNAME=dsnmask-'   

   .-SMSGROUP=*------------.  .-UNIT=*----.   
>--+-----------------------+--+-----------+--------------------->
   '-SMSGROUP=smsgroupmask-'  '-UNIT=unit-'   

   .-DEVTYPE=*-------.  .-VOLSTATE=*--------.   
>--+-----------------+--+-------------------+------------------->
   '-DEVTYPE=devtype-'  '-VOLSTATE=volstate-'   

   .-LIMIT=0-----.   
>--+-------------+---------------------------------------------->
   '-LIMIT=limit-'   

>--+-COMBINE=NO--+-SUMMARY=NO----------+--+-SUMMARY=YES-+------------------+-+-+-->
   |             '-SORTDSNBY=sortdsnby-'  |             |          .-NO--. | | |   
   |                                      |             '-LIMITED=-+-YES-+-' | |   
   |                                      '-SORTVOLBY=sortvolby--------------' |   
   '-COMBINE=YES--SORTDSNBY=sortdsnby--SORTVOLBY=sortvolby---------------------'   

   .-FUNCTION--=--LIST-.  .-DSNREPEAT=NO--.   
>--+-------------------+--+---------------+--------------------->
   '-FUNCTION=function-'  '-DSNREPEAT=YES-'   

   .-DATEFORM=YYDD---.   
>--+-----------------+-----------------------------------------><
   '-DATEFORM=YYMMDD-'   

volser
Volume serial number of the disk. Can include a "volume mask" with a percent sign (%) representing exactly one character, or an asterisk (*) representing any number of characters (or no characters). Only volumes matching the mask participate in processing.
dsnmask
A generic data set name, or search pattern. Within the data set name, you can include a percent sign (%) to represent exactly one character, an asterisk (*) to represent any number of characters (or no characters) within a qualifier, or two asterisks (**) to represent any number of characters (or no characters) within any number of qualifiers. The default is **.

If you also specify a "volume mask" in volser, only volumes having data sets matching the dsnmask participate in the processing.

In any mode except batch mode, the user's TSO prefix (normally the user ID) is used as the high-level qualifier for any name that is not entered in quotation marks. For example, the default of ** lists all entries in batch mode; in any other mode, it lists all entries that have the user's TSO prefix as high-level qualifier.

smsgroupmask
A generic SMS storage group name, or search pattern. Within the name, you can include a percent sign (%) to represent exactly one character, an asterisk (*) to represent any number of characters (or no characters).
unit
A generic device address, or search pattern. Within the address, you can include a percent sign (%) to represent exactly one character, an asterisk (*) to represent any number of characters (or no characters).
devtype
A generic device type name, or search pattern. Within the name, you can include a percent sign (%) to represent exactly one character, an asterisk (*) to represent any number of characters (or no characters).
volstate
A generic volume status name, or search pattern. Within the name, you can include a percent sign (%) to represent exactly one character, an asterisk (*) to represent any number of characters (or no characters).
The following full names are supported:
  • PRIVATE (also includes PRIV/RSDNT)
  • RESIDENT
  • PUBLIC
  • STORAGE
  • ALL
limit
The maximum number of data sets to be selected for processing. The default (0) indicates that there is no limit on the number of data sets selected.
function
The command that you want to execute:
LIST
Display the list (the default)
PRINT
Print the list
SUMMARY
Determines whether or not the VTOC list is produced in full or as a summary.
NO
(Default) The full list is produced.
YES
A summary is produced and the SORTBY parameter is ignored. The list is sorted by device number.
LIMITED
Determines where the volume summary list (SUMMARY=YES) contains detailed (NO) or limited (YES) data about the number of datasets located on the volumes processed. Specifying LIMITED=YES provides faster response times.
NO
Detailed dataset information included in the volume summary list.
YES
No dataset counts provided in the volume summary list.
sortdsnby
Determines the sequence in which the VTOC data set list appears:
NAME
Sorted by data set name
VOLSER
Sorted by volume serial
EXTENT
Sorted by extent
SIZE
Sorted by data set size
TYPE
Sorted by DSORG
RECFM
Sorted by RECFM
LRECL
Sorted by LRECL
BLKSIZE
Sorted by BLKSIZE
DATE
Sorted by creation date
EDATE
Sorted by expiration date
RDATE
Sorted by last referred date
sortvolby
Determines the sequence in which the VTOC volume list appears:
VOLSER
Sorted by volume serial
UNIT
Sorted by device address (unit)
DTYPE
Sorted by device type
SMSSG
Sorted by SMS storage group
TTTRK
Sorted by disk capacity
USTRK
Sorted by tracks used
USPTRK
Sorted by utilization in %
TRKF
Sorted by tracks available
TDSN
Sorted by number of data sets
TVSDSN
Sorted by number of VSAM data sets
TNVSDSN
Sorted by number of non-VSAM data sets
SVTOC
Sorted by VTOC size
UPVTOC
Sorted by VTOC utilization in %
INDX
Sorted by VTOC indexing
DSCBS
Sorted by VTOC free DSCBs
FCYL
Sorted by cylinders available
MFCYL
Sorted by maximum free space in cylinders
FTRK
Sorted by tracks available
MFTRK
Sorted by maximum free space in tracks
COMBINE
Determines whether a combined data set and volume summary list report is produced.
NO
Does not produces a combined data set and volume summary list report.
YES
Produces a combined data set and volume summary list report.
DSNREPEAT
Determines whether a combined data set and volume summary list report is produced.
NO
Suppresses the data set name on the second and subsequent extents.
YES
The data set name appears for each extent.
DATEFORM
Determines the display format for the date fields.
YYDD
Use the date format YYYY.DDD.
YYMMDD
Use the date format YY/MM/DD.
//DVT JOB (acct),'name'  Display VTOC
//*
//HFMBAT    PROC
//HFMBAT    EXEC PGM=HFMMAIN
//STEPLIB  DD DSN=HFM.SHFMMOD1,DISP=SHR
//SYSPRINT DD SYSOUT=*
//SYSABEND DD SYSOUT=*
//SYSUDUMP DD SYSOUT=*
//         PEND
//*
//ZDTOOLS  EXEC HFMBAT
//SYSPRINT DD SYSOUT=*
//SYSIN    DD *
$$FILEM DVT VOLSER=SCPMV5,DSNAME=**,SORTBY=DATE
$$FILEM EOJ
/*