Tivoli Storage Manager for HP-UX 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.

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. If necessary, a library drive may be made available by dismounting the drive with the DISMOUNT VOLUME command. After a library is available, the CHECKOUT LIBVOLUME command can be reissued.
This command creates a background process that can be canceled with the CANCELPROCESS 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

                                                     (1)
>>-CHECKOut LIBVolume--library_name------volume_name------------>
 
      .-REMove--=--Yes-----------.   .-CHECKLabel--=--Yes-----.
>-----+--------------------------+---+------------------------+->
      '-REMove--=--+-Yes-------+-'   '-CHECKLabel--=--+-Yes-+-'
                   +-No--------+                      '-No--'
                   |      (2)  |
                   '-Bulk------'
 
      .-FORCE--=--No------.
>-----+-------------------+------------------------------------><
      '-FORCE--=--+-No--+-'
                  '-Yes-'
 

Notes:

  1. This parameter is required for SCSI and 3494 libraries.

  2. This parameter only applies to SCSI libraries.

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 whether the server ejects a volume from the library. 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.
Note:There is a difference between the REMOVE=YES and REMOVE=BULK options. REMOVE=YES prompts the user to remove the cartridge and issue the REPLY command. REMOVE=BULK informs the user to remove the cartridge from a specific slot.

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:The server issues a message stating that the tape volume should be removed from the Entry/Exit port.

CHECKLabel
Specifies how or whether the server reads sequential media labels of volumes. 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. 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.

Command:
checkout libvolume forest exb004

Related Commands

Table 28. 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 ]