Tivoli Storage Manager for Windows: 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 (with the DEVICE parameter on the |library definition) or a data mover (as specified using the DEFINE PATH |command). However, the drives in a library can be accessed by multiple |sources.

|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 LocalArea Network

>>-DEFine LIBRary--library_name--------------------------------->
 
   .-LIBType--=--MANUAL--------------.
>--+---------------------------------+-------------------------><
   '-LIBType--=--+-MANUAL----------+-'
                 +-SCSI--| A |-----+
                 +-349X--| B |-----+
                 +-EXTernal--| C |-+
                 +-ACSLS--| D |----+
                 '-RSM--| E |------'
 
A (SCSI)
 
|--DEVIce--=--device_name---------------------------------------|
 
B (349X)
 
                   .-,-----------.
             (1)   V             |
|--DEVIce--=---------device_name-+------------------------------>
 
   .-SCRATCHCATegory--=--301----.
>--+----------------------------+------------------------------->
   '-SCRATCHCATegory--=--number-'
 
   .-PRIVATECATegory--=--300----.
>--+----------------------------+-------------------------------|
   '-PRIVATECATegory--=--number-'
 
C (EXTERNAL)
 
|--EXTERNALManager--=--path_name--------------------------------|
 
D (ACSLS)
 
|--ACSID--=--number---------------------------------------------|
 
E  (RSM)
 
|--MEDIAType--=--media_type-------------------------------------|
 
 

Notes:

  1. Specify one to eight device names.

Syntax

Library Sharing in a Storage Area Network but Not for NDMP Operations

SAN -- Define a Library toa Library Manager

>>-DEFine LIBRary--library_name--------------------------------->
 
>----LIBType--=--+-SCSI--DEVIce--=--device_name-+--------------->
                 +-349X--| A |------------------+
                 '-FILE-------------------------'
 
>--SHAREd--=--Yes----------------------------------------------><
 
A (349X)
 
                   .-,-----------.
             (1)   V             |
|--DEVIce--=---------device_name-+------------------------------>
 
   .-SCRATCHCATegory--=--301----.
>--+----------------------------+------------------------------->
   '-SCRATCHCATegory--=--number-'
 
   .-PRIVATECATegory--=--300----.
>--+----------------------------+-------------------------------|
   '-PRIVATECATegory--=--number-'
 
 

Notes:

  1. Specify one to eight device names.



SAN -- Define a Library toa 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 ControlledDirectly by Tivoli Storage Manager

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


|
|

SAN -- Define a Library ControlledThrough a NAS File Server

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

|Syntax


|
|

SAN -- Define an EXTERNALLibrary Shared with Storage Agents

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

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.

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 device name is required. 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 the library and that third-party software such |as Gresham EDT-DistribuTAPE allows multiple Tivoli Storage Manager 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). When you select this parameter, you must also specify the Automated Cartridge System (ACS) ID.
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.

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.

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 does not apply to any other library types. 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.

|You can omit this parameter to set up a library device for Tivoli |Data Protection for NDMP. The library can still be accessed from a |network-attached storage (NAS) file server if a path to the library is |defined using the DEFINE PATH command. A NAS file server can only |control libraries that have SCSI-controlled autochangers.

The device name is a symbolic name that is specified in the c:\winnt\ibmatl.conf file. An alias name is used for a device that can be controlled by either the ADSMSCSI driver or Windows NT driver. The alias name replaces the real device name in 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 additional information on device names, see the description of the DEVICE parameter in the DEFINE DRIVE command and the Administrator's Guide.

EXTERNALManager
Specifies the location of the external library manager where Tivoli Storage Manager can send media access requests. This is required and valid only if LIBTYPE=EXTERNAL.

|In a Managed System for SAN Storage Agent environment, this |parameter specifies the fully-qualified path name where the external library |manager executable is located.

|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.

|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.

|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.

|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 device class mount retention specification is valid and |that the mounted volume should be retained for the specified period.

|No
|Specifies that the device class mount retention specification 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 primary 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 option in the server options file), Tivoli Storage Manager 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 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 primary 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 server is responsible for mounting volumes as requested by other servers and tracking drive and volume allocation to other servers for the library manager.

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

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

Command:
define library manualmount libtype=manual

Task

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

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

Task

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

Command:
define library acslib libtype=acsls acsid=1

Task

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

Command:
define library superstore libtype=RSM mediatype="LTO Ultrium"

Task

In a Storage Area Network, define a SCSI library named LTOLIB on a library manager server named ASTRO. The device name of the library is lb3.0.0.0. Then define the same library on a library client server.

Command:
define library ltolib libtype=SCSI device=lb3.0.0.0 shared=yes

define library ltolib libtype=shared primarylibmanager=astro

|Task

|A tape library 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. |

|Command:
|define library tsmlib libtype=scsi |device=lb3.0.0.0 |

|Task

|A tape library 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. |

|Command:
|define library naslib libtype=scsi
|Note:
You do not specify a DEVICE parameter on the DEFINE LIBRARY command Instead |you specify a DEVICE parameter when you define the path to the library. |
|

|Task

|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 c:\program |files\GES\EDT\bin\elm.exe. Use the mount retention value set in |the device class associated with this library. |

|Command:
|define library stklanfree libtype=external lanfree=yes obeymountretention=yes 
|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 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 ]