IBM LTO 7 Install Users Guide
IBM LTO 7 Install Users Guide
GC27-2130-21
IBM Tape Device Drivers IBM
GC27-2130-21
ii IBM Tape Device Drivers: Installation and User's Guide
Twenty-second Edition (November 2015)
This twenty-second edition of the IBM Tape Device Drivers Installation and User's
Guide, GC27-2130-21, replaces and makes obsolete the following manual: IBM Tape
Device Drivers Installation and User's Guide, GC27-2130-20.
Note: Library firmware and tape drive firmware are verified and released together.
When updating to the latest firmware, verify that all installed components such as
tape drives, and library are at the latest levels noted on the Support website.
Mixing different levels of library and tape drive firmware is not supported and can
cause unpredictable results.
To open a Service Request online: Under Support & downloads, click Open a
service request.
Related information
A companion publication that covers programming aspects for the device drivers
is: IBM Tape Device Drivers: Programming Reference, GA32-0566.
To access the latest documentation for your product, go to the IBM Publications
Center at http://www-05.ibm.com/e-business/linkweb/publications/servlet/
pbi.wss. Select your country, then click Search for publications to find the desired
publication. Publications can be viewed and downloaded from the website.
AIX
The following URL points to information about IBM System p (also known as
pSeries) servers: http://www-1.ibm.com/servers/eserver/pseries.
HP-UX
Linux
Solaris
Microsoft Windows
Additional Information
The following publication contains additional information related to the IBM tape
drive, medium changer, and library device drivers: American National Standards
Preface ix
x IBM Tape Device Drivers: Installation and User's Guide
Sending your comments
Your feedback is important in helping us provide the most accurate and best
quality information. If you have comments or suggestions for improving this
publication, you can send us comments electronically by using these addresses.
v E-mail
Submit your comments electronically to the following e-mail address:
[email protected]
Be sure to include the name and order number of the book and, if applicable,
the specific location of the text you are commenting on, such as a page number
or table number.
v Mail
Fill out the Readers' Comments form (RCF) at the back of this book. Return it by
mail or give it to an IBM representative. If the RCF is removed, you can address
your comments to:
International Business Machines Corporation
RCF Processing Department GZW
9032 South Rita Road
Tucson, AZ 85775-4401
Note: When the page range is selected for the section you want to print, note that
the print page range is based on the page controls for Adobe Acrobat, not the page
printed on the actual document. Enter the Adobe page numbers to print.
If you want to print one or more separate sections of the manual, follow these
steps:
1. Navigate to the beginning of the section and note the page number.
2. Navigate to the last page in the section and note that page number.
3. Select File > Print, then choose Pages and enter the page range for the section.
Only the page range entered prints.
4. Repeat these steps to print additional sections.
Attention: Only one Table of Contents and one Index exists for this entire book.
If you want to print those items, you must repeat the previous process, entering
the page range for the Table of Contents and the Index page range, respectively.
Contents xvii
Standard Edition - known issues and limitations 228 Appendix A. Accessing
Standard Edition - Start menu commands . .. 232 documentation and software online .. 327
Standard Edition - Scan menu commands . .. 233
Standard Edition - Tapeutil menu commands 252
Standard Edition - Program options . . . .. 264
Appendix B. Verifying correct
Standard Edition - Tapeutil scripting commands 264 attachment of your devices . . . .. 331
IBM Tape Diagnostic Tool - Graphical Edition .. 292
Installing ITDT - Graphical Edition . . . .. 292 Appendix C. Managing the microcode
Graphical Edition - known issues and on the IBM tape drive . . . . . . .. 333
limitations . . . . . . . . . . . .. 293
ITDT-GE user interface description . . . .. 294
Notices . . . . . . . . . . . . .. 335
Graphical Edition - Scan menu commands .. 297
Graphical Edition - visualizing log files. . .. 311
Graphical Edition - Tapeutil menu commands 312 Index . . . . . . . . . . . . . .. 337
Purpose
The IBM tape and medium changer device drivers are designed specifically to take
advantage of the features that are provided by the IBM tape drives and medium
changer devices. The goal is to give applications access to the functions required
for basic tape functions (such as backup and restore) and medium changer
operations (such as cartridge mount and unmount), and to the advanced functions
needed by full tape management systems. Whenever possible, the driver is
designed to take advantage of the device features transparent to the application.
The most current information on hardware and software requirements for IBM
tape and medium changer device drivers can be found in the individual platform
readme files or with the subsequent links.
Hardware requirements
The tape drivers are developed to support various versions of different platforms.
For the latest support, refer to the Interoperation Center website -
http://www.ibm.com/systems/support/storage/config/ssic/.
Note: A single Fibre Channel host bus adapter (HBA) for concurrent tape and disk
operations is not recommended. Tape and disk devices require incompatible HBA
settings for reliable operation and optimal performance characteristics. Under stress
conditions (high I/O rates for either tape, disk, or both) where disk and tape
subsystems share a common HBA, stability problems are observed. These issues
are resolved by separating disk and tape I/O streams onto separate HBAs and by
using SAN zoning to minimize contention. IBM is focused on assuring
server/storage configuration interoperability. It is strongly recommended that your
overall implementation plan includes provisions for separating disk and tape
workloads.
For information about this issue, see the following Redbook, section 4.1.3 in
http://www.redbooks.ibm.com/abstracts/sg246502.html?Open.
Software requirements
If you use a third-party application, consult with your application provider about
the compatibility with IBM tape device drivers.
For detailed driver requirements for each operating system, refer to the appropriate
chapter. To obtain the most current service and documentation for this software,
refer to Appendix A, “Accessing documentation and software online,” on page 327.
The IBM tape product family provides an excellent solution for customers with
small to large storage and performance requirements.
1. IBM Virtualization Engine TS7520
2. IBM Virtualization Engine TS7650
| 3. IBM TS2230/TS2240/TS2250/TS2260/TS2270 tape drive
4. IBM TS2340/TS2350/TS2360 tape drive
5. IBM 3580 (Ultrium) tape drive (Model L33)
6. IBM TS1140/TS1150 tape drive (Enterprise)
7. IBM TS1120/TS1130 tape drive (Enterprise)
8. IBM TS3200 tape library
9. IBM TS3500 and TS4500 tape library (also known as IBM UltraScalable tape
library 3584)
10. IBM TS3310 tape library
11. IBM TS3100 tape library
3
4
2
10
System
Storage
1
9 8
SystemSto
rage
dd000005
Chapter 1. Introduction 3
4 IBM Tape Device Drivers: Installation and User's Guide
Chapter 2. Common extended features
Purpose
This chapter provides general information about the IBM device drivers,
requirements, and advanced functionality.
Path failover is supported on certain tape products with the latest IBM device
drivers available on the following website - http://www.ibm.com/support/
fixcentral. Instructions for downloading drivers can be found in Appendix A,
“Accessing documentation and software online,” on page 327. Some devices
require a path failover feature code to be installed before path failover support is
enabled in the device driver. Refer to “Supported devices and feature codes” on
page 10 for a list of supported devices and what path failover feature code is
required for your machine type.
At startup or configuration, the system detects multiple logical devices of the tape
drive. Each logical device is a physical path to the same tape drive. A backup and
restore application can open and use only one logical device at a time because they
represent the same physical device.
When path failover support is enabled on all logical devices, the device driver
configures them internally as a single device with multiple paths. The application
can still open and use only one logical device at a time. If an application opens the
primary device and a permanent path error occurs, the device driver initiates
failover error recovery automatically on an alternate path. If successful, the current
operation continues on an alternate path without interrupting the application. The
data path failover error recovery first restores the previous device state, SCSI
Reservation, and tape position. Then, it tries the failing operation again.
Automatic failover
The automatic failover support provides error recovery on an alternate path when
a permanent error occurs on the primary path. This support is transparent to the
running application. The two types of path failover are Data Path failover (DPF)
Consider a multipath connection that consists of two Host Bus Adapters (HBAs)
connected through a fabric to a multi-port drive.
Mulit-Port Drive
Dual HBA 1
2
A B
Drive
Multi-Port Drive
In Library
Fabric Drive Library
Controller
Drive
a2500255
Virtual Tape Library
As seen in Figure 3, four available paths are available between the drive and the
host system. These paths are
One path is the primary path and the other three are alternate paths. If [A, p1] is
the primary path and if HBA A fails, two valid paths ([B, p1] and [B, p2]) remain.
The DPF tries to switch to one of the available configured paths. Conversely, if the
cable to port 1 of the drive fails with [A, p1] as the primary path, two valid paths
to the drive [A, p2] and [B, p2] are still available. Without DPF support, if a
permanent path error occurs (because of HBA or cable failover, for example), the
application fails. With DPF, if the permanent failure occurs with this configuration,
two valid physical paths for the data are still available for transmitting data. The
running application is not affected.
If the path that failed is restored, the device driver claims the path as available and
uses it as a valid alternate path in most conditions. This action is dependent on
Dual HBA
Single-Port Drive 1
A B
Drive
Single Port Drive
In Library Library
Fabric Drive
Controller
Drive
a2500256
Virtual Tape Library
This configuration supplies two physical paths to the same device. However, if the
port or cable from the device fails, the automatic failover does not work. That
connection is severed and a permanent path error occurs. If, however, the failure
was with one of the HBAs or their cables, the automatic data path failover selects
the other HBA. Then, the information continues through the alternate path. An
example here is with the connections [A, p1] and [B, p1]. If [A, p1] is the primary
path and a failure occurs with the HBA or HBA cable, then DPF automatically
moves the connection to [B, p1] without affecting the application.
Consider a single path from the HBA through the fabric to a multi-port device.
Drive
Mulit-Port Drive
In Library
Fabric Drive Library
Controller
Drive
a2500257
Virtual Tape Library
This configuration also provides a failover path unless the failure is with the HBA
or the HBA’s cable. At which point, the connection is severed and a permanent
path error occurs. Whereas, if the failure occurs on the device side, an alternative
path is still available for the information to go through which DPF automatically
failovers to.
Consider a multipath connection that consists of two Host Bus Adapters (HBAs)
connected through a fabric to the library by at least two drives.
Library
Dual HBA
A B
Drive 1
Library
Drive 2 Controller
Fabric
Control Path Failover (CPF)
a2500293
As seen in Figure 6, four available paths are available between the drive and the
host system. These paths are
If the failed path is restored, the device driver claims the path as available and
uses it as a valid alternate path in most conditions. This action is dependent on
Operating System and HBA behavior, not the IBM tape device driver behavior.
Note: In the operating systems logs, reservation conflict information might appear,
which is because of scsi2 reservations that are not cleared. However, the device
driver continues to try any paths that are available to make the reservation conflict
transparent to the operating system.
Consider a single path from the HBA through the fabric to two drives in a library.
Library
Control Path Failover (CPF) Drive 1
Single HBA Multi Drives Library
Drive 2 Controller
Single HBA
Fabric
A
a2500292
Virtual Tape Library
This configuration also provides a failover path unless the failure is with the HBA
or the HBA’s cable. At which point, the connection is severed and a permanent
path error occurs. Whereas, if the failure occurs with a drive or a drive’s cable, an
alternative path is still available for the information to go through which CPF
automatically failovers to.
If the first application finishes and closes the device, there is now one application
with HBA1 and two applications with HBA2. When the next application opens a
tape drive, it is assigned to HBA1, so again there are two applications with HBA1
and two applications with HBA2. Likewise, if the second application finishes and
closes the device, HBA2 has one application that is assigned to it. The next
application that opens a tape drive is assigned to HBA2.
The dynamic load balancing support is independent from the automatic failover
support. Regardless of the path that is assigned initially for load balancing, if that
path fails, the automatic failover support attempts recovery on the next available
path.
This feature is enabled by default. The attributes are set in the drive by the host
during open, close, device reset, and data path change only. If there is a problem
with sending the attributes to the drive, the error is ignored and not returned to
the application.
There is no ioctl in the IBM tape drivers to retrieve the dynamic runtime attributes
but is an upcoming command on ITDT. The attributes can also be retrieved
through a pass through ioctl to issue Read Dynamic Runtime Attributes SCSI
command (see applicable IBM Tape Drive SCSI Reference). See the host platform
section for any special information that pertains to the driver that concerns DRA. If
there is a question whether your driver level supports DRA, see the fixlist that
comes with your driver to see whether it was added. Updates are also required
with the drive firmware.
Note:
1. Path failover is not supported on parallel SCSI (except for some parallel SCSI
drives on AIX® operating systems). Path failover is only supported on SAS
devices that are attached to Windows and Linux for Intel/AMD
processor-based servers. SAS is not supported on System p® servers (AIX and
Linux).
2. Path failover is not supported on Virtual Tape Libraries (except for the libraries
that are listed in Table 1) that emulate IBM tape devices.
3. If your device does not support path failover, you must disable this option in
the device driver. See the specific platform section for driver default behavior
and enable/disable failover instructions.
Data encryption
The IBM TS1120 (3592 Model E05) and newer tape drives can encrypt data as it is
written to their supporting IBM 3592 Enterprise Tape Cartridges, including WORM
cartridges. The IBM TS1040 LTO Ultrium 4 and newer Ultrium tape drives can also
encrypt data as it is written to any LTO 4 or newer data cartridge. Encryption is
completed at full line speed in the tape drive after compression. (Compression is
more efficiently done before encryption.) This new capability adds a strong
| The IBM TS4500 does not support SME for LTO. For specific encryption support,
| refer to SSIC at http://www.ibm.com/systems/support/storage/config/ssic/.
The following three major elements comprise the tape drive encryption solution.
v The encryption-enabled tape drive
The 3592 Model E07 and newer model tape drives, and the LTO Ultrium 4 and
newer Ultrium drives are encryption capable. All TS1120 Model E05 tape drives
with Feature code 5592 or 9592 are encryption capable. They are functionally
capable of completing hardware encryption, but this capability is not yet
activated. To run hardware encryption, the tape drives must be
encryption-enabled. Encryption can be enabled on the encryption-capable tape
drives through the Tape Library Specialist Web interface. Refer to the
appropriate section in the documentation for your library for information about
how to enable encryption.
| The LTO Ultrium 6 and later encryption environment is complex and requires
knowledge beyond that of product trained Service Support Representatives (SSRs).
The Encryption function on tape drives (desktop, stand-alone, and within libraries)
is configured and managed by the customer. In some instances, SSRs are required
to enable encryption at a hardware level when service access or service password
controlled access is required. Customer setup support is by Field Technical Sales
Support (FTSS), customer documentation, and software support for encryption
software problems. Customer 'how to' support is also provided with a support line
contract.
Note: The abbreviation EKM for the driver configuration file is used generically to
refer to any encryption key manager.
It is required to use the latest device drivers available on the website. See
Appendix A, “Accessing documentation and software online,” on page 327 for
instructions.
This method is best for encryption-capable tape drives in open attached IBM tape
libraries. Scratch encryption policies that specify when to use encryption are set up
through the IBM Tape Library Specialist Web interface. Policies are based on
cartridge volume serial numbers. Key generation and management are run by an
encryption key manager. Policy control and keys pass through the library-to-drive
interface, therefore encryption is transparent to the applications.
Any task that is not identified as an IBM service task is the responsibility of the
customer.
1. Install, cable, and configure the encryption-capable tape drive (refer your IBM
Tape Drive or Library Operator's Guide)
2. Install appropriate IBM tape device driver level (Atape, for example).
3. Set up encryption policies. Refer to the appropriate Tivoli Storage Manager
documentation.
4. Perform write/read operation to test encryption.
5. Verify encryption of the test volume by Autonomic Management Engine
(AME): issue QUERY VOLUME FORMAT=DETAILED
Verify that Drive Encryption Key Manager is set to Tivoli Storage Manager.
Any task that is not identified as an IBM service task is the responsibility of the
customer.
1. Install, verify, and configure
a. Keystore
b. EKM (Refer to documentation on Tivoli Key Lifecycle Manager (TKLM))
Note: The tape drive must be set to system-managed encryption from the drive
panel or library user interface before device driver system-managed encryption is
used.
After the device driver is installed, then an encryption key manager must be
configured. The servers are configured in a text file ibmekm.conf that is installed
in the /etc directory by the device driver if a current configuration file does not
exist.
The following shows the different entry formats for IPv4 and IPv6 addresses in the
ibmekm.conf configuration file:
v IPv4 format: EKMserver timeout IPv4_address Port_number
v IPv6 format: EKMserver timeout IPv6_address Port_number
The timeout value in seconds is used when a request is sent to the server and the
time for the server to respond in case no response is received.
After servers are configured in the ibmekm.conf file, then specific tape drives
must be configured to the device driver for system-managed encryption. The
device driver default does not enable encryption. Refer to the following sections
for specific information, depending on the operating system.
Any task that is not identified as an IBM service task is the responsibility of the
customer.
1. Install, verify, and configure
a. Keystore
b. EKM (Refer to documentation on Tivoli Key Lifecycle Manager (TKLM)) for
information on both.
2. Install and cable the encryption-capable tape drive (IBM service task for TS1120
Tape Drive).
3. Use IBM tape library specialist to enable the tape drive for library-managed
tape encryption (refer to your IBM Tape Drive or Library Operator's Guide).
Bulk rekey
For customers with Library-Managed Encryption with 3592 Enterprise tape drives
and IBM tape and changer drivers that are running on open systems operating
system (AIX, HP-UX, Linux, Solaris, Windows), sample code for completing bulk
rekey operations is available. The sample code packages are provided "as-is" with
limited testing, and are provided to give customers guidance on bulk rekey
operations.
For UNIX operating systems, a sample script (rekey_unix.sh) is provided and must
be used with the tapeutil version that is bundled in the same package. For
Windows operating systems, a sample c program (rekey_win.c) is provided. Both
of these sample programs must be used with both the IBM tape and changer
drivers. In addition, data cartridges must be in storage cells, not in I/O station
cells or tape drives.
Purpose
The IBM AIX Enhanced Tape and Medium Changer device driver is designed to
take advantage of the features that are provided by the IBM tape drives and
medium changer devices. The goal is to give applications access to the functions
required for basic tape operations (such as backup and restore) and medium
changer operations (such as mount and unmount the cartridges), and to the
advanced functions needed by full tape management systems. Whenever possible,
the driver is designed to take advantage of the device features transparent to the
application.
Data flow
The software that is described in this chapter covers the AIX Enhanced Device
Driver (Atape device driver) and the interface between the application and the
tape device. For data flow, refer to Figure 9.
Product requirements
Hardware requirements
Software requirements
The AIX Enhanced device driver (Atape device driver) supports AIX 5L™ Version
5.3 and later releases on IBM POWER-based AIX servers.
The entries are removed from the files when Atape is uninstalled.
Attention: The entries might be lost when a user upgrades the AIX file set of
bos.sysmgt.sysbr for System Backup and BOS Install Utilities after Atape
installation. It is recommended that the user check whether the entries still exist
and add the entries into the files if needed.
Installation procedure
For information on obtaining the latest version of device drivers and the latest
documentation, refer to Appendix A, “Accessing documentation and software
online,” on page 327.
Preinstallation considerations
Installation procedure
Enter the following command to list the currently installed Atape.driver version:
lslpp -l Atape.driver
Enter the following command to install the Atape driver in the current directory.
For example
installp -acXd Atape.x.x.x.x Atape.driver
This command installs and commits the Atape driver on the system.
Note: If the tape device was configured previously by another SCSI device driver,
such as OST (Other SCSI Tape), issue the following command to remove the device
definition before the following steps are completed.
rmdev -l [device]
Configuring limitations
The subsequent limitations are applied for the Atape driver that runs on an AIX
host.
Deconfigure the medium changer device by using one of the following procedures:
1. The first method leaves the device that is defined in the configuration database.
It is similar to bringing the device offline.
Enter the following command to bring the /dev/smcn medium changer device
offline, but leave it defined in the device database.
rmdev -l smcn
2. The second method brings the medium changer device offline and removes its
definition from the device database.
Enter the following command.
rmdev -l smcn -d
The device driver is not unloaded from the kernel until the last device is
deconfigured.
Uninstalling
Attention: All devices that use the Atape driver must be closed and cannot be in
use when Atape is uninstalled or the uninstall fails.
You can uninstall the Atape device driver by using the smit command menu to
uninstall software and selecting Atape.driver or by using the following installp
command
installp -u Atape.driver
Configuration parameters
The operating parameters for the tape drive and device driver are set and changed
by configuration parameters. The installation defaults are provided for all
parameters initially. The AIX smit command is used to set these parameters when
a device is configured or to change these parameters. The AIX chdev command is
used to change the configuration parameters.
The configuration parameters are used to set the operating mode of the tape drive
and device driver when a device is opened. These parameters can be queried by an
application. Some parameters can be temporarily changed during the open
subroutine by an application. But, they are always restored to the configuration
values when a device is closed. The configuration parameters are
v Alternate Pathing
v Autoloading
v Emulate autoloader (359x devices only)
v Block size
v Buffered mode (359x devices only)
v Compression
v Fail degraded media (359x devices only)
v Logical write protect (359x devices only)
v Logging
v Maximum size of the log file
v New logical name
v Read error recovery time (359x devices only)
v Record space mode
v Reservation key
v Reservation support
v Reservation type
v Retain reservation
v Rewind immediate
v System encryption
v System encryption for Write Commands
v Trailer labels
v SCSI status busy retry
Alternate pathing
This parameter enables or disables the path failover support when a device is
configured.“Data Path failover and load balancing support for tape drives” on
page 36 for a description of the path failover and failover support.
This parameter enables the autoloading feature of the device driver. It is used with
the autoloading capability of the autoloader, ACF, ACL, or CSL installed on the
tape device.
Note: The autoloading feature is not supported on the IBM 3584 UltraScalable tape
library and the IBM 3583 Ultrium Scalable tape library with more than one IBM
3580 Ultrium tape drive installed.
Note: The autoloading feature is supported only on the following device types and
configurations:
v IBM 3490E Models C11, C22, E01, E11, F01, and F11
v IBM Enterprise Tape System 3590, Models B11, E11, and H11
v IBM Magstar® MP 3570 Models B01, C01, B11, and C11
v IBM Magstar MP 3570 Models B02, B12, C02, and C12 (configured in split mode
only)
v IBM 7332 (all models)
Tapes that are created with AUTOLOAD=YES are not readable in configurations
without Atape autoload enabled, or on other UNIX operating systems, or on device
types/models that are different from the backup device type/model.
If the parameter is set to On, then the tape stacker acts as one large virtual tape.
During a read, write, or forward space file operation, no end of tape is detected by
the application. When the end of tape is reached, the device driver automatically
rewinds and unloads the tape, then loads the next tape. Then, it continues reading
or writing the next tape. The following conditions are required to use this feature:
v The autoloading parameter must be set to On.
v The cartridge stacker must be loaded with one or more tapes.
v The ACF, ACL, or CSL must be set to Automatic, System, or Random mode.
This feature allows multivolume backups (with commands such as tar) without
prompting for a volume change.
Emulate autoloader
This parameter controls how the device driver operates when the ACF on the IBM
Enterprise Tape System 3590, the IBM Magstar MP tape device, or the IBM 3490E
Model Fxx is set to Random mode. If this parameter is set to On and the ACF is in
Random mode, the device driver emulates an autoloading tape drive. When an
unload command is sent to the device driver to unload a tape, the tape is
unloaded, returned to the magazine, and the next tape in the magazine is loaded
The emulate autoloader parameter can be used for legacy applications that are
written for the IBM 3490E Automated Cartridge Loader (ACL) when the IBM
Enterprise Tape System 3590, the IBM Magstar MP 3570, or the IBM 3490 Model F
autoloader is set to Random mode. This parameter eliminates the need to
reconfigure the autoloader of the device Random or Automatic operation.
Note: On IBM Magstar MP 3570 Models B02, C02, and C12, this feature is
supported only when the two drives are configured in Split mode, or in Base mode
with one drive that is configured and available to AIX. This feature does not work
in Base mode if both drives are in the available state to AIX.
Block size
This parameter specifies the block size that is used for read and write operations.
A value of zero is the variable block size. Any other value is a fixed block size.
The installation default is zero (use variable length) except for the IBM 7332 4-mm
Tape Cartridge Autoloader, for which the default is a fixed block size of 1024 bytes.
Buffered mode
When a write command is processed, the data is either stored directly on the
physical tape or buffered in the tape device. Buffering can increase the device
performance.
Compression
This parameter controls whether the device driver fails a tape operation when
degraded media is detected by the IBM Enterprise Tape System 3590. If a tape is
loaded and the IBM 3590 cannot read the positioning information from the tape,
the device driver is notified when the first command is sent to the tape drive. If
this parameter is set to On, the device fails the command and returns a media
error to the application. If this parameter is set to Off, the device driver does not
fail the command.
Degraded media is a correctable condition that prevents the IBM Enterprise Tape
System 3590 from running high speed Locate operations. A Locate command can
take over 20 minutes, depending on the wanted position and the amount of data
on the tape. This parameter is intended for use by real-time applications that
cannot tolerate long Locate commands.
Logging
This parameter turns the volume information logging on and off. If logging is set
to On, the statistical information about the device and media is saved in a log file
when a tape is unloaded. If logging is set to Off, the information is not saved. This
parameter has no effect on error logging because error logging is always enabled.
For information, refer to “Device and volume information logging” on page 40.
This parameter specifies the number of entries that are made before the log file
starts to wrap. Each entry is approximately 2 KB (2048 bytes). After the log file
starts to wrap, the number of entries stays constant. Each time a new entry is
made, the oldest entry is overlaid. For information, refer to “Device and volume
information logging” on page 40.
Setting this parameter changes the logical name of the device to a new name as
specified. After the logical name is changed, the new logical name parameter is
cleared. For information, refer to “Persistent Naming Support” on page 32.
This parameter controls the read error recovery time for the IBM Enterprise Tape
System 3590. If this parameter is set to On, the recovery time for read errors is
limited to a maximum of 5 seconds. If this parameter is set to Off, full recovery is
used by the device and can take up to 10 minutes. This parameter is intended for
use by real-time applications that cannot tolerate long delays when data is read
from the tape.
The installation default is Off (do not limit the read error recovery time).
This parameter specifies how the device driver operates when a forward or
backward space record operation encounters a filemark. The two modes of
operation are SCSI and AIX.
The SCSI mode is the default mode of operation. When a forward or backward
space record operation is issued to the driver and a filemark is encountered, the
device driver returns -1 and the errno variable is set to input/output error (EIO).
The tape is left positioned after the filemark (the end-of-tape side of the filemark
on the forward space and the beginning-of-tape side of the filemark on the
backward space).
Reservation key
This parameter specifies the SCSI Persistent Reservation key that is used by the
device driver when either the Reservation Type parameter is SCSI Persistent
Reserve and the Alternate Pathing parameter is set to no or when the Alternate
Pathing parameter is set to Yes.
If the Reservation Key parameter is specified as blank (NULL), then the device
driver uses an internal unique key for all devices on the host they are configured
on. Another AIX host that shares devices also have an internal unique key for all
devices if the Reservation Key parameter was blank (NULL).
If the default is not used, then the Reservation Key value can be specified as either
a 1-8 character ASCII alphanumeric key or a 1-16 hexadecimal key that has the
format 0xkey. If fewer than 8 characters are used for an ASCII key (such as host1),
the remaining characters are set to 0x00 (NULL). If less than a 16 hexadecimal key
is used, the remaining bytes are set to 0x00.
Note: When a Reservation Key is specified on each host that shares a device, the
key must be unique to each host.
Reservation support
The parameter of reserve_support indicates that the Atape driver manages the
reservation for the tape device when it is enabled. Atape reserves the tape device
in open and releases it in close, and maintains the reservation in error recovery
procedure (ERP).
Note: For the medium changer, this parameter is not applied when the Alternate
Pathing (path failover) parameter is set to Yes. The device driver forces the setup
to be disabled and the medium changer is not reserved in open when the
Alternate Pathing parameter is set to Yes.
Reservation type
This parameter specifies the SCSI Reservation type that is used by the device
driver, either a SCSI Reserve 6 command or a SCSI Persistent Reserve command.
Note: This parameter is not used if the Alternate Pathing (path failover)
parameter is set to Yes. The device driver uses SCSI Persistent Reserve when the
Alternate Pathing parameter is set to Yes.
When this parameter is set to 1, the device driver does not release the device
reservation when the device is closed for the current open. Any subsequent opens
and closes until the STIOCSETP IOCTL is issued with retain_reservation parameter
set to 0. The device driver still reserves the device on open to make sure that the
previous reservation is still valid.
Rewind immediate
This parameter turns the immediate bit On and Off in rewind commands. If it is
set to On, the rewind tape operation runs faster. However, the next command takes
a long time to finish unless the rewind operation is physically complete. Setting
this parameter reduces the amount of time that it takes to close a device for a
Rewind on Close special file.
The installation default is Off (no rewind immediate) except for the IBM 7332
4-mm Tape Cartridge Autoloader, for which the default is On (rewind immediate).
System encryption
Trailer labels
If this parameter is set to On, then writing a record past the early warning mark
on the tape is allowed. The first write operation to detect EOM fails, and the errno
variable is set to ENOSPC. No data is written during the operation. All subsequent
write operations are allowed to continue until the physical end of the volume is
reached and EIO is returned.
This parameter can also be selected by using one of three device special files that
allow trailer-label processing. The special files are rmtx.40, rmtx.41, and rmtx.60,
where x is the name of the device (for example, rmt0.40).
Atape retries the SCSI command fail due to the SCSI status Busy when the
parameter of busy_retry is set to On. Otherwise, Atape fails the SCSI command if
it is set to Off.
The media parameters can be queried and set by ITDT or the tape diagnostic and
utility function by using the Query/Set Parameters option in the window.
Capacity scaling
This parameter sets the capacity or logical length of the current tape on IBM
Enterprise Tape System 3590, IBM Enterprise Tape System 3592, or Magstar MP
tape subsystems. By reducing the capacity of the tape, the tape drive can access
data faster at the expense of data capacity.
Capacity scaling can be set at 100% for the entire tape (which is the default) or set
at 75%, 50%, or 25% of the tape or any device-specific hexadecimal value. For
example, on IBM 3592, to change capacity scaling from a 300 GB format tape
(100%) to a 60 GB format tape, select the capacity scaling option, then select the
option to enter a hexadecimal value and enter 35. Capacity scaling remains with
the tape across mounts until it is changed.
Note:
1. The tape position must be at the start of the tape to change this parameter from
its current value.
2. Changing this parameter destroys any existing data on the tape.
3. Attempting to set capacity scaling that is not supported by a device or the
current media loaded always returns 100% and cannot be changed. For
example, 60 GB media for the IBM 3592 cannot be capacity scaled and is
always 100%.
This parameter sets or resets the logical write protect of the current tape on IBM
Enterprise Tape System 3590, IBM Enterprise Tape System 3592, or Magstar MP
tape subsystems. The three types of logical write protect are associated protect,
persistent protect, and write-once read-many (WORM) protect.
Associated protect remains only while the current tape is mounted or associated
with the tape drive. It is reset when the tape is unloaded or the tape drive is reset.
Persistent protect remains or persists with the tape across mounts until it is reset.
WORM protect also remains with the tape across mounts, but (unlike persistent
protect) it cannot be reset on the tape. After a tape is WORM protected, it can
never be written on again.
Note:
This parameter is the volume ID of the current loaded tape. It is used in the log
file entry (if volume logging is active) to identify the entry with a particular
volume. The device driver sets the volume ID to UNKNOWN initially and when
the tape is unloaded.
Special files
When the driver is installed and a tape device is configured and available for use,
access is provided through the special files. These special files, which consist of the
standard AIX special files for tape devices (with other files unique to the Atape
driver), are in the /dev directory.
Note: The asterisk (*) represents a number that is assigned to a particular device
(such as rmt0).
For tape drives with attached SCSI medium changer devices, the rmt*.smc special
file provides a separate path for commands that are issued to the medium changer.
When this special file is opened, the application can view the medium changer as a
separate SCSI device.
Both this special file and the rmt* special file can be opened at the same time. The
file descriptor that results from opening the rmt*.smc special file does not support
the following operations.
v Read
v Write
v Open in Diagnostic mode
v Commands that are designed for a tape drive
If a tape drive has a SCSI medium changer device that is attached, then all
operations (including the medium changer operations) are supported through the
interface to the rmt* special file. For detailed information, refer to Table 4.
Table 4. Special files for tape devices
Rewind on Retension Bytes per
Close (Note on Open Inch (Note Unload on
Special file name 1) (Note 2) 3) Trailer Label Close
/dev/rmt* Yes No N/A No No
/dev/rmt*.1 No No N/A No No
/dev/rmt*.2 Yes Yes N/A No No
Table 5 on page 32 shows the attributes of the special file. The asterisk (*)
represents a number that is assigned to a particular device (such as smc0). The
term smc is used for a SCSI medium changer device. The smc* special file
provides a path for issuing commands to control the medium changer robotic
device. For information, refer to Table 5 on page 32.
The file descriptor that results from opening the smc special file does not support
the following operations:
v Read
v Write
v Commands that are designed for a tape device
When the AIX operating system is booted, the HBA runs a device discovery and
assigns a default logical name to each device found in a sequential order. If there
are three tape drives attached to a parallel SCSI adapter, each with a LUN ID of 0
and a target address of 0, 1, and 2, the HBA initially configures them as Available
with the following logical names.
rmt0 target 0, lun 0 Available
rmt1 target 1, lun 0 Available
rmt2 target 2, lun 0 Available
On the next reboot, if the existing rmt1 target 1 device is powered off or not
connected, the HBA initially configures two devices as Available with the following
logical names:
rmt0 target 0, lun 0 Available
rmt1 target 2, lun 0 Available
If the previous rmt1 target 1 device is powered on after reboot and the cfgmgr
command is run, the HBA configures the device as rmt2 instead of rmt1.
rmt2 target 1, lun 0 Available
This is one example, but there are other cases where the logical names of devices
could change when the system is rebooted. For applications that need a consistent
naming convention for all attached devices, it is accomplished with persistent
naming support by defining a unique logical name (other than the AIX default
names) that are associated with the specific SCSI ID, LUN ID, and HBA that the
device is connected to.
For example, a default rmt0 logical name for a tape drive can be changed to rmt-0,
tape0, or any descriptive name wanted. In this example, if the three tape drives are
changed to rmt-0, rmt-1, and rmt-2, and the system is then rebooted with rmt-1
powered off, the HBA detects that unique names are predefined for the attached
devices, and the HBA uses those names. In this case, the devices configure as
follows:
rmt-0 target 0, lun 0 Available
rmt-1 target 1, lun 0 Defined
rmt-2 target 2, lun 0 Available
Since rmt-1 is not detected by the HBA but is predefined at the SCSI ID and LUN
ID, it remains in the defined state and is not configured for use. But, the next rmt-2
tape drive configures as the same name at the same location after reboot.
To change the logical name by using SMIT, complete the following steps:
1. Run SMIT from a command line and select Devices.
2. Select Tape Drive.
3. Select Change/Show Characteristics of a Tape Drive.
4. Select the logical device to be changed from the list displayed.
5. In the New Logical Name field, enter a non-AIX default logical name.
6. Press Enter to process the change.
The logical name of a device can be changed by using the chdev command. For
example, to change the logical name of the device from rmt0 to rmt-0, run
chdev –l rmt0 –a new_name=rmt-0
Note:
v When path failover is enabled, if you change the logical name for either a
primary or alternate device, only the individual device name changes.
v Follow the naming convention whenever you run mksysb, bosboot:
– The prefix name of "rmt" cannot be changed.
– A sequence number must be a positive integer. The smallest sequence number
is 0.
– The prefix name cannot contain non-numerical characters. For example,
rmt1_rescu is not an acceptable prefix name.
– When a device instance logical name is generated, the SMIT tool
automatically assigns the next available sequence number (relative to a
The Atape device driver path failover support configures multiple physical control
paths to the same logical library within the device driver. It also provides
automatic failover to an alternate control path when a permanent error occurs on
one path. This support is transparent to the running application.
To enable or disable the support on a single logical device, use the SMIT menu to
Change/Show Characteristics of a Tape Drive, select the logical device to change
such as smc0, smc1, then select Yes or No for Enable Path Failover Support. The
support can also be enabled or disabled by using the chdev command, for example,
chdev -l smc0 -aalt_pathing=yes
chdev -l smc1 -aalt_pathing=yes
chdev -l smc0 -aalt_pathing=no
chdev -l smc1 -aalt_pathing=no
When a second logical device is configured with path failover support enabled for
the same physical device, it configures as an alternative path. On SCSI attached
devices, -A is appended to the location field. On Fibre attached devices, -ALT is
appended to the location field of the device.
For example, you can easily determine how many physical devices are configured
with path failover support.
Note: Show the primary and alternative path configuration for any device by
using tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
Logical devices that are configured as primary paths can also be unconfigured and
reconfigured at any time after initial configuration is run. However, the operation
is different for a primary device. When a primary device is unconfigured, the
following events occur.
1. All alternative devices are unconfigured as described previously.
2. The primary device is unconfigured.
3. The -P or -PRI appended to the location field is removed.
4. The device is changed to the Defined state.
5. All alternative devices that were unconfigured are reconfigured. The first device
that is reconfigured becomes the new primary device. All remaining alternative
devices are reconfigured as alternative paths.
These methods can unconfigure and reconfigure physical devices on the system
when device connections or addressing changes are made.
Path failover support can be enabled on all configured devices at one time, or it
can be enabled or disabled selectively by logical device. It might be desirable at
times to configure some, but not all, logical paths to a device with the support
enabled.
To enable the support globally on all currently configured devices, run the
command
/usr/lpp/Atape/instAtape -a
This action unconfigures all devices that have path failover set to No, and
reconfigures all devices, setting path failover to Yes.
For example, if rmt0 is configured first, then rmt1, the lsdev -Cc tape command
output is similar to the following command.
rmt0 Available 20-60-01-PRI IBM 3590 Tape Drive and Medium Changer (FCP)
rmt1 Available 30-68-01-ALT IBM 3590 Tape Drive and Medium Changer (FCP)
If rmt1 is configured first, then rmt0, the command output is similar to the
following.
rmt0 Available 20-60-01-ALT IBM 3590 Tape Drive and Medium Changer (FCP)
rmt1 Available 30-68-01-PRI IBM 3590 Tape Drive and Medium Changer (FCP)
To see this information, run the lsdev -Cc tape command and look at the location
field in the data. By running lsdev -Cc tape | grep PRI, for example, you can
easily determine how many physical devices on the RS/6000® or System p (also
known as pSeries) server are configured with path failover support.
Logical devices that are configured as primary paths can also be unconfigured and
reconfigured at any time after initial configuration is run. However, the operation
is different for a primary device. When a primary device is unconfigured, the
following events occur.
1. All alternative devices are unconfigured as described previously.
2. The primary device is unconfigured.
3. The PRI appended to the location field is removed.
4. The device is changed to the Defined state.
5. All alternative devices that were unconfigured are reconfigured. The first device
that is reconfigured becomes the new primary device. All remaining alternative
devices are reconfigured as alternative paths.
These methods unconfigure and reconfigure physical devices on the system when
device connections or addressing changes are made.
System-managed encryption
The wrt_encryption attribute controls whether the device driver can set the tape
drive to encryption enabled for write commands. When set to off, the tape drive
uses encryption for read operations; write operations do not use encryption. When
set to on, the tape drive uses encryption for both read/write operations. When set
to custom, the device driver does not modify current tape drive setting. The
custom setting is intended for applications that use system-managed encryption to
control write encryption without device driver intervention.
This test is a tape diagnostic and utility function. Refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
Error logging
Encryption errors are logged along with other tape operation errors by using the
standard TAPE_ERR1 Template “Tape Operation Error” with associated sense data
in the detail data.
An encryption failure is indicated when the asc/ascq in the sense data is EFxx or
EExx. Refer to the tape drive hardware reference for information on the asc/ascq
being reported. The asc/ascq can be found in the first column of the second row in
detail sense data. For example,
Detail Data
SENSE DATA
0A00 0000 5A08 25FF 0000 00FF FF00 0000 0000 0000 F000 0600 0000 1458 0000 0000
EF11 FF02 D105 0000 0009 0191 0002 0000 0000 0A00 0000 0000 0000 0000 0000 0000
0000 0000 0000 FFFF FF00 0000 FFF0 B7E3 0001 2127 0000 0000 0000 0000 3930 3220
2020 2000 0041 4A00 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000
0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000
Problem determination
A set of tools is provided with the device driver to determine whether the device
driver and the tape device are functioning correctly. The standard AIX interface is
provided for problem determination.
Dump support
Dump support is provided through the dump entry point in the driver. Refer to
appropriate AIX manuals for a description of how to use the dump devices and
how to read the dump data.
To establish the rmt1 tape device as a secondary dump device, enter the following
command,
sysdumpdev -s /dev/rmt1
To run a dump operation, use the sysdumpstart command. To send the dump data
to the secondary dump device, enter the following command:
sysdumpstart -s
Note: This command stops the system. Use the sync command to ensure that the
cache is flushed before the sysdumpstart -s command is issued.
After the dump data is placed on the tape, copy it to a file on the disk before the
crash command is used to process it. For example,
dd if=/dev/rmt1 of=tapedump1 ibs=4096 obs=512
crash tapedump1
If the block size of the tape device is larger than the block size sent during the
dump process, the dump operation fails. Set the block size to zero on the tape
device and experiment with the ibs value for the dd command.
This process is a separate facility from error logging. Error logging is routed to the
system error log. Device information logging is sent to a separate file.
Refer to “Tape drive, media, and device driver parameters” on page 23 for a
description of these parameters.
Each time the rewind and unload sequence occurs or the STIOC_LOG_SENSE ioctl
command is issued, an entry is added to the log. Each time a new cartridge is
loaded, the values in the device log buffers are reset with the Log Sense command.
The log data is gathered on a per-volume basis.
The files are in binary format. Each entry has a header followed by the raw Log
Sense pages as defined for a particular device.
The first log page is always page 0x00. This page, as defined in the SCSI-2 ANSI
specification, contains all pages that the device supports. Page 0x00 is followed by
all pages that are specified in page 0x00. The format of each following page is
defined in the SCSI specification and the device manual.
Note:
1. Name is the logical name of the device (such as rmt0).
2. File is the name of a log file (such as Atape.rmt0.log).
3. The -d parameter, if used, deletes the log file for the specified device.
The contents of the log file are displayed as standard output. To save the log in a
file, use the AIX redirection function. For example,
tapelog -l rmt0 > rmt0.log
Where the first xxxxxxxx is the actual reserve key, and the second xxxxxxxx is the
reserving host initiator WWPN.
After the reserving host WWPN is initially logged, subsequent reservation conflicts
from the same reserving host WWPN are not logged. This action prevents multiple
entries in the error log until either the reserving host WWPN is different from the
one initially logged or the device driver reserved the device and another
reservation conflict occurs.
If the Persistent Reserve In command fails, the detail data contains the following
entry with the errno from the failing Persistent Reserve In command.
Chapter 3. AIX Tape and Medium Changer device driver 41
Unable to obtain reserving host information, errno x
Error logging
The device driver provides logging to the AIX system error log for various errors.
The error log can be viewed for specific devices by using the Error Log Analysis
utility that is provided with the tape drive service aids. Refer to “Error Log
Analysis” on page 48. The error log can also be viewed by using the smit or the
errpt command.
Error labels
Errors are logged with an associated error label and error ID. The error label
indicates the basic type of error.
v TAPE_ERR1
Tape media error
v TAPE_ERR2
Tape hardware error
v TAPE_ERR4
SCSI Adapter detected error
v TAPE_ERR5
Unknown error
v RECOVERED_ERROR
Temporary tape hardware or media error
v SIM_MIM_RECORD_3590
3590 Service/Media Information Message (Log Page X '31')
v TAPE_SIM_MIM_RECORD
Tape drive Service/Media Information Message (Log Page X '31')
v DEV_DUMP RETRIEVED
Device dump retrieved
v TAPE_DRIVE_CLEANING
Tape drive needs cleaning
v RESERVE_CONFLICT
Detail data
Detail data is logged with the associated error that identifies the cause of the error.
Detail data for the SIM_MIM_RECORD_3590 or TAPE_SIM_MIM_RECORD entries
contain the raw data from Log Sense Page 31. Refer to the hardware reference
manual for the format of this entry. All other error log entries use the following
format for detail data:
Detail Data
SENSE DATA
aabb xxxx ccdd eeee eeee eeee eeee eeee ffgg hhxx ssss ssss ssss ssss ssss
ssss ssss ssss ssss ssss ....
aa Length of the command descriptor block (CDB).
bb SCSI target address.
xx Unused or reserved.
cc Start of CDB, cc is the operation code (byte 0).
dd Logical unit (byte 1) in the CDB.
ee Bytes 2 - 12 in the CDB.
ff Status validity field. If this field is 01, then a SCSI error was reported, and
byte gg indicates the type of error. If this field is 02, then an adapter error
was reported, and byte hh indicates the type of error.
gg This byte indicates the type of SCSI error that occurred.
v 02 CHECK CONDITION - Device reported a check condition.
v 08 BUSY STATUS - Target is busy.
v 18 RESERVATION CONFLICT - Target is reserved to another initiator.
v 22 COMMAND TERMINATED - Device terminated the command.
v 28 QUEUE FULL - Device command queue is full.
hh This byte indicates the type of adapter error that occurred. For parallel
SCSI adapters, this byte is the general_card status code as defined in
/usr/include/sys/scsi.h
v 01 HOST IO BUS ERROR - Host I/O bus error during data transfer.
v 02 SCSI BUS FAULT - SCSI bus protocol or hardware error.
v 04 COMMAND TIMEOUT - Command timed out before completion.
v 08 NO DEVICE RESPONSE - Target did not respond to selection phase.
v 10 ADAPTER HARDWARE FAILURE - Adapter indicated a hardware
failure.
v 20 ADAPTER SOFTWARE FAILURE - Adapter indicated a microcode
failure.
v 40 FUSE OR TERMINAL PWR - Blown terminator fuse or bad
termination.
v 80 SCSI BUS RESET - Adapter indicated that SCSI bus was reset.
For FCP or SAS adapters, this byte is the adapter_status code as defined in
/usr/include/sys/scsi_buf.h
v 01 HOST IO BUS ERROR - Host I/O bus error during data transfer.
v 02 TRANSPORT FAULT - Failure in the transport layer.
v 03 COMMAND TIMEOUT - Command timed out before completion.
When the device is first configured, the dump name is set to dump1. If more than
three dumps occur, the driver starts over at dump1; therefore the last three dumps
are always kept.
The feature is enabled by default. The drive attributes on the host are set during
the open, close, device reset, and data path change only. So, it does not have
impact on the tape and system performance. The error is ignored and is not
returned to application, when the information failed to send. However, a device
attribute named as "host_attributes" is available to disable the DRA feature, when
Atape runs with the virtual tape library for which the feature is not supported.
Trace facility
The AIX trace facility is supported for the device driver. The trace event is
identified with a hookword. The hookword that is used by the device driver is 326.
The trace can be initiated at any time before an operation on a tape device.
This command starts the trace in the background and collects only the trace events
with the 326 hookword (Atape device driver).
This command stops the trace after the tape operations are run.
This command formats the trace output into a readable form and places it into a
file for viewing.
Component tracing
Later releases of AIX 5.3 and above support component tracing. Unlike system
tracing that must be started and stopped, component tracing by default is on all
the time and runs continually.
The Atape component trace can also be retrieved from a system dump. This action
eliminates the need to start the Atape system trace before a system dump or to
re-create an AIX system dump when a system trace is not running. The AIX system
dump is normally stored in the /var/adm/ras directory as a vmcore.x.BZ file, where
x is a dump number 1, 2, and so on.
To retrieve and format the Atape component trace from a dump file (for example,
vmcore.1.BZ) to a file (for example, actrc.dump) into the current directory, run the
following commands.
dmpuncompress /var/adm/ras/vmcore.1.BZ
trcdead -c /var/adm/ras/vmcore.1
trcrpt -l Atape -o actrc.dump
Tape drive service aids are also available by using the Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
This utility forces a dump operation on the tape drive. After the dump operation is
completed, the dump data can be transferred from the tape drive by using the
Read Dump utility.
Read Dump
This utility transfers the dump data from the device to a file, a diskette, or a tape
cartridge.
Note: On certain terminal types, it might be necessary to press Esc and the
number 7 instead of F7.
The Read Dump operation starts, and a window opens when the operation is
completed.
Microcode Load
This utility downloads microcode to the device from a file or a diskette (AIX
format only).
Note: To download the microcode from a DOS diskette, you must first use the AIX
dosread command to transfer the file from the DOS diskette to the AIX file. Then,
you can use the Microcode Load utility to download the AIX file to the tape drive.
Note: On certain terminal types, it might be necessary to press Esc and the
number 7 instead of F7.
5. If the current microcode on a tape drive is Federal Information Processing
Standard (FIPS) code, then a window opens and displays the following
message.
Warning: The drive is currently using FIPS code. Press Enter to
continue with downloading new drive code.
The Microcode Load operation starts, and a window opens when the operation is
completed.
This utility displays and analyzes the system error log entries for a specific tape
drive and can be used for problem determination. The type of error, the SCSI
command, and the sense data (if applicable) are displayed for each entry in the
error log (one screen at a time).
Reset Drive
This utility creates a field microcode replacement (FMR) cartridge tape by using
the loaded functional microcode in the tape drive.
Data path
The simplified model in Figure 10 shows the components that are involved in the
data path for moving data at a file level between disk storage devices and tape.
Note: The device parameters must not be changed from the defaults for most
applications.
The following guidelines typically result in good tape path performance for use
with AIX utilities:
1. Hardware compression must be enabled for maximum performance if the data
sent to the device is uncompressed.
For tape diagnostic and utility functions refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 217.
Purpose
This device driver product provides SCSI-3 attachment for the IBM tape devices to
selected Hewlett-Packard Precision Bus and PCI-based operating systems that run
HP-UX 11i v2, and 11i v3.
The HP-UX installed name of this device driver is Advanced Tape Device Driver
(ATDD). ATDD is used throughout this chapter to identify this driver.
ATDD is designed specifically to take advantage of the features that are provided
by the IBM tape devices (refer to “Hardware requirements” on page 1). The goal is
to give applications access to the functions required for basic operations (such as
backup and restore) and the advanced functions that are needed by full tape
management systems. Whenever possible, the device driver is designed to take
advantage of the IBM tape system features transparent to the application.
Data flow
Both data and commands flow between the application program and the tape
subsystem by way of the IBM Tape and Medium Changer device driver for HP-UX
(ATDD). Figure 11 shows the relationships between the IBM Tape and Medium
Changer device driver for HP-UX, the application program, the SCSI or Fibre
Channel adapter device driver, and the IBM tape subsystem.
SCSI or Fibre
ATDD Channel IBM
Application
Device Adapter Tape
Program
a250104
Product requirements
ATDD implementation
ATDD is a set of device driver implementations for operation in the following
HP-UX operating system environments:
v HP PCI Bus - HP-UX 11i v1 (64 bit) - versions of this driver are identified by
levels ATDD 3.x.x.x.
Hardware requirements
For current hardware requirements, refer to the “Hardware requirements” on page
1.
Note:
1. ATDD does not support tape devices that are attached to HSC/GSC bus
architectures.
2. For attachment of Enterprise Tape System 3590 and IBM Magstar MP devices to
HP rp8400 (formerly V-Class) platforms, a feedthrough SCSI terminator, which
attaches to the A4800A Host Bus Adapter, is required. This feedthrough SCSI
terminator is available as FC 9798 for Enterprise Tape System 3590 and FC 5098
for the 3575 Tape Library Dataserver or MP 3570 C model tape subsystem.
Attach the male end of the feedthrough SCSI terminator to the host adapter
and connect the host end of the standard FC 51xx SCSI cable to the
feedthrough terminator. Terminate the SCSI bus at the last device on the bus as
usual.
3. The low-level FC-Tape protocol standard is not supported in the HP A5158A
HBA firmware and users must restrict their SAN configurations. The jobs are
aborted with HP-UX A5158A HBA configurations when errors are detected in
the SAN.
The HP A5158A host adapter is not compliant with the Fibre Channel Protocol
for SCSI, second version (FCP-2), dated 17 November 2000, a draft that is
proposed by the American National Standard of Accredited Standards
Committee (NCITS).
4. The HP A6826A HBAs need the QLogic firmware level B.11.11.02 or later. If the
adapter is directly connected to a 3592 without a switch, then the topology on
the drive port must be set to L-port.
Software requirements
For current software requirements, refer to the “Software requirements” on page 1.
Attention: To install ATDD in HP-UX 11i v3, some HP-UX patches must be
applied first on the system. For information, refer to the atdd.Readme file that is
downloaded with the driver.
For programming information, refer to the IBM Tape Device Drivers Programming
Reference, GA32-0566.
Configuration limitations
Maximum supported number of tape devices 1000
Maximum supported number of HBA ports 128
Maximum supported number of paths for a 16/16
device (DPF/ CPF)
Maximum LUNs per system 32
Every attached tape or library device uses a certain amount of resources. The user
must consider resources such as physical memory and virtual space on the system,
which can further limit the number of devices that can be attached.
Preinstallation considerations
Make sure that your system is ready to install ATDD before you begin. Follow
these steps to complete the installation.
1. Copy the software from the distribution medium to the depot.
2. Check the readme file and verify that your system is configured appropriately
for installing ATDD.
3. Ensure that the tape drives to be managed by ATDD are powered on.
4. Install and configure the software.
The following describes facts about the command sequences.
v In some of the examples, file names that are given on the command line must be
referenced with an absolute path. Using 'pwd'/filename to reference a file
instead of filename ensures this.
v All the software distributor commands (for example, swinstall or swcopy) can
be run first with the -p flag to preview the command. After the preview output
is observed, you can reissue the command without the -p flag to complete the
actual operation.
v The software distributor commands are moderately complex scripts that
frequently require several steps. The steps are typically Selection, Analysis, and
Execution. Each step can produce useful information and error messages. It is a
good idea to carefully observe the results of the installation process as it occurs.
If you encounter unexpected results during the installation, check the associated
log file.
While the software distributor commands are used, you might encounter the
following error about mounted file systems:
ERROR: "hostname/": One or more filesystems that appear in the
filesystem table are not mounted and cannot be mounted.
Many commands (for example, swinstall and swremove) attempt to mount all file
systems in the /etc/fstab file at the start of the analysis phase. This action ensures
that all listed file systems are mounted before proceeding. This action also helps
ensure that files are not loaded into a directory that might be below a future
mount point. But, it often causes an error with NFS mounted file systems.
This error can be overridden with '-x' to set the mount_all_filesystems option to
FALSE. When this option is used, the command finishes with a warning that
indicates no attempt is made to mount all file systems. For example,
# swinstall -x mount_all_filesystems=false -x ask=true -x autoreboot=true atdd
WARNING: "hostname:/": There will be no attempt to mount filesystems
that appear in the filesystem table.
The Drive Configuration File is required if you do not use the device driver
configuration defaults.
If you do not need to create a Drive Configuration File, skip to the instructions in
“Powering Off the tape drives” on page 56.
The configuration file is named sbin/init.d/atdd and has the following syntax:
ATDD_global_parameter=value
ATDD_device_parameter[index]=value
Note:
v Blank lines and lines that start with # are ignored.
v No spaces can appear within each entry.
v No trailing comments can appear on a variable definition line.
To determine the device hardware path for IBM tape drives with a SCSI
attachment, complete the following steps.
1. Run ioscan to determine the hardware path (the SCSI adapter) the tape drive is
connected to.
# ioscan -f -C ext_bus
2. Record the hardware path entry of the adapter:
For example: 0/10/0/0
3. Determine the SCSI target address of the tape drive.
HWPATH = adapterpath.drivetargetaddress.0 (tape drive)
For a tape drive at SCSI target address 3, the device hardware path is
0/10/0/0.3.0
To determine the device hardware path for IBM tape drives with the Fibre Channel
attachment, complete the following steps.
1. Run ioscan to determine the hardware path (the Fibre Channel) the tape drive
is connected to
# ioscan -f -C tape
2. Record the hardware path entry of the Fibre Channel. For example,
HWPATH = 0/5/0/0.8.0.255.7.9.0
You must tell the driver which hardware path you want to attach to if you are not
using the installation defaults for driver behavior. Create an entry in the
/etc/rc.config.d/atdd configuration file for each device you want the driver to
attach. For example:
ATDD_HWPATH[0]=0/10/0/0.1.0
ATDD_HWPATH[1]=0/10/0/0.6.0
ATDD_HWPATH[2]=0/5/0/0.8.0.255.6.14.0
The ATDD is shipped with default settings for all configuration parameters. To
change these settings, an entry is made in the configuration file that assigns an
appropriate value to the wanted configuration variable. Each device can have a
different value for each configuration variable. The index number that is associated
with the configuration variable associates the parameter setting with the device at
the hardware path with the same index.
Example 1:
ATDD_IMMEDIATE[0]=1
This parameter allows application control to return from the device before the
rewind completes for the device at hardware path 0/10/0/0.1.0 (based on the
hardware path entry in “Creating the hardware path entry”).
Example 2:
ATDD_TRAILER[1]=1
This parameter allows write operations after an early end-of-tape warning for the
device at hardware path 0/10/0/0.6.0. Refer to Table 7 on page 62 and Table 8 on
page 63 for a description of all configuration parameters.
Note: If you experience difficulties with your tape device, check the /etc/rc.log for
errors and correct the problem.
Before you continue, make sure that all devices CLAIMED with the preceding
command are devices that you want this device driver to manage.
To list device file names in the /dev directory and its subdirectories, enter
# ioscan -funC tape
To remove a tape drive from the CLAIMED state so it is not configured by this
driver, power Off the tape drive and run ioscan without the -k argument as
follows.
# ioscan -f -C tape
To install ATDD with the script, download the installation script with the driver at
Fix Central, then run the installation script.
When the installation script runs, the customer is prompted with the question,
Would you like to activate the Medium Changer support by ATDD (Y/N)?. Enter
Y to allow the ATDD to configure all attached IBM Medium Changer devices. Or,
answer N to allow the HP native changer driver to configure these Medium
Changer devices.
Note:
1. If a previous version of ATDD is installed on your system, uninstall it before
you attempt to install the latest version. Refer to “Uninstalling the software” on
page 61.
2. The system reboot is required to install ATDD in HP-UX 11i v3.
Attention: If you do not copy the ATDD software into a depot, you cannot
readily uninstall the product.
When the software is in the depot and only the appropriate drives are powered on,
the ATDD software can be installed to the root file system with the HP-UX
swinstall command. If the target root file system is the primary, the ATDD
software is configured automatically upon installation.
If the target is an alternate root file system, then the ATDD software is not
configured automatically.
The following commands install ATDD from the depot to the default root file
system by issuing the swinstall command with the ask options that are set as
follows:
# swinstall -p -x ask=true atdd (preview option)
# swinstall -x ask=true atdd in HP-UX 11i v1, and v2
# swinstall -x autoreboot=true -x ask=true atdd in HP-UX 11i v3
Running the swinstall command with the ask option set to TRUE prompts the
customer, Would you like to activate the Medium Changer support by ATDD
(Y/N)?. Enter Y to allow the ATDD to configure all attached IBM Medium Changer
devices, or answer N to allow the HP native changer driver to configure these
Medium Changer devices.
You can use swlist to list the software that is installed on the default root file
system as follows:
# swlist atdd
You can verify correct installation to the default root file system with the swverify
command as follows:
# swverify atdd
If you enabled ACDD, run the following ioscan command to view the medium
changers found:
In HP-UX 11i v3, run # ioscan -funNC tape or autoch to display the tape devices
that are configured with ATDD and ACDD drivers. Run # ioscan -funNC tape or
autoch to show the tape devices that are bound with the legacy atdd_leg and
acdd_leg drivers.
By default, ATDD automatically configures all supported IBM tape drives that are
attached and powered on when the ATDD package is installed. The ACDD driver
does not configure IBM Medium Changer devices by default. To configure all IBM
Medium Changer devices on the system during the installation of ATDD package,
run the swinstall command with the -x ask=true command option and answer
Yes to allow the ACDD to claim these devices.
v In HP-UX 11i v1 and v2, run the command:
# /opt/atdd/bin/atdd_claim -c
v In HP-UX 11i v3, do the following steps:
1. Bind each changer device with the ACDD driver:
# ioscan -b -M acdd -H hw_path
2. Reboot the system to configure the changer devices:
# shutdown -ry now
To claim a specific tape device with atdd/acdd during reboot, edit the "Claiming
Device" section in the /sbin/init.d/atdd file.
For example, to attach IBM 3590E11 medium changer with acdd driver:
1. To determine the HW path:
# ioscan -fnk|grep IBM
autoch 0 0/3/0/0.5.1 schgr CLAIMED DEVICE IBM 03590E11
2. Comment out the command lines in the init script of /sbin/init.d/atdd:
v For tape drives:
/opt/atdd/bin/atdd_claim -t
v For medium changers:
/opt/atdd/bin/atdd_claim -c
3. Add a command line in the Configuring Device section in /sbin/init.d/atdd:
/opt/atdd/bin/atdd_claim -H 0/3/0/0.5.1
To dynamically attach selected IBM tape device after the ATDD installation, run
the following commands.
1. To determine the HW path of the device:
Note: The dynamic attachment might be lost after the system reboots.
Use the system ioscan and rmsf commands to force a non-atdd/acdd driver to
bind an IBM tape device. For example, force bind the IBM 3590E media changer
with the HP native changer driver schgr with these steps:
1. Determine the HW path of the device:
# ioscan -fnk |grep IBM
tape 0 0/3/0/0.5.0 atdd CLAIMED DEVICE IBM 03590E11
autoch 0 0/3/0/0.5.1 acdd CLAIMED DEVICE IBM 03590E11
2. Remove the I/O configuration from the system:
# rmsf -H 0/3/0/0.5.1
3. Force binding:
# ioscan -M schgr -H 0/3/0/0.5.1
4. Create the device special files:
# insf -H 0/3/0/0.5.1
5. Verify the force binding:
# ioscan -fnk |grep IBM
tape 0 0/3/0/0.5.0 atdd CLAIMED DEVICE IBM 03590E11
autoch 0 0/3/0/0.5.1 schgr CLAIMED DEVICE IBM 03590E11
Note: The force binding is lost after the system reboots. To keep the binding to
a selected device with a particular driver after a reboot, add these
command-lines in steps 2–4 in Claiming Device section in /sbin/init.d/atdd file.
For example,
# Configuring Device Section:
# add specific device claim here, for example
# /opt/atdd/bin/atdd_claim -H 0/3/0/0.5.1
# /opt/atdd/bin/atdd_claim -H 0/6/0/0.1.30.255.0.0.1
rmsf -H 0/3/0/0.5.1
ioscan -M schgr -H 0/3/0/0.5.1
insf -H 0/3/0/0.5.1
By default, atdd driver automatically configures all supported IBM tape drives that
are attached and powered on when the ATDD package is installed. The acdd
driver does not configure IBM medium changer devices by default. All of IBM
medium changers are claimed if you use acdd and acdd_leg as the changer drivers
during ATDD are installed. To attach a selected IBM tape device with a particular
driver, run the system ioscan command to force a non-ATDD/ACDD driver to
bind an IBM tape device, and then reboot the system. For example, to force bind
the IBM 3592 E05 tape drive with the HP native tape driver estape, complete these
steps:
1. Determine the HW path of the device:
# ioscan -fNk | grep IBM
tape 1 64000/0xfa00/0x7 atdd CLAIMED DEVICE IBM 03592E05
2. Force the binding:
Attention: Do not try to uninstall the ATDD software by deleting the files that
make up the ATDD file set. This action causes a number of inconsistencies on the
system. It is best to use the swremove command.
If more than one level of ATDD exists in the depot, explicitly specify the level to
remove it. For example:
# swremove -d atdd,r=3.5.0.0
To display and manage ATDD kernel modules and kernel-tunable parameters, run
kmadmin, kmsystem, kmtute, and kmadmin commands in HP-UX 11i v1 and kcmodule,
kctune commands in HP-UX 11i v2 and v3, or go to the Kernel Configuration in
the sam utility. Refer to the system manual for detail.
For an example, print the ATDD driver module status, entering the command:
# kcmodule -d atdd
Module State Cause Description
atdd static explicit Advanced Tape Device Driver
For PB driver:
# /opt/OMImag/bin/atdd_cfg -h
Device-specific parameters
Some of the configuration parameters are device-specific, while others are
driver-specific. Table 7 shows the parameters that are device-specific, what they
mean, and their values.
Table 7. HP-UX: Device-specific parameter definitions
Parameter Meaning Values
DENSITY Density to use when In hexadecimal
writing/reading tape
SILI Suppress Incorrect Length v 0=Off (do not suppress, by
Indicator default)
v 1=On (suppress)
BLOCKSIZE Block Size Size in bytes, 0 by default.
COMPRESSION Compression Mode v 0=Off (do not use compression
at drive)
v 1=On (use compression at
drive, by default)
BUFFERING Buffering Mode v 0=Off (do not buffer data)
v 1=On (buffer data to hardware
buffers, by default)
IMMEDIATE Immediate Mode v 0=Off (wait for rewind
completion, by default)
v 1=On (return before rewind is
complete)
TRAILER Trailer Label Processing v 0=Off (do not allow writes past
early EOT warning, by default)
v 1=On (allow writes past early
EOT warning)
ERRNO_LEOT Error Number return for Value that is returned for writes
Logical End Of Tape) past EOM, 28 by default.
Driver-specific parameters
Some of the configuration parameters are device-specific, while others are
driver-specific.Table 8 shows the parameters that are driver-specific, what they
mean, and their values.
Table 8. HP-UX: Driver-specific parameters (Global)
Parameter Meaning Values
INSTANCE ATDD Device Number (Read Only)
DEVICES Number of Configured Devices (Read Only)
All configurable parameters for the specified device are displayed by entering
#atdd_cfg -d special_file only
For instance:
# /opt/atdd/bin/atdd_cfg -d /dev/rtape/tape14_BEST
DENSITY=0
SILI=1
BLOCKSIZE=0
COMPRESSION=1
BUFFERING=1
REWIND_IMMEDIATE=0
TRAILER=1
SCALING=0
WRITEPROTECT=0
ERRNO_LEOT=28
WFM_IMMEDIATE=0
RESERVE=1
PRE_V3_COMPAT=0
To display a specific parameter, run #atdd_cfg -d special_file -o parameter
For example,
#/opt/atdd/bin/atdd_cfg -d /dev/tape/tape14_BESTn -o COMPRESSION
COMPRESSION=1
To set a new BOOT default value for the configuration parameter, you must
modify or add an entry in the atdd.cfg configuration file in /etc/rc.config.d for
the static driver or the atdd configuration file in /sbin/init.d.
For example, if you want the COMPRESSION default set to 0 for the device at
ATDD_HWPATH[0] or tape14_BESTn, add the following line to your configuration file:
v In HP-UX 11i v1 and v2:
ATDD_COMPRESSION[0]=0
v In HP-UX 11i v3:
/opt/atdd/bin/atdd_cfg -d /dev/rtape/tape14_BESTn -o COMPRESSION -w 0
Note: The configuration parameters are prefixed with ATDD_ in the configuration
file. For instructions about using the configuration program, use the -h option as
follows:
# atdd_cfg -h
To change the value of tunable, run the command kctune/kmtune or the SAM
(System Administration Manager) tool.
Special files
For each drive configured by ATDD, 12 or 13 special files are created. 12 special
files are generated for a 3590 with ACF set to Manual, Automatic, System,
Accumulate, Random, or Library mode. A 13th special file is created for
independent operation of the ACF, if the 3590 mode is set to Random 2 LUN
operation (/dev/rmt/<instance#>chng).
# lssf /dev/rchgr/autoch1
acdd section 0 at address 64000/0xfa00/0x21 /dev/rchgr/autoch1
If the device special files are not created on the system, use the # insf command
to generate them.
The persistent DSF format for tape devices that are introduced with the Agile view
in HP-UX 11i v3 is
# ioscan -funNC tape
Class I H/W Path Driver S/W State H/W Type Description
===================================================================
tape 1 64000/0xfa00/0x7 estape CLAIMED DEVICE IBM 03592E05
/dev/rtape/tape1_BEST /dev/rtape/tape1_BESTn
/dev/rtape/tape1_BESTb /dev/rtape/tape1_BESTnb
If you see .altpath next to one of the special files in HP-UX 11i v1 and v2, then
you successfully enabled the control path failover feature for your library. In
HP-UX 11i v3, use the # ioscan -m dsf command and “[11] Display All Paths” on
page 256 or “Display All Paths” on page 317 in ITDT to verify that the multiple
path is configured by the system and ATDD.
After the path failover support is enabled, it remains set until atdd_claim is run
with the alternate_pathing driver parameter set to OFF. The path failover setting
is retained even if the system is rebooted. If you want to turn off the control path
failover feature in the ATDD driver, complete the following steps.
v In HP-UX 11i v1 and v2:
1. Clear the alternate_pathing parameter.
# /opt/atdd/bin/atdd_failover -a 0
2. Reconfigure CPF for the devices.
# /opt/atdd/bin/atdd_claim
v In HP-UX 11i v3:
Run kctune to disable the kernel tunable of atdd_alternate_pathing. ATDD
manages the CPF in the next open.
# kctune atdd_alternate_pathing=0
* The automatic ’backup’ configuration has been updated.
* The requested changes have been applied to the currently
running configuration.
Tunable Value Expression Changes
atdd_alternate_pathing (before) 1 1 Immed
(now) 0 0
The primary and alternative path information can be obtained by using the
following command on HP-UX 11i v1 and v2.
# ioscan -funC autoch
Note: To display the primary and alternative path configuration for any device by
using tape diagnostic and utility functions, refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
If it is necessary to disable a path and not complete path failover (for example due
to maintenance), run commands to disable and then later enable the primary and
alternative paths.
The commands to enable and disable primary and alternative paths are tape
diagnostic and utility functions.
Note: See Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217.
Data Path failover and load balancing support for tape drives
The HP-UX device driver path failover support configures multiple physical paths
to the same device within the device driver and provides two basic functions.
1. Automatic failover to an alternative physical path when a permanent error
occurs on one path.
2. Dynamic load balancing for devices with multiple Host Bus adapters (HBA).
On HP-UX 11i v3, HP-UX system always picks up a best path for ATDD to
open. ATDD does not run a dynamic load balancing in open.
Note:
1. Data Path failover is not supported when block sizes greater than 256 K are
used, except in HP-UX 11i v3.
2. It is required that applications must open the primary path for Data Path
failover (not in HP-UX 11i v3).
Chapter 4. HP-UX Tape and Medium Changer device driver 69
3. Data Path failover is supported for 3592 tape drives on HP-UX 11i v2 and v3,
and for Ultrium 3, Ultrium 4, Ultrium 5, and Ultrium 6 drives on HP-UX v2
and v3.
Note:
a. 1234567890123456 is an example of a data path failover feature key. If you
have multiple 3584 libraries and multiple data path failover feature keys,
input your keys as follows:
DPF_KEYS="key1; key2; ..."
b. A DPF key is required for Ultrium 3 tape drives only. No DPF key must be
added into the /sbin/init.d/atdd file if you are running the most recent drive
code.
2. Save the file, then run the following command in HP-UX 11i v1 and v2:
# /opt/atdd/bin/atdd_claim
3. In HP-UX 11i v1 and v2, you can check whether the driver recognized multiple
data paths for your drives by running:
#ioscan -funC tape
If you see ".altpath" next to one of the special files, then you successfully
enabled control path failover feature for your library.
In HP-UX 11i v3, use the # ioscan -m dsf command to verify that the multiple path
is configured by the system and ATDD.
Note: See Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217.
After path failover support is enabled, it remains set until atdd_claim or kctune is
run with the alternate_pathing driver parameter set to OFF. The path failover
setting is retained even if the system is rebooted. If you want to turn off the data
path failover feature in the ATDD driver, complete the following steps.
If you want to turn the data path failover feature back on in the ATDD driver,
complete the following steps.
The primary and alternative path information can be obtained by issuing the
following command except in HP-UX 11i v3.
# ioscan -funC tape
The commands to enable and disable primary and alternative paths are tape
diagnostic and utility functions.
Note: See Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217.
Problem determination
A set of tools is provided with the device driver to determine if the device driver
and the tape device are functioning correctly.
Error logging
Read the system log file (typically /var/adm/syslog/syslog.log) and the ATDD log
file (/var/adm/atdd/atdd_d.log) if you are having problems. The ATDD logs
messages to this file that provides information about the problem.
Support_info script
Run the support_info script, in the /opt/OMImag/bin directory for the static driver
and in /opt/atdd/bin for the DLKM driver. This script gathers important system
and configuration information. There are several sections with the keyword
VERIFY, indicating information that must be verified for correctness.
Log in as user ID "root" on the system that experienced a problem. Then, run the
script and redirect the output to an end of a file.
Static
/opt/OMImag/bin/support_info > support_info.out
Tracing facility
Running the ATDD_trace utility, in the /opt/OMImag/bin for the static driver and in
/opt/atdd/bin for the DLKM driver, displays debug information. The utility traces
can be started at any time before an operation on a tape device. The default debug
level is 0x00001003, which shows driver configuration and per instance drive
attribute configuration and errors. You can increase the amount of debug
information that is displayed by enabling more trace flags. Issuing atdd_trace -f
0x1fffffff turns on every trace.
1. Determine which items must be traced and set the trace flags by using the
atdd_trace command. For example, to trace everything -
For the Static driver:/opt/OMImag/bin/atdd_trace -f 0x1fffffff
For the DLKM driver:/opt/atdd/bin/atdd_trace -f 0x1fffffff
In HP-UX 11i v3, run the sam utility or # kctune atdd_trace_level=1
command to set the trace level to 1. The default set is 3. The different levels
of tracing for 11iv3 are
v Full trace = 1
v Messages = 2
v Warnings = 3
v Errors = 4
The set of trace flags is displayed in Table 11.
Table 11. Trace flags
COMMAND VALUE
Configuration 0x00000001
General errors 0x00000002
Routine entry points 0x00000004
Returns 0x00000008
TRACE_DBG information 0x00000010
Open/Close routine 0x00000020
Trace motion commands 0x00000040
Read/Write 0x00000100
Strategy 0x00000200
Open/Close states 0x00000400
IOCTLs 0x00000800
Trace device config routines 0x00001000
Trace SCSI level stuff 0x00004000
Configuration 0x10000000
Entry point 0x01000000
General information 0x00400000
Memory 0x00200000
Table 13 describes problems and possible solutions for errors you might encounter
with the static driver.
Table 13. Troubleshooting (problems and solutions)
Problem Solution
No special files that are found in /dev/rmt Issue the following commands: /opt/OMImag/bincd
/opt/OMImag/binatdd_mksf | sh.
For tape diagnostic and utility functions, refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 217.
Purpose
The lin_tape and medium changer device driver is designed to take advantage of
the features that are provided by the IBM tape drives and medium changer
devices. The goal is to give applications access to the functions required for basic
tape operations (such as backup and restore) and medium changer operations
(such as mount and unmount the cartridges), and also the advanced functions that
are needed by full tape management systems. Whenever possible, the driver is
designed to take advantage of the device features transparent to the application.
Data flow
The software that is described in this chapter covers the Linux device driver
(lin_tape device driver) and the interface between the application and the tape
device.
a250181
Driver Driver
Product requirements
Hardware requirements
Software requirements
This file contains the latest driver information and supersedes the information in
this publication.
Conventions used
In subsequent pages, you see file names with x.x.x in them. The x.x.x refers to the
version of the driver, which changes as IBM releases new driver levels. Use the
actual driver version numbers as you complete the instructions.
Commands that you are to type are indicated with a leading ">" character, which
indicates the shell prompt.
Note: This procedure is run with tape diagnostic and utility functions. See
Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217.
Configuration limitations
Maximum supported number of 1024
tape devices
Maximum supported number of 16 (8 dual-port, 4 quad-port)
HBA ports
Maximum supported number of 16/16
paths for a device (DPF/CPF)
Maximum LUNs per system 256
Every attached tape or library device uses a certain amount of resources. The user
must consider resources such as physical memory and virtual space on the system,
which might further limit the number of devices that can be attached.
/usr/share/doc/packages/lin_tape/
lin_taped.Readme (for SUSE LINUX)
/usr/share/doc/packages/lin_tape/copying
(for SUSE LINUX)
Installation procedure
If lin_tape is already installed on your system, refer to the “Updating procedure.”
This section assumes that you are installing the lin_tape device driver onto a
system where it is not currently installed.
If you are installing lin_tape on a system that is running Linux for S/390® or
Linux for zSeries, ensure that the OpenFCP adapter device driver zfcp is loaded in
the kernel. Refer to “Configuring Tape and Medium Changer devices on IBM
System z models” on page 81 for how to configure and install zfcp.
Make sure that the C/C++ development and kernel development packages are
installed on your system. To install the lin_tape driver with all the added value of
the lin_taped daemon, complete the following steps.
1. Download the appropriate level of the source RPM package to a directory of
your choice on the Linux kernel for which you want to install it.
2. Run rpmbuild --rebuild <filename>, where: <filename> is the name of the RPM
file. A binary RPM package is created for your kernel from the source RPM
package. For example,
>rpmbuild --rebuild lin_tape-1.x.x.x.0-1.src.rpm
3. Output from the build is printed to your screen. Near the end of the output, a
line indicates the file name and location of your binary RPM package. For
example, a line similar to the following is output to your screen.
Wrote: /usr/src/redhat/RPMS/i386/lin_tape-1.x.x.x.0-1.i386.rpm
4. To install the lin_tape driver from the binary package, run >rpm -ivh
<filename> For example,
>rpm -ivh /usr/src/redhat/RPMS/i386/lin_tape-1.x.x.x.0-1.i386.rpm
5. To install the lin_taped daemon, download it to your Linux file system and run
rpm -ivh on the daemon RPM file. For example,
>rpm -ivh /usr/src/redhat/RPMS/i386/lin_taped-1.x.x.x.0-rhel5.i386.rpm
Updating procedure
If your current lin_tape device driver was installed from a rpm package
previously, you can uninstall the driver first, then install the newer version. For
example,
>rpm -e lin_taped
>rpm -e lin_tape
>rpmbuild --rebuild lin_tape.x.x.x.i386.rpm
>rpm -i lin_tape.x.x.x.i386.rpm
Note: All tape devices that use the lin_tape device driver must be closed and
cannot be in use when lin_tape is uninstalled.
The installed rpm package can be queried by running the following commands to
show information that is associated with the package.
To show the states of files in the package, for example, normal, not installed, or
replaced -
Note: Hot plugging SCSI devices while the Linux server is running can cause
hardware damage.
After the driver software is installed and a tape device is connected to the adapter,
the device can be configured and made available for use. Access to the device is
not provided until the device is configured.
If your system is attached to an IBM 3583 tape library with the integrated router,
before the QLogic driver is installed, set the host type of the router to solaris and
make sure that the logical unit numbers of the control unit, medium changer, and
the connected tape drives are contiguous. Otherwise, the QLogic device driver
does not recognize all of the attached devices. To view the LUNs of attached
devices, log on to the router and use the fcShowDevs command. If the LUNs are
not contiguous, use the mapCompressDatabase command to delete the invalid LUNs
and make the valid LUNs contiguous.
When you run the lin_tape kernel module, it creates special files in the /dev
directory.
For 2.4 kernels, there are three ways to load the zfcp device driver to see the
attached tape devices.
1. Create a /etc/zfcp.conf file and make a ramdisk to statically attach tape devices
into your system. You can use this method only if you have a persistent
mapping in a SAN environment. Every time that you reboot the system, the
zfcp is automatically loaded and the tape devices can be seen from the system.
You must add the device map into this file. The following is an example of
zfcp.conf.
0xf1c0 0x1:0x5005076300402733 0x0:0x0000000000000000;\
0xf1c1 0x1:0x5005076300402733 0x0:0x0001000000000000
The zfcp device driver uses the "map" module parameter to recognize a
physically attached tape device. map takes the following format,
map="<devno><port scsi-id>:<wwpn><unit-scsi-lun>:<fcp-lun>;...."
Where
devno The device number of the host bus adapter (16 bits, see
/proc/subchannels). It is 0xf1c0 or 0xf1c1 in the previous example.
port scsi-id
Linux internal SCSI ID assigned to the Fibre Channel port of the SCSI
target device (32-bit, must not be 0, must be a unique one-to-one
mapping for each worldwide port name. It is 0x1 in the previous
example.
wwpn Worldwide port name that identifies the Fibre Channel port of the SCSI
target device (64-bit). It is 0x5005076300402733 in the previous example.
unit scsi-lun
Linux internal SCSI Logical Unit Number (32-bit). It is 0x0 in the
previous example.
fcp-lun
Logical Unit Number that is associated with the SCSI target device
(64-bit). In the previous example, 0x0000000000000000 is the Logical
Unit Number 0, and 0x0001000000000000 is the Logical Unit Number 1.
Then, reboot the system. After it is booted up, your tape device must be shown
in /proc/scsi/scsi file.
2. Modify the /etc/modules.conf file to add the zfcp module parameters; then run
the depmod –A and modprobe zfcp command.
Note: Do not use this choice together with the first one, otherwise it causes
conflicts.
The zfcp map in /etc/modules.conf always takes higher priority than the map
in /etc/zfcp.conf.
The following example demonstrates the zfcp configuration in
/etc/modules.conf.
options zfcp map="\
0xf1c0 0x1:0x5005076300402733 0x0:0x0000000000000000;\
0xf1c1 0x1:0x5005076300402733 0x0:0x0001000000000000"
The map arguments are the same as the ones listed in for the /etc/zfcp.conf file.
After the /etc/modules.conf file is modified, save and close it. Then, run the
following command.
>depmod -A
>modprobe zfcp
This action installs the zfcp device driver and all of its prerequisite kernel
modules. Now you can check the file /proc/scsi/scsi to see if all of the attached
tape devices are shown in this file. If not, then check the Fibre Channel
connection, such as the fibre cables, or if the devices are powered on.
Then, run the following commands to install zfcp.
>rmmod zfcp
>modprobe zfcp
3. Run the modprobe zfcp command first, then dynamically add a tape device into
the system after you physically attach a Fibre Channel tape device to the
switch.
If you physically attach a tape device on the switch and zfcp is already loaded,
you do not need to reboot the Linux system to add this entry in the
/proc/scsi/scsi file. The zfcp device driver provides an "add_map" proc system
entry under the directory /proc/scsi/zfcp to dynamically add the device into the
system. For example, to add two logical units from the example in Step 2 into
the system, you can issue the following commands.
Uninstallation procedure
Note: All tape devices that use the lin_tape driver must be closed and cannot be
in use when lin_tape is uninstalled or the uninstall fails.
Configuration parameters
The configuration parameters are used to set the operating mode of the tape drive
and device driver when a device is opened. The installation defaults are provided
for all parameters initially. These parameters are kept on reopen, but are always
restored back to the default values when the lin_tape device driver is reinstalled.
Note: This procedure is completed with tape diagnostic and utility functions. See
Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217.
Nonchangeable parameters
The configuration parameters are used to set the operating mode of the tape drive
and device driver when a device is opened. The nonchangeable parameters are
detailed as follows.
Autoloading
This parameter enables the autoloading feature of the device driver. It is disabled
by default and cannot be changed.
Capacity scaling
This parameter sets the capacity or logical length of the current tape. By reducing
the capacity of the tape, the tape drive can access data faster at the expense of data
capacity. Capacity scaling is not supported currently but might be supported in
future releases of lin_tape.
Density code
This parameter is the density setting for the currently loaded tape. Some tape
devices support multiple densities and report the current setting in this field. It
cannot be changed by the application.
Emulate autoloader
Hook word
This parameter sets or resets the logical write protect of the current tape. This
feature is not supported currently but might be supported in future releases of the
lin_tape.
Medium type
This parameter is the media type of the current loaded tape. Some tape devices
support multiple media types and different values are reported in this field.
SILI bit currently is not supported due to limitations associated with the Linux
environment. SILI bit support can be enabled in future releases of the lin_tape.
This parameter specifies how the device driver operates when a forward or
backward space record operation encounters a filemark. Only the SCSI mode is
supported by lin_tape. When a forward or backward space record operation is
issued to the driver and a filemark is encountered, the device driver returns -1 and
the errno variable is set to input/output error (EIO). On the forward space
operation, the tape is left-positioned after the filemark (the end of tape side of the
filemark). On the backward space operation, the tape is positioned before the
filemark (the beginning of tape side of the filemark).
This parameter is the volume ID of the currently loaded tape. The lin_tape device
driver ignores this field.
Write protect
Changeable parameters
The configuration parameters are used to set the operating mode of the tape drive
and device driver when a device is opened. The changeable parameters are
detailed as follows.
Barcode length
This parameter can be set to change the barcode length for a cartridge. For LTO
cartridges the default is 8. It can be changed to 6 for LTO 1 and LTO 2 generation
cartridges only. For 3592 cartridges the default is set at 6. It can be changed to 8. In
the /etc/modprobe.conf.local file the following line must be added to reflect the
desired change.
options lin_tape ibm3592_barcode=8
options lin_tape lto_barcode=6
Block size
This parameter specifies the block size that is used for read and write operations.
A value of zero means a variable block size. Any other value is a fixed block size.
The installation default is zero (variable length block size). Refer to “Maximum
SCSI transfer length” on page 88 for guidance.
Buffered mode
This parameter specifies whether read and write operations must be buffered by
the tape device. The default (recommended) value is TRUE.
Capacity scaling
This parameter sets the capacity or logical length of the current tape on Enterprise
Tape System 3590 or 3592 tape subsystems. By reducing the capacity of the tape,
the tape drive can access data faster at the expense of data capacity. Capacity
scaling can be set at 100% for the entire tape (which is the default), or set at 75%,
50%, or 25% of the 3590 tape cartridge and more available capacity scaling for the
3592 standard 300 GB rewritable data cartridge. Capacity scaling remains with the
tape across mounts until it is changed.
Note:
1. The tape position must be at the start of the tape to change this parameter from
its current value.
2. Changing this parameter destroys any existing data on the tape.
3. For 3592 media types, capacity scaling is supported only for the standard 300
GB rewritable data cartridge. Attempting to set capacity scaling that is not
supported by a device or the current loaded media always returns 100% and
cannot be changed. For example, the 60 GB (Economy Data) cartridge for the
IBM 3592 cannot be capacity-scaled and is always 100%.
Compression
This parameter is provided in the lin_tape version 1.2.2 or later. It is set to FALSE
by default. If it is FALSE and the lin_taped daemon is running and if an error
occurs in the drive that creates a drive dump, the lin_tape device driver
automatically retrieves the drive dump and saves it under the /var/log directory
by default. You can specify another directory in the /etc/lin_taped.conf file. The
dump is labeled with a .dmp extension on the file. Refer to “Configuring and
running the lin_taped daemon” on page 101 for details.
This parameter is provided in the lin_tape version 1.2.2 or later. It is set to FALSE
by default. If it is FALSE and the lin_taped daemon is running and SIM/MIM data
is generated by the drive, the lin_tape device driver automatically retrieves the
data and saves it in a formatted text file under the /var/log directory by default.
You can specify another directory in the /etc/lin_taped.conf file. Refer to
“Configuring and running the lin_taped daemon” on page 101 for details.
Dynamic attributes
This parameter turns the volume information logging On or Off. With the lin_tape
version 1.2.2 and later, the lin_tape device driver provides this support. It is set to
On by default. If logging is On and the lin_taped daemon is running, the lin_tape
device driver retrieves the full log sense data from the drive whenever a tape is
unloaded, or the drive reaches a log threshold. The log file is saved in binary
format under the directory /var/log by default. You can specify another directory
in /etc/lin_taped.conf file. Refer to “Configuring and running the lin_taped
daemon” on page 101 for details.
Note: This parameter is volume logging, which is different from error logging.
lin_tape provides error logging whenever the lin_taped daemon is running. Refer
to “Configuring and running the lin_taped daemon” on page 101 for details on
error logging.
This parameter sets or resets the logical write protect of the current tape on
Enterprise Tape System 3590 tape subsystems. The three types of logical write
protect are associated protect, persistent protect, and write-once read-many
(WORM) protect.
1. Associated protect remains only while the current tape is mounted or
associated with the tape drive. It is reset when the tape is unloaded or the tape
drive is reset.
2. Persistent protect remains or persists with the tape across mounts until it is
reset.
3. WORM protect also remains with the tape across mounts, but unlike persistent
protect it cannot be reset on the tape. After a tape is WORM protected, it can
never be written on again.
Note: The tape position must be at the start of the tape to change this parameter
from its current value.
In the lin_tape drivers with level lower than 3.0.3, the maximum transfer length
per device per SCSI command is 262144 bytes (256 KB) by default. Variable block
read/write requests with transfer length greater than the maximum transfer length
fails [errno: EINVAL]. When a fixed block size is defined, large write requests are
subject to both the granularity of the block size and the maximum transfer length.
For example, with a fixed block size of 80000 bytes and maximum transfer length
of 262144, a write request for 400000 bytes (5 blocks of 80000 each) is written to
tape in two transfers. The first transfer is 240000 bytes (3 blocks) and the second
transfer is 160000 (the remaining two blocks). You can increase the maximum
transfer length to enhance the data throughput. This procedure can be done with
ITDT with the Query/Set Parameters option, or a customized STIOCSETP
input/output control (ioctl) call. However, setting the transfer length greater than
the default 256 KB does not guarantee a noticeable increase in data throughput.
Maximum transfer length of 256 KB is highly recommended.
In lin_tape driver with level 3.0.5 or higher and the open source driver lin_tape,
the maximum transfer length is defined as the minimum length that the host bus
adapter and the tape drive can support. This number is greater than 256 KB. It
cannot be changed by the STIOCSETP ioctl call any more.
Rewind immediate
This parameter sets the immediate bit for rewind commands. If it is set to On, the
rewind tape operation runs faster, but the next command takes a long time to
finish unless the physical rewind operation is complete. Setting this parameter
reduces the amount of time it takes to close a device for a Rewind on Close special
file.
Trace
This parameter turns the trace facility On or Off. With the lin_tape version 1.2.2
and later, the lin_tape device driver provides this support. It is set to On by
default. If trace is On and the lin_taped daemon is running, the lin_tape device
driver retrieves the trace from the driver if trace level is set to 1 or 2 in the
/etc/lin_taped.conf file. The trace file is saved under the directory /var/log by
default. You can specify another directory in /etc/lin_taped.conf file. Refer to
“Configuring and running the lin_taped daemon” on page 101 for details.
If this parameter is set to On, then writing records past the early warning mark on
the tape is allowed. The first write operation after detecting the early warning
mark fails and the errno variable is set to ENOSPC. No data is written during the
operation. All subsequent write operations are allowed to continue until the
physical end of the volume is reached and errno EIO is returned.
If this parameter is set to Off, then writing records past the early warning mark is
not allowed. Errno variable is set to ENOSPC.
Busy Retry
The parameter busy_retry determines how many times to retry a command when
the device is busy. Default is 0 (off), and can be set up to 480 in the configuration
file before the lin_tape is loaded.
Special files
After the driver is installed and a device is configured and made available for use,
access is provided through the special files. These special files, which consist of the
standard Linux special files for devices, are in the /dev directory.
For tape drives with attached medium changer devices, the IBMchanger* special
file provides a separate path for issuing commands to the medium changer. When
this special file is opened, the application can view the medium changer as a
separate device. Both the tape and changer special file can be opened at the same
time.
Table 15. Linux: Special files for IBM tape devices
Special file name Rewind on Close
/dev/IBMTape* YES
/dev/IBMTape*n NO
This name is always associated with the same physical device, rather than being
required to reference the device name /dev/IBMtape0, which can change names
and become /dev/IBMtape1 after the driver is reinstalled.
Lin_tape exports several attributes that can be used as the basis to create persistent
names. These attributes can be reported to the user through udevadm info on
recent Linux kernels, or udevinfo on older Linux kernels. The udevinfo and
udevadm are udev management tools. These tools can query the udev database for
device information and properties that are stored in the udev base for help
creating udev rules.
Note: Udev, udevinfo, and udevadm are not implemented or maintained by the
lin_tape driver. Refer to the man pages for udevadm or udevinfo for details on
usage. These man pages are system specific and supersede all information in this
document. For questions on these utilities, you must contact your Linux support
representative.
If a tape device is attached to the Linux system with worldwide port name
0x123456789ABCDEF0 with a current device name of /dev/IBMtape0, a user can run
udevadm information to obtain information on exported attributes for this device.
This procedure can be done as follows,
>udevadm info --attribute-walk --name /dev/IBMtape0
The ww_port_name is in a rules file that assigns a symbolic link to a device that
has the listed worldwide port name. The file typically is placed in
/etc/udev/rules.d, but this location might be changed by the udev_rules directive
in the /etc/udev/rules.conf file. In this example, a file is created that is called
/etc/udev/rules.d/98-lin_tape.rules and write a single line to the file.
KERNEL=="IBMtape*", ATTRS{ww_port_name}=="0x123456789ABCDEF0",
SYMLINK="lin_tape/by-id/lin_tape4801101"
Assuming that the udev service is running and configured correctly, the user can
install or reinstall lin_tape with modprobe, and the symbolic link is created in the
/dev/lin_tape/by-id folder. One line must be added to the 98-lin_tape.rules file for
each wanted symbolic link.
Note: Wait at least 10 seconds between step 3 (modprobe -r lin_tape) and step
5 (modprobe lin_tape) in order for udev to correctly configure the devices.
6. Check that the devices are all correctly listed with the following command.
ls -l /dev/lin_tape/by-id/
7. Restart the lin_taped daemon.
lin_taped
The Linux lin_tape device driver control path failover support configures multiple
physical control paths to the same logical library within the device driver. It also
provides automatic failover to an alternative control path when a permanent error
occurs on one path. This support is transparent to the running application.
If your library lists "Primary" or "Alternate" under "FO Path", you successfully
enabled the control path failover feature for your library. If "NA" is listed under
"FO Path", then the control path failover is not enabled. After control path failover
support is enabled, it remains set until the lin_tape driver is reloaded with the
alternate_pathing driver parameter set to OFF. The path failover setting is
retained even if the system is rebooted. If you want to turn off the control path
failover feature in the lin_tape device driver, you can complete the following steps.
1. lin_taped stop
2. rmmod lin_tape
3. Delete the following line in your /etc/modprobe.conf file.
options lin_tape alternate_pathing=1
4. depmod
5. modprobe lin_tape
6. lin_taped
| Note: To validate the lintape version that adds this support, check the fixlist for a
| statement about SFMP support.
| Example output:
| pfo10 sg=/dev/sg10 st=none sf=yes fo=no wwnn=0000013400140405 type=changer
| 2:0:1:1 up last - -
| 3:0:1:1 - - - -
| There is only one sg device file name per device that uses all the paths for this
| device.
Note: Show the primary and alternative path configuration for any device with
tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 217.
If it is necessary to disable a path and not run path failover (for example, because
of maintenance), run commands to disable and then later enable the primary and
alternative paths.
The commands to enable and disable primary and alternative paths are tape
diagnostic and utility functions.
Note: See Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217.
Data Path failover and load balancing support for tape drives
Data path failover support is not enabled automatically when the device driver is
installed. The Linux lin_tape device driver provides a driver parameter
alternate_pathing for you to enable the data path failover.
To enable the failover support in the lin_tape device driver software, you must
complete the following steps after the lin_tape rpm package is installed.
>lin_taped stop (stop the lin_taped daemon)
>rmmod lin_tape (unload the lin_tape driver from the memory
If you have IBM LTO tape drives, the library must have a path failover feature
code. The data path failover license keys are needed to enable the failover if you
are running LTO2 drives or if you are running LTO3 drives with old levels of drive
code. DPF keys do not need to be added if you are running the latest drive code
on LTO3 or higher drives.
If your tape drive lists "Primary" or "Alternate" under "FO Path", you successfully
enabled data path failover feature for your tape drive. If it is "NA" listed under
"FO Path", then the data path failover is not enabled. After the path failover
support is enabled, it remains set until the lin_tape driver is reloaded with the
alternate_pathing driver parameter set to OFF. The path failover setting is
retained even if the system is rebooted. If you want to turn off the data path
failover feature in the lin_tape device driver, you can run the following steps.
>lin_taped stop
>rmmod lin_tape
| Note: To validate the lintape version that adds this support, check the fixlist for a
| statement about SFMP support.
The primary and alternative path information can be obtained by the following
command.
>cat /proc/scsi/IBMtape
| Example output:
| pfo9 sg=/dev/sg9 st=/dev/st0 sf=yes fo=no wwnn=500507630f04be07 type=tape
| 2:0:1:0 up last - wwpn=500507630f44be07
| 3:0:1:0 - - - -
| Only one st and one sg device file name per device can use all the paths for that
| device.
Note: Show the primary and alternative path configuration for any device with
tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 217.
The commands to enable and disable primary and alternative paths are tape
diagnostic and utility functions.
Note: See Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217.
/dev/IBMchanger0, etc.
proc entry /proc/scsi/IBMtape No change
/proc/scsi/IBMchanger
Daemon name IBMtaped lin_taped
Daemon configuration file /etc/IBMtaped.conf /etc/lin_taped.conf
Daemon trace files /var/log/IBMtape.trace /var/log/lin_tape.trace
/var/log/IBMtape.errorlog /var/log/lin_tape.errorlog
Installation
Installation of the lin_tape driver is the same as for the IBMtape driver, except
that IBMtape must be replaced with lin_tape in the installation instructions. Refer
to “Installation and Configuration instructions” on page 77 for details.
The lin_tape driver cannot be installed if the IBMtape driver is already installed. If
the IBMtape driver is installed, first uninstall the IBMtape driver, and then install
the lin_tape driver. With RHEL4 and SLES10, driver removal also requires a reboot
of the server, since the IBMtape driver module is "permanent" in these
distributions.
The special device files for the lin_tape driver are the same as for the IBMtape
driver. Refer to “Special files for the tape device” on page 89 and “Special files for
the Medium Changer device” on page 89 for details on special device files.
After the maintenance is complete and the environment is ready to issue input and
output, the drivers must be reinstalled in reverse order. This procedure is typically
done by
modprobe <HBA_driver>
modprobe lin_tape
To check whether the lin_taped daemon is running, run the following command.
lin_taped status
For details about path failover support, refer to “Control Path failover support for
tape libraries” on page 92 and “Data Path failover and load balancing support for
tape drives” on page 94.
lin_taped daemon
The lin_taped daemon uses the same command-line arguments as the IBMtaped
daemon. The lin_taped configuration file is the same as the IBMtaped
configuration file, but is renamed to lin_taped.conf. Refer to“Configuring and
running the lin_taped daemon” on page 101 for information.
System-managed encryption
The device driver SME settings can be set for all drives at once with the
default_sys_encryption_proxy and default_sys_encryption_write module options.
If no options are specified in the registry, the driver uses the default values for the
parameters.
v The default value for default_sys_encryption_proxy is 1.
This value causes the device driver to handle encryption key requests, if the
drive is set up for system-managed encryption. This value does not need to be
The default settings are used to initialize the settings for all connected drives.
To modify the settings for individual drives, the settings are sys_encryption_write
and sys_encryption_proxy. They have the same definitions and values as the
similarly named "default" parameters, except that the settings apply only to
individual drives.
These settings are available as part of the sysfs infrastructure. For each drive, there
are two files, named sys_encryption_write and sys_encryption_proxy, in the
/sys/class/lin_tape/{DEVICE}/ directory, where: {DEVICE} is the device name,
such as IBMtape0. The contents of these files indicate the current setting for the
parameter for that particular drive. The setting can be changed by writing a
different value for the parameter to the file.
Note: The driver encryption parameters for individual drives are not persistent
between loads of the lin_tape driver. If you remove the lin_tape driver, and then
reload it, the individual settings for all drives are the same as the "default" settings
in /etc/modprobe.conf, /etc/modprobe.conf.local, or /etc/modprobe.d/lin_tape.conf.
The ibmekm.conf file, which contains the configuration that the EKM servers use,
is installed in the /etc/ directory when lin_tape is installed. Instructions for
modifying this file are found within the file itself.
Problem determination
A set of tools is provided with the device driver to determine whether the device
driver and the tape device are functioning correctly.
Then reinstall lin_tape. This action causes the lin_tape_debug variable to be set
every time lin_tape is loaded.
v Issue the following command from the shell.
echo 1 > /sys/bus/scsi/drivers/lin_tape/lin_tape_debug
This action causes the lin_tape_debug variable to be set only until lin_tape is
uninstalled or until the variable is set back to 0.
Installing lin_taped
You can customize the operation of lin_taped by modifying its configuration file,
which is at /etc/lin_taped.conf. The daemon reads only the configuration file when
it starts; so if you modify the configuration file, stop the daemon, and restart it so
that your modifications are recognized by the daemon.
Tracing:
Three levels of tracing are supported for the lin_taped daemon. lin_taped tracing is
a complement to, but is different from, tracing of the kernel module that is
described in “Tracing driver modules” on page 101. The lin_taped tracing levels
are defined as follows:
You can change the directory to which the tracing information is written or the
default maximum size of the trace file by modifying settings in the lin_taped.conf
file. Refer to the instructions in the lin_taped.conf file for details.
Error logging:
lin_taped records certain error messages from the lin_tape device driver in a file
named /var/log/lin_tape.errorlog, by default. Information is written into the file
until it is 1 MB in size, by default. After 1 MB of trace information is written, the
file is archived (with the Linux ar command) into file lin_tape.a in the same
directory. In the archive, the file name is renamed to lin_tape.errorlog.timestamp,
where timestamp reflects the time that the file was archived.
You can change the directory to which the error logging information is written or
the default maximum size of the error log file by modifying settings in the
lin_taped.conf file. Refer to the instructions in the lin_taped.conf file for details.
The first line indicates the tape device special file name and the device serial
number, and the timestamp when the error message was recorded. "Scsi Path" is
the SCSI path for this logical unit. It matches the order of the scsi/Channel/Id/Lun
information in the /proc/scsi/scsi file. "CDB Command" is the command data block
of the SCSI command. "Status Code" is the returned result from the Linux SCSI
middle layer device driver (scsi_mod.o). The 4 bytes represent driver_byte,
host_byte, msg_byte, and status_byte. "Sense Data" is the full SCSI sense data that
is returned from the target. "Description" is a person-readable text string that is
obtained by parsing the sense key field of the sense data.
Volume logging:
The lin_tape device driver retrieves the full log sense data from the tape drive
whenever the drive reaches a log threshold, or a tape is unloaded from the drive,
or the drive is reset through an application. This data is stored in binary in a file
named lin_tape.timestamp.log, where: lin_tapen is the device special file (for
example, lin_tape1, lin_tape2) and timestamp reflects the time that the file was
created. Each time log sense data is obtained, it is written to a new file. Use the
appropriate tape drive hardware reference manual to decode the log sense data.
The volume logging data is stored in the /var/log directory by default. You can
specify another directory in the /etc/lin_taped.conf file.
There are two configuration parameters in the /etc/lin_taped.conf file that you can
tailor to affect the number of log sense files that are kept on your system.
v lin_tapeMaxLogSenseFiles, which has a value of 0 or a positive decimal number.
v lin_tapeAutoLogSenseFileOverWrite, which has a value of 0 or 1.
If a condition occurs in the drive such that a drive dump is created, lin_taped
retrieves the drive dump and saves it in a file named lin_tapex.timestamp.dmp,
wherelin_tapen is the device special file (for example, lin_tape1, lin_tape2) and
timestamp reflects the time that the file was created. Each time a drive dump is
obtained, it is written to a new file. The IBM service organization might request
that you forward drive dumps to them for analysis.
The drive dumps are stored in the /var/log directory by default. You can specify
another directory in the /etc/lin_taped.conf file.
There are two configuration parameters in the /etc/lin_taped.conf file that you can
tailor to affect the number of drive dumps that are kept on your system.
v lin_tapeMaxDumpFiles, which can have a value of 0 or a positive decimal
number.
v lin_tapeAutoDriveDumpFileOverWrite, which can have a value of 0 or 1.
If a condition occurs in the drive such that a drive SIM/MIM data is created,
lin_taped retrieves the data and save it in a file named
lin_tapex.timestamp.simmim, where lin_tapen is the device special file (for
example, lin_tape1, lin_tape2) and timestamp reflects the time that the file was
created. Each time SIM/MIM data is obtained, it is written to a new file. The IBM
service organization might request that you forward SIM/MIM data to them for
analysis.
The SIM/MIM data is stored in the /var/log directory by default. You can specify
another directory in the /etc/lin_taped.conf file.
If lin_tapeMaxSimMimDataFiles is 0, lin_tapeAutoSimMimDataOverWrite is
ignored, and each time SIM/MIM data is obtained, it is written to a new file.
Selective tracing:
Lin_tape provides facilities by which you can disable and enable tracing, error
logging, auto-retrieving drive dumps, and auto-retrieving SIM/MIM data. You can
selectively enable or disable them through an application program, which uses the
STIOC_SETP ioctl. These settings persist until the device driver is restarted, or the
host system is rebooted.
Running lin_taped:
If you are running the lin_tape device driver, version 1.4.1 or higher, after
installing lin_tape lin_taped starts running even if your system does not have a
You can start lin_taped from the command line. lin_taped takes zero or more of the
parameters as listed in the following command.
lin_taped [start stop restart status]
lin_taped or lin_taped start
Starts the daemon. If there is already a lin_taped running, the new one is
aborted. (Use lin_taped restart if lin_taped is already running.)
lin_taped stop
Terminates the daemon and frees all the resources that are associated with
the daemon. When the daemon is stopped, no information is saved.
lin_taped restart
Terminates the currently running daemon and starts a new one. The new
daemon reads the /etc/lin_taped.conf file. This command is used after the
/etc/lin_taped.conf file is modified while lin_taped is running.
lin_taped status
Prints a message on stdout to indicate whether the daemon is running or
not.
Note: If you run rmmod lin_tape command to remove the lin_tape device driver
from the running kernel, you must stop the lin_taped daemon first; otherwise you
get a Device or Resource Busy error.
to the debug buffer. To prevent multiple identical entries in the error log,
subsequent reservation conflicts from the same reserving host WWPN are not
logged.
Purpose
This device driver product provides attachment for IBM Magnetic Tape and
Library System products to Oracle SPARC and x64 Servers running the Solaris
operating system.
Data flow
Both data and commands flow between the application program and the tape
subsystem by way of IBMtape. Figure 13 shows the data flow between IBMtape,
the application program, the SCSI adapter device driver, and the IBM tape system.
SCSI or
IBMtape FC IBM
Application
Device Host Bus Tape
Program
a2500266
Driver Adapter Subsystem
Driver
Product requirements
Hardware requirements
Refer to the “Hardware requirements” on page 1 for the latest hardware that is
supported by the IBMtape device driver.
Note: For IBM Ultrium drives with the Fibre Channel attachment, the Oracle
Solaris operating system requires that the Fibre Channel addressing mode of the
drive be set to hard addressing.
Software requirements
The IBMtape package consists of the device driver and a number of associated
files and utilities. For components that are created during IBMtape installation,
refer to Table 19.
Table 19. Solaris: IBMtape components
Component (Note) Description
/etc/ibmekm.conf SME configuration file, working version
/etc/tmd.conf TMD configuration file, working version
/opt/IBMtape Package subdirectory
/opt/IBMtape/diags_info Diagnostic script
/opt/IBMtape/ibmekm.conf SME configuration file, reference version
/opt/IBMtape/tapelist Utility program
/opt/IBMtape/tmd Tape Monitor Daemon (TMD) program
/opt/IBMtape/tmd.conf TMD configuration file, reference version
/opt/IBMtape/IBMtape.conf Configuration file, reference version
/opt/IBMtape/ztapelist Shell script for Solaris zones use
/opt/IBMtape/tapedtrc Dynamic tracing utility program
/usr/kernel/drv/IBMtape Kernel module device driver
/usr/kernel/drv/IBMtape.conf Configuration file, working version
/usr/include/sys/smc.h Medium changer application programming
interface (API) header file
/usr/include/sys/st.h Tape drive API header file
/usr/include/sys/svc.h Service aid API header file
/usr/include/sys/oldtape.h Compatibility API header file
Note: When IBMtape is updated, the working copies of IBMtape.conf, tmd.conf, and
ibmekm.conf are not overwritten by the package file contents. This action allows tape
drive configuration options to be preserved across IBMtape updates. The reference copies
of IBMtape.conf, tmd.conf, and ibmekm.conf are always installed in the /opt/IBMtape
directory.
Examples of installation commands and their results throughout this chapter use a
percent sign (%) to indicate the shell prompt.
Note: To prevent more than one device driver from claiming IBMtape-owned
devices, IBMtape must be also configured with the HBA correctly. Refer to the
section of “Configuring IBM tape devices with Oracle FC and SAS HBAs” on page
117 for the details.
Attention: Failure to prevent more than one device driver from operating the
same tape drive might cause system panics or data loss on the tape drive.
The following installation and update steps describe how to prevent conflicts
between IBMtape and other SCSI tape device drivers.
Preinstallation considerations
Follow these steps to install or update IBMtape. Before the step-by-step procedure
is started, note the following general considerations.
v Differential SCSI-2 support must exist on the machine before IBMtape is
installed. Install and configure one of the supported differential SCSI adapters
first, then return to this section. Refer to the differential SCSI adapter
documentation for instructions on installing the adapter and adapter driver.
v You must have root authority to install or remove IBMtape.
v You can restart the system as part of the IBMtape installation. Take appropriate
precautions that this action does not adversely affect users or active processes on
the system.
v As a consequence of installing or reinstalling IBMtape, device special file
numbers under /dev/rmt might change. These numbers are assigned by Solaris
during the driver attachment process, and the sequencing cannot be specified by
the device driver or installer.
| Note: At the time of this writing, Solaris IBMtape driver does not yet support
| LTO 7. Check the Fixlist on FixCentral for updates on LTO 7 support.
Note: When the drive is configured with Oracle HBA driver, even though the
hardware path shows as st@w10000000c9848d68,0 the device special file still
indicates that the drive is configured with IBMtape driver.
lrwxrwxrwx 1 root root 80 Feb 22 05:12 /dev/rmt/0st ->
../../devices/pci@400/pci@0/pci@d/SUNW,emlxs@0/fp@0,0/
st@w10000000c9848d68,0:st
The previous device special file is created by IBMtape. Refer to “Special files”
on page 131 for detail.
In this example, /dev/rmt/0st (a SCSI tape drive) is controlled by IBMtape and
is associated with the device at SCSI address b, LUN 0. The address is
reported in hexadecimal format: The file /dev/rmt/1smc (a SCSI medium
changer) is associated with the device at SCSI address b, LUN 1. Record the
device type, /dev/rmt special file number, owning driver, SCSI target address,
and LUN. This information is required later in the installation.
For example, suppose that an installation has only an IBMtape-owned device
that is installed at SCSI address 8. The device consists of both a tape drive and
SCSI medium changer. The tape drive is accessed as /dev/rmt/2st, and the
medium changer as /dev/rmt/3smc. For a similar equipment listing after the
device information is recorded, refer to Table 21.
Table 21. Solaris Device Driver - IBMtape - equipment listing example 1
SCSI address/LUN
DEVICE Old special fle Old driver (Old)
3590-B11 drive /dev/rmt/2st IBMtape 8/0
3590-B11 changer /dev/rmt/3smc IBMtape 8/1
7. Select one of the following methods to prevent conflicts between IBMtape and
other SCSI tape device drivers, depending on the equipment that is attached
to your system.
Note: To prevent more than one device driver from claiming IBMtape-owned
devices, IBMtape must be also configured with HBA correctly. Refer to the
section of “Configuring IBM tape devices with Oracle FC and SAS HBAs” on
page 117
110 IBM Tape Device Drivers: Installation and User's Guide
page 117 for the details.
Attention: Failure to prevent more than one device driver from operating the
same SCSI tape drive can cause system panics or data loss on the tape drive.
a. If the system has only IBMtape-owned devices that are attached, follow
these steps to prevent st and other non-IBM SCSI tape device drivers from
claiming the IBM devices.
1) Edit /kernel/drv/st.conf, and comment out all SCSI target entries by
placing a number sign (#) in the first column of each target entry. The
following example shows the entries for SCSI target addresses 0 and 1
commented out. Repeat this operation for all target entries.
#name="st" class="scsi"
#target=0 lun=0;
#name="st" class="scsi"
#target=1 lun=0;
2) For other non-IBM installed SCSI tape device drivers, remove the
drivers if they are not needed. If a driver is for SCSI tape devices only,
it is not needed. If a driver is for both tape and disk devices, follow the
suppliers’ instructions to disable its access to all SCSI tape devices.
b. If the system has a mixture of IBMtape-owned devices and other tape
drives, follow these steps to configure st and other non-IBM SCSI tape
device drivers so that they control a range of target addresses distinct from
the range that IBMtape uses. These steps leave target addresses 7 and 15
unclaimed by all target device drivers because SCSI adapters typically use
one of the two addresses.
1) Edit /kernel/drv/st.conf, and comment out SCSI target entries for
addresses 7-15 by placing a number sign (#) in the first column of each
target entry. In the following example, the entries for SCSI address 7
and 8 are commented out. Repeat this operation for all entries in the
target address range 7-15.
#name="st" class="scsi"
#target=7 lun=0;
#name="st" class="scsi"
#target=8 lun=0;
2) For other non-IBM installed SCSI tape device drivers, follow the
suppliers’ instructions to disable their access to all SCSI tape devices in
the address range 7-15.
3) After the IBMtape package is installed, you must alter its configuration
file so it does not use SCSI target addresses in the range 0-7 or address
15.
Now st and other non-IBM SCSI tape device drivers are configured to
avoid a conflict with IBMtape.
8. Remove all special file entries under /dev/rmt. This action ensures that stale
entries do not exist after the system is restarted. New entries are created when
the system is restarted.
% rm /dev/rmt/*
9. Read the next section of “Configuring IBM tape devices with Fibre Channel
and SAS HBAs” on page 115, and follow the instruction requirements for the
selected HBA in the host machine before or after IBMtape is installed.
10. If you are updating the level of IBMtape, remove the currently installed
IBMtape package. If this procedure is a new installation of IBMtape, skip this
step.
a. Use pkgrm to remove the current level.
Note: If this procedure is a new installation of IBMtape, IBM devices are not
yet attached to the system, pkgadd error messages similar to the following are
output.
...
drvconfig: Driver (IBMtape) failed to attach
Warning: Driver (IBMtape) successfully added to system
but failed to attach
## The device driver was unable to detect any supported devices!
## Verify that the device(s) are properly connected and powered on.
## Ensure that the SCSI adapter device driver is installed/configured.
## Then try reinstalling the device driver as follows:
## -enter the command: rem_drv IBMtape
## -enter the command: add_drv -m ’* 0666 bin bin’ IBMtape
## If problems persist, contact your IBM service representative.
pkgadd: ERROR: postinstall script did not complete successfully
...
Later, after you cabled IBM drives to the system and restarted, the driver
attaches normally.
If the distribution medium is a package file in a UNIX file system, complete
the following steps. You might obtain a package file by downloading it from
the IBM Fix Central website: http://www.ibm.com/support/fixcentral. For
information, see Appendix A, “Accessing documentation and software online,”
on page 327. This example presumes a package file named IBMtape.4.0.2.7 in
the /tmp directory.
a. If necessary, FTP the package file to the target system. Use binary transfer
mode. Place the package file in the target system’s /tmp directory.
b. Use pkgadd to install the driver.
% /usr/sbin/pkgadd -d /tmp/IBMtape.4.0.2.7
12. If your system environment includes a mixture of IBMtape-owned devices
and devices that are owned by st or another third-party SCSI tape device
driver, you must first modify the configuration files for the non-IBM device
drivers and restrict them to target addresses in the range 0-6.
Edit IBMtape.conf, in /usr/kernel/drv, and comment out entries for SCSI
target addresses 0-7 and 15. Place a number sign (#) in the first column of
each line that makes up the entries. In the following example, the entries for
address 0, LUN 0 and address 0, LUN 1 are commented out. Repeat the
operation for all stanzas in the address range 0-7 and address 15. Each SCSI
target address has a stanza for both LUN 0 and LUN 1.
Alternatively, you can modify the configuration file or use the utility that is
provided by the Fibre Channel HBA driver to persistently bind the tape
device to the expected SCSI target address.
13. Shut down the system. One common method to complete a shutdown is
shown here but use your installation’s normal procedures.
% /usr/sbin/shutdown -y -g0 -i0
14. Address or readdress devices as determined by your installation.
a. If the system has only IBMtape-owned devices that are attached, you can
select addresses in the range 0-6 or 8-14. Leave addresses 7 and 15 unused
because these addresses are used typically by the SCSI adapter.
1) For each device, refer to the appropriate IBM hardware reference for
any special instructions about addressing. Then, set the address and
record the device type, SCSI address, and LUN. For example, suppose
that an installation has only IBMtape-owned devices attached. An IBM
device with tape drive and medium changer is added. It is addressed
at target 4 and the information is recorded. For the results, refer to
Table 22
Table 22. Solaris Device Driver - IBMtape - equipment listing example 2
SCSI SCSI
Old special address/LUN address/LUN
DEVICE file Old driver (Old) (New)
3590-B11 drive - - - 4/0
3590-B11 changer - - - 4/1
b. If you are using distinct address ranges to separate tape drives that are
IBMtape-owned from devices that are owned by st or another supplier’s
driver, readdress the tape drives now.
1) For each device that is owned by st or another SCSI tape device driver,
refer to the manufacturer’s hardware reference for any special
15. Cable the tape drives to the system, if not yet done. Refer to the
manufacturer’s hardware references for any special instructions about cabling.
Ensure that each SCSI bus is terminated properly.
16. Start the system according to your installation’s normal procedures.
17. Log on as root and list the device special files in /dev/rmt as you did earlier
during the installation.
% ls -l /dev/rmt/*l
% ls -l /dev/rmt/*st /dev/rmt/*smc
Compare the SCSI addresses obtained from ls with the readdressed SCSI
targets you recorded. Write the new device special file numbers and owning
driver next to the matching new SCSI addresses.
For example, suppose that an installation previously had two non-IBM devices
that are owned by st at SCSI addresses 2-8. An IBM device with tape drive
and medium changer is added. To prevent conflicts between IBMtape and st,
the non-IBM devices are all placed at addresses in the range 0-6. The new IBM
device is addressed in the range 8-14. Depending on the addresses that are
chosen after installation is completed and device information is recorded, refer
to Table 24 for the possible equipment listing entries.
Table 24. Solaris Device Driver - IBMtape - equipment listing example 4
SCSI SCSI
Old special Old address/LUN address/LUN New New special file
DEVICE file driver (Old) (New) driver (Note)
QIC /dev/rmt/5l st 2/0 2/0 st /dev/rmt/0l
To configure an IBM tape device with a QLogic FC HBA, complete the following
steps.
1. Run the QLogic SANSurfer Control FX utility to find and record the mapped
target and LUN of the tape device.
2. Remove the comment at the beginning of the entry for the QLogic HBA in the
/usr/kernel/drv/IBMtape.conf file.
For example, the following command opens the entry for QLogic QLA2462
running QLogic HBA driver qla2300.
name="IBMtape" parent="qla2300" target=0; # for qla2300 only
3. Update the entry for the device in the IBMtape.conf file, if necessary. The
current entry in the IBMtape.conf file is added to target 255 with LUN 0 and 1.
For instance, the following command adds an entry for a mapped device with
target 200 and LUN 3.
name="IBMtape" class="scsi" target=200 LUN=3;
4. Unload and reload the IBMtape driver.
# /opt/IBMtape/tmd -s
# rem_drv IBMtape
# add_drv -m ’* 0666 bin bin’ IBMtape
# /opt/IBMtape/tmd
5. Display information on the configured devices by running
/opt/IBMtape/tapelist -l.
To configure an IBM tape device with a QLogic FC HBA running with Oracle
branded QLogic FC HBA driver (qlc), refer to the section “Configuring IBM tape
devices with Oracle FC and SAS HBAs” on page 117.
To configure an IBM tape device with an Emulex FC HBA, complete the following
steps.
1. Run the Emulex HBAnyware utility to find and record the mapped target and
LUN of the tape device.
2. For lpfc.6.30g or later, update the parameters setting in /kernel/drv/lpfc.conf
and reboot the system.
If IBMtape driver is used as a tape driver, change the parameter for IBMtape.
target-tape="IBMtape
If IBMtape driver is used as a changer driver, modify the setting for IBMtape.
target-tapechanger="IBMtape"
3. Remove the comment at the beginning of the entry for the Emulex HBA in
/usr/kernel/drv/IBMtape.conf:
name="IBMtape" parent="lpfc" target=0;
If this action fails to configure the changer, you might need to add the entries
for LUN 0 and 1.
To configure an IBM tape device with an Emulex FC HBA running with Oracle
branded Emulex FC HBA (emlxs) driver, refer to the section “Configuring IBM
tape devices with Oracle FC and SAS HBAs.”
To configure an IBM tape device with an Oracle FC HBA, complete the following
steps.
1. Attach the IBM tape devices on the host.
2. Install the appropriate patch for the Oracle HBA driver.
3. Run # cfgadm -al to display the configuration between the HBA and the tape
device.
Run # cfgadm -al -o show_FCP_dev Ap_Id to show the medium changer
configuration with the FC HBA.
Run # cfgadm -c configure device to configure the tape device with the HBA if
needed.
4. Install the IBMtape tape driver by running the # pkgadd -d IBMtape command.
5. Enter the following appropriate lines in /etc/driver_aliases:
IBMtape "scsiclass,01.vIBM.pXXX" for tape drive.
IBMtape "scsiclass,08.vIBM.pXXX" for medium changer.
Where: 01 and 08 stand for the type of tape drive and medium changer and
XXX is the product ID string in the standard inquiry data. For example,
ULT3580-TD2 is the product ID of the IBM LTO2 drive. The following entry is
added in the file for the IBM LTO2 drive.
IBMtape "scsiclass,01.vIBM.pULT3580-TD2"
The following is a list of the entries for the supported IBM tape devices.
For the tape drives
IBMtape "scsiclass,01.vIBM.pULT3580-TD1"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD1"
IBMtape "scsiclass,01.vIBM.pULT3580-TD2"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD2"
IBMtape "scsiclass,01.vIBM.pULT3580-TD3"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD3"
IBMtape "scsiclass,01.vIBM.pULT3580-TD4"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD4"
IBMtape "scsiclass,01.vIBM.pULT3580-TD5"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD5"
IBMtape "scsiclass,01.vIBM.pULT3580-HH2"
IBMtape "scsiclass,01.vIBM.pULTRIUM-HH2"
IBMtape "scsiclass,01.vIBM.pULT3580-HH3"
Note: The entry is also added running the # update_drv command on Solaris 8
(patch 111804-03 is required), Solaris 9, and later versions of the operating
system. For example,
# update_drv -av -i ’"scsiclass,01.vIBM.pULT3580-TD2"’ IBMtape
6. Reboot the system by running # reboot -- -r.
7. Run # /opt/IBMtape/tapelist -l to display the configured tape device
information.
Note: All of the added entries are removed by the operating system
automatically after IBMtape is unloaded from the kernel by running the #
pkgrm, rem_drv, or modunload commands. It is recommended that you back up
these entries in a file. Then, reenter the entries when you upgrade the IBMtape
driver before the #pkgadd command is run.
To configure an IBM tape device with an AMMC FC HBA, complete the following
steps:
1. Modify and add the following parameters in /kernel/drv/jnic146x.conf.
CmdTaskAttr=1;
lun_throttle=1;
tape-device="IBMtape";
tape-changer="IBMtape";
2. Update the change in jnic146x.conf.
3. Run the EZ Fibre utility to find and record the mapped target and LUN of the
tape device.
4. Remove the comment from the beginning entry for AMCC HBA in
/usr/kernel/drv/IBMtape.conf.
name="IBMtape" parent="jnic146x" target=0;
To configure an IBM tape device with a Brocade FC HBA, complete the following
steps.
1. Attach IBM tape devices on the host.
2. Install the appropriate version of Brocade HBA driver and its utilities.
3. Run Brocade HCM (Host Connectivity Manager) to display the configuration.
4. Install the IBMtape tape driver by running # pkgadd command.
5. Enter the following appropriate lines in /etc/driver_aliases:
IBMtape "scsiclass,01.vIBM.pXXX" for tape drive.
IBMtape "scsiclass,08.vIBM.pXXX" for medium changer.
Where: 01 and 08 stand for the type of tape drive and medium changer and
XXX is the product ID string in the standard inquiry data. For example,
ULT3580-TD2 is the product ID of the IBM LTO2 drive. The following entry is
added in the file for the IBM LTO2 drive,
IBMtape "scsiclass,01.vIBM.pULT3580-TD2"
The following is a list of the entries for the supported IBM tape devices.
For the tape drives
IBMtape "scsiclass,01.vIBM.pULT3580-TD3"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD3"
IBMtape "scsiclass,01.vIBM.pULT3580-HH3"
IBMtape "scsiclass,01.vIBM.pULTRIUM-HH3"
IBMtape "scsiclass,01.vIBM.pULT3580-TD4"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD4"
IBMtape "scsiclass,01.vIBM.pULT3580-HH4"
IBMtape "scsiclass,01.vIBM.pULTRIUM-HH4"
IBMtape "scsiclass,01.vIBM.pULT3580-TD5"
IBMtape "scsiclass,01.vIBM.pULTRIUM-TD5"
IBMtape "scsiclass,01.vIBM.pULT3580-HH5"
IBMtape "scsiclass,01.vIBM.pULTRIUM-HH5"
IBMtape "scsiclass,01.vIBM.p03592E05"
IBMtape "scsiclass,01.vIBM.p03592E06"
IBMtape "scsiclass,01.vIBM.p03592E07"
IBMtape "scsiclass,01.vIBM.p03592E08"
For the medium changers
IBMtape "scsiclass,08.vIBM.p03584L32"
IBMtape "scsiclass,08.vIBM.p03584L22"
IBMtape "scsiclass,08.vIBM.p3576-MTL"
IBMtape "scsiclass,08.vIBM.p3573-TL"
IBMtape "scsiclass,08.vIBM.p3572-L1U"
IBMtape "scsiclass,08.vIBM.p3572-TL"
IBMtape "scsiclass,08.vIBM.p3577-TL"
Configuring limitations
The subsequent limitations are applied for the IBMtape driver that runs on a
Solaris host.
Every opened tape device uses a certain amount of resources. The user must also
consider other resources such as physical memory and virtual space on the system
before you attempt to reach the limits.
The IBMtape driver supports the Solaris Zones environment. To install IBMtape
on the system with the virtualized zones, run the pkgadd system command from
the global zone.
#pkgadd -G -d IBMtape.x.x.x.x
The IBMtape installation script installs the driver in the global zone and installs
some of IBMtape utilities that run a non-root user in all zones.
Since the tape devices in non-global zones are configured from the global zone, a
script program that is called ztapelist was developed to help the user display the
IBM tape devices. And, it dynamically assigns or removes IBM tape devices in
non-global zones without the non-global zone reboot requirement. The utility
(available in IBMtape 4.1.5.2 or later) is installed on Solaris 10 and runs in the
global zone only.
Synopsis
/opt/IBMtape/ztapelist [-l] [-c] [-z zonename] [-a] [-d] [-h]
The ztapelist command displays all of the IBM tape devices in the global zone
and the tape devices in the non-global zones as shown in the following example.
An option of ztapelist -z zonename is also provided to show all of the assigned
tape devices in a particular zone.
# /opt/IBMtape/ztapelist -l
Running in global zone ...
Inst# Special File Device Serial No TGT/LUN Ucode World Wide NN World Wide PN
------- -------------- ---------- ----------------- ------------ ---------- ----------------- -----------------
193 /dev/rmt/27st 03592E05(e/e) 000001365066 2/0 1A38 500507630019F016 500507630059F016
194 /dev/rmt/28smc 03584L22 0000000T003904E5 2/1 805r N/A N/A
200 /dev/rmt/29st ULT3580-TD4(e) 1300000044 4/0 82F0 500507630019F009 500507630059F009
201 /dev/rmt/30smc 03584L32 0000000T00390401 4/1 805r N/A N/A
206 /dev/rmt/31st ULT3580-TD3 1210003557 7/0 73P5 500507630019F007 500507630059F007
38 /dev/rmt/32smc 03584L32 0000000T00390401 7/1 805r N/A N/A
Note: Due to operating system limitations, this option is supported on Solaris 10,
11.0, and 11.2, and not on 11.1.
The ztapelist command also allows the user to remove all or some assigned tape
devices from the non-global zone, as shown in the following example.
Do you wish to continue to remove the devices from this zone? [y/n]: n
Do you wish to continue to remove the devices from other zone? [y/n]: y
ID NAME STATUS PATH
0 global running /
1 camshaft running /zones/zone1
2 softail running /zones/zone2
Configuration parameters
When devices controlled by IBMtape are used, certain device characteristics, such
as the default block size, can be controlled through the device driver configuration
file. The IBMtape configuration file is named IBMtape.conf. The working copy of
this file is in the /usr/kernel/drv directory.
Note: IBM requires that the Solaris native SCSI tape device driver `st is configured
so that it does not attempt to support SCSI targets that are controlled by IBMtape.
Refer to “Preventing conflicts with other device drivers” on page 108 for
information about multiple driver access to a device.
Attention: Failure to prevent more than one device driver from operating the
same tape drive can cause system panics or data loss on the tape drive.
Configuration settings are applied only at start time, or when IBMtape is unloaded
manually from, then reloaded into, memory. If you change configuration settings in
IBMtape.conf, you can make the changes effective by restarting the system. As an
alternative to restarting, ensure that no IBMtape-owned devices are in use, then
issue the following command.
IBMtape.conf contains one stanza for each SCSI target address/LUN pair that is
owned by IBMtape. The reference IBMtape.conf file that is supplied with the
package contains a stanza for every possible SCSI target and LUN combination
that is supported by IBM tape systems.
The following example shows the stanza for target 0, LUN 0, with IBMtape's
default configuration parameter values. The parameter immediate is disabled,
which means that SCSI commands Write FM, Locate, Load-Unload, Erase, and
Rewind complete before status is returned.
name="IBMtape" class="scsi"
target=0 lun=0
block_size=0
buffering=1
immediate=0
trailer=0
sili=0;
The following example shows the stanza for target 0, LUN 0, with IBMtape's
default configuration parameter values and the rewind immediate mode set On.
This action causes the SCSI rewind command to return control to the application
program before the command completes on the tape drive.
name="IBMtape" class="scsi"
target=0 lun=0
block_size=0
buffering=1
rew_immediate=1
trailer=0
sili=0;
The name variable identifies IBMtape as the device driver, and class identifies the
type of device that is supported as SCSI.
The target and the lun variables determine the target address and LUN of IBM
devices that are controlled by that stanza. On systems with multiple SCSI adapters,
a single target/LUN stanza controls the configuration settings for all devices that
are addressed with that target address and LUN. Thus, two or more supported
IBM devices on the system that have the same target and LUN settings but are
attached to different SCSI buses are all affected by the configuration parameters of
the single stanza with that target address and LUN.
#name="IBMtape" class="scsi"
#target=0 lun=1
#block_size=0
#buffering=1
#immediate=0
#trailer=0
#sili=0;
The remaining five configuration parameters specifically affect the behavior of the
IBM device or devices that are associated with that stanza (target and LUN). All of
these parameters are specific to tape drive device operation only and have no
effect on medium changer device behavior. The default configuration parameters
are adequate for most purposes. However, the values in the configuration file can
be modified to suit the specific requirements of the application or the user.
Modifying a value in the configuration file determines the value of the parameter
at device open time. When the device is open, the value of a parameter can be
altered with an ioctl function call. But the change is effective only while the device
remains open. Working configuration parameters revert to the default values
(established by the configuration file) when the device is closed and reopened.
Refer to the IBM Tape Device Drivers: Programming Reference for information about
changing configuration parameters through program control.
Table 25 lists and describes the set of configuration parameters that are recognized
by the IBMtape device driver.
Table 25. Solaris: configuration parameters recognized by IBMtape
Parameter Values Description
block_size (0=variable This option specifies the device block size that is
length) established with the SCSI Mode Select command
during an open function call. Until this value is
changed, it is the working block size. Variable block
size is established with a value of zero. Any other
positive value represents a fixed block size. The
maximum supported block size varies for each tape
device. Refer to the appropriate hardware reference
manual for information.
Note: IBMtape does not allow odd-byte-count fixed
block reads or writes. For instance, a fixed block size
of 4096 or 4098 is allowed, but 4097 is not. If you
attempt to read or write with an odd-byte-count fixed
block size, the read or write returns -1, with errno set
to 22, invalid argument. If you must read or write
odd-byte-count blocks, set block size to 0 (variable
block size), then transfer one block’s worth of data per
read or write.
The dynamic runtime attributes setting is retained even if the system is rebooted.
Follow the steps to enable or disable the Dynamic Runtime Attributes parameter.
1. To enable the support on all currently configured devices, add the entry
Dynamic_Runtime_Attribute =1 at the beginning of the IBMtape.conf file.
2. Stop the TMD (tape monitor daemon) running on the system and unload the
IBMtape driver module from the current kernel.
# /opt/IBMtape/tmd -s
# /usr/sbin/rem_drv IBMtape
3. Reload the IBMtape driver module in the kernel and start the daemon.
Removing IBMtape
All active processes that use IBM devices that are supported by the IBM SCSI Tape
and Medium Changer Device Driver for Solaris must be stopped for the removal
procedure to complete successfully.
Use the pkgrm command to remove the IBMtape package from the system.
% /usr/sbin/pkgrm IBMtape
Note:
a. It is possible to reinitialize the IBMtape device driver without restarting the
system. This procedure is done by first unloading the device driver, then
reloading the device driver into kernel memory.
b. For the version of IBMtape.4.0.9.2 and later, the TMD daemon must be
stopped. Run the /opt/IBMtape/tmd -s command to unload the IBMtape
driver from the kernel. Running the /opt/IBMtape/tmd command restarts the
daemon afterward to reload the device driver.
The commands to unload the device driver are
% /opt/IBMtape/tmd -s for IBMtape.4.0.9.2 and later
% /usr/sbin/rem_drv IBMtape
The commands to reload the device driver are
% /usr/sbin/add_drv -m ’* 0666 bin bin’ IBMtape
% /opt/IBMtape/tmd for IBMtape.4.0.9.2 and later
Note: It is suggested that the host system and all devices that are attached to
the SCSI bus be powered Off before devices are added or removed from the
SCSI bus. Hot plugging SCSI devices can cause hardware damage and
disruption of reliable system operation
# tapelist -t
hba_index hba_inst hba_driver reg_count usage_count HBA Path
--------- -------- ----------- ----------- ----------- --------------------------–
0 0 qla2300 4 1 /devices/pci@4,2000/fibre-channel@1
1 2 lpfc 4 2 /devices/pci@6,2000/pci@1/fibre-channel@4
2 3 lpfc 1 0 /devices/pci@6,2000/pci@1/fibre-channel@5
A new feature is added in tapelist to display the drive information in the library
that is running /opt/IBMtape/tapelist -L.
# tapelist -L
Addr Inst# Special File Device Serial No TGT/LUN Ucode World Wide NN World Wide PN
----- ----- ------------- ------------- --–-------------- ------- ----- ------------–-- ------------–--
Library (/dev/rmt/5smc) Info:
2894 /dev/rmt/5smc 03584L22 0000000T003904E5 3/1 806c N/A N/A
274 2893 /dev/rmt/13st 03592E05(e/e) 000001365066 3/0 1D10 500507630019F016 500507630059F016
276 2914 /dev/rmt/14st 03592E06(e/e) 000001326803 14/0 2444 500507630019F019 500507630059F019
The following is a definition of the fields and headers that appear in the previous
screens.
Inst # The instance number of the particular device.
Special File The device special file used to access this device.
Device A string indicating the device model and encryption information
(e/e: encryption capable/encryption enable).
Serial No: The serial number of the device.
TGT/LUN The SCSI target and LUN of the device.
Ucode level The current microcode (firmware) loaded on the device.
World Wide NN A number indicating Fibre Channel World Wide Node Name of the device.
World Wide PN A number indicating Fibre Channel World Wide Port Name of the device.
Dev Phy Path A string indicating the device path in the device tree.
Path Type A primary or alternate path used for failover.
hba_index The index number of the particular HBA in the HBA list.
hba_inst The instance number of the particular HBA assigned by the
Solaris system.
hba_driver The HBA driver name with IBM tape drive attachment.
reg_count The number of IBM tape drives attached on the HBA.
usage_count The number of IBM tape drives currently using the HBA.
HBA Path A string indicating the HBA device path in the device tree.
Addr The element address where the drive is located in the library.
e/e The first and second instances of "e" stand for encryption
capable and encryption enable.
Running tapelist without any options displays the device information line by line
for all of the configured devices.
Special files
After the IBMtape driver is installed, a set of special files is available for
completing input/output (I/O) operations to each supported device. The device
special file names that are created by the IBMtape device driver are similar to the
SCSI tape special files used on Solaris systems.
Each tape instance has a set of minor numbers that provides access to the same
physical device. But, each minor number provides a different function or behavior
for the tape subsystem. These minor numbers are accessed through variations of
the special file name for that device. The special files are created in the /dev/rmt
directory. These special files are symbolic links to files created within the /devices
subdirectory hierarchy.
Issuing the ls -la /dev/rmt command gives useful information about these device
special files. The following example shows entries that are returned by this
command for a single IBM tape subsystem. This listing is system-dependent, so
entries vary slightly in format, depending on the operating system and SCSI
adapter support. Entries might be included for other devices that are not
supported by the IBMtape device driver.
lrwxrwxrwx root other 79 Aug 26 18:54 0smc ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:smc
lrwxrwxrwx root other 78 Aug 26 18:54 0st ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:st
lrwxrwxrwx root other 79 Aug 26 18:54 0stb ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:stb
lrwxrwxrwx root other 80 Aug 26 18:54 0stbn ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:stbn
lrwxrwxrwx root other 79 Aug 26 18:54 0stc ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:stc
lrwxrwxrwx root other 80 Aug 26 18:54 0stcb ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:stcb
lrwxrwxrwx root other 81 Aug 26 18:54 0stcbn ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:stcbn
lrwxrwxrwx root other 80 Aug 26 18:54 0stcn ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:stcn
lrwxrwxrwx root other 79 Aug 26 18:54 0stn ->
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,
10000/IBMtape@2,0:stn
Device behaviors
Certain device behaviors are determined by which special file in the set is opened
for device access. The smc special file controls only the medium changer portion of
the device and accepts only medium changer operations by way of the ioctl entry
point. The smc special file does not support the read and write entry points. Only
one st type special file for a particular device can be opened at any one time. The
smc special file can be opened concurrently with any one of the st special files.
The IBMtape device driver decides which types of special files to create during
installation, which is based on the IBM device type that is configured. For the IBM
3490E Magnetic Tape Subsystem, only the eight st type special files are created. For
other IBM tape drives, all nine special files that are shown previously are created.
For IBM tape libraries and autoloaders, only a single smc special file is created.
With the information from the previous command, issuing the ls -la
/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000 command
presents further information about the same special files, as shown in the following
example. Again, the actual path information that is specified in the command
varies from system to system.
crw-rw-rw- 1 bin bin 109,1696 Aug 26 18:54 IBMtape@2,0:smc
crw-rw-rw- 1 bin bin 109,1664 Aug 26 18:56 IBMtape@2,0:st
crw-rw-rw- 1 bin bin 109,1728 Aug 26 18:54 IBMtape@2,0:stb
crw-rw-rw- 1 bin bin 109,1732 Aug 26 18:54 IBMtape@2,0:stbn
crw-rw-rw- 1 bin bin 109,1688 Aug 26 18:54 IBMtape@2,0:stc
crw-rw-rw- 1 bin bin 109,1752 Aug 26 18:54 IBMtape@2,0:stcb
crw-rw-rw- 1 bin bin 109,1756 Aug 26 18:54 IBMtape@2,0:stcbn
crw-rw-rw- 1 bin bin 109,1692 Aug 26 18:54 IBMtape@2,0:stcn
crw-rw-rw- 1 bin bin 109,1668 Aug 26 18:54 IBMtape@2,0:stn
These entries show the major and minor numbers that are associated with each
special file. Here, the major number is 109 and identifies to the system that the
IBMtape device driver is in support of these special files. Major numbers are
assigned by the system at the time the driver is installed and vary from system to
system. The nine different minor numbers are specific to the special file names.
They are used by the device driver to determine which special file was used to
access the device and control the device behavior accordingly. For example, the
minor number 1696 indicates to the driver that the device was opened by way of
the smc special file. For information on device special files and major and minor
numbers, consult the Solaris mtio man pages.
However, the logical names of devices can be changed because of the swapping of
connecting cables, HBA mapping changes, tape device driver updates, or other
reasons.
# tapelist -l
Inst# Special File Device Serial No TGT/LUN Device Physical Path
------ -------------- ------------- ------------ -------- -------------------------------------
454 /dev/rmt/2st ULT3580-TD3 1210003557 3/0 /devices/pci@6,2000/pci@1/fibre-channel@5/IBMtape@3,0
582 /dev/rmt/8st ULT3580-TD3 1210003557 3/0 /devices/pci@1f,2000/pci@1/fibre-channel@5/IBMtape@3,0
The tape drive is mapped at target 3, LUN 0 on HBA 1 and target 24, LUN 0
on HBA 2 after device persistent binding.
# tapelist -l
Inst# Special File Device Serial No TGT/LUN Device Physical Path
------ --------------- ----------- --------- ---------- ----------------------------------------
454 /dev/rmt/4st ULT3580-TD3 1210003557 3/0 /devices/pci@6,2000/pci@1/fibre-channel@5/IBMtape@3,0
1136 /dev/rmt/7st ULT3580-TD3 1210003557 24/0 /devices/pci@1f,2000/pci@1/fibre-channel@5/IBMtape@18,0
Note:
1) A tab is entered between addr=3,0; and rmt/10\M0.
2) The 0 in the entry is the zero in M0.
3) To avoid conflicts with the current device special files assigned by the
system automatically, be sure to assign a higher number for the
persistent name.
4) The address is w500507630059f007,0 for the tape drive on the Oracle
HBA with the path of /devices/pci@1,0/pci1022,7450@1/
pci1077,141@1/fp@0,0/tape@w500507630059f007,0.
.
b. Add the entry into the /etc/devlink.tab system file.
# tapelist -l
Inst# Special File Device Serial No TGT/LUN Device Physical Path
------ ------------- ------------ ------------- ---------- -------------------------
454 /dev/rmt/10st ULT3580-TD3 1210003557 3/0 /devices/pci@6,2000/pci@1/fibre-channel@5/IBMtape@3,0
1136 /dev/rmt/11st ULT3580-TD3 1210003557 24/0 /devices/pci@1f,2000/pci@1/fibre-channel@5/IBMtape@18,0
The primary and alternative path information can be obtained in the field of "Path
Type" running the /opt/IBMtape/tapelist command output and is similar to the
example in Table 27 on page 136.
#tapelist -1
Inst# Special File Device Serial No TGT/LUN Ucode WWNN WWPN Device Physical Path Path Type
-------------------------------------------------------------------------------------------------------------
686 /dev/rmt/12smc 03584L32 0000000T0039 1/1 402j N/A N/A /devices/pci@If,2000/QLGC,qla@1/IBMtape@1,1 Primary
688 /dev/rmt/14smc 03584L32 0000000T0039 2/1 402j N/A N/A /devices/pci@If,2000/QLGC,qla@1/IBMtape@2,1 Alt_path_1
694 /dev/rmt/26smc 03584L32 0000000T0039 5/1 402j N/A N/A /devices/pci@If,2000/QLGC,qla@1/IBMtape@5,1 Alt_path_2
Note: Display the primary and alternative path configuration for any device by
using tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
Note: Display the primary and alternative path configuration for any device by
using tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
Data Path failover and load balancing support for tape drives
Note: The tape drive failover feature code must be installed before the DPF for
IBM Ultrium tape drive is enabled in the Solaris IBMtape device driver. Refer to
“Automatic failover” on page 5 to determine which feature code is required for
your machine type.
Note:
a. The parameter dpf_keys is in the format “key1, key2, key3, ...... ”. Each key
is 16 characters long with a comma "," and a space " ". The IBMtape driver
supports up to 36 dpf keys.
b. DPF keys do not need to be added in IBMtape.conf if you are running the
latest drive code on Ultrium 3 and Ultrium 4 drives.
4. Stop the TMD (tape monitor daemon) running on the system and unload the
IBMtape driver module from the current kernel.
# /opt/IBMtape/tmd -s
# /usr/sbin/rem_drv IBMtape
5. Reload the IBMtape driver module in the kernel and start the daemon.
# /usr/sbin/add_drv -m ’ 0666 bin bin’ IBMtape
# /opt/IBMtape/tmd
This action deconfigures all devices to add the parameter dpf_support=0 in the
IBMtape.conf file, and reboot the system or deconfigure and reconfigure all
devices. For example,
1. To disable the support globally on all currently configured devices, add the
entry dpf_support=1 at the beginning of the IBMtape.conf file.
# dpf_support=0;
2. Stop the TMD (tape monitor daemon) from running on the system and unload
the IBMtape driver module from the current kernel.
# /opt/IBMtape/tmd -s
# /usr/sbin/rem_drv IBMtape
3. Reload the IBMtape driver module in the kernel and start the daemon.
# /usr/sbin/add_drv -m ’ 0666 bin bin’ IBMtape
# /opt/IBMtape/tmd
For example, if 0st (port 0 of 3592) is configured first, then 5st (port 1), 18st (port
1), and 21st (port 0) to the two HBAs through a switch (here, WWPN
5005076302400127 from port 0 and 5005076302800127 from port 1), the
/opt/IBMtape/tapelist command output is similar to the example in Table 28.
Table 28. Example of Data Path failover support command output
#tapelist -1
Inst# Special File Device Serial No TGT/LUN Ucode WWNN WWPN
Device Physical Path Path Type
--------------------------------------------------------------------------------------------------
685 /dev/rmt/0st 03592J1A 000001300168 1/0 04CE 5005076302000127 5005076302400127
/devices/pci@1f,2000/QLGC,qla@1/IBMtape@1,0 Primary
697 /dev/rmt/5st 03592J1A 000001300168 7/0 04CE 5005076302000127 5005076302800127
/devices/pci@1f,2000/QLGC,qla@1/IBMtape@7,0 Alt_path_1
666 /dev/rmt/18st 03592J1A 000001300168 1/0 04CE 5005076302000127 5005076302800127
/devices/pci@1f,4000/JNI,FCR@2/IBMtape@1,0 Alt_path_2
670 /dev/rmt/21st 03592J1A 000001300168 3/0 04CE 5005076302000127 5005076302400127
/devices/pci@1f,4000/JNI,FCR@2/IBMtape@3,0 Alt_path_3
Note: Display the primary and alternative path configuration for any device by
using tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
To enable a path from a disabled state, you can run the following steps.
1. Add the parameter of dpf_support and turn it off in the path entry in
IBMtape.conf file. For example,
name="IBMtape" class="scsi" target=3 lun=0;
2. Stop the TMD (tape monitor daemon) from running on the system and unload
the IBMtape driver module from the current kernel.
# /opt/IBMtape/tmd -s
# /usr/sbin/rem_drv IBMtape
3. Reload the IBMtape driver module in the kernel and start the daemon.
# /usr/sbin/add_drv -m ' 0666 bin bin' IBMtape
# /opt/IBMtape/tmd
System-managed encryption
The sys_encryption_write parameter controls if the device driver can set the tape
drive to encryption enabled for write commands. When set to OFF, the tape drive
uses encryption for read operations; write operations do not use encryption. When
set to ON, the tape drive uses encryption for both read/write operations. When set
to CUSTOM, the device driver does not modify current tape drive setting. The
custom setting is intended for applications by using system-managed encryption to
control write encryption without device driver intervention. The parameter is set to
“CUSTOM” by default.
This test is a tape diagnostic and utility function. Refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 217.
Functional verification
If you wish to verify that the installation of the IBM SCSI Tape and Medium
Changer Device Driver for Solaris package was successful, follow these steps.
1. Enter this command to verify that installation was successful.
/usr/bin/pkginfo IBMtape
The following information must be displayed.
system IBMtape IBM SCSI Tape & Medium Changer Device Driver x.x.x.x
where x.x.x.x is the version of the device driver.
2. To verify that device driver support for a specific IBM tape system that is
attached to the system is functioning correctly, enter the following command.
/opt/IBMtape/tapelist -f /dev/rmt/nst
substituting for n the number that is associated with the device special file
assigned to the IBM tape system that you want to check. Listing the contents of
the /dev/rmt directory (by using the ls command) can be helpful in
determining the correct special file name. For medium changer devices, the
special file name /dev/rmt/nsmc must be used.
The following information is displayed.
IBM Tape Device Information :
Instance : 202
Special File : /dev/rmt/13st
Device : ULT3580-TD5(fh)
Serial Number : 1013000306
TGT/LUN : 5/0
Ucode : z1B8
World Wide NN : 500507630019F00B
World Wide PN : 500507630059F00B
Dev Phy Path : /devices/pci@6,2000/fibre-channel@1/IBMtape@5,0
Path Type : N/A
Path Type : N/A
3. To verify that the IBMtape device driver is loaded in kernel memory, enter the
following command.
/usr/sbin/modinfo | /usr/bin/grep IBMtape
The following information is displayed.
165 f5f10000 15c0s 109 1 IBMtape (IBM SCSI Tape/Medium Changer DD)
The first five fields that are shown probably do not match your specific output.
The fields indicate the ID, load address, size, major number, and revision for the
IBMtape device driver and vary from machine to machine
Installation problems
If you are experiencing problems with installation of the IBM SCSI Tape and
Medium Changer Device Driver for Solaris package, the following information
might help. If you cannot solve the problems after the following is checked, contact
the appropriate IBM service representative.
v If you receive the following message during installation,
drvconfig: System call ’modctl_modconfig’ failed:
No such device or address.
Warning: Driver (IBMtape) configuration failed.
System could not install driver.
it indicates that the IBMtape device driver was not loaded because it did not
detect the presence of any supported IBM devices on the SCSI bus. Verify that
SCSI adapter device driver support is installed and configured correctly. Verify
that the IBM tape subsystem is connected properly to the SCSI bus, which is
powered On, and online. It is not necessary for the tape drive to have a
cartridge that is loaded to be recognized by the IBMtape device driver.
v If you cannot open an IBM device, verify that you are using the correct special
file. The IBM tape special files are of the form *st* in the /dev/rmt directory. The
IBM medium changer special files are of the form *smc in the /dev/rmt
directory. Ensure that the Solaris native tape device driver (st) is not contending
for the same IBM device. Consult the st.conf file in the /kernel/drv directory
and comment out conflicting stanzas.
The following options can be used to configure the tape monitor daemon, running
it on the command line. Most options can also be specified in the /etc/tmd.conf
configuration file. However, the command line options override any configuration
file options.
-s Stop any currently running instance of the tape monitor daemon.
-r Restart the tape monitor daemon and reload all configuration settings.
-d Turn on drive error diagnostic retrieval and storage.
This option is enabled by default.
-D Turn off drive error diagnostic retrieval and storage.
-p <directory> Specify an alternate directory for the storage of
drive diagnostic information. Default directory is /var/opt/IBMtape
-l <filename> Specify a file for writing daemon related log messages.
By default, the tmd only writes status information to the syslog file of
/var/adm/messages.
-y Turns off writing log messages to syslog.
-z Turn off compression. By default, the tmd will use a form of file compression
to reduce the size of stored diagnostic information.
Tracing facility
IBMtape incorporates a tracing facility that is useful for completing problem
determination. The tracing facility logs diagnostic information to
/var/adm/messages based on the control variable IBM_trace. Refer to “Setting the
IBM_trace level for static tracing” on page 145 for instructions on how to set the
trace value.
IBM_trace values range from 0-13 and result in posted messages as shown in
Table 29. Postings are cumulative, so trace level 3 also posts items for levels 2, 1,
and 0. A trace value of 2 or 3 is suitable for most normal production environments,
with little or no degradation of throughput. IBM_trace values of 4 and higher
increasingly degrade performance and generally is used only when directed by
IBM support personnel.
Table 29. Solaris: tracing facility
Trace level Items traced
0 Severe error conditions only. For installations with small /var file systems,
this setting can prevent filling the file system unexpectedly. However, this
setting might be at the cost of not recording messages that are related to
serious device or system environment errors.
1 Device sense data. Sense data can help in diagnosing the source of
unexpected error conditions.
3 Device opens and closes,
Decoded SCSI command, sense key, ASC and ASCQ for sense data.
4–13 Increasingly verbose tracing information. These tracing levels are useful only
to IBMtape developers.
Note: IBMtape earlier than Version 4.0.2.7 had only IBM_trace values 0–4. Message content
and selection differed significantly from current IBMtape versions.
By default, system error messages, including IBMtape trace messages, are placed
in /var/adm/messages. If your installation modified /etc/syslog.conf to redirect
system error messages, IBMtape tracing is handled as other kernel messages. Refer
to the syslog.conf man page and the comments in syslog.conf for information
about the system logging operation. Changes made to syslog.conf take effect after
the next system restart.
The following shows trace level 2 output, with system date and time stamps
removed. Device instance 390 is opened on the first line. The device minor number
12450 is decoded and shows that the SCSI medium changer (smc) special file was
opened.
Note: Solaris, rather than printing multiple 16-byte lines of hexadecimal zeros,
prints only the first such line, followed by a repeat count.
IBMtape(390) _open: 374 Inst 390, Minor 12450 (smc), Flags 0x5,
TL 2/0/0, 4.0.2.8
IBMtape(390) check_sense: cmd 0xa5(move_medium), key/asc/ascq 0x5/3b/e,
defer 0, retry 0, rc 22
IBMtape(390) 03590B11 SENSE DATA:
IBMtape(390) 70 0 5 0 0 0 0 58 0 0 0 0 3b e ff 2
IBMtape(390) 0 20 1 40 a 9 1 0 0 0 0 0 0 0 a5 0
IBMtape(390) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
last message repeated 1 time
IBMtape(390) 0 0 0 0 0 0 0 0 36 33 39 20 20 20 20 0
IBMtape(390) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
IBMtape(390) _close: Inst 390, Minor 12450 (smc), Flags 0x5, exit(0)
In the next example, the device open line shows that a tape drive (drv) device
special file was opened. The sense data for device instance 292 was generated
during a space operation. The Sense Key/ASC/ASCQ shows that a filemark was
encountered during the space.
IBMtape(292) _open: 554 Inst 292, Minor 9412 (drv), Flags 0x5,
TL 2/0/0, 4.0.2.8
IBMtape(292) check_sense: cmd 0x11(space), key/asc/ascq 0x0/0/1,
defer 0, retry 0, rc 5
IBMtape(292) 03570B02 SENSE DATA:
IBMtape(292) f0 0 80 0 0 0 1 48 0 0 0 0 0 1 ff a
IBMtape(292) c4 b1 0 20 0 5 1 91 0 34 0 0 0 0 11 0
IBMtape(292) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 6
IBMtape(292) 6f 28 0 ad 73 32 0 0 0 0 0 0 0 0 0 0
IBMtape(292) 0 0 0 0 0 0 20 0 31 42 41 20 20 20 20 0
IBMtape(292) _close: Inst 292, Minor 9412 (drv), Flags 0x5, exit(0)
Finally, the sense data for device instance 230, a tape drive, occurred during a test
unit ready and indicates that no tape is loaded in the drive.
IBMtape(230) _open: 728 Inst 230, Minor 7366 (drv), Flags 0x5,
TL 2/0/0, 4.0.2.8
IBMtape(230) check_sense: cmd 0x0(test_unit_ready),
key/asc/ascq 0x2/3a/0, defer 0, retry 0, rc 5
IBMtape(230) 03570B02 SENSE DATA:
IBMtape(230) 70 0 2 0 0 0 0 48 0 0 0 0 3a 0 ff 2
IBMtape(230) c4 8 0 30 0 6 1 40 0 0 0 0 0 0 0 0
IBMtape(230) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
last message repeated 1 time
IBMtape(230) 0 0 0 0 0 0 0 0 31 42 41 20 20 20 20 0
IBMtape(230) _close: Inst 230, Minor 7366 (drv), Flags 0x5, exit(0)
You can match an instance number with its corresponding device special file in
two steps.
1. Find the instance number in /etc/path_to_inst.
$ grep 292 /etc/path_to_inst
"/pci@6,4000/scsi@2,1/IBMtape@2,0" 292 "IBMtape"
2. List long the contents of /dev/rmt and search for the path name you found in
the previous step.
In this example, /dev/rmt/8st, /dev/rmt/8stb, and so on, are symbolic links to the
device special files that are associated with device instance 292.
The default value for IBM_trace is zero (0). You can define another IBM_trace value
by placing an entry in /etc/system so that IBM_trace is set at each restart. For
example, this entry in /etc/system sets IBM_trace to 2 at each restart.
set IBMtape:IBM_trace = 2
You can also set or modify the IBM_trace value manually in an adb session.
Because the driver must already be loaded and initialized before this method is
used, the trace value that is set is active only during driver operation.
In this sample session, ksh> is a shell prompt, and adb> is the adb session prompt.
Commands that you enter are in boldface. Explanatory comments follow number
signs (#) or exclamation and number sign pairs (!#). Text lines without a prefix are
adb session responses to commands.
#
# Start adb session and set session prompt.
ksh> adb -P "adb> " -k -w /dev/ksyms /dev/mem
physmem 7c5e
!#
To facilitate capture of data, the script places information in a file that is called
diags.out in the directory where the script is. Send the output file to the location
identified by your IBM service representative.
iostat command
IBMtape driver supports the iostat system command, which reports I/O statistics
for the supported tape drives in IBMtape.4.1.2.7 and later versions. Refer to man
(1M) iostat for the command usage.
| Note: To disable reservation conflict logging, add the entry log_reserve = 0 at the
| beginning of IBMtape.conf, then reload the Tape Monitor Daemon and the driver.
Purpose
The Windows tape and medium changer device driver is designed to take
advantage of the features that are provided by the IBM tape drives and medium
changer devices. The goal is to give applications access to the functions required
for basic tape operations (such as backup and restore) and medium changer
operations (such as mount and unmount the cartridges), and to the advanced
functions needed by full tape management systems. Whenever possible, the driver
is designed to take advantage of the device features transparent to the application
Data flow
The software that is described here covers the Windows device driver and the
interface between the application and the tape device.
a2500268
Driver
Product requirements
Hardware requirements
Refer to the “Hardware requirements” on page 1 for the latest hardware that is
supported by the IBM tape device driver.
Software requirements
| Note: Limited support for customers who have Microsoft Windows Server 2008
| extended support from Microsoft only.
The recommended procedure for installing a new version of the device driver is to
uninstall the previous version (see “Uninstalling the device drivers” on page 153).
Installation overview
Installation procedures
a2500267
Note:
a. More installation features are available through the command-line interface
(CLI), which include
v Installing only the tape or medium changer device drivers (-t or -c)
v Running in debug mode, which creates the file debug.txt in the driver
package directory (-d)
v Running in silent mode, which suppresses messages that require user
intervention, but only with Microsoft-certified IBM drivers (-s)
v Disabling the Microsoft RSM service (-r), available in driver packages
v6.1.8.6 and later
Note: All drivers that are released by IBM went through a complete test to
ensure that they are stable and conform to specified requirements.
a250215
7. To verify that the tape and medium changer devices and drivers are installed
correctly, follow the instructions in Appendix B, “Verifying correct attachment
of your devices,” on page 331.
If you must remove a device, or if you are altering the hardware configuration,
you must uninstall or disable the device first.
1. Right-click My Computer, select Manage to open the Computer Management
Console, and click Device Manager.
2. Right-click the device that you want to uninstall and select Uninstall .... If you
want to disable the device without uninstalling it, you can select Disable.
Note: This removal procedure removes the device from the device tree, but it does
not uninstall the device driver files from your hard disk.
To uninstall the device drivers from the system, which includes deleting the system
files and deallocating other system resources, complete the following steps.
| 1. Quiesce all activity on the tape and medium changer.
2. Double-click uninst.exe in the driver package.
Note: This action removes all the files in the system directories that were
created during the installation of the device driver. It does not delete the
compressed file or the files that were extracted from the compressed file. If you
| want to remove these files, you must delete them manually. For v.6.2.5.3 and
| later, it is not required to manually remove the devices at the Device Manager.
3. Restart the system.
Configuring limitations
The driver limitation for the supported number of tape devices is 1024. Every
installed device uses a certain amount of resources. The user must also consider
other resources, such as physical memory and virtual space on the system before
you attempt to reach the limits. Also, be aware of Microsoft limitations. One
known article is http://support.microsoft.com/kb/310072 (ID: 310072). Be aware of
any Windows specific version limitations.
| HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtpbs2k12
Alternately, you can use the Windows Device Manager to examine the device
number to determine that persistent naming is enabled on your host. Persistent
names contain tape device numbers that are based at 4801101 (which is the decimal
equivalent of hexadecimal 0x49424D and ASCII "IBM").
If two physical paths exist to a drive and different Windows device names are
required (which happens, for example, when two different HBAs are connected to
the drive and Data Path failover is disabled), the first discovered path claims the
persistent device name. Any subsequent paths that connect to the same device
receive names according to the order in which they are discovered by the Windows
Device Manager.
Note: Persistent naming is not set by default. For disabling it, set the
PersistentNaming value to 0 and restart the system.
Note: Show the primary and alternative path configuration for any device with
tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 217.
| [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ibmcg2k12.
For latest LTO generation 3 code and later LTO generation tape drives, a license
key feature for the library hardware is required.
Note: For LTO generation 3 or lower, or for tape drives that require a data path
license key on the host side to enable DPF, the device driver looks for a file that is
called %system_root%:\IBM_DPF.txt for the key. %system_root% is the drive letter
where Windows is installed, typically C (for example, C:\IBM_DPF.txt). The file
contains the key on a single line, with no spaces and no other text on the line. If
multiple keys are required, place each key in the file on its own line. The driver
looks for this file at initialization. If the file contains a valid DPF license key, the
DPF feature is enabled and any eligible devices have multi-path support.
Note: Show the primary and alternative path configuration for any device with the
tape diagnostic and utility functions. Refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 217.
| [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ibmtp2k12
This line indicates that DPF is disabled in the driver. This setting takes effect only
after your system is rebooted.
If you enabled Persistent Reserve on DPF disabled, look for a line like
| [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ibmtp2k12
System-managed encryption
Note: Leading zeros in the serial number must be excluded. For example, if the
serial number of the encryption-capable tape drive were 0123456789, the user
creates the following registry key:
| HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtp2k12
Under this key, the user creates DWORD values that are called
sys_encryption_proxy or sys_encryption_write, and assigns them values that
correspond with the wanted behavior.
The device driver SME settings can be set for all drives at once by placing the
sys_encryption_proxy and sys_encryption_write registry options under the device
driver key, found at
| HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtp2k12
When this option is chosen, the settings that are established for all drives are
overridden by the serial-number specific settings described the previous
paragraph.
If no options are specified in the registry, the driver uses the default values for the
parameters.
v The default value for sys_encryption_proxy is 1.
This value causes the device driver to handle encryption key requests, if the
drive is set up for system-managed encryption. This value does not need to be
Changes to the registry require a reboot before the settings are able to be viewed.
However, during new installations of the driver, if the old driver is not uninstalled,
the old settings remain in place and no reboot is required.
Configuration file
The file %system_root%:\IBMEKM.conf is used to store the IP address of the
EKM server and other network-related parameters. The phrase %system_root%
refers to the drive letter where the Windows installation is located, typically C (for
example C:\IBMEKM.conf).
For example, if the Windows installation is installed at c:\, the EKM server is
named ekmtest, the wanted timeout is 10 seconds, and the IP address is 127.0.0.1
at port 4242. Then, create a line in C:\IBMEKM.conf as follows.
ekmtest<tab>10<tab>127.0.0.1:4242
Problem determination
There is a debug version of the device driver that can be used if you encounter
problems. The debug version of the driver issues DbgPrint messages at various
places during device driver execution. To capture these messages, you must start a
debugger or use a tool like Debug View from Sysinternals Suite, available from
http://technet.microsoft.com/sysinternals/.
To restore the non-debug version of the driver, complete the following steps.
1. Quiesce all activity on the tape and medium changer devices.
2. Exit all applications that are using the tape and medium changer devices.
| 3. Uninstall the debug driver version, which can be accomplished by running
| uninst.exe, within the driver's package folder.
| Note: For v.6.2.5.3 and later, there is no need to manually remove the devices
| at Device Manager.
| 4. Restart the system.
| 5. When the system is back, install the non-debug driver version.
Where kkkkkkkk is the actual reserve key and xxxxxxxx is the reserving host initiator
WWPN.
After initially logging the reserving host WWPN, subsequent reservation conflicts
from the same reserving host WWPN are not logged. This action prevents multiple
entries in the error log until the reserving host WWPN is different from the one
initially logged. Or, the device driver reserved the device and then another
reservation conflict occurs.
| The last driver level to include support for Windows 2000 is V6.1.4.8.
| The last driver level to include support for Windows 2003 is V6.2.1.7.
| The last driver level to include support for Windows 2008 is V6.2.5.2.
a2500296
|
| Figure 17. Warning screen
|
| 3. To verify that the tape and medium changer devices and drivers are installed
| correctly, follow the instructions in Appendix B, “Verifying correct attachment
| of your devices,” on page 331.
| Note: This action removes all the files in the system directories that were
| created during the installation of the device driver. It does not delete the
| compressed file or the files that were extracted from the compressed file. If you
| want to remove these files, you must delete them manually.
| 3. Restart the system.
| To install and use the debug version of the device driver, complete the following
| steps after the driver is initially installed.
| 1. Quiesce all activity on the tape and medium changer.
a2500297
|
| Figure 18. \checked folder
|
| 4. Copy the checked version of ibmtpxxyyy.sys or ibmcgxxyyy.sys to
| \winnt\system32\drivers, overwriting the version of the file already there.
| 5. Restart the system.
| 6. Start the debugger to capture the DbgPrint messages.
| 7. Issue the commands to the driver. You can see debug statements that are
| printed to the debugger window from IBMTpBus, IBMCgBus, tape, or mcd. For
| example, you might see IBMTpBus: ENT: tag output. If you do not see
| something similar, then something went wrong on the checked driver
| installation or there is no driver activity.
| To restore the non-debug version of the driver, complete the following steps.
a2500298
|
| Figure 19. \checked folder
|
| 4. Copy the non-debug version of ibmtpxxyyy.sys or ibmcgxxyyy.sys to
| \winnt\system32\drivers, overwriting the version of the file already there.
| 5. Restart the system. When the driver starts and commands are issued to it, the
| driver no longer produces debug output.
The IBM 3494 Library device driver is a device driver providing attachment for the
IBM 3494 Enterprise Automated Tape Library and IBM Virtual Tape Server (VTS)
to a server. The programs that are described in this chapter support the 3494
Enterprise Automated Tape Library on the following operating systems:
v AIX on IBM POWER-based servers
v HP-UX
v Linux
v Solaris
v Microsoft Windows
Note: Check the versions of operating system that is supported by the IBM tape
driver on each platform.
MTLIB program
The mtlib program is a command-line interface used to control the 3494 Enterprise
tape library and is installed, by default, for execution by all users on the system.
This program provides the full interface (except for the MTIOCLEW library system
call) as specified in the IBM Tape Device Drivers: Programming Reference, GA32-0566.
Refer to “MTEVENT program” on page 175.
The mtlib program provides an interface to the physical tape drives and volumes
within a 3494 tape library and also to the virtual tape drives and volumes within
an attached IBM Virtual Tape Server (VTS).
To issue commands to the physical tape drives and volumes, specify a device
special file name, such as /dev/lmcp0 or the logical name of the library, such as
libmgrc7.
To issue commands to the virtual tape drives and volumes in an attached VTS
library, specify a device special file name or the logical name of the library with
the name of the logical VTS library that is appended with a slashv(/). For example,
to issue commands to the first attached VTS library, use /dev/lmcp0/vts1 or
libmgrc7/vts1. The attached VTS libraries are named logically vts1, vts2, and so on.
They correspond to the order in which they were configured in the tape library.
The -D flag, with the -E flags, can be used to display the attached VTS devices and
the number of the VTS library.
system token...............roadster
category 0101 –– name: SCRATCH
category 0102 –– name: WORKING
MTEVENT program
The mtevent program is a command-line interface to the MTIOCLEW command.
Note:
1. The -l flag is required.
2. If the -t flag is not supplied, then no timeout is completed.
Software interface
The Cvobject module provides three subroutines for communicating with the IBM
3494 Enterprise tape library. These subroutines are open_ibmatl, close_ibmatl, and
ioctl_ibmatl. The open_ibmatl and close_ibmatl routines are used to open and
close communication with the library. Similarly, the open and close system calls
are used to open and close communication with a file. The ioctl_ibmatl subroutine
is used to send commands to the Library Manager on the 3494 tape library.
To send commands to the 3494 tape library, one symbolic name must be defined
for use on the library.
Unsolicited notification
There are situations when the Library Manager has a condition to report that is not
related to any I/O operation. In this case, an unsolicited notification is sent to the
device daemon. If a notification is received, then any process that is waiting with
the Library Event Wait call is notified. An example of an unsolicited notification is
the operational state change of the library (from the Auto mode to the Pause
mode). Refer to the IBM Tape Device Drivers: Programming Reference for a list of
unsolicited notifications that are received by the lmcpd.
Volume categories
To facilitate the management of the tape volumes within the 3494 tape library, the
capability to associate the tape volumes into logical groupings is provided. Each
logical grouping is known as a category. For example, an installation can have one
or more scratch categories that are assigned by media type or class of user.
Another potential use is managing volumes for daily, weekly, and monthly
backups or volumes that are owned by a specific user. The lmcpd also allows a
user process to assign a particular category to a tape device in the library. This
process allows all the volumes that are associated with the category to be mounted
as determined by the flags of the command on the specified device.
The X'FFFF' category is available for general programming use. However, any
mount request to this category must apply to a specific volume that is assigned to
the category (and not based on the category alone).
Overview
Existing customer scripts that use the mtlib program and customer or ISV
applications require no or minor changes to use, depending on the 3494 functions
that are used. Customer and ISV applications must be recompiled only with the
new libibm.o object module to use the emulation support. The mtlib 3494 user
command line interface program has the same syntax and output on every
operating system. It also provides a common utility for SCSI Medium Changer
libraries. Current operating system device driver utilities vary by syntax or output.
They require a knowledge of SCSI Medium Changers to use, and require multiple
commands to run a single mtlib command.
Figure 21 and Figure 22 on page 180 show the 3494/SMC data flow between existing
applications and components and the new libsmc extension.
Application
LIBIBM.O 3494
Object LMCPD TCP/IP
Library Manager
Module
LIBSMC
Driver Device Driver Changer
AIX
libsmc_aix.c Atape Device
libsmc.c Driver
3494 API
Emulation Solaris
libsmc_sun.c IBMtape Device
Driver
Linux
libsmc_linux.c IBMtape Device
Driver
Windows
a28t1002
libsmc_win.c IBMtape Device
Driver
For example, SMC libraries on AIX are named smc0, smc1, and so on. To issue an
mtlib query library command on AIX to a 3584 library named smc0,
mtlib -l smc0 -qL
Volume categories
The 3494 library supports the grouping of one or more volumes into categories
that can be assigned by an application and operations that can specify a category
only rather than a specific volume. SCSI Medium Changers do not provide a
similar function. All volumes in an SMC library are category 0000, the NULL
category.
Most applications and scripts do not use the return request id to determine when
the operation completes and uses the no wait option for performance only. For
example, by using the no wait option on a demount operation so the application
can continue while the library is demounting the volume. These applications and
mtlib scripts do not require any changes but do take the same amount of time as
the wait option.
Applications that use the Query Message ID or mtlib -i option to determine when
the return request id operation completes might require changes. One change is
polling for a mount that is issued with the no wait option since any request id is
always unknown on an SMC library because the operation is already complete.
Performance considerations
The performance time of mtlib commands that are issued to a SCSI 3584 library
versus a 3494 vary and some performance times might be higher. The mtlib
commands, such as -qV and -qI that require reading all the slot information from
the library also vary in the amount of time it takes for the command to complete.
The fewer the number of slots that are in the library, the shorter time it takes to
complete the mtlib command and a larger number of slots in the library takes
longer.
The daemon, which is known to AIX specifically as the IBM Library Manager
Control Point Daemon (lmcpd), communicates with tape libraries that are defined
in a configuration file. This file, ibmatl.conf, is placed in the /etc directory when
the software package is installed. Customization of this file is described in
“Defining tape libraries to the daemon” on page 184. A typical environment for the
AIX 3494 Enterprise Library Driver is an RS/6000 or System p (also known as
pSeries) server on a local area network (LAN) with SCSI- or fibre-attached tape
drives that provide backup and restore functions.
Data flow
The software described in this chapter covers the library device driver and the
interface between the application and the library device driver. For information,
refer to Figure 23.
Figure 23. Data flow for AIX 3494 Enterprise Tape Library Driver
Hardware requirements
Software requirements
To obtain the most current service and documentation for this software, refer to
Appendix A, “Accessing documentation and software online,” on page 327
Installation instructions
Use the standard set of AIX methods to install and configure the LMCP devices.
You must have root authority to complete these operations.
Installation procedure
Enter the following command to list the currently installed version of the 3494
Enterprise Library Driver:
lslpp -l atldd.driver
If a tty connection is needed, use a standard 25 pin null modem D-shell RS-232
cable to connect the workstation to the 3494 Enterprise tape library. Place the cable
on the native serial port or on the 8 port or 16 port asynchronous adapter.
If a LAN connection is needed, connect the LAN cable from the Token Ring or
Ethernet adapter card in the workstation to the 3494 tape library.
After the 3494 tape library is connected to the workstation, you must configure the
serial port to which it is connected. Use smit to configure the serial port. Enter the
following command:
smit tty
To operate the 3494 Enterprise tape library successfully through the configured
LMCPs, you must configure all 3490E or 3590 tape drives in the 3494 tape library.
Refer to “Configuring the Library Manager Control Point” on page 185 for
instructions.
After the software is installed and the tape libraries are connected to the system,
the /etc/ibmatl.conf file must be edited to define the tape libraries to the lmcpd.
The format of the file is
Symbolic name Connection type Identifier Alternate LAN Connection
Symbolic name is used to identify each library. The symbolic names must be unique
across all libraries that are defined in the /etc/ibmatl.conf file.
Connection type is used to define the type of connection to the library (either
RS-232 or TCP/IP). For RS-232 connections, this type is the device special file name
of the tty device (for example, /dev/tty0 or /dev/tty1). For TCP/IP connections, this
type is the IP address of the Library Manager. If the library has a dual LAN card
that is installed, the second IP address of the dual LAN card must be entered after
the first IP address.
Note: Ensure that duplicate IP addresses are not used in this file or unpredictable
results can occur.
Identifier is used to specify a name by which the Library Manager identifies the
host machine. This identifier has a maximum of 8 characters. The host name of the
Note: For RS-232 attachments, the alternate LAN connection is not applicable.
Failover for RS-232 connections proceeds over the single serial line.
This stanza defines the libmgrc7 library that is connected by /dev/tty0 to the
workstation. The library uses the mercury identifier for the host.
libmgrc8 9.115.32.21 jupiter
This stanza defines the libmgrc8 library that is connected through TCP/IP to the
workstation. The address of the Library Manager on the 3494 Tape Library is
9.115.32.21. The library uses the jupiter identifier for the host.
libmgrc9 9.115.46.15 telos 9.115.46.17
This stanza defines the libmgrc9 High Availability library that is connected
through TCP/IP to the workstation. The IP addresses of the dual Library Managers
are 9.115.46.15 and 9.115.46.17.
libmgrc7 9.115.32.21 9.115.32.22 mercury
This stanza defines libmgrc7 with a dual LAN card connected through TCP/IP to
the workstation. The first address of the Library Manager on the 3494 Tape Library
is 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercury
identifier for the host.
The following stanza defines the libmgrc7 High Availability library with dual LAN
cards connected through TCP/IP to the workstation. The IP addresses of the first
Library Manager are 9.115.32.21 and 9.115.32.22. The IP addresses of the second
Library Manager are 9.115.26.13 and 9.115.26.14. The library uses the mercury
identifier for the host.
libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14
After the driver is installed, a tape library is connected to the workstation, and the
serial port is configured, you can configure the instances of the LMCP. Complete
the following procedure to define and configure the LMCP:
1. Enter the following command:
smit
The system management interface tool (smit) main menu is displayed (refer to
Table 45 on page 186).
System Management
Devices
Tape Drive
4. Select Add a Tape Drive from the Tape Drive menu (Table 47). The Tape
Drive Type menu is displayed (refer to Table 48).
5. Select the Library Manager control point from the Tape Drive Type menu
(refer to Table 48).
Table 48. SMIT tape drive type menu
The Add an LMCP Logical Device menu is displayed (refer to Table 49).
The Logical Name field for the Library Manager control point is optional. If
the field remains blank, a unique name is assigned automatically. The
assigned name is lmcpn, where: n is a number that indicates the LMCP entry
and starts with zero for the first LMCP defined.
The Library Name field must be one of the library names that are defined in
the /etc/ibmatl.conf file. Refer to “Defining tape libraries to the daemon” on
page 184 for a description of this file.
The Command Timeout in Minutes field is optional and is used to specify
the maximum amount of time an application waits for commands to complete,
including mount and demount commands. The default is to wait forever until
the command completes.
Table 49. Add an LMCP Logical Device menu
[Entry Fields]
Logical Name of LMCP (optional) []
Library Name (F4 to list library names) [libmgrc7] +
Command Timeout in Minutes []
COMMAND STATUS
lmcp0 Defined
Tape Drive
10. Select a defined Library Manager control point to configure from the LMCP
Selection list.
The COMMAND STATUS window opens with the Command: OK status,
and the Library Manager control point is shown as Available (refer to
Table 52).
Table 52. Configure a Defined LMCP COMMAND STATUS window
COMMAND STATUS
lmcp0 Available
11. Cancel the COMMAND STATUS window by pressing F3. The LMCP
Selection window opens again.
12. Continue selecting the Library Manager control points for configuration until
all the devices are configured.
13. Exit from the smit menu.
You completed the configuration of Library Manager control points to the
system.
The lmcpd is loaded during the system initialization. During the initial installation
of the driver, you must load the daemon manually by using the following
command,
cfgmgr
You can access the 3494 Enterprise Tape Library after the command is completed.
To verify that the daemon is loaded correctly, enter the following command,
ps -efa | grep lmcpd
You can see multiple instances of the daemon running (which is typical), but only
one instance has a parent process ID of 1.
In the following examples, replace the letter n with the appropriate number for the
chosen device.
Uninstall procedure
All devices that use the atldd driver must be closed and not in use when atldd is
uninstalled or the uninstall fails.
You can uninstall the atldd by using the smit command menu to uninstall software
and selecting atldd.driver or use the following installp command,
installp -u atldd.driver
Special files
After the driver is installed and a Library Manager control point is configured and
made available for use, access is provided through the special files. These special
files are in the /dev directory. Each instance of an LMCP has exactly one special file
(for example, /dev/lmcp0) associated with it.
Problem determination
A set of tools is provided with the device driver to determine whether it is
functioning correctly. The standard AIX interface is provided for problem
determination.
Error logging
The driver provides logging to the system error log for various errors. View the
error log by using the smit or the errpt command. The error templates follow the
same form as the default AIX error log entries.
The AIX trace facility is supported for the device driver. The trace event is
identified with a hookword. The hookword that is used by the device driver is 426.
The trace can be initiated at any time before an operation on a tape device.
This command starts the trace in the background and collects only the trace events
with the 426 hookword.
This command stops the trace after the tape operations are completed.
This command formats the trace output into a readable form and places it in a file
for viewing. The /etc/lmcp.trcfmt file is installed into /etc during installation. It
provides the formatting statements that are needed by trcrpt.
The following trace facility is available for the lmcp daemon and device driver:
trcatl -[ald]
Arguments:
-a (trace all libraries defined in /etc/ibmatl.conf)
-l <name> (name of library)
-d (delete all log files; requires root authority)
Examples:
trcatl -a >/tmp/trace-out
trcatl -l libmgrc7
Note: In the HP-UX operating system, this daemon is a program that runs
unattended in the background to run a standard service. Some daemons are
triggered automatically to complete their task, others operate periodically.
The Library Manager control point daemon (lmcpd) is provided in the package.
The lmcpd is a process that is always running on the system. It provides direct
communication with the 3494 Enterprise Library Manager. An application links
with the supplied C object module by using the interface that is described in the
IBM Tape Device Drivers: Programming Reference. The subroutines in this module
communicate with the lmcpd to run the various library operations by using
standard UNIX namespace sockets.
The lmcpd communicates with the Library Manager through TCP/IP. The
/etc/ibmatl.conf configuration file is used to define the attachment for each library.
Refer to “Defining the library device to LMCPD” on page 195 for information.
Data flow
The software described in this chapter covers the library driver. The interface
between the application and the library driver is described in the IBM Tape Device
Drivers: Programming Reference. Figure 24 on page 192 illustrates the data flow.
Application
C
Object
Module
TCP/IP Library
LMCPD Manager
a250106
Figure 24. Data flow for HP-UX 3494 Enterprise tape library driver
Product requirements
The following software and hardware are required to use this product.
Hardware requirements
Software requirements
To obtain the most current service and documentation for this software, refer to
Appendix A, “Accessing documentation and software online,” on page 327.
Software compatibility
Installation instructions
This chapter describes how to install, configure, and uninstall the HP-UX
Automated Tape Library Support for the 3494 Enterprise tape library. The IBM tape
library driver for HP-UX is installed by using the standard swinstall process. The
IBM tape library driver for HP-UX is the lmcpd package.
Installation overview
LAN support must exist on the machine before the IBM tape library driver for
HP-UX is installed. Install and configure the LAN support before you proceed with
the installation of the lmcpd package. For information, refer to the HP-UX
documentation appropriate for the LAN support that you are using.
1. Copy the software from the distribution medium to the depot.
2. Check the readme file and verify that your system is configured appropriately
for installing the lmcpd software.
3. Install and configure the software.
The distribution diskette contains a swinstall process that includes the lmcpd
daemon with other associated files and utilities.
Take note of the following facts about the command sequences described in this
section:
v In some of the examples, file names that are given on the command line must be
referenced with an absolute path. Using 'pwd'/filename to reference a file
instead of filename ensures the absolute path.
v All the SD commands (for example, swinstall, swcopy) can be run initially with
the '-p' flag to preview the command. After the preview output is observed,
you can reissue the command without the '-p' flag to run the actual operation.
v The SD commands are moderately complex scripts that usually proceed in
several steps. The steps are typically Selection, Analysis, and Execution. Each
step might produce useful information and error messages. It is a good idea to
observe carefully the results of the installation process as it occurs.
If you run into unexpected results during the installation, check the associated log
file.
Note: If you are updating the lmcpd package, the existing /etc/ibmatl.conf file is
preserved. It is not overwritten. A copy of ibmatl.conf is also installed in the
/opt/lmcpd directory.
Installing the product manually requires two steps, detailed in the following
sections.
1. “Copying the software to the Software Depot”
2. “Installing the product”
If you do not copy the lmcpd software into a depot, you cannot easily uninstall the
software.
When the software is in the depot, the lmcpd software can be installed to the root
file system by using the HP-UX swinstall command.
Use swlist to list the software that is installed on the default root file system as
follows,
# swlist lmcpd
Verify correct installation to the default root file system with the swverify
command,
# swverify lmcpd
You can use a LAN connection (either Ethernet or Token Ring) through a TCP/IP
connection. The connection must be in place before the software is installed to
ensure correct initialization of the daemon. For each 3494 Enterprise tape library
that is connected through TCP/IP, ensure that your machine has access to the
Library Manager on the 3494 Enterprise tape library. Use the ping utility to verify
that you have network connectivity to the Library Manager. Consult your network
administrator if you need help with this task.
After the software is installed and all tape libraries are connected to the system,
the /etc/ibmatl.conf file must be edited to define the library devices to the lmcp
daemon. The format of the file is
Symbolic name Connection type Identifier Alternate LAN Connection
Symbolic name is used to identify each tape library. The symbolic names must be
unique across all libraries that are defined in the ibmatl.conf file.
Connection type defines the type of connection to the library. For TCP/IP
connections, this type is the IP address of the 3494 Enterprise Library Manager. If
the Library has a dual LAN card that is installed, the second IP address of the dual
LAN card must be entered after the first IP address.
Identifier is used to specify a name by which the Library Manager identifies the
host machine. This identifier has a maximum length of 8 characters. The symbolic
network name of the host is usually the best name to use, although any name is
acceptable. This parameter is used only to identify a particular host to the 3494
Library Manager.
This stanza defines the 3494a library that is connected to the host. The address of
the Enterprise Library Manager is 9.115.32.21. The tape library uses jupiter as the
identifier for the host.
This stanza defines the libmgrc9 High Availability library that is connected
through TCP/IP to the workstation. The IP addresses of the dual Library Managers
are 9.115.46.15 and 9.115.46.17.
libmgrc7 9.115.32.21 9.115.32.22 mercury
This stanza defines libmgrc7 with a dual LAN card connected through TCP/IP to
the workstation. The first address of the Library Manager on the 3494 Tape Library
is 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercury
identifier for the host.
The following stanza defines the libmgrc7 High Availability library with dual LAN
cards connected through TCP/IP to the workstation. The IP addresses of the first
Library Manager are 9.115.32.21 and 9.115.32.22. The IP addresses of the second
Library Manager are 9.115.26.13 and 9.115.26.14. The library uses the mercury
identifier for the host.
libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14
You can add or delete entries in /etc/ibmatl.conf at any time. However, changes do
not take effect until the daemon is started again. Use the UNIX kill command
(kill -kill <pid>) to stop the lmcpd process, then enter the /etc/lmcpd command
to start the daemon again.
Ensure that the library activity on all of the libraries is completed before lmcpd is
started again.
Uninstallation procedure
Do not try to uninstall the lmcpd software by deleting the files that make up the
lmcpd file set. It is best to use the swremove command.
Halt all library activity before the uninstallation procedure is started. Kill the
lmcpd daemon if it is running.
To remove the lmcpd software from the root file system, enter
# swremove -p lmcpd
# swremove lmcpd
To determine what versions of the lmcpd software are currently installed on the
default root file system,
# swlist -a state lmcpd
To determine what versions of the lmcpd software are stored in the default depot,
# swlist -d state lmcpd
To view the set of files that are installed with the lmcpd software,
# swlist -l file lmcpd
Problem determination
A set of tools is provided with the software to determine whether the lmcpd is
functioning correctly.
Error logging
The lmcpd uses the syslog facility to log the errors. Errors are logged according to
the /etc/syslog.conf file. The lmcpd uses the daemon facility for logging errors.
Only errors are logged with this facility. For information about using syslog, refer
to your system administration manuals.
Arguments:
-a (trace all libraries defined in /etc/ibmatl.conf)
-l <name> (name of library)
-d (delete all log files; requires root authority)
Examples:
trcatl -a >/tmp/trace-out
trcatl -l libmgrc7
Linux
The software consists of a daemon that communicates directly with the Library
Manager of the 3494 Enterprise Tape Library through Ethernet or Token Ring LAN.
It also provides a utility program that provides a command line interface to the
daemon, and a C object module that can be linked with user applications to
provide a communication interface with the daemon.
Note: In the Linux operating system, this program runs unattended, in the
background, to complete a standard service. Some daemons are triggered
automatically to complete their task; others operate periodically.
A typical environment for the Linux Automated Tape Library Driver is a Linux
workstation that acts as a data server on a network. Tape devices provide backup
or restore and data server functions.
The Library Manager control point daemon (lmcpd) is provided in the package.
The lmcpd is a process that is always running on the system. It provides direct
communication with the Library Manager. An application links with the supplied
C object module by using the interface that is described in the IBM Tape Device
Drivers: Programming Reference. The subroutines in this module communicate with
the lmcpd to run the various library operations with standard UNIX namespace
sockets.
The lmcpd communicates with the Library Manager through TCP/IP. The
/etc/ibmatl.conf configuration file is used to define the attachment for each library.
Refer to “Defining the library device to the lmcpd” on page 200 for information.
Data flow
The software described in this chapter covers the library driver. The interface
between the application and the library driver is described in the IBM Tape Device
Drivers: Programming Reference.Figure 25 illustrates the data flow.
Application
C
Object
Module
TCP/IP Library
LMCPD Manager
a250106
Figure 25. Data flow for Linux 3494 Enterprise tape library driver
Product requirements
The following hardware and software components are required and supported by
IBM.
Software requirements
To obtain the most current service and documentation for this software, refer to
Appendix A, “Accessing documentation and software online,” on page 327.
Installation instructions
The IBM tape library driver for Linux (ibmatl), is supplied in an rpm package. The
following sections describe installation, removal, configuration, and verification
procedures for ibmatl. Refer to any Linux distribution that supports rpm for rpm
command information. You must have root authority to proceed with the
installation of the driver.
In the subsequent pages, you can see file names with xxxx or x.x.x.x in them. The
xxxx or x.x.x.x refers to the version of the driver, which changes as IBM releases
new driver levels. Use the actual driver version numbers as you complete the
procedures.
Install and configure the LAN support before you proceed with the installation of
the ibmatl package. For information, refer to the Linux documentation appropriate
to the LAN support you are using.
On the IBM Linux for IBM S/390 and zSeries systems, documentation files are
installed at
/usr/share/doc/packages/ibmatl/README (readme file)
/usr/share/doc/packages/ibmatl/license (license file)
On Red Hat Linux for Intel PC-based systems, documentation files are installed at
/usr/share/doc/ibmatl-x.x.x.x/README (readme file, where x.x.x.x is the version)
/usr/share/doc/ibmatl-x.x.x.x/license (license file, where .x.x.x.x is the version)
Note: If you are updating the ibmatl package, the existing /etc/ibmatl.conf file is
preserved (it is not overwritten).
Installation procedure
Use a LAN connection (either Ethernet or Token Ring) through TCP/IP. The
connection must be in place before the software is installed to ensure correct
initialization of the daemon. For each 3494 tape library that is connected through
TCP/IP, ensure that your machine has access to the Library Manager on the 3494
tape library. Use the ping utility to verify that you have network connectivity to
the Library Manager. Consult your network administrator if you need help with
this task.
After the software is installed and tape libraries are connected, the /etc/ibmatl.conf
file must be edited to define the library devices to the lmcpd. The format of the
file is
Symbolic name Connection type Identifier Alternate LAN Connection
Symbolic name is used to identify each tape library. The symbolic names must be
unique across all libraries that are defined in the ibmatl.conf file.
Connection type is used to define the type of connection to the library. For TCP/IP
connections, this type is the IP address of the 3494 Library Manager. If the Library
has a dual LAN card that is installed, the second IP address of the dual LAN card
must be entered after the first IP address.
This stanza defines the 3494a library that is connected to the host. The address of
the 3494 Library Manager is 9.115.32.21. The tape library uses jupiter as the
identifier for the host.
libmgrc9 9.115.46.15 telos 9.115.46.17
This stanza defines the libmgrc9 High Availability library that is connected
through TCP/IP to the workstation. The IP addresses of the dual Library Managers
are 9.115.46.15 and 9.115.46.17.
libmgrc7 9.115.32.21 9.115.32.22 mercury
This stanza defines libmgrc7 with a dual LAN card connected through TCP/IP to
the workstation. The first address of the Library Manager on the 3494 Tape Library
is 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercury
identifier for the host.
libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14
This stanza defines the libmgrc7 High Availability library with dual LAN cards
connected through TCP/IP to the workstation. The IP addresses of the first Library
Manager are 9.115.32.21 and 9.115.32.22. The IP addresses of the second Library
Manager are 9.115.26.13 and 9.115.26.14. The library uses the mercury identifier for
the host.
You can add or delete entries in /etc/ibmatl.conf at any time. However, changes do
not take effect until the daemon is started again. Use the UNIX kill command
(kill -kill <pid>) to stop the lmcpd process, and enter the /etc/lmcpd command
to start the daemon again.
Ensure that activity on all libraries is completed before the lmcpd is restarted.
Updating procedure
If your current ibmatl was installed from an rpm package previously, issue the
following command.
rpm -Uvv ibmatl.x.x.x.x.s390.rpm --for IBM Linux on S/390 systems
rpm -Uvv ibmatl.x.x.x.x.i386.rpm --for Red Hat Intel PC based systems
The query function is supported for the ibmatl rpm package only.
The installed rpm package can be queried by running the following commands to
display information that is associated with the package.
To display the states of files in the package, for example, normal, not installed, or
replaced.
>rpm -qs ibmatl
If the IBMtape device driver is installed from the rpm package, issue the following
command,
>rpm -V ibmatl
Starting ibmatl
Uninstallation procedure
Attention: Do not try to uninstall the ibmatl software by removing the files that
make up the ibmatl file set. It is best to use the rpm -e command or the uninstall
script.
Note: Halt all library activity before the uninstall procedure is started.
If more than one level of ibmatl exists on the system, explicitly specify the level to
remove it.
rpm -evv ibmatl-5.0.7.0
Problem determination
A set of tools is provided with the software to determine whether the ibmatl is
functioning correctly.
Error logging
The ibmatl uses the syslog facility to log the errors. Errors are logged according to
the /etc/syslog.conf file. The ibmatl uses the daemon facility for logging errors.
Only errors are logged with this facility. For information about using syslog, refer
to your system administration manuals.
Arguments:
-a (trace all libraries defined in /etc/ibmatl.conf)
-l <name> (name of library)
-d (delete all log files; requires root authority)
Examples:
trcatl -a >/tmp/trace-out
trcatl -l libmgrc7
Solaris
The software consists of a daemon that communicates directly with the Library
Manager of the 3494 tape library through RS-232 or LAN. It also has a utility
program that provides a command line interface to the daemon, and a C object
module that can be linked with user applications to provide a communication
interface with the daemon.
A typical environment for the IBM Oracle Automated Tape Library Driver is an
Oracle workstation that acts as a data server on a network with SCSI tape devices
that provide backup or restore and data server functions.
The Library Manager control point daemon (lmcpd) is provided in the package.
The lmcpd is a process that is always running on the system. It provides direct
communication with the 3494 Library Manager. An application links with the
supplied C object module by using the interface that is described in theIBM Tape
Device Drivers: Programming Reference. The subroutines in this module communicate
with the lmcpd to run the various library operations with standard UNIX
namespace sockets.
The lmcpd communicates with the Library Manager either through a standard 25
pin null modem D-shell RS-232 cable or through TCP/IP. The /etc/ibmatl.conf
configuration file is used to define the type of attachment for each library. Refer to
“Defining the symbolic name to the lmcpd” on page 207 for information.
Data flow
The software described in this chapter covers the library driver. The interface
between the application and the library driver is described in the IBM Tape Device
Drivers: Programming Reference. Figure 26 on page 204 illustrates the data flow.
Application
C
Object TCP/IP
Module
LMCPD Library
Manager
Native
TTY
a250093
Device
Driver
Figure 26. Data flow for Solaris 3494 Enterprise tape library driver
Product requirements
The following software and hardware are supported by this product.
Hardware requirements
Note: For information, refer to Chapter 6, “Solaris Tape and Medium Changer
Device Driver,” on page 107.
v IBM Tape and Medium Changer Device Driver for Solaris
To obtain the most current service and documentation for this software, refer to
Appendix A, “Accessing documentation and software online,” on page 327.
Software compatibility
Installation instructions
The IBM tape library driver for Solaris is installed by using the standard Solaris
package facility. The IBM Tape Library Driver for Solaris is the lmcpd package.
Preinstallation considerations
The LAN or tty support must exist on the machine before the IBM Tape Library
daemon for SunOS is installed. Install and configure the LAN or tty adapter and
the associated LAN or tty adapter device driver before you proceed with the
installation of the lmcpd package. For information, refer to the documentation
appropriate for the LAN or tty adapter and the LAN or tty adapter device driver
that you are using.
Note: If an earlier version of the product is installed on the machine, run the
uninstallation procedure before you enter the following commands. Refer to
“Uninstallation procedure” on page 208 for information.
Note: If you are updating the lmcpd package, the existing /etc/ibmatl.conf file is
preserved. It is not overwritten. A copy of ibmatl.conf is also installed in the
/opt/lmcpd directory.
Use the following commands to install the lmcpd package. Substitute the device
special file name for the installation source device that is appropriate for your
system.
If a previous version is installed on the system, uninstall the previous version first,
then enter the following command,
/usr/sbin/pkgrm lmcpd
To install the package from the directory where the driver is located, enter the
following command,
/usr/sbin/pkgadd -d lmcpd.x.x.x.x
To verify that the installation was successful, enter the following command,
/usr/bin/pkginfo lmcpd
Use one of the following methods to connect the workstation to the 3494 tape
library.
v Use a standard 25 pin null modem D-shell RS-232 cable. Place the cable on the
native serial port or on the eight-port or 16 port asynchronous adapter.
v Use a LAN connection (either Ethernet or Token-Ring) through TCP/IP.
In either case, the connection must be in place before the software is installed to
ensure correct initialization of the daemon.
For each 3494 tape library that is connected with an RS-232 cable, follow the
directions in “Configuring the serial port.” For each 3494 tape library that is
connected through TCP/IP, ensure that your machine has access to the Library
Manager on the Enterprise device. Use the ping utility to verify that you have
network connectivity to the Library Manager. Consult your network administrator
if you need help with this task.
Identify the host name of your workstation to the Enterprise Library Manager.
Follow the instructions in the IBM Enterprise Automated Tape Library Operator Guide,
in the Add LAN Host section.
After the 3494 tape library is connected to the workstation, you must configure the
serial port to which it is connected.
After the software is installed and all tape libraries are connected to the system,
the /etc/ibmatl.conf file must be edited to define the tape libraries to the lmcpd.
The format of the file is
Symbolic name Connection type Identifier Alternate LAN Connection
Symbolic name is used to identify each tape library. The symbolic names must be
unique across all libraries that are defined in the/etc/ibmatl.conf file.
Connection type is used to define the type of connection to the library (either
RS-232 or TCP/IP). For RS-232 connections, this type is the device special file name
of the tty device (for example, /dev/ttya or /dev/tty1). For TCP/IP connections, this
type is the IP address of the Library Manager. If the Library has a dual LAN card
that is installed, the second IP address of the dual LAN card must be entered after
the first IP address.
Identifier is used to specify a name by which the Library Manager identifies the
host machine. This identifier has a maximum length of 8 characters. The host name
of the workstation is usually the best name to use (although it is not necessary).
This parameter is used only to identify a particular host to the 3494 Enterprise
Library Manager.
Note: For RS-232 attachments, the alternate LAN connection is not applicable.
Failover for RS-232 connections proceeds over the single serial line.
This stanza defines the 3494a library that is connected by /dev/ttya to the
workstation. The library uses the mercury identifier for the host.
3494b 9.115.32.21 jupiter
This stanza defines the 3494b library that is connected through TCP/IP to the
workstation. The address of the Library Manager on the Enterprise Tape Library is
9.115.32.21. The library uses the jupiter identifier for the host.
libmgrc9 9.115.46.15 telos 9.115.46.17
This stanza defines the libmgrc9 High Availability library that is connected
through TCP/IP to the workstation. The IP addresses of the dual Library Managers
are 9.115.46.15 and 9.115.46.17.
libmgrc7 9.115.32.21 9.115.32.22 mercury
This stanza defines libmgrc7 with a dual LAN card connected through TCP/IP to
the workstation. The first address of the Library Manager on the 3494 tape library
is 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercury
identifier for the host.
The following stanza defines the libmgrc7 High Availability library with dual LAN
cards connected through TCP/IP to the workstation. The IP addresses of the first
You can add or delete entries in /etc/ibmatl.conf at any time. However, changes do
not take effect until the daemon is started again. Use the UNIX kill command
(kill -kill <pid>) to stop the lmcpd process, then enter the /etc/lmcpd command
to start the daemon again.
Ensure that the library activity on all of the libraries is completed before the lmcpd
is restarted.
Uninstallation procedure
Halt all library activity before the uninstallation procedure is started. Stop the
lmcpd daemon if it is running. Enter the following command to uninstall the
library support from your workstation.
/usr/sbin/pkgrm lmcpd
Problem determination
A set of tools is provided with the software to determine whether the lmcpd is
functioning correctly.
Error logging
The lmcpd uses the syslog facility to log the errors. Errors are logged according to
the /etc/syslog.conf file. The lmcpd uses the daemon facility for logging errors.
Only errors are logged with this facility. For information about using syslog, refer
to your system administration manuals.
Arguments:
-a (trace all libraries defined in /etc/ibmatl.conf)
-l <name> (name of library)
-d (delete all log files; requires root authority)
Examples:
Windows
The software consists of a tape library service that communicates directly with the
Library Manager of the 3494 Enterprise Tape Library through LAN. A utility
program also provides a command prompt interface to the service, and a static
library and DLL that can be used to provide a communication interface with the
service.
The IBM Automated Tape Library service is provided in the installation package.
This service is installed with STARTUP=AUTOMATIC, which means that it is
started when the Microsoft Windows operating system is started. An application
program might access those functions through API calls. The interface is described
in the IBM Tape Device Drivers: Programming Reference. The subroutines in this
module communicate with the Enterprise Library Manager to run the various
library operations.
The service communicates with the Library Manager through TCP/IP. The
c:\winnt\ibmatl.conf configuration file is used to define the type of attachment
for each library. Refer to “Defining the symbolic name to the service” on page 213
for information.
Data flow
The software described in this chapter covers the library driver. The interface
between the application and the library driver is described in the IBM Tape Device
Drivers: Programming Reference.Figure 27 on page 210 illustrates the data flow.
Product requirements
The following hardware and software components are required and supported by
IBM.
Hardware requirements
The following options are required for operation of the Enterprise Library
Manager:
v Token-Ring or Ethernet adapter card in an Intel-compatible workstation that
runs Microsoft Windows and attached to the 3494 Enterprise Tape Library
v LAN cable
Software requirements
Microsoft Windows is required for the library driver: For information, refer to
Chapter 7, “Windows Tape and Medium Changer device driver,” on page 149.
Installation instructions
The IBM tape library service for Microsoft Windows is installed by starting the
installation binary. This binary has the format ibmatl.x.x.x.x.x86.exe for 32-bit
Windows 200x that runs on x86, ibmatl.x.x.x.x.i64.exe for 64-bit Windows 2003 that
runs on IA64, and ibmatl.x.x.x.x.x64.exe for 64-bit Windows Server 2003 and
Windows Server 2008 that runs on AMD64 and EM64T.
Installation procedure
Use the following procedure to install the IBM Automated Tape Library Service or
to upgrade the software level of your service on your workstation.
Follow these steps to run the installation of the service and its associated software:
1. Verify that the prerequisites are satisfied. Refer to “Product requirements” on
page 210.
2. Ensure that the workstation is on the LAN.
3. Log on as Administrator.
4. If the IBM Automated Tape Library Service is installed, ensure that all
programs and services that use the service are stopped. Then, remove it from
the system.
5. Ensure that the IBM Automated Tape Library Service is not running.
v On Windows NT
a. Click Start.
b. Move to Settings, then click Control Panel.
c. Double-click the Services icon.
v On Windows 2000 and 2003
a. Click Start.
b. Move to Settings, then click Control Panel.
c. Double-click the Services icon.
v On Windows 2008
a. Click Start.
b. Double-click the Administrative Tools icon.
c. Double-click the Services icon.
The Services window opens. Scroll through the entries until you find IBM
Automated Tape Library. If you do not find the entry for IBM Automated
Tape Library, the service is not installed; click Close. If there is an entry and
the status is blank, the service is not running; click Close. If the status is
Started, click IBM Automated Tape Library, then click Stop.
v Wait for the service to stop and the Status to be set to blank, then click
Close.
v On 32-bit Windows 200x, wait for the service to stop and the Service status
to be set to Stopped, then close both windows.
v On 64-bit Windows, the service is stopped and removed automatically
during the uninstallation.
6. Obtain ibmatl driver from the IBM storage FTP server in binary.
7. Locate and start ibmatl driver.
Note: When a firewall is enabled on Windows, you must allow the lmcpd
program to access the network. Do not block the network IP port of 3494,
which is used for communication between the 3494 library and lmcpd.
Identify the host name of your workstation to the Enterprise Library Manager.
Follow the instructions in the IBM Enterprise Automated Tape Library Operator Guide,
in the Add LAN Host section.
After the software is installed and the tape libraries are connected to the system,
the c:\winnt\ibmatl.conf file must be edited to define the tape libraries to the
service. The format of the file is
Symbolic name Connection type Identifier Alternate LAN Connection
Symbolic name identifies each tape library. The symbolic names must be unique
across all libraries that are defined in the c:\winnt\ibmatl.conf file.
Connection type is the IP address of the Library Manager. If the Library has a dual
LAN card that is installed, the second IP address of the dual LAN card must be
entered after the first IP address.
Identifier specifies a name by which the Library Manager identifies the host
machine. This identifier has a maximum length of 8 characters. The host name of
the workstation is usually the best name to use (although it is not necessary). This
parameter identifies only a particular host to the Enterprise Library Manager.
The following stanza defines the 3494b library that is connected through TCP/IP to
the workstation. The address of the Library Manager on the 3494 tape library is
9.115.32.21. The library uses the jupiter identifier for the host.
3494b 9.115.32.21 jupiter
The following stanza defines the libmgrc9 High Availability library that is
connected through TCP/IP to the workstation. The IP addresses of the dual
Library Managers are 9.115.46.15 and 9.115.46.17.
libmgrc9 9.115.46.15 telos 9.115.46.17
The following stanza defines libmgrc7 with a dual LAN card connected through
TCP/IP to the workstation. The first address of the Library Manager on the 3494
tape library is 9.115.32.21 and the second address is 9.115.32.22. The library uses
the mercury identifier for the host.
libmgrc7 9.115.32.21 9.115.32.22 mercury
The following stanza defines the libmgrc7 High Availability library with dual LAN
cards connected through TCP/IP to the workstation. The IP addresses of the first
Library Manager are 9.115.32.21 and 9.115.32.22. The IP addresses of the second
Library Manager are 9.115.26.13 and 9.115.26.14. The library uses the mercury
identifier for the host.
libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14
On Windows NT, stop and start the service by using the Services option in the
Control Panel window.
On Windows 200x, stop and start the service by using the Services icon, which is
on the Administrative Tools icon in the Control Panel window.
Ensure that the library activity on all of the libraries is completed before the
service is started again.
Uninstallation procedure
Use the following procedure to remove the IBM Automated Tape Library Service
permanently from your workstation.
Note: If you are upgrading the software level of your service, follow the steps in
“Installation procedure” on page 211.
Follow these steps to uninstall the service and its associated software:
1. Log on as Administrator.
2. Back up the c:\winnt\ibmatl.conf file if you want to keep a copy of this file
because the uninstall procedure erases the file.
3. Ensure that all programs and services that use the IBM Automated Tape
Library Service are stopped.
4. Ensure that the IBM Automated Tape Library Service is not running. Click
Start > Settings > Control Panel.
v Double-click the Services icon.
v On Windows 200x, double-click the Administrative Tools icon, then
double-click the Services icon.
The Services window opens. Scroll through the entries until you find IBM
Automated Tape Library. If the status is blank, the service is not running;
click Close. If the status is Started, click IBM Automated Tape Library, then
click Stop.
v Wait for the service to stop and the Status to be set to blank, then click
Close.
v On 32-bit Windows 200x, wait for the service to stop and the Service status
to be set to Stopped, then close both windows.
v On 64-bit Windows, the service is stopped and removed automatically
during the uninstallation.
5. Open a Command Prompt window, enter lmcpd -remove, press Enter, then
wait for the command to complete.
Note: If you forget this step, the next time that the system is started,
Microsoft Windows NT tries (unsuccessfully) to start the service again. To
resolve this situation, you must reinstall the service, then uninstall it.
6. Double-click Add/Remove Programs in Windows NT/200x or Programs and
Features on Windows 2008 in the Control Panel window.
7. Scroll to and select IBM Automated Tape Library.
Problem determination
A tracing tool is provided with the software to determine whether ibmatl is
functioning correctly.
Note:
1. Run trcatl in the Command Prompt window.
2. The -a parameter takes precedence over the -l parameter.
3. The trace.out is located under the directory where the trcatl runs.
Examples:
trcatl -l libmgrc7
trcatl -a > trace.out
Purpose
The IBM Tape Diagnostic Tool (ITDT) is available in two versions:
v Standard Edition (ITDT-SE) - The command line version.
v Graphical Edition (ITDT-GE) - The GUI version for the following platforms:
– Microsoft Windows operating systems
– Linux operating systems
Both versions provide the user with a single diagnostic program for tapeutil
applications. Both SE and GE contain tapeutil functions with SE also providing
scripting capability.
Note: The term tapeutil is a synonym for the tool that is delivered with the device
driver. For example, this tool is named tapeutil on UNIX operating systems; it is
named ntutil on Microsoft Windows operating systems.
The available advanced operations that are provided by the IBM Tape Diagnostic
Tool is completed on tape drives and tape libraries. By using this function, you can
complete maintenance tasks and run diagnostic tasks to determine tape drive
issues. This action reduces product downtime and increases productivity.
Note: When this test is completed, all data on the cartridge is overwritten.
v Run a full write function
Note: When this test is completed, all data on the cartridge is overwritten.
v Run a system test
Write different block sizes with compressible and incompressible data and then
outputs performance data.
Note: When this test is completed, all data on the cartridge is overwritten.
v Run a tape usage function to retrieve statistical data and error counters
v Run HD-P functions like discovery.
v Physical Copy/Data migration and verification of cartridges.
v Log and Dump File analysis.
ITDT-SE provides the most important functions of the previous tapeutil tools. As
an extension of the current tapeutil variants, the set of operations and functions
available with ITDT-SE is identical across all supported operating systems (unless a
function is not available on a particular system).
Dedicated device drivers for tapes and libraries can be installed on the target
system and an application is installed that uses the tape/library devices. When this
configuration exists, ITDT-SE can coexist with the application so that when the
application disables the device internally, ITDT-SE can run the diagnostic tests on
that device.
Accessing ITDT
IBM maintains the latest levels of the ITDT tool chain and documentation on the
Internet at http://www.ibm.com/support/fixcentral.
This portal gives access to the download area where the following procedure
guides you to the correct download:
1. In the Product Group menu select Storage Systems.
2. In the Product Family menu select Tape Systems.
3. In the Product Type menu select Tape device drivers and software.
4. In the Product menu select Tape Diagnostic Tool (ITDT).
5. Select your platform and press Continue.
Supported systems
ITDT is supported on the following systems.
The following equipment is supported System x LTO tape drives. These drives are
not tested by the IBM Test Lab. They are also not supported by IBM support. All
queries are to be addressed to IBM System x support.
v IBM Full Height LTO Gen 1, p/n 00N8016, replacement p/n 37L5799
v IBM Full Height LTO Gen 2, p/n 59P6744, replacement p/n 71P9141
v IBM Full Height LTO Gen 3, p/n 25R0012 and 39M5657, replacement p/n
25R0003 and 23R4808
v IBM Half Height LTO Gen 3, p/n 43W8478, replacement p/n 23R7036
v IBM Half Height LTO Gen 4, p/n 44E8895, replacement p/n 45E1125
v IBM Half Height LTO Gen 5
v 3600-XXX Library and Autoloader IBM Full Height LTO Gen 1, p/n 09N4048
v 4560-SLX IBM Full Height LTO Gen 2, p/n 71P9146
v 3623-2LX IBM Full Height LTO Gen 2
v 3361-4LX IBM Full Height LTO Gen 3 SCSI (p/n 42C3942 and 40K2573) and
Fibre (p/n 40K2575)*
v 3362-2LX IBM Full Height LTO Gen 3 SCSI (p/n 40K2596) and Fibre (p/n
42D8769)*
All other System x LTO tape drives are not supported by ITDT.
Note: Replacement part numbers are only given for the stand-alone IBM LTO tape
drives.
For i5/OS operating systems, see “i5/OS operating systems” on page 230 for
product support limitations.
Before the IBM Tape Diagnostic Tool Standard Edition (ITDT-SE) is used with the
IBM Tape Device Driver, we recommend upgrading to the latest available IBM
Tape Device Driver level.
In a System Managed Encryption setup, the Encryption test [E] always exits with
NO DRIVER SPECIAL FILE when ITDT-SE is started with -force-generic-dd.
Note: ITDT-SE on i5/OS requires a Microsoft Windows PC with a Java™ run time
1.4.2 or higher.
1. Start the installer installi5OS_ITDT_SE_<version>.exe.
2. Read through the welcome and license screens.
a2500247
a2500248
Figure 30. Machine credentials screen
a2500249
Note: ITDT-SE can be used only by a user with root access rights, except for the
Mac OS, which requires the user to have the minimum of read/write access to the
device file.
| 1. Download install_itdt_se_<OS>_<version> to a directory of your choice.
| v install_itdt_se_Aix_<version> is for AIX operating systems
| v install_itdt_se_Linuxi386_<version> is for Linux operating systems on X86
| hardware
| v install_itdt_se_Linuxx86_64_<version> is for Linux operating systems on
| X86_64 hardware
| v install_itdt_se_Linuxpowerpc64_<version> is for Linux operating systems
| on pSeries
| v install_itdt_se_Linuxs390x_<version> is for Linux operating systems on
| zSeries
| v install_itdt_se_Hpux_<version> is for HP-UX operating systems.
| v install_itdt_se_MacOS_<version> is for Mac OS operating systems.
| v install_itdt_se_SolarisX86_64_<version> is for Solaris X86_64 operating
| systems.
| v install_itdt_se_Solaris_<version> is for Solaris SPARC operating systems.
| 2. Run the following command to make install_itdt_se_<OS>_<version>
| executable.
| chmod 700 install_itdt_se_<OS>_<version>
| or
| ./install_itdt_se_<OS>_<version>
Note: For system security reasons, always reset the sgen device driver settings
after you finish working with ITDT-SE, by using the sgen_solaris_conf.sh
script.
To configure the sgen driver, start the sgen_solaris_conf.sh script with root
access.
The following command-line options are available on the SGEN driver
configuration screen:
v 1. Check driver: This option checks if the driver /kernel/drv/sgen is available.
v 2. List driver settings: This option shows the current activated devices.
v 3. New driver configuration: This option shows the screen that is used to
create a new driver configuration (see Step 2).
v 4. Stop sgen driver: This option stops the driver (that is, rem_drv sgen).
v 5. Start sgen driver: This option stops and starts the sgen driver.
v 6. Exit program: This option closes the shell script.
2. Enter option 3 to create a new driver configuration.
The following command-line options are available on the New Configuration
screen. Use these options to configure the sgen driver:
v 1. List targets: This option shows the targets in current configuration.
v 2. Define device types: This option defines drive and changer types.
v 3. or 5. Add targets: This option adds targets to the list.
Note: Option 4 allows for the removal of individual devices one at a time.
Option 6 allows for the removal of a range of devices, eliminating the need
to remove many devices one by one.
v 7. Save configuration: This option saves the modifications.
v 8. Back to Main Menu: This option returns to the main menu.
3. After the sgen driver is configured, enter command-line option 8 to go back to
the main menu.
4. On the SGEN driver configuration screen, enter command-line option 5. This
option starts the sgen driver. New devices are found by using the definitions
that are completed in Step 2.
5. After the new devices are found, enter option 6 to exit the sgen_solaris_conf.sh
script.
Note: For Fibre Channel Host Bus Adapters (HBAs), special handling is required.
Attached devices must be configured with their WWPN in the sgen.conf file. This
task must be done manually. It is not completed by using the
sgen_solaris_conf.sh script.
If you have finished the editing, the sgen driver has to be restarted.
Please enter "update_drv sgen".
The Read Attribute command is 16-byte CDB. On Solaris 10, IBMtape can detect
what maximum CDB length is supported from HBA attributes and set the
supported CDB. For Solaris 9, CDB16 must be enabled for ITDT-SE to work
correctly. This procedure can be done by adding the entry of
cdb16_support=1
ITDT-SE does not create any registry entries or make changes outside the
installation directory.
| During installation a subdirectory "ITDT" was created which contains the ITDT
| program file and 2 subdirectories initially:
| v "License" directory with license files in different languages.
| v "Scripts" directory for extra scripts.
| When the program is run for the first time, two more subdirectories are created in
| the "ITDT" folder:
| v "Input" directory for firmware files to be uploaded to devices.
| v "Output" directory for generated log and dump files.
| To remove ITDT from your system, erase the ITDT directory. Any log and dump
| files in the subdirectories are also erased when you do so.
During the initial program start, the input and output directories are created.
v Input directory: default directory for firmware files during Firmware Update
v Output directory: directory that contains the result files, dump files, and log files
after tests are run
For FC and SAS devices, ID and LUN greater than 999 are not displayed; they are
| shown as ###.
When logged in through telnet, backspace might not work - an escape sequence is
inserted and the input is ignored after Enter is pressed.
On HP-UX11.iV3 systems, tape libraries that are operated through the drive's
control path (no control path failover) might disappear from the Device List after a
[F] Firmware Update on the controlling drive. It is recommended to complete
repeated [S] Scan operations to make the library reappear in the device list.
Note: On an SLES9 s390x (64 bit) configuration, you might experience a SCSI
CMD TIMEOUT when the [T] option is run with the IBM Tape Device Driver.
For SUSE SLES9 on zSeries, ensure that the kernel update SUSE-SA:2007:035 is
installed.
If the IBM Tape Device Driver is not installed on Solaris 10, tape devices might not
be found during scan although they are configured in sgen.conf. When this event
occurs, complete the following steps to configure the devices:
1. Check the current driver bindings for IBM tape drives and changers by
entering the following commands:
# egrep "scsiclass,01" /etc/driver_aliases (for drives)
# egrep "scsiclass,08" /etc/driver_aliases (for changers)
2. Modify the /etc/driver_alias file to comment all lines not starting with sgen
and containing identification of your drives and changers. Examples:
#st "scsiclass,01" (all tape drives)
#st "scsiclass,01.vIBM.pULT3580-TD4" (IBM tape drive model ULT3580-TD4)
#st "scsiclass,08" (all changers)
#st "scsiclass,08.vIBM.p3573-TL" (IBM changer model 3573-TL)
3. Check that the configured drives are not configured for st driver by entering
the following command:
# cfgadm -al
When applications are turned on Windows while ITDT-SE is running, an extra ESC
character might appear on the input line. When this issue occurs, the input is
ignored after Enter is pressed.
If you are using Adaptec SCSI Host Bus adapters, ensure that you are using the
latest Adaptec Host Bus Adapter Drivers instead of the drivers that are shipped
with the Windows operating system.
On Microsoft Windows systems where the maximum transfer size is limited to less
than 64 kB, the Dump and Firmware Update operations do not work.
As the library is varied offline, the Encryption Test does not deliver decrypted data
in a Library Managed Encryption environment.
The [U] Tapeutil option is not available for i5/OS with this release as all the
underlying operations require the IBM Tape Device Driver to be installed.
FC 5912 SAS HBA support is only for POWER6 and V6R1 configurations that are
attached to LTO Gen 4 HH tape drives (No support for LTO 3 HH SAS).
Prevent/Allow Medium Removal is missing as a Tape Drive option. But, it can still
be completed by using the [56] Prevent/Allow Medium Removal option for tape
libraries while the tape device is opened.
If you press the arrow keys on most UNIX operating system consoles, the input is
ignored after Enter is pressed.
When the Tab key is pressed as an input string for field data, the user interface is
corrupted.
Make sure that field input does not start with a number followed by space and
extra text. This input is interpreted as an entry to a specific row in the field. To
avoid this issue, use an underscore character ( _ ) instead of the space character.
Command timeout
When a command timeout condition occurs, ITDT might still continue to complete
more operations (like unmounting the cartridge) instead of instantly terminating
with a timeout condition.
Library Firmware Update with ITDT-SE and ITDT-GE is not supported by the
3576/TS3310 library. Update the Firmware by using the 3576/TS3310 Web User
Interface.
Drives in a 3494 tape library or an STK silo library are supported, only the [T]
Test option does not work because of device-specific restrictions for handling
cartridges.
a2500231
Figure 33. Start screen menu
a2500295
Figure 34. Scan screen menu
| To select a device, enter a number from the leftmost column, then click Enter.
Entering the M command returns to the Start Screen menu. Entering the V
command toggles between displaying the physical device address and the driver
name.
Scan
The Scan function [S] is used to discover all supported tape and library devices
that are attached to the computer system so that they can be selected for the
subsequent ITDT-SE operations. The scan function also serves as a connection test
that can be used to verify correct attachment of the devices.
Make sure that no other program is accessing the devices that are used by
ITDT-SE. For example, stop the backup jobs that are accessing the devices when
ITDT-SE is used, or if not sure, stop the entire backup application.
After ITDT-SE is started, type S followed by Enter to activate the scan function.
Depending on the operating system and the number of attached drives, the scan
can take several minutes. See “Standard Edition - known issues and limitations” on
page 228 for details.
During the scan operation, a bar in the lower left edge of the screen shows that the
scan operation is still in progress.
When the scan is finished, the first device list screen is displayed.
If marked
with an
X, the
device is
selected
Commands
a2500280
Command
prompt
The first device list screen shows all detected devices and the connection
information (host adapter number, bus number, SCSI/FCP ID, and LUN or driver
name) along with product data (Model name, Unit Serial number, Microcode
revision). For drives that are attached to a library, the Changer column shows the
serial number of the changer the drive is attached to.
Note: For fast down scrolling, type + followed by a space and the number of lines
to scroll down, then press Enter. Alternately, type N and press Enter to scroll down
one page.
Note: For fast up (backward) scrolling, type - followed by a space and the number
of lines to scroll up. Press Enter, or type P and press Enter to scroll up one page.
If no devices appear or if devices are missing in the list, make sure that
v ITDT-SE is running with administrator/root rights.
v The devices are properly attached and powered on.
v Linux: The devices must be attached at boot time.
v i5/OS: Only tape drives are detected.
v Solaris, when no IBM tape device driver is in use:
– Ensure that sgen is correctly configured.
file /kernel/drv/sgen.conf
ITDT-SE uses the IBM Tape Device Driver for its operations. If no IBM Tape Device
Driver is installed, the generic device driver for the operating system is used
instead. On Microsoft Windows, any Tape Device Driver that is installed is used.
Note: For operating system-specific information on how to use this command, see
the corresponding Initial Startup sections.
When the wanted device is displayed, select the device for test. Only one device
| can be selected at a time.
Health Test
| The Health Test function [T] checks if the tape device is defective and outputs a
| pass/fail result.
Attention: The health test function erases user data on the cartridge that is used
for the test.
| For the library or autoloader test, the Library Test [L] must be selected.
Note:
1. The test can take from 15 minutes up to 2 hours.
2. The test runs only on tape drives, not on autoloaders or libraries.
To test tape drives within a library, the library must be in online mode.
1. Start ITDT-SE, then type S and press Enter to scan for the devices.
| 2. Select the device that you want to test by entering its number and press Enter.
3. Type T followed by Enter to activate the test.
Note: If ITDT-SE detects data on the cartridge, the Device Test screen displays a
message (as shown in Figure 38 on page 238.
Type Y followed by Enter to continue the test if you are sure that data on the
cartridge can be overwritten. If you are unsure, type N followed by Enter to stop
the test.
During the test, the program shows a progress indicator in the form of a bar of
number signs (#) (▌1▐) that shows the progress of a single subtest and also a
description of that subtest. The user might stop the test by selecting the [A]Abort
option (exception: POST A).
During the test, a progress indicator (▌1▐) is shown on the test screen. Messages
from the test steps are shown in the Status field (▌2▐).
1 2
a2500235
The test can be stopped by typing A followed by Enter at any time except during
the POST test, which is not interruptible.
a2500236
When all subtests are finished, ITDT-SE shows a screen that displays the
attachment and device information as in the first device list screen. It also shows
the test result and failure information in the code field. The screen also shows the
output files that were generated during the test run. The files might be requested
by the IBM Support Center.
If you want to use other ITDT-SE functions, type R followed by Enter to return to
the first device list screen. Otherwise, type Q followed by Enter to exit the
program.
Dump file
names
Log file
names
a2500237
Figure 41. Dump
When the dump process is completed on a tape library or autoloader other than
the 3584/TS3500/TS4500, the Dump function stores 1 log file in the output folder
of the program (*.blz). For the 3584/TS3500/TS4500, a dump file (*.a) is stored in
the output folder.
Note: When the Dump function is completed for tape libraries or autoloaders
other than the 3584/TS3500/TS4500, the log file contains only Log Sense and Mode
Sense pages, while a Drive or 3584/TS3500/TS4500 dump contains much more
diagnostic information.
Retrieve the files from the ITDT-SE output subdirectory that was created during
the installation. The following are examples of the directory:
v Example output directory (Windows): c:\ITDT\output
v Example output directory (UNIX): /home/user/ITDT/output
v Example output directory (i5/OS): /home/ITDT/output
(On the IFS) use FTP or the System i Navigator to transfer the file
If you want to use other ITDT-SE functions, type R followed by Enter to return to
the device list; otherwise, type Q followed by Enter to exit the program.
Firmware Update
The Firmware Update [F] upgrades the firmware of tape drives and tape libraries.
See “Supported equipment” on page 220 for a list of supported products.
a2500251
Figure 42. Firmware Update screen
The following site is available for the latest firmware files: http://www.ibm.com/
systems/support/storage/tape
Download the files to the ITDT-SE input subdirectory that was created during the
installation. The following are examples of the directory:
| Example input directory (Windows): c:\ITDT\input
|
| Example input directory (Unix): /home/user/ITDT/input
|
| Example input directory (i5/OS): /home/ITDT/input
| (on the IFS) use FTP or the i-Series Navigator to transfer the file
Note: The selected file name is reset to the first item (#0) after the Refresh
function is used.
v If the displayed directory contains more files than the files shown, type + and
press Enter to scroll down the list. For fast down scrolling type + followed
by a space and the number of lines to scroll down then press Enter. To scroll
back, use - instead of +.
Scrollable data is indicated by "VVVVVVVVVVVVVVVVV".
VVVVV
=
a2500253
more data
5. After the firmware file is selected, type C and press Enter to continue.
6. Before the firmware update is started, make sure the file that is displayed in
the FW File field is the correct file.
v If the correct file is displayed, proceed to the next step.
v If the correct file is not displayed, type C and press Enter to change the
selected firmware file. Go to Step 4.
Note: The selected file name is reset to the first item in the list when you
return to that dialog from the Start Update dialog.
7. If you decide to run the firmware update, type S and press Enter to start the
firmware update.
During the firmware update, a firmware update progress screen is displayed.
Attention: Once started, do not interrupt the firmware update.
The firmware update usually takes 3-5 minutes, but it can take up to 45
minutes for libraries. If you decide not to run the firmware update, type R and
press Enter to return to the Device List.
The System Test runs only on tape drives, not on autoloaders or libraries. To
complete a System Test on tape drives within a library, the library must be in
online mode.
1. Start ITDT-SE, type S, and press Enter to scan for the devices.
2. Type Y and press Enter to start the System Test.
ITDT-SE then switches to the System Test screen. If no cartridge is inserted,
ITDT-SE prompts to insert a cartridge. Either insert a cartridge and press Enter
or stop the test by typing C followed by Enter.
Note: If ITDT-SE detects data on the cartridge, it shows the System Test screen,
and displays the following message.
Cartridge not empty!
Overwrite data?
Type Y followed by Enter to continue the test if you are sure that data on the
cartridge can be overwritten. If you are unsure, type N followed by Enter to
stop the test.
The System Test is completed as follows:
a. System Test determines the amount of data to write for each supported
blocksize (a percentage of the cartridge is written for each blocksize).
b. The test determines the maximum supported blocksize of the system.
c. System Test writes the amount of data with all supported block sizes in
powers of two down to 16 KB. It begins with the maximum supported
blocksize that was detected before, first with incompressible, next with
compressible data, and then performance data and a progress screen.
d. At the end of the test, a summary screen is displayed.
"Compressible = Yes" means that the data written was just zeros so that the
data is compressed by the drive with a maximum compression ratio.
"Compressible = No" means that a data pattern was written that the drive
almost cannot compress at all. If the compression ratio is 1, the drive was not
able to compress the data (equivalent to 1:1 compression ratio). If the
compression ratio is 94.0, the drive was able to do 94:1 compression, meaning
that 94 bytes in the original data is compressed to 1 byte on the medium. 100.0
means 100 bytes is compressed down to 1 byte on the medium.The System Test
can be stopped by typing A followed by Enter at any time.
Note: It can take some time until the System Test stops.
If you want to use other ITDT-SE functions, type R followed by Enter to return to
the device list. Otherwise, press Q followed by Enter to exit the program.
| Eject Cartridge
| The Eject Cartridge [J] function unloads a cartridge from a tape drive.
| 1. Start ITDT-SE, then type S and press Enter to scan for the devices.
| 2. Select the device that you want to unload a cartridge from by entering its
| number and pressing Enter.
| 3. Type J and press Enter to unload a cartridge.
| Cleaning Statistics
| Cleaning Statistics [A] retrieves statistical data about cleaning actions. Some
| devices do not support this function.
| 1. Start ITDT-SE, type S, and press Enter to scan for the devices.
| 2. Select the device that you want to retrieve cleaning statistics from by entering
| its number and pressing Enter.
| 3. Type A and press Enter to start the cleaning statistics retrieval for the selected
| device.
Full Write
The Full Write [F] function writes the entire cartridge with a specified block size
either with compressible or incompressible data and output performance data.
Attention: The Full Write function erases data on the cartridge that is used for
the test.
Note:
1. The Full Write function takes approximately 2 hours when incompressible data
is written, less time for compressible data.
2. The Full Write function runs only on tape drives, not on autoloaders or
libraries.
Note: If ITDT-SE detects data on the cartridge, it shows the Full Write screen,
and displays the following message:
Cartridge not empty!
Overwrite data?
Type Y followed by Enter to continue the test if you are sure that data on the
cartridge can be overwritten. If you are unsure, type N followed by Enter to
stop the test.
| Note: Values of 16 KB and 32 KB are not tested in cases where the capability of
| a system supports higher block sizes.
5. Select the type of data to write, either [C] Compressible or [I] Incompressible.
During the full write, the program shows a progress indicator in form of a bar
of number signs (#) that shows the progress of the full write.
The full write can be stopped by typing A followed by Enter at any time.
Note: It can take some time until the full write stops.
If all write operations are finished, ITDT-SE shows a screen that displays the
compression ratio (▌1▐) and the write performance (shown in ▌2▐ as the Data
Rate) for the selected block size. If an error occurred during the full write, data
is only written partially.
"Compressible = Yes" means that the data written was just zeros so that the
data is compressed by the drive with a maximum compression ratio.
"Compressible = No" means that a data pattern was written that the drive
almost cannot compress at all. If the compression ratio is 1, the drive was not
able to compress the data (equivalent to 1:1 compression ratio). If the
compression ratio is 94.0, the drive was able to do 94:1 compression, meaning
that 94 bytes in the original data is compressed to 1 byte on the medium. 100.0
means 100 bytes is compressed down to 1 byte on the medium.
If you want to use other ITDT-SE functions, type R followed by Enter to return
to option 4 the device list. Otherwise, type Q followed by Enter to exit the
program.
1
a2500243
a2500244
Figure 46. Tape Usage screen
1. After ITDT-SE is started, type S followed by Enter to activate the device scan.
2. Select the device that you want to test by entering its number and press Enter.
3. Type U followed by Enter to start the tape usage log retrieval. ITDT-SE then
switches to the tape usage screen. If no cartridge is inserted, ITDT-SE prompts
to insert a cartridge. Either insert a cartridge and press Enter or stop the test by
entering C followed by Enter.
During the get logs operation, the program shows a progress indicator in form of a
bar of number signs (#) that shows the progress of a single suboperation and a
description of that operation.
| When all suboperations are finished, ITDT-SE shows a Tape Usage completion
screen. The Status field on the lower right side indicates PASSED if the log
retrieval completed successfully and ABORTED otherwise.
Note: The tape drive firmware must be at least version: C7RC (for LTO 5), C974
(for LTO 6), and 36A5 (for Jaguar E07 and E08). The LTFS Readiness Check
requires an empty data cartridge.
The LTFS Readiness Check can return with result FAILED and one of the following
error codes.
Library Test
The Library Test [L] starts and monitors the library-internal self-test. This test runs
only on libraries and autoloaders, not on tape drives.
1. Start ITDT-SE, type S, and press Enter to scan for the devices.
2. Type O and press Enter to display the second device list screen.
3. On the second device list screen, type L and press Enter to start the Library
Test.
A Device Test screen is displayed and a functionality test on the tape library is
completed.
At the end of the test, a results screen is displayed.
The Library Test can be stopped by typing A followed by Enter at any time.
Note: It can take some time until the Library Test stops.
If you want to use other ITDT-SE functions, type R followed by Enter to return to
the device list; otherwise press Q followed by Enter to exit the program.
First, the test tries to read dump files from each drive that is installed from the
library. After that, the customer must select one drive for loading the cartridges.
All cartridges of the I/O and storage slots are moved - one after the other - from
their source to the selected drive. A dump is taken and moved back to the source
address.
In the result screen, the dumps taken and the count of dumps are displayed.
Note: On i5/OS, media changers and media changer operations are not supported
by this release of ITDT-SE. To test a tape drive inside a library, the tape drive must
be varied online and the tape library must be varied offline (see “Starting ITDT-SE
on i5/OS operating systems” on page 227 for details). As the library is varied
offline, the Encryption function does not deliver decrypted data in a Library
Managed Encryption environment.
1. After ITDT-SE is started, type S followed by Enter to activate the device scan.
2. Select the device that you want to test by entering its number and press Enter.
3. Type E and press Enter to start the encryption test. ITDT-SE then switches to
the Encryption Verification screen. On this screen, the system requires the
entry of the number of the start record and the amount of data (in KB) to be
read.
4. Type S followed by a space and the start record number, then press Enter to
enter the start record number. Type L followed by a blank and the data length,
then press Enter to enter the data length, maximum 100000 KB.
5. If you entered the values correctly, press Enter to start the encryption.
During the encryption, the program shows a progress indicator in form of a bar
of number signs (#) that shows the progress of a single subtest and information
about that subtest.
The Encryption function can be stopped by typing A followed by Enter at any
time.
Note: It can take some time before the Encryption function stops.
If all encryption operations are finished, ITDT-SE shows a screen that displays the
Status field on the lower left side that indicates PASSED if the encrypted test
completed successfully and ABORTED otherwise.
The screen also shows the output files that were generated during the Encryption
function:
v file serial# .n.ENC contains the raw encrypted data
v file serial# .n.DEC contains the decrypted data
If you want to use other ITDT-SE functions, type R followed by Enter to return to
the device list. Otherwise, type Q followed by Enter to exit the program.
| Configure TCP/IP
| Configure TCP/IP [C] configures the ethernet port settings of LTO 5, LTO 6, LTO 7,
TS1140, and TS1150 drives. For those drives, the current settings are read and
displayed and can be changed.
| Note: LTO 5, LTO 6, and LTO 7 drives have one port and TS1140 and TS1150
drives have two ports that can be configured. Configuring the ethernet ports must
not be done in a TS3500/TS4500. Although the ports can be configured, it is
ineffective.
1. Start ITDT-SE, type S, and press Enter to scan for the devices.
2. Select a device from the list (just the ones that are listed are supported) by
entering the number, then press Enter.
3. Type O and press Enter to display the second device list screen.
4. On the second device list screen, type C and press Enter to open the Configure
TCP/IP screen.
ITDT-SE switches to the Configure TCP/IP screen and reads the data configuration
of port 1. To toggle between port 1 and 2, type P and press Enter.
Each parameter can be set by entering the number (1 - 5) and a following value. If
you want to enable DHCP, enter '1 1' and press Enter. The value of the DHCP
field is refreshed with the value entered.
The values for both ports are applied to the drive by entering A and pressing
Enter. ITDT-SE configures the drive and the current active addresses are shown in
the field: Active IP Addresses. Regular field values:
[1] DHCP enabled: 0/1 (false/true)
[2] Address IPV4 Regular IPv4 address
[3] Subnet Mask Length V4: 0...23
[4] Address IPV6: Regular IPv6 address
[5] Subnet Mask Length V4: 0...127
If you want to use other ITDT-SE functions, type R, then press Enter to return to
the device list. Or, press Q and Enter to exit the program.
Return
Return [R] - type R followed by Enter to go back to the first device list screen.
Note: On any screen, to start a command, press the shortkey displayed in brackets
[ ], followed by Enter.
Note: Always use the Read Only mode when you are working with
write-protected media.
ITDT supports generic and Device Driver claimed devices. This section shows
examples for device names (addressing) of all supported platforms. The used
abbreviations stand for:
Note: The correct IDs are reported in the ITDT Control Center after a scan or with
the scripting function "scan".
Table 55. Device addressing
IBM Tape Generic IDs separated with Generic (alternative, as a
Device Driver blanks result from ".itdt scan")
IBM AIX /dev/rmtX.Y
/dev/smcX
Linux /dev/IBMtapeX
/dev/
IBMchangerX
Microsoft \\.\tape0
Windows
\\.\changer0 H<host>-B<bus>-
<host><bus><target><lun>
T<target>-L<lun>
Oracle Solaris /dev/rmtXsmc
/dev/smc/
Xchng
HP-UX /dev/rmt/
Xmnb
/dev/rmt/
Xchng
changerX
IBM 'i' - Device Name; for
-
example, TAP01
For a device that uses the IBM device driver, the call might look like \\.\Tape4,
and for a generic device on Windows 2 0 3 0.
[3] Inquiry
When you select the Inquiry command [3]:
1. You are prompted for page code.
2. ITDT then displays a decoded format of a hexadecimal dump and prints a
hexadecimal dump of the inquiry data.
[20] Rewind
When you select the Rewind command [20], ITDT issues the ioctl rewind command
for the device.
Note: If the block size is zero, variable mode is used. With a fixed block size, a
data amount of (block size * blocks) is transferred with a single operation. This
process can get rejected if the total amount exceeds the transfer size the system
can handle.
v You are prompted for the number of blocks per read/write (If you press Enter,
the default number of blocks is 20).
v You are prompted for the number of repetitions (If you press Enter, the default
number of repetitions is 1).
ITDT runs the selected test. Then, it displays the transfer size and block size that is
used for this test, the number of records read/written, and the total bytes
transferred.
[28] Erase
When you select the Erase command [28], ITDT issues the (extrinsic) ioctl
command to erase the cartridge.
Note: The list of changeable parameters is operating system specific. For a list
of changeable parameters, refer to .
3. You are prompted for parameter to change.
4. ITDT requests prompt for parameter value (if required).
5. ITDT requests safety prompt (if required).
6. ITDT issues the ioctl command.
Not all drives have a display. The 3592 drive is the only one that has display
message capability. It is the only one with a display that is more than one character
long. Eight is the limit of the characters on a display screen.
dd000009
You can change any of the settings by stepping through each parameter - press
Enter. To change a parameter, enter the new value, then press Enter. All data is
sent to the drive and the following screen display is shown:
Note: Because earlier drive generations do not have an ethernet port, the
Configure TCP/IP Port command is rejected for these devices with the following
message:
TCP/IP configuration is not supported on this product.
Note: See “3576/TS3310 tape library” on page 231 for information on how to
update the firmware on a 3576/TS3310 tape library.
The following site is available for the latest firmware files:
http://www.ibm.com/storage/lto.
If it is successful, it delivers two maps that represents the logical and physical
HD-P environment.
The logical map is a representation of the libraries, where a “1” is the indicator for
a connection and a “-1” of no connection.
Command Result
+-----------------------------------------------------------------------------+
| Shuttle Call System discover..... |
| Scanning devices..... |
| .....DeviceFileName:/dev/smc1 SN:0000013AAA160404 |
| |
| Discovering Libraries...... |
| .....Passed |
| |
| Connection Map: |
| LL01: /dev/smc1 |
| |
| LL01 |
Note: Mixed Media environments (3592 and LTO) are not supported.
-LL Errors|Warnings|Information|Debug
Set log level (default: Error)
-R resultdir
Use ’resultdir’ as result file path (default: output)
Note: "filename" is a device special file for the drive/changer or the device
address (host bus target lun). For a complete list of the file name or address
syntax, refer the section "Special Files" on each platform or go to “Device file
names - device addressing” on page 254.
The Open Mode flag is supported on all platforms. If the flag is not set, the device
is opened in read/write mode. More parameters that might be required for
opening the device are automatically detected and set.
-w mode
Open mode, by default Read/Write.
Valid modes are:
1 = Read/Write
2 = Read Only
3 = Write Only
4 = Append
Note: Always use the Read Only mode when you are working with
write-protected media.
The new command set enables legacy commands on every platform, even if that is
not previously supported by Tapeutil. The output follows current Tapeutil
conventions. But, if different output displays for a single command on various
platforms, the output is implemented according to the AIX output as the primary
scripting platform.
General commands
v “allow” on page 267
v “devinfo” on page 267
v “inquiry” on page 268
v “logpage” on page 268
v “loop” on page 268
v “modepage” on page 268
v “prevent” on page 268
v “print” on page 269
v “qrypath” on page 269
v “qryversion” on page 269
Tape commands
v “append” on page 271
v “bsf” on page 272
v “bsr” on page 272
v “chgpart” on page 272
v “density” on page 272
v “display” on page 272
v “erase” on page 273
v “fdp” on page 273
v “fdpl” on page 273
v “fsf” on page 274
v “fsr” on page 274
v “getparms” on page 274
v “idp” on page 274
v “idpl” on page 275
v “list” on page 275
v “load” on page 275
v “logsense” on page 276
v “qrypar/qrypart” on page 276
v “qrylbp” on page 276
v “qrypos” on page 276
v “qrytcpip” on page 276
v “read” on page 277
v “resetdrive” on page 277
v “rmp” on page 277
v “runtimeinfo/qryruntimeinfo” on page 277
v “rewind” on page 277
v “rtest” on page 278
v “rwtest” on page 278
v “sdp [0|1|2|3]” on page 278
v “sdpl [0|1]” on page 278
v “seod” on page 279
v “setparm” on page 279
v “setpos” on page 280
v “settcpip” on page 280
v “sync” on page 281
v “unload” on page 281
HD-P commands
v “hdp discover” on page 288
v “hdp senderror” on page 288
v “hdp show” on page 289
allow
(Deprecated: unlock, -o rem) Allow medium removal for tape or changer devices
(unlock door). The counter command for this is prevent.
Parameters:
None
devinfo
(Deprecated: -o gdi) Show device information (device type, sub type and block
size)
Parameters:
inquiry
(Deprecated: -o inq) Issue an Inquiry command and dump the bytes in Hex.
Parameters:
inquiry [Page code in Hex, 00-FF without leading x]
Note: ITDT prints a hex dump of the inquiry data on all platforms.
logpage
(Deprecated: -o log) This subcommand issues the SCSI Log Sense command to the
device for the specified page and displays the log sense data.
Parameters:
Page (page in hex without the leading x)
[Subpage] (in hex without leading x)
loop
This subcommand loops all subsequent subcommands continuously or a number
of times if the Count parameter is specified. Also refer to the sleep subcommand.
Parameters:
loop [Count]
modepage
(Deprecated: -o mod) This subcommand issues the SCSI Mode Sense command to
the device for the specified page and displays the mode sense data.
Parameters:
modepage Page (page in hex without leading x)
prevent
(Deprecated: -o lck, lock) Prevent medium removal for tape or changer devices
(lock door). The counter command for this command is allow.
Parameters:
None
Parameters:
print Text
qrypath
(Deprecated: -o phs, path, checkpath) This subcommand displays information
about the device and SCSI paths, such as logical parent, SCSI IDs, and the status of
the SCSI paths for the primary path and all alternate paths that are configured.
Parameters:
None
Note: ITDT shows the entire path information for all the commands.
qryversion
(Deprecated: -o drv) This subcommand prints out the current version of the IBM
device driver.
Parameters:
None
release
(Deprecated: -o rel) This subcommand explicitly releases a device and makes it
available for other hosts by issuing the SCSI Release command.
Parameters:
None
reqsense
(Deprecated: -o req) This subcommand issues the SCSI Request Sense command to
the device and displays the sense data in hex format.
Parameters:
None
Parameters:
None
scan
Displays the list of connected devices. For each detected device special file name,
vendor id, firmware version, serial-number, SCSI bus address, associated changer,
and device driver name is shown.
Parameters:
[-force-generic-dd] [-o formatstring]
Example scan:
./itdt scan
Scanning SCSI Bus ...
#0 /dev/IBMtape3 - [ULT3580-TD5]-[ACDF] S/N:1168001104 H3-B0-T3-L0
#1 /dev/IBMchanger1 - [3573-TL]-[9.20] S/N:00L4U78D6118_LL0 H3-B0-T5-L1
#2 /dev/IBMtape7 - [ULTRIUM-TD4]-[A232] S/N:1310000593 H1-B0-T0-L0
The formatstring controls the output and specifies how the connected devices must
be reported. It can include any alphanumeric character. The default formatstring is
“"#%# %D - [%P]-[%F] S/N:%S H%H-B%B-T%T-L%L".
An integer that is placed between a % sign and the format command acts as a
minimum field width specifier, a negative value uses right text alignment.
Any combination of the identifiers that are listed here are supported.
Known problem: On Solaris for IBM device driver managed device: the
information about the host, bus, target, and lun for generic devices is incorrect.
sleep
Sleep for the specified number of seconds before running the next subcommand.
Parameters:
sleep [Seconds]
tur
(Deprecated: -o tur) This subcommand issues the SCSI Test Unit Ready command
to the device.
Parameters:
None
vpd
This subcommand displays Vital Product Data (VPD) that are part of the Inquiry
command data and outputs Manufacturer, Product Identification and Revision
Level.
Parameters:
None
append
Opens the device in append mode. The file access permission is Write Only.
Parameters:
None
bsf
(Deprecated: -o bsf) This subcommand backward spaces Count filemarks. The
tape is positioned on the beginning of the last block of the previous file. An
optional Count can be specified. The default is 1.
Parameters:
bsf [Count]
bsr
(Deprecated: -o bsr) This subcommand backward spaces Count records. An
optional count can be specified. The default is 1.
Parameters:
bsr [Count]
chgpart
This subcommand changes the current active tape partition to a new partition
specified by Number. Optionally, a Blockid can also be specified. If Blockid is
omitted, the tape is positioned at the start of the new partition. Otherwise, the tape
is positioned at the Blockid specified.
Parameters:
Number [Blockid]
density
(Deprecated: -o gdn / -o rds) This subcommand issues the SCSI Report Density
Support command for all supported media and for the current media loaded in the
drive, and displays the results. If the drive is not loaded, the current media density
is not reported.
Parameters:
None
display
(Deprecated: -o msg) This subcommand displays a message on the display panel of
the tape device. Up to 16 characters can be used for the message. If the message is
longer than eight characters, the display alternates between the first eight
characters and the remainder of the message.
272 IBM Tape Device Drivers: Installation and User's Guide
Parameters:
display “message1” “message2”
erase
(Deprecated: -o era) This subcommand writes EOD at the current position and
erases the tape from EOD to the end of current partition.
Parameters:
None
Note: The erase command triggers a long erase of the cartridge that sets EOD to
the current position. Then, it writes the Data Set Separator (DSS) pattern from the
new EOD to the end of the current partition. This process overwrites any data that
is on the cartridge after the current logical position. To remove the entire cartridge,
the user must remove all partitions (use the rmp command for LTO 5, TS1140, and
newer drives). Then, issue the rewind command before the erase command.
Examples:
fdp
This subcommand creates fdp (fixed data partitions) wrap wise. The default size
for LTO 5 of partition 0 in this case is 1425 GB and the size of partition 1 is 37.5
GB. It also works for Jaguar 4 but the size depends on the used cartridge.
Supported by LTO 5, Jaguar 4, and later.
Parameters:
None
fdpl
This subcommand creates fdp (fixed data partitions) longitudinal. The command is
valid only for Jaguar drives (Jaguar 4 and later) and creates partitions 0 and 1 on
the cartridge. The size depends on the used cartridge.
Parameters:
None
Parameters:
fsf [Count]
fsr
(Deprecated: -o fsr) This subcommand forward spaces count records. An optional
count can be specified. The default is 1.
Parameters:
fsr [Count]
getparms
(Deprecated: -o parms / status / -o gpa) Get and show drive, media and driver
parameters.
Parameters:
None
idp
This subcommand creates initiator defined partitions (IDP) wrap wise on tape. The
parameter pSize0 is used to specify the size of partition 0 and the parameter pSize1
is used to specify the size of partition 1. One of pSize0 or pSize1 must have a
value that is entered in hex matching 37.5 * n with (1 <= n <= 38) to specify the
wanted size of that partition. The other parameter of pSize0 or pSize1 must have
the value 0xFFFF to specify that the remaining capacity is used for that partition. If
0xFFFF is not used for one of the parameters, pSize0 or pSize1, the drive might
reject the command | unless pSize0 and pSize1 exactly match predefined allowable
values.
For Jaguar 4 (not for LTO 5) the parameters pSize2 and pSize3 are valid and they
follow the same rules as described earlier.
For example: If you want a 37.5 GB partition (the minimum size partition) in
partition 0 and the remainder in partition 1, then set pSize 0 to 0x26 and pSize1 to
0xFFFF. This action results in a volume with a 37.5 GB sized partition 0 and a 1425
GB sized partition 1.
Parameters:
idp pSize0 pSize1
pSize0: size of partition 0
pSize1: size of partition 1
idpl
This subcommand creates initiator defined partitions (IDP) longitudinal wise on
tape. The parameter pSize0 is used to specify the size of partition 0 and the
parameter pSize1 is used to specify the size of partition 1. One of pSize0 or pSize1
must have a value that is entered in hex matching 37.5 * n with (1 <= n <= 38) to
specify the wanted size of that partition. The other parameter of pSize0 or pSize1
must have the value 0xFFFF to specify that the remaining capacity is used for that
partition. If 0xFFFF is not used for one of the parameters, pSize0 or pSize1, the
drive might reject the command | unless pSize0 and pSize1 exactly match
predefined allowable values.
For Jaguar 4 (not for LTO 5) the parameters pSize2 and pSize3 are valid and they
follow the same rules as described earlier.
For example: If you want a 37.5 GB partition (the minimum size partition) in
partition 0 and the remainder in partition 1, then set pSize 0 to 0x26 and pSize1 to
0xFFFF. This action results in a volume with a 37.5 GB sized partition 0 and a 1425
GB sized partition 1.
Parameters:
idp pSize0 pSize1
pSize0: size of partition 0
pSize1: size of partition 1
Example Call:
idp 0x26 0xffff
list
This subcommand displays the content of a tape. The output lists filemarks and
the size of each record found on the tape until the end of data is reached. The
output that is generated from this subcommand can be large depending on the
amount of data on the tape and must usually be redirected to a file.
Parameters:
None
load
(Deprecated: -o lod) This subcommand issues a SCSI Load command to load a
tape. The subcommand loops all subsequent subcommands continuously or a
number of times if the Count parameter is specified. Also refer to the sleep
subcommand.
Parameters:
None
logsense
Retrieves all Log Sense pages and outputs them as hex.
Parameters:
None
qrypar/qrypart
Queries and displays tape partitioning information.
Parameters:
None
qrylbp
Queries and displays logical block protection information.
Parameters:
None
qrypos
(Deprecated: -o gpo) This subcommand displays the current tape position.
Parameters:
None
qrytcpip
This subcommand outputs the current drive TCP/IP configuration. Only supported
| with LTO 5, LTO 6, LTO 7, TS1140, and TS1150. Outputs adapter and TCP/IP
address information for IPv4 and IPv6 with address, port and subnet mask. For
example:
./itdt -f /dev/IBMtape3 qrytcpip
Reading current TCP/TP Configuration...
Number of Port Descriptors 1
Port Descriptor for Port 1
Number of Socket Descriptors 2
Adapter:1 IPV4 9.11.22.111/23 DHCP:0
Adapter:2 IPV6[0002:0000:0000:0000:0007:0008:0000:0000]/24
Active IP Addresses:
IPv4: 169.254.0.3
Exit with code: 0
Parameters:
None
read
This subcommand reads a file, or a specified number of records, from the tape to
the destination file name specified with the -d flag. If the optional count parameter
is used, only the number of records that are specified with the -c flag are read
unless a filemark is encountered before the number of specified records. If the
count parameter is not used, all records up to the next filemark on tape are read.
Parameters:
read -d Dest [-c Count]
resetdrive
This subcommand issues a Send Diagnostic command (Reset Drive subcommand)
to reset the device.
Parameters:
None
rmp
Remove partitioning.
Parameters:
None
runtimeinfo/qryruntimeinfo
This subcommand is used to query the dynamic runtime information. Dynamic
runtime information allows an initiator to set dynamic runtime attributes (DRA)
about itself into a device server. The device server then associates those attributes
to the I_T_L nexus and uses the information and associations for enhanced data
collection and debugging.
Parameters:
None
rewind
(Deprecated: -o rew) Rewinds the tape.
Parameters:
None
Parameters:
read [-b Blocksize] [-c Count] [-r Repetition]
rwtest
This subcommand runs a read and write test by writing a random data pattern on
the tape, reading it, and verifying that it matches the written data. An optional
block size, count, and repetition can be specified with the -b, -c, and -r flags,
respectively. If the block size is fixed, then the count specifies the number of blocks
to write on each repetition. A single transfer transmits (block size * count) bytes.
The operation is rejected if the total amount exceeds the transfer size the system is
capable of. If the block size is zero (variable), then the count specifies the number
of bytes to write on each repetition. The default is a block size of 10240 bytes, a
count of 20 blocks, and a repetition of 1.
Parameters:
rwtest [-b Blocksize] [-c Count] [-r Repetition]
sdp [0|1|2|3]
Creates SDP (Select Data Partitions) wrap wise on tape.
Parameters:
Type number
For LTO (5 and higher) only the values 0 and 1 are valid.
Using value 0 as parameter leads to partition 0 with 1.5TB
and partition 1 does not exist.
Using value 1 as parameter leads to partition 0 with 750 GB
and partition 1 with 712.5 GB.
For Jaguar (4 and higher) values 0, 1, 2 and 3 are valid.
Using value 0 as parameter will create only one partition,
value 1 creates two and so on.
The sizes of the partitions are depending on the cartridge used in drive.
sdpl [0|1]
Creates SDP (Select Data Partitions) longitudinal on tape.
Parameters:
seod
(Deprecated: -o eod) Spaces to end of data on the tape.
Parameters:
None
setparm
(Deprecated: -o spa / volid / compress / nocompress / sili / nosili /
autoload / noautoload / retain / noretain)
ITDT-SE uses the new setparm option that corresponds to the current interactive
mode options.
Supported platforms: All, but only a subset of the parameters is supported by the
platform's device drivers.
Table 56. Supported platforms
Linux Windows AIX Solaris HP-UX
setparm autoload X
setparm autodump X
setparm blocksize X X X X X
setparm buffering X X X X
3
setparm capacity X X X X X
setparm compression X X X X X
setparm datasafemode¹ X X X X X
setparm immediate X X X X
setparm readpastfilemark X
setparm recordspacemode X
setparm sili X X X
Note:
1. The datasafemode can be set to YES or NO when no cartridge is loaded. When
a cartridge is loaded, the datasafemode can be set only to YES.
2. Depending on the support of the device.
3. Only supported by 3592.
setpos
(Deprecated: -o spo / asf) This subcommand issues the SCSI Locate command to
the device to set the tape position. If the optional Blockid parameter is specified,
the tape position is set to the Blockid. Otherwise, if the Blockid parameter is
omitted, the tape position is set to the last position saved by using the qrypos
subcommand.
Parameters:
setpos [Blockid]
settcpip
| This subcommand sets the drive ethernet port TCP/IP settings for LTO 5, LTO 6,
| LTO 7, TS1140, and TS1150 drives. Either a static IPv4 or IPv6 address can be set or
DHCP enabled.
Example DHCP:
./itdt -f /dev/IBMtape3 settcpip DHCP
Initializing device...
Setting TCP/TP Configuration...
Reading current TCP/TP Configuration...
Number of Port Descriptors 1
Port Descriptor for Port 1
Number of Socket Descriptors 2
Adapter:1 IPV4 9.11.22.111/23 DHCP:1
Adapter:2 IPV6 [0002:0000:0000:0000:0007:0008:0000:0000]/24
Active IP Addresses:
Exit with code: 0
169.254.0.3 IPv4:
9.155.27.46 IPv4:
9.155.27.14
Parameters:
dhcp, address[/subnet_mask_length]
Note: With the current firmware level, the device can be reached (ping, FTP) only
within the same subnet. For example, the sample is configured with a static IP
address (9.155.27.14) and DHCP enabled. The drive can be pinged only within the
same subnet (9.155.27.xxx). Both IP addresses (9.155.27.14 and the DCP address
9.155.27.46) are active and can be used.
sync
(Deprecated: -o syn) This subcommand synchronizes buffers/flushes the tape
buffers to tape.
Parameters:
None
unload
(Deprecated: -o off / offline / rewoffl) This subcommand rewinds and unloads
the tape.
Parameters:
None
verlbp
This subcommand verifies logical block protection written blocks. The verification
length can be set with parameter value filemarks count or with EOD.
Parameters:
weof
(Deprecated: -o eof / eof) These subcommands write count filemarks. An
optional count can be specified. The default is 1.
Parameters:
weof [Count]
Note: The weof parameter [count] is optional, if it is not supplied, one filemark is
written.
write
This subcommand writes the source file specified with the -s flag on the tape. In
case the parameter 'raw' is specified, the blocksize specified in setparm (setparm
blocksize) is used instead of the default blocksize of 64 kB.
Parameters:
[-raw] -s Source
wtest
(Deprecated: -o wri) This subcommand runs a write test by writing a random data
pattern on the tape. The rtest subcommand can be used after the wtest
subcommand to verify the data that was written. An optional block size, count,
and repetition can be specified with the -b, -c, and -r flags, respectively. If the
block size is fixed, the count specifies the number of blocks to write on each
repetition. If the block size is zero (variable), the count specifies the number of
bytes to write on each repetition. The default is a block size of 10240, a count of 20
blocks, and a repetition of 1.
Parameters:
wtest [-b Blocksize] [-c Count] [-r Repetition]
audit
(Deprecated: -o aud / -o ier) This subcommand with no parameters issues the
SCSI Initialize Element Status command to the device. Using the optional
parameters Address and Count issues the SCSI Initialize Element Status With
Range command to the device. The Address parameter specifies the starting
element address and the Count parameter, if used, specifies the number of
elements to initialize. If Count is omitted, it defaults to 1.
Parameters:
audit [[Address] [Count]]
cartridgelocation
This subcommand with no parameters issues the SCSI Read Element Status
command to the device to report all slots with the cartridge location information.
Using the optional parameters Slot and Count issues the SCSI Read Element Status
to the device for a specific starting Slot address and optionally the Count specifies
the number of slots to return. If Count is omitted, it defaults to 1.
Parameters:
cartridgelocation [Slot [Count]]
elementinfo
(Deprecated: -o ele) This subcommand displays element information (number and
address) of each element type.
Parameters:
None
exchange
(Deprecated: -o exh) This subcommand issues the SCSI Exchange Medium
command to the device by using the Source, Dest1, and Dest2 addresses specified.
This command runs the equivalent function of two Move Medium commands. The
first moves the cartridge from the element address that is specified by the Dest1
parameter to the element address specified by the Dest2 parameter. The second
moves the cartridge from the element address that is specified by the Source
parameter to the element address specified by the Dest1 parameter.
Parameters:
exchange Source Dest1 Dest2
inventory
(Deprecated: -o inv) This subcommand with no parameters issues the SCSI Read
Element Status command for each element type and displays the element status
information. If the optional -i parameter is used, then only the import/export
element status information is returned. If the optional -v parameter is used, then
only the element status information for the specified Volid if found is returned.
Parameters:
inventory [-i | -v Volid]
Parameters:
move Source Dest
position
(Deprecated: -o pos) This subcommand issues the SCSI Position to Element
command by using the destination specified.
Parameters:
position Dest
dump
(Deprecated: -o sdp) This subcommand forces a dump of the tape drive and stores
the dumps before and after the force dump in the ITDT-SE output folder with the
ITDT-SE naming convention (serialnumber.a.gz and serialnumber.b.gz).
Parameters:
None
ekmtest
Test encryption key path/setup.
Parameters:
None
encryption
Query tape drive encryption settings and display the encryption state.
Parameters:
None
ucode
(Deprecated: -o dmc) This subcommand downloads microcode to the device. The
Filename is a file that contains the ucode.
Parameters:
tapephcp
Creates a physical copy of a tape cartridge. The created cartridge has the same
physical layout and contents as the origin cartridge. The amount of transferred
data and the current data transfer rate is displayed every 3-5 minutes. Tapephcp is
supported for LTO and 3592 tape drives and can therefore be used for data
migration. A tapephcp command that is issued to copy data from a 3592 drive to
an LTO drive or from an LTO Gen 4 to an LTO Gen 3 works, if the amount of used
data from the source device is equal or less than the capacity of the destination
device.
Parameters:
| tapephcp [-cqs Memorysize] source destination
Source and destination can either a special device file name, or a tape image file
name. The special device file format is identical to the format specified in chapter
3.19 parameter “-f device”.
| To ensure maximum performance for tape to tape copy actions, tapephcp allocates
| a read buffer of 2500 MB (assuming the maximum system block size is 1 MB). If
| the system does not provide this buffer, the operation is aborted with MEMORY
| ALLOCATION FAILED. The value for memory allocation can be changed with an
| integer value for the parameter cqs (Command Queue Size). The cqs value must
| be multiplied with the maximum supported system blocksize to determine the size
| of memory that is allocated by ITDT. Supported copy operations are from tape to
tape, from image file to tape, and from tape to image file.
ltfsphcp
Creates a physical copy of an LTFS formatted cartridge. Ltfsphcp is based on
tapephcp. The LTFS specified parameters volumeuuid and VCI are adjusted during
this copy operation. The created cartridge has the same physical layout as the
origin cartridge. Expect the volumeuuid to be identical to the contents of the two
cartridges. The amount of transferred data and the current data transfer rate is
displayed every 3-5 minutes. When ltfsphcp is used with a non-LTFS formatted
cartridge, the behavior of ltfsphcp is identical to tapephcp.
Parameters:
| ltfsphcp [-cqs Memorysize] source destination
Source and destination can either a special device file name, or a tape image file
name. The special device file format is identical to the format specified in chapter
3.19 parameter “-f device”.
| To ensure maximum performance for tape to tape copy actions, ltfsphcp allocates a
| read buffer of 2500 MB (assuming the maximum system block size is 1 MB). If the
| system does not provide this buffer, the operation is aborted with MEMORY
| ALLOCATION FAILED. The value for memory allocation can be changed with an
| integer value for the parameter cqs (Command Queue Size). The cqs value must
| be multiplied with the maximum supported system blocksize to determine the size
| of memory that is allocated by ITDT. Supported copy operations are from tape to
tape, from image file to tape, and from tape to image file.
verify
Verifies the physical contents of two cartridges. The physical data layout and the
binary data are compared.
Parameters:
source destination
Source and destination can either a special device file name, or a tape image file
name. The special device file format is identical to the format specified in chapter
3.19 parameter -f.
Examples:
./itdt verify /dev/IBMtape0 /dev/IBMtape1
checkltfsreadiness
This subcommand issues the LTFS Readiness Check test.
The LTFS Readiness Check analyzes the Operating System and tape drive
environment to ensure that the IBM Linear Tape file system can be installed. This
test checks the Operating System version, the tape device driver version, the tape
drive firmware, and the LTFS HBA requirements. LTFS Readiness Check requires
an empty data cartridge.
ltfsdefragmentation
On an LTFS formatted cartridge, the physical data records for a single file can be
fragmented across the entire media. When such a file is accessed, a long response
time might result. The tape drive must locate to different cartridge positions to
retrieve the entire contents the file. If the first data records of a file are stored at
the end of the tape and the other records are stored at the beginning of the media,
the tape drive must run several times intensive seek operations to fulfill the
complete file retrieval. This subcommand creates a copy of the cartridge with
unfragmented content.
As an initial step, ITDT stores the complete content of the source tape media in a
Tape Image file that is on an HDD. Using this Tape Image file and the ITDT image
Parameters:
source tempdirectory destination [options]
Options:
-LTFSCOMMAND=<value> Command used to perform the LTFS mount operation (default:ltfs)
-MKLTFSCOMMAND=<value> Command used to format the destination media (default:mkltfs)
-LTFSCPCOMMAND=<value> Command used to perform the LTFS Copy (default:cp)
-LTFS_SRC_OPTION=<value> For mounting of ITDT Image File, additional Mount options
-LTFS_DEST_OPTION=<value> For mounting of destination cartridge, additional Mount options
-MKLTFSOPTION=<value> Additional options for mkltfs
-LTFSCPOPTION=<value> Options for LTFS file copy program (default:-r --preserve=mode,
ownership,timestamps,xattr)
-LTFSCPOPTION=<value> Options for LTFS file copy program(default:-r --preserve=mode,
ownership,timestamps,xattr)
-verbose Displays executed LTFS (ltfs,mkltfs, ltfscp) commands and
associated return code
-debug Displays detailed output of executed commands commands
Prerequirements: IBM LTFS SDE Version 2.2 (Build 4700 or later) and sufficient free
hard disk space for temporary Tape Image file
Example:
./itdt ltfsdegragmentation /dev/IBMtape0 /tmp/tapeimages
/dev/IBMtape1 -verbose -mkltfsoption=--force
standardtest
The Test function (Scan Menu Command [T]) checks if the tape device is defective
and outputs a pass/fail result. This test requires a loaded cartridge.
Parameters:
[-forcedataoverwrite]
fullwrite
Runs the ITDT Full Write Test (Scan Menu Command [F]).
The Full Write function writes the entire cartridge with a given block size either
with compressible or incompressible data and output performance data. This test
requires a loaded cartridge.
Parameters:
systemtest
Runs the ITDT Systemtest (Scan Menu Command [Y]).
The System Test is a short test that runs the following actions.
v Reveals system performance bottlenecks. Compressible data throughput values
can reveal bandwidth limitations that are caused by the system or cabling or
HBA.
v Measures performance variations across the different block sizes to find the ideal
block size for the system configuration.
This test requires a loaded cartridge.
Parameters:
[-forcedataoverwrite]
tapeusage
Displays the tapeusage information (Scan Menu Command [U]).
Parameters:
None
hdp discover
Discovers the HD-P system and presents the logical and physical HD-P
environment. The logical map is an n x n representation of the libraries, where a
“1” is the indicator for a connection and a “-1” of no connection. In case the
command is called without any device files, all attached TS3500/TS4500 are used.
Parameters:
[-d device-file1 -d device-file2 ....]
hdp senderror
Issues a Test Call Home function. In case the command is called without any
device file, all attached TS3500/TS4500 are used.
Parameters:
[-d device-file]
hdp show
Shows the extended HD-P Import Export Elements. In case the command is called
without any device file, all attached TS3500/TS4500 are used.
Parameters:
[-d device-file]
Deprecated commands
The following is a list of commands that are currently available in this version of
ITDT. However, in a future release the following commands and some alternate
calls of the Common Command Scripting set are no longer available and the
scripts that contain these commands must be changed. The scripts that use the
deprecated commands must be changed for future editions.
General commands
v -o dis / disablepath
v -o ena / enablepath
v fuser
v kill
v passthru
v resetpath
Tape commands
v bsfm
v -o chk
v fsfm
v -o grs
v -o gmi
v qryinquiry
v qrysense
v -o ret
v setblk
v -o gds
v getrecsize
v setrecsize
Requirements:
v Windows operating system
v IBM tape library with one or more tape drives
v IBM tape device driver or Generic SCSI driver
v Path variable must include ITDT executable
Usage: load-drive.cmd drivername|hbtl [drivenumber]
drivername is the device driver name assigned by the IBM device driver
hbtl is the associated SCSI address h=host, b=bus, T=target id and l=lun
drivenumber, logical drive number, default is 1
Example for using the SCSI Generic driver: load-drive.cmd "2 0 3 1"
load-drive.cmd:
@ECHO OFF
IF [%1]==[] (
echo.
echo Usage load-drive.cmd drivername^|hbtl [drivenumber]
echo.
echo drivername is the drivername assigned by the IBM device driver
echo example:load-drive.cmd \\.\Changer0
echo.
echo hbtl is the associated SCSI address h=host, b=bus, T=target id and l=lun
echo example: load-drive.cmd "3 0 2 1"
echo.
goto :EOF
)
set driveNumber=1
IF not [%2]==[] set driveNumber=%2
echo Loading/Unload Cartridge Drive:%driveNumber%
:checkline
set name=%1 %2
if "%name%"=="Drive Address" (
set /a count+=1
set currentTag=%name%
set driveAddress=%3
)
if "%name%"=="Source Element" (
if "%count%"=="%driveNumber%" if "%currentTag%"=="Drive Address"
if "%action%"=="unload" (
set destination=%5
)
)
if "%name%"=="Slot Address" (
set currentTag=%name%
set slotAddress=%4
)
GOTO:EOF
:moveMedium
echo %action% move media from %sourceAddress% to destination %destination%
itdt -f %~1 move %sourceAddress% %destination%
del inventory.txt
GOTO:EOF
When scripting, one must be aware of the following general deviations to the
legacy tapeutil scripting command set.
The Verbose Mode parameter is ignored for the ITDT-SE implementation; instead
always the full information is printed.
For some operations, the sense data length is limited to 32 bytes - this length is
required by the ITDT test sequences.
The list command does not work on Linux variants where the reported maximum
SCSI transfer size is larger than the size the system can actually transfer.
Because ITDT-SE opens the device read/write by default in scripting mode, the
WORM mode cannot be deactivated in scripting mode. Use the Tapeutil interactive
mode instead to deactivate the WORM mode.
ITDT-GE installer automatically uninstalls any previous version before the current
one is installed.
For the graphical user interface (GUI), a minimum screen resolution of 1024*768
pixels is required.
The ITDT-GE installer automatically uninstalls any previous version before the
current one is installed.
For the graphical user interface (GUI) a minimum screen resolution of 1024*768
pixels is required. The supported Linux operating systems for ITDT-GE are
v Linux Distributions with glibc 2.2.5 and higher.
On RedHat Enterprise Linux 4 and 5 and SuSE Enterprise Linux 10, starting the
online help might cause an error message Problems opening link / Unable to
open web browser on {0}. Workarounds are to issue the commands
a) ln -s /usr/bin/firefox /usr/local/bin/mozilla
or
b) export MOZILLA_FIVE_HOME=/usr/lib/firefox<version>
Replace with the appropriate path to your installed Firefox version before ITDT-GE
is started.
Gnome desktop
If you are using the Gnome desktop, be sure to log in to the desktop session as
root to use ITDT-GE to prevent device access issues.
Performance issues
If you are using Adaptec SCSI Host Bus Adapters, ensure that you are using the
latest Adaptec Host Bus Adapter Drivers instead of the drivers that are shipped
with the Windows operating system.
After a firmware update, devices might disappear. This issue is a known Windows
problem.
When a command timeout condition occurs, ITDT might still continue to run more
operations (like unmounting the cartridge) instead of instantly terminating with a
timeout condition.
Library Firmware Update with ITDT-GE is not supported by the 3576/TS3310 tape
library. Update the firmware by using the 3576/TS3310 Web User Interface.
Drives in a 3494 tape library or an STK silo library are supported. Only the Test
option does not work because of device-specific restrictions for handling cartridges.
To start ITDT-GE on Windows, click the shortcut that is created by the installation
process. On Linux, no start menu entry is generated. Start ITDT-GE by opening a
Terminal window, then switch to root user.
$ su -
The User Settings dialog box displays the first time that the program is run,
allowing the entry of user specifications: User name, company name, output path,
and log level.
The Output Path defines the location where the test reports and dumps are saved.
The Windows default output path is
C:\Documents and Settings\<username>\.itdt-ge\output
or
C:\Users\<username>\.itdt-ge\output
where <username> is the Windows user login name. The Linux default output
path is
/root/.itdt-ge/output
The Log Level must not be changed unless requested to do so by the IBM Support
Center. It is recommended that this information be provided to allow for further
analysis of test results.
a2500279
a2500239
Figure 53. Graphical Edition interface
v Main menu (▌1▐ on Figure 53)- in upper left (File, Window, Help) The following
main program menu items are available:
a2500264
v Control Center (▌2▐ on Figure 53) - On left side (Device operations - Scan, Test,
Dump, and Update)
Extra device operations are available by using drop-down arrows.
v Test Lab (▌3▐ on Figure 53) - Located from center to right side (Contains running
and previously run tests)
v Status Information (▌4▐ on Figure 53) - Located below the Test Lab (Contains
summary results of tests)
The following toolbar buttons for the device operations are available.
v Click the Scan menu item in the Control Center to display the list of tape
devices found. When the scan is complete, select one device in the Test Lab by
clicking the corresponding check box. Click the arrow next to the Scan menu
item to add a device manually.
v Test
Click the arrow next to the Test menu item to select an extended test.
v Dump
Click the arrow next to the Dump menu item to select more log options.
v Update
Click the Update menu item to start the firmware update. Click the arrow next
to the Update menu item to select Online update options.
v Config
Click the TCP/IP Port menu item to configure the TCP/IP port.
For each device on which the operation is started, a tab displays on the right panel
(Test Lab area). The tab contains the operation information and status. Only one
operation can be run at a time with ITDT-GE. The benefit in using tabs even for
the single operation mode is that you get a history of operations as for each
consecutive operation, a separate tab is opened.
Scan
a2500240
The scan function is used to discover all supported tape and library devices that
are attached to the computer system. Then, they can be selected for the subsequent
ITDT-GE operations. The scan function also serves as a connection test that can be
used to verify correct attachment of the devices.
Note: When Scan is pressed for the first time, a dialog box is displayed that warns
the user to stop all backup jobs.
When the scan is finished, the device list is displayed in the Control Center area.
A scroll bar is available to show all the devices. When the device you want is
displayed, select the device for test. Only one device can be selected.
a2500241
Figure 57. Test
| The Health Test function checks if the tape device is defective and outputs a
pass/fail result.
Attention:
1. The test functionality erases user data on the cartridge that is used for the test.
2. The test can take from 15 minutes up to 2 hours.
3. The test runs only on tape drives, not on autoloaders or libraries.
| To start the Health Test function, it is recommended that a new or rarely used
cartridge is used. Scaled (capacity-reduced) cartridges must not be used to test the
device.
To test tape drives within a library, the library must be in online mode.
| After the device is selected, start the Health Test function by selecting the Health
Test menu item.
| Note: It can take some time until the Health Test function stops.
a2500242
Figure 58. Test results
Note: Information can be found in the .txt/.blz files. See the log file section (▌1▐).
After you click Apply, the new values are set and the updated values display.
Note: Because earlier drive generations do not have an ethernet port, the
Configure TCP/IP Ports command is rejected for these devices with the following
message:
TCP/IP configuration is not supported on this product.
Dump
After the device you want to dump is selected, start the Dump function by
selecting Dump > Dump from the actions toolbar.
When the dump process is run on a tape library or autoloader other than the
3584/TS3500/TS4500, the Dump function stores 1 log file in the output folder of
the program (*.blz). For the 3584/TS3500/TS4500, a dump file (*.a) is stored in the
output folder. Both files start with the serial number of the device (▌1▐).
a2500225
Figure 60. Dump results
Note: When the Dump function is run for tape libraries or autoloaders other than
the 3584/TS3500/TS4500, the log file contains Log Sense and Mode Sense pages
only. A Drive or 3584/TS3500/TS4500 dump contains more diagnostic information.
(▌2▐)
Firmware Update
The Firmware Update upgrades the firmware of tape drives and tape libraries. See
“Supported equipment” on page 220 for a list of supported products.
Note: See “3576/TS3310 tape library” on page 231 for information on how to
update the firmware on a 3576/TS3310 tape library.
The following site is available for the latest firmware files: http://www.ibm.com/
storage/lto
The firmware update usually takes 3-5 minutes, but it can take up to 45 minutes
for libraries.
The program connects to IBM FixCentral and identify updates for the devices. If
the connection cannot be established or another problem occurred, the problem
description is shown at the bottom of "FixCentral" Test Tab.
a2500289
Figure 61. Check for Device Updates - FixCentral components
In the sample above, the drive has two FixCentral components. Each component
has several items; such as code files and textual meta information.
| The code files (binary files) have a "+" in the icon to distinguish and can be
downloaded either by double-clicking or by using the right mouse button. The text
files (for example, readme files) can be viewed in the same way. A separate Test
Tab is opened and the information shown.
For automation drives (drives in a library), both devices are used. A code level for
an automation drive is directly linked to a code level of a library.
Encryption
a2500226
Note: The test that is shown on the graphic was run on a non-encrypted device
and is showing a failure.
Note: It can take some time until the Encryption function stops.
Full Write
The Full Write function writes the entire cartridge with a specified block size either
with compressible or incompressible data and output performance data.
Attention:
1. The Full Write function erases data on the cartridge that is used for the test.
2. The Full Write function takes approximately 2 hours when incompressible data
is written, less time for compressible data.
3. The Full Write function runs only on tape drives, not on autoloaders or
libraries.
To run a full write on tape drives within a library, the library must be in online
mode.
1. After the device you want to write to is selected, start the Full Write function
by selecting Test > Full Write from the actions toolbar.
2. Click OK to start the full write.
3. ITDT-GE then shows the Full Write screen. If no cartridge is inserted, ITDT-GE
prompts you to insert a cartridge. Either insert a cartridge and click OK or stop
by clicking Abort.
a2500227
Figure 64. Overwrite data?
Click Yes to continue the test if you are sure that data on the cartridge can be
overwritten. If you are unsure, click No to stop the test.
4. The system prompts for entry of a transfer size between 16 KB and the
maximum block size that is supported by the system. Maximum value is 512
KB. Select the appropriate value for your system.
a2500228
5. Select the type of data to write, either [C] Compressible or [I] Incompressible.
The full write can be stopped by clicking Abort.
Note: It can take some time until the full write actually stops.
"Compressible = Yes" means that the data written was just zeros so that the
data can be compressed by the drive with a maximum compression ratio.
"Compressible = No" means that a data pattern was written that the drive
306 IBM Tape Device Drivers: Installation and User's Guide
almost cannot compress at all. If the compression ratio is 1, the drive was not
able to compress the data (equivalent to 1:1 compression ratio). If the
compression ratio is 94.0, the drive was able to do 94:1 compression. It means
that 94 bytes in the original data was compressed to 1 byte on the medium.
100.0 means 100 bytes is compressed down to 1 byte on the medium.
If all write operations are finished, ITDT-GE shows the performance statistics
for the selected block size that is written on the cartridge, in the Status
Information area. If an error occurred during the full write, data is only
partially written.
Tape Usage
The Tape Usage function retrieves statistical data and error counters from a
cartridge.
1. After the device you want to test is selected, start the Tape Usage function by
selecting Dump > Tape Usage Log from the actions toolbar.
2. ITDT-GE then shows the tape usage screen. If no cartridge is inserted, ITDT-GE
prompts you to insert a cartridge. Either insert a cartridge and click OK or stop
by clicking Abort.
System Test
The System Test is a short test that runs the following tests:
v Reveals system performance bottlenecks. Compressible data throughput values
can reveal bandwidth limitations that are caused by the system or cabling or
HBA.
v Measures performance variations across the different block sizes to find the ideal
block size for the system configuration.
After the device you want to test is selected, start the System Test function by
selecting Test > System Test from the actions toolbar.
ITDT-GE then shows the System Test screen. If no cartridge is inserted, ITDT-GE
prompts you to insert a cartridge. Either insert a cartridge and click OK or stop by
clicking Abort.
Note: If ITDT-GE detects data on the cartridge, it shows the following message -
Cartridge not empty!
Overwrite data?
Click Yes to continue the test if you are sure that data on the cartridge can be
overwritten. If you are unsure, click No to stop the test.
a2500230
After the device you want to test is selected, start the Library Self-Test function by
selecting Test > Library Diagnostic Self-Test from the actions toolbar.
At the end of the test, the results are shown in the Status Information area.
First, the test tries to read dump files from each drive that is installed from the
library. Then, you can select one drive for loading the cartridges.
All cartridges of the I/O and storage slots are moved - one after the other from
their source to the selected drive. A dump is taken and moved back to the source
address. In the result screen, the dumps taken and the count of dumps are shown.
If a tape drive cannot be identified by using a device scan, the user can manually
create a test record for the drive. The system prompts the user to run the SCSI/FC
Wrap test for the drive (see the service manual for the drive). The results of the
wrap test can be entered along with extra inspection information. The results are
saved into binary and text output files that have the same format as the output
files generated by the test.
1. From the Main Program menu, select File > Manual Record.
2. Enter the required information to complete the items in the screen.
a. Enter the device serial number.
b. Enter the content of the Message Display.
c. Optionally, enter any information text.
3. After all information is entered, click OK.
The information is stored in a binary file (which can be used for further
analysis), and in a human-readable text file. Both files are stored in the
ITDT-GE output folder.
Copy Services
With Copy and Migration Services, tape content can either be copied or moved
v From a cartridge to another cartridge
The tool offers different use cases like copying data or migrating data from one
generation to another. That is, data can be copied from a Gen4 cartridge to a Gen5
cartridge. Even migration from an LTO to IBM Enterprise Tape Systems is
supported. For an LTFS environment, the data can be copied or moved with the
LTFS Physical copy that adjusts the LTFS parameter on the target to be unique.
| Such a copy can be used in the same LTFS environment as the source. To ensure
| maximum performance for tape to tape copy actions, ITDT allocates a read buffer
| which calculates to 2500 multiplied by the maximum supported system blocksize.
| If the system does not provide this buffer, the operation is aborted with MEMORY
| ALLOCATION FAILED.
Verify
Verifies the physical contents of two cartridges. The physical data layout and the
binary data are compared.
Usage
By opening the "Copy Services" perspective, the user can run a 'Scan...' to discover
attached devices.
If the source and the target are selected, the Copy Services or a verification can be
started regarding the used Mode: “Tape Physical Copy” on page 310, “LTFS
Physical Copy” on page 310, or “Verify” on page 310.
| A Dump or a BLOB file can be opened either with the menu command File/Open
Log File or by switching to the Log Files perspective and pressing Open Log File
.... In both cases, a File Selection dialog opens where files can be selected for
| display. After the successful opening of a file, the data is shown.
Two views are available for presenting the data - each at a separate panel.
v The Event List shows the events of this file on the left side. An event is a group
of information and consists of 1 to n Elements shown on the right. By selecting
one event list entry on the left, the corresponding data (event elements) is shown
on the right.
v The Report panel offers the opportunity to generate a sublist of the available
'Event List' entries.
On the left, the Tapeutil Control Center tree contains all Tapeutil commands for
tape drives and tape libraries.
The commands from the General Commands and Service Aid Commands
categories are duplicated into the two sections (to make the GUI navigation easier).
After one category is expanded, the related commands open that allows users to
select the command.
a2500260
a2500261
Figure 72. Command parameter results
The Open command has a Scan ... button in the Parameter view. Pressing Scan...
runs a scan on the host and shows the attached devices in the Result View at the
bottom. This information is helpful to identify the right Device Name for the open
function field Device Name.
a2500287
This screen layout stays within the Tapeutil perspective until the program is
closed. Outputs of subsequent operations are added to the Results field.
Commands that fail are indicated with a red cross in the Status area. Commands
that succeed are indicated with a green check mark. The status area can be cleared
by pressing Clear.
General commands
v “Open” on page 316
v “Close” on page 316
v “Inquiry” on page 317
v “Test Unit Ready” on page 317
v “Reserve Device” on page 317
v “Release Device” on page 317
v “Request Sense” on page 317
v “Log Sense” on page 317
v “Mode Sense” on page 317
v “Query Driver Version” on page 317
v “Display All Paths” on page 317
Tape drive specific commands
v “Rewind” on page 318
v “Forward Space Filemarks” on page 318
v “Backward Space Filemarks” on page 318
v “Forward Space Records” on page 318
v “Backward Space Records” on page 318
v “Space to End of Data” on page 318
v “Read and Write Tests” on page 318
v “Read or Write Files” on page 320
v “Erase” on page 321
Note: When a command is issued in Tapeutil mode for ITDT GE, Execute must be
pressed before the action takes place.
Open
When you select the Open command:
1. ITDT checks if a device is already opened.
2. Under Device Name:, enter the name of the device in the box.
3. In the Open Mode menu, select how to open the device (rw, ro, wo, append).
4. ITDT opens the device that you selected.
Note: Always use the Read Only mode when you are working with
write-protected media.
Close
When you select the Close command
1. ITDT checks if the device is already closed.
2. ITDT closes the device.
Reserve Device
When you select the Reserve Device command, ITDT issues a reserve command
for the device.
Release Device
When you select the Release Device command, ITDT issues a release command for
the device.
Request Sense
When you select the Request Sense command
1. ITDT issues a Request Sense command.
2. ITDT then displays a decoded format of hexadecimal dump sense data and
prints hexadecimal dump sense data.
Log Sense
When you select the Log Sense command
1. Enter the page number, in hexadecimal, in the Page-Code field.
2. ITDT issues a Log Sense command and outputs a hexadecimal dump of that
page.
Mode Sense
When you select the Mode Sense command
1. Enter the page number, in hexadecimal, in the Page-Code field.
2. ITDT issues a Mode Sense command and outputs a hexadecimal dump of that
page.
Note: The default is a block size of 10240 bytes, a count of 20 blocks, and a
repetition of 1. If the block size is zero, variable mode is used. With a fixed block
size, a data amount of (block size * blocks) is transferred with a single operation.
This operation might get rejected if the total amount exceeds the transfer size of
the system.
The following steps are run, depending on which test is selected.
v The Read/Write steps:
1. Issues a Read Position.
2. Sets block size.
3. Generates special pattern.
Erase
When you select the Erase command, ITDT issues the (extrinsic) ioctl command.
Load Tape
ITDT issues a SCSI Load command to load a tape.
Unload Tape
When you select the Unload Tape command
1. ITDT issues the (extrinsic) ioctl command.
2. The tape rewinds and then unloads.
Write Filemarks
When you select the Write Filemarks command
1. In the Filemark-Count box, enter the number of filemarks to write.
2. ITDT issues the (extrinsic) ioctl command.
Synchronize Buffers
When you select the Synchronize Buffers command, ITDT issues the ioctl
command.
Query/Set Parameter
When you select the Query/Set Parameter command
1. ITDT shows the changeable parameters.
Note: The list of changeable parameters are operating system specific. For a list
of changeable parameters, refer to Table 56 on page 279.
2. Select from the list of parameters that can be changed by clicking the choice.
3. ITDT requests prompt for parameter value (if required).
4. ITDT requests safety prompt (if required).
5. ITDT issues the ioctl command.
Query/Set Position
When you select the Query/Set Position command
1. ITDT prints the current position and requests the new position.
Note: ITDT does not distinguish between logical and physical position. It
shows the current position and queries for the one to set, then sets the new
position.
2. Enter the block id for where the tape must go. This block id must be entered
in decimal. When the tape is set, the block id is printed in decimal with
hexadecimal in parentheses.
3. ITDT issues the Set Position ioctl and returns the pass or fail results.
4. ITDT prints decoded logical position details.
5. ITDT issues Query Physical Position ioctl command.
6. ITDT prints decoded physical position details.
Display Message
When you select the Display Message command
1. ITDT provides Parameter boxes in which you can enter 1 or 2 messages up to
8 characters.
Note: Display Message works only on drives that have a display pane, the 3590
and 3592 drives.
2. In the Type: menu, select which message (0 or 1) you want shown and if you
want it to flash. There is also an alternate (alt) selection that alternates between
messages.
3. ITDT issues the ioctl command.
4. ITDT prints the displayed message.
Element Information
When you select the Element Information command:
1. ITDT issues the ioctl command.
2. ITDT shows
v Number of robots
v First robot address
v Number of slots
v First slot address
v Number of I/E elements
v First element address
v Number of drives
v First drive address
Position to Element
When you select the Position to Element command:
1. In the Parameter boxes, the Transport element address must be entered, in
decimal (picker).
2. Insert the Destination element address in decimal.
3. ITDT issues the ioctl command.
Element Inventory
When you select the Element Inventory command:
1. ITDT issues the Element Info ioctl command.
2. ITDT issues the Element Inventory ioctl command.
3. ITDT displays decoded element inventory information.
Move Medium
When you select the Move Medium command:
1. Insert source element address into the Source element address box in Decimal.
2. Insert the first destination element address in decimal in the First destination
element address box.
3. Insert the second destination element address in decimal in the Second
destination element address box.
4. ITDT issues the ioctl command.
a2500272
Figure 75. Configure TCP/IP Ports command in the Graphical Edition
After you click Apply, the new values are set and the updated values display.
Note: Because earlier drive generations do not have an ethernet port, the
Configure TCP/IP Ports command is rejected for these devices with the following
message:
TCP/IP configuration is not supported on this product.
Dump/Force Dump/Dump
When you select the Dump/Force Dump/Dump command:
1. ITDT retrieves the dump.
2. ITDT issues the Force Dump command.
3. ITDT retrieves the second dump.
4. ITDT displays the name of stored dump files and the output directory where
they are stored. The dump filenames start with the serial number of the device.
Firmware Update
When you select the Firmware Update command, browse to the microcode file to be
used. ITDT runs the firmware update and displays progress status and result.
Note: See “3576/TS3310 tape library” on page 294 for information on how to
update the firmware on a 3576/TS3310 tape library.
Note:
v The latest driver has the highest number extension. Numeric sequence
numbers are in each level of the device and library driver. So, for example,
for AIX the number is Atape.11.7.5.0.bin. As newer levels of a driver are
released, a higher numeric sequence is assigned. When a driver is
downloaded, ITDT also appears as a recommended download if you
selected the option of co-requisites and prerequisite.
v As of January 31, 2012, each IBM client that accesses Fix Central (whether
through their employees or other authorized representatives) is required to
have an individual IBM ID to download fixes (some exemptions might
apply). The registration is quick and simple and provides users with a
customized experience to better serve their needs.
8. After you click Continue, you can choose the way that you want to download
the fix or fixes. You can either use your browser (HTTP), the Download
Director (http://www6.software.ibm.com/dldirector/doc/
DDfaq_en.html#Q_A1), or bulk FTP option. The bulk FTP option is a web
service where you can download a package with the FTP command or other
download commands like WGET.
Note:
v To use the Download Director, ensure that the Java Runtime Environment is
installed on your computer. For information, see http://
www6.software.ibm.com/dldirector/doc/DDfaq_en.html. Leave the check
box for prerequisites and co-requisites selected. Click Continue.
Note: Some plain text files might require you to right-click, then select Save
Link As... to download the file.
Platform-specific help
If the problem persists after these procedures are followed, it is possible that an
unexpected condition occurred in the driver’s environment. In this case, contact
your IBM service representative (1-800-IBM-SERV) and provide the following
information to help IBM re-create and resolve the problem:
1. Machine type and model of your IBM tape product
2. Specific driver version
3. Description of the problem
4. System configuration
5. Operation that was running at the time the problem was encountered
If you are having trouble with your hardware, IBM service personnel ask what
level of microcode you have on your hardware. If they believe that you need a
new level of microcode, they might instruct you to install a newer level of
microcode on your hardware. They can provide you with updated microcode.
You can query the current level of microcode by issuing commands on the front
panel of your hardware. Consult the appropriate hardware reference manual for
specific instructions on querying your microcode level.
If your device is connected to a host system that has device or library support, you
can also query the last 4 digits of the current level of microcode with software.
Refer to Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 217. The unit must
be powered On, configured properly, and ready. For information, refer to the
appropriate chapter in this document (based on the operating system/platform) for
details on how to have the device ready.
Any references to an IBM program or other IBM product in this publication is not
intended to state or imply that only IBM’s program or other product may be used.
Any functionally equivalent program that does not infringe any of IBM’s
intellectual property rights may be used instead of the IBM product. Evaluation
and verification of operation in conjunction with other products, except those
expressly designed by IBM, is the user’s responsibility.
IBM may have patents or pending patent applications covering subject matter in
this document. The furnishing of this document does not give you any license to
these patents. You may send license inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other
country (or region) where such provisions are inconsistent with local law:
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
"Copyright 1992, 1993, 1994, 1997 Henry Spencer. All rights reserved. This software
is not subject to any license of the American Telephone and Telegraph Company or
of the Regents of the University of California.
Permission is granted to anyone to use this software for any purpose on any
computer system, and to alter it and redistribute it, subject to the following
restrictions:
1. The author is not responsible for the consequences of use of this software, no
matter how awful, even if they arise from flaws in it.
2. The origin of this software must not be misrepresented, either by explicit claim
or by omission. Since few users ever read sources, credits must appear in the
documentation.
3. Altered versions must be plainly marked as such, and must not be
misrepresented as being the original software. Since few users ever read
sources, credits must appear in the documentation.
4. This notice cannot be removed or altered.
Trademarks
Intel, Itanium, and Pentium are trademarks of Intel Corporation in the United
States, other countries (or regions), or both.
Java and all Java-based trademarks are trademarks of Oracle, Inc. in the United
States, other countries, or both.
Microsoft, Windows, Windows NT, and Windows 2000 are trademarks of Microsoft
Corporation in the United States, other countries (or regions), or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries (or regions).
Other company, product, and service names may be trademarks or service marks
of others.
V
Verifying device attachment 331
verifying the install/update 199
Virtual Tape Server Subsystem
Attachment 182
volume categories 177, 180
volume ID for logging 29
W
Windows (IBMtape) 149
Windows 3494 Enterprise Tape
Library 209, 210, 211, 215
Windows device driver 149, 150
Windows NT 149
Windows system-managed
encryption 156
Index 339
340 IBM Tape Device Drivers: Installation and User's Guide
Readers’ Comments — We'd Like to Hear from You
IBM Tape Device Drivers
Installation and User's Guide
We appreciate your comments about this publication. Please comment on specific errors or omissions, accuracy,
organization, subject matter, or completeness of this book. The comments you send should pertain to only the
information in this manual or product and the way in which the information is presented.
For technical questions and information about products and prices, please contact your IBM branch office, your
IBM business partner, or your authorized remarketer.
When you send comments to IBM, you grant IBM a nonexclusive right to use or distribute your comments in any
way it believes appropriate without incurring any obligation to you. IBM or any other organizations will only use
the personal information that you supply to contact you about the issues that you state on this form.
Comments:
Name Address
Company or Organization
_ _ _ _ _ _ _Fold
_ _ _and
_ _ _Tape
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Please
_ _ _ _ _do
_ _not
_ _ staple
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Fold
_ _ _and
_ _ Tape
______
NO POSTAGE
NECESSARY
IF MAILED IN THE
UNITED STATES
IBM Corporation
Building 9032-2 Department GZW
Information Development
9000 South Rita Road
Tucson, AZ
USA 85744-0002
_________________________________________________________________________________________
Fold and Tape Please do not staple Fold and Tape
Cut or Fold
GC27-2130-21 Along Line
IBM®
Printed in USA
GC27-2130-21