Tivoli Storage Manager for Windows: 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 volume with the DISMOUNT VOLUME command. After a 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



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--'
 
 

Syntax



ACSLS Library

>>-CHECKOut LIBVolume--library_name----+-volume_name-+---------->
                                       '-| A |-------'
 
   .-REMove--=--Yes-----.  .-CHECKLabel--=--Yes-----.
>--+--------------------+--+------------------------+----------->
   '-REMove--=--+-Yes-+-'  '-CHECKLabel--=--+-Yes-+-'
                '-No--'                     '-No--'
 
   .-FORCE--=--No------.
>--+-------------------+--+-------------------+----------------><
   '-FORCE--=--+-No--+-'  '-CAP--=----x,y,z---'
               '-Yes-'
 
A 
 
|--+-VOLRange--=----volume_name1,volume_name2---+---------------|
   |               .-,-----------.              |
   |               V             |              |
   '-VOLList--=--+---volume_name-+--+-----------'
                 '-FILE:--file_name-'
 
 

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.

VOLRange

Specifies a range of volume names separated by a comma. This parameter only applies to automated cartridge system library software (ACSLS) libraries. Use this parameter to specify multiple volumes to check out.

You can specify only volume names that can be numerically incremented. In addition to the incremental area, a volume name can include an alphanumeric prefix and an alphanumeric suffix, for example:

Parameter Description
volrange=bar110,bar130 The 21 volumes are checked in: bar110, bar111, bar112,...bar129, bar130.
volrange=bar11a,bar13a The 3 volumes are checked in: bar11a, bar12a, bar13a.
volrange=123400,123410 The 11 volumes are checked in: 123400, 123401, ...123409, 123410.

VOLList
Specifies the list of volumes to process for the command. This parameter only applies to ACSLS Libraries. Use this parameter to specify multiple volumes to check out.

Possible values are:

volume_name
Specifies the names of one or more values used for the command. Example: VOLLIST=TAPE01,TAPE02.

FILE:file_name
Specifies the name of a file that contains a list of volumes for the command. In the file, each volume name must be on a separate line. Blank lines and comment lines that begin with a asterisk are ignored. For example, to use volumes TAPE01, TAPE02 and TAPE03, create a file, TAPEVOL, that contains these lines:
TAPE01
TAPE02
TAPE03

You can specify the volumes for the command as follows: VOLLIST=FILE:TAPEVOL.

Note:
The file name is case-sensitive.

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:
If you specify REMOVE=YES, the server prompts you to remove the cartridge from a specific slot and issue a REPLY command. If you specify REMOVE=BULK, the server indicates where the cartridge is located. It does not request or require a REPLY command.

For both REMOVE=YES or REMOVE=BULK, the server performs the actions shown in the table below.

Table 29. How TSM Responds to REMOVE=YES or REMOVE=BULK

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's 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.

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 REMOVE=BULK, TSM 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. 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.

CAP
Specifies which Entry/Exit Port to use for ejecting volumes if you specify REMOVE=YES. This parameter only applies to ACSLS libraries.

To display valid cartridge access port (CAP) identifiers (x,y,z) in the library, issue the QUERY CAP command with ALL specified from the automated cartridge system system administrator (ACSSA) console on the ACSLS server host. The default value is (-1,-1,-1), in which case the ACSLS server will choose any available CAP with a non-zero priority. This parameter is optional. With CAP=x,y,z specified, each identifier corresponds to:

x
The Automated Cartridge System (ACS) ID. This identifier can be a number between 0-126.

y
The Library Storage Module (LSM) ID. This identifier can be a number between 0-23.

z
The CAP ID. This identifier can be a number between 0-2.

Refer to your Storage Tek documentation for more information.

Examples

Task

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

Command:
checkout libvolume forest exb004

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 ]