Administrator's Reference

CHECKIN LIBVOLUME (Check a Storage Volume into a Library)

Use the CHECKIN LIBVOLUME command to add a sequential access storage volume to ADSM's inventory for an automated library. The CHECKIN LIBVOLUME command informs the ADSM server that a volume is available for use. The server does not use any volumes that physically reside in an automated library until a volume has been checked in via the CHECKIN LIBVOLUME command.

If you include the DEVCONFIG option in the dsmserv.opt file, the files you specify with that option are automatically updated with the results of 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. A library drive must be made available, if necessary, 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

                                           (3)
>>-CHECKIn LIBVolume--libraryname--volname---------------------->
 
                            .-CHECKLabel--=--Yes--------------.
>---STATus--=--+-PRIvate-+--+---------------------------------+->
               '-SCRatch-'  '-CHECKLabel--=--+-Yes---------+--'
                                             +-No----------+
                                             |         (3) |
                                             '-Barcode-----'
 
     .-SWAP--=--No-------.
>----+-------------------+--VOLRange--=--+-volname1-+----------->
     '-SWAP--=--+-No--+--'               '-volname2-'
                '-Yes-'
 
    .-MOUNTWait--=--60---------------.
>---+--------------------------------+-------------------------->
    '-MOUNTWait--=--mountwaitvalue---'
 
     .-SEARCH--=--No------------.
>----+--------------------------+------------------------------->
     '-SEARCH--=--+-No-------+--'
                  +-Yes------+
                  |      (2) |
                  '-Bulk-----'
 
               (1)
     .-DEVType------=--CARTridge------.
>----+--------------------------------+------------------------><
     |         (1)                    |
     '-DEVType------=--+-CARTridge-+--'
                       '-3590------'

1	The DEVTYPE parameter only applies to 349X libraries containing 3590 devices.
2	Do not enter a volume name when the SEARCH parameter equals yes. If a volume name is entered under this condition, an error is issued.
3	For SCSI libraries only, you should usually specify SEARCH= YES and no volume name. For performance reasons it is not recommended to mix volumes with barcode labels and volumes without barcode labels in a library device.

Parameters

libraryname

Specifies the name of the library where the storage volume is to be located. This parameter is required.

volname

Specifies the volume name of the storage volume being checked in. Do not enter this parameter if the SEARCH parameter equals yes. This parameter is required under any other condition.

STATus=voltype

Specifies the status that is to be assigned to the storage volume being checked in. This keyword is required. Possible values are:

PRIvate: Specifies that the volume is not part of the library's pool of scratch volumes. A PRIVATE volume is only mounted when its volume name is explicitly requested.
SCRatch: Specifies that the storage 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.

CHECKLabel=checkvalue

Specifies how or whether ADSM should read sequential media labels of volumes during CHECKIN LIBVOLUME command processing. This parameter is optional. For SCSI devices, setting the checkvalue to Barcode allows ADSM to utilize, if available, any barcode information. You can suppress label checking by setting the checkvalue to NO. Suppressing label checking, however, can result in future errors (for example, either a wrong label or an improperly labeled volume can cause an error). The errors are resolved during AUDIT LIBRARY command processing. The default value is YES.

For optical volumes being checked into an automated library, you must take the default (CHECKLABEL=YES). ADSM must read the label to determine whether the volume is rewritable (OPTICAL device type) or write-once read-many (WORM device type). Possible values are:

Yes

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

No

Specifies that during check-in the media label is not read. Selecting this value can result in future errors that are resolved through AUDIT LIBRARY command processing.

Barcode

Specifies to use the barcode storage volume label. You can decrease the checkin time by using the barcode.

Barcode is applicable to libraries with LIBTYPE=SCSI only. This option can only be used with SEARCH=YES.

To use the barcode reader for the CHECKIN LIBVOLUME command (with SEARCH=YES specified), include the parameter CHECKLABEL=BARCODE (abbreviated as CHECKL=B) in the command following the positional parameters. For example:

CHECKIN LIBVOL MYLIB SEARCH=YES STATUS=SCRATCH CHECKL=B

This parameter will cause a low-level audit of the library, including a barcode scan of all cartridges. The CHECKIN LIBVOLUME command will then use the barcode information as the label of the volume to check-in the cartridges.

This value for the CHECKLABEL parameter overrides the default value of YES, which has the result of loading each cartridge into a drive and reading the label directly from the tape media itself.

If the scanner is unable to read a given barcode label, or if a tape does not have a barcode label, the checkin will load that tape in a drive to read the label. This is consistent with the default action of these commands and is necessary for their proper operation.

It should also be noted that CHECKLABEL=NO is invalid for CHECKIN (with SEARCH=YES). The above barcode information applies to SCSI libraries, but does not apply to 3494-class libraries.

