Optional Parameters

This parameter cannot be used to delete a user catalog, and is ignored when you delete members of a partitioned data set or the tape library entry.

Abbreviation: CAT

• The volume that contains a data set to be deleted with SCRATCH.
• The data set to be deleted if ERASE is specified.
• The partitioned data set from which a member (or members) is to be deleted.
• The volumes that contain VVDS entries for the objects cataloged.
• The VVDS volume that contains a VVR or NVR to be deleted.

Use of the FILE parameter improves the performance of the DELETE command.

When you delete a data set, the volume referred to in the DD statement must be the same as the volume referred to in the usercatalog.

If you do not specify FILE and VSAM requires access to a volume or volumes during the delete processing, VSAM tries to dynamically allocate the volumes. When the entryname is pdsname(membername) VSAM dynamically allocate the entire PDS rather then the pdsname(member).

When more than one volume is to be identified (for example, a multivolume data set), FILE identifies the DD statement that specifies all volumes. If in any of the above cases the volumes are of a different device type, use concatenated DD statements. All volumes that contain associations to a cluster being deleted must also be included on the DD statement referenced by the FILE parameter.

When deleting multivolume non-VSAM data sets with the SCRATCH option, DELETE SCRATCH processing requires access to each volume in the entry's catalog record before the scratch can be issued. This requires either all volumes to be mounted, online, and allocatable to the job, or the use of the FILE parameter specifying a DD statement allocating at least one mountable unit (not permanently resident or reserved). Deferred mount must be specified on the DD statement so that allocation will flag the UCB to allow remove/mount requests to be issued for the unit as required during delete processing. If access to the volumes cannot be provided, use DELETE NOSCRATCH to uncatalog the non-VSAM data set and the user will assume the responsibility of scratching the format-1 DSCBs from all the volumes. If RACF is installed, you must have access authority under RACF to specify DELETE NOSCRATCH.

When the FILE parameter points to a DD statement that has DISP=SHR the data set can be deleted when allocated to another user, but is not open.

The use of this DD name in subsequent commands in the same invocation of IDCAMS may not work properly. Specifically, DEFINE, BLDINDEX, REPRO, and IMPORT may fail if these commands refer to the same DD name for output from those commands. This is because those commands will use volume and device-related information that may no longer be applicable. BLDINDEX, REPRO, and IMPORT should use the OUTDATASET keyword instead of OUTFILE to avoid this problem.

FORCE

lets you delete generation data groups, tape library entries, and user catalogs without first ensuring that these entries are empty.

Attention: The FORCE parameter deletes all clusters in the catalog.

If you delete a generation data group using FORCE:

• Proper access authority to the RACF resource for catalog functions is necessary for DELETE GDG FORCE. The DELETE GDG FORCE function should not be used to redefine the GDG limit value. ALTER LIMIT should be used instead.
• The GDG entry is deleted even though it might point to non-VSAM entries in the catalog.
• Each SMS-managed non-VSAM data set entry pointed to by the GDG base entry is deleted before the GDG base entry is deleted. The non-VSAM data set is scratched.
• Each non-SMS-managed non-VSAM data set entry pointed to by the GDG base entry is deleted before the GDG base entry is deleted. However, the non-VSAM data set's space and contents on the volume are undisturbed.
• No VVDSs are deleted
• An IKJ56220I is possible when perform in DELETE GDG FORCE against a GDG with a large limit and GDSs with many candidate volumes. Similar to limitations imposed on concatenated data sets in a single DD, allocation of an entire GDG is dependent on the size of the TIOT. DELETE GDG FORCE is a unique command that requires allocation of all generation data sets under a GDG in order to perform the forced delete.

If you delete a tape library entry using FORCE:

• The tape library entry is deleted even if tape volume entries are still associated with the specified tape library.
• Any tape volume entries associated with a deleted tape library entry will remain in the catalog for these tape volume entries.

If you delete a user catalog using FORCE:

Attention: The FORCE parameter deletes all clusters in the catalog.

