Tivoli Header

Administrator's Reference


DEFINE DEVCLASS (Define a Device Class)

Use this command to define a device class.

Note:
The DISK device class is defined by Tivoli Storage Manager and cannot be modified with the DEFINE DEVCLASS command.

The syntax and parameter descriptions are provided according to the device type. The syntax and parameter information is presented in the following order:

DEFINE DEVCLASS -- 3590

Privilege Class

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

Syntax

>>-DEFine DEVclass--device_class_name--DEVtype--=--3590--------->
 
                             .-COMPression--=--Yes-----.
>--+----------------------+--+-------------------------+-------->
   '-ESTCAPacity--=--size-'  '-COMPression--=--+-Yes-+-'
                                               '-No--'
 
   .-MAXCAPacity--=--0----.
>--+----------------------+------------------------------------->
   '-MAXCAPacity--=--size-'
 
   .-PREFIX--=--ADSM-------------------.
>--+-----------------------------------+------------------------>
   '-PREFIX--=--+-ADSM---------------+-'
                '-tape_volume_prefix-'
 
   .-MOUNTRetention--=--60------.  .-MOUNTWait--=--60------.
>--+----------------------------+--+-----------------------+---->
   '-MOUNTRetention--=--minutes-'  '-MOUNTWait--=--minutes-'
 
   .-MOUNTLimit--=--2------.
>--+-----------------------+--+----------------------------+---->
   '-MOUNTLimit--=--number-'  '-EXPiration--=--+-yyyyddd-+-'
                                               '-yyddd---'
 
                           .-PROtection--=--No------------.
>--+--------------------+--+------------------------------+----->
   '-RETention--=--days-'  '-PROtection--=--+-No--------+-'
                                            +-Yes-------+
                                            '-Automatic-'
 
   .-UNIT--=--3590------.
>--+--------------------+--------------------------------------><
   '-UNIT--=--unit_name-'
 
 

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.

DEVtype=3590 (Required)
Specifies the 3590 device type is assigned to the device class. 3590 indicates that 3590 cartridge tape devices are assigned to the device class.

ESTCAPacity
Specifies the estimated capacity for the volumes assigned to this device class. This parameter is optional. The default estimated capacity for 3590 tapes is 9G.

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

Note:
This value is ignored if you specify a value other than 0 in the MAXCAPACITY parameter. If the server uses the value specified in the ESTCAPACITY parameter, this value does not determine the amount of data stored on the volume, but only determines the usage before the volume is filled. After a volume is full, the actual amount of data stored on the tape is used for these calculations.

