FDRCRYFM REORG Statement

REORG statement

The REORG statement takes a backup of the Encryption Keyfile (similar to the DUMP statement, described earlier) and then reloads the Encryption Keyfile from that backup, after removing obsolete entries from the file. Although the Encryption Keyfile does not need frequent reorganization (unless you create frequent encrypted backups), it should be reorganized periodically (perhaps once a month).

The step JCL must include a TAPE1 DD statement. REORG takes a backup of the Encryption Keyfile to that DD (just like the DUMP statement) and then reads it back to reload the Encryption Keyfile. Although the TAPE1 DD statement can specify a temporary data set, we recommend that it be a permanent data set for backup purposes and to protect against a failure during the reload.

REORG statement syntax

REORG
	,CRYDD=ENCRYPT|ddn
	,DATACLAS=dataclas
	,DELETE=IGNORE|PURGE|RETAIN
	,DISABLE=([CANCELPROT][CHECKCATALOG][DYNALLOC][ESTAE][EXPANDREASON] [IFNOTCURRENT][NULLFILE][RESERVE][SELTERR])
	,ENABLE=([CANCELPROT][CHECKCATALOG][DYNALLOC] [ESTAE] [EXPANDREASON][IFNOTCURRENT][NULLFILE][RESERVE][SELTERR])
	,DUMPDEVICE=DISK|TAPE
	,LOG|NOLOG
	,PRTLENGTH=nnnnn
	,SIMULATE
	,SORTALLOCATE=NO|YES|([SORTLIB][SORTMSG][SORTWORK])
	,SORTCORE=100000|nnnnnnn
	,SORTLIB=SYS1.SORTLIB|dsn
	,SORTMSG=AC|AP|CC|CP|NO|PC
	,SORTMSGDDNAME=SYSOUT|ddn
	,SORTPFX=SORT|cccc
	,STORCLAS=storclas
	,TODD=TAPE1|ddn
	,WORKDDNAMES=3|n
	,WORKUNIT=SYSALLDA|unit

There are three options that control removal of obsolete entries during the reload. None of them are enabled by default, so you must specify at least one for the REORG to have any meaning. They are (details below):

DELETE=PURGE

To purge entries marked by a DELETE statement.

ENABLE=NULLFILE

To purge entries where the output file was DUMMY (DSN=NULLFILE).

ENABLE=IFNOTCURRENT

To purge uncataloged backups on DASD and backups on tape that are no longer recorded in your tape management system.

REORG statement operands

CRYDD=

ddn

Specifies the name of the DD statement that is to be used to reference the Encryption Keyfile.

Default: ENCRYPT.

DATACLAS=

dataclas

Specifies the SMS data class name (1 to 8 characters) to use when dynamically allocating any of the temporary files, including sort work files if requested by SORTALLOC=. It must be a value valid for DATACLAS= in the JCL. DATACLAS= is required only when the SORTOUT temporary work file must be allocated with more than 65,535 tracks (when the used space in the Encryption Keyfile exceeds about 39,000 tracks). The data class specified must have the attributes that allocate an Extended Format (EF) striped file on multiple volumes in order to accommodate this allocation.

Default: There is no default for DATACLAS=. It is ignored if STORCLAS= is not specified.

DELETE=

Specifies whether entries marked for deletion by a previous DELETE statement (in this step or a previous FDRCRYFM step) are to be removed:

IGNORE

Ignore the delete flag (entries may still be removed for other reasons).

PURGE

Remove all entries with the delete flag on.

RETAIN

Retain all entries with the delete flag on, even if they are selected for other reasons.

Default: IGNORE, so DELETE=PURGE must be specified to remove entries marked by a previous DELETE statement.

DISABLE=

ENABLE=

The options specified are disabled or enabled for this REORG operation. Multiple options are enclosed in parentheses and separated by commas. The options and their meaning if enabled are:

CANCELPROT

Controls the activation of cancel protection for this service.

CHECKCATALOG

Can be used in conjunction with IFNOTCURRENT. If no supported tape management system is detected, it substitutes a catalog check for the normal tape management check. It can be used if you do not have one of the supported tape management systems (CA 1, CA TLMS, DFSMSrmm, or Zara).

DYNALLOC

Dynamically allocate the Encryption Keyfile specified in the FDR Global Options, if the ENCRYPT DD statement is omitted.

