IBM Tivoli Storage Manager, Version 7.1

DEFINE DEVCLASS (Define an ECARTRIDGE device class)

Use the ECARTRIDGE device class when you are using StorageTek drives such as the StorageTek SD-3, 9490, 9840 or 9940.

AIX operating systems Linux operating systems If you are defining a device class for devices that are to be accessed through a z/OS® media server, see DEFINE DEVCLASS (Define an ECARTRIDGE device class for z/OS media server).

Privilege class

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

Syntax

Read syntax diagramSkip visual syntax diagram
>>-DEFine DEVclass--device_class_name--------------------------->

>--LIBRary--=--library_name--DEVType--=--ECARTridge------------->

                                                  (1)      
   .-LBProtect--=--No------------.  .-WORM--=--No------.   
>--+-----------------------------+--+------------------+-------->
   '-LBProtect--=--+-READWrite-+-'  '-WORM--=--+-No--+-'   
                   +-WRITEOnly-+               '-Yes-'     
                   '-No--------'                           

   .-FORMAT--=--DRIVE---------.                             
>--+--------------------------+--+----------------------+------->
   '-FORMAT--=--+-DRIVE-----+-'  '-ESTCAPacity--=--size-'   
                +-18T-------+                               
                +-18TC------+                               
                +-36T-------+                               
                +-36TC------+                               
                +-SD3A------+                               
                +-SD3AC-----+                               
                +-SD3B------+                               
                +-SD3BC-----+                               
                +-SD3C------+                               
                +-SD3CC-----+                               
                +-9840------+                               
                +-9840-C----+                               
                +-9940------+                               
                +-9940-C----+                               
                +-9940B-----+                               
                +-9940B-C---+                               
                +-M8100-----+                               
                +-M8100C----+                               
                +-T9840C----+                               
                +-T9840C-C--+                               
                +-T9840D----+                               
                +-T9840D-C--+                               
                +-T10000A---+                               
                +-T10000A-C-+                               
                +-T10000B---+                               
                +-T10000B-C-+                               
                +-T10000C---+                               
                '-T10000C-C-'                               

   .-PREFIX--=--ADSM-------------------.   
>--+-----------------------------------+------------------------>
   '-PREFIX--=--+-ADSM---------------+-'   
                '-tape_volume_prefix-'     

   .-MOUNTRetention--=--60------.  .-MOUNTWait--=--60------.   
>--+----------------------------+--+-----------------------+---->
   '-MOUNTRetention--=--minutes-'  '-MOUNTWait--=--minutes-'   

   .-MOUNTLimit--=--DRIVES-----.   
>--+---------------------------+-------------------------------->
   '-MOUNTLimit--=--+-DRIVES-+-'   
                    +-number-+     
                    '-0------'     

                               (1) (2)     
   .-DRIVEEncryption--=--ALLOW---------.   
>--+-----------------------------------+-----------------------><
   '-DRIVEEncryption--=--+-ON-------+--'   
                         +-ALLOW----+      
                         +-EXTernal-+      
                         '-OFF------'      

Notes:
  1. You cannot specify both WORM=Yes and DRIVEENCRYPTION=ON.
  2. You can use drive encryption only for Oracle StorageTek T10000B drives with a format value of DRIVE, T10000B, or T10000B-C, and for Oracle StorageTek T10000C drives with a format value of DRIVE, T10000C or T10000C-C.

Parameters

device_class_name (Required)
Specifies the name of the device class to be defined. The maximum length of the device class name is 30 characters.
LIBRary (Required)
Specifies the name of the defined library object that contains the ECARTRIDGE tape drives that can be used by this device class. For information about defining a library object, see the DEFINE LIBRARY command.
DEVType=ECARTridge (Required)
Specifies that the ECARTRIDGE device type is assigned to the device class. ECARTRIDGE indicates that a specific type of cartridge tape device (StorageTek) is assigned to this device class.
LBProtect

Specifies whether logical block protection is used to ensure the integrity of data stored on tape. When LBPROTECT is set to READWRITE or to WRITEONLY, the server uses this feature of the tape drive for logical block protection and generates cyclic redundancy check (CRC) protection information for each data block written on tape. The server also validates the CRC protection information when data is read from the tape.

The default is NO.

The following values are possible:
READWrite
Specifies that logical block protection is enabled in the server and the tape drive for both read and write operations. Data is stored with CRC information in each block. This mode affects performance because additional processor usage is required for Tivoli® Storage Manager and the tape drive to calculate and compare CRC values. The READWRITE value does not affect backup sets and data that is generated by the BACKUP DB command.

When the LBPROTECT parameter is set to READWRITE, you do not have to specify the CRCDATA parameter in a storage pool definition because logical block protection provides better protection against data corruption.

