Administrator's Reference

DEFINE DRIVE (Define a Drive to a Library)

Use this command to define a drive that TSM can use to access data on storage volumes. Each drive is assigned to a single library. You must define this library before you issue this command. You can define more than one drive for a given library by issuing the DEFINE DRIVE command once for each drive. Stand-alone drives always require a manual-type library. For additional information, see Administrator's Guide.

Privilege Class

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

Syntax

>>-DEFine DRive--lib_name--drive_name--------------------------->
 
                                .-ONLine--=--Yes-----.
>-----DEVIce--=--device_name----+--------------------+---------->
                                '-ONLine--=--+-Yes-+-'
                                             '-No--'
 
>-----+---------------------------+----------------------------->
      |                     (1)   |
      '-ELEMent--=--address-------'
 
>-----+-----------------------------+--------------------------->
      |                       (2)   |
      '-ACSDRVID--=--drive_id-------'
 
      .-CLEANFREQuency--=--NONE---------.
>-----+---------------------------------+----------------------><
      '-CLEANFREQuency--=--+-NONE-----+-'
                           +-ASNEEDED-+
                           '-value----'
 

Notes:

  1. The ELEMENT parameter is required for drives in SCSI libraries.

  2. ACSDRVID is required for drives in ACSLS libraries. This parameter is not valid for non-ACSLS libraries.

Parameters

lib_name (Required)
Specifies the name of the library to which the drive is assigned. This parameter is required for all drives, including stand-alone drives. The specified library must have been previously defined by using the DEFINE LIBRARY command.

drive_name (Required)
Specifies the name that is assigned to the drive. The maximum length of this name is 30 characters.

DEVIce (Required)
Specifies the name of the device that corresponds to the drive. For example, you might specify mt5.0.0.1.

For a drive that is device type REMOVABLEFILE, specify its drive letter and a colon, for example, E:.

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.

For devices that are 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 that the device is a tape device, and the lb indicates that 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

Because the alias name does not change unless you change how the device is physically attached, always use the alias name for devices that are controlled by Windows NT device drivers. To distinguish between a real device name and an alias, TSM checks for a backslash (\) at the beginning of the name. If the name begins with a backslash, TSM recognizes that the name is the real device name and not an alias.

ONLine
Specifies whether the drive is available for use. This parameter is optional. The default is YES.

Yes
Specifies that the drive is available for use.

No
Specifies that the drive is not available for use.

ELEMent=address
Specifies the new value to be used for the drive's element address within a SCSI library. This parameter is optional. TSM needs the element address to connect the physical location of the drive to the drive's SCSI address. To find the element address for your library configuration, access the TSM Web site at: http://www.tivoli.com/tsm . At this URL, follow the links to device information. You will need to click on your product and platform and then scroll to the required device. When you click on your selected device, you will get the element address.

ACSDRVID
Specifies the ID of the drive that is being accessed. The drive ID is a set of numbers that indicates the physical location of a drive within an ACSLS library. This drive ID must be specified as a,l,p,d, where a is the acsid, l is the LSM (library storage module), p is the panel number, and d is the drive ID. TSM needs the drive ID to connect the physical location of the drive to the drive's SCSI address. See the STK documentation for details.

CLEANFREQuency
Specifies how often the TSM activates drive cleaning. You must have a cleaner cartridge checked into the library's volume inventory to use this parameter. This parameter is optional. The default is NONE.
Note:Use drive cleaning that is controlled by TSM only for SCSI libraries that do not have automatic drive cleaning support in their device hardware.

NONE
Specifies that TSM does not track cleaning for this drive. Use this for libraries that have their own automatic cleaning.

ASNEEDED
Specifies that TSM loads the drive with a checked-in cleaner cartridge only when a drive reports to the device driver that it needs cleaning.

value
Specifies (in gigabytes) how much data to process on the drive before TSM loads the drive with a cleaner cartridge. TSM resets the gigabytes-processed counter each time it loads a cleaner cartridge in the drive.

Usage Notes

Examples

Task

Suppose you have already defined a manual tape library named MANLIB using the DEFINE LIBRARY command. You then wish to inform the server that you have a tape drive that can be used to access storage media. You choose the name TAPEDRIVE0 for this drive.

Command:
define drive manlib tapedrive0 device=mt3.0.0.0

Task

You have already defined a manual library named MANUAL using the DEFINE LIBRARY command. You now want to inform the server that you have a stand-alone Iomega Zip drive that is accessed as drive letter H and is ready for use. You choose the name ZIP1 for this drive.

Command:
define drive manual zip1 device=h:

Task

Define drives with element numbers for autochangers.

Command:
define drive tapedrive0 device=mt3.0.0.0 element=82

Task

Define a drive in an ACSLS library with a library name of ACSLIB and a drive name of ACSDRV1.

Command:
define drive acslib acsdrv1 device=mt3.0.0.0 acsdrvid=1,2,3,4

Task

Define a drive for a device type of REMOVABLEFILE (CDROM).

Note:Refer to the Administrator's Guide for more information.

Command:
define drive manual cddrive device=e:

Related Commands

Table 58. Commands Related to DEFINE DRIVE

Command Description
DEFINE LIBRARY Defines an automated or manual library.
DELETE DRIVE Deletes a drive from 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.


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