Tivoli Header

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.

A library can only be accessed by one source. This can be either a Tivoli Storage Manager server or a data mover . However, the drives in a library can be accessed by multiple sources.

Note:
Beginning with version 5.1, use the DEFINE PATH command to specify the device names of SCSI and 349X libraries and the external media manager paths for EXTERNAL libraries.

This section includes syntax diagrams for a number of different library configurations:

Configuration Task Syntax Diagram
LAN -- Define a library (MANUAL, SCSI, 349X, EXTERNAL, ACSLS, RSM). For a SCSI library that will be used for NDMP operations, see Syntax. Syntax (Define a Library in Local Area Network)
SAN -- Define a library ( SCSI, 349X, FILE) to a library manager server. Syntax (SAN -- Define a Library to a Library Manager)
SAN -- Define a library (SHARED) to a library client server. Syntax (SAN -- Define a Library to a Library Client)
SAN or LAN -- Define a SCSI library that will be accessed by a NAS data mover and directly controlled by Tivoli Storage Manager. Syntax (Define a Library Controlled Directly by Tivoli Storage Manager)
SAN or LAN -- Define a SCSI library to be accessed by NAS data mover and controlled through a NAS file server. Syntax (Define a Library Controlled Through a NAS File Server)
SAN -- Define an EXTERNAL library to be shared with storage agents. Syntax (SAN -- Define an EXTERNAL Library Shared with Storage Agents)

Privilege Class

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

Syntax



Define a Library in a Local Area Network

>>-DEFine LIBRary--library_name--------------------------------->
 
   .-LIBType--=--MANUAL-----------.
>--+------------------------------+----------------------------><
   '-LIBType--=--+-MANUAL-------+-'
                 +-SCSI---------+
                 +-349X--| A |--+
                 +-EXTernal-----+
                 +-ACSLS--| B |-+
                 '-RSM--| C |---'
 
A (349X)
 
   .-SCRATCHCATegory--=--301----.
|--+----------------------------+------------------------------->
   '-SCRATCHCATegory--=--number-'
 
   .-PRIVATECATegory--=--300----.
>--+----------------------------+-------------------------------|
   '-PRIVATECATegory--=--number-'
 
B (ACSLS)
 
|--ACSID--=--number---------------------------------------------|
 
C (RSM)
 
|--MEDIAType--=--media_type-------------------------------------|
 
 

Syntax

Library Sharing in a Storage Area Network (but NOT for NDMP Operations)

SAN -- Define a Library to a Library Manager

>>-DEFine LIBRary--library_name--------------------------------->
 
                                    .-SHAREd--=--No------.
>----LIBType--=--+-349X--| A |-+----+--------------------+-----><
                 +-SCSI--| B |-+    '-SHAREd--=--+-Yes-+-'
                 '-FILE--------'                 '-No--'
 
A (349X)
 
   .-SCRATCHCATegory--=--301----.
|--+----------------------------+------------------------------->
   '-SCRATCHCATegory--=--number-'
 
   .-PRIVATECATegory--=--300----.
>--+----------------------------+-------------------------------|
   '-PRIVATECATegory--=--number-'
 
B (SCSI)
 
|--+-------------------------+--+--------------------------+----|
   '-WWN--=--world_wide_name-'  '-SERial--=--serial_number-'
 
 



SAN -- Define a Library to a Library Client

>>-DEFine LIBRary--library_name--------------------------------->
 
>--LIBType--=--SHAREd--PRIMarylibmanager--=--server_name-------><
 
 

Syntax

Libraries in a Local Area Network or a Storage Area Network and Used for NDMP Operations

Define a Library Controlled Directly by Tivoli Storage Manager

>>-DEFine LIBRary--library_name--LIBType--=--SCSI--------------->
 
   .-SHAREd--=--No------.
>--+--------------------+--------------------------------------><
   '-SHAREd--=--+-No--+-'
                '-Yes-'
 
 