• The user catalog is deleted even if it contains entries for objects that have not been deleted.
• All data sets cataloged in the user catalog as well as the catalog data set itself are deleted. All volumes on which these data sets reside must be included with the FILE parameter.
• All VSAM clusters are automatically deleted, but the contents of each cluster and alternate index are not erased. (If you specify FORCE, the ERASE parameter is ineffective.)
• SMS-managed non-VSAM data set entries in the user catalog are deleted and the data sets are scratched.
• Non-SMS-managed non-VSAM data set entries in the user catalog are deleted, but the data sets are not scratched. A non-SMS-managed non-VSAM data set can be located with its DSCB in the volume's VTOC.
• If you are using the XFACILIT class STGADMIN.IGG.DELAUDIT.catalogname to restrict deletion of data sets in the user catalog, those data sets to which the user does not have authority will not be deleted, but the user catalog will be deleted. The entries failing the delete will not be accessible until they are recataloged.

Abbreviation: FRC

NOFORCE

causes the DELETE command to end when you request the deletion of a generation data group, tape library entry, or user catalog that is not empty.

Abbreviation: NFRC

MASK

The MASK keyword cannot be specified with the following keywords:

• TRUENAME (TRUENAME)
• Non-VSAM Volume record (NVR)
• VSAM Volume Record (VVR)
• PDSE/PDS member data set
• Library Entry (LIBRARYENTRY)
• Tape Volume entry (VOLUMEENTRY)

The DELETE MASK command allows only one entry-name to be specified. If there are multiple entry-names specified, the request will fail with error messages.

When you specify a filter key with the MASK operand, the following rules apply:

• An asterisk (*) represents 1 to 8 characters in a level of a catalog entry.
• Double asterisks (**) represents multiple qualifiers within a catalog entry. The double asterisks (**) must be preceded by a period, and the double asterisks can be followed by either a period or a blank.
• Percent sign (%) allows 1 to 8 percent signs (%) specified in each qualifier.
• The high level qualifier of the filter key must be fully qualified unless the CATALOG parameter is also supplied. In other words, the high level qualifier cannot contain a *, ** or %. ABC%.DATA.SET and **.DATA.SET and A*.DATA.SET are all examples of an invalid mask. If you want to specify names like ABC%.DATA.SET or **.DATA.SET or A*.DATA.SET where the high level qualifier is not fully qualified, you must also specify the CATALOG parameter.
• When using asterisk within a qualifier, this is considered as a mask entry name and a MASK keyword must be specified. Examples are 'A.B*.C', 'AB.CD*', 'AB.*CD.'.

See Catalog Search Interface User's Guide in z/OS DFSMS Managing Catalogs for more information regarding data set name filter keys.

NOMASK

NOMASK is the default. With NOMASK the entryname can be fully qualified or a generic name. When using a generic name, the asterisk(*) will only replace one single qualifier.

Here are examples of how DELETE works using MASK, NOMASK or omitting the MASK or NOMASK parameter, given the following data sets.

1)  AAA.BBB.AAA.DDD
2)  AAA.BBB.CCC.DDD
3)  AAA.BBB.CCC.DDD.EEE
4)  AAA.BBB.CCC
5)  BBB.DDD.AAC.BBC.EEE
6)  BBB.DDD.ABC.BBC.EEE
7)  BBB.DDD.ADC.BCCD.EEEE
8)  CCC.GDG.BASE1                        This entry is an empty GDG base. It has no entries
9)  CCC.GDG.BASE2                        This entry is not an empty GDG base. It has entries
10) CCC.GDG.BASE2.G0001V00               This is an entry that belongs to CCC.GDG.BASE2
11) CCC.GDG.BASE2.G0002V00               This is an entry that belongs to CCC.GDG.BASE2
12) CCC.GDG.FLAT.FILE                    This is a non-GDG

When NOMASK or parameter is omitted, the following are the results:

DELETE AAA.*                                    results in no data sets being deleted
DELETE AAA.* NOMASK                             results in no data sets being deleted
DELETE AAA.*  MASK     			        results in no data sets being deleted
DELETE AAA.BBB.*                                results in the deletion of data set #4
DELETE AAA.BBB.* NOMASK                         results in the deletion of data set #4
DELETE AAA.BBB.*.DDD                            results in the deletion of data sets #1
                                                and #2