WRITEOnly
Specifies that logical block protection is enabled in the server and the tape drive for write operations only. Data is stored containing CRC information in each block. For read operations, the server and the tape drive do not validate the CRC. This mode affects performance because additional processor usage is required for Tivoli Storage Manager to generate the CRC and for the tape drive to calculate and compare CRC values for write operations. The WRITEONLY value does not affect backup sets and data that are generated by the BACKUP DB command.
No
Specifies that logical block protection is not enabled in the server and the tape drive for read and write operations. However, the server enables logical block protection on write operations for a filling volume that already has data with logical block protection.
Restriction: Logical block protection is supported only on Oracle StorageTek T10000C drives.
WORM
Specifies whether the drives use WORM (write once, read many) media. The parameter is optional. The default is No.
Yes
Specifies that the drives use WORM media.
No
Specifies that the drives do not use WORM media.
Restriction: If you select Yes, the only options that are available for the FORMAT parameter are:
  • DRIVE
  • 9840
  • 9840-C
  • T9840D
  • T9840D-C
  • T10000A
  • T10000A-C
  • T10000B
  • T10000B-C
  • T10000C
  • T10000C-C
FORMAT
Specifies the recording format to be used when data is written to sequential access media. This parameter is optional; the default value is DRIVE. If the drives are in a library that includes drives of different tape technology, do not use the DRIVE value. Use the specific format that the drives use.
Important: If you specify DRIVE for a device class that has non-compatible sequential access devices, then you must mount volumes on devices that are capable of reading or writing the format that is established when the volume was first mounted. This can cause delays if the only sequential access device that can access the volume is already in use.
The following table lists the recording formats and estimated capacities for ECARTRIDGE devices:
Table 1. Recording formats and default estimated capacities for ECARTRIDGE tapes
Format Estimated capacity Description
DRIVE The server selects the highest format that is supported by the drive on which a volume is mounted.
Attention: Avoid specifying DRIVE when a mixture of drives is used within the same library. For example, do not use this option for a library that contains some drives that support recording formats superior to other drives.
18T 360 MB 18-track uncompressed (standard) (read-only) format
18TC 1.44 GB 18-track extended (read-only), compressed format
36T 720 MB 36-track extended (read and write) format
36TC 2.88 GB 36-track extended (read and write), compressed format
SD3A 10 GB Uncompressed (standard) format, using a 10 GB 'A' cartridge with 91 meters (298 feet) of tape
SD3AC 40 GB Compressed format, using a 10 GB 'A' cartridge with 91 meters (298 feet) of tape
SD3B 25 GB Uncompressed (standard) format, using a 25 GB 'B' cartridge with 204 meters (668 feet) of tape
SD3BC 100 GB Compressed format, using a 25 GB 'B' cartridge with 204 meters (668 feet) of tape
SD3C 50 GB Uncompressed (standard) format, using a 50 GB 'C' cartridge with 392 meters (1286 feet) of tape
SD3CC 200 GB Compressed format, using a 50 GB 'C' cartridge with 392 meters (1286 feet) of tape
9840 20 GB Uncompressed 9840 format, using a StorageTek 9840 cartridge. This format is valid for StorageTek 9840 and 9840B drives
9840-C 80 GB LZ-1 Enhanced (4:1) compressed 9840 format, using a StorageTek 9840 cartridge
9940 60 GB Uncompressed 9940 format, using a StorageTek 9940 cartridge
9940-C 120 GB Compressed 9940 format, using a StorageTek 9940 cartridge
9940B 200 GB Uncompressed 9940B format, using a StorageTek 9940 cartridge
9940B-C 400 GB Compressed 9940B format, using a StorageTek 9940 cartridge
M8100 10 GB Uncompressed (standard) format, using a 10 GB cartridge
M8100C 10 GB Compressed format, using a 10 GB cartridge. Because there is no mechanism to determine the type of cartridge in an M8100 drive, the server assumes a 10 GB estimated uncompressed capacity.
T9840C 40 GB Uncompressed T9840C format, using a StorageTek 9840 cartridge
T9840C-C 80 GB Compressed T9840C format, using a StorageTek 9840 cartridge
T9840D 75 GB Uncompressed T9840D format, using a StorageTek 9840 cartridge
T9840D-C 150 GB Compressed T9840D format, using a StorageTek 9840 cartridge
T10000A 500 GB Uncompressed T10000A format, using a StorageTek T10000 cartridge
T10000A-C 1 TB Compressed T10000A format, using a StorageTek T10000 cartridge
T10000B 1 TB Uncompressed T10000B format, using an Oracle StorageTek T10000 cartridge
T10000B-C 2 TB Compressed T10000B format, using an Oracle StorageTek T10000 cartridge
T10000C 5 TB Uncompressed T10000C format, using an Oracle StorageTek T10000 T2 cartridge
T10000C-C 10 TB Compressed T10000C format, using an Oracle StorageTek T10000 T2 cartridge
Notes:
  • Some formats use a tape drive hardware compression feature. Depending on the effectiveness of compression, the actual capacity might be double or more than the listed value.
  • T10000A drives can read and write the T10000A format only. T10000B drives can read, but cannot write, the T10000A format. T10000C drives can read, but cannot write, the T10000A and T10000B formats.