SAN -- Define a Library Controlled Through a NAS File Server

>>-DEFine LIBRary--library_name--LIBType--=--SCSI--------------->
 
>--SHAREd--=--No-----------------------------------------------><
 
 

Syntax



SAN -- Define an EXTERNAL Library Shared with Storage Agents

>>-DEFine LIBRary--library_name--LIBType--=--EXTernal----------->
 
                    .-OBEYMOUNTRetention--=--Yes-----.
>--LANFree--=--Yes--+--------------------------------+---------><
                    '-OBEYMOUNTRetention--=--+-Yes-+-'
                                             '-No--'
 
 

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 must be mounted on drives in this type of library, messages are sent to operators. This type of library is used with stand-alone drives.

FILE
Specifies that a pseudo-library is created for sequential file volumes. When you issue the DEFINE DEVCLASS command with DEVTYPE=FILE and SHARED=YES parameters, this occurs automatically. FILE libraries are necessary only when sharing sequential file volumes between the server and one or more storage agents. The use of FILE libraries requires library sharing.

SCSI
Specifies that the library has a SCSI-controlled media changer device. To mount volumes on drives in this type of library, Tivoli Storage Manager uses the media changer device.

349X
Specifies that the library is an IBM 3494 Tape Library Dataserver. The scratch and private categories are optional and mutually exclusive.

Because Tivoli Storage Manager uses decimal values for the category number and the 349X uses hexadecimal values, both values are provided in the following descriptions.

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

SHAREd
Specifies that the library is shared with another Tivoli Storage Manager server over a storage area network (SAN) or a dual SCSI connection to library drives.
Note:
Specify this library type when defining the library on the library client.

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.

In a Managed System for SAN environment, this parameter specifies that STK Automated Cartridge System Library Software (ACSLS) or Library Station software controls the library. The third-party software such as Gresham EDT-DistribuTAPE allows multiple servers to share the library. The drives in this library are not defined to Tivoli Storage Manager. ACSLS identifies the drive for media operations.

ACSLS
Specifies that the library is a Storage Tek (STK) library that is controlled by STK Automated Cartridge System Library Software (ACSLS).
Note:
Do not specify a library type of ACSLS for the Managed System for SAN environment. Specify EXTERNAL.

RSM
Specifies that the library is integrated with Windows Removable Storage Management (RSM). This library type allows Tivoli Storage Manager 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 removable media pools. The corresponding media pool is named TSM\library_name. This library can be associated with the LTO or GENERICTAPE device types. Do not define an LTO drive to a library associated with a device class whose device type is GENERICTAPE.

Use the Removable Storage Manager snap-in to view the contents of the RSM database and included media pools.

You can create more than one RSM library type if each library_name is unique.

You can delete RSM libraries, but you cannot update them.

WWN
Specifies the Fibre Channel world wide name for the library. This parameter is valid only for drives in SCSI libraries. This parameter is required if the device will be accessed by a data mover for server-free data movement.

SERial
Specifies the serial number for the library being defined. This parameter is required if the device will be accessed by a data mover for server-free data movement.

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. This parameter is required and valid only when LIBTYPE=ACSLS.

See your STK documentation for more information.

LANFree
Specifies whether the library is used for LAN-free operations. The default is NO. When an external library will be accessed by a storage agent, this parameter must be set to YES.

MEDIAType
Specifies the media type. The Windows Removable Storage Manager snap-in displays this information under media pools. You must use quotation marks ("") around these media types because of embedded spaces. For example, "4mm DDS" is a valid media type for tape.

This parameter is required and valid only when LIBTYPE=RSM.

OBEYMOUNTRetention
Specifies whether the server uses the value set for mount retention in the device class associated with this library. The default is NO.

Yes
Specifies that the mounted volume should be retained for the period specified by the mount retention value.

No
Specifies that the mount retention value is to be ignored.

