Reclaim Optical (RCLOPT)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Reclaim Optical (RCLOPT) command rebuilds the optical index database files and/or the internal library indexes. These files and indexes are used to maintain volume and directory information. Following are some of the reasons the files and indexes may need to be rebuilt: after CISC to RISC migration, after optical media is physical moved or removed by hand, after a hardware failure while media was being moved, or when a database or index has been damaged or destroyed. This command requires exclusive use of the directly-attached optical device.

Note: This command may take an extended period of time to complete - possibly more then 24 hours. The time to completion is influenced by several factors including: number of optical libraries, number of media in each library, capacity of each media, number of files and directories on each media and the options chosen on the command.

Restriction: You must have *USE authority to use this command. It is shipped with *EXCLUDE public authority.

Top

Parameters

Keyword Description Choices Notes
MLB Optical media library Name, *ALL Required, Positional 1
OPTION Option *SYNC, *UPDATE, *RESET Optional, Positional 2
VOL Volume identifier Character value, *ALL Optional
DIR Rebuild directory index *NO, *YES Optional
Top

Optical media library (MLB)

Specifies the directly-attached optical device for which the optical indexes are rebuilt.

*ALL
The optical indexes for all directly-attached optical devices are rebuilt.
optical-device-name
Specify the name of the directly-attached optical device for which the optical indexes are rebuilt.
Top

Option (OPTION)

Specifies which type of reclaim operation is performed.

*SYNC
The optical volume index is synchronized with the internal device index. If a volume is not in the optical volume index, both the volume and the directory index entries are created for the volume. This option will usually complete in the shortest amount of time and, in most cases, should be attempted first before trying the *UPDATE or *RESET option.
*UPDATE
The optical volume index is rebuilt and the optical directory index is optionally rebuilt with information read from the optical cartridge. In most cases this option will be used to rebuild the indexes for a single volume or optical cartridge.
*RESET
The internal device index and the optical volume index are rebuilt. The optical directory index is optionally rebuilt with information read from the optical cartridge. Selecting *RESET requires every volume to be mounted into a drive at least once. The optical directory index is built if the Rebuild directory index parameter is set to *YES. Specifying DIR(*YES) will require every volume to be mounted a second time. In most cases *RESET should be used only after *SYNC and/or *UPDATE have already been attempted.
Top

Volume identifier (VOL)

Specifies which volumes are used during the reclaim operation when OPTION(*UPDATE) is specified.

*ALL
All volumes in the optical device are used.
volume-identifier
Specify the volume identifier of a specific volume to use during the reclaim operation.
Top

Rebuild directory index (DIR)

Specifies whether the optical directory index is rebuilt for each volume processed during Reclaim Optical processing. This parameter only applies to options *UPDATE and *RESET. When *SYNC is specified, DIR(*NO) will be used. In addition, this option does not apply to volumes which have a media format type of *UDF since directory index information is not maintained for *UDF volumes. When *UDF volumes are processed, DIR(*NO) will be used.

*NO
The optical directory index is not rebuilt for each volume processed.
*YES
The optical directory index is rebuilt for each volume processed. Only applies to *UPDATE and *RESET for non-UDF volumes.

Note: Choosing the value *NO may result in less time being required to complete the Reclaim Optical request.

Top

Examples

RCLOPT   MLB(OPT01)  OPTION(*UPDATE)  VOL(VOL01)  DIR(*YES)

This command re-creates both the optical volume index and the optical directory index for the optical volume VOL01 in the optical media library OPT01.

Top

Error messages

*ESCAPE Messages

OPT0125
Command &1 completed with errors, more information in job log.
OPT1320
Optical volume &1 in use.
OPT1325
Optical volume format not recognized.
OPT1330
Optical volume not found or not useable.
OPT1331
Optical volume &1 not found.
OPT1346
Operation not allowed to volume located in a remote optical device.
OPT1360
Media directory corrupted on optical volume &1.
OPT1460
Optical volume &1 is not in an optical device.
OPT1530
&1 does not represent a valid optical device.
OPT1555
Optical device &1 in use.
OPT1605
Media or device error occurred.
OPT1640
Error occurred reading files or directories.
OPT1652
Device &1 is not an optical media library.
OPT1790
Operation not allowed or conflicts with another request.
OPT1805
Error accessing optical volume index file.
OPT1810
Error accessing optical directory index file.
OPT1815
Internal program error occurred.
OPT1820
Internal error occurred on optical device &1.
OPT1821
Error occurred on optical device &1.
OPT1825
Optical indexes are incorrect for optical device &1.
OPT1860
Request to optical device &1 failed.
OPT1861
No device description configured for resource &1.
OPT1862
No active device description for resource &1.
OPT1863
Optical libraries need to be reclaimed.
OPT1872
Optical request timed out or was cancelled.
OPT2040
Error accessing backup control file.
OPT2155
Reclaim Optical failed for optical device &1.
OPT2165
Reclaim Optical failed for volume &1.
OPT2187
Optical index inconsistency, reclaim optical required.
OPT2188
Optical index files are damaged.
OPT2190
Error occurred during reclaim optical processing while accessing volume &1.
OPT2191
Error occurred while reading volume directory for volume &1.
OPT2301
Internal system object in use.
OPT7740
User not authorized to object &2 in library &3 type &4.
Top