Tivoli Storage Manager for HP-UX Administrator's Reference

DEFINE LIBRARY (Define a Library)

Use this command to define a library. A library is a collection of one or more drives, and possibly robotic devices (depending on the library type), which can be used to access storage volumes.

Privilege Class

To issue this command, you must have system privilege or unrestricted storage privilege.

Syntax

>>-DEFine LIBRary--library_name--------------------------------->
 
      .-LIBType--=--MANUAL---------------------------.
>-----+----------------------------------------------+---------><
      '-LIBType--=--+-MANUAL-----------------------+-'
                    +-SCSI--| DEVICE1 |------------+
                    +-349X--| DEVICE8 |--| 349X |--+
                    +-EXTernal--| EXTERNAL |-------+
                    '-SHAREd--| SHARED |-----------'
 
DEVICE1
 
|---DEVIce--=--device_name--------------------------------------|
 
DEVICE8
 
               .-,-------------------.
               V              (1)    |
|---DEVIce--=-----device_name--------+--------------------------|
 
349X
 
    .-SCRATCHCATegory--=--301-----.
|---+-----------------------------+----------------------------->
    '-SCRATCHCATegory--=--number--'
 
      .-PRIVATECATegory--=--300-----.
>-----+-----------------------------+---------------------------|
      '-PRIVATECATegory--=--number--'
 
EXTERNAL
 
|---EXTERNALManager--=--path_name-------------------------------|
 
SHARED
 
    .-SHAREd--=--No------.
|---+--------------------+--------------------------------------|
    '-SHAREd--=--+-No--+-'
                 '-Yes-'
 

Notes:

  1. You can specify one to eight device names by separating the names with commas and no intervening spaces.

Parameters

library_name (Required)
Specifies the name of the library to be defined. The maximum length of this name is 30 characters.

LIBType
Specifies the type of library that is being defined. The default is MANUAL. Possible values are:

MANUAL
Specifies that the library is not automated. When volumes need to be mounted on drives that reside in this type of library, messages are sent to mount operators to inform them of the required action. This type of library is used with stand-alone drives.

349X
Specifies that the library is an IBM 3494 Tape Library Dataserver. When you select this parameter, you must enter the device name, and you can choose SCRATCHCATEGORY or PRIVATECATEGORY. Since TSM uses decimal values for the category number and the 349X uses hexidecimal values, both values are provided in the following descriptions.

SCRATCHCATegory
Specifies the category number to be used for scratch volumes in the library. This parameter is optional. The default value is 301 (X'12D'). You can specify a number from 1 to 65279.

When support for 3590 drives in 349X libraries is enabled (by the ENABLE3590LIBRARY option in the server options file), TSM automatically creates two scratch categories when the library is defined. The first category is for 3490 scratch volumes, and is either the value specified with this parameter, or the default 301 (X'12D'). The second scratch category is for 3590 scratch volumes, and is one greater than the value specified with the SCRATCHCATEGORY parameter. The default value for this second category is 302 (X'12E'). Only the 3590 drive is supported on HP-UX. The 3490 scratch category defined here is not actually used, but the scratch cataegory+1 is used for the 3590. For example if the scratch category is 301 then the category used for the 3590 is 302.

Attention: When you enable 3590 support for a 3494 library shared between TSM and other applications, data loss can occur if TSM creates a duplicate category for 3590 scratch volumes.

PRIVATECATegory
Specifies the category number for private volumes that must be mounted by name. This parameter is optional. The default value is 300 (X'12C'). You can specify a number from 1 to 65279.

For more information on specifying a category number, see Administrator's Guide.

EXTernal
Specifies that the library is managed by an external media management system. This library type does not support drive definitions via the DEFINE DRIVE command. Rather, the external media management system identifies the appropriate drive for media access operations. If you select this parameter, you must also enter the following parameter:

EXTERNALManager
Specifies the location of the external library manager where TSM can send media access requests. This parameter is required.

ACSID
Specifies the number of this STK library assigned by the ACSSA (Automatic Cartridge System System Administrator). This can be a number from 1 to 64. Issue QUERY ACS on your system to get the number for your library ID. See your STK documentation for more information.

DEVIce
Specifies the names of the devices that access the library's robotic mechanism. For example, you might specify /dev/rmt/lb0 as the device name. This parameter is required for SCSI and 349X library types, but is not valid for either MANUAL or EXTERNAL libraries. If the library type is SCSI, only one device name is allowed. If the library type is 349X, you can specify 1 to 8 device names by separating the names with commas and no intervening spaces.

TSM needs the device's file name to work with removable media devices.

See the DEVICE parameter description in the DEFINE DRIVE command and the Administrator's Guide for additional information on device names.

To identify and work with removable media devices, TSM needs each device's name, the special file name. After you configure the device drivers for the tape drives supported by the standard HP-UX device drivers, the operating system automatically assigns the special file names during system start-up. A single drive can have multiple special file names, depending on the format and recording density that the drive supports.

Select the device name to use in defining the drive to TSM based on the format and density that you want TSM to use. For example, one device may have all of the following special file names:

Examples

Task 1

Define a library named MANLIB with the library type of MANUAL.

Command:
define library manlib libtype=manual

Task 2

Define a library named EZLIFE with a library type of SCSI and a device name of /dev/rmt/lb0.

Command:
define library ezlife libtype=scsi device=/dev/rmt/lb0

Related Commands

Table 55. Commands Related to DEFINE LIBRARY

Command Description
AUDIT LIBRARY Ensures that an automated library is in a consistent state.
DEFINE DRIVE Assigns a drive to a library.
DELETE LIBRARY Deletes a library.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more libraries.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE LIBRARY Changes the attributes of a library.


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