Tivoli Storage Manager for Windows: Administrator's Reference

LABEL LIBVOLUME (Label a Library Volume)

Use this command to label tape volumes, or in an automated library, to label the volumes automatically as they are checked in. This command allows the server to use the full-length label with which the volumes are often pre-labeled.

Note:
Use this command only for 349X, ACSLS, SCSI and MANUAL libraries. The LABEL 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 a volume with the DISMOUNT VOLUME command. Once a library drive is available, the LABEL LIBVOLUME command can be reissued. Ensure that a drive is available for the server to process this command.

Privilege Class

To issue this command, you must have system privilege.

Syntax



Manual Library

>>-LABEl LIBVolume--library_name------volume_name--------------->
 
   .-OVERWRITE--=--No------.
>--+-----------------------+-----------------------------------><
   '-OVERWRITE--=--+-No--+-'
                   '-Yes-'
 
 

Syntax



SCSI Library

>>-LABEl LIBVolume--library_name-------------------------------->
 
>----+-volume_name-----------------------------------------------------+---->
     |                                             (1)                 |
     +-SEARCH--=--Yes----+-------+--LABELSource--=-------+-Barcode-+---+
     |                   '-| A |-'                       '-Prompt--'   |
     '-SEARCH--=----Bulk-----------------------------------------------'
 
                                .-OVERWRITE--=--No------.
>--+-------------------------+--+-----------------------+------><
   '-CHECKIN--=--+-SCRatch-+-'  '-OVERWRITE--=--+-No--+-'
                 '-PRIvate-'                    '-Yes-'
 
A (SEARCH=Yes)
 
|--+-VOLRange--=----volume_name1,volume_name2---+---------------|
   |               .-,-----------.              |
   |               V             |              |
   '-VOLList--=--+---volume_name-+--+-----------'
                 '-FILE:--file_name-'
 
 

Notes:

  1. This parameter applies only to SCSI libraries when SEARCH=Yes or SEARCH=Bulk.

Syntax



349X Library

>>-LABEl LIBVolume--library_name-------------------------------->
 
>----+-volume_name-------------------+-------------------------->
     '-SEARCH--=--Yes----+-------+---'
                         '-| A |-'
 
>--+-------------------------+--+---------------------------+--->
   '-CHECKIN--=--+-SCRatch-+-'  '-DEVType--=--+-CARTridge-+-'
                 '-PRIvate-'                  '-3590------'
 
   .-OVERWRITE--=--No------.
>--+-----------------------+-----------------------------------><
   '-OVERWRITE--=--+-No--+-'
                   '-Yes-'
 
A (SEARCH=Yes)
 
|--+-VOLRange--=----volume_name1,volume_name2---+---------------|
   |               .-,-----------.              |
   |               V             |              |
   '-VOLList--=--+---volume_name-+--+-----------'
                 '-FILE:--file_name-'
 
 

Syntax



ACSLS Library

>>-LABEl LIBVolume--library_name-------------------------------->
 
>----+-volume_name-------------------+-------------------------->
     '-SEARCH--=--Yes----+-------+---'
                         '-| A |-'
 
                                .-OVERWRITE--=--No------.
>--+-------------------------+--+-----------------------+------><
   '-CHECKIN--=--+-SCRatch-+-'  '-OVERWRITE--=--+-No--+-'
                 '-PRIvate-'                    '-Yes-'
 
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 that contains the storage volume.

volume_name
Specifies a volume to label.

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 and exit port. TSM identifies the slot or the port by its element address. See http://www.tivoli.com/support/storage_mgr/tivolimain.html for details on element addresses.

For manual libraries, the server issues a request to have the volume inserted into a drive.

Note:
If the specified volume name is already defined in a storage pool or volume history, the volume will not be labeled and a message will be displayed.

CHECKIN
Specifies whether the server checks in the volume. This parameter is optional. The following are possible values:

SCRatch
Specifies that the server checks in the volumes and adds them to the library's scratch pool.

PRIvate
Specifies that the server checks in the volumes and designates them as private. Private volumes are available only when you request them by name.

SEARCH
Specifies that the server searches the library for usable volumes to label. This parameter applies to SCSI, 349X, and ACSLS libraries.

Possible values are:

Yes
Specifies that the server labels only volumes stored in the library, unless the volume is already labeled or its barcode cannot be read.

If you specify the LABELSOURCE=PROMPT option, the volume is moved from its location in the library or in the entry/exit ports to the drive. The server prompts you to issue the REPLY command containing the label string, and that label is written to the tape.

Bulk
Specifies that the server searches the library entry/exit ports for usable volumes to label. This option is only valid for SCSI libraries.

If you specify LABELSOURCE=BARCODE, the volume bar code is read, and the tape is moved from its location in the library or in the entry/exit ports to a drive where the bar-code label is written. After the tape is labeled, it is moved back to its location in the library, to the entry/exit ports, or to a storage slot if the CHECKIN option is specified. For bar-code support to work correctly for libraries supported by Tivoli Storage Manager, the Tivoli Storage Manager server, and the device driver must be at the same level . Bar-code support is available for libraries supported by Tivoli Storage Manager and which use the Tivoli Storage Manager device driver or the RMSS Magstar or LTO Ultrium device driver.

VOLRange

Specifies a range of volume names separated by a comma. Use this parameter to limit the search when you specify SEARCH=YES. This parameter applies to SCSI, 349X, and ACSLS libraries.

Note:
VOLRange is designed to act as a filter for volumes that need to be checked in or labeled. For SCSI libraries, the VOLRANGE parameter requires that LABELSOURCE=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 be processed for the command. Use this parameter to limit the search when you specify SEARCH=YES. This parameter applies to SCSI, 349X, and ACSLS libraries.
Note:
VOLList is designed to act as a filter for volumes that need to be checked in or labeled. For SCSI libraries, the VOLLIST parameter requires that LABELSOURCE=BARCODE is specified.

Possible values are:

volume_name
Specifies the names of one or more values that are 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 an asterisk are ignored. For example, to use volume 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.

LABELSource
Specifies how or whether the server reads sequential media labels of volumes. This option is only valid for SCSI libraries. Specify this parameter only when SEARCH=YES.

Possible values are:

Prompt
Prompts for volume names as necessary.

Barcode
The server attempts to read the bar-code label. If the attempt fails, the server will not label the volume and will display a message.
Note:
For bar-code support to work properly, the appropriate device drivers must be installed for the libraries.

DEVType
Specifies the device type for the volume being checked in. Possible values are:

CARTridge
Specifies that the volume being checked in is for a 3490 device type. The default is CARTRIDGE.

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

OVERWRITE
Specifies whether the server attempts to overwrite existing labels. This parameter is optional. The default is NO. Possible values are:

No
Specifies that the server only labels unlabeled volumes.

Yes
Specifies that the server overwrites existing labels only if both the existing label and the prompted or barcode label are not already defined in any the server storage pool or volume history list.

Examples

Task

Label tapes in a SCSI library named AUTO automatically as you are checking the volumes in.

Command:
label libvolume auto checkin=scratch search=yes 
labelsource=barcode overwrite=yes

Task

Label 3 volumes from bar11a to bar13a in a SCSI library named ABC..

Command:
label libvolume abc checkin=scratch search=yes 
volrange=bar11a,bar13a labelsource=barcode

The 3 volumes are labeled: bar11a, bar12a, bar13a.

Related Commands

Table 149. Commands Related to LABEL 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.
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.
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 ]