Tivoli Storage Manager for Windows: Administrator's Reference

DEFINE DRIVE (Define a Drive to a Library)

Use this command to define a drive. Each drive is assigned to a single library. The library must be defined 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 library. For additional information, see Administrator's Guide.

Note:
|Before you issue the DEFINE DRIVE command for a removable media |device like a Jaz, Zip, or CD-ROM drive, you must load the drive with properly |formatted and labeled media. See the chapters on adding devices and |managing media in the Administrator's Guide for more |information. | |

Privilege Class

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

Syntax

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

Notes:

  1. The ELEMENT parameter is valid only for drives in SCSI libraries and not when the command is issued from a library client TSM server (that is, when the library type is SHARED). This parameter is required for a drive in a SCSI library containing more than 1 drive.

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

  3. The CLEANFREQUENCY parameter is valid only for drives in SCSI libraries.

Parameters

library_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
Specifies the name of the device that corresponds to the drive. For example, you might specify mt5.0.0.1. |If the drive will only be accessed by a NAS data mover, you can omit |the DEVICE parameter.

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

For a drive in a FILE library, use the keyword FILE. FILE drives are created automatically in a FILE library when the DEFINE DEVCLASS command is issued with DEVTYPE=FILE and SHARED=YES. Shared file libraries should be associated with a single device class.

For devices that are supported by either the ADSMSCSI driver or Windows drivers, use an alias name to refer to the devices. The alias name replaces the real ADSMSCSI name or Windows name for a device.

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 device drivers. To distinguish between a real device name and an alias, the server checks for a backslash (\) at the beginning of the name. If the name begins with a backslash, the server 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
Specifies the element address of the drive within a SCSI library.

Notes:

  1. This parameter is valid for a drive in a SCSI library when the command is issued from a TSM library manager server.

  2. This parameter is optional for a drive in a SCSI library, including a shared SCSI library, containing only one drive.

  3. This parameter is required for a drive in a SCSI library, including a shared SCSI library, containing more than one drive.

The server 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, consult the manufacturer's information.

Additional information on element addresses can be found at the TSM Web site: http://www.tivoli.com/support/storage_mgr/tivolimain.html. Follow the links to device information. Select the appropriate product and platform, then scroll to the required device. Click on a specific device to see element addresses.

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. The server 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 server activates drive cleaning. This parameter is optional. The default is NONE. For the most complete automation of cleaning for an automated library, you must have a cleaner cartridge checked into the library's volume inventory. For details on using this parameter for automated and manual libraries, see Administrator's Guide.
Note:
|There are special considerations if you plan to use server-activated |drive cleaning with a SCSI library that provides automatic drive cleaning |support in its device hardware. See the Administrator's |Guide for details. |

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

ASNEEDED
Specifies that the server loads the drive with a checked-in cleaner cartridge only when a drive reports to the device driver that it needs cleaning.
Note:
|Tivoli Storage Manager does not control the drives connected to the |NAS filer. If a drive is attached only to a NAS file server (no |connection to a storage agent or server), do not specify ASNEEDED for the |cleaning frequency. |

value
Specifies, in gigabytes, how much data is processed on the drive before the server loads the drive with a cleaner cartridge. The server resets the gigabytes-processed counter each time it loads a cleaner cartridge in the drive.

Consult the drive manufacturer's information for cleaning recommendations. If the information gives recommendations for cleaning frequency in terms of hours of use, convert to a gigabytes value by doing the following:

  1. Use the bytes-per-second rating for the drive to determine a gigabytes-per-hour value.
  2. Multiply the gigabytes-per-hour value by the recommended hours of use between cleanings.
  3. Use the result as the cleaning frequency value.
Note:
|For IBM 3590 and IBM 3570, we recommend that you specify a value |for the cleaning frequency to ensure that the drives receive adequate |cleaning. Consult the drive manufacturer's information for |cleaning recommendations. |

Examples

Task

Specify the name TAPEDRIVE0 for a tape drive in the library, MANLIB. Specify the device name as mt3.0.0.0.

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 a drive in an autochanger defined as library AUTOLIB1. The drive is element number 82.

Command:
define drive autolib1 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:

Task

Define a drive, TAPE0, to a LTO library named 3584LIB. The drive is located at element 104.

Command:
define drive 3584lib tape0 device=\\.\Tape0 element=104

Task

Define a FILE drive in an existing FILE library named SANLIB.

Command:
define drive sanlib san1 device=file

Related Commands

Table 65. Commands Related to DEFINE DRIVE

Command Description
DEFINE DRIVEMAPPING Defines the drive name that will be mapped to the storage agent allowing for direct storage and retrieval of data.
DEFINE LIBRARY Defines an automated or manual library.
DEFINE PATH Defines a path from a source to a destination.
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 ]