Administrator's Reference

CHECKIN LIBVOLUME (Check a Storage Volume into a Library)

Use this command to add a sequential access storage volume or a cleaning tape to the TSM inventory for an available, automated library. This command informs TSM that a volume is available for use. TSM does not use a volume that physically resides in an automated library until the volume has been checked in via this command.

Note:The CHECKIN 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 must be made available by dismounting the drive with the DISMOUNT VOLUME command. Once a library drive is available, the CHECKIN 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

>>-CHECKIn LIBVolume--library_name--volume_name----------------->
 
      .-SEARCH--=--No-------.
>-----+---------------------+----------------------------------->
      '-SEARCH--=--+-No---+-'
                   +-Yes--+
                   '-Bulk-'
 
>-----+-------------------------------------+------------------->
      '-VOLRange--=----volname1,volname2----'
 
>-----STATus--=--+-PRIvate-+------------------------------------>
                 +-SCRatch-+
                 '-CLEaner-'
 
>-----+-------------------------------------+------------------->
      |                .-,-------------.    |
      |                V               |    |
      '-VOLList--=--+----volume_name---+-+--'
                    '-FILE:--file_name---'
 
      .-CHECKLabel--=--Yes---------.   .-SWAP--=--No------.
>-----+----------------------------+---+------------------+----->
      '-CHECKLabel--=--+-Yes-----+-'   '-SWAP--=--+-No--+-'
                       +-No------+                '-Yes-'
                       '-Barcode-'
 
      .-MOUNTWait--=--60--------------.
>-----+-------------------------------+------------------------->
      '-MOUNTWait--=--mountwaitvalue--'
 
>-----+----------------------+---+---------------------------+-><
      '-DEVType--=----3590---'   '-CLEanings--=----number----'
 

Parameters

library_name (Required)
Specifies the name of the library.

volume_name
Specifies the volume name of the storage volume being checked in. Do not enter this parameter if the SEARCH parameter equals YES or BULK. This parameter is required if SEARCH equals NO.

SEARCH
Specifies whether TSM searches the library to find volumes that were not checked in. This parameter is optional. The default is NO. Possible values are:

No
Specifies that only the named volume is checked into the library.

Yes
Specifies that TSM searches the library for volumes to be checked in.
Note:If the library is shared between applications, be cautious when selecting this parameter. TSM could examine a volume required by another application.

Bulk
Specifies that TSM searches the library's Entry/Exit ports for volumes that can be checked in automatically.
Note:Do not specify both CHECKLABEL=NO and SEARCH=BULK.

VOLRange

Specifies a range of volume names separated by a comma. Use this parameter to limit the search when you specify SEARCH=YES.

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 be processed for the command. Possible values are:

volume_name
Specifies the names of one or more values used for the command. Example: VOLLIST=TAPE01,TAPE02.
Note:VOLList is designed to filter only the volumes to be checked in or labeled, and it requires that CHECKLabel=BARCODE.

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 named TAPEVOL that contains the lines in the following example:
TAPE01
TAPE02
TAPE03

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

Note:The file name is case sensitive.

STATus (Required)
Specifies the volume status. Possible values are:

PRIvate
Specifies that the volume is a private volume that is mounted only when it is requested by name.

SCRatch
Specifies that the volume is a new scratch volume. This new scratch volume can be mounted to satisfy scratch mount requests during either data storage operations or export operations.

CLEaner
Specifies that the volume is a cleaner cartridge and not a data cartridge. The CLEANINGS parameter is required for a cleaner cartridge, and must be set to the number of cleaner uses.
Note:CHECKLABEL=YES is invalid for checking in a cleaner. A cleaner cartridge must be checked in separately from a data cartridge by using STATUS=CLEANER.

CHECKLabel
Specifies how or whether TSM should read sequential media labels of volumes. This parameter is optional. The default is YES.

Possible values are:

Yes
Specifies that an attempt is made to read the media label during check-in.

No
Specifies that the media label is not read during check-in. However, suppressing label checking can result in future errors (for example, either a wrong label or an improperly labeled volume can cause an error).

Barcode
Specifies that TSM reads the barcode label. You can decrease the check-in time by using the barcode.

This parameter applies only to SCSI libraries. To use this option, you must specify SEARCH=YES.

SWAP
Specifies whether TSM swaps cartridges if an empty library slot is not available. This parameter is optional. The default is NO. Possible values are:

No
Specifies that TSM checks in the volume only if an empty slot is available.

Yes
Specifies that if an empty slot is not available, TSM swaps cartridges to check in the volume.
Note:The volume selected for the swap operation (target swap volume) is ejected from the library and replaced with the volume being checked in. TSM identifies a target swap volume by checking for an available scratch volume. If none exist, TSM identifies the least frequently mounted volume.

MOUNTWait
Specifies the number of minutes to wait for a storage volume to be mounted. This parameter is optional. If the volume is not mounted within the specified amount of time, the mount request is canceled. Specify an integer from 0 to 9999. The default is 60 minutes.

DEVType
Specifies the device type for the volume you are checking in. This parameter applies only when SEARCH=YES and a library contains both 3490 and 3590 device types. When you are checking in volumes on a 349X library, you must specify DEVTYPE. Possible values are:

3590
Specifies that the volume is for a 3590 device type.

CLEanings
Specifies the number of cleaner uses. This parameter is required if STATUS=CLEANER.
Note:If more than one cleaner is checked into the library, only one will be used until its CLEANINGS value decreases to zero. Another cleaner will then be selected by TSM, and the first cleaner can be checked out and discarded.

Examples

Task 1

Check in the volume named WPDV00 into the library named AUTO.

Command:
checkin libvolume auto wpdv00 status=scratch

Related Commands

Table 28. Commands Related to CHECKIN LIBVOLUME

Command Description
AUDIT LIBRARY Ensures that an automated library is in a consistent state.
CHECKOUT LIBVOLUME Checks a storage volume out of an automated library.
DEFINE LIBRARY Defines an automated or manual library.
QUERY LIBRARY Displays information about one or more libraries.
QUERY LIBVOLUME Displays information about a library volume.
UPDATE LIBVOLUME Changes the status of a storage volume.
LABEL LIBVOLUME Labels a library volume.


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