Optional Parameters

BACKUPDATA

requires that information on backed up data sets is collected from the given backup control data set (BCDS).

The desired BCDS must be allocated to the ddname BCDS.

Abbreviation: BACD

BACKUPALL

requires that information on backed up data sets and UNIX files is collected from the given backup control data set (BCDS).

The desired BCDS must be allocated to the ddname BCDS. This parameter cannot be specified with BACKUPDATA or BACKUPUNIX.

Abbreviation: BALL

BACKUPUNIX

requires that information on backed up UNIX files is collected from the given backup control data set (BCDS).

The desired BCDS must be allocated to the ddname BCDS. This parameter cannot be specified with BACKUPDATA or BACKUPALL.

Abbreviation: BACU

CAPPLANDATA

includes capacity planning information in the output data set. Allocate the MCDS to the ddname MCDS and the BCDS to the ddname BCDS.

Abbreviation: CAPD

shows the type and format of the cartridges used for mountable tape data sets used with this data class. It is mapped by one of the following attributes:

DDCMENUL: Media type is not specified (NULL). The constant value is 0.
DDCMEDA1: Media type is MEDIA1 (cartridge system tape media). The constant value is 1.
DDCMEDA2: Media type is MEDIA2 (enhanced capacity cartridge tape media). The constant value is 2.
DDCMEDA3: Media type is MEDIA3 (high-performance cartridge tape media). The constant value is 3.
DDCMEDA4: Media type is MEDIA4 (extended high-performance cartridge tape media). The constant value is 4.
DDCMEDA5: Media type is MEDIA5 (IBM® TotalStorage Enterprise Tape Cartridge media). The constant value is 5.
DDCMEDA6: Media type is MEDIA6 (Enterprise WORM Tape Cartridge media). The constant value is 6.
DDCMEDA7: Media type is MEDIA7 (Enterprise Economy Tape Cartridge media). The constant value is 7.
DDCMEDA8: Media type is MEDIA8 (Enterprise Economy WORM Tape Cartridge media). The constant value is 8.
DDCMEDA9: Media type is MEDIA9 (Enterprise Economy Tape Cartridge media). The constant value is 9.
DDCMEDA10: Media type is MEDIA10 (Enterprise Economy WORM Tape Cartridge media). The constant value is 10.
DDCMED11: Media type is MEDIA11 (Enterprise Economy WORM Tape Cartridge media). The constant value is 10.

DDCRECTE

indicates the number of recording tracks on the cartridge used for the mountable tape data sets associated with this data class.

DDCRTNUL: The recording technology is not specified (NULL). The constant value is 0.
DDC18TRK: The recording technology is 18TRACK. The constant value is 1.
DDC36TRK: The recording technology is 36TRACK. The constant value is 2.
DDC128TK: The recording technology is 128TRACK. The constant value is 3.
DDC256TK: The recording technology is 256TRACK. The constant value is 4.
DDC384TK: The recording technology is 384TRACK. The constant value is 5.
DDCEFMT1: The recording technology is EFMT1. The constant value is 6.
DDCEFMT2: The recording technology is EFMT2. The constant value is 6.
DDCEFMT3: The recording technology is EFMT3. The constant value is 6.
DDCEEFM3: The recording technology is EEFMT3. The constant value is 6.
DDCEFMT4: The recording technology is EFMT4. The constant value is 6.
DDCEEFM4: The recording technology is EEFMT4. The constant value is 6.

ERRORLIMIT(value)

is the maximum number of errors for which detailed DCOLLECT error messages can print during program run. ERRORLIMIT prevents runaway message output. The default for ERRORLIMIT is 2,147,483,647 errors, but any number between 1 and 2,147,483,647 can be given. Processing continues even though the error limit has been reached.

Abbreviation: ELIMIT

EXCLUDEVOLUMES(volser[ volser…])

allows you to exclude information on a selected volume or group of volumes. One or more volumes selected by using the STORAGEGROUP and VOLUMES keywords can be excluded with this keyword. Options for EXCLUDEVOLUMES are:

a fully specified volume serial number, containing 1-to-6 characters
a partially specified volume serial number using a single trailing asterisk as a placeholder for all remaining characters, or
any combination of the above.

Abbreviation: EXV

EXITNAME(entrypoint)

is the 1-to-8 character entrypoint name for an external DCOLLECT user exit module. Load it to an APF-authorized library for access at the time of DCOLLECT invocation. If you do not use it, the default DCOLLECT user exit, IDCDCX1, is used. The user exit module is restricted by a RACF FACILITY profile with the resource name of STGADMIN.IDC.DCOLLECT.xxxxxxxx where xxxxxxxx is the DCOLLECT EXITNAME parameter value. Users must have at least READ authority to the FACILITY class resource name in order to invoke the exit.

