DEFINE DRIVE (Define a drive to a library)

Use this command to define a drive. Each drive is assigned to a library, and so the library must be defined before you issue this command.

A path must be defined after you issue the DEFINE DRIVE command to make the drive usable by IBM Spectrum Protect. For more information, see DEFINE PATH (Define a path). If you are using a SCSI or VTL library type, see PERFORM LIBACTION (Define or delete all drives and paths for a library).

You can define more than one drive for a library by issuing the DEFINE DRIVE command for each drive. Stand-alone drives always require a manual library.

Windows operating systemsRestriction: Before you issue the DEFINE DRIVE command, for a removable media device such as a Jaz, Zip, or CD drive, you must load the drive with properly formatted and labeled media.

Privilege class

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

Syntax


1  DEFine
DRive library_name drive_name
1!  SERial = AUTODetect
1  SERial =
2.1 AUTODetect
2.1 serial_number
1!  ONLine = Yes
1  ONLine =
2.1 Yes
2.1 No
1!  ELEMent = AUTODetect(1)
1  ELEMent =
2.1 AUTODetect
2.1 address
4?  ACSDRVID = drive_id(2)
1  CLEANFREQuency =(3)
2.1 NONE
2.1 ASNEEDED(4)
2.1 gigabytes
Notes:
  • 1 The ELEMENT parameter is only necessary for drives in SCSI libraries when the drive type is a network attached SCSI (NAS) 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.
  • 4 The CLEANFREQUENCY=ASNEEDED parameter value does not work for all tape drives. For more information, see the parameter description.

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.
SERial
Specifies the serial number for the drive that is being defined. This parameter is optional. The default is AUTODETECT.

If SERIAL=AUTODETECT, then the serial number reported by the drive when you define the path is used as the serial number.

If SERIAL=serial_number, then the serial number that is entered is used to verify that the path to the drive is correct when you define the path.

Note: Depending on the capabilities of the device, SERIAL=AUTODETECT might not be supported. In this case, the serial number is reported as blank.
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 a drive within a SCSI or virtual tape library (VTL). The server uses the element address to connect the physical location of the drive to the SCSI or VTL address of the drive. The default is AUTODETECT.

If ELEMENT=AUTODETECT, then the element number is automatically detected by the server when the path to the drive is defined.

To find the element address for your library configuration, consult the information from the manufacturer.

Restriction:
  • The ELEMENT parameter is valid only for drives in SCSI libraries or VTLs when the drive type is not a network attached SCSI (NAS) drive.
  • This parameter is not effective when the command is issued from a library client server (that is, when the library type is SHARED).
  • Depending on the capabilities of the library, ELEMENT=AUTODETECT might not be supported. In this case, you must supply the element address.
ACSDRVID
Specifies the ID of the drive that is being accessed in an ACSLS library. 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 StorageTek documentation for details.
Windows operating systemsRestriction: To use ACSLS functions, the installation of StorageTek Library Attach software is required.
CLEANFREQuency
Specifies how often the server activates drive cleaning. This parameter is optional. For the most complete automation of cleaning for an automated library, you must have a cleaner cartridge that is checked into the library's volume inventory.

If you are using library-based cleaning, NONE is advised when your library type supports this function.

This parameter is not valid for externally managed libraries, such as 3494 libraries or StorageTek libraries that are managed under ACSLS.

Important: 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.
NONE
Specifies that the server does not track cleaning for this drive. This value can be used 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.

The CLEANFREQUENCY=ASNEEDED parameter value does not work for all tape drives. See the Supported Devices website for your operating system to view detailed drive information. If ASNEEDED is not supported, you can use the gigabytes value for automatic cleaning.

For IBM 3592 and LTO drives, library-based cleaning is advised. If library-based cleaning is not supported, then ASNEEDED must be used. Gigabytes is not recommended.

Restriction: IBM Spectrum Protect does not control the drives that are connected to the NAS file server. 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.
gigabytes
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.
Important: When CLEANFREQUENCY=gigabyte, drive cleaning can occur before the gigabyte setting is reached, if the drive notifies the device driver that a cleaning is necessary.

Consult the information from the drive manufacturer 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.

Using the cleaning frequency that is recommended by IBM® for IBM drives ensures that the drives are not overcleaned.

For IBM 3590 drives, specify a gigabyte value for the cleaning frequency to ensure that the drives receive adequate cleaning.

Example: Define a drive to library

Define a drive in a manual library with a library name of LIB01 and a drive name of DRIVE01.
define drive lib01 drive01
AIX operating systems
define path server01 drive01 srctype=server desttype=drive 
library=lib01 device=/dev/rmt0
Linux operating systems
define path server01 drive01 srctype=server desttype=drive 
library=lib01 device=/dev/tsmscsi/mt0
Windows operating systems
define path server01 drive01 srctype=server desttype=drive 
library=lib01 device=mt3.0.0.0

Example: Define a drive in an ACSLS library

Define a drive in an ACSLS library with a library name of ACSLIB and a drive name of ACSDRV1.
define drive acslib acsdrv1 acsdrvid=1,2,3,4
AIX operating systems
define path server01 acsdrv1 srctype=server desttype=drive 
library=acslib device=/dev/rmt0
Linux operating systems
define path server01 acsdrv1 srctype=server desttype=drive 
library=acslib device=/dev/tsmscsi/mt0
Windows operating systems
define path server01 acsdrv1 srctype=server desttype=drive 
library=acslib device=mt3.0.0.0

Example: Define a drive in an automated library

Define a drive in an automated library with a library name of AUTO8MMLIB and a drive name of DRIVE01.
define drive auto8mmlib drive01 element=82
AIX operating systems
define path server01 drive01 srctype=server desttype=drive 
library=auto8mmlib device=/dev/rmt0
Linux operating systems
define path server01 drive01 srctype=server desttype=drive 
library=auto8mmlib device=/dev/tsmscsi/mt0
Windows operating systems
define path server01 drive01 srctype=server desttype=drive 
library=auto8mmlib device=mt3.0.0.0

Related commands

Table 1. Commands related to DEFINE DRIVE
Command Description
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.
PERFORM LIBACTION Defines all drives and paths for a library.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more libraries.
QUERY PATH Displays information about the path from a source to a destination.
UPDATE DRIVE Changes the attributes of a drive.
UPDATE PATH Changes the attributes associated with a path.