Administrator's Reference
Use this command to define a device class to support the sequential access
devices at your installation.
Note: | The DISK device class is predefined by TSM 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:
Privilege Class
To issue this command, you must have system privilege or unrestricted
storage privilege.
Syntax
>>-DEFine DEVclass--device_class_name----DEVType--=--FILE------->
.-MOUNTLimit--=--1----------------.
>-----+---------------------------------+----------------------->
'-MOUNTLimit--=--mountlimitvalue--'
.-MAXCAPacity--=--4M----.
>-----+-----------------------+--------------------------------->
'-MAXCAPacity--=--size--'
.-DIRectory--=--current_directory_name--.
>-----+---------------------------------------+----------------><
'-DIRectory--=--directory_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=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. A file is
a form of sequential access media.
- MOUNTLimit
- Specifies the maximum number of files that can be simultaneously open for
input/output. This parameter is optional. The default value is
1. You can specify a number from 1 to 256.
- MAXCAPacity
- Specifies the maximum size of any data storage files defined to a storage
pool in this device class. This parameter is optional. You must
specify this value as an integer followed by K (Kilobytes),
M (Megabytes), or G (Gigabytes).
For example, MAXCAPACITY=5M specifies that the maximum capacity for a
volume in this device class is 5 megabytes. The default value is 4MB
(MAXCAPACITY=4M). The minimum value allowed is 100KB
(MAXCAPACITY=100K). The maximum value is 128GB
(MAXCAPACITY=128G).
Do not define a MAXCAPACITY value greater than 640M when this file is for
REMOVABLEFILE CD-ROM support. A value less than a CD-ROM's usable
space (650MB) allows for a one-to-one match between files from the FILE device
class and copies that are on CD-ROM.
- DIRectory
- Specifies the directory location of the file used in this device
class. This parameter is optional. The default is the current
working directory of the server at the time the command is issued, unless the
DSMSERV_DIR environment variable has been set. For additional
information about the DSMSERV_DIR variable, refer to Quick
Start.
By specifying a directory name, you identify the location where the server
places the files that represent storage volumes for this device class.
While processing the command, the server expands the specified directory name
into its fully qualified form, starting from the root directory.
Later, if the server needs to allocate a scratch volume, it creates a new
file in this directory. For scratch volumes used to store client data,
the file created by the server has a file name extension of
.BFS. For scratch volumes used to store export data, a file name
extension of .EXP is used. For example, if you define a device
class with a DIRECTORY of /TSMSTOR and the server needs a
scratch volume in this device class to store export data, the file that the
server creates may be named
/TSMSTOR/00566497.EXP.
Examples
Task
Define a device class named PLAINFILES with a file device type and a
maximum capacity of 50MB.
- Command:
- define devclass plainfiles devtype=file maxcapacity=50m
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--=--maxcap--'
.-MOUNTLimit--=--1----------------.
>-----+---------------------------------+----------------------->
'-MOUNTLimit--=--mountlimitvalue--'
.-MOUNTRetention--=--60-------.
>-----+-----------------------------+--------------------------->
'-MOUNTRetention--=--minutes--'
.-PREFIX--=--ADSM----------.
>-----+--------------------------+------------------------------>
'-PREFIX--=--+-ADSM------+-'
'-volprefix-'
.-RETRYPeriod--=--10-------------------.
>-----+--------------------------------------+------------------>
'-RETRYPeriod--=--retryvalue(minutes)--'
.-RETRYInterval--=--30-------------------.
>-----+----------------------------------------+---------------><
'-RETRYInterval--=--retryvalue(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.
Note: | If you change the SERVERNAME of an existing server to a new name, data on the
volumes under the old SERVERNAME will no longer be accessible with this device
class.
|
- MAXCAPacity
- Specifies the maximum size that objects can be when created on the target
server; the default for this value is 500M. This parameter is
optional. You must specify this value as an integer followed by
K (Kilobytes), M (Megabytes), or G
(Gigabytes).
For example, MAXCAPACITY=5M specifies that the maximum capacity for a
volume in this device class is 5 megabytes. The default value is 500M
(MAXCAPACITY=500M). The minimum value allowed is 100KB
(MAXCAPACITY=100K).
- MOUNTLimit
- Specifies the maximum number of volumes that can be simultaneously open
for input/output. This parameter is optional. The default value
is 1. You can specify a number from 1 to 256.
- 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.
This parameter can improve response time for sequential access media mounts
by leaving previously mounted volumes online.
- 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:
- The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would
be acceptable:
AB.CD2.E
- The qualifiers must be separated by a single period.
- The first letter of each qualifier must be alphabetical or national
(@,#,$), followed by alphabetical, national, hyphen, or numeric
characters.
An example of a high level archive file name using the default prefix (with
the TSM qualifier added) 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.
Privilege Class
To issue this command, you must have system privilege or unrestricted
storage privilege.
Syntax
>>-DEFine DEVclass--device_class_name----DEVType--=--3590------->
.-FORMAT--=--DRIVE-----.
>-----+----------------------+--LIBRary--=--library_name-------->
'-FORMAT--=--+-DRIVE-+-'
+-3590B-+
'-3590C-'
.-MOUNTRetention--=--60-------.
>-----+-----------------------------+--------------------------->
'-MOUNTRetention--=--minutes--'
.-PREFIX--=--ADSM--------------.
>-----+------------------------------+-------------------------->
'-PREFIX--=--+-ADSM----------+-'
'-tapevolprefix-'
.-MOUNTWait--=--60-------.
>-----+-----------------------+---+------------------------+---->
'-ESTCAPacity--=--size--' '-MOUNTWait--=--minutes--'
.-MOUNTLimit--=--DRIVES--------------.
>-----+------------------------------------+-------------------><
'-MOUNTLimit--=--+-DRIVES----------+-'
+-mountlimitvalue-+
'-0---------------'
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 IBM 3590 cartridge tape devices are assigned to this
device class.
- FORMAT
- Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is
DRIVE.
The following are possible values for 3590 devices:
- DRIVE
- Specifies that TSM selects the highest format that can be supported by the
sequential access drive on which a volume is mounted.
- 3590B
- Specifies that TSM writes data using the basic (uncompressed)
format. This results in a tape capacity of approximately 10GB.
- 3590C
- Specifies that TSM writes data using the compressed format. This
results in a tape capacity of approximately 10GB. However, this format
uses the tape drive's hardware compression feature so the actual capacity
may be greater depending on the effectiveness of compression.
- LIBRary
- Specifies the name of the defined library object that contains the tape
drives that can be used by this device class. For information about
defining a library object, see the DEFINE LIBRARY command.
- MOUNTRetention
- Specifies the amount of time, in 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 previouslyvolumes online.
- 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, TSM uses this prefix to create
the data set name. This parameter is optional. The default value
is ADSM. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that
supports your current management system, use a volume prefix that conforms to
your naming conventions.
- The value is to be made up of qualifiers, which can contain up to 8
characters (including periods). For example, the following value would
be acceptable:
AB.CD2.E
- The qualifiers must be separated by a single period.
- The first letter of each qualifier must be alphabetical or national
(@,#,$), followed by alphabetical, national, hyphen, or numeric
characters.
- ESTCAPacity
- Specifies the estimated capacity for the sequential access volumes
categorized by 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), or G (Gigabytes).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes. The smallest value allowed
is 100KB (that is, ESTCAPACITY=100K).
- MOUNTWait
- Specifies the maximum number of minutes to wait for a sequential access
volume to be mounted in a manual library. This parameter is optional
and does not apply to automated libraries. 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 256.
Note: | 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.
|
The following are possible values:
- DRIVES
- Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
- mountlimitvalue
- Specifies the maximum number of drives used concurrently in this device
class by TSM. 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.
Privilege Class
To issue this command, you must have system privilege or unrestricted
storage privilege.
Syntax
>>-DEFine DEVclass--device_class_name----DEVType--=--3570------->
.-FORMAT--=--DRIVE-----.
>-----+----------------------+--LIBRary--=--library_name-------->
'-FORMAT--=--+-DRIVE-+-'
+-3570B-+
'-3570C-'
.-MOUNTRetention--=--60-------.
>-----+-----------------------------+--------------------------->
'-MOUNTRetention--=--minutes--'
.-PREFIX--=--ADSM--------------.
>-----+------------------------------+-------------------------->
'-PREFIX--=--+-ADSM----------+-'
'-tapevolprefix-'
.-MOUNTWait--=--60-------.
>-----+-----------------------+---+------------------------+---->
'-ESTCAPacity--=--size--' '-MOUNTWait--=--minutes--'
.-MOUNTLimit--=--DRIVES--------------.
>-----+------------------------------------+-------------------><
'-MOUNTLimit--=--+-DRIVES----------+-'
+-mountlimitvalue-+
'-0---------------'
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=3570 (Required)
- Specifies the 3570 device type is assigned to the device class. The
3570 indicates that IBM 3570 cartridge tape devices are assigned to this
device class.
- FORMAT
- Specifies the recording format to be used when writing data to sequential
access media. This parameter is optional; the default value is
DRIVE.
The following are possible values for 3570 devices:
- DRIVE
- Specifies that TSM selects the highest format that can be supported by the
sequential access drive on which a volume is mounted.
- 3570B
- Specifies that TSM writes data that uses the basic (uncompressed)
format. This results in a tape capacity of approximately 5GB.
- 3570C
- Specifies that TSM writes data that uses the compressed format.
This results in a tape capacity of approximately 5GB. However, this
format uses the tape drive's hardware compression feature so the actual
capacity may be greater depending on the effectiveness of compression.
- LIBRary
- Specifies the name of the defined library object that contains the tape
drives that can be used by this device class. For information about
defining a library object, see the DEFINE LIBRARY command.
- MOUNTRetention
- Specifies the amount of time, in 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, setting this parameter to a low value (for example, two
minutes) enhances device sharing between applications.
- 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, TSM uses this prefix to create
the data set name. This parameter is optional. The default value
is ADSM. The maximum length of this prefix is 8 characters.
If you have already established a media label naming convention that
supports your current management system, use a 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 contain up to 8
characters (including periods). For example, the following value would
be acceptable:
AB.CD2.E
- The qualifiers must be separated by a single period.
- The first letter of each qualifier must be alphabetical or national
(@,#,$), followed by alphabetical, national, hyphen, or numeric
characters.
An example of a tape volume data set name using the default prefix (with
the TSM qualifier added) is ADSM.BFS.
- ESTCAPacity
- Specifies the estimated capacity for the sequential access volumes
categorized by 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), or G (Gigabytes).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes. The smallest value allowed
is 100KB (that is, ESTCAPACITY=100K).
For more information on the default estimated capacity for 3570 cartridge
tapes, see Table 49.
Table 49. TSM Estimated Capacity for Cartridge Tape
Tape Format
| Estimated Capacity
|
3570B
| 5GB
|
3570C
| 5GB (see note)
|
Note: | This format uses the tape drive hardware compression feature.
Depending on the effectiveness of compression, the actual capacity may be
greater than the listed value.
|
|
- MOUNTWait
- Specifies the maximum number of minutes to wait for a sequential access
volume to be mounted in a manual library. This parameter is optional
and does not apply to automated libraries. 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 256.
Note: | 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.
|
The following are possible values:
- DRIVES
- Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
- mountlimitvalue
- Specifies the maximum number of drives used concurrently in this device
class by TSM. 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.
Privilege Class
To issue this command, you must have system privilege or unrestricted
storage privilege.
Syntax
>>-DEFine DEVclass---device_class_name-------------------------->
>-----DEVType--=--GENERICTAPE---LIBRary--=--library_name-------->
.-MOUNTRetention--=--60-------.
>-----+-----------------------------+--------------------------->
'-MOUNTRetention--=--minutes--'
.-MOUNTWait--=--60-------.
>-----+-----------------------+---+------------------------+---->
'-ESTCAPacity--=--size--' '-MOUNTWait--=--minutes--'
.-MOUNTLimit--=--DRIVES--------------.
>-----+------------------------------------+-------------------><
'-MOUNTLimit--=--+-DRIVES----------+-'
+-mountlimitvalue-+
'-0---------------'
When using this device type, the server does not recognize either the type
of device or the cartridge recording format. Because the server does
not recognize the type of device, if an I/O error occurs, error information is
less detailed compared to error information for a specific device type (for
example, 8mm). When defining devices to the server, do not mix various
types of devices within the same device type.
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=GENERICTAPE (Required)
- Specifies that the GENERICTAPE device type is assigned to the device
class. GENERICTAPE indicates that the volumes for this device class are
used in tape drives supported by the operating system's tape device
driver.
The server recognizes that the media can be removed and that additional
media can be inserted, subject to limits set with the MOUNTLIMIT parameter for
the device class and the MAXSCRATCH parameter for the storage pool.
Volumes in a device class with device type GENERICTAPE are sequential
access volumes.
- LIBRary
- Specifies the name of the defined library object that contains the tape
drives used by this device class. For information about defining a
library object, see the DEFINE LIBRARY command.
- MOUNTRetention
- Specifies the amount of time, in 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.
- ESTCAPacity
- Specifies the estimated capacity for the sequential access volumes
categorized by this device class. This parameter is optional.
You must specify this value as an integer followed by K
(Kilobytes), M (Megabytes), or G (Gigabytes).
For example, ESTCAPACITY=5M specifies that the estimated capacity for a
volume in this device class is 5 megabytes. The smallest value allowed
is 100KB (that is, ESTCAPACITY=100K).
Specify a capacity appropriate to the particular tape drive being
used.
- MOUNTWait
- Specifies the maximum number of minutes to wait for a sequential access
volume to be mounted in a manual library. This parameter is optional
and does not apply to automated libraries. 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 256.
Note: | 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.
|
The following are possible values:
- DRIVES
- Specifies that every time a mount point is allocated, the number of drives
defined to the library is used to calculate the true mountlimit value
(including online status).
- mountlimitvalue
- Specifies the maximum number of drives used concurrently in this device
class by TSM. 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.
Privilege Class
To issue this command, you must have system privilege or unrestricted
storage privilege.
Syntax
>>-DEFine DEVclass---device_class_name-------------------------->
>-----DEVType--=--REMOVABLEfile---LIBRary--=--library_name------>
.-MOUNTRetention--=--60-------.
>-----+-----------------------------+--------------------------->
'-MOUNTRetention--=--minutes--'
.-MOUNTWait--=--60-------.
>-----+------------------------+-------------------------------><
'-MOUNTWait--=--minutes--'
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=REMOVABLEfile (Required)
- Specifies that the REMOVABLEFILE device type is assigned to the device
class. REMOVABLEFILE indicates that the volume for this device class is
CD-ROM. The server opens a file on the media and reads the file
data. The media contains data that is copied from the FILE device class
to the removable file media. TSM does not write directly to removable
file media.
The server recognizes that the media can be removed and that additional
media can be inserted. Set limits with the MOUNTLIMIT parameter for the
device class and the MAXSCRATCH parameter for the storage pool.
When you use CD-ROM media for the REMOVABLEFILE device type, the library
type must be MANUAL. You access the media through a mount point, for
example, /dev/cdx, where x is a number that is assigned
by your operating system. Use the device manufacturer's operating
system utilities to format (if necessary) and label the media.
The label on the media must meet the following restrictions:
- No more than 11 characters
- Same name for file name and volume label
See "Configuring REMOVABLEFILE Media Devices " in
Administrator's Guide for more information.
- LIBRary
- Specifies the name of the defined library object that contains the
removable media drives used by this device class. For information about
defining a library object, see the DEFINE LIBRARY command.
- MOUNTRetention
- Specifies the amount of time, in 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.
- MOUNTWait
- Specifies the maximum number of minutes to wait for a sequential access
volume to be mounted in a manual library. This parameter is optional
and does not apply to automated libraries. 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.
Table 50. Commands Related to DEFINE DEVCLASS
Command
| Description
|
BACKUP DEVCONFIG
| Backs up TSM device information to a file.
|
DEFINE LIBRARY
| Defines an automated or manual library.
|
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 ]