Basic System DMS PROC › SCAN Commands › SCAN CATALOGS Command

SCAN CATALOGS Command

The syntax of the SCAN CATALOGS command is as follows:

SCAN CATALOGS=,EXCCATS=,BACKUP

SCAN CATALOGS=

Specify a catalog name (or catalog pattern) to be scanned. The catalog(s) can be ICF, VSAM or an explicitly named OS CVOL. If an explicit catalog name is specified (for example, PROJ99.USERCAT), only that one catalog will be processed. However, if a catalog pattern is specified (for example, SYS1/), all catalogs that match the pattern and are connected to the master catalog will be processed. All standard CA Disk pattern matching capabilities are available (/, ?, * and !).

Note: The pattern matching capability is not available in any operating environment that does not connect user catalogs to the master catalog. You can turn off this support by specifying sysparm VSCATPTN with a value of N, thereby forcing you to explicitly name a catalog. It should also be noted that the pattern matching capability does incur some additional overhead in that the master catalog must be searched in order to determine the user catalogs defined to the system. The master catalog will also be selected if it meets the specified pattern.

Normally, if a pattern name is specified that doesn't match any of the catalog names in your installation, CA Disk will terminate all commands in the command stream. This can be overridden by specifying sysparm VSCATPTN with a value of C, such that only the one SCAN command will fail and all other commands will be executed.

EXCCATS=

This parameter should be specified only when a catalog pattern is specified on the CATALOGS= parameter. Its function is to allow the user to exclude up to ten catalog names and/or patterns that would otherwise be selected based on the pattern supplied on the CATALOGS= parameter. See the example in Complex DSCL Command Sequences for a further explanation.

BACKUP

This parameter causes a backup copy to be taken of each ICF catalog selected for processing by the SCAN command, with the retention period provided by the RETRETPD sysparm. CA Disk uses the IDCAMS EXPORT utility to create the catalog backup, but then copies its ALIAS entries from the master catalog as part of the backup as well.

Do not confuse this BACKUP parameter (on the SCAN command) with the BACKUP command itself. This BACKUP parameter causes ICF catalogs to be backed up. The BACKUP command causes VSAM or non-VSAM data sets or ICF catalogs to be backed up. If you would like to specify a particular retention period or expiration date for the backup of an ICF catalog, specify SELECT CATALOGS= and BACKUP RETPD= or EXPDT= under any SCAN command.

For more information, see the section Year 2000 Considerations in the chapter "General Information."