Tivoli Storage Manager for HP-UX 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 available, automated library. This command informs the server that a volume is available for use. The server 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 drive 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----------------->
 
>-----STATus--=--+-PRIvate------+------------------------------->
                 +-SCRatch------+
                 |         (1)  |
                 '-CLEaner------'
 
      .-SEARCH--=--No------------.
>-----+--------------------------+------------------------------>
      '-SEARCH--=--+-No--------+-'
                   +-Yes-------+
                   |      (2)  |
                   '-Bulk------'
 
>-----+---------------------------------------------+----------->
      '-VOLRange--=----volume_name1,volume_name2----'
 
>-----+-------------------------------------+------------------->
      |                .-,-------------.    |
      |                V               |    |
      '-VOLList--=--+----volume_name---+-+--'
                    '-FILE:--file_name---'
 
      .-CHECKLabel--=--Yes--------------.
>-----+---------------------------------+----------------------->
      '-CHECKLabel--=--+-Yes----------+-'
                       +-No-----------+
                       |         (3)  |
                       '-Barcode------'
 
                                 .-SWAP--=--No------.
>-----+----------------------+---+------------------+----------->
      '-DEVType--=----3590---'   '-SWAP--=--+-No--+-'
                                            '-Yes-'
 
      .-MOUNTWait--=--60-----.
>-----+----------------------+---+---------------------------+-><
      '-MOUNTWait--=--value--'   '-CLEanings--=----number----'
 

Notes:

  1. This parameter applies only to SCSI libraries.

  2. This parameter applies only to SCSI libraries.

  3. This parameter applies only to SCSI libraries.

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

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 within the library, or if available, inserted into the library's entry port. If the cartridge slot is used, it is identified by its element address. See http://www.tivoli.com/support/storage_mgr/tivolimain.html for details on element addresses.

Yes
Specifies that the server searches the library for volumes to be checked in. 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 control unit to determine all volumes that are assigned to the specified library's SCRATCH or PRIVATE category and all the volumes that are assigned to the library's 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. Use this parameter to limit the search when you specify SEARCH=YES.

Note:This only applies to 349X, ACSLS and SCSI libraries. VOLList is designed to filter only the volumes to be checked in or labeled. For SCSI libraries, this parameter requires that CHECKLabel=BARCODE.

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. Use this parameter to limit the search when you specify SEARCH=YES. Possible values are:

volume_name
Specifies the names of one or more values used for the command. Example: VOLLIST=TAPE01,TAPE02.
Note:This applies to 349X, ACSLS and SCSI libraries. VOLList is designed to filter only the volumes to be checked in or labeled. For SCSI libraries, this parameter 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, 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.

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).
Note:For SCSI libraries, do not specify both SEARCH=YES and CHECKLABEL=NO in the same command.

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 is unable to read a given barcode label, or if a tape does not have a barcode label, the check-in command will load that tape in a drive to read the internal label.

DEVType
Specifies the device type for the volume being checked in. This parameter applies to 349X libraries containing 3590 devices. Possible values are:

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

SWAP
Specifies whether the server swaps cartridges, if an empty library slot is not available. 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.
Note: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 exist, the server identifies the least frequently mounted 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 applies 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 1

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

Command:
checkin libvolume auto wpdv00 status=scratch

Task 2

Scan the library for all unused volumes and put them in scratch status.

Command:
checkin libvolume abc search=yes status=scratch 

Task 3

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

Command:
checkin libvolume mylib vol1 search=yes 
status=scratch checkl=b

Related Commands

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