Tivoli Header

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 server inventory for an automated library (other than an automated external library). The server cannot use a volume that physically resides in an automated library until that volume has been checked in.

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, you can make a library drive available issuing the DISMOUNT VOLUME command to dismount the volume. After a library drive is available, reissue the CHECKIN LIBVOLUME command.

This command creates a background process that you can cancel 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 Libraries

>>-CHECKIn LIBVolume--library_name------------------------------>
 
                    .-SEARCH--=--No-.
>----+-volume_name--+---------------+-+------------------------->
     +-SEARCH--=--Yes--+-------+------+
     |                 '-| A |-'      |
     '-SEARCH--=----Bulk--------------'
 
                           .-OWNer--=--""----------.
>--STATus--=--+-PRIvate-+--+-----------------------+------------>
              +-SCRatch-+  '-OWNer--=--server_name-'
              '-CLEaner-'
 
   .-CHECKLabel--=--Yes---------.  .-SWAP--=--No------.
>--+----------------------------+--+------------------+--------->
   '-CHECKLabel--=--+-Yes-----+-'  '-SWAP--=--+-No--+-'
                    +-No------+               '-Yes-'
                    '-Barcode-'
 
   .-MOUNTWait--=--60----.
>--+---------------------+--+--------------------------+-------><
   '-MOUNTWait--=--value-'  '-CLEanings--=----number---'
 
A (SEARCH=Yes)
 
|--+-VOLRange--=----volume_name1,volume_name2---+---------------|
   |               .-,-----------.              |
   |               V             |              |
   '-VOLList--=--+---volume_name-+--+-----------'
                 '-FILE:--file_name-'
 
 

Syntax



349X Libraries

>>-CHECKIn LIBVolume--library_name------------------------------>
 
                    .-SEARCH--=--No-.
>----+-volume_name--+---------------+-+------------------------->
     '-SEARCH--=--Yes--+-------+------'
                       '-| A |-'
 
                           .-OWNer--=--""----------.
>--STATus--=--+-PRIvate-+--+-----------------------+------------>
              '-SCRatch-'  '-OWNer--=--server_name-'
 
   .-CHECKLabel--=--Yes-----.  .-DEVType--=--CARTridge-----.
>--+------------------------+--+---------------------------+---->
   '-CHECKLabel--=--+-Yes-+-'  '-DEVType--=--+-CARTridge-+-'
                    '-No--'                  '-3590------'
 
   .-SWAP--=--No------.  .-MOUNTWait--=--60----.
>--+------------------+--+---------------------+---------------><
   '-SWAP--=--+-No--+-'  '-MOUNTWait--=--value-'
              '-Yes-'
 
A (SEARCH=Yes)
 
|--+-VOLRange--=----volume_name1,volume_name2---+---------------|
   |               .-,-----------.              |
   |               V             |              |
   '-VOLList--=--+---volume_name-+--+-----------'
                 '-FILE:--file_name-'
 
 

Syntax



ACSLS Libraries

>>-CHECKIn LIBVolume--library_name------------------------------>
 
                    .-SEARCH--=--No-.
>----+-volume_name--+---------------+-+------------------------->
     '-SEARCH--=--Yes--+-------+------'
                       '-| A |-'
 
                           .-OWNer--=--""----------.
>--STATus--=--+-PRIvate-+--+-----------------------+------------>
              '-SCRatch-'  '-OWNer--=--server_name-'
 
   .-CHECKLabel--=--Yes-----.  .-SWAP--=--No------.
>--+------------------------+--+------------------+------------->
   '-CHECKLabel--=--+-Yes-+-'  '-SWAP--=--+-No--+-'
                    '-No--'               '-Yes-'
 
   .-MOUNTWait--=--60----.
>--+---------------------+-------------------------------------><
   '-MOUNTWait--=--value-'
 
A (SEARCH=Yes)
 
|--+-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 of the storage volume being checked in. This parameter is required if SEARCH equals NO. Do not enter this parameter if the SEARCH parameter equals YES or BULK.

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 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 not valid for checking in a cleaner cartridge. Use STATUS=CLEANER to check in a cleaner cartridge separately from a data cartridge.

OWNer
Specifies which server owns a private volume in a SCSI or 349X library that is shared across a SAN. If this parameter is not specified, the library manager server owns the private volume.
Note:
You can specify an owner only for a single private volume. You cannot specify an owner when you use SEARCH=YES or SEARCH=BULK. You cannot specify an owner for a scratch volume. This allows scratch volumes to always be available to all servers sharing the library.

SEARCH
Specifies whether the server 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.

For SCSI libraries: The server issues a request to have the volume inserted into a cartridge slot in the library or, if available, into an entry port. The cartridge slot or entry port is identified by its element address. See http://www.tivoli.com/support/storage_mgr/tivolimain.html for details on element addresses.