Abbreviation: EXIT

MIGRATEDATA

requires collection of information on migrated data sets from the specified MCDS (Migration Control Data Set). The desired MCDS must be allocated to the ddname MCDS.

Abbreviation: MIGD

MIGRSNAPALL

asks ARCUTIL to do SNAP processing, and is used for diagnostic reasons only. See z/OS DFSMShsm Implementation and Customization Guide for more information on SNAP ALL processing. Do not use it with MIGRSNAPERR. It is ignored if you do not use MIGRATEDATA, BACKUPDATA, or CAPPLANDATA.

Abbreviation: MSALL

MIGRSNAPERR

requires ARCUTIL to run SNAP processing when an error occurs during ARCUTIL processing. Use it for diagnostic purposes only. See z/OS DFSMShsm Implementation and Customization Guide for more information on SNAP ALL processing. Do not use it with MIGRSNAPALL. It is ignored if you do not use MIGRATEDATA, BACKUPDATA, or CAPPLANDATA.

Abbreviation: MSERR

NODATAINFO

says that no data set information records are generated or written to the output data set. Use this parameter if you want only volume information generated for the given volumes or storage groups.

Abbreviation: NOD

NOVOLUMEINFO

says that no volume information records are generated or written to the output data set. Use this parameter if you want only data set information generated for the given volumes or storage groups.

Abbreviation: NOV

REPLACE|APPEND

specifies whether the output data is to replace existing data or whether the output data is to be added to the end of the existing data set. The REPLACE/APPEND applies when OUTDATASET is used. If you use OUTFILE, data set processing is controlled by the JCL DISP parameter: OLD replaces the current contents of the data set, and MOD appends new records to the end of the data set.

REPLACE: asks that the contents of the output data set are overwritten with new data. All existing data in the output data set is lost when this parameter is selected.
Abbreviation: REPL
APPEND: writes new records starting at the end of the existing data, if any exists. All existing data is preserved when this parameter is selected.
Abbreviation: APP

SMSDATA(SCDSNAME(entryname)|ACTIVE)

includes SMS configuration data in the DCOLLECT output data set. This parameter can include either an SCDS name or the keyword ACTIVE.

One or more of the following record types is created when you use SMSDATA:

Type: Description
DC: Data Class construct information
SC: Storage Class construct information
MC: Management Class construct information
BC: Base Configuration information
SG: Storage Group construct information
VL: Storage Group volume information
AG: Aggregate Group information
DR: OAM Drive Record information
LB: OAM Library Record information
CN: Cache Names from the Base Configuration Information
AI: Accounting Information for the ACS routines.

Abbreviation: SMS

The subparameters of SMSDATA are:

SCDSNAME(entryname): is the source of the SMS control data that is to be collected.
entryname: is used to specify the name of an existing cataloged SCDS. An enqueue with a major name of IGDCDS is issued to serialize access to the control data set. The enqueue is held during SMSDATA processing.
Abbreviation: SCDS
ACTIVE: takes the SMS information from the configuration that is currently active on the system.

STORAGEGROUP(sgname[ sgname…])

lists the storage groups from which information is to be collected. For each storage group listed, a list of online volume serials is generated. Information is collected for all data sets residing on those volumes unless you use NODATAINFO. Volume information is collected unless you use NOVOLUMEINFO. A maximum of 255 storage groups can be selected. Although several storage groups can be specified, and the volume list might have duplicates, each volume's information is only processed once.

Abbreviation: STOG

TIMEOUT(value)

Specifies the elapse-time value, in unit of seconds, that the caller is willing to wait for LSPACE function to complete. The value must be a positive number from 1 and 86400, inclusive. The default value is 240 seconds. This parameter applies only when the information is collected from the VOLUMES. End of change

VOLUMES(volser[ volser…])

lists the volumes from which information is to be collected. For each online volume serial listed (or resolved from generic specifications), information is collected for all data sets residing on those volumes unless you use NODATAINFO. Volume information is collected unless you use NOVOLUMEINFO. You can use a maximum of 255 volume serials.

Options are:

A fully specified volume serial number, containing 1-to-6 characters.
A partially specified volume serial number using a single asterisk as a place holder for all remaining characters.
Six asterisks to indicate the system residence volume (SYSRES).
Any combination of the above.

For example, you might use one of these for the volume serial number:

SYS001: This collects data from volume SYS001 only.
SYS*: This collects data from all online volumes beginning with SYS.
This collects data from the system residence volume (SYSRES).
******: This collects data from the system residence volume (SYSRES).
**: This collects data from all online volumes.

Although the same volumes can be specified several times, each volume's information is only processed once.

Abbreviation: VOL