DELETE AAA.BBB.* MASK      	                results in the deletion of data set #4
DELETE AAA.BBB.*.DDD NOMASK                     results in the deletion of data sets #1
                                                and #2
DELETE AAA.BBB.*.DDD.EEE                        results in the deletion of data set #3.
DELETE AAA.BBB.*.DDD.EEE NOMASK                 results in the deletion of data set #3.
DELETE AAA.BBB.AAA.DDD MASK                     results in the deletion of data sets #1
DELETE CCC.GDG.*                                results in the deletion of data set #9
                                                and an error message is issued for data
                                                set #10, #11, and #12 because the base
                                                is not empty
DELETE CCC.GDG.* NOMASK                         results in the deletion of data set #9
                                                and an error message is issued for data
                                                set #10, #11, and #12 because the base
                                                is not empty
DELETE CCC.GDG.BASE1                            results in the deletion of data set #9



DELETE CCC.GDG.BASE1 NOMASK                     results in the deletion of data set #9
DELETE CCC.GDG.BASE2                            results in the deletion of no data sets
                                                as the GDG base has entries.
DELETE CCC.GDG.BASE2 NOMASK                     results in the deletion of no data sets
                                                as the GDG base has entries.

When MASK is specified, the following are the results:

DELETE AAA.** MASK                              results in deletion of #1 #2 #3 and #4
DELETE BBB.DDD.** MASK                          results in deletion of #5 #6 #7 and #8
DELETE BBB.DDD.BBC.A%C.BBC.EEE MASK             results in deletion of #5 #6
DELETE BBB.DDD.ADC.B%%%.EEEE MASK               results in deletion of #7 #8
DELETE AAA.*.** MASK                            results in deletion of #1 to #4
DELETE BBB.DDD.A*.BBC.EEE MASK                  results in deletion of #5 #6
DELETE BBB.DDD.A*C.BBC.EEE MASK                 results in deletion of #5 #6

DELETE CCC.GDG.BASE2.* MASK                     results in deletion of #11 and #12 GDG


                                              
DELETE CCC.GDG.BASE2.G%%%%V00 MASK              results in deletion of #11 and #12
DELETE CCC.GDG.BASE2.G*V00 MASK                 results in deletion of #11 and #12
DELETE CCC.GDG.BASE2.G%%%%V00 MASK NVSAM        results in deletion of #11 and #12
DELETE CCC.GDG.BASE2.G*V00 MASK NVSAM           results in deletion of #11 and #12

RECOVERY

When RECOVERY is specified and the entry name identifies a user catalog, the user catalog is to be replaced with an imported backup copy. The user catalog, its VSAM volume record (VVR), and its VTOC entries are deleted. The VVR and DSCBs, for each of the objects defined in the user catalog, are not deleted or scratched. If the catalog is RACF-protected, alter authority is required.

VSAM must be able to read the VVDS or be able to process it as an ESDS for the function to complete successfully.

When RECOVERY is specified and entryname identifies a VVDS, the VVDS is unusable or inaccessible and must be rebuilt by deleting, redefining, and loading the appropriate VSAM data sets on the volume. The VVDS entry's DSCB will be scratched from the VTOC. The CATALOG parameter must contain the name of the master catalog when a VVDS is deleted with the RECOVERY parameter. If RACF protected, ALTER authority is required.

When RECOVERY is specified and the entry name identifies a GDG, the SMS-managed or non-SMS-managed GDG entry is deleted from the catalog and generation data sets remain unaffected in the VTOC.

If a VVDS contains a catalog entry or a system data set (SYS1.) entry that is cataloged in a master catalog, the VVDS catalog entry and the DSCB of the associated VVDS will not be removed.

If you delete a generation data group (DELETE GDG RECOVERY) using RECOVERY, proper authority to the RACF resource for catalog function is necessary.

See the USERCATALOG parameter for information about using RECOVERY with

Abbreviation: RCVRY

NORECOVERY

indicates that the entry is to be processed as described by the other parameters specified.

Abbreviation: NRCVRY

