Tivoli Header

Administrator's Reference

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

Use this command to remove a sequential access storage volume from the server inventory for an automated library. 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.

Notes:

  1. Check out processing does not wait for a drive to become available, even if the drive is in the IDLE state. If necessary, you can make a library drive available by dismounting the volume with the DISMOUNT VOLUME command. After a drive is available, the CHECKOUT LIBVOLUME command can be reissued.

  2. Before checking out volumes from a 349X library, ensure that the 349x Cartridge Input and Output facility has enough empty slots for the volumes to be checked out. The 3494 Library Manager does not inform an application that the Cartridge Input and Output facility is full. It accepts requests to eject a cartridge and waits until the Cartridge Input and Output facility is emptied before returning to the server. Tivoli Storage Manager may appear to be hung when it is not. You should check the library and clear any intervention requests.

Privilege Class

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

Syntax



SCSI Library

>>-CHECKOut LIBVolume--library_name----volume_name-------------->
 
   .-REMove--=--Yes------.  .-CHECKLabel--=--Yes-----.
>--+---------------------+--+------------------------+---------->
   '-REMove--=--+-Yes--+-'  '-CHECKLabel--=--+-Yes-+-'
                +-No---+                     '-No--'
                '-Bulk-'
 
   .-FORCE--=--No------.
>--+-------------------+---------------------------------------><
   '-FORCE--=--+-No--+-'
               '-Yes-'
 
 

Syntax



349X Library

>>-CHECKOut LIBVolume--library_name----volume_name-------------->
 
   .-REMove--=--Yes------.
>--+---------------------+-------------------------------------><
   '-REMove--=--+-Yes--+-'
                +-No---+
                '-Bulk-'
 
 

Parameters

library_name (Required)
Specifies the name of the library.

volume_name
Specifies the volume name. This parameter is required for SCSI and 3494 libraries.

REMove
Specifies that the server tries to move the volume out of the library and into the bulk I/O station or entry/exit ports.

For 349x Libraries:

For SCSI Libraries:


Table 29. How Tivoli Storage Manager Responds to REMOVE=YES or REMOVE=BULK for SCSI Libraries

If a library . . . Then . . .
Does not have entry/exit ports TSM leaves the cartridge in its current slot within the library and specifies the slot address in a message.
Has entry/exit ports and an entry/exit port is available TSM moves the cartridge to the available entry/exit port and specifies the port address in a message.
Has entry/exit ports, but no ports are available TSM leaves the cartridge in its current slot within the library and specifies the slot address in a message.

This parameter is optional. The default is YES. Possible values are:

Yes
Specifies that a volume is placed into the bulk I/O station. The server deletes the volume entry from the server library inventory.

No
Specifies that a volume is not ejected. The server deletes the volume entry from the server library inventory and leaves the volume in the library for use by other applications.

Bulk
For SCSI libraries with multiple entry/exit ports, this specifies that the volume is ejected to the next available entry/exit port.
Note:
For SCSI libraries only, if REMOVE=BULK, the server indicates where the cartridge is located, but it does not require or request a REPLY command.

CHECKLabel
Specifies how or whether the server reads sequential media labels of volumes.
Note:
This parameter does not apply to IBM 349X libraries.

This parameter is optional. The default is YES. Possible values are:

Yes
Specifies that the server attempts to read the media label to verify that the correct volume is being checked out.

No
Specifies that during checkout the media label is not read. This improves performance because the read process does not occur.

FORCE
Specifies whether the server checks out a volume if an input/output (I/O) error occurs when reading the label.
Note:
This parameter does not apply to IBM 349X libraries.
This parameter is optional. The default is NO. Possible values are:

No
The server does not check out a storage volume if an I/O error occurs when reading the label.

Yes
The server checks out the storage volume even if an I/O error occurs.

Examples

Task

Check out the volume named EXB004 from the library named FOREST. Read the label the verify the volume name, but do not move the volume out of the library.

Command:
checkout libvolume forest exb004 checklabel=yes remove=no

Related Commands

Table 30. 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.
LABEL LIBVOLUME Labels a library volume.
QUERY LIBRARY Displays information about one or more libraries.
QUERY LIBVOLUME Displays information about a library volume.
QUERY PROCESS Displays information about background processes.
UPDATE LIBVOLUME Changes the status of a storage volume.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]