For 349X libraries: The volume could already be in the library, or you could put it into the I/O station when prompted.

Yes
Specifies that the server searches the library for volumes to be checked in. You can use the VOLRANGE or VOLLIST parameter to limit the search.

Notes:

  1. If the library is shared between applications, be cautious when selecting this parameter. The server could examine a volume required by another application. For 349X libraries, the server queries the library manager to determine all volumes that are assigned to the SCRATCH or PRIVATE category and to INSERT category.

  2. For SCSI libraries, do not specify both SEARCH=YES and CHECKLABEL=NO in the same command.

Bulk
Specifies that the server searches the library's entry/exit ports for volumes that can be checked in automatically. This option only applies to SCSI libraries.
Note:
Do not specify both CHECKLABEL=NO and SEARCH=BULK.

VOLRange
Specifies a range of volume names separated by a comma. You can use this parameter to limit the search for volumes to be checked in when you specify SEARCH=YES. If there are no volumes in the library that are within the specified range, the command completes without errors.
Note:
This parameter only applies to 349X, ACSLS, and SCSI libraries. For SCSI libraries, you must also specify CHECKLABEL=BARCODE.

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 a list of volumes. You can use this parameter to limit the search for volumes to be checked in when you specify SEARCH=YES. If there are no volumes in the library that are in the list, the command completes without errors.
Note:
This parameter only applies to 349X, ACSLS, and SCSI libraries. For SCSI libraries, you must also specify CHECKLABEL=BARCODE.
Possible values are:

volume_name
Specifies one or more volumes names that are separated by commas and no intervening spaces . For 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 an 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.

CHECKLabel
Specifies how or whether the server 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. For optical volumes (write-once and rewritable), you must specify YES.
Note:
For SCSI libraries, do not specify both SEARCH=YES and CHECKLABEL=NO in the same command.

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).For 349X and ACSLS libraries, specify NO to avoid loading cartridges into a drive to read the media label. These libraries always return the external label information on cartridges, and TSM uses that information.

Barcode
Specifies that the server reads the barcode label if the library has a barcode reader and the volumes have external barcode labels. 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.

If the barcode reader cannot read the barcode label, or if the tape does not have a barcode label, the server mounts the tape and reads the internal label.

DEVType
Specifies the device type for the volume being checked in. This parameter only applies to and is required for 349X libraries containing both 3490 and 3590 devices. The default is CARTRIDGE. Possible values are:

CARTridge
Specifies that the device type for the volume being checked in is 3490.

3590
Specifies that the device type for the volume being checked in is 3590.

SWAP
Specifies whether the server swaps volumes if an empty library slot is not available. The volume selected for the swap operation (target swap volume) is ejected from the library and replaced with the volume being checked in. The server identifies a target swap volume by checking for an available scratch volume. If none exists, the server identifies the least frequently mounted volume.

This parameter is optional. The default is NO. This parameter only applies if there is a volume name specified in the command. Possible values are:

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

Yes
Specifies that if an empty slot is not available, the server swaps cartridges to check in the volume.

MOUNTWait
Specifies the number of minutes to wait for a storage volume to be mounted. 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. This parameter is optional.

CLEanings
Enter the recommended value for the individual cleaner cartridge (usually indicated on the cartridge). Cleanings apply only to SCSI libraries. 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, and the first cleaner can be checked out and discarded.

Examples

Task

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

Command:
checkin libvolume auto wpdv00 status=scratch

Task

Scan a SCSI library named AUTOLIB1 and, using the barcode reader, look for cleaner cartridge CLNV. Use SEARCH=YES, but limit the search by using the VOLLIST parameter.

Command:
checkin libvolume autolib1 search=yes vollist=cleanv status=cleaner
  cleanings=10 checklabel=barcode 

Task

Scan a 349X library named ABC, and limit the search to a range of unused volumes bar110 to bar130 and put them in scratch status.

Command:
checkin libvolume abc search=yes volrange=bar110,bar130
 status=scratch 

Task

Use the barcode reader to scan a SCSI library named MYLIB for VOL1, and put it in scratch status.

Command:
checkin libvolume mylib search=yes vollist=vol1 status=scratch
 checklabel=barcode

Related Commands

Table 28. Commands Related to CHECKIN LIBVOLUME

Command Description
AUDIT LIBRARY Ensures that an automated library is in a consistent state.
CANCEL PROCESS Cancels a background server process.
CHECKOUT LIBVOLUME Checks a storage volume out of 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.
DISMOUNT VOLUME Dismounts a sequential, removable volume by the volume name.
LABEL LIBVOLUME Labels volumes in manual or automated libraries.
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 ]