ESTCAPacity
Specifies the estimated capacity for the volumes that are assigned to this device class. This parameter is optional.

You can specify this parameter if the default estimated capacity for the device class is inaccurate due to compression of data.

You must specify this value as an integer followed by K (kilobytes), M (megabytes), G (gigabytes), or T (terabytes). The smallest value that is allowed is 1 MB (that is, ESTCAPACITY=1M).

For example, ESTCAPACITY=5M specifies that the estimated capacity for a volume in this device class is 5 MB.

PREFIX
Specifies the high-level qualifier of the data set name that the server writes into the sequential access media labels. For each sequential access volume assigned to this device class, the server uses this prefix to create the data set name. This parameter is optional. The default value is ADSM.

If you previously established a tape label naming convention that supports your current tape management system, use a tape volume prefix that conforms to your naming conventions.

Values specified for this parameter must meet the following conditions:
  • The value is to be made up of qualifiers, which can be a maximum of eight characters including periods. For example, the following value is acceptable:
         AB.CD2.E
  • The qualifiers must be separated by a single period.
  • The first letter of each qualifier must be alphabetic or national (@,#,$), followed by alphabetic, national, hyphen, or numeric characters.

ADSM.BFS is an example of a tape volume file name that uses the default prefix and the added server qualifier.

MOUNTRetention
Specifies the number of minutes to retain an idle sequential access volume before dismounting it. This parameter is optional. The default value is 60. You can specify a number from 0 to 9999.

This parameter can improve response time for sequential access media mounts by leaving previously mounted volumes online. However, for EXTERNAL library types (that is, a library that is managed by an external media management system), set this parameter to a low value (for example, two minutes) to enhance device sharing between applications.

MOUNTWait
Specifies the maximum number of minutes the server waits for an operator to respond to a request to either mount a volume in a drive in a manual library or check in a volume to be mounted in an automated library. This parameter is optional. If the mount request is not satisfied within the specified amount of time, the mount request is canceled. The default value is 60 minutes. You can specify a number from 0 to 9999.
MOUNTLimit
Specifies the maximum number of sequential access volumes that can be simultaneously mounted for the device class. This parameter is optional. The default is DRIVES. You can specify a number from 0 to 4096.

If you plan to use the simultaneous-write function, ensure that sufficient drives are available for the write operation. If the number of drives needed for a simultaneous-write operation is greater than the value of the MOUNTLIMIT parameter for a device class, the transaction fails.

The following are possible values:
DRIVES
Specifies that every time a mount point is allocated, the number of drives that are defined to the library is used to calculate the true value (including online status).
Tip: For EXTERNAL library types, do not use the DRIVES default for the MOUNTLIMIT value. Specify the number of drives for the library as the MOUNTLIMIT value.
number
Specifies the maximum number of drives that are used concurrently in this device class by the server. This value must never be allowed to exceed the number of drives that are defined and online in the library that services this device class.
0 (zero)
Specifies that no new transactions can gain access to the storage pool.
DRIVEEncryption
Specifies whether drive encryption is allowed. This parameter is optional. The default is ALLOW.
Restrictions:
  1. You can use drive encryption only for the following drives:
    • Oracle StorageTek T10000B drives that have a format value of DRIVE, T10000B, or T10000B-C
    • Oracle StorageTek T10000C drives that have a format value of DRIVE, T10000C, or T10000C-C
  2. You cannot specify Tivoli Storage Manager as the key manager for drive encryption of write once, read many (WORM) media. You cannot specify both WORM=Yes and DRIVEENCRYPTION=ON.
  3. If encryption is enabled for a device class, and the device class is associated with a storage pool, the storage pool should not share a scratch pool with other device classes that cannot be encrypted. If a tape is encrypted, and you plan to use it on a drive that cannot be encrypted, you must manually relabel the tape before it can be used on that drive.
ON
Specifies that Tivoli Storage Manager is the key manager for drive encryption and allows drive encryption for empty storage pool volumes only if the application method is enabled. (Other types of volumes are not encrypted. For example, back up sets, export volumes, and database backup volumes are not encrypted.) If you specify ON and you enable another method of encryption, drive encryption is not allowed and backup operations fail.
ALLOW
Specifies that Tivoli Storage Manager does not manage the keys for drive encryption. However, drive encryption for empty volumes is allowed if another method of encryption is enabled.
EXTernal
Specifies that Tivoli Storage Manager does not manage the keys for drive encryption. Use this setting with an encryption methodology that is provided by another vendor and that is used with Application Method Encryption (AME) enabled on the drive. When you specify EXTERNAL and Tivoli Storage Manager detects that AME encryption is enabled, Tivoli Storage Manager does not turn off encryption. By contrast, when you specify ALLOW and Tivoli Storage Manager detects that AME encryption is enabled, Tivoli Storage Manager turns off encryption.
OFF
Specifies that drive encryption is not allowed. If you enable another method of encryption, backups fail. If you enable the application method, Tivoli Storage Manager disables encryption and backups are not attempted.


Feedback