Load or Unload Image Catalog (LODIMGCLG)

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

The Load or Unload Image Catalog (LODIMGCLG) command is used to associate an image catalog and its images to a virtual device. The status of the image catalog will be changed based on the value specified for the Option (OPTION) parameter as follows:

*LOAD
This will cause the status of the image catalog to change to Ready. All image catalog entries that are in mounted or loaded status will be loaded in the specified virtual device. The allow save attribute will be set to not allow save for all image catalog files.
*UNLOAD
This will cause the status of the image catalog to change to Not ready. All image catalog entries are removed from the specified virtual device. The allow save attribute will be set to allow save for all image catalog entries.

Only one image catalog can be associated with a virtual device. If the virtual device already has an image catalog associated with it, you can use OPTION(*UNLOAD) to unload the current image catalog.

Restrictions:

Top

Parameters

Keyword Description Choices Notes
IMGCLG Image catalog Name Required, Positional 1
OPTION Option *LOAD, *UNLOAD Optional, Positional 3
DEV Virtual device Name Optional, Positional 2
WRTPTC Write protect *DFT, *ALL, *NONE Optional
LIBMODE Library mode *NO, *YES Optional
Top

Image catalog (IMGCLG)

Specifies the image catalog to be loaded or unloaded.

This is a required parameter.

name
Specify the name of the image catalog.
Top

Option (OPTION)

Specifies whether the image catalog is to be loaded or unloaded.

*LOAD
The image catalog will be loaded into the virtual device.
*UNLOAD
The image catalog will be unloaded from the virtual device.
Top

Virtual device (DEV)

Specify the device that the image catalog is to be loaded into or unloaded from.

This is a required parameter.

name
Specify the name of the virtual device.
Top

Write protect (WRTPTC)

Specifies whether to write protect based on each catalog entry's assigned value or to force all catalog entries to be write protected when the image catalog is loaded. The write protect value for each catalog entry will be returned to its previous value when the image catalog is unloaded from the device.

This parameter is valid only when parameter OPTION(*LOAD) is specified. When parameter OPTION(*UNLOAD) is specified the WRTPTC parmeter is ignored.

*DFT
Each image catalog entry's current write protect value will be used when the image catalog is loaded in the virtual device.

The default write protect values for dependent and reference image catalogs are unique and are defined as follows:

  1. Optical dependent image catalogs
    • All entries will have their write protected value set on when the image catalog is loaded in the virtual device.
  2. Optical reference image catalogs
    • All entries will have their write protected value set on when the image catalog is loaded in the virtual device.
  3. Tape dependent image catalogs
    • All entries will have their write protected value set on when the image catalog is loaded in the virtual device.
  4. Tape reference image catalogs
    • All entries will use the current write protect value when the image catalog is loaded in the virtual device.
*ALL
All entries will be write protected when the image catalog is loaded in the virtual device.
*NONE
The write protect value will be set off for all entries when the image catalog is loaded in the virtual device.

The *NONE write protect values for dependent and reference image catalogs are unique and are defined as follows:

  1. Optical dependent image catalogs
    • All entries will have their write protected value set on when the image catalog is loaded in the virtual device.
  2. Optical reference image catalogs
    • All entries will have their write protected value set on when the image catalog is loaded in the virtual device.
  3. Tape dependent image catalogs
    • All entries will have their write protected value set on when the image catalog is loaded in the virtual device.
  4. Tape reference image catalogs
    • All entries will have their write protect value set off when the image catalog is loaded in the virtual device.
Top

Library mode (LIBMODE)

Specifies whether to load the image catalog in the virtual optical device in library mode. Library mode loads all volumes in mounted or available status.

For tape image catalogs, this parameter is ignored.

*NO
The image catalog will not be loaded into the virtual device in library mode.
*YES
The image catalog will be loaded into the virtual device in library mode.
Top

Examples

Example 1: Loading an Image Catalog

LODIMGCLG   IMGCLG(MYCLG)  DEV(OPTVRT01)  OPTION(*LOAD)

This command loads image catalog MYCLG into device OPTVRT01. Write protection is set based on the current value for each catalog entry. This example assumes that MYCLG is not a dependent or reference catalog.

Example 2: Loading an Image Catalog as Read-only

LODIMGCLG   IMGCLG(MYCLG)  DEV(OPTVRT01)  OPTION(*LOAD)
            WRTPTC(*ALL) LIBMODE(*YES)

This command loads image catalog MYCLG into device OPTVRT01 in library mode. Write protection is set on for all catalog entries.

Example 3: Unloading an Image Catalog

LODIMGCLG   IMGCLG(MYCLG)  OPTION(*UNLOAD)

This command unloads image catalog MYCLG from the associated virtual device.

Example 4: Loading a Tape Image Catalog

LODIMGCLG   IMGCLG(MYCLG)  DEV(TAPVRT01)  OPTION(*LOAD)

This command loads image catalog MYCLG into device TAPVRT01.

Top

Error messages

*ESCAPE Messages

CPFBC10
Image catalog &1 not loaded to device &2.
CPFBC11
Image catalog &1 not unloaded from device &2.
CPFBC45
Image catalog &1 not found.
CPF9802
Not authorized to object &2 in &3.
CPF9820
Not authorized to use library &1.
Top