SCRATCH

specifies that a data set is to be scratched from (removed from the VTOC of) the volume on which it resides. For VSAM data sets and SMS-managed non-VSAM data sets, the VSAM volume data set (VVDS) entry is also removed.

DELETE SCRATCH will ignore any missing data set components (such as VVRs or F1 DSCBs) and will scratch all the data set parts that can be found at the time the request is issued.

When SCRATCH is specified for a VVDS, the VVDS is scratched and the catalog entry for the VVDS is removed. The VVDS must be empty.

If the catalog entry does not exist for a non-VSAM data set, you can use the SCRATCH function of the OS/VS IEHPROGM utility to remove the format-1 DSCB from the VTOC.

If you select SCRATCH, one of the following statements must be true:

• The entry is in the master catalog.
• One or more of the qualifiers in the entry's qualified name is the same as the catalog's name or alias.
• The FILE parameter is specified.

If you specify SCRATCH when deleting a non-VSAM data set defined with an esoteric device type, SYSDA for example, the DELETE will be unsuccessful under the following circumstances:

• Input/output configuration is changed resulting in addition or deletion of one or more esoteric device types.
• The esoteric device type definitions on the creating and using systems do not match when the catalog is shared between the two systems.

Note: If the VVDS indicates that the data set is owned by a catalog other than that catalog identified through the usual catalog search order for DELETE, a DELETE NOSCRATCH is done against the catalog that resulted from the catalog search, and a zero return code is returned to the user. For example, if you specify a DELETE SCRATCH command against a data set in Catalog A, and the VVDS indicates that the data set is owned by Catalog B, a DELETE NOSCRATCH operation is done against Catalog A, and the data set remains intact and accessible from Catalog B. See Catalog Search Order for DELETE for information on the catalog search order for DELETE.

Abbreviation: SCR

NOSCRATCH

specifies that the catalog entry is to be deleted from the catalog without mounting the volume that contains the object defined by the entry. VVDS and VTOC entries are not deleted.

If RACF is installed, you must have access authority under RACF to specify NOSCRATCH. With proper authority, DELETE NOSCRATCH is allowed on SMS-managed VSAM and non-VSAM data sets, thus deleting the BCS entry in the catalog without accessing the VVDS or VTOC.

Attention:  

• DELETE NOSCRATCH can result in uncataloged SMS-managed data sets.
• DELETE NOSCRATCH cannot be issued against a VSAM data set which is currently open.

For more information on cloning zFS, see the VOLUMES parameter in Access Method Services DEFINE CLUSTER command.

NOSCRATCH removes the catalog entry for a VVDS. This entry can be reinstated with DEFINE RECATALOG. If the volume is mounted and usable, the VVDS is checked to ensure that the catalog entry being removed has no data sets in the VVDS. If the catalog entry indicates there are data sets in the VVDS, the VVDS's VSAM volume control record (VVCR) is removed and the catalog entry for the VVDS is removed.

If the volume is mounted and you specify NOSCRATCH for a VSAM volume data set (VVDS), the catalog entry for the VVDS is removed, and the catalog back pointer in the VSAM volume control record (VVCR) is removed.

You should specify NOSCRATCH for the following:

• If the format-1 DSCB of a non-VSAM data set has already been scratched from the VTOC.
• If you are deleting a non-VSAM data set that was defined with a device type named by the user (for example, SYSDA) and the device type is not valid.
• If the object is defined in a catalog and you want to recatalog the object in the same catalog.
• After you convert a volume, the names of catalogs owning data sets on the volume will still be in the VVCR. Only catalogs that reside on the converted volume need to have their names in the VVCR. You can remove unneeded catalog names from the VVCR by using DELETE VVDS NOSCRATCH with the CATALOG parameter referencing the catalog to be deleted from the VVCR. For coexistence, an error indication is still returned if there are VVR or NVRs on the volume for the referenced catalog.
• NOSCRATCH affects the DFSMShsm delete function interaction for VSAM base clusters and non-VSAM data sets. It causes the migrated data set to be recalled because a migrated data set cannot be uncataloged.

Abbreviation: NSCR