Administrator's Reference

CHECKOUT LIBVOLUME (Check a Storage Volume out of a Library)

Use the CHECKOUT LIBVOLUME command to remove a sequential access storage volume from an existing automated library.

If you include the DEVCONFIG option in the dsmserv.opt file, the files you specify with that option are automatically updated with the results of this command.

Note:

The CHECKOUT LIBVOLUME command processing will not wait for a drive to become available, even if the drive is only in the IDLE state. A library drive must be made available, if necessary, by dismounting the drive with the DISMOUNT VOLUME command. Once a library drive is available, the CHECKOUT LIBVOLUME command can be reissued.

This command creates a background process that can be canceled with the CANCEL PROCESS command. To display information on background processes, use the QUERY PROCESS command.

Privilege Class

To issue this command, you must have system privilege or unrestricted storage privilege.

Syntax

>>-CHECKOut LIBVolume--libraryname--volname--------------------->
 
    .-CHECKLabel--=--Yes------.  .-FORCE--=--No-------.
>---+-------------------------+--+--------------------+--------->
    '-CHECKLabel--=--+-Yes-+--'  '-FORCE--=--+-No--+--'
                     '-No--'                 '-Yes-'
 
     .-REMove--=--Yes-------.
>----+----------------------+----------------------------------><
     '-REMove--=--+-Yes--+--'
                  +-No---+
                  '-Bulk-'
 

Parameters

libraryname

Specifies the name of the library where the storage volume is to be removed. This parameter is required.

volname

Specifies the volume name of the storage volume being checked out. This parameter is required.

CHECKLabel=checkvalue

Specifies how or whether ADSM should read sequential media labels of volumes during CHECKOUT LIBVOLUME command processing. This parameter is optional.For non-SCSI devices you can suppress label checking by setting the checkvalue to NO. The default value is YES. Possible values are:

Yes

Specifies that during checkout libvolume processing an attempt is made to read the media label. Reading the media label verifies that the correct volume is being checked out.

No

Specifies that during checkout the media label is not read. This increases performance since the read process does not occur.

FORCE=forcevalue

Specifies whether ADSM checks out a storage volume if there is an input/output (I/O) error reading the label. This parameter is optional. The default value is NO. Possible values are:

No

Specifies that ADSM does not check out a storage volume when there is an I/O error reading the label.

Yes

Specifies that ADSM checks out the storage volume even when an I/O error reading the label occurs.

REMove=removevalue

Specifies whether ADSM ejects a volume during CHECKOUT LIBVOLUME command processing from either an IBM 3494 or 3495 library. This parameter is optional. The default value is Yes. Possible values are:

Yes

Specifies that a volume is ejected during CHECKOUT LIBVOLUME command processing. The volume entry is deleted from the ADSM library inventory.

No

Specifies that a volume is not ejected during CHECKOUT LIBVOLUME command processing. This deletes the volume entry from the ADSM library inventory and leaves the volume in the library for use by other applications.

Bulk

For SCSI libraries with multiple Entry/Exit ports, specifies that the volume is ejected to the next avaiable Entry/Exit port. An informational message is issued stating that the tape volume should be removed from the Bulk I/O station at the convenience of the operator. Please note, the user is not prompted to issue the REPLY command. Once all Entry/Exit ports are full, the cartridge will be left in its home cell and an informational message is issued stating that the tape volume should be removed from its home cell at the convience of the operator. This message will provide the home cell's element number, which in some libraries may require an element map to identify it. ADSM documentation provides maps for many of the common libraries, and it should also be in the hardware documentation. For SCSI libraries withOUT Multiple Entry/Exit ports, the REMOVE=Bulk option is invalid and it will be processed as REMOVE=NO. This is done to prevent operations that are used for accessingEntry/Exit ports from being issued on those libraries that do not support them.

Usage Notes

A volume that is checked out of a library may still be defined in a storage pool. If the server attempts to access the checked out volume, a request is issued that waits for the volume to be checked in.

During scheduled batch jobs that are running the CHECKOUT LIBVOLUME command you may not want to be prompted with reply messages for each tape checkout. You can eliminate the reply messages by setting the CHECKOUT LIBVOLUME command's remove parameter to no; however, this does cause the tape to remain in the library. For additional information, see the REMove parameter description.

Examples

Task

Check out the volume named EXB004 from the library named FOREST.

Command:

checkout libvolume forest exb004

Related Commands

Table 25. Commands Related to CHECKOUT LIBVOLUME

Command	Description
AUDIT LIBRARY	Ensures that an automated library is in a consistent state.
CANCEL PROCESS	Cancels a background server process.
CHECKIN LIBVOLUME	Checks a storage volume into an automated library.
DEFINE LIBRARY	Defines an automated or manual library.
DEFINE VOLUME	Assigns a volume to be used for storage within a specified storage pool.
QUERY LIBRARY	Displays information about one or more libraries.
QUERY LIBVOLUME	Displays information about a library volume.
QUERY PROCESS	Displays information about one or all background server processes.
UPDATE LIBVOLUME	Changes the status of a storage volume.