ESTAE

Controls the specification of ESTAE recovery services that can be used for user or vendor supplied code.

EXPANDREASON

Controls the printing of expanded drop reasons during Encrypt reorganization.

IFNOTCURRENT

Removes all entries whose backup no longer exists. For backups on DASD, they are removed if the backup is no longer cataloged in an z/OS catalog. For backups on tape, they are removed if they are no longer recorded in the tape management system active on your operating system (DFSMSrmm and CA 1 tape management systems are supported).

NULLFILE

Removes all entries whose backup was DUMMY (DSN=NULLFILE); these are usually tests.

RESERVE

Protects the Encryption Keyfile with a RESERVE macro against the volume on which it resides during the reorganization (see the CNTRESV option above).

SELTERR

Unsatisfied selection criteria causes the condition code to be set to a non-zero value.

Default: All options are disabled by default, except RESERVE, which is enabled by default.

DUMPDEVICE=

Specifies the device type that is eligible to be used as a backup medium during the REORG operation.

DISK

The backup can be on either a tape or DASD device.

TAPE

The backup must be on a tape device.

Default: TAPE.

LOG

NOLOG

Specifies whether the entries that are being removed by the REORG operation are to be listed.

Default: LOG.

PRTLENGTH=

nnnnn

Specifies the number of bytes to be displayed from each record for the DIAGNOSE option. The value may be any number from 32 through 32,000, inclusive.

Default: Varies by record type.

SIMULATE

Specifies the REORG operation is simulated. If specified, all processing is done and all entries selected for removal are displayed (if LOG is in effect) but the Encryption Keyfile is not actually updated. By default, the Encryption Keyfile is updated and entries are actually removed.

SORTALLOC=

Specifies if FDRCRYFM is to dynamically allocate SORT related DD statements and, if allocation is requested, which ddnames are to be allocated.

NO

Do no dynamically allocate SORT related ddnames.

SORTLIB

Dynamically allocate the SORTLIB ddname using the value in the operand SORTLIB for the DSNAME.

SORTMSG

Dynamically allocate the sort message output ddname using the value in the operand SORTMSGDDNAME for the ddname.

SORTWORK

Dynamically allocate the SORTWKnn ddnames using the values in the operand WORKUNIT as the unit.

YES

Dynamically allocate all SORT related ddnames.

Multiple values may be specified for this operand if separated by commas and enclosed in parenthesis.

Default: NO.

SORTCORE=

nnnnnnn

Specifies the amount of storage the program SORT is to use if external sorting is required. The number may be from 10,000 to 8,000,000 inclusive.

Default: 100,000.

SORTLIB=

dsn

Specifies the data set name to be allocated to the ddname SORTLIB.

Default: SYS1.SORTLIB.

SORTMSG=

Specifies the message option to be used by the program SORT if external sorting is required.

AC

All messages are directed to the console.

AP

All messages are directed to the printer.

CC

Critical messages are directed to the console.

CP

Critical messages are directed to the printer.

NO

No messages are to be produced.

PC

Critical messages are to be directed to both the console and the printer.

Default: CC.

SORTMSGDDNAME=

ddn

Specifies the ddname to be used by the program SORT if messages are to be output to the printer.

Default: SYSOUT.

SORTPFX=

cccc

Specifies the ddname prefix to be used by the program SORT if external sorting is required. If the string specified is less than four characters, a dollar sign “$” fill character is used.

Default: SORT.

STORCLAS=

storclas

Specifies the SMS storage class name (1 to 8 characters) to use when dynamically allocating any of the temporary work files, including sort work files if requested by SORTALLOC=. It must be a value valid for STORCLAS= in the JCL.

Default: There is no default for the STORCLAS= keyword. If neither STORCLAS= or WORKUNIT= is specified, processing continues using the default value of SYSALLDA for WORKUNIT.

TODD=

ddn

Specifies the ddname to be used when creating a backup tape from an Encrypt Encryption Keyfile with FDRCRYFM.

Default: TAPE1.

WORKDDNAMES=

n

Specifies the number of sort work ddnames to allocate. The number may be from 1 to 5 inclusive.

Default: 3.

WORKUNIT=

unit

Specifies the unit name, a value from 1 to 8 characters in length that represents one or more groups of like DASD, to use when allocating any of the temporary work files.

Default: SYSALLDA.