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.
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:
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:
SAN -- Define a Library toa Library Client |
>>-DEFine LIBRary--library_name---------------------------------> >--LIBType--=--SHAREd--PRIMarylibmanager--=--server_name------->< |
|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----------------------------------------------->< |
|
|
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
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.
|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.
|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.
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:
For additional information on device names, see the description of the DEVICE parameter in the DEFINE DRIVE command and the Administrator's Guide.
|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.
This parameter is required and valid only when LIBTYPE=RSM.
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.
Examples
Task
Define a library named MANUALMOUNT with the library type of MANUAL.
Task
Define a library named EZLIFE with a library type of SCSI and a device name of lb3.0.0.0.
Task
Define a library named ACSLIB with a library type of ACSLS and an acsid of 1.
Task
Define a library named SUPERSTORE with a library type of RSM. The media type for the library is 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.
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. |
|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. |
|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. |
|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. |