UPDATE DRIVE (Update a drive)

Use this command to update a drive.

Privilege class

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

Syntax

Read syntax diagramSkip visual syntax diagram
>>-UPDate DRive--library_name--drive_name----------------------->

>--+------------------------------+--+--------------------+----->
   '-SERial--=--+-serial_number-+-'  '-ONLine--=--+-Yes-+-'   
                '-AUTODetect----'                 '-No--'     

>--+----------------------------+------------------------------->
   '-ELEMent--=--+-address----+-'   
                 '-AUTODetect-'     

>--+---------------------------+-------------------------------->
   |                       (1) |   
   '-ACSDRVID--=--drive_id-----'   

>--+-----------------------------------------+-----------------><
   |                     (2)                 |   
   '-CLEANFREQuency--=------+-NONE---------+-'   
                            |          (3) |     
                            +-ASNEEDED-----+     
                            '-gigabytes----'     

Notes:
  1. The ACSDRVID parameter is valid only for drives in ACSLS libraries.
  2. The CLEANFREQUENCY parameter is valid only for drives in SCSI libraries.
  3. 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.
drive_name (Required)
Specifies the name that is assigned to the drive.
SERial
Specifies the serial number for the drives that are being updated. This parameter is valid only for drives in a SCSI or virtual tape library (VTL). This parameter is optional. The possible values are:
serial_number
Specifies the serial number for the drive that is being updated.
Note: If a path to this drive is already defined, then the number you enter here is compared to the number detected by Tivoli® Storage Manager. If the numbers do not match, the command fails.
AUTODETECT
Specifies that the serial number is automatically detected and used by Tivoli Storage Manager if a path is already defined to this drive.

If a path to this drive is not defined, then the serial number is not detected.

ONLine
Specifies whether the drive is available for use. This parameter specifies whether drives can be taken offline and used for another activity, such as maintenance. This parameter is optional.

You can issue this command when the drive is involved in an active process or session, but it is not advised. If you issue a command to take the drive offline while it is in use, an error message is issued. The mounted volume completes its current process. If this volume was part of a series of volumes for a specific transaction, the drive is not available to complete mounting the series. If no other drives are available, the process fails.

Attention: When a drive is in use, do not specify the ELEMENT parameter with the ONLINE parameter. The drive is not updated, and the command fails.

The drive state is not changed even if the server is halted and restarted. If a drive is offline when the server is restarted, a warning message is issued stating that the drive must be manually brought online. If all of the drives in a library are updated to be offline, processes that need a library mount point fail, rather than queue up for a mount point.

YES
Specifies that the drive is available for use (online).
No
Specifies that the drive is not available for use (offline).
ELEMent
Specifies the element address of the drive within a SCSI or VTL library. The server uses the element address to connect the physical location of the drive to the SCSI address of the drive. This parameter is valid only for a drive in a SCSI or VTL library when the command is issued from a Tivoli Storage Manager library manager server. The possible values are:
address
Specifies the element address for the drive that is being updated.

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

Remember: If a path to this drive is already defined, then the number you enter here is compared to the number previously detected by Tivoli Storage Manager. If the numbers do not match, then this command fails.
AUTODETECT
Specifies that the element number is automatically detected and used by Tivoli Storage Manager if a path is already defined to this drive.

If a path to this drive is not defined, then the element number is not detected.

Restriction: If the library in which the drive is located does not support the Read Element Status SCSI command, and ELEMENT=AUTODETECT, the command fails with a Tivoli Storage Manager error message.
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 your StorageTek documentation for details.
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 checked into the volume inventory for the library. If you are using library based cleaning, NONE is advised when your library type supports this function. This parameter is valid only for drives in SCSI libraries, and 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. Use this parameter 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. Visit 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: Tivoli Storage Manager 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.
Tip: For IBM 3590, specify a value for the cleaning frequency to ensure that the drives receive adequate cleaning. Consult the information from the drive manufacturer for cleaning recommendations. Using the cleaning frequency that is recommended by IBM does not over clean the drives.

Example: Update the element address for a drive

Update DRIVE3, in the library named AUTO, by changing the element address to 119.
update drive auto drive3 element=119

Example: Take a drive offline

Update DRIVE3, in the library named MANLIB, to take it offline.
update drive manlib drive3 online=no

Related commands

Table 1. Commands related to UPDATE DRIVE
Command Description
CLEAN DRIVE Marks a drive for cleaning.
DEFINE DRIVE Assigns a drive to a library.
DEFINE PATH Defines a path from a source to a destination.
DELETE DRIVE Deletes a drive from a library.
QUERY DRIVE Displays information about drives.
QUERY LIBRARY Displays information about one or more libraries.
UPDATE PATH Changes the attributes associated with a path.