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--libraryname---------------------------------->
 
      .-LIBType--=--MANUAL---------------.
>-----+----------------------------------+---------------------><
      '-LIBType--=--+-MANUAL-----------+-'
                    +-SCSI--| A |------+
                    +-349X--| B |------+
                    +-EXTernal--| C |--+
                    '-ACSLS--| D |-----'
 
A
 
|---DEVIce--=--device_name--------------------------------------|
 
B
 
    .-SCRATCHCATegory--=--301-----.
|---+-----------------------------+----------------------------->
    '-SCRATCHCATegory--=--number--'
 
      .-PRIVATECATegory--=--300-----.
>-----+-----------------------------+---DEVIce--=--device_name--|
      '-PRIVATECATegory--=--number--'
 
C
 
|---EXTERNALManager--=--path_name-------------------------------|
 
D
 
|---ACSID--=--number--------------------------------------------|
 

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.

SCSI
Specifies that the library is automated via a SCSI autochanger device. When volumes need to be mounted on drives that reside in this type of library, TSM uses the robotic autochanger device to automatically carry out the required actions. You must also specify a device name.

349X
Specifies that the library is an IBM 3494 or 3495 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').

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.

ACSLS
Specifies that the library is an STK library that is controlled by STK Automated Cartridge System Library Software (ACSLS). When you select this parameter, you must also specify the Automated Cartridge System (ACS) ID.

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/01b as the device name. This parameter is required for SCSI and 349X library types, but is not valid for MANUAL, EXTERNAL, or ACSLS 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.

For the IBM 3494, the device name is the symbolic name you entered in the configuration file for the library. For devices other than the 3494, the special file names are shown here. In this table, x denotes any number from 0 to 7.

Special File Name Description
/dev/rmt/xmt Used by all TSM-supported tape drives (not supported by IBM hardware device drivers)
/dev/rmt/xlb Used by SCSI-attached libraries that are supported by the TSM device driver
/dev/rmt/xop Used by all TSM-supported optical drives
/dev/rmtxst Used by the GENERICTAPE and 3570/3590 device types
/dev/rmtxsmc Used by 3570 and 3575 libraries, and used to define the Automatic Cartridge Facility feature of the IBM 3590 B11 as a library

See the DEVICE parameter description in the DEFINE DRIVE command and the Administrator's Guide for additional information on device 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/01b.

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

Task 3

Define a library named ACSLIB with a library type of ACSLS and an acsid of 1.

Command:
define library acslib libtype=acsls acsid=1

Related Commands

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