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 is, the special file name) that corresponds to the drive. For example, you might specify /dev/rmt/2mt.

To access a drive that is device type REMOVABLEFILE, use a mount point such as, /cdrom/cdrom0.

For devices other than the IBM 3494, the name is the special file name. For a 3494, the device name is the symbolic name you entered in the configuration file for the library.

During configuration of devices other than the 3494, one or more device special file names are created. The following table shows the form of the names. In this table, x denotes a number from 0 to 7.

Special File Name. Description
/dev/rmt/xmt Used for tape drives that are supported by the TSM device driver
/dev/rmt/xlb Used for SCSI-attached libraries that are supported by the TSM device driver
/dev/rmt/xop Used for optical drives that are supported by the TSM device driver
/dev/rmt/xst Used for IBM 3490, 3570, and 3590 tape drives, which are supported by the IBMtape device driver
/dev/rmt/xsmc Used for the medium changer (the robotics) of an IBM 3570 or an IBM 3590 B11 with Automatic Cartridge Facility (ACF) feature, which are supported by the IBMtape device driver
Note:If the device name is a NON-TSM device name (not controlled by an TSM/IBM tape device driver), perform the following as a precaution to see if TSM can use this drive as a GENERICTAPE type device.

  1. Insert a blank or unused tape into the drive. Ensure that the inserted tape is not write-protected.

  2. At a Sun Solaris (not TSM) command prompt as root user, issue the Solaris command:
    /usr/bin/dd if=/usr/bin/dd of={Device Name} obs=80   
    

    {Device Name} is the same as the devicename in the DEFINE DRIVE command.

  3. If you get an I/O error from the dd command, Solaris is unable to use the drive. This can also prevent TSM from using the drive.

  4. Eject the tape.

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.

Examples

Task

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

Command:
define drive manlib tapedrive3 device=/dev/rmt/0mt

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=/dev/0mt acsdrvid=1,2,3,4

Task

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

Note:This command uses a UNIX mount point as the device. Refer to the Administrator's Guide for more information.

Command:
define drive manlib CDROM device=/cdrom/cdrom0

Related Commands

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