SWAP=swapvalue

Specifies whether ADSM will initiate a swap operation when an empty library slot is not available during CHECKIN LIBVOLUME command processing. This parameter is optional. The default value is NO. Possible values are:

No: Specifies that if an empty slot is not available, the CHECKIN LIBVOLUME command is rejected.
Yes: Specifies that if an empty slot is not available, ADSM initiates a swap operation. The volume selected (target swap volume) for the swap operation is ejected from the library and replaced with the volume being checked in. ADSM determines which volume is the target swap volume by checking for (1) any available scratch volumes, and if this is not successful, then (2) the least frequently mounted volume.

You can override swap processing by selecting a volume in the library and then explicitly issuing the CHECKOUT LIBVOLUME command prior to the CHECKIN LIBVOLUME command.

VOLRange=volrangevalue

Specifies the volume range for this command. The volname format can be any combination of alphanumeric characters. Basically, it contains prefix, incremental, and suffix areas.

The prefix and suffix areas are optional. If they are used, they are identical alphanumeric characters between volname1 and volname2. Prefix area begins at the first character and ends at the first non-compare numeric character. The incremental area is numeric characters. The incremental area begins at the first non-compare character and ends at the next alpha character. The incremental numeric of volname2 must be greater than the numeric of volname1. The suffix area begins at the end of the incremental area. If all characters of volname1 and volname2 are identical, then all characters are prefix area and only one volume is in the range. The possible combination for volume ranges are: AnA, nA, An, n, or A.

A equals the prefix or suffix area where alphanumeric characters of volname1 and volname2 are identical.

n equals the numeric incremental area.

When VOLRange is specified, SEARCH=YES must also be specified.

You can override swap processing by selecting a volume in the library and then explicitly issuing the CHECKOUT LIBVOLUME command prior to the CHECKIN LIBVOLUME command.

MOUNTWait=mountwaitvalue

Specifies the maximum length of time, in minutes, to wait for a storage volume to be mounted. This parameter is optional. If the mount request is not satisfied within the specified amount of time, the mount request is canceled. The default value is 60 minutes. You can specify an integer in the range of 0 to 9999, inclusive.

SEARCH=searchvalue

Specifies whether ADSM searches the library to see if the volume has been previously checked in. This parameter is optional. The default value is NO. Possible values are:

No

Specifies that only the named volume is to be checked into the library. The server issues a mount request to have the volume inserted into a cartridge slot within the library or if available, inserted into the library's entry/exit port. If the cartridge slot is used, it is identified by its element address. See ADSM Administrator's Guide for details on element addresses.

Yes

Specifies that ADSM should search the library for volumes that can be checked in automatically.

If the library is shared between applications, be cautious when selecting this parameter. ADSM could examine a volume required by another application.

For SCSI libraries, the server scans all of the slots in the library for volumes that have not previously been checked in. If a volume meets this requirement and contains a valid volume label, it is checked in automatically.

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 volumes that have just been inserted into the library's convenience or bulk I/O station. Each of these volumes is tested for a valid media label and then checked into the library automatically. For additional information about categories, see the DEFINE LIBRARY command and the ADSM Administrator's Guide.

Bulk

Specifies that ADSM should search the library's Entry/Exit ports for volumes that can be checked in automatically.

For SCSI libraries, the server scans all of the Entry/Exit ports in the library for volumes. If a volume is found that contains a valid volume label, it is checked in automatically. Please note that the CHECKLABEL option NO is invalid with this SEARCH option. When using the CHECKLABEL=YES option, the volume is moved from the Entry/Exit ports to the drive where the label is read. After reading the label, the tape is moved from the drive to a storage slot. When using the CHECKLABEL=BARCODE, the volume's barcode is read and the tape is moved from the Entry/Exit port to a storage slot. For barcode support to correctly work, the ADSM device drivers must be installed for ADSM controlled libraries.

DEVType=devtypevalue

This parameter only applies to 349X libraries containing 3590 devices. This parameter allows you to specify the device type for the volume being checked in. This parameter is optional. The default is CARTRIDGE. Possible values are:

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

Usage Notes

When the server cannot find a volume it needs for a client operation in an automated library, the server will request that the volume be checked in. If the volume is available, check the volume in. If the volume is not available (for example, lost or destroyed), update the access mode of the volume to UNAVAILABLE by using the UPDATE VOLUME command. Cancel the server's request for check-in by using the CANCEL REQUEST command. (To get the ID of the request to cancel, use the QUERY REQUEST command.) Do not cancel the client process that caused the request.

Examples

Task

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

Command:: checkin libvolume auto wpdv00 status=scratch

Related Commands

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

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.

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