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--| A |------+
                    +-349X--| B |------+
                    +-SHAREd--| C |----+
                    +-EXTernal--| D |--+
                    +-ACSLS--| E |-----+
                    '-RSM--| F |-------'
 
A (SCSI)
 
                              .-SHAREd--=--No------.
|---DEVIce--=--device_name----+--------------------+------------|
                              '-SHAREd--=--+-Yes-+-'
                                           '-No--'
 
B (349X)
 
    .-SCRATCHCATegory--=--301-----.
|---+-----------------------------+----------------------------->
    '-SCRATCHCATegory--=--number--'
 
      .-PRIVATECATegory--=--300-----.
>-----+-----------------------------+---DEVIce--=--device_name--|
      '-PRIVATECATegory--=--number--'
 
C (SHARED)
 
|---PRimarylibmanager--=--pservernname-------------------------->
 
>-----+--------------------------------------+------------------|
      '-SEcondarylibmanager--=--sservername--'
 
D (EXTERNAL)
 
|---EXTERNALManager--=--path_name-------------------------------|
 
E (ACSLS)
 
|---ACSID--=--number--------------------------------------------|
 
F  (RSM)
 
|---MEDIAType--=--"MEDIAType"-----------------------------------|
 

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. This parameter is optional. The default is MANUAL. Possible values are:

MANUAL
Specifies that the library type 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.

SHAREd
Specifies whether this library is shared with other TSM servers in a storage area network (SAN). The default is NO.

No
Specifies that the library is not shared with other TSM servers. This is the default.

YES
Specifies that this library can be shared with other TSM servers.
Note:When defining a shared library on the client TSM server, ensure that the library name agrees with the server library name.

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

Note:When you enable 3590 support for a 3494 library sharing TSM and other applications or systems, you could lose data if duplicate volumes are created.

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.

SHAREd
Specifies that the library is shared with another TSM server over a storage area network (SAN) or a dual SCSI connection to library drives. When you select this parameter, you must specify the PRIMARYLIBMANAGER.

PRimarylibmanager (Required)
Specifies the name of the server that is responsible for controlling access to library resources. You must define this server with the DEFINE SERVER command before you can use it for a PRIMARYLIBMANAGER.

SEcondarylibmanager
Specifies the name of the server that will be responsible for controlling access to library resources if the primary library manager server becomes unavailable. You must define this server with the DEFINE SERVER command before you can use it for a SECONDARYLIBMANAGER. This parameter is optional.

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 (Required)
Specifies the location of the external library manager where TSM can send media access requests.

ACSLS (LibAttach)
Specifies that the library is a 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. Refer to your Storage Tek documentation for installation of the Storage Tek LibAttach Service.

ACSID (Required)
Specifies the number of this STK library that is 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.

RSM
Specifies that the library is integrated with Windows NT Removable Storage Management (RSM). This library type allows TSM to share libraries with other applications that use RSM. When the first RSM library is defined, it contains no media or media type, but it is a holding library for all other TSM media pools. When you create a library type of RSM, the corresponding media pool is named TSM\libraryname. The device class that is associated with this library must have a device type of GENERICTAPE. Use the NT System Monitor to view the contents of the RSM database and included media pools. You can create more than one RSM library type if each libraryname is unique.
Note:You can delete RSM libraries, but you cannot update them.

"MEDIAType" (Required)
Specifies the Windows NT media type. The Windows NT System Monitor displays these under media pools. You must use quotation marks ("") around these media types because of embedded spaces. For example, "4mm DDS" is a valid Windows NT media type. This media type is valid only for tape.

DEVIce
Specifies the names of the devices that access the library's robotic mechanism. 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-8 device names by separating the names with commas and no intervening spaces. The device name is a symbolic name that is specified in the c:\winnt\ibmatl.conf file.

For devices supported by either the ADSMSCSI driver or Windows NT drivers, use an alias name to refer to the devices when using TSM. The alias name replaces the real ADSMSCSI name or Windows NT name for a device in TSM commands and screens.

An alias name has the form mtx.y.z.n or lbx.y.z.n. The mt indicates the device is a tape device and the lb indicates the device is the controller for a tape autochanger or an automated library. The alias can be abbreviated. Some examples follow:

mt3
Tape drive at SCSI ID 3, LUN 0 on bus 0, port 0

lb4.1
Library at SCSI ID 4, LUN 1 on bus 0, port 0

mt5.0.1
Tape drive at SCSI ID 5, LUN 0, bus 1, port 0
For more information, see the DEVICE parameter of the DEFINE DRIVE command or the Administrator's Guide.

Examples

Task

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

Command:
define library manlib libtype=manual

Task

Define a library named EZLIFE with a library type of SCSI. For this example assume that you are using the ADSMSCSI device driver. The device SCSI ID is 3, with a logical unit number (LUN) of 0 on path 0, port 0; thus, the device name is: lbt3.0.0.0.

Command:
define library ezlife libtype=SCSI device=lb3.0.0.0

Related Commands

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