PRIMarylibmanager
Specifies the name of the Tivoli Storage Manager 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 as a library manager. This parameter is required and valid only if LIBTYPE=SHARED (that is, when you define a library in a SAN to a library client server).

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. This parameter is valid only when LIBTYPE=349X.

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. This parameter is valid only when LIBTYPE=349X.

When support for 3590 drives in 349X libraries is enabled (by the ENABLE3590LIBRARY server option), Tivoli Storage Manager 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 Tivoli Storage Manager and other applications, data loss can occur if Tivoli Storage Manager creates a duplicate category for 3590 scratch volumes.

SHAREd
Specifies whether this library is shared with other Tivoli Storage Manager servers in a storage area network (SAN).
Note:
This parameter is required when you define a library to the library manager. This parameter is only valid for SCSI and 349X libraries.

YES
Specifies that this library can be shared with other servers. When you specify YES, the library manager server mounts volumes as requested by other servers and tracks drive and volume allocation to other servers.

NO
Specifies that this library cannot be shared with other servers. SHARED=NO is required if the library is controlled by passing commands through a NAS file server.

Examples

Task - MANUAL Library

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

Command
define library manualmount libtype=manual

Task - SCSI Library in a LAN

Define a library named SCSILIB with a library type of SCSI and a device name of lb3.0.0.0.

Commands
define library scsilib libtype=scsi
define path server1 scsilib srctype=server desttype=library 
   device=lb3.0.0.0

Task - SCSI Library in a SAN

In a Storage Area Network, two Tivoli Storage Manager servers must share a SCSI library. Define a SCSI library named LTOLIB on a library manager server named CASTOR. The device name of the library is lb3.0.0.0. Then define the same library on a library client server named POLLUX.

Commands
On the library manager, CASTOR:
define library ltolib libtype=scsi shared=yes 
define path castor ltolib srctype=server desttype=library 
  device=lb3.0.0.0

On the library client, POLLUX:

define library ltolib libtype=shared primarylibmanager=castor 

Task - ACSLS Library

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

Commands
define library acslib libtype=acsls acsid=1

Task - RSM Library

Define a library named RSMLIB with a library type of RSM. The media type for the library is LTO Ultrium.

Command
define library rsmlib libtype=rsm mediatype="LTO Ultrium"

Task - SCSI Libraries Used for NDMP Operations

A SCSI library named TSMLIB is connected to a Tivoli Storage Manager server. Define that library so that it will be directly controlled by Tivoli Storage Manager and used for NDMP operations.

Commands
define library tsmlib libtype=scsi
define path server1 tsmlib srctype=server desttype=library 
   device=lb3.0.0.0

A SCSI library named NASLIB is connected directly to a NAS file server. Define that library so that it will be controlled by Tivoli Storage Manager through the NAS data mover and used for NDMP operations.

Commands
define library naslib libtype=scsi
define path nasdm naslib srctype=datamover desttype=library 
   device=rst1l

Task - EXTERNAL Library in a Managed System for SAN

For a Managed System for SAN configuration, define a library named STKLANFREE with the library type of EXTERNAL. The external library manager executable is located in the c:\program files\GES\EDT\bin\elm.exe directory. Use the mount retention value set in the device class associated with this library.

Commands
define library stklanfree libtype=external lanfree=yes obeymountretention=yes 
define path server1 stklanfree srctype=server desttype=library 
  externalmanager=c:\program files\GES\EDT\bin\elm.exe

Related Commands

Table 69. 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.
DEFINE PATH Defines a path from a source to a destination.
DELETE DRIVE Deletes a drive from a library.
DELETE PATH Deletes a path from a source to a destination.
DELETE LIBRARY Deletes a library.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more libraries.
QUERY PATH Displays information about the path from a source to a destination.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE LIBRARY Changes the attributes of a library.
UPDATE PATH Changes the attributes associated with a path.


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