You must specify this value as an integer followed by K (Kilobytes), M (Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (that is, ESTCAPACITY=100K).

COMPression
Specifies whether the device class is to exploit file compression. This parameter is optional. The default value is YES.

Possible values are:

Yes
Specifies that the data for each tape volume is compressed.

No
Specifies that the data for each tape volume is not compressed.

MAXCAPacity
Specifies the maximum amount of data the server can store in the volumes categorized by this device class. This parameter is optional. The default is 0.

If the MAXCAPACITY parameter is chosen and the server detects an end-of-tape situation for the specified volume, a warning message is issued and the tape is treated as full.

0
Specifies that the volume will be filled to the physical end of the volume.

size
Specify the maximum capacity of the volume. The capacity must be specified as an integer followed by K (Kilobytes), M (Megabytes), or G (Gigabytes).

Set the capacity to a nonzero value less than the maximum capacity of the tape to avoid an end-of-tape situation.

PREFIX
Specifies the high-level qualifier of the data set name in the tape labels. For all tape volumes 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. Values specified for this parameter must meet the following conditions:

An example of a tape volume data set name using the default prefix is ADSM.BFS.

If you have already established a tape label naming convention that supports your current tape management system, consider using a tape volume prefix that conforms to your naming conventions.

MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle tape volume before dismounting it. Mount retention time begins after the idle time-out period has expired. 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 tape mounts by leaving the previously mounted volume online.

MOUNTWait
Specifies the maximum number of minutes to wait for a sequential access volume to be mounted. 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 tape volumes that can be simultaneously mounted for a device class. This parameter is optional. The default value is 2. You can specify a number from 1 to 256.

You cannot share drives between device classes (that is, the sum of your mount limits should not be more than the number of physical drives allocated to the server).

EXPiration
Specifies the expiration date that is placed on the tape labels for this device class. This parameter is optional. There is no default value.

If you specify this parameter, enter the expiration date when the server no longer requires the tape. The server does not use this information, however; this information is passed to the operating system for use by MVS or tape management systems. For additional information, see the Administrator's Guide.

If you specify this parameter, you cannot specify the RETENTION parameter. Possible values are:

yyyyddd
Specifies the expiration date for this device class, in YYYYDDD format.

yyddd
Specifies the expiration date for this device class, in YYDDD format.
Note:
For dates after 2000, use YYYYDDD. YYDDD should only be used for any special processing dates, such as 99365 or 99366 which can mean to keep this data forever.

RETention
Specifies the number of days to retain the tape. This parameter is optional. You can specify a number from 1 to 9999. If you specify this parameter, enter the number of days that equals the length of time the server is expected to use the tape. The server does not use this information, but the information is passed to the operating system for use by MVS or tape management systems. For additional information, see the Administrator's Guide.

If you specify this parameter, you cannot specify the EXPIRATION parameter.

PROtection
Specifies whether RACF, if installed, protects volumes assigned to this device class. If protection is provided, RACF profiles are created for the volumes. This parameter is optional. The default value is NO. Possible values are:

No
Specifies that RACF does not protect 3590 volumes assigned to this device class.

Yes
Specifies that RACF protects 3590 volumes assigned to this device class. RACF profiles are created for volumes when the server first uses the volumes, but the profiles are not deleted when volumes are deleted from the server. Profiles will have to be manually deleted.

Automatic
Specifies that RACF protects 3590 volumes assigned to this device class. RACF profiles are deleted when volumes are deleted from the server.
Important:
If you specify PROTECTION=AUTOMATIC, volumes deleted from the server will no longer be RACF-protected and the data on these volumes will be accessible by other users.

If you specify PROTECTION=AUTOMATIC, the server will issue RACROUTE commands to delete profiles when a volume is deleted from the server. The deletion commands issued will depend on the current system settings for TAPEVOL and TAPEDSN. If the system settings are changed, the server may not delete existing profiles. See the following note for more information on this parameter.

Note:
If sensitive data is stored on volumes assigned to this device class, it is recommended that PROTECTION=YES be specified and that RACF profiles be manually deleted after tape cartridges have been erased.

The profiles created when you specify PROTECTION=YES or PROTECTION=AUTOMATIC depend on the system RACF settings. The protection provided is the same as using PROTECT=YES in JCL. If RACF is active and both TAPEVOL and TAPEDSN are inactive, allocation of tapes will fail. See RACF Security Administrator's Guide for more information on the TAPEVOL and TAPEDSN settings and the profiles that will be created when they are active.

Profile creation and deletion occur based on the protection setting when the volume is first used and when it is deleted. The server does not attempt to create profiles for volumes that it has already used. If protection is set to AUTOMATIC, the server will attempt to delete profiles when volumes are deleted.

It is not recommended that you change protection to AUTOMATIC for a device class that has been set to NO. Volumes without profiles may exist and error messages will be generated when volumes are deleted. If a different value is required, a new device class should be defined.

UNIT
Specifies an esoteric unit name to specify a group of tape devices that support 3590 tape. This parameter is optional. The default value is 3590. This name can be as many as 8 characters.

DEFINE DEVCLASS -- CARTRIDGE

Privilege Class

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

Syntax

>>-DEFine DEVclass--device_class_name--DEVtype--=--CARTridge---->
 
                             .-MAXCAPacity--=--0----.
>--+----------------------+--+----------------------+----------->
   '-ESTCAPacity--=--size-'  '-MAXCAPacity--=--size-'
 
   .-COMPression--=--Yes-----.
>--+-------------------------+---------------------------------->
   '-COMPression--=--+-Yes-+-'
                     '-No--'
 
   .-PREFIX--=--ADSM-------------------.
>--+-----------------------------------+------------------------>
   '-PREFIX--=--+-ADSM---------------+-'
                '-tape_volume_prefix-'
 
   .-MOUNTRetention--=--60------.  .-MOUNTWait--=--60------.
>--+----------------------------+--+-----------------------+---->
   '-MOUNTRetention--=--minutes-'  '-MOUNTWait--=--minutes-'
 
   .-MOUNTLimit--=--2------.
>--+-----------------------+--+----------------------------+---->
   '-MOUNTLimit--=--number-'  '-EXPiration--=--+-yyddd---+-'
                                               '-yyyyddd-'
 
                           .-PROtection--=--No------------.
>--+--------------------+--+------------------------------+----->
   '-RETention--=--days-'  '-PROtection--=--+-No--------+-'
                                            +-Yes-------+
                                            '-Automatic-'
 
   .-UNIT--=--3480------.
>--+--------------------+--------------------------------------><
   '-UNIT--=--unit_name-'
 
 

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.

DEVtype=CARTridge (Required)
Specifies the CARTRIDGE device type is assigned to the device class. CARTRIDGE indicates that cartridge tape devices are assigned to the device class.

ESTCAPacity
Specifies the estimated capacity for the volumes 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.

Note:
This value is ignored if you specify a value other than 0 in the MAXCAPACITY parameter. If the server uses the value specified in the ESTCAPACITY parameter, this value does not determine the amount of data stored on the volume, but only determines the usage before the volume is filled. After a volume is full, the actual amount of data stored on the tape is used for these calculations.

You must specify this value as an integer followed by K (Kilobytes), M (Megabytes), or G (Gigabytes). The smallest value allowed is 100KB (ESTCAPACITY=100K).

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

For more information on the default estimated capacity for cartridge tapes, see Table 44.

Table 44. Recording Formats and Default Estimated Capacities for Cartridge Tapes

Format Media Type Estimated Capacity
3480 (Not applicable) 180MB
3480XF (Not applicable) 180MB
3490 Base CST 180MB
3490B CST 360MB
3490C CST 360MB
3490B ECCST 720MB
3490C ECCST 720MB
Note:

3490 Base devices include models A01, A02, A10, A20, B02, B04, B20, B40, D41, D42.

3490E devices include models C1A, C2A, C10, C11, C22

MAXCAPacity
Specifies the maximum amount of data the server can store in the volumes categorized by this device class. This parameter is optional. The default is 0.

If the MAXCAPACITY parameter is chosen and the server detects an end-of-tape situation for the specified volume, a warning message is issued and the tape is treated as full.

0
Specifies that the volume will be filled to the physical end of the volume. The server uses a default method based on IBM 3480 and 3490E device characteristics using IBM tapes. It writes to the end of the tape to determine the maximum capacity.

size
Specify the maximum capacity of the volume. The capacity must be specified as an integer followed by K (Kilobytes), M (Megabytes), or G (Gigabytes).

Set the capacity to a nonzero value less than the maximum capacity of the tape to avoid an end-of-tape situation.

For example, MAXCAPACITY=5M specifies that the maximum capacity for this device class is 5 megabytes.

COMPression
Specifies whether the device class is to exploit file compression. This parameter is optional. The default value is YES.

If your tape devices have IDRC, then data can be compressed when written to CARTRIDGE tape devices. If your tape devices do not have IDRC, then the compression attribute is ignored and data is not compressed.

Also, if your tape volumes can be moved to other physical sites, ensure that the compressed data can be read at the other sites. If the other sites cannot read compressed data, you want to specify COMPRESSION=NO. Possible values are:

Yes
Specifies that the data for each tape volume is compressed.

No
Specifies that the data for each tape volume is not compressed.

PREFIX
Specifies the high-level qualifier of the data set name in the tape labels. For all tape volumes 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. Values specified for this parameter must meet the following conditions:

An example of a tape volume data set name using the default prefix is ADSM.BFS.

If you have already established a tape label naming convention that supports your current tape management system, consider using a tape volume prefix that conforms to your naming conventions.

MOUNTRetention
Specifies the amount of time, in minutes, to retain an idle tape volume before dismounting it. Mount retention time begins after the idle time-out period has expired. 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 tape mounts by leaving the previously mounted volume online.

MOUNTWait
Specifies the maximum number of minutes to wait for a sequential access volume to be mounted. 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 tape volumes that can be simultaneously mounted for a device class. This parameter is optional. The default value is 2. You can specify a number from 1 to 256.

You cannot share drives between device classes (that is, the sum of your mount limits should not be more than the number of physical drives allocated to the server).

EXPiration
Specifies the expiration date that is placed on the tape labels for this device class. This parameter is optional. There is no default value.

If you specify this parameter, enter the expiration date when the server no longer requires the tape. The server does not use this information, however; this information is passed to the operating system for use by MVS or tape management systems. For additional information, see the Administrator's Guide.

If you specify this parameter, you cannot specify the RETENTION parameter. Possible values are:

yyddd
Specifies the expiration date for this device class, in YYDDD format.

yyyyddd
Specifies the expiration date for this device class, in YYYYDDD format.

RETention
Specifies the number of days to retain the tape. This parameter is optional. You can specify a number from 1 to 9999. If you specify this parameter, enter the number of days that equals the length of time the server is expected to use the tape. The server does not use this information, however; this information is passed to the operating system for use by MVS or tape management systems. For additional information, see the Administrator's Guide.

If you specify this parameter, you cannot specify the EXPIRATION parameter.

PROtection
Specifies whether RACF, if installed, protects volumes assigned to this device class. If protection is provided, RACF profiles are created for the volumes. This parameter is optional. The default value is NO. Possible values are:

No
Specifies that RACF does not protect CARTRIDGE volumes assigned to this device class.

Yes
Specifies that RACF protects CARTRIDGE volumes assigned to this device class. RACF profiles are created for volumes when the server first uses the volumes, but the profiles are not deleted when volumes are deleted from the server. Profiles will have to be manually deleted.

Automatic
Specifies that RACF protects CARTRIDGE volumes assigned to this device class. RACF profiles are deleted when volumes are deleted from the server.
Important:
If you specify PROTECTION=AUTOMATIC, volumes deleted from the server will no longer be RACF-protected and the data on these volumes will be accessible by other users.

If you specify PROTECTION=AUTOMATIC, the server will issue RACROUTE commands to delete profiles when a volume is deleted from the server. The deletion commands issued will depend on the current system settings for TAPEVOL and TAPEDSN. If the system settings are changed, the server may not delete existing profiles. See the following note for more information on this parameter.

Note:
If sensitive data is stored on volumes assigned to this device class, it is recommended that PROTECTION=YES be specified and that RACF profiles be manually deleted after tape cartridges have been erased.

The profiles created when you specify PROTECTION=YES or PROTECTION=AUTOMATIC depend on the system RACF settings. The protection provided is the same as using PROTECT=YES in JCL. If RACF is active and both TAPEVOL and TAPEDSN are inactive, allocation of tapes will fail. See RACF Security Administrator's Guide, SC28-1340 for more information on the TAPEVOL and TAPEDSN settings and the profiles that will be created when they are active.

Profile creation and deletion occur based on the protection setting when the volume is first used and when it is deleted. The server does not attempt to create profiles for volumes that it has already used. If protection is set to AUTOMATIC, the server will attempt to delete profiles when volumes are deleted.

It is not recommended that you change protection to AUTOMATIC for a device class that has been set to NO. Volumes without profiles may exist and error messages will be generated when volumes are deleted. If a different value is required, a new device class should be defined.

UNIT
Specifies an esoteric unit name to specify a group of tape devices that support Cartridge System tape. This parameter is optional. The default value is 3480. This name can be as many as 8 characters.

Examples

Task

Define a device class named SQUARE1 with a CARTRIDGE tape device and with RACF protection active for all tape volumes assigned to this device class. All data is compressed for this device class.

Command:
define devclass square1 devtype=cartridge compression=yes protection=yes

DEFINE DEVCLASS -- FILE

Use the FILE device class when you are using files on magnetic disk storage as volumes that store data sequentially (as on tape).

Privilege Class

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

Syntax

>>-DEFine DEVclass--device_class_name--DEVType--=--FILE--------->
 
   .-MOUNTLimit--=--2------.
>--+-----------------------+------------------------------------>
   '-MOUNTLimit--=--number-'
 
   .-PREFIX--=--ADSM---------------.
>--+-------------------------------+---------------------------->
   '-PREFIX--=--tape_volume_prefix-'
 
   .-MAXCAPacity--=--1M---.  .-UNIT--=--""--------.
>--+----------------------+--+--------------------+------------->
   '-MAXCAPacity--=--size-'  '-UNIT--=--unit_name-'
 
   .-VOLSER--=--""-------------------.
>--+---------------------------------+-------------------------><
   '-VOLSER--=--volume_serial_number-'
 
 

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.

DEVType=FILE (Required)
Specifies that the FILE device type is assigned to the device class. FILE indicates that a file is assigned to this device class. When the server needs to access a volume that belongs to this device class, it opens a file and reads or writes file data.

MOUNTLimit
Specifies the maximum number of FILE volumes that can be concurrently open at any one time for this device class. This parameter is optional. The default value is 2. For 3995 devices emulating 3390 devices, this value should not be set higher than the number of concurrent input/output streams possible on the media storing the volumes.

Because FILE volumes are classified as sequential media, processing conventions normally associated with sequential media are followed. Specifically, this means that mount limits are observed, and that data that has expired leaves holes in the volume and volumes can only be recycled through either the MOVE DATA command or the volume reclamation process. Only one process can read or write to a volume at a time. This has important implications for clients backing up directly to FILE media. The number of active clients is limited to the value specified in the MOUNTLIMIT parameter for the device class.

The value you specify in this parameter is important if there is a significant penalty switching from one volume to another (switching can take place when using 3995 devices emulating 3390 devices). The value you specify in this parameter should be no higher than the number of physical drives available on the device.

PREFIX
Specifies the high-level qualifier of the data set name that is used to allocate scratch volume data sets. For all scratch file volumes created in this device class, the server uses this prefix to create the data set name. This parameter is optional. The default is ADSM.

Values specified for this parameter must meet the following conditions:

An example of a file volume data set name using the default prefix is ADSM.B0000021.BFS.

If you have established a data set naming convention, consider using a file prefix that conforms to your naming conventions.

MAXCAPacity
Specifies the maximum size of any data storage files defined to a storage pool in this device class. The default value is 1MB (MAXCAPACITY=1M). MAXCAPACITY=5M specifies that the maximum capacity for a volume in this device class is 5 megabytes. This parameter is optional.

If you are explicitly allocating FILE volume data sets, be sure the allocated capacity matches the maximum capacity. File volumes are allocated in 16KB blocks. Thus, if the maximum capacity is 50MB, you should allocate 3200 blocks. A combination of primary and secondary extents may be specified to achieve the allocation. When the server detects that a volume has reached a size equal to the maximum capacity, it treats the volume as full and tries to store any new data on a different volume.

Note:
File volumes of 256MB or smaller will be allocated with a single primary extent. Volumes larger than 256MB will be allocated with a 256MB primary extent and secondary extents of 1/15 of the remaining required space.

size
Specify this value as an integer followed by K (Kilobytes), M (Megabytes), or G (Gigabytes). The minimum value allowed is 100KB (MAXCAPACITY=100K).

UNIT
Specifies the unit name that indicates on which device to place the FILE volumes. You can specify any unit name that is known to your MVS installation. The maximum length of the unit name is 8 characters. The default value is a null string (""). This parameter is optional.

VOLSER
Specifies the volume serial number of a DASD on which to place FILE volumes. The volser can be any volume serial number known to your MVS installation. The maximum length of the volser is 6 characters. The default value is a null string (""). This parameter is optional.
Note:
Specifying a value for this parameter requires you to also specify a value for the UNIT parameter.

DEFINE DEVCLASS -- SERVER

Privilege Class

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

Syntax

>>-DEFine DEVclass--device_class_name--DEVType--=--SERVER------->
 
                               .-MAXCAPacity--=--500M-.
>--SERVERName--=--server_name--+----------------------+--------->
                               '-MAXCAPacity--=--size-'
 
   .-MOUNTLimit--=--1------.  .-MOUNTRetention--=--60------.
>--+-----------------------+--+----------------------------+---->
   '-MOUNTLimit--=--number-'  '-MOUNTRetention--=--minutes-'
 
   .-PREFIX--=--ADSM--------------.
>--+------------------------------+----------------------------->
   '-PREFIX--=--+-ADSM----------+-'
                '-volume_prefix-'
 
   .-RETRYPeriod--=--10--------------------.
>--+---------------------------------------+-------------------->
   '-RETRYPeriod--=--retry_value_(minutes)-'
 
   .-RETRYInterval--=--30--------------------.
>--+-----------------------------------------+-----------------><
   '-RETRYInterval--=--retry_value_(seconds)-'
 
 

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.

DEVType=SERVER (Required)
Specifies a remote connection that supports virtual volumes.

SERVERName (Required)
Specifies the name of the server. The SERVERNAME parameter must match a defined server.

MAXCAPacity
Specifies the maximum size for objects created on the target server; the default for this value is 500M. This parameter is optional.

500M
Specifies that the maximum capacity is 500M (500MB).

size
Specify this value as an integer followed by K (Kilobytes), M (Megabytes), or G (Gigabytes). The minimum value allowed is 100KB (MAXCAPACITY=100K).

MOUNTLimit
Specifies the maximum number of simultaneous sessions between the source server and the target server. Any attempts to access more sessions than indicated by the mount limit cause the requester to wait. This parameter is optional. The default value is 1. You can specify a number from 1 to 256.

The following are possible values:

1
Specifies that only one session between the source server and the target server is allowed.

number
Specifies the number of simultaneous sessions between the source server and the target server.

MOUNTRetention
Specifies the number of minutes to retain an idle connection with the target server before closing the connection. This parameter is optional. The default value is 60. You can specify a number from 0 to 9999.

PREFIX
Specifies the beginning portion of the high-level archive file name on the target server. This parameter is optional. The default value is ADSM. The maximum length of this prefix is 8 characters.

Values specified for this parameter must meet the following conditions:

An example of a high level archive file name using the default prefix is ADSM.volume1.

RETRYPeriod
Specifies the retry period in minutes. The retry period is the interval during which the server attempts to contact a target server if there is a suspected communications failure. This parameter is optional. The default value is 10 minutes.

RETRYInterval
Specifies the retry interval in seconds. The retry interval is how often retries are done within a given time period. This parameter is optional. The default value is 30 seconds.

Related Commands


Table 45. Commands Related to DEFINE DEVCLASS

Command Description
BACKUP DEVCONFIG Backs up Tivoli Storage Manager device information to a file.
DELETE DEVCLASS Deletes a device class name.
QUERY DEVCLASS Displays information about device classes.
UPDATE DEVCLASS Changes the attributes of a device class.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]