IBM Tape Device Drivers

IBM Tape Device Drivers
Installation and User’s Guide
GC27-2130-09
GC27-2130-09
Note!
Before using this information and the product that it supports, be sure to read the general information under “Notices” on
page 323.
Tenth Edition (March 2010)

This ninth edition of the IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-09, replaces and makes
obsolete the following manuals:
v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-08
v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-01.
v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-00.
v IBM TotalStorage and System Storage Tape Device Drivers Installation and User’s Guide, GC35-0154-17.
v IBM Ultrium Device Drivers Installation and User’s Guide, GC32-0430-13
© Copyright IBM Corporation 2007, 2010.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Figures . . . . . . . . . . . . . . . v Chapter 5. Linux Tape and Medium
Changer Device Driver . . . . . . . . 91
Tables . . . . . . . . . . . . . . . vii Purpose . . . . . . . . . . . . . . . 91
Data Flow . . . . . . . . . . . . . . . 91
Preface . . . . . . . . . . . . . . . ix Product Requirements . . . . . . . . . . . 92
Related Information . . . . . . . . . . . . ix Installation and Configuration Instructions . . . . 94
How to Send Your Comments . . . . . . . . xiv Tape Drive, Media, and Device Driver Parameters 99
Special Printing Instructions . . . . . . . . . xv Special Files . . . . . . . . . . . . . . 104
Control Path Failover Support for Tape Libraries 106
Data Path Failover and Load Balancing Support for
Chapter 1. Introduction . . . . . . . . 1 Tape Drives . . . . . . . . . . . . . . 108
Purpose . . . . . . . . . . . . . . . . 1 Open Source Device Driver - lin_tape . . . . . 110
IBM Tape Products . . . . . . . . . . . . 1 System-Managed Encryption . . . . . . . . 111
Problem Determination . . . . . . . . . . 114
Chapter 2. Common Extended Features 9
Purpose . . . . . . . . . . . . . . . . 9 Chapter 6. Solaris Tape and Medium
Supported Hardware . . . . . . . . . . . 9
Changer Device Driver . . . . . . . 121
Supported Applications. . . . . . . . . . . 9
Purpose . . . . . . . . . . . . . . . 121
Path Failover and Load Balancing . . . . . . . 9
Data Flow . . . . . . . . . . . . . . 121
Dynamic Load Balancing . . . . . . . . . . 13
Product Requirements . . . . . . . . . . 122
Supported Devices and Feature Codes . . . . . 13
Installation and Configuration Instructions . . . 124
Data Encryption . . . . . . . . . . . . . 14
Special Files . . . . . . . . . . . . . . 145
Persistent Naming Support . . . . . . . . . 149
Chapter 3. AIX Tape and Medium Control Path Failover Support for Libraries . . . 150
Changer Device Driver . . . . . . . . 21 Data Path Failover and Load Balancing Support for
Purpose . . . . . . . . . . . . . . . 21 Tape Drives . . . . . . . . . . . . . . 151
Data Flow . . . . . . . . . . . . . . . 22 System-Managed Encryption . . . . . . . . 154
Product Requirements . . . . . . . . . . . 22 Problem Determination . . . . . . . . . . 155
Installation and Configuration Instructions . . . . 24
Tape Drive, Media, and Device Driver Parameters 26 Chapter 7. Windows Tape and Medium
Special Files . . . . . . . . . . . . . . 33
Changer Device Driver . . . . . . . 163
Purpose . . . . . . . . . . . . . . . 163
Control Path Failover Support for Tape Libraries . . 36
Data Flow . . . . . . . . . . . . . . 163
Product Requirements . . . . . . . . . . 164
Tape Drives . . . . . . . . . . . . . . 38
Installation and Configuration Instructions . . . 165
System-Managed Encryption . . . . . . . . 40
Persistent Naming Support on Windows Server
2003 and Windows Server 2008 . . . . . . . 169
Tape Drive Service Aids . . . . . . . . . . 47
Control Path Failover Support for Tape Libraries 170
Performance Considerations . . . . . . . . . 49
Data Path Failover Support for Tape Drives . . . 170
System-Managed Encryption . . . . . . . . 172
Chapter 4. HP-UX Tape and Medium Problem Determination . . . . . . . . . . 173
Changer Device Driver . . . . . . . . 53
Purpose . . . . . . . . . . . . . . . 53 Chapter 8. 3494 Enterprise Tape
Data Flow . . . . . . . . . . . . . . . 53
Library Support . . . . . . . . . . 177
Product Requirements . . . . . . . . . . . 54
Purpose . . . . . . . . . . . . . . . 177
Installation and Configuration Instructions . . . . 56
MTLIB Program . . . . . . . . . . . . 178
Supported Configuration Parameters . . . . . . 73
MTEVENT Program . . . . . . . . . . . 189
Special Files . . . . . . . . . . . . . . 77
Library Driver Information . . . . . . . . . 189
3494 Library Emulation . . . . . . . . . . 193
Control Path Failover Support for Tape Libraries . . 79
AIX . . . . . . . . . . . . . . . . 196
HP-UX . . . . . . . . . . . . . . . 205
Tape Drives . . . . . . . . . . . . . . 81
Linux . . . . . . . . . . . . . . . . 212
Solaris . . . . . . . . . . . . . . . . 218
Windows . . . . . . . . . . . . . . . 224
© Copyright IBM Corp. 2007, 2010 iii

Chapter 9. IBM Tape Diagnostic Tool Graphical Edition - Tapeutil Menu Commands . . 303
(ITDT). . . . . . . . . . . . . . . 231
Purpose . . . . . . . . . . . . . . . 232 Appendix A. Accessing
Accessing ITDT . . . . . . . . . . . . 234 Documentation and Software Online . 317
Supported Systems . . . . . . . . . . . 234
Supported Equipment . . . . . . . . . . 235 Appendix B. Verifying Proper
Standard Edition - Installation . . . . . . . . 236
Attachment of Your Devices . . . . . 319
Standard Edition - Initial Startup . . . . . . . 240
Standard Edition - Known Issues and Limitations 243
Standard Edition - Start Menu Commands . . . 246 Appendix C. Managing the Microcode
Standard Edition - Scan Menu Commands. . . . 247 on the IBM Tape Drive . . . . . . . 321
Standard Edition - Tapeutil Menu Commands . . 263
Standard Edition - Tapeutil Scripting Commands 271 Notices . . . . . . . . . . . . . . 323
Graphical Edition - Installation . . . . . . . 287 Trademarks . . . . . . . . . . . . . . 324
Graphical Edition - Known Issues and Limitations 288
Graphical Edition - User Interface Description . . 289
Index . . . . . . . . . . . . . . . 325
Graphical Edition - Scan Menu Commands . . . 292
iv IBM Tape Device Drivers Installation and User’s Guide

Figures
1. Current Attachment Array . . . . . . . . 2 45. Configure a Defined LMCP COMMAND
2. Example of an IBM Tape Environment . . . . 3 STATUS Window . . . . . . . . . . 202
3. Multiple HBA and multi-port devices . . . . 10 46. Data Flow for HP-UX 3494 Enterprise Tape
4. Multiple HBA and single ports . . . . . . 11 Library Driver . . . . . . . . . . . 206
5. Single HBA and multi-port devices. . . . . 12 47. Data Flow for Linux 3494 Enterprise Tape
6. Sample Encryption Configuration File. . . . 17 Library Driver . . . . . . . . . . . 213
7. Data Flow for AIX Device Driver (Atape) 22 48. Data Flow for Solaris 3494 Enterprise Tape
8. Data Path for AIX Device Driver (Atape) 50 Library Driver . . . . . . . . . . . 219
9. Data Flow for HP-UX Device Driver (ATDD) 54 49. Data Flow for Windows 3494 Enterprise Tape
10. Example of atdd_d.log Output . . . . . . 87 Library Driver . . . . . . . . . . . 225
11. Data Flow for Linux Device Driver (lin_tape) 92 50. Welcome/Startup screen . . . . . . . . 237
12. Data Flow for Solaris Device Driver 51. License screen . . . . . . . . . . . 238
(IBMtape) . . . . . . . . . . . . . 122 52. Machine credentials screen . . . . . . . 238
13. Example of Control Path Failover Support 53. Installation progress screen . . . . . . . 239
Command Output . . . . . . . . . . 151 54. Installation complete screen . . . . . . . 239
14. Example of Data Path Failover Support 55. Start Screen Menu . . . . . . . . . . 246
Command Output . . . . . . . . . . 153 56. Scan Menu . . . . . . . . . . . . 247
15. Data Flow for Windows Device Driver 57. More Scan Options. . . . . . . . . . 248
(IBMmag) . . . . . . . . . . . . . 163 58. Device List Screen . . . . . . . . . . 249
16. Installation Application in Windows Explorer 167 59. Data Delete Question . . . . . . . . . 251
17. Windows Logo Testing screen . . . . . . 168 60. Test Running. . . . . . . . . . . . 251
18. Checked folder . . . . . . . . . . . 174 61. Test Results . . . . . . . . . . . . 252
19. Syntax Diagram for mtlib program . . . . 178 62. Dump . . . . . . . . . . . . . . 253
20. Device Query . . . . . . . . . . . 181 63. Firmware Update screen . . . . . . . . 254
21. Volume Query . . . . . . . . . . . 181 64. Scrollable Data screen . . . . . . . . . 255
22. Expanded Volume Query . . . . . . . 182 65. Encryption Start screen . . . . . . . . 257
23. Expanded Volume Data with Usage . . . . 182 66. Full Write Results . . . . . . . . . . 259
24. Inventory Count Data. . . . . . . . . 182 67. Tape Usage Screen . . . . . . . . . . 260
25. Tape Library Device Number . . . . . . 183 68. System Test Results . . . . . . . . . 261
26. Expanded Tape Library Device List . . . . 183 69. Graphical Edition User Interface . . . . . 289
27. Library Data . . . . . . . . . . . . 184 70. Graphical Edition Preferences . . . . . . 290
28. Statistical Data . . . . . . . . . . . 185 71. Graphical Edition Interface . . . . . . . 291
29. Inventory Query . . . . . . . . . . 186 72. Main Program Menu Items . . . . . . . 291
30. Category Inventory Query . . . . . . . 187 73. Toolbar Buttons . . . . . . . . . . . 292
31. Reserve Category Command . . . . . . 188 74. Scan Function . . . . . . . . . . . 293
32. Reserve Category List . . . . . . . . . 188 75. Test Menu . . . . . . . . . . . . 294
33. Category Attribute List . . . . . . . . 188 76. Test Results . . . . . . . . . . . . 295
34. Library Address Information . . . . . . 189 77. Dump Menu . . . . . . . . . . . . 296
35. 3494/SMC Library Data Flow . . . . . . 193 78. Dump Results . . . . . . . . . . . 297
36. LIBSMC and OS Components . . . . . . 194 79. Encryption Function . . . . . . . . . 298
37. Data Flow for AIX 3494 Enterprise Tape 80. Overwrite Data . . . . . . . . . . . 300
Library Driver . . . . . . . . . . . 196 81. Transfer Size . . . . . . . . . . . . 300
38. SMIT Main Menu . . . . . . . . . . 200 82. Tape Usage . . . . . . . . . . . . 301
39. SMIT Devices Menu . . . . . . . . . 200 83. System Test . . . . . . . . . . . . 302
40. SMIT Tape Drive Menu . . . . . . . . 201 84. Tapeutil Control Center . . . . . . . . 304
41. Tape Drive Type Menu . . . . . . . . 201 85. Tape Drive Commands . . . . . . . . 305
42. Add an LMCP Logical Device Menu 201 86. Command Parameters . . . . . . . . 305
43. LMCP COMMAND STATUS Window 202 87. Command Parameter Results . . . . . . 306
44. Configure an LMCP Selection List . . . . 202
© Copyright IBM Corp. 2007, 2010 v

vi IBM Tape Device Drivers Installation and User’s Guide
Tables
1. Ultrium Product Comparison . . . . . . . 7 18. SCSI Supported Devices . . . . . . . . 123
2. Supported Devices and Feature Codes . . . 13 19. IBMtape Components . . . . . . . . . 124
3. Interoperability between IPv4 and IPv6 Clients 20. IBMtape Install or Update . . . . . . . 126
and Servers . . . . . . . . . . . . 17 21. Solaris Device Driver - IBMtape - Equipment
4. Feature Codes (Encryption) . . . . . . . 19 Listing Example 1 . . . . . . . . . . 127
5. Special Files for Tape Devices . . . . . . 33 22. Solaris Device Driver - IBMtape - Equipment
6. Special Files for Medium Changer Devices 34 Listing Example 2 . . . . . . . . . . 130
7. Error Description . . . . . . . . . . 51 23. Solaris Device Driver - IBMtape - Equipment
8. Device-Specific Parameter Definitions . . . . 74 Listing Example 3 . . . . . . . . . . 131
9. Driver-Specific Parameters (Global) . . . . 75 24. Solaris Device Driver - IBMtape - Equipment
10. Special Files . . . . . . . . . . . . 77 Listing Example 4 . . . . . . . . . . 131
11. New Special Files in HP-UX 11i v3 . . . . . 77 25. Configuration Parameters Recognized by
12. Trace Flags . . . . . . . . . . . . . 85 IBMtape . . . . . . . . . . . . . 141
13. Problems, Reasons, and Solutions . . . . . 87 26. IBM SCSI Tape/Medium Changer Special
14. Troubleshooting (Problems and Solutions) 89 Files for Solaris . . . . . . . . . . . 148
15. Components Created During lin_tape 27. Tracing Facility . . . . . . . . . . . 158
Installation . . . . . . . . . . . . . 94 28. Definitions of Abort Codes . . . . . . . 257
16. Special Files for IBM TotalStorage Tape 29. Supported Platforms . . . . . . . . . 281
Devices . . . . . . . . . . . . . 104 30. Driver Descriptions . . . . . . . . . 318
17. IBMtape and lin_tape Comparison . . . . 110
© Copyright IBM Corp. 2007, 2010 vii

viii IBM Tape Device Drivers Installation and User’s Guide
Preface
These publications and URLs provide user information and installation assistance
for IBM® tape drive, medium changer, and library device drivers.
Related Information
Reference material, including the Adobe® PDF version of this publication, is
available at the following url: http://www-01.ibm.com/support/
docview.wss?rs=577&uid=ssg1S7002972
A companion publication covering programming aspects for the device drivers is:
IBM Tape Device Drivers: Programming Reference, GA32-0566.
Current® Products
IBM TotalStorage Enterprise Tape System 3592 Publications
The following publications relate to the IBM TotalStorage® Enterprise Tape System
3592:
v IBM TotalStorage Enterprise Tape System 3592 Operator Guide, GA32-0465
v IBM TotalStorage Enterprise Tape System 3592 Introduction and Planning Guide,
GA32-0464
v IBM TotalStorage Silo Compatible Tape Frame 3592 Introduction, Planning, and User's
Guide, GA32-0463
v IBM TotalStorage Enterprise Tape System 3592 Hardware Reference, GA32-0466
IBM System Storage TS1120 Tape Drive

The following publications relate to the IBM System Storage® TS1120 Tape Drive:
v IBM System Storage TS1120 Tape Drive and Controller Introduction and Planning
Guide, GA32-0555
v IBM System Storage TS1120 Tape Drive and Controller Operator Guide, GA32-0556
v IBM System Storage TS3500 Tape Library Operator Guide, GA32-0560
v IBM System Storage TS3500 Tape Library Introduction and Planning Guide,
GA32-0559
v IBM System Storage 3953 Library Manager Model L05 Operator Guide, GA32-0558
v IBM System Storage 3953 Tape System Introduction and Planning Guide, GA32-0557
IBM Ultrium Tape Drive Models T800 and T800F

The following publications relate to the IBM Ultrium Tape Drive Models T800 and
T800F:
v IBM Ultrium Tape Drive Models T800 and T800F Setup, Operator, and Service Guide,
GC26-7697
IBM LTO Ultrium 3-H Tape Drive

The following publications relate to the IBM LTO Ultrium 3-H Tape Drive:
v IBM LTO Ultrium 3-H Tape Drive Setup, Operator, and Service Guide, SC23-5231

The following publications relate to the IBM System Storage TS2230 Tape Drive:
© Copyright IBM Corp. 2007, 2010 ix

v IBM System Storage TS2230 Tape Drive Setup, Operator, and Service Guide,
GC27-2099
v IBM System Storage TS2230 Tape Drive Installation Quick Reference, GC27-2100
IBM TotalStorage 3580 Tape Drive Models L33/L3H

The following publications relate to the IBM TotalStorage 3580 Tape Drive Models
L33/L3H:
v IBM TotalStorage 3580 Tape Drive Models L33/L3H Setup, Operator, and Service
Guide, GC26-7708
v IBM TotalStorage 3580 Tape Drive Models L33/L3H Quick Reference, GC26-7709

The following publications relate to the IBM System Storage TS2340 Tape Drive
[also known as IBM LTO4 (TS2340)]:
v IBM System Storage TS2340 Tape Drive Models L43/S43 Setup, Operator, and Service
Guide, GC27-2103
v IBM System Storage TS2340 Tape Drive Models L43/S43 Quick Reference Card,
GC27-2104
IBM System Storage TS3500 Tape Library (also known as IBM

TotalStorage UltraScalable Tape Library 3584)
The following publications relate to the IBM System Storage TS3500 Tape Library:
v IBM System Storage TS3500 Tape Library Planning and Operator Guide, GA32-0408
v IBM System Storage TS3500 Tape Library Maintenance Information, 19P2440
IBM Virtualization Engine TS7520

The following publications relate to the IBM Virtualization Engine TS7520:
v IBM Virtualization Engine TS7520 Hardware, Installation, Setup, and Problem
Determination Guide, GC26-7766-01
v IBM Virtualization Engine TS7520 Introduction and Planning Guide, GC27-2067-00
v IBM Virtualization Engine TS7500 User Guide, GC27-2068-00
IBM System Storage TS3400 Tape Library

v IBM System Storage TS3400 Tape Library Installation Quick Reference, GA32-0573
v IBM System Storage TS3400 Tape Library Planning and Operator Guide, GC27-2107
v IBM System Storage TS3400 Tape Library Maintenance Information, GA32-0572

v IBM System Storage TS3310 Tape Library Setup and Operator Guide, GA32-0477
v IBM System Storage TS3310 Tape Library Maintenance Information, GA32-0478
v IBM System Storage TS3310 Tape Library SCSI Reference, GA32-0476

v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Setup, Operator,
and Service Guide, GA32-0454
v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Installation Quick
Reference, GA32-0456
v IBM System Storage TS3100 Tape Library and TS3200 Tape Library SCSI Reference,
GA32-047
x IBM Tape Device Drivers Installation and User’s Guide

v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Setup, Operator,
v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Installation Quick
Reference, GA32-0456
v IBM System Storage TS3100 Tape Library and TS3200 Tape Library SCSI Reference,
GA32-047
AIX
The following URL points to information about IBM System p® (also known
asERserver pSeries®) servers:
http://www-1.ibm.com/servers/eserver/pseries
HP-UX
The following URL relates to HP HP-UX systems:
http://www.hp.com
Linux
The following URLs relate to Linux® distributions:
http://www.redhat.com
http://www.suse.com
Solaris
The following URL relates to Sun Solaris systems:
http://www.sun.com
Microsoft Windows
The following URL relates to Microsoft® Windows® systems:
http://www.microsoft.com
Legacy Products
IBM TotalStorage Ultrium External Tape Drive 3580
The following publications relate to the IBM TotalStorage Ultrium External Tape
Drive 3580:
v IBM 3580 Ultrium Tape Drive Setup, Operator, and Service Guide, GA32-0415
IBM TotalStorage Ultrium Tape Autoloader 3581

The following publication relates to the IBM TotalStorage Ultrium Tape Autoloader
3581:
v IBM 3581 Ultrium Tape Autoloader Setup, Operator, and Service Guide, GA32-0412
IBM TotalStorage 3581 Tape Autoloader (also known as IBM

TotalStorage Ultrium Tape 2U Autoloader 3581)
The following publication relates to the IBM TotalStorage 3581 Tape Autoloader:
v IBM 3581 Tape Autoloader Models L28/L38/L3H and F28/F38/F3H Setup, Operator,
Preface xi
IBM TotalStorage 3582 Tape Library (also known as IBM
TotalStorage Ultrium Tape Library 3582)
The following publications relate to the IBM TotalStorage 3582 Tape Library:
v IBM TotalStorage 3582 Tape Library Setup, Operator, and Service Guide, GA32-0458
IBM TotalStorage 3583 Tape Library (also known as IBM

TotalStorage Ultrium Scalable Tape Library 3583)
The following publications relate to the IBM TotalStorage Ultrium Scalable Tape
Library:
v IBM 3583 Tape Library Setup and Operator Guide, GA32-0411
v IBM 3583 Tape Library Service Guide, GA32-0425
v IBM Storage Area Network Data Gateway Module Setup, Operator, and Service Guide,
GA32-0436

The following publications relate to the IBM Virtualization Engine TS7510:
v IBM Virtualization Engine TS7510 Hardware, Installation, Setup, and Problem
Determination Guide, GC26-7766
v IBM Virtualization Engine TS7510 Introduction and Planning Guide, GC26-7767
v IBM Virtualization Engine TS7510 User Guide, GC26-7769
IBM TotalStorage Enterprise Automated Tape Library 3494

The following publications relate to the IBM TotalStorage Enterprise Automated
Tape Library (3494):
v IBM TotalStorage Enterprise Automated Tape Library (3494) Introduction and Planning
Guide, GA32-0448
v IBM TotalStorage Enterprise Automated Tape Library (3494) Operator Guide,
GA32-0449
v IBM TotalStorage 3494 Tape Library Maintenance Information, SA37-0407
IBM 3490E Tape Subsystem

The following publications relate to the IBM 3490E Tape Subsystem:
v IBM 3490 Magnetic Tape Subsystem Enhanced Capability Models C10, C11, C1A, C22,
and C2A Hardware Reference, GA32-0219
v IBM 3490 Magnetic Tape Subsystem Enhanced Capability Models E01 and E11 User’s
Guide, GA32-0298
v IBM 3490 Magnetic Tape Subsystem Enhanced Capability Models C10, C11, C1A, C22,
and C2A Maintenance Information, SA37-0299
v IBM 3490E Tape Subsystem, Models F01, F1, F11, and FC0, Installation, Planning, and
Operator's Guide, GA32-0378
IBM Magstar MP 3570 Tape Subsystem

The following publications relate to the IBM Magstar® MP 3570 Tape Subsystem:
v IBM Magstar MP 3570 Tape Subsystem Operator’s Guide, GA32-0345
v IBM Magstar MP 3570 Tape Subsystem Introduction and Planning Guide, GA32-0348
v IBM Magstar MP 3570 Tape Subsystem Hardware Reference, GA32-0365
v IBM Magstar MP 3570 Tape Subsystem Hardware Reference C-Series Models,
GA32-0394

The following publications relate to the IBM Magstar MP 3575 Tape Subsystem:
xii IBM Tape Device Drivers Installation and User’s Guide

v IBM Magstar MP 3575 Tape Library Dataserver Introduction and Planning Guide,
GA32-0380
v IBM Magstar MP 3575 Tape Library Dataserver Operator Guide, GA32-0381
v IBM Magstar MP 3575 Tape Library Dataserver Hardware Reference, GA32-0382
IBM TotalStorage Enterprise Tape System 3590

The following publications relate to the IBM TotalStorage Enterprise Tape System
3590:
v IBM TotalStorage Enterprise Tape System 3590 Introduction and Planning Guide,
GA32-0329
v IBM TotalStorage Enterprise Tape System 3590 Operator Guide, GA32-0330
v IBM TotalStorage Enterprise Tape System 3590 Hardware Reference, GA32-0331
v IBM TotalStorage Enterprise Tape System 3590 Operator’s Quick Guide, GA32-0354
IBM 7331 8mm Tape Library

The following publications relate to the IBM 7331 8mm Tape Library:
v IBM 7331 8mm Tape Library Installation Guide, SA26-7110
v IBM 7331 8mm Tape Library Operator Guide, SA26-7111
IBM 7332 4mm DDS-2 Tape Cartridge Autoloader

The following publications relate to the IBM 7332 4mm DDS-2 Tape Cartridge
Autoloader:
v IBM 7332 4mm DDS-2 Tape Cartridge Autoloader Model 005 Installation Guide,
SA26-7138
v IBM 7332 4mm DDS-2 Tape Cartridge Autoloader Model 005 Operator Guide,
SA26-7139
v IBM 7332 4mm DDS-2 Tape Cartridge Autoloader Model 005 Service Guide,
SA26-7140
IBM 7332 Model 220 External 4mm Tape Autoloader

The following publications relate to the IBM 7332 Model 220 External 4mm Tape
Autoloader:
v 7332 Model 220 4mm Tape Autoloader, Setup and Operator Guide, SA26-2005
v 7332 Model 220 4mm Tape Autoloader Service Guide, SY32-0408

The following publications relate to the IBM 7334 8mm Tape Library:
v 7334 Model 410 8mm Tape Library Setup and Operator Guide, SA26-2009
v 7334 Model 410 8mm Tape Library Service Guide, SY32-0412

The following publication relates to the IBM 7336 4mm Tape Library:
v IBM 7336 4mm Tape Library Model 205 Operator and Setup Guide, SA37-0309
IBM 3447 and 7337 Digital Linear Tape Library

The following publications relate to the IBM 3490E Tape Subsystem:
v 3447 and 7337 Digital Linear Tape Library Setup and Operator Guide, GA32-0399
v 3447 and 7337 Digital Linear Tape Library Service Guide, GA32-0400
v 7337 Model 360 Digital Linear Tape Library Setup and Operator Guide, SA41-0051
Preface xiii
Tru64
The following URL points to information about Tru64 systems:
http://www.hp.com
SGI
The following URL relates to SGI systems:
http://www.sgi.com
Other Publications
IBM Storage Area Network Data Gateway Installation and User's Guide, SC26-7304
Additional Information
The following publication contains additional information related to the IBM tape
drive, medium changer, and library device drivers:
v American National Standards Institute Small Computer System Interface
X3T9.2/86-109 X3.180, X3B5/91-173C, X3B5/91-305, X3.131-199X Revision 10H,
and X3T9.9/91-11 Revision 1
How to Send 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 Internet: [email protected]
v IBMLink from U.S.A.: STARPUBS at SJEVM5
v IBMLink from Canada: STARPUBS at TORIBM
v IBM Mail Exchange: USIB3VVD at IBMMAIL
v Fax from U.S.A., Canada, and other countries: 520-799-2906
xiv IBM Tape Device Drivers Installation and User’s Guide

Special Printing Instructions
This Tape Device Drivers Installation and User's Guide contains different sections
for each type of operating system/platform; for example, AIX®, Tru64, HP-UX,
Linux, Sun Solaris, Windows; and a separate section on these operating systems for
the 3494 Enterprise Tape Library.
Note: When selecting the page range for the section you wish 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.
Important printer note
This area indicates the Ignore the page number

pages that will actually appearing on the page itself
print in your specified when entering page ranges
range of pages. for your printer.
If you wish 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: There is only one Table of Contents and one Index for this entire book.
If you wish to print those items, you must repeat the process above, entering the
page range for the Table of Contents and the Index page range, respectively.
Preface xv
xvi IBM Tape Device Drivers Installation and User’s Guide
Chapter 1. Introduction
| This publication describes the IBM Tape and Medium Changer Device Drivers and
| IBM Tape Diagnostic Tool (ITDT) for various operating systems. Not all devices are
| supported by ITDT and all operating systems drivers. Refer to the specific chapters
for details.
Purpose
The IBM tape and medium changer device drivers are designed specifically to take
advantage of the features 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 demount), as well as 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. Please note that
some independent software vendor (ISV) applications have certain device driver
requirements. Before you install the device drivers, please refer to the ISV web site
for their support to find out what device drivers should be used for the ISV.
IBM Tape Products

The IBM Tape product family provides an excellent solution for customers with
small to large storage and performance requirements.
Current Products
Figure 1 on page 2 illustrates the attachment of various current products to an
open systems server.
© Copyright IBM Corp. 2007, 2010 1

Introduction
3
2
4
11
5
System
Storage
10
6
8
9
7
SystemSto
rage
dd000004
Figure 1. Current Attachment Array
1 Open Systems Server 7 IBM TS3200 Tape Library

2 IBM Virtualization Engine 8 IBM TS3500 Tape Library
TS7520/TS7530
3 IBM Virtualization Engine TS7650 9 IBM TS3310 Tape Library
4 IBM TS2230/TS2240/TS2250 Ultrium 10 IBM TS3400 Tape Library
3/4/5 Half-High Tape Drive
5 IBM TS2340/TS2350 (or 3580) Ultrium 11 IBM TS3100 Tape Library
3/4/5 Full-High Tape Drive
6 IBM TS1120/TS1130 Tape Drive [also
known as Enterprise]
Figure 2 on page 3 illustrates an Ultrium environment that could include an IBM

3583 Tape Library and an IBM TS3500 Tape Library.
2 IBM Tape Device Drivers Installation and User’s Guide

Introduction
Medium
IBM Changer
Tape Drive Robot
Open
Systems
Server Tape
IBM Cartridges
IBM Tape Library
Tape Drive
a250116
IBM Tape Device Driver
Figure 2. Example of an IBM Tape Environment

The IBM Virtualization Engine TS7520 product is a virtual-tape solution designed
to help optimize tape processing. Through the implementation of an integrated,
tiered storage hierarchy of disk and tape, the benefits of both technologies can be
leveraged to help enhance performance and provide the capacity needed for
today's tape processing requirements. Deploying this innovative offering can help
reduce batch processing time and management overhead.

Disk storage can be expensive, and simply increasing disk capacity year after year
is a no-win strategy. IBM Virtualization Engine TS7650 with ProtecTIER tackles the
problem by eliminating the abundance of redundant data creating more capacity in
the disks: up to 25 times more capacity. ProtecTIER, featuring HyperFactor
technology, uses powerful algorithms to filter out duplicate data so that only new
data items are stored. The result is superior inline performance, unmatched
scalability and enterprise data integrity. ProtecTIER employs blazing fast
performance, able to process up to 900 megabytes per second in a clustered
configuration, and it's done in-line, de-duplicating data in real time as it is written
to your back-up device.
IBM System Storage TS2230/TS2240/TS2250 Tape Drive

The IBM System Storage TS2230 Tape Drive Model H3L (Machine Type 3580,
Model H3L, SAP part number 3580L3E) is a high-performance, high-capacity
data-storage device that is designed to backup and restore open systems
applications. This model incorporates the Linear Tape Open (LTO) IBM Ultrium 3
Half-High Tape Drive. It is available with a Small Computer Systems Interface
(SCSI) or with a Serial Attached SCSI (SAS) interface. The drive has a native
storage capacity of 400 GB per cartridge (800 GB at 2:1 compression) on the
Ultrium 3 data cartridge.
The IBM System Storage TS2240 Tape Drive is an excellent tape storage solution
for businesses requiring backup or low-cost, real-time archival storage of their
data. The TS2240, with a half-high form factor, offers the same high capacity of
full-high LTO 4 tape drives. The TS2240 has a physical storage capacity of up to 1.6
TB (with 2:1 compression) in conjunction with the IBM System Storage LTO
Ultrium 800 GB data cartridge, which provides up to double the capacity of
Ultrium 3 cartridges. The native data transfer performance of the TS2240 Tape
Drive has increased over the previous LTO half-high generation to up to 120
MB/sec. The TS2240 Tape Drive continues to provide an excellent alternative to
Chapter 1. Introduction 3
Introduction
slower and smaller capacity 1/4-inch, 4 mm and 8 mm DLT/SDLT tape drives. The
TS2240 provides added security features by supporting encryption of data with 3
Gbps SAS connectivity.
| The IBM System Storage TS2250 Tape Drive is an excellent tape storage solution
| for businesses requiring backup or low-cost, real-time archival storage of their
| data. The TS2250, with a half-high form factor, offers the same high capacity of
| full-high LTO 5 tape drives. The TS2250 has a physical storage capacity of up to 3.0
| TB (with 2:1 compression) in conjunction with the IBM System Storage LTO
| Ultrium 1500 GB data cartridge for LTO5, which provides nearly double the
| capacity of IBM System Storage LTO Ultrium 800 GB data cartridge for LTO4. The
| native data transfer performance of the TS2250 Tape Drive has increased over the
| previous LTO half-high generation to up to 140 MB/sec. The TS2250 Tape Drive
| continues to provide an excellent alternative to slower and smaller capacity
| 1/4-inch, 4 mm and 8 mm DLT/SDLT tape drives. The TS2250 provides added
| security features by supporting encryption of data with 6 Gbps SAS connectivity.
IBM System Storage TS2340/TS2350 Tape Drive

The IBM System Storage TS2340 Tape Drive [also known as IBM LTO4] is a
high-performance, high-capacity data-storage device for the midrange open
systems environment. It is designed to increase maximum tape drive throughput
native data rate performance up to 120 MB/sec compared to the IBM LTO
generation 3 Tape Drive (Ultrium 3) at 80 MB/sec native data transfer rate. In
addition, with the use of the new IBM LTO Ultrium 800 GB Data Cartridge, the
Ultrium 4 Tape Drive doubles the tape cartridge capacity up to 800 GB native
physical capacity (1600 GB with 2:1 compression). It is available with Small
Computer System Interface (SCSI) or Serial Attached SCSI (SAS) interface. The
Ultrium 4 SAS Tape Drive is encryption-capable and designed to support
Application Managed Encryption.
| The IBM System Storage TS2350 Tape Drive [also known as IBM LTO5] is a
| high-performance, high-capacity data-storage device for the midrange open
| systems environment. It is designed to increase maximum tape drive throughput
| native data rate performance up to 140 MB/sec compared to the IBM LTO
| generation 4 Tape Drive (Ultrium 4) at 120 MB/sec native data transfer rate. In
| addition, with the use of the new IBM LTO Ultrium 1500 GB Data Cartridge, the
| Ultrium 5 Tape Drive doubles the tape cartridge capacity up to 1500 GB native
| physical capacity (3000 GB with 2:1 compression). It is available with Small
| Computer System Interface (SCSI) or Serial Attached SCSI (SAS) interface. The
| Ultrium 5 SAS Tape Drive is encryption-capable and designed to support
| Application Managed Encryption.
IBM TotalStorage 3580 (Ultrium) Tape Drive (Models L33 and

L3H)
The IBM TotalStorage 3580 Tape Drive Model L33/L3H offers high-capacity,
performance, and technology designed for the midrange open systems
environment. This model incorporates the Linear Tape Open (LTO) IBM
TotalStorage Ultrium Tape Drive (Generation 3), which more than doubles
maximum tape drive performance over the Generation 2 LTO Ultrium Tape Drive
(Ultrium 2). This tape drive comes with a SCSI Ultra160 LVD attachment, for
connection to a wide spectrum of open system servers.
The IBM LTO Ultrium 3-H Tape Drive and IBM LTO Ultrium 4 Half-High Tape
Drive are high-performance, high-capacity data-storage devices in a half-height
form factor that are designed to backup and restore open systems applications.
Both drives can be integrated into an enclosure, such as a desktop unit, tape

Introduction
autoloader, or tape library. They are available with a Small Computer Systems
Interface (SCSI) or with a Serial Attached SCSI (SAS) interface. The IBM LTO
Ultrium 3-H Tape Drive has a native storage capacity of 400 GB per cartridge (800
GB at 2:1 compression). The IBM LTO Ultrium 4 Half-High Tape Drive has a native
storage capacity of 800 GB per cartridge (1600 GB at 2:1 compression).
IBM System Storage TS1120/TS1130 Tape Drive (Enterprise)

The IBM System Storage TS1120 Tape Drive is the second generation of the 3592
tape drive. It provides higher levels of performance, reliability, and cartridge
capacity than the IBM TotalStorage Tape System 3590 and the 3592 tape drive. The
TS1120 tape drive has a dual-ported 4-Gbps Fibre Channel interface, Fibre Channel
attachment, and a new high-technology design that increases the native data rate
to 100 MB/sec.
The IBM System Storage TS1130 Tape Drive features storage capability to help you
establish easy access to data, better security, long-term retention and data
governance and regulatory compliance. The TS1130 tape drive offers
high-performance flexible data storage with support for data encryption.

The IBM System Storage TS3200 Tape Library Express Model offers high capacity
and performance technology for the midrange open systems environments. The
| TS3200 Tape Library is an external 4U standalone or rack-mountable unit that can
| house both IBM LTO Ultrium full and half high tape drives.
IBM System Storage TS3500 Tape Library (also known as IBM

TotalStorage UltraScalable Tape Library 3584)
The IBM System Storage TS3500 Tape Library is a highly scalable, automated tape
library combining IBM automation technology for midrange to enterprise open
systems environments. The TS3500 Tape Library supports logical partitioning and
can house both IBM LTO Ultrium and IBM TotalStorage Enterprise 3592 Tape
Drives (in separate frames). With scalability of one to sixteen frames and up to 192
tape drives, the TS3500 tape library can have an expanded available storage
capacity of over 5000 TB (with 3:1 compression) using TotalStorage Enterprise 3592
Tape Drives.

The IBM System Storage TS3310 Tape Library is a modular, scalable tape library
designed to scale vertically with expansion for Linear Tape Open (LTO) tape
cartridges, drives, and redundant power supplies. The base library module, model
L5B, is the entry point for the product family. It contains all of the necessary
robotics and intelligence to manage the 5U high library system, which houses up
to 36 cartridges (30 storage slots and 6 Input/Output slots) and two LTO
generation 3 tape drives. The TS3310 model L5B can be expanded with the
addition of expansion units, the model E9U. Each model E9U contains 92 physical
LTO cartridge storage cells and space for up to four LTO generation 3 tape drives.
Additionally, the E9U has space for up to two (one redundant) power supply
modules (At least one power supply module must be installed if a drive is present
in the E9U).

The IBM System Storage TS3400 TAPE LIBRARY is designed to offer high
performance drive technology and automation for the open systems environment.
The TS3400 Tape Library is an addition to the family of IBM System Storage tape
library offerings. The TS3400 Tape Library is an external 5U stand-alone or
rack-mountable unit that incorporates up to two IBM System Storage TS1120 Tape
Introduction
Drives Model 3592-E05 (Machine Type 3592, Model E05), which are ordered
separately. It comes with 4 Gbps dual-ported switched fabric Fibre Channel
attachment. The TS1120 Tape Drive has a native data transfer rate of up to 100
MB/ sec. per drive.

The IBM System Storage TS3100 (Machine Type 3573) Tape Library provides a
compact, high-capacity, low-cost solution for simple, unattended data backup. This
unique design houses up to 22 tape cartridges in a compact 2U form factor with
easy access to tape cartridges via two removable magazines and an Input/Output
(I/O) Station.
Legacy Products
IBM TotalStorage Ultrium Scalable Tape Library 3583
The IBM TotalStorage Ultrium Scalable Tape Library 3583 is an automated tape
library that incorporates IBM Ultrium tape drives in either a stand alone or
optional rack mount configuration. Three different library models are available
with storage capacities of 18 through 72 slots and one to six Ultrium tape drives.
The IBM TotalStorage Ultrium Scalable Tape Library 3583 can be used for save,
restore and mass storage archives where multi-terabyte capacities are required.
IBM TotalStorage Ultrium Tape Library 3582

The IBM TotalStorage Ultrium Tape Library 3582 is an entry tape library
incorporating high-performance IBM TotalStorage Ultrium generation 2 Tape
Drives for the midrange open systems environment. It can accommodate one or
two Ultrium generation 2 Tape Drives and comes standard with a one-cartridge
I/O station and 23 data cartridge slots giving a native library capacity of 4.8 TB
uncompressed native storage.
IBM TotalStorage Ultrium Tape 2U Autoloader 3581

The Ultrium Tape 2U Autoloader 3581 is an external 2U stand-alone or
rack-mountable unit that incorporates a single IBM LTO Ultrium 2 tape drive. The
Ultrium Tape 2U Autoloader 3581 capacity is eight tape cartridges, providing a
media capacity of up to 1.6 TB (3.2 TB with 2:1 compression) data storage per unit.
The Model L28 comes with a LVD Ultra160 SCSI attachment, while the Model F28
comes with a Native Switched Fabric Fibre Channel attachment, for connection to a
wide spectrum of open systems servers.
IBM TotalStorage Ultrium Tape Autoloader 3581

The IBM TotalStorage Ultrium Tape Autoloader 3581 is an external, stand-alone, or
rack-mounted tape autoloader that incorporates one IBM Ultrium Tape Drive. The
autoloader has seven storage slots giving the autoloader up to 1,400 GB of
uncompressed data storage. The autoloader can be used with compatible software
applications to automate backup/recovery or other data storage activities.
IBM TotalStorage Ultrium External Tape Drive 3580

The IBM TotalStorage Ultrium External Tape Drive 3580 is a stand alone, large
capacity, high performance tape drive that adheres to the Linear Tape Open (LTO)
specifications and supports the IBM Ultrium format tape. The drive supports
native tape capacities of up to 200 GB with uncompressed data transfer rates of up
to 35 MB per second. With both Low Voltage Differential (LVD) Ultra-2 SCSI and
High Voltage Differential (HVD) Ultra SCSI attachments, this device is suitable for
a variety of save, restore, and archiving requirements for PC and Open Systems
operating systems.

Introduction
StorageSmart by IBM Ultrium Products

The StorageSmart by IBM Ultrium family of products is compatible with the IBM
branded versions of the Ultrium family products. In this manual, where there is no
specific mention of the StorageSmart by IBM Ultrium branded set of products, the
documentation pertaining to the IBM branded family of products should be used.
Table 1 cross references the StorageSmart by IBM Ultrium product set to the IBM
Ultrium product set.
Table 1. Ultrium Product Comparison
StorageSmart by IBM Ultrium IBM Version of Ultrium
StorageSmart by IBM Ultrium External Tape IBM TotalStorage Ultrium External Tape
Drive TX200 Drive 3580
StorageSmart by Ultrium Tape Autoloader IBM TotalStorage Ultrium Tape Autoloader
SL7 3581
StorageSmart by Ultrium Scalable Tape IBM TotalStorage Ultrium Scalable Tape
Library SL72 Library 3583
No equivalent in the IBM Ultrium product IBM TotalStorage UltraScalable Tape Library
set 3584
IBM TotalStorage Enterprise Automated Tape Library 3494

The IBM TotalStorage Enterprise Automated Tape Library 3494 is an automated
tape library, providing an automated tape solution to a variety of system
environments. It provides a solution for automating tape operations such as
save/restore, migration of data between direct access storage devices (DASD) and
tape, and other mass data applications.
IBM TotalStorage Enterprise Tape System 3590

The IBM TotalStorage Enterprise Tape System 3590 consists of a tape drive
combined with an automatic cartridge facility (ACF). In addition to the functions
that the ACL or CSL provide for the IBM 3490E Magnetic Tape Subsystem, the
ACF on the Enterprise Tape System 3590 can operate as an integrated medium
changer device to provide random access of cartridges in the magazine cells under
program control.
Note: The 3590 drive has two Fibre Channel addressing modes. When attaching an
open systems server to a 3590 Fibre Channel drive, you must use the hard
addressing mode. When attaching a 3590 drive directly to a host (without a
switch), use lower addresses for hosts and higher addresses for drives.
IBM TotalStorage Virtual Tape Server (Models B10, B18, and B20)
The IBM TotalStorage Virtual Tape Server (VTS) product delivers an increased level
of storage capability to the traditional storage product hierarchy. To the host
software, a VTS subsystem looks like a 3490E Enhanced Capability Tape Subsystem
with associated Cartridge System Tape or Enhanced Capacity Cartridge System
Tape.

The IBM Magstar MP 3570 Tape Subsystem consists of one or two tape drives
(depending on the model) integrated with a full capability medium changer robotic
facility, which provides random access of cartridges in the storage cells under
program control.
Introduction
IBM Magstar MP 3575 Tape Library Dataserver

The IBM Magstar MP 3575 Tape Library Dataserver is a scalable family of
high-performance tape libraries that use the IBM Magstar MP tape drives. The IBM
device drivers control both the Magstar MP tape drives and the robotic cartridge
handling mechanism in these tape libraries that instructs the robot to mount and
demount the cartridges.

The IBM Virtualization Engine TS7510 product delivers and increased level of
storage capability to the traditional storage product hierarchy. To the host software,
the IBM Virtualization Engine TS7510 looks like a 3584 library with associated tape
drives.
IBM 3490E Magnetic Tape Subsystem

The IBM 3490E Magnetic Tape Subsystem consists of one or two tape drives
(depending on the model) combined with an automatic cartridge loader (ACL) or
cartridge stack loader (CSL). The ACL or CSL can load the next tape from the
cartridge stack into the tape drive either automatically when a tape is unloaded, or
when the tape drive is under program control.
IBM 7332 4mm Tape Cartridge Autoloader

The IBM Magstar MP 3575 Tape Library Dataserver is a scalable family of
high-performance tape libraries that use the IBM Magstar MP tape drives. The IBM
device drivers control both the Magstar MP tape drives and the robotic cartridge
handling mechanism in these tape libraries that instructs the robot to mount and
demount the cartridges.
IBM 7331, 7334, 7336, or 7337 Tape Medium Changer

The IBM 7331 and 7334 products are 8mm Tape Medium Changer Library devices.
The IBM 7336 product is a 4mm Tape Medium Changer Library device. The IBM
7337 product is a DLT Tape Medium Changer Library device. The AIX Enhanced
Device Driver controls the robotic cartridge handling mechanism in these tape
libraries that instructs the robot to mount and demount the cartridges. Access to
the tape drives within these libraries is through the native operating system AIX
Tape Device Driver.

Chapter 2. Common Extended Features
Purpose . . . . . . . . . . . . . . . . 9 Supported Devices and Feature Codes . . . . . 13
Supported Hardware . . . . . . . . . . . 9 Data Encryption . . . . . . . . . . . . . 14
Supported Applications. . . . . . . . . . . 9 Tape and Library Requirements. . . . . . . 14
Path Failover and Load Balancing . . . . . . . 9 Planning for Application-Managed Tape
Automatic Failover . . . . . . . . . . . 10 Encryption . . . . . . . . . . . . . 15
Multiple HBA and Multi-Port Devices . . . . 10 Planning for System-Managed Tape Encryption 16
Multiple HBA and Single Ports . . . . . . . 10 Planning for Library-Managed Tape Encryption 18
Single HBA and Multi-Port Devices . . . . . 12 Feature Codes (Encryption) . . . . . . . . 19
Dynamic Load Balancing . . . . . . . . . . 13
Purpose
This chapter provides general information about the IBM Device Drivers. Refer to
the specific operating system chapters for details on device support.
Supported Hardware
| The tape drivers are developed to support various versions of different platforms.
| For details on supported tape attachment please refer to the System Storage
| Interoperation Center website at
| http://www.ibm.com/systems/support/storage/config/ssic/
Supported Applications
If you use a third party application, consult with your application provider as to
the compatibility with IBMtape.
ftp://service.boulder.ibm.com/storage/tape/lto_isv_matrix.pdf
For detailed 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
317.
Path Failover and Load Balancing

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 alternate physical path when a permanent error occurs
on one path.
2. Dynamic load balancing for tape devices using multiple Host Bus Adapters
(HBA).
Path Failover is supported on certain tape products with the latest IBM device
drivers available on the following website:
www.ibm.com/support/fixcentral
Instructions for downloading drivers can be found in Appendix A, “Accessing

Documentation and Software Online,” on page 317. Some devices require a path
failover feature code to be installed prior to enabling the path failover support in
the device driver. Refer to Table 2 on page 13 for a list of supported devices and
what path failover feature code may be required for your machine type.

Path Failover
Automatic Failover
The automatic failover support provides error recovery on an alternate path when
a permanent error occurs on the primary path. This is transparent to the running
application. There are two types of Path Failover, Data Path Failover (DPF) and
Control Path Failover (CPF). They are closely related however the difference is that
DPF is an automatic failover support for the transfer of data, which provides error
recovery for systems connected to tape drives while CPF is an automatic failover
support for the transfer of commands to move tape cartridges. Below are examples
of different configurations that can be constructed.
Multiple HBA and Multi-Port Devices

Consider a multipath connection that consists of two Host Bus Adapters (HBA)
connected through a fabric to a multi-port device. By having two connections from
each device to the fabric, a configuration of four different physical paths can be set
up. e.g. HBA A to port 1, HBA A to port 2, HBA B to port 1, and HBA B to port 2.
One path is the primary path and the other three would be alternate paths. If the
primary path should have a failure, the Automatic Failover would try switching to
another configured path. Without path failover support, if a permanent path error
occurs (because of an HBA or cable failure, for example), the application fails.
However should that occur with this configuration there would still be two valid
physical paths for the data to be transmitted on and the running application
wouldn’t be affected.
Mulit-Port Drive
(DPF)
Dual HBA
X Library
(CPF) Drive
Library
Fabric X Drive
Controller
Drive
X Virtual Tape Library

(DPF and CPF) a2500255
Figure 3. Multiple HBA and multi-port devices
Multiple HBA and Single Ports

For another example, consider the same multipath connection that consists of two
Host Adapters connected through a fabric to a single port device. This
configuration would supply two physical paths to the same device, however, if the
port or cable from the device fails the automatic failover would not work as 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 would
select the other HBA and the information would continue through the alternate
path.

Path Failover
Dual HBA
Single-Port Drive
(DPF and CPF)
X Drive
Library
Fabric Drive Library

Controller
Drive
Virtual Tape Library
a2500256
Figure 4. Multiple HBA and single ports

Path Failover
Single HBA and Multi-Port Devices

Yet for another example, consider a single path from the HBA through the fabric to
a multi-port device. This 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 should occur on the device side there is
still an alternative path available for the information to go through.
Mulit-Port Drive
(DPF)
Single HBA
X Library
(CPF) Drive
Library
Fabric X Drive
Controller
Drive
X Virtual Tape Library

(DPF and CPF)
a2500257
Figure 5. Single HBA and multi-port devices
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.
Without path failover support, if a permanent path error occurs (because of an

HBA or cable failure, for example), the application fails. It is possible to initiate
manual failover by restarting the application on the alternate logical device, but the
application has to be restarted from the beginning. A long back up or restore
operation may have been in progress when the path error occurred. Sometimes
manual failover may require operator intervention to reset the drive because a
SCSI Reservation could still exist on the failing HBA path.
When the 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, and then retries the failing operation.

Path Failover
Dynamic Load Balancing

The dynamic load balancing support optimizes resources for tape devices that have
physical connections to multiple Host Bus Adapters (HBA) in the same machine.
When an application opens a device that has multiple HBA paths configured, the
device driver determines which path has the HBA with the lowest usage, and
assigns that path to the application. When another application opens a different
device with multiple HBA paths, the device driver again determines the path with
the lowest HBA usage and assigns that path to the second application. The device
driver updates the usage on the HBA assigned to the application when the device
is closed. Dynamic load balancing uses all Host Bus Adapters whenever possible
and balance the load between them to optimize the resources in the machine.
For example, consider a machine with two Host Bus Adapters, HBA1 and HBA2,
with multiple tape drives attached. Each tape drive is connected to both HBA1 and
HBA2. Initially, there are no tape drives currently in use. When the first application
opens a tape drive for use, the device driver assigns the application to use HBA1.
When a second application opens a tape drive for use, the device driver assigns
the second application to use HBA2. A third application would be assigned to
HBA1 and a fourth application would be assigned to HBA2. There would be two
applications using HBA1 and two applications using HBA2.
If the first application finishes and closes the device, there would now be one
application using HBA1 and two applications using HBA2. When the next
application opens a tape drive, it would be assigned to HBA1, so again there
would be two applications using HBA1 and two applications using HBA2.
Likewise, if the second application finishes and closes the device, HBA2 would
have one application using it and the next application that opens a tape drive
would be assigned to HBA2.
The dynamic load balancing support is independent from the automatic failover
support. Regardless of the path assigned initially for load balancing, if that path
fails, the automatic failover support attempts recovery on the next available path.
Supported Devices and Feature Codes

Path failover is supported only for the devices listed in Table 2. Path failover
includes Control Path Failover (CPF) for tape libraries and Data Path Failover
(DPF) for tape drives. In order to use path failover support, some devices require
feature codes as listed in Table 2.
Table 2. Supported Devices and Feature Codes
| Supported Tape Library/Drive Feature Code (FC), if required
| TS3500/3592 Standard, no FC required (CPF and DPF)
| TS3500/LTO FC 1682 (CPF and DPF)
| TS3400/3592 Standard, no FC required (CPF and DPF)
| TS7520/Al FC 1682 (CPF and DPF)
| TS7650/All Standard, no FC required (DPF only)
3583 FC 1680 (CPF), FC 1681 (DPF)

Path Failover
Table 2. Supported Devices and Feature Codes (continued)

| Supported Tape Library/Drive Feature Code (FC), if required
3582 FC 1680 (CPF), FC 1681 (DPF)
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 attached to Windows and Linux for Intel/AMD
processor based servers.
2. Path failover is not supported on Virtual Tape Libraries (except for those
listed in Table 2 on page 13) that emulate IBM tape devices.
Data Encryption
Tape and Library Requirements

Encryption support is available in the IBM encryption-capable TS1120 and Ultrium
| LTO4 and LTO5 (Fibre Channel or SAS) tape drives that support encryption. If
system-managed or library-managed encryption is used, the Transparent LTO
| Encryption feature code is required for the library with Ultrium LTO4 and LTO5
tape drives. This feature code is not required for TS1120 tape drives.
Application-managed encryption does not require this feature code for any of
encryption-capable tape drives. Refer to “Feature Codes (Encryption)” on page 19
for the feature code numbers.
In the open system environment, there are three methods of encryption

management to choose from. These methods differ in where you choose to locate
your encryption key manager application. Your operating environment determines
which is the best for you, with the result that key management and the encryption
policy engine may be located in any one of the three environmental layers:
application layer, system layer, and library layer.
Application-Managed Tape Encryption

This method is best where operating environments run an application already
capable of generating and managing encryption policies and keys, such as Tivoli®
Storage Manager (TSM). Policies specifying when encryption is to be used are
defined through the application interface. The policies and keys pass through the
data path between the application layer and the Encryption is the result of
interaction between the application and the encryption-enabled tape drive, and is
transparent to the system and library layers.
Please refer to “Planning for Application-Managed Tape Encryption” on page 15

for details on the hardware and software requirements for application-managed
encryption. For details on setting up application-managed tape encryption refer to
the Tivoli Storage Manager documentation or for more information, visit the
following site:
http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/index.jsp
| It is required to use the latest device drivers available. Please refer to Appendix A,
| “Accessing Documentation and Software Online,” on page 317 for downloading
| drivers.

Data Encryption
System-Managed Tape Encryption

| In this method, key generation and management is performed by an encryption
| key manager (EKM). Policy controls and keys pass through the data path between
the system layer (device drivers) and the encryption-capable tape drives.
Encryption is transparent to the applications.
| 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 our web site. Please see
| Appendix A, “Accessing Documentation and Software Online,” on page 317 for
| instructions.
Refer to “Planning for System-Managed Tape Encryption” on page 16 for details on

the hardware and software requirements for system-managed encryption. For
details on setting up system-managed encryption in different operating system
environment, refer to the applicable chapter for each operating system.
Library-Managed Tape Encryption

This method is best for encryption-capable tape drives in an open attached IBM
tape libraries. Scratch encryption policies specifying when to use encryption are set
up through the IBM System Storage Tape Library Specialist Web interface. Policies
are based on cartridge volume serial numbers. Key generation and management is
| performed by an encryption key manager. Policy control and keys pass through
the library-to-drive interface, therefore encryption is transparent to the
applications.
Please refer to “Planning for Library-Managed Tape Encryption” on page 18 for

details on the hardware and software requirements for library-managed
encryption. For details on setting up library-managed encryption on
encryption-capable tape drives, please refer to the IBM System Storage Tape
Library Operator's Guide for your library.
Planning for Application-Managed Tape Encryption

Note: Please contact your IBM Representative for additional information about
encryption on the IBM encryption-capable tape drive.
In order to perform encryption on the encryption-capable tape drive, the following

is required:
v Encryption-capable tape drive(s)
v Encryption configuration features:
– Library code updates and Transparent LTO Encryption feature code for
| libraries with Ultrium LTO4 and LTO5 drives
– Tape drive code updates
Application-Managed Tape Encryption Setup Tasks

Any task 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
System Storage 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 TSM documentation.
4. Perform write/read operation to test encryption.

Data 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.
Planning for System-Managed Tape Encryption


is required:
| v Keystore (Refer to documentation on Tivoli Key Lifecycle Manager (TKLM))
| – Tivoli Key Lifecycle Manager (TKLM)
– Tape drive code updates and Transparent LTO Encryption feature code for
| libraries with Ultrium LTO4 and LTO5 drives
– Tape system library code updates
Setup Tasks for System-Managed Tape Encryption on Open

Systems Operating System
1. Install, verify, and configure:
a. Keystore
| b. EKM (Refer to documentation on Tivoli Key Lifecycle Manager (TKLM))
| Note: The SSL protocol in TKLM isn't supported with SME.

2. Install, cable, and configure encryption-capable tape drive (refer your IBM
System Storage Tape Drive or Library Operator's Guide).
3. Install and enable appropriate Device Driver Level (refer to the appropriate
operating system chapter in this document for more details)
4. Edit /etc/ibmekm.conf file.
| 5. Use “[38] Test Encryp. Path (Test Encryption Key Path/Setup)” on page 268 or
| “Test Encryption Path” on page 314 to verify.
System-Managed Encryption Configuration

Note: The tape drive must be set to system-managed encryption from the drive
panel or library user interface before using device driver system-managed
encryption.
| After installing the device driver, then an encryption key manager needs to 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
already exist.
Figure 6 on page 17 is an example of the sample configuration file installed.

Data Encryption
# IBM Encryption Key Manager Configuration File

#
# (C) COPYRIGHT International Business Machines Corp. 2006
# All Rights Reserved
# Licensed Materials - Property of IBM
#
# US Government Users Restricted Rights - Use, duplication or
# disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
#
# This file contains the TCP/IP address(s) and port(s) for the Encryption Key
# Server with a configuration entry in the following formats. The IPv4 address
# entered as x.x.x.x:port. The IPv6 address entered as x:x:x:x:x:x:x:x port.
# The server is for information only and is not used. The timeout value is
# specified in seconds.
#
# The format for IPv4 address:
# server timeout address:port
# for example,
# ekmtest 10 9.12.123.1234:8050
#
# The format for IPv6 address:
# server timeout address port
# for example,
# ekmtest 10 fe80::207:30ee:edcb:d05d 8050
#
# The Encryption Key Server address and port can be a local loop back
# address 127.0.0.1:port in IPv4 format or ::1 port in IPv6 format if the server
# is on the same host or a network address and port if external to the host.
# Up to 16 server address and port entries are supported if there are multiple
# TCP/IP connections to the same server and/or multiple servers.
#
# Interoperability between IPv4 and IPv6 versions running on dual-stack hosts:
# IPv4 Client <--> IPv4/IPv6 Server using IPv4 address for EKM server
# IPv6 Client <--> IPv4 Server using IPv4 address for EKM server
# IPv6 Client <--> IPv6 Server using IPv6 address for EKM server
#
# Sample entry for a local server with a 10 second timeout using port 8050
# in IPv4 format
# ekmtest 10 127.0.0.1:8050
#
# in IPv6 format
# ekmtest 10 ::1 8050
Figure 6. Sample Encryption Configuration File
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”
| To set up an IP address for an encryption key manager server, use Table 3 to

choose an appropriate IP address type and then add the IP address in the entry of
the encryption configuration file.
Table 3. Interoperability between IPv4 and IPv6 Clients and Servers
IPv4 EKM IPv6 EKM IPv4 EKM IPv6 EKM
server IPv4-only server IPv6-only server server
host host dual-stack host Dual-stack host
IPv4 IPv4 (no) IPv4 IPv4
Client/IPv4-only
host

Data Encryption
Table 3. Interoperability between IPv4 and IPv6 Clients and Servers (continued)
IPv4 EKM IPv6 EKM IPv4 EKM IPv6 EKM
server IPv4-only server IPv6-only server server
host host dual-stack host Dual-stack host
IPv6 (no) IPv6 (no) IPv6
Client/IPv6-only
host
IPv4 Client IPv4 (no) IPv4 IPv4
dual-stack host
IPv6 Client IPv4 IPv6 (no) IPv6
dual-stack host
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.
A maximum of 16 server connections can be configured for failover. When a

connection can not be made or is lost on the current server being used, the
operation is retried on the next configured server.
After configuring servers in the ibmekm.conf file then specific tape drives need to
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.
Planning for Library-Managed Tape Encryption


is required:
| v Keystore (Refer to documentation on Tivoli Key Lifecycle Manager (TKLM))
| – Tivoli Key Lifecycle Manager (TKLM)
– Tape system library code updates and Transparent LTO Encryption feature
| code for libraries with Ultrium LTO4 and LTO5 drives.
– Tape drive code updates
Library-Managed Tape Encryption Tasks

1. Install, verify, and configure
a. Keystore
| b. EKM (Refer to documentation on Tivoli Key Lifecycle Manager (TKLM)) for
more information on both.
2. Install and cable the encryption-capable tape drive (IBM service task for TS1120
Tape Drive).
3. Use IBM System Storage Tape Library Specialist to enable the tape drive for
library-managed tape encryption (refer to your IBM System Storage Tape Drive
or Library Operator's Guide).
4. Use library diagnostic functions to verify.

Data Encryption
Bulk Rekey
For customers using Library-Managed Encryption with 3592 Enterprise Tape
Drives and IBM tape and changer drivers running on open systems operating
system (AIX, HP-UX, Linux, Solaris, Windows), sample code for performing 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 in conjunction with the tapeutil version 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 in conjunction with both the IBM tape and
changer drivers. In addition, data cartridges must be located in storage cells, not in
I/O station cells or tape drives.
For more information and to download the sample code packages, see
http://www.ibm.com/support/fixcentral/.
Feature Codes (Encryption)

In order to use system-managed and library-managed encryption, the Transparent
LTO Encryption feature codes listed in Table 4 are required for the associated IBM
| tape libraries with Ultrium LTO4 and LTO5 tape drives. If the drives in use are
TS1120 Tape Drives, this feature code is not required for system-managed or
library-managed encryption. If you are using application-managed encryption, no
feature code is required on any encryption-capable tape drives.
Table 4. Feature Codes (Encryption)
Tape Library Feature Code
TS3500 FC 1604
TS3400 Standard Feature
TS3310 FC 5900
TS3100/3200 FC 5900

Data Encryption

Chapter 3. AIX Tape and Medium Changer Device Driver
Purpose . . . . . . . . . . . . . . . 21 Primary and Alternate Paths. . . . . . . . 39
Data Flow . . . . . . . . . . . . . . . 22 Querying Primary and Alternate Path
Product Requirements . . . . . . . . . . . 22 Configuration . . . . . . . . . . . . 39
Hardware Requirements . . . . . . . . . 22 Configuring and Unconfiguring Primary and
Software Requirements . . . . . . . . . 24 Alternate Devices . . . . . . . . . . . 40
Installation and Configuration Instructions . . . . 24 System-Managed Encryption . . . . . . . . 40
Installation Procedure . . . . . . . . . . 25 Device Driver Configuration. . . . . . . . 40
Configuring Tape and Medium Changer Devices 25 Querying Tape Drive Configuration . . . . . 40
Deconfiguring Tape Devices . . . . . . . . 26 Testing Data Encryption Configuration and
Deconfiguring Medium Changer Devices . . . 26 Connectivity . . . . . . . . . . . . . 41
Uninstalling . . . . . . . . . . . . . 26 Error Logging . . . . . . . . . . . . 41
Tape Drive, Media, and Device Driver Parameters 26 Field Support Information . . . . . . . . 41
Configuration Parameters. . . . . . . . . 27 Problem Determination . . . . . . . . . . 41
Media Parameters . . . . . . . . . . . 31 Using the Dump Support . . . . . . . . . 41
Special Files . . . . . . . . . . . . . . 33 Device and Volume Information Logging . . . 42
Special Files for Tape Devices . . . . . . . 33 Log File . . . . . . . . . . . . . . 42
Special Files for Medium Changer Devices . . . 34 Tape Log Utility . . . . . . . . . . . . 43
Persistent Naming Support . . . . . . . . . 35 Reservation Conflict Logging . . . . . . . 43
Changing the Logical Name After Initial Boot . . 35 Error Logging . . . . . . . . . . . . 43
Control Path Failover Support for Tape Libraries . . 36 Error Log Templates . . . . . . . . . . 44
Configuring and Unconfiguring Path Failover Automatic Dump Facility . . . . . . . . . 46
Support . . . . . . . . . . . . . . 36 Trace Facility . . . . . . . . . . . . . 46
Primary and Alternate Paths. . . . . . . . 36 Atape System Trace (ATRC) Utility . . . . . 46
Querying Primary and Alternate Path Component Tracing. . . . . . . . . . . 46
Configurations . . . . . . . . . . . . 37 Atape Component Trace (ACTRC) Utility . . . 47
Configuring and Unconfiguring Primary and Tape Drive Service Aids . . . . . . . . . . 47
Alternate Devices . . . . . . . . . . . 37 Details of Tape Service Aids . . . . . . . . 47
Data Path Failover and Load Balancing Support for Performance Considerations . . . . . . . . . 49
Tape Drives . . . . . . . . . . . . . . 38 Data Path . . . . . . . . . . . . . . 50
Installing Data Path Failover License Key . . . 38 Common AIX Utilities . . . . . . . . . . 50
Configuring and Unconfiguring Path Failover AIX iostat Utility for Tape Performance . . . . 50
Support . . . . . . . . . . . . . . 38 Before Calling Support . . . . . . . . . 51
This chapter describes the IBM AIX Enhanced Tape and Medium Changer Device
Driver (Atape) for IBM tape devices.
Purpose
The IBM AIX Enhanced Tape and Medium Changer Device Driver is designed
specifically to take advantage of the features 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 demount the cartridges), as well as 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. Please note that some independent software vendor (ISV) applications
have certain device driver requirements. Before installing the device drivers, please
refer to the ISV web site or their support to find out what device drivers should be
used for the ISV.

AIX Device Driver (Atape)
Data Flow
The software 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 7.
Figure 7. Data Flow for AIX Device Driver (Atape)
Product Requirements
The following hardware and software components are supported by IBM.
Hardware Requirements
The following hardware is supported by the Atape device driver:
v One or more of the following IBM RS/6000® or System p (also known as
pSeries) SCSI host bus adapters for libraries containing Ultrium tape drives:
– PCI-X DDR Dual -x4 SAS Adapter (FC 5900 and FC 5912)
– PCI Dual Channel Ultra-3 SCSI Adapter (LVD) (FC 6203)
– PCI Differential Ultra SCSI Adapter (HVD) (FC 6207)
– PCI Universal Differential Ultra SCSI Adapter (HVD) (FC 6204)
– Integrated Ultra2 SCSI Adapter for LVD attachment (with a VHDCI
connector):
- System p (also known as pSeries) 620 (7025 - 6F0, 6F1)
- 7025 - F80
- System p (also known as pSeries) 660 (7026 - 6H0, 6H1, 6M1)
- System p (also known as pSeries) 640 (7026 - B80)
- 7026 - H80, M80
- 7044 - 170, 270
– Integrated Ultra3 SCSI Adapter for LVD attachment (with a VHDCI
connector):
- System p (also known as pSeries) 610 (7028 - 6C1, 6E1)
- System p (also known as pSeries) 630 (7028 - 6C4, 6E4
- System p (also known as pSeries) 650 (7038 - 6M2)
- System p (also known as pSeries) 655 (7039 - 651)
- 9112 - 265
– PCI Dual Channel Ultra-2 SCSI Adapter (LVD) (FC 6205)
– PCI-X Dual Ultra320 SCSI Blind Swap Adapter (FC 5710)
– PCI-X Dual Channel Ultra 320 SCSI Adapter (FC 5712)
– PCI-X Dual Channel Ultra 320 SCSI Adapter (FC 5736)
v One or more of the following IBM RS/6000 or System p (also known as pSeries)
FC-AL host bus adapters for TS1120 tape drives and all IBM libraries:
– Gigabit Fibre Channel Adapter (PCI) (FC 6227)
– Gigabit Fibre Channel Adapter for 64–bit PCI bus (FC 6228)

– Two Gigabit Fibre Channel Adapter (PCI—X) (FC 6239)

– Two Gigabit Fibre Channel Adapter (PCI-X) (FC 5716)
– Four Gigabit Fibre Channel Adapter (PCI-X) (FC 5758 and FC 5759)
– Four Gigabit Fibre Channel Adapter (PCI-E) (FC 5773 and FC 5774)
v For the 3490E and Magstar devices, one of the following RS/6000 or System p
(also known as pSeries) host adapters:
– Micro Channel SCSI Adapters
- RS/6000 or System p (also known as pSeries) FC 2412 Enhanced SCSI-2
Differential Fast/Wide Adapter/A
- RS/6000 or System p (also known as pSeries) FC 2416 SCSI-2 Differential
Fast/Wide Adapter/A
- RS/6000 or System p (also known as pSeries) FC 2420 SCSI-2 Differential
High Performance External I/O Controller (limited to seven SCSI IDs)
– PCI SCSI Adapters
- RS/6000 or System p (also known as pSeries) FC 2409 PCI SCSI-2
Differential Fast/Wide Adapter
- RS/6000 or System p (also known as pSeries) FC 6209 PCI SCSI-2
Differential Fast/Wide Adapter
- RS/6000 or System p (also known as pSeries) FC 6207 PCI Differential
Ultra SCSI Adapter
- RS/6000 or System p (also known as pSeries) FC 6204 PCI Universal
Differential Ultra SCSI Adapter
v For 733x devices, refer to the specific product document for hardware
attachment requirements.
v The IBM TotalStorage Enterprise Tape System 3590 Model E and Model H Tape
Drives with Fibre Channel Attachment, is supported with the System p (also
known as pSeries) FC 6227 or FC 6228 Gigabit Fibre Channel Adapters and
FC6239 2 Gigabit Fibre Channel PCI-X Adapters.
v The following SCSI-attached devices are supported through the IBM 2108-G07
(SAN Data Gateway) attached to the FC 6227 or FC 6228 Gigabit Fibre Channel
Adapters and FC6239 2 Gigabit Fibre Channel PCI-X Adapters:
IBM TotalStorage Enterprise Tape System 3590, Models B11, B1A, E11, E1A,
H11, and H1A
IBM Magstar MP 3570 Tape Subsystem Model C
v The IBM TotalStorage Enterprise Tape System 3592 Model J is supported with
FC6239 2 Gigabit Fibre Channel PCI-X Adapters.
Four Gigabit Fibre Channel Adapter (PCI-E) (FC 5773 and FC 5774)
v The 8 Gigabyte Fibre Channel Adapter (FC 5735) is supported on pSeries for the
following tape drives and libraries. This adapter also supports N_Port ID
Virtualization (NPIV) and AIX VIOS clients if the AIX VIOS server with this
adapter is configured for NPIV to run on the VIOS clients.
– TS1130 (3592 E06) Enterprise Drive
- 3494 IBM Enterprise Tape Library
- TS3400 (3577) Library
- TS3500 (3584) Library
– TS1120 (3592 E05) Enterprise Drive
- 3494 IBM Enterprise Tape Library
Chapter 3. AIX Tape and Medium Changer Device Driver 23

- TS3400 (3577) Library

- TS3500 (3584) Library
– Ultrium TD4 LTO drives
- TS3100 (3573-L2U) Library
- TS3500 (3584) Library
– Ultrium TD3 LTO drives
- TS3500 (3584) Library
Note: Using a single Fibre Channel host bus adapter (HBA) for concurrent tape
and disk operations is generally 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 have been observed. These issues are resolved by
separating disk and tape I/O streams onto separate HBAs and using SAN
zoning to minimize contention. IBM is focused on assuring server/storage
configuration interoperability. We strongly recommend that your overall
implementation plan includes provisions for separating disk and tape
workloads.
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.
To obtain the most current service and documentation for this software, refer to
Appendix A, “Accessing Documentation and Software Online,” on page 317.
Installation and Configuration Instructions

The recommended procedure for installing a new version of the device driver is to
uninstall the previous version.
Instructions for uninstalling the device driver are outlined below in “Uninstalling”
on page 26.
Attention: At the end of the installation procedure, the installp facility

automatically runs the AIX bosboot command to update the boot record with the
newly installed Atape files. When the bosboot command completes, the following
messages are displayed:
0503-292 This update does not fully take effect until after a system reboot.
installp: bosboot process completed.
This message is referring to the updates to the boot record only. If the installation
summary shows that the Atape driver was installed successfully, it is not necessary
to reboot the machine at this time.
If the installation summary shows that the install failed, you should reboot the
machine and attempt to install the Atape driver a second time.

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 317.
Preinstallation Considerations
Before proceeding with the installation, verify the following items:
1. The tape device is properly functioning, properly attached to the server, and is
powered up.
2. You have logged onto the server on an account which has root authority.
3. You have a command shell window open on the server to perform the
installation procedure.
4. Make sure the current path is defined in the command shell PATH variable.
This can be accomplished in the korn shell using the following command:
EXPORT PATH=.:$PATH
5. If the tape device was configured previously by another device driver (not
Atape), remove any existing device definitions for it. The following command
is an example: rmdev -l ost1 -d
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 installs and commits the Atape driver on the system.
Configuring Tape and Medium Changer Devices

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.
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 performing the following steps:
rmdev -l [device]
Configure a tape device using one of the following procedures:

v Enter the following command with no parameters:
cfgmgr
The command configures all devices automatically (including any new tape or
medium changer devices).
or
v Power Off your subsystem and reboot the system to configure it automatically
and make available any new tape or medium changer devices on the system.

Deconfiguring Tape Devices

Note: In the following examples, replace the letter n with the appropriate number
for the chosen device.
Deconfigure the tape device using one of the following procedures:

1. The first method leaves the tape device defined in the configuration database. It
is similar to bringing the device offline (not in use).
Enter the following command to bring the /dev/rmtn tape device offline, but
leave it defined in the device database:
rmdev -l rmtn
2. The second method brings the tape device offline and removes its definition
from the device database.
Enter the following command:
rmdev -l rmtn -d
The device driver is not unloaded from the kernel until the last device is
deconfigured.
Deconfiguring Medium Changer Devices

Note: In the following examples, replace the letter n with the appropriate number
for the chosen device.
Deconfigure the medium changer device using one of the following procedures:
1. The first method leaves the device 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.
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 using the smit command menu to
uninstall software and selecting Atape.driver or using the following installp
command:
installp -u Atape.driver
Tape Drive, Media, and Device Driver Parameters

This chapter describes the parameters that control the operating modes of the AIX
Enhanced Tape and Medium Changer Device 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
configuring a device 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 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 type
v Rewind immediate
| v System encryption
| v System encryption for Write Commands
v Trailer labels
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 38 for a description of the path failover and failover support.
| The installation default is no (path failover is not enabled).
Autoloading
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 TotalStorage 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)
Do not enable autoloading if one of the following conditions is true:

v The device is used by an application that provides library medium changer
support for the IBM 3581 or IBM 3583.
v The device is installed in a 3494 Enterprise Tape Library.
v The device is used by an application with stack loader support.
v The application is MKSYSB.
v The tapes being read were not written using the autoloading feature.
Tapes created with AUTOLOAD=YES may not be 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, loads the next tape, then 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.
The installation default is Off (no autoloading).
Emulate Autoloader
This parameter controls how the device driver operates when the ACF on the IBM
TotalStorage 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
automatically into the tape drive. If this parameter is set to Off, the normal unload
operation occurs, and the tape remains in the drive.
The emulate autoloader parameter can be used for legacy applications written for
the IBM 3490E Automated Cartridge Loader (ACL) when the IBM TotalStorage
Enterprise Tape System 3590, the IBM Magstar MP 3570, or the IBM 3490 Model F
autoloader is set to Random mode. This eliminates the need to re-configure the
autoloader of the device Random or Automatic operation.
The installation default is Off (do not emulate autoloader).
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 only one drive 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 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 4mm
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.
The installation default is On (use Buffered mode).
Compression
Hardware compression is implemented in the device hardware. This parameter
turns the compression feature On and Off. If compression is enabled, then the
effective performance can increase based on the compressibility of the data.
The installation default is On (use compression).
Fail Degraded Media

This parameter controls whether the device driver fails a tape operation when
degraded media is detected by the IBM TotalStorage 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 TotalStorage

Enterprise Tape System 3590 from performing high speed Locate operations. A
Locate command can take over 20 minutes, depending on the desired 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.
The installation default is Off (do not fail the tape operation if degraded media is
detected).
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 more information, refer to “Device and Volume Information Logging” on page
42.
The installation default is Off (no logging).
Maximum Size of the Log File

This parameter specifies the number of entries 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 more information, refer to “Device and Volume
Information Logging” on page 42.

The installation default is 500.
New Logical Name

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 more information, refer to “Persistent Naming Support” on page 35.
There is no installation default value for this parameter.
Read Error Recovery Time

This parameter controls the read error recovery time for the IBM TotalStorage
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
reading data from the tape.
The installation default is Off (do not limit the read error recovery time).
Record Space Mode

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).
The AIX mode returns the same EIO errno value as the SCSI mode when a filemark
is encountered except that the tape is left positioned before the filemark (the
beginning-of-tape side of the filemark on the forward space and the end-of-tape
side of the filemark on the backward space).
The installation default is SCSI mode.
| Reservation type
| This parameter specifies the SCSI Reservation type that will be 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 will use SCSI Persistent Reserve when the
| Alternate Pathing parameter is set to yes.
| The installation default is SCSI Reserve 6.
| Reservation key
| This parameter specifies the SCSI Persistent Reservation key that will be 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.
| The default for this attribute is blank (NULL).

| If the Reservation Key parameter is specified as blank (NULL) then the device
| driver will use an internal unique key for all devices on the host they are
| configured on. Another AIX host sharing the same devices would also have an
| internal unique key for all devices if the Reservation Key parameter was blank
| (NULL).
| If the default above 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 less than 8 characters are used for an ASCII key such as host1,
| the remaining characters will be set to 0x00 (NULL). If less than a 16 hexadecimal
| key is used, the remaining bytes will be set to 0x00.
| Note: When specifying a Reservation Key on each host sharing a device, the key
| must be unique to each host.
| Rewind Immediate
This parameter turns the immediate bit On and Off in rewind commands. If it is
set to On, then the rewind tape operation executes faster, but 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 4mm
Tape Cartridge Autoloader, for which the default is On (rewind immediate).
| System encryption
| This parameter specifies if System-Managed Encryption should be used. For more
| information refer to “System-Managed Encryption” on page 40.
| The installation default is no.
| System encryption for Write Commands

| This parameter controls if System-Managed Encryption will be used for Write
| commands. For more information refer to “System-Managed Encryption” on page
| 40.
| The installation default is custom.
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 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).
The installation default is Off (no trailer labels).
Media Parameters
The ability to set or change media parameters is a tape diagnostic and utility
function, refer to Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 231.

The media parameters can be queried and set by ITDT or the tape diagnostic and
utility function using the Query/Set Parameters option in the window.
These parameters cannot be set or changed by the configuration procedures. The

media parameters are:
v Capacity scaling
v Logical write protect
v Volume ID for logging
Capacity Scaling
This parameter sets the capacity or logical length of the current tape on IBM
TotalStorage Enterprise Tape System 3590, IBM TotalStorage 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.
Notes:
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%.
Logical Write Protect

This parameter sets or resets the logical write protect of the current tape on IBM
TotalStorage Enterprise Tape System 3590, IBM TotalStorage 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.
Notes:
1. The tape position must be at the start of the tape to change this parameter from
its current value.
2. Attempting to set logical write protect that is not supported by a device or the
current media loaded always returns "No" and cannot be changed.

Volume ID for Logging

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
Once 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.
Special Files for Tape Devices

Each tape device has a set of special files that provides access to the same physical
drive but to different types of functions. As shown in Table 5, in addition to the
tape special files, a special file is provided for tape devices that allows access to the
medium changer as a separate device.
Note: The asterisk (*) represents a number 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 issuing commands 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 designed for a tape drive
If a tape drive has a SCSI medium changer device 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 5.
Table 5. Special Files for Tape Devices
Rewind on Retension on Bytes per Inch Unload on
Special File Name Close (Note 1) Open (Note 2) (Note 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
/dev/rmt*.3 No Yes N/A No No
/dev/rmt*.4 Yes No N/A No No
/dev/rmt*.5 No No N/A No No
/dev/rmt*.6 Yes Yes N/A No No
/dev/rmt*.7 No Yes N/A No No
/dev/rmt*.10 (Note 4) No No N/A No No

Table 5. Special Files for Tape Devices (continued)

Rewind on Retension on Bytes per Inch Unload on
Special File Name Close (Note 1) Open (Note 2) (Note 3) Trailer Label Close
/dev/rmt*.20 Yes No N/A No Yes
/dev/rmt*.40 Yes No N/A Yes No
/dev/rmt*.41 No No N/A Yes No
/dev/rmt*.60 Yes No N/A Yes Yes
/dev/rmt*.null (Note 5) Yes No N/A No No
/dev/rmt*.smc (Note 6) N/A N/A N/A N/A N/A
Notes:
1. The Rewind on Close special files write filemarks under certain conditions before rewinding.
2. The Retension on Open special files rewind the tape on open only. Retensioning is not performed because these
tape products perform the retension operation automatically when needed.
3. The Bytes per Inch options are ignored for the tape devices supported by this driver. The density selection is
automatic.
4. The rmt*.10 file bypasses normal close processing , and the tape is left at the current position.
5. The rmt*.null file is a pseudo device similar to the /dev/null AIX special file. The input/output control (ioctl) calls
can be issued to this file without a real device attached to it, and the device driver returns a successful
completion. Read and write system calls return the requested number of bytes. This file can be used for
application development or debugging problems.
6. The rmt*.smc file can be opened independently of the other tape special files.
Special Files for Medium Changer Devices

After the driver is installed and a medium changer device is configured and made
available for use, access to the robotic device is provided through the smc* special
file in the /dev directory.
Table 6 shows the attributes of the special file. The asterisk (*) represents a number
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 more information,
refer to Table 6.
Table 6. Special Files for Medium Changer Devices
Special File Name Description
/dev/smc* Access to the medium changer robotic device
/dev/smc*.null Pseudo medium changer device
Note: The smc*.null file is a pseudo device similar to the /dev/null AIX special file. The
commands can be issued to this file without a real device attached to it, and the device
driver returns a successful completion. This file can be used for application development
or debugging problems.
The file descriptor that results from opening the smc special file does not support
the following operations:
v Read
v Write
v Commands designed for a tape device

Persistent Naming Support

Persistent naming support is used to ensure that attached devices are always
configured with the same logical name based on the SCSI ID, LUN ID, and host
bus adapter (HBA), even when the system is rebooted.
When the AIX operating system is booted, the HBA performs a device discovery
and assigns a default logical name to each device found in a sequential order. For
example, 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 respectively, the HBA
would initially configure them as Available with the following logical names:
rmt0 target 0, lun 0 Available

On the next reboot, for example, if the existing rmt1 target 1 device is powered off
or not connected, the HBA would initially configure two devices as Available with
the following logical names:

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:
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, this 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.
Changing the Logical Name After Initial Boot

The logical name of a device can be changed after an initial boot and configured.
This can be done using the SMIT menu or the chdev command from a script or
command line.
For example, a default rmt0 logical name for a tape drive could be changed to
rmt-0, tape0, or any descriptive name desired. In this example, if the three tape
drives are changed to rmt-0, rmt-1, and rmt-2 respectively, and the system is then
rebooted with rmt-1 powered off, the HBA detects that there are unique names
predefined for the attached devices, and the HBA uses those names. In this case,
the devices would 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 has been 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.

Using SMIT to Change the Logical Name

To change the logical name using SMIT, perform 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.
Using chdev Command to Change the Logical Name

The logical name of a device can be changed using the chdev command. For
example, to change the logical name of the device rmt0 to rmt-0, run:
chdev –l rmt0 –a new_name=rmt-0
The output of this command displays rmt0 changed.
Note: When path failover is enabled, changing the logical name for either a
primary or alternate device only changes that individual device name.
Control Path Failover Support for Tape Libraries

Note: The library control path failover feature code must be installed prior to
enabling the path failover support in the Atape device driver. Refer to
“Automatic Failover” on page 10 for what feature codes may be required for
your machine type.
The Atape device driver path failover support configures multiple physical control
paths to the same logical library within the device driver and provides automatic
failover to an alternate control path when a permanent error occurs on one path.
This is transparent to the running application.
Configuring and Unconfiguring Path Failover Support

Path failover support is not enabled automatically when the device driver is
installed. It must be configured initially on each logical device after installation.
When path failover support is enabled for a logical device, it remains set until the
device is deleted or the support is unconfigured. The alternate path failover setting
is retained even if the system is rebooted.
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, and so on, then select Yes or No for Enable Path Failover
Support. The support can also be enabled or disabled 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
Primary and Alternate Paths

When the device driver configures a logical device with path failover support
enabled, the first device configured always becomes the primary path. On SCSI
attached devices, -P is appended to the location field. On Fibre attached devices,
-PRI is appended to the location field of the device.

When a second logical device is configured with path failover support enabled for
the same physical device, it configures as an alternate 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.
A third logical device is also configured as an alternate path with either -A or -ALT
appended, and so on. The device driver supports up to 16 physical paths for a
single device.
The labeling of a logical device as either a primary or alternate path is for

information only, in order to:
1. Be able to identify the actual number of physical devices configured on the
system and a specific logical device associated with them. There is only one
logical device labeled as the primary path for each physical device. However,
there can be many (multiple) logical devices labeled as an alternate path for the
same devices.
2. Provide information about which logical devices configured on the system have
path failover support enabled.
Querying Primary and Alternate Path Configurations

You can display the primary and alternate path configuration for all devices with
the lsdev command. There can be two or more logical devices configured for a
single physical device, but the first device configured is labeled the primary device.
All other logical devices configured after the first device are labeled as alternate
devices. To see this, run the lsdev -Cc tape command and look at the location field
in the data. Run the following command:
lsdev -Cc tape | grep P
For example, you can easily determine how many physical devices are configured
with path failover support.
Note: Display the primary and alternate path configuration for any device using
tape diagnostic and utility functions, refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 231.
Configuring and Unconfiguring Primary and Alternate Devices

Logical devices configured as alternate paths can be unconfigured and
reconfigured at any time after the initial configuration is run. Unconfiguring an
alternate path device removes that device from the primary device path list,
removes the -A or -ALT appended to the location field, and changes the device to
the Defined state. The primary and any other alternate devices are still available.
Likewise, configuring a new alternate path device or reconfiguring an existing one

in the Defined state adds that device to the primary device path list, appends -A or
-ALT to the location field, and makes the device available.
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 alternate 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 alternate devices that were unconfigured are reconfigured. The first device
that is reconfigured becomes the new primary device. All remaining alternate
devices are reconfigured as alternate paths.
These methods provide the ability to unconfigure and reconfigure physical devices
on the system when device connections or addressing changes are made.
Data Path Failover and Load Balancing Support for Tape Drives
Notes:
1. Some devices require a path failover feature code installed prior to enabling the
path failover support in the Atape device driver. Refer to “Automatic Failover”
on page 10 for what feature code may be required for your machine type.
2. DPF keys do not need to be added if you are running the latest drive code on
Ultrium-3 and Ultrium-4 drives.
3. This function is not supported for devices that are attached through an IBM
San Data Gateway or on the IBM Virtualization Engine TS7510.
4. The AIX operating system only supports a static configuration of devices,
which also applies to the Path Failover and Failover Support. When devices are
initially configured at a specific SCSI ID and physical connection (drive port,
host bus adapter, and switch number/port, if applicable) and in the Available
state, changing the physical device address/connection without either rebooting
or unconfiguring and reconfiguring the devices has unpredictable results and is
not supported.
Installing Data Path Failover License Key

Use the following command line script to query, add, or delete license keys for this
feature before enabling the path failover feature as described below. The key is a
16-digit hexadecimal value, for example, 1234567890abcdef.
All key values “A-F” should be entered in lowercase letters as “a-f.”

v Query installed keys: dpf_keys
v Install a license key: dpf_keys -a key
v Delete a license key: dpf_keys -d key

Path failover support is not enabled automatically when the device driver is
installed. It must be configured initially on each logical device after installation.
When path failover support is enabled for a logical device, it remains set until the
device is deleted or the support is unconfigured. The path failover setting is
retained even if the system is rebooted.
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 may 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 unconfigures all devices that have path failover set to No, and reconfigures all
devices, setting path failover to Yes.
To enable or disable the support on a single logical device, use the smit menu to
Change/Show Characteristics of a Tape Drive, then select Yes or No for Enable
Path Failover Support. The support can also be enabled or disabled using the
chdev command, for example:
chdev -l rmt0 -aalt_pathing=yes
chdev -l rmt0 -aalt_pathing=no

enabled, the first device configured always becomes the primary path and PRI is
appended to the location field of the device. When a second logical device is
configured with path failover support enabled for the same physical device, it
configures as an alternate path and ALT is appended to the location field. A third
logical device is configured as the next alternate path with ALT appended, and so
on. The device driver supports up to 16 physical paths for a single device.
For example, if rmt0 is configured first, then rmt1, the lsdev -Cc tape command
output is similar to the following:
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)

logical device labeled the primary path for each physical device. However,
there may be many (multiple) logical devices labeled as an alternate path for
the same devices.
Querying Primary and Alternate Path Configuration

the lsdev command. There may be two or more logical devices configured for a
single physical device, but the first device configured is labeled the primary device.
All other logical devices configured after the first device are labeled as alternate
devices.
To see this, 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.

Configuring and Unconfiguring Primary and Alternate Devices

Logical devices configured as alternate paths can be unconfigured and
reconfigured at any time after the initial configuration is run. Unconfiguring an
alternate path device removes that device from the primary device path list,
removes the ALT appended to the location field, and changes the device to the
Defined state. The primary and any other alternate devices are still available.
Likewise, configuring a new alternate path device or reconfiguring an existing one
in the Defined state adds that device to the primary device path list, appends ALT
to the location field, and makes the device available.
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 alternate 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 alternate devices that were unconfigured are reconfigured. The first device
that is reconfigured becomes the new primary device. All remaining alternate
devices are reconfigured as alternate paths.
These methods provide the ability to unconfigure and reconfigure physical devices
on the system when device connections or addressing changes are made.
System-Managed Encryption
Device Driver Configuration

System-Managed Encryption can be set on a specific tape drive using the standard
SMIT panels to Change/Show Characteristics of a tape device or the command line
chdev command. There are 2 new attributes added for encryption:
sys_encryption “yes/no” Use System Encryption FCP Proxy Manager
wrt_encryption “off/on/custom” System Encryption for Write Commands at BOP
The sys_encryption attribute enables device driver system-managed encryption for

a tape drive by setting the value to yes.
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 using system-managed encryption to
control write encryption without device driver intervention.
Note: If wrt_encryption is set to on, an application can not open a tape drive
using the append mode.
Querying Tape Drive Configuration

This is a tape diagnostic and utility function, refer to Chapter 9, “IBM Tape

AIX System-Managed Encryption
Testing Data Encryption Configuration and Connectivity

There is a data encryption test available to validate the ibmekm.conf file server
entries and test tape drive to server connectivity operations.
This is a tape diagnostic and utility function, refer to Chapter 9, “IBM Tape
Diagnostic Tool (ITDT),” on page 231
Error Logging
Encryption errors are logged along with other tape operation errors 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 specific 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
Field Support Information

When encryption failures require field support and/or development analysis the
following data should be provided for a problem on a specific tape drive from the
machine (rmt1 for example) for the device driver. Tape drive dumps and EKM
server logs may be needed in addition to this information.
errpt –a > errpt.rmt1
lsattr –El rmt1 > lsattr.rmt1
All Atape files in /var/adm/ras/Atape*
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. The standard AIX interface is
provided for problem determination.
Using the 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.
Dump Device Commands

To list the current dump devices, enter the following command:
sysdumpdev -l
To establish the rmt1 tape device as a secondary dump device, enter the following
command:
sysdumpdev -s /dev/rmt1
To perform 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 issuing the sysdumpstart -s command.
To list the last dump data, enter the following command:

sysdumpdev -z
After the dump data is placed on the tape, copy it to a file on the disk before using
the crash command to process it. For example:
dd if=/dev/rmt1 of=tapedump1 ibs=4096 obs=512
crash tapedump1
Note: The ibs value is the input block size.
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.
Device and Volume Information Logging

An optional logging utility is provided to log the information about the device and
the media. The information is extensive for some devices and limited for other
devices. If set to On, the logging facility gathers all available information through
the SCSI Log Sense 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.
The following parameters control this utility:

v Logging
v Maximum size of the log file
Refer to “Tape Drive, Media, and Device Driver Parameters” on page 26 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.
Log File
The data is logged in the /usr/adm/ras directory. The file name is dependent on each
device; therefore, each device has a separate log. An example of the rmt1 device
file is:
/usr/adm/ras/Atape.rmt1.log
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 the device supports. Page 0x00 is followed by all
pages specified in page 0x00. The format of each following page is defined in the
SCSI specification and the device manual.

Tape Log Utility

A tape log utility is installed with the tapelog device driver that displays the
contents of the log file in ASCII text. The log pages are displayed as hexadecimal
values in dump format.
The syntax for the tape log utility is:

tapelog -l Name [-d] or tapelog -f File [-d]
Notes:
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
Reservation Conflict Logging

When the device driver receives a reservation conflict during open or after the
device has been opened it will log a reservation conflict in the AIX error log. Prior
to logging the error the device driver will issue a Persistent Reserve In command
to determine if a SCSI Persistent Reservation is active on the reserving host to get
the reserving host initiator WWPN (World Wide Port Name) and reserve key. If
successful, the device driver will log this information as follows:
Reserving host key xxxxxxxx WWPN xxxxxxxx
Where the first xxxxxxxx is the actual reserve key and the second xxxxxxxx is the
reserving host initiator WWPN.
After initially logging the reserving host WWPN, subsequent reservation conflicts
from the same reserving host WWPN will not be logged to prevent multiple
entries in the error log until either the reserving host WWPN is different than the
one initially logged or the device driver has reserved the device and then another
reservation conflict occurs.
If the Persistent Reserve In command fails then the detail data will contain the
following entry with the errno from the failing Persistent Reserve In command:
Unable to obtain reserving host information, errno x
The possible errno values are:

v ENOMEM - Device driver cannot obtain memory to perform the command
v EINVAL - Device has a Persistent Reservation but does not support the
Persistent Reserve In service action
v EBUSY - Device has failed the command with reservation conflict and has a
SCSI-2 Reserve active
v EIO - Unknown I/O failure occurred
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 using the Error Log Analysis
utility provided with the tape drive service aids. Refer to “Error Log Analysis” on
page 49. The error log can also be viewed using the smit or the errpt command.

Error Log Templates

The error log templates the device driver uses follow the same format as the
default AIX tape error log entries. Each error log entry is identified by an error
label and contains detail data associated with the type of error. The following items
describe the error labels and detail data for the templates used for logging tape
device, media, and SCSI adapter related errors in the AIX system error log.
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
Reservation 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 X'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 ....
Where:
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 through 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 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 SCSI bus has been reset.
For FCP or SAS adapters, this is the adapter_status code as defined in
/usr/include/sys/scsi_buf.h:
01 HOST IO BUS ERROR - Host I/O bus error during data transfer.
02 TRANSPORT FAULT - Failure in the transport layer.
03 COMMAND TIMEOUT - Command timed out before completion.
04 NO DEVICE RESPONSE - Target did not respond to attempts to
select it.
05 ADAPTER HARDWARE FAILURE - Adapter indicated a hardware
failure.
06 ADAPTER SOFTWARE FAILURE - Adapter indicated a microcode
failure.
07 WW NAME CHANGE - Adapter detected a new worldwide name
for the device.
08 FUSE OR TERMINAL PWR - Blown terminator fuse or bad
termination.
09 TRANSPORT RESET - Adapter detected an external SCSI bus reset.
0A TRANSPORT BUSY - The transport layer is busy.
0B TRANSPORT DEAD - The transport layer is currently inoperative.
ss If byte gg indicates a check condition, the ss byte is the sense data from the
device. Refer to the appropriate device reference manual for the specific
format and content of these bytes.

Automatic Dump Facility

The device driver provides an automatic dump facility for devices that support
reading a dump and indicating when a dump is available in device sense data.
Whenever a check condition occurs and the sense data indicates that a dump is
available, the device driver reads the dump from the device and stores it in the
/var/adm/ras directory. A maximum of three dumps for each device are stored in
this directory as:
Atape.rmtx.dump1
Atape.rmtx.dump2
Atape.rmtx.dump3
Note: X is the device number, for example, rmt0.
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.
Trace Facility
The AIX trace facility is supported for the device driver. The trace event is
identified with a hookword. The hookword used by the device driver is 326. The
trace can be initiated at any time before an operation on a tape device.
Enter the following AIX command to start the trace:

trace -a -j 326
This command starts the trace in the background and collects only the trace events
with the 326 hookword (Atape device driver).
Enter the following AIX command to stop the trace:

trcstop
This command stops the trace after the tape operations are performed.
Enter the following AIX command to view the trace:

trcrpt > trace.out
This command formats the trace output into a readable form and places it into a
file for viewing.
Atape System Trace (ATRC) Utility

The atrc trace utility is also installed with the device driver to start, stop, and
format a device driver trace. To start the trace, enter the atrc command. To stop
and format the trace, enter the atrc command again. The trace is formatted to an
atrc.out AIX file in the current directory.
Component Tracing
Later releases of AIX 5.3 and above support component tracing. Unlike system
tracing that needs to be started and stopped, component tracing by default is on
all the time and runs continually.
To determine if component tracing is available run the command ctctrl -q to

display a list of supported components with their default settings. You must have
root authority to run this command. Refer to the AIX ctctrl man page for a
complete description of the ctctrl command and parameters.

To dump and format the current component trace to a file (for example, actrc.out)
into the current directory, run the following commands:
ctctrl -D -c Atape
trcrpt -l Atape -o actrc.out
The Atape component trace can also be retrieved from a system dump. This
eliminates the need to start the Atape system trace prior to a system dump or to
recreate 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
Atape Component Trace (ACTRC) Utility

The actrc component trace utility is also installed with the device driver to dump
and format the current Atape component trace. To dump and format the
component trace, run the command actrc. The trace is formatted to an actrc.out file
in the current directory.
Tape Drive Service Aids

The service aids described in the following sections are accessible through the AIX
| diagnostic subsystem using the AIX diag command and in the Task Selection menu
| selecting IBM Tape Drive Service Aids. Refer to “Details of Tape Service Aids”
| below.
Tape drive service aids are also available using the "IBM Tape Diagnostic Tool
(ITDT)". Refer to Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 231.
Details of Tape Service Aids

The following service aid utilities are installed with the device driver:
v Force Microcode Dump
v Read Dump
v Microcode Load
v Error Log Analysis
v Reset Drive
v Create an FMR Tape
Force Microcode Dump

This utility forces a dump operation on the tape drive. After the dump operation is
performed, the dump data can be transferred from the tape drive using the Read
Dump utility.
To access this utility:

1. Open the Service Aids window.
2. Select Force Microcode Dump from the IBM Tape Drive Service Aids window,
then press Enter.
3. Select the device from the IBM Tape Drive Selection window, then press Enter.

The Force Microcode Dump operation starts, and a window opens when the
operation is completed.
Read Dump
This utility transfers the dump data from the device to a file, a diskette, or a tape
cartridge.

2. Select Read Dump from the IBM Tape Drive Service Aids window, then press
Enter.
4. Enter the destination file name or device in the Prompting for Destination
window. The default destination is the /dev/rfd0 diskette drive. To transfer the
dump data to a tape cartridge, enter the device name of the tape drive (for
example, /dev/rmt0). To transfer the dump data to a file, enter the file name.
Press F7 to commit.
Note: On certain terminal types, it may be necessary to press the Esc key and
the number 7 key 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.

2. Select Microcode Load from the IBM Tape Drive Service Aids window, then
press Enter.
3. Select the device from the IBM IBMTape Drive Selection window, then press
Enter.
4. Enter the source file name or device on the Prompting for Source File window.
The default source is the /dev/rfd0 diskette drive. To load from a file, enter the
file name. Press F7 to commit.
Note: On certain terminal types, it may be necessary to press the Esc key and
the number 7 key 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:
Warning: The drive is currently using FIPS code. Press Enter to

continue with downloading new drive code.
If you do not want to download the new code, press either F3 to cancel or F10
to exit without downloading new code. Otherwise, press Enter to continue with
the download code procedure.

The Microcode Load operation starts, and a window opens when the operation is
completed.
Error Log Analysis

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).

2. Select Error Log Analysis from the IBM Tape Drive Service Aids window, then
press Enter.
4. If entries are listed in the error log for the selected device, then the first entry is
displayed. Press Enter to display the next entry.
5. After all entries are displayed, a window opens, and the operation is
completed.
Reset Drive
This utility resets the tape drive.

2. Select Reset Drive from the IBM Tape Drive Service Aids window, then press
Enter.
3. Select the device from the IBM IBMTape Drive Selection window, then press
Enter.
The Reset Drive operation starts, and a window opens when the operation is
completed.
Create an FMR Tape

This utility creates a field microcode replacement (FMR) cartridge tape using the
loaded functional microcode in the tape drive.

2. Select Create an FMR Tape from the IBM Tape Drive Service Aids window,
then press Enter.
3. Select the device from the IBMTape Drive Selection window, then press Enter.
The Create an FMR Tape operation starts, and a window opens when the
operation is completed.
Performance Considerations
This chapter describes the parameters and issues that may affect the perceived
performance of the tape drive. In general, AIX applications that operate at a file
level to move data between disk storage devices and tape do not exploit the full
capabilities of a high end tape device. The goal of this discussion is to give an
overview of the data path components involved in moving data between disk
storage devices and tape. The following chapter describes basic techniques and
common utilities in a specific environment that can be used to understand how a

device is performing. Performance issues encountered by advanced application

developers are beyond the scope of this document.
v Refer to the hardware reference for the specific device for performance
specifications.
v Refer to the application documentation for information on device-specific
application configuration.
v Refer to the operating system documentation for information on disk storage
device striping and other techniques for improving file system performance.
Data Path
The simplified model in Figure 8 shows the components involved in the data path
for moving data at a file level between disk storage devices and tape.
Performance analysis must be approached by determining which component of the

data path impacts performance. Typically, a performance problem can be isolated
by looking at one leg of the data path at a time. The goal of this analysis is to
confirm that the tape data path is not impacting the performance adversely.
Figure 8. Data Path for AIX Device Driver (Atape)
Common AIX Utilities

The most commonly reported cause for poor tape performance is the use of small
block sizes or the modification of the installation defaults for the tape device.
Note: The device parameters should 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 should be enabled for maximum performance if the
data sent to the device is uncompressed.
2. The block_size parameter should be set to variable (block_size=0) and command
or application parameters specified to a block size appropriate for the device.
3. Block sizes of 128 KB or greater should be used to improve performance.
AIX iostat Utility for Tape Performance

In releases of AIX 5.3 and earlier, the AIX iostat utility supports tape performance
statistics in addition to other supported devices (such as disk). To determine if the
iostat utility supports the configured tape drives, run the command iostat -p. If the
configured tape drives are supported, a list of configured tape drives are displayed
with the statistics listed for each drive. Refer to the AIX iostat man page for a
complete description of the iostat command and parameters. When using the Data

Path Failover feature, only the primary path for the tape drive is listed. The
statistics apply to both the primary and alternate paths that are used.
Before Calling Support

System performance tuning is not a support responsibility. If tests indicate raw
tape performance is below specifications, record the exact failing command and
collect the output from the commands in Table 7 before contacting support.
Table 7. Error Description
Information Command
Configuration lscfg -v
Device parameters lsattr -E -l rmtN
Error log. Call hardware support if errors errpt -a
are found for TAPE_ERR* or SCSI* error
labels.
Driver version lslpp -l Atape.driver
Trace of failing command Refer to “Trace Facility” on page 46


Chapter 4. HP-UX Tape and Medium Changer Device Driver
Purpose . . . . . . . . . . . . . . . 53 Querying Primary and Alternate Path
Data Flow . . . . . . . . . . . . . . . 53 Configurations . . . . . . . . . . . . 80
Product Requirements . . . . . . . . . . . 54 Disable and Enable Primary and Alternate Paths 80
ATDD Implementation . . . . . . . . . 54 Data Path Failover and Load Balancing Support for
Hardware Requirements . . . . . . . . . 54 Tape Drives . . . . . . . . . . . . . . 81
Software Requirements . . . . . . . . . 55 Configuring and Unconfiguring Path Failover
Software Interface to the Device Driver . . . . 56 Support . . . . . . . . . . . . . . 81
Installation and Configuration Instructions . . . . 56 Primary and Alternate Paths. . . . . . . . 82
Installation and Configuration for PCI Drivers. . 56 Querying Primary and Alternate Path
Installation and Configuration of Precision Bus Configuration . . . . . . . . . . . . 83
Drivers . . . . . . . . . . . . . . . 64 Disable and Enable Primary and Alternate Paths 83
Supported Configuration Parameters . . . . . . 73 Problem Determination . . . . . . . . . . 83
Configuration Parameter Definitions . . . . . 73 Error Logging . . . . . . . . . . . . 83
Special Files . . . . . . . . . . . . . . 77 Reservation Conflict Logging . . . . . . . 83
Persistent Naming Support . . . . . . . . . 78 Sense Data Logging . . . . . . . . . . 84
Control Path Failover Support for Tape Libraries . . 79 Support_info Script . . . . . . . . . . . 84
Configuring and Unconfiguring Path Failover Tracing Facility . . . . . . . . . . . . 84
Support . . . . . . . . . . . . . . 79 Atdd_d Log Daemon . . . . . . . . . . 86
Primary and Alternate Paths. . . . . . . . 80 Problems and Solutions . . . . . . . . . 87
This chapter provides an overview of the IBM Tape and Medium Changer Device
Driver for HP-UX that provides support for IBM tape drives and medium changer
devices.
For tape diagnostic and utility functions refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 231.
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 running
HP-UX 10.20, 11.0, 11i v1, 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 section to identify this driver.
ATDD is designed specifically to take advantage of the features provided by the

IBM tape devices (refer to “Supported Hardware” on page 9. The goal is to give
applications access to the functions required for basic operations (such as backup
and restore) and the advanced functions 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 9 on page 54 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.

HP-UX Device Driver (ATDD)
SCSI or Fibre
ATDD Channel IBM
Application
Device Adapter Tape
Program
a250104
Driver Device Subsystem
Driver
Figure 9. Data Flow for HP-UX Device Driver (ATDD)
The following hardware and software components are required and supported by
the IBM Tape and Medium Changer Device Driver for HP-UX (ATDD).
ATDD Implementation
ATDD is actually a set of device driver implementations for operation in the
following HP-UX operating system environments:
v HP Precision Bus - HP-UX 10.20 (32 bit) - versions of this driver are identified
by levels ATDD 2.9.x.x.
v HP Precision Bus - HP-UX 11.00 (32 bit) - versions of this driver are identified by
levels ATDD 4.9.x.x.
v HP PCI Bus - HP-UX 11.00 (64 bit) - versions of this driver are identified by
levels ATDD 1.x.x.x.
v HP PCI Bus - HP-UX 11i v1 (64 bit) - versions of this driver are identified by
levels ATDD 3.x.x.x.
v HP PCI Bus - HP-UX 11i v2 (64-bit for Itanium® 2) - versions of this driver are
identified by levels ATDD 5.5.x.x.
v HP PCI Bus - HP-UX 11i v2 (64-bit for PA-RISC) - versions of this driver are
identified by levels ATDD 5.6.x.x.
v HP PCI Bus - HP-UX 11i v3 (64-bit for Itanium 2) - versions of this driver are
identified by levels ATDD IA.6.x.x.x.
v HP PCI Bus - HP-UX 11i v3 (64-bit for PA-RISC) - versions of this driver are
identified by levels ATDD PA.6.x.x.x.
ATDD supports the following HP SCSI host bus adapters:
v HP A4800A PCI Ultra SCSI Host Bus Adapter (HVD)
v HP A5159A PCI Dual Port FWD SCSI Host Bus Adapter (HVD)
v HP A5149A PCI to Ultra 2 SCSI Host Bus Adapter (LVD Single Port)
v HP A5150A Dual Channel PCI to Ultra 2 SCSI Host Bus Adapter (LVD Dual
Port)
v HP A6828A Ultra 160 SCSI Adapter (LVD Single Port)
v HP A6829A Ultra 160 SCSI Adapter (LVD Dual Port)
v HP-PB FWD SCSI-2 Host Adapter (HP 28696A) with firmware revision 3543 or
later (ATDD Precision Bus drivers)
v HP PCI-X Dual Port Ultra320 SCSI Host Bus Adapter (HP A7173A, LVD)
v HP PCI-X 2-P SCSI/1000Base-T Multifunction Adapter (HP AB290A, LVD) (11i
v3 only)
v HP PCI 1000Base-T and 1000Base-SX Adapter (HP A6794A, LVD) (11i v3 only)

v HP PCIe SC44Ge SAS Host Bus Adapter (HP AH303A, SAS) (11i v3 only)
ATDD supports the following HP Fibre Channel adapter:

v HP A5158A Fibre Channel Mass Storage adapter
v HP A6795A Fibre Channel PCI Tachyon XL2 host bus adapter
v HP AB378A/B and AB379A/B PCI-X Fibre Channel Adapter
v HP A6826A PCI-X Fibre Channel Adapter
Notes:
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 should 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 proposed by
the American National Standard of Accredited Standards Committee (NCITS).
4. Using 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 tape, disk, or both)
where disk and tape subsystems share a common HBA, stability problems have
been observed. These issues are resolved by separating disk and tape I/O
streams onto separate HBAs and using SAN zoning to minimize contention.
IBM is focused on assuring server and storage configuration interoperability. It
strongly recommends that your implementation plan includes provisions for
separating disk and tape workloads.
5. 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 needs to be set to L-port.
The most recent supported HBA information can be found at the following site:
http://www-01.ibm.com/servers/storage/support/config/ess/index.jsp
The following software is required and supported by ATDD:
v HP-UX operating system version 10.20, 11.0, 11i v1, 11i v2, and 11i v3.
v SCSI and FC Host Bus Adapter (HBA) is supplied by HP. Refer to HP’s
documentation for the SCSI and FC adapter to determine which patch is
required.
Chapter 4. HP-UX Tape and Medium Changer Device Driver 55

| The latest driver information can be found on our fix central website, which is
| explained in Appendix A, “Accessing Documentation and Software Online,” on
| page 317.
| Attention: To install ATDD in HP-UX 11i v3, some HP-UX patches must be
| applied first on the system. For the detailed information, refer to the atdd.Readme
| file which is downloaded with the driver.
Software Interface to the Device Driver

The IBM Tape and Medium Changer Device Driver for HP-UX provides the
following standard HP-UX entry points for IBM tape systems:
Open This entry point is driven by the open system function call.
Write This entry point is driven by the write system function call.
Read This entry point is driven by the read system function call.
Close This entry point is driven explicitly by the close system function
call and implicitly by the operating system at program termination.
IOCTL This entry point is driven by the input/output control (ioctl)
system function call. It provides a set of tape device, medium
changer device, and SCSI specific operations. It allows HP-UX
applications to access and control the features and attributes of
IBM SCSI tape subsystems programmatically.
For programming information, refer to the IBM Tape Device Drivers Programming
Reference, GA32-0566.

The following sections describe the installation and configuration for three types of
HP-UX devices.
Installation and Configuration for PCI Drivers

This chapter describes how to install, configure, and uninstall the IBM Tape and
Medium Changer Device Driver for HP-UX (ATDD) for PCI-based systems. By
default, ATDD automatically configures all supported IBM tape drives that are
attached and powered On when the system starts. ACDD, the changer part of
ATDD, does not configure IBM Medium Changer devices by default because many
applications use either their own changer drivers or the native schgr or sctl drivers.
In HP-UX 11.0, 11i v1 and v2, the ATDD package includes with atdd tape driver
and acdd changer driver dynamic loadable kernel modules (DLKM). In HP-UX 11i
v3, the ATDD package consists of five modules in the kernel:
v atdd - static tape driver kernel module
v acdd - static changer driver kernel module
v atdd_leg - static legacy tape driver kernel module
v acdd_leg - static legacy changer driver kernel module
v atdd_core - DLKM core kernel module
Overview of the Installation Process

During and after the ATDD is installed, ACDD, the changer part of ATDD, can be
set to configure (CLAIM) all attached IBM Medium Changer devices. Additionally,
selected IBM Medium Changer devices can be configured by running the swinstall

command with the -x ask=true command option, or by running

/opt/atdd/bin/atdd_claim –c c in 11.0, 11i v1 and v2. The installation process depends
on whether all IBM tape drives are to be configured by ATDD or only selected
ones, and whether configured tape drives exhibit default behavior or require
specific configuration settings. Additionally, for IBM Medium Changers, installation
selection or post-installation configuration can determine whether all IBM Medium
Changers should be configured, selectively configured, or NOT configured at all.
Make sure your system is ready to install ATDD before you begin. Follow these
steps to perform the install:
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, filenames 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 observing the preview
output, you can reissue the command without the -p flag to perform 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 may produce useful information and error messages, so 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 using the software distributor commands, you may 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 ensures that all
listed file systems are mounted before proceeding. This also helps ensure that files
are not loaded into a directory that may be below a future mount point, but it
often causes an error with NFS mounted file systems.
This error can be overridden using '-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.

Create the Drive Configuration File, (Optional)

If you are not using the standard device driver defaults, you must create a
configuration file that directs the device driver on how to customize driver
behavior for particular IBM TotalStorage and System Storage devices. If all
configured devices are to use the device driver configuration defaults, it is not
necessary to create a configuration file before installing the driver for ATDD.
The Drive Configuration File is required if:

v You are running a level of ATDD before level 1.7.1.0 on HP-UX 11.0.
v 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
“Power Off the Tape Drives” on page 59.
If you do need to create a Drive Configuration File, consult the following

instructions.
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 starting with # are ignored.
v No spaces may appear within each entry.
v No trailing comments may appear on a variable definition line.
Determine the Device Hardware Path for IBM Tape Drives: To determine the
device hardware path for IBM tape drives with a SCSI attachment, perform the
following steps:
1. Run ioscan to determine the hardware path (i.e., 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, perform the following steps:
1. Run ioscan to determine the hardware path (i.e., 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
Create the Hardware Path Entry: 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
Note: This example shows that three devices are CLAIMED by the ATDD. If you
have a single 3590 device operating in one LUN mode, then you would
have only a single ATDD_HWPATH entry. If you have four tape devices
attached, four ATDD_HWPATH entries are required in the configuration file.
Create the Device Specific Configuration Entries (Optional): The ATDD is

shipped with default settings for all configuration parameters. To change these
settings, an entry is made in the configuration file assigning an appropriate value
to the desired configuration variable. Each device may have a different value for
each configuration variable. The index number 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 “Create the Hardware Path Entry” on page 58).
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 8 on page 74 and Table 9 on
page 75 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.
Power Off the Tape Drives

When the ATDD software is initially installed, it attaches itself to all tape drives
that are in the CLAIMED state as shown by entering the command:
# ioscan -fk -C tape
Before you continue, make sure all devices CLAIMED with the preceding
command are devices you want this device driver to manage.
To list device file names in the /dev directory and its subdirectories, enter:
# ioscan -funC tape
In HP-UX 11i v3, you can also enter:
# ioscan -funNC 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

Install the Driver Using the ATDD Installation Script

An installation script (InstallAtdd) is provided to automate driver installation and
perform some checking functions. It copies the latest version of the driver to the
software depot and installs the latest driver version.
| To install ATDD with the script, download the install script with the driver at fix
| central, then run the install 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.
Notes:
1. If a previous version of ATDD is installed on your system, uninstall it before
attempting to install the latest version. Refer to “Uninstalling the software” on
page 64.
2. The system reboot is required to install ATDD in HP-UX 11i v3.
To install ATDD manually, follow the steps in “Install Drivers Manually.”
Install Drivers Manually

Installing the drivers manually requires the steps detailed in the following sections.
1. “Copy the Software to the Software Depot” on page 60.
2. “Install the ATDD Software” on page 60.
3. If a previous version of ATDD is installed on your system, uninstall it before
attempting to install the latest version. Refer to “Uninstalling the software” on
page 64.
Copy the Software to the Software Depot:
Attention: If you do not copy the ATDD software into a depot, you will not be
able to uninstall the product readily.
Copy the appropriate driver to the Software Depot. For example:
# swcopy -p -s /driver_location/atdd.x.x.x.x atdd (preview option)

# swcopy -s /driver_location/atdd.x.x.x.x atdd
Use swlist to verify that the ATDD software is in the depot:
# swlist -d atdd
Install the ATDD Software: 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 using 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.

Note: If an earlier version of the product is already installed on the target root file
system, the existing version is replaced. This is true even if the version
already installed is more recent than the version being installed.
The following commands install ATDD from the depot to the default root file
system by issuing the swinstall command with the ask options set as follows:
# swinstall -p -x ask=true atdd (preview option)

# swinstall -x ask=true atdd in HP-UX 11.0, 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 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
After the installation is completed, run the ioscan command to list the tape drives
found:
# ioscan -fknC tape
Class I H/W Path Driver S/W State H/W Type Description
============================================================================================
tape 0 0/3/0/0.5.0 atdd CLAIMED DEVICE IBM 03590E11
/dev/rmt/0m /dev/rmt/0mn /dev/rmt/c4t5d0BEST /dev/rmt/c4t5d0BESTn
/dev/rmt/0mb /dev/rmt/0mnb /dev/rmt/c4t5d0BESTb /dev/rmt/c4t5d0BESTnb
tape 1 0/3/0/0.6.0 atdd CLAIMED DEVICE IBM 03590B11
tape 4 0/5/0/0.1.23.232.0.0.2 atdd CLAIMED DEVICE IBM ULT3580-TD1
/dev/rmt/4mb /dev/rmt/4mnb /dev/rmt/c6t0d2BESTb /dev/rmt/c6t0d2BES
If you have enabled ACDD, run the following ioscan command to view the
medium changers found:
# ioscan -fnkC autoch
=======================================================================
autoch 0 0/3/0/0.5.1 acdd CLAIMED DEVICE IBM 03590E11
/dev/rmt/0chng
autoch 2 0/6/0/0.1.17.255.5.10.1 acdd CLAIMED DEVICE IBM 03590E11
/dev/rmt/2chng
autoch 4 0/5/0/0.1.23.232.0.0.1 acdd CLAIMED DEVICE IBM ULT3583-TL
/dev/rmt/4chng
In HP-UX 11i v3, run # ioscan -funNC tape or autoch to display the tape devices
configured with ATDD and ACDD drivers. Run #ioscan -funC tape or autoch to
show the tape devices bound with the legacy atdd_leg and acdd_leg drivers.

Configure all IBM Tape Drives/Media Changers with ATDD/ACDD: 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 install 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.
To configure all IBM Medium Changer devices on the system after the install of
the ATDD package:
v In HP-UX 11.0, 11i v1 and v2, run the command:
# /opt/atdd/bin/atdd_claim -c
v In HP-UX 11i v3, do the following:
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 remove the claim with ACDD after the next reboot:

v In HP-UX 11.0, 11i v1 and v2, run the command:
# /opt/atdd/bin/atdd_claim -u
v In HP-UX 11i v3, do the following:
1. Bind each changer device with a changer driver:
# ioscan -b -M acdd -H hw_path
2. Reboot the system to unconfigure the changer devices:
# shutdown -ry now
Configure Selected IBM Tape Devices with ATDD/ACDD in HP-UX 11.0, 11i v1
and v2:
Attaching Selected IBM Tape Devices to ATDD/ACDD During Auto Booting: To claim
a specific tape device with atdd/acdd during reboot, edit the "Claiming Device"
section in the file of /sbin/init.d/atdd.
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 line(s) 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
Attaching Selected IBM Tape Devices to ATDD/ACDD Dynamically: To dynamically

attach selected IBM tape device after the ATDD installation, run the following
commands.
1. To determine the HW path of the device:

# ioscan -fnk|grep IBM

2. To claim the device with ATDD/ACDD:
# /opt/atdd/bin/atdd_claim -H 0/3/0/0.5.1
Note: The dynamic attachment may be lost after the system reboots.
Attaching Selected IBM Tape Device with a Particular Driver: 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
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
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
Configure Selected IBM Tape Devices with ATDD/ACDD in HP-UX 11i v3: 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 3592E05 tape drive with the HP native tape driver estape, perform 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:
# ioscan -b -M estape -H 64000/0xfa00/0x7
3. Reboot the system:

# shutdown -ry now

4. Create the device special files if it does not exist after the system bootup:
# insf -H 64000/0xfa00/0x7
5. Verify the force binding:
# ioscan -fNk | grep IBM
tape 1 64000/0xfa00/0x7 estape CLAIMED DEVICE IBM 03592E05
Uninstalling the software:
Attention: Do not try to uninstall the ATDD software by simply deleting the files
that make up the ATDD fileset. This causes a number of inconsistencies on the
system. It is best to use the swremove command.
To uninstall ATDD (from the root file system):

# swremove atdd in HP-UX 11.0, 11i v1 and v2
# swremove -x autoreboot=true atdd in HP-UX 11i v3
Other Administrative Tasks: To determine whether the current version of ATDD

is installed or configured on the default root file system:
# swlist -a state atdd
To determine the versions of ATDD stored in the default depot:

# swlist -d atdd
To remove ATDD from the depot:

# swremove -d atdd
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 view the fileset of ATDD installed on the system:

# swlist -l file atdd
To display and manage ATDD kernel modules and kernel-tunable parameters, run
kmadmin, kmsystem, kmtute and kmadmin commands in HP-UX 11.0 and 11i v1
and kcmodule, kctune commands in HP-UX 11i v2 and v3, or go to the “Kernel
Configuration” in sam utility. Refer to the system manual for more detail.
For an example, print out the ATDD driver module status entering the command:
# kcmodule -d atdd
Module State Cause Description
atdd static explicit Advanced Tape Device Driver
Installation and Configuration of Precision Bus Drivers

This chapter describes how to install, configure, and uninstall the IBM Tape and
Medium Changer Device Driver for HP-UX (ATDD) for HP Precision Bus (HP-PB)
systems.
Make sure your system is ready to install ATDD before you begin. Follow these
steps to perform the install:

appropriately for installing ATDD.
3. Ensure that the tape drives to be managed by ATDD are powered on.
Note the following facts about the command sequences described in this section:
v In some of the examples, filenames given on the command-line must be
v All the software distributor commands (for example, swinstall or swcopy) can first
be run with the -p flag to preview the command. After observing the preview
output, you can reissue the command without the -p flag to perform 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 may 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 encounter unexpected results during the installation, check the associated
log file.
While using the software distributor commands, you may 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 ensures that all
listed file systems are mounted before proceeding. This also helps ensure that files
are not loaded into a directory that may be below a future mount point, but it
often causes an error with NFS mounted file systems.
This error can be overridden using '-x' to set the mount_all_filesystems option to
FALSE. When this option is used, the command finishes with a warning indicating
that no attempt is made to mount all file systems. For example
# swinstall -x mount_all_filesystems=false -x autoreboot=true atdd

WARNING: "hostname:/": There will be no attempt to mount filesystems
that appear in the filesystem table.
Create the Configuration File

A configuration file must be created that tells the device driver how to customize
your configuration. The file is named etc/rc.config.d/atdd.cfg 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.
Determine the Device Hardware Path for Enterprise Tape System 3590: To
determine the device hardware path, follow these steps:

1. Run ioscan to determine which SCSI adapter the 3590 drive is connected to.
for example, 56/40
3. Determine the SCSI target address of the 3590 drive. The panel on the front of
the 3590 drive displays the selected target address.
HWPATH = adapterpath.drivetargetaddress.0 (3590 one LUN mode)

or
HWPATH = adapterpath.drivetargetaddress.0
HWPATH = adapterpath.drivetargetaddress.1 (3590 random 2 LUN mode)
For a 3590 at SCSI target address 3 in random 2 LUN mode, the device
hardware paths are:
56/40.3.0
56/40.3.1
Determine the Device Hardware Path for Magstar MP 3570 Tape Subsystem:
The Magstar MP 3570 product family consists of stand alone tape drives (Models
B00 and C00) and library models with one or two tape drives. Models B01, B02,
B11, B12, C01, C02, C11, and C12 support a 20 cartridge, random access cartridge
loader and are known as library units. To control the operation of the library
mechanism, SCSI Medium Changer commands are issued to LUN 1 of one or both
of the drive ports depending on the library configuration.
Base configuration is intended for attachment of one or two drive libraries on a

single SCSI bus. Control of the library is accomplished by sending Medium
Changer commands to LUN 1 of drive 1 (the drive on the left as viewed from the
rear of the library). The hardware path definitions present in the atdd.cfg file must
include a definition for drive 1 LUN 1 for operation of the library mechanism.
Models B02, B12, C02, and C12 can operate in a split configuration where each
drive and a subset of the cartridge slots are viewed as an independent library. In
this case, a definition for LUN 1 for each drive must be present in the atdd.cfg file
to control each logical library independently. Typically, independent SCSI buses are
used for operation of each logical library.
To determine the device hardware path, follow these steps:

1. Run ioscan to determine which SCSI adapter the Magstar MP library drive is
connected to.
for example, 56/40
3. Determine the SCSI target addresses of the Magstar MP drives. The panel on
the front of the Magstar MP library displays the selected target addresses.
HWPATH = adapterpath.drivetargetaddress.0 (Magstar MP drive)

HWPATH = adapterpath.drivetargetaddress.1 (Magstar MP library changer)
For a Magstar MP library with a single drive at target address 3 in base
configuration, the device hardware paths are:

56/40.3.0
56/40.3.1
Determine the Device Hardware Path for Magstar MP 3575 Tape Libraries: Each
drive in a 3575 library can support an automation path for the logical library of
which it is a member by sending SCSI Medium Changer commands to LUN 1 of
the drive port. The 3575 Model L06 supports one logical library. The other 3575
tape libraries (Models L12, L18, L24, and L32) can support two or three logical
libraries depending on the specific model. The first drive in each logical library
must have LUN 1 configured to operate the automation for that logical library
(drive 1 for logical library 1, drive 3 for logical library 2, and drive 5 for logical
library 3). Other drives may have LUN 1 configured, but this is optional.
LUN 1 control of the library mechanism can be configured for any drive by way of
the front panel on the library. Conceivably, LUN 1 could be configured for two
drives in the same logical library, but this is unnecessary in most instances. In that
case, the automation conforms to the SCSI-3 Primary Commands standard for
multiple port behavior (except for the handling of reservations).
Access to a logical library is on a first-come, first-served basis for hosts accessing

the same logical library on different ports. Each port can accept commands while
the library is in use by another host by way of another port. The 3575 deviates
from the SCSI-3 specification in that device and element reservations issued on one
port apply only to those hosts that access that port. Initiators connected to the
same logical library through an alternate port are not subject to those reservations.
Special files for operation of the 3575 automation are based on the hardware path
definitions present in the atdd.cfg file. Target device LUN 1 also needs to be
enabled at the library operator panel for drives other than the first drive in each
logical library if they are used to accept automation commands. LUN 1 for the first
drive in each logical library is mandatory and is enabled automatically by the
library firmware.
To determine the device hardware path, follow these steps:

1. Run ioscan to determine which SCSI adapter the Magstar MP library drive is
connected to.
For example, 56/40
3. Determine the SCSI target addresses of the Magstar MP drives. The panel on
the front of the 3575 library displays the selected target addresses.
HWPATH = adapterpath.drivetargetaddress1.0 (Magstar MP drive)

HWPATH = adapterpath.drivetargetaddress2.0 (Magstar MP drive)
HWPATH = adapterpath.drivetargetaddress1.1 (3575 library control path)
For a 3575 library with two drives in one logical library (drive 1 at SCSI target 3
and drive 2 at SCSI target 4), the device hardware paths are:
56/40.3.0
56/40.4.0
56/40.3.1

Determine the Drive Hardware Path for IBM 3580 Ultrium Tape Drive, 3581 Tape
Autoloader with SCSI Attachment: To determine the hardware path for the 3580
Tape Drive and the 3581 Tape Autoloader with SCSI attachment, follow this
procedure:
1. Run ioscan to determine which SCSI adapter the IBM Ultrium drive or
autoloader is connected to:
2. Record the hardware path entry of the adapter, for example, 0/4/0/0.
3. Determine the SCSI target address of the IBM Ultrium drive (3580) or the drive
in the IBM 3581 Ultrium Tape Autoloader. The switch on the rear of the IBM
3580 Ultrium Tape Drive displays the selected SCSI target address.
The LCD panel on the front of the unit can display the drive (and medium
changer SCSI address) for the IBM 3581 Ultrium Tape Autoloader.
HWPATH=adapterpath.drivetargetaddress.0 (3580 drive)
or
HWPATH=adapterpath.drivetargetaddress.0 (3581 drive)
For an IBM 3581 Ultrium Tape Autoloader at SCSI target address 3, the drive
device hardware path is: 0/4/0/0.3.0
Determine the Drive Hardware Paths for IBM Ultrium Tape Libraries with SCSI
Attachment: To determine the hardware path for the 3582, 3583, and 3584 Tape
Libraries with SCSI attachment, follow this procedure:
1. Run ioscan to determine which SCSI adapter the IBM Ultrium Tape Library is
connected to:
2. Record the hardware path entry of the adapter, for example:
1/8/0/0
3. Determine the SCSI target addresses of the IBM Ultrium drives in the Tape
Library. The LCD panel on the front of the unit can display the drive (and
medium changer) SCSI addresses.
HWPATH=adapterpath.drivetargetaddress.0 (drive 1)
HWPATH=adapterpath.drivetargetaddress.0 (drive n)
The drive hardware paths for an IBM Ultrium 3583 Tape Library with a drive at
SCSI ID 3 and SCSI ID 5 are:
1/8/0/0.3.0
1/8/0/0.5.0
Determine the Drive Hardware Paths for IBM 3580 Ultrium Tape Drive, IBM
Ultrium Tape Libraries with Fibre Channel Attachment: To determine the
hardware path for the 3580 tape drive and the 3582, 3583, and 3584 tape library
with fibre channel attachment, follow this procedure:
1. Run ioscan to determine which hardware path the IBM Ultrium drive is
connected to:
# ioscan -f -C tape
2. Record the hardware path entry of the IBM Ultrium Fibre Channel drive. For
example,
0/5/0/0.8.0.255.7.9.0 (3580 stand alone tape drive)
0/8/0/0.8.0.0.0.0.2 (3583 drive 1)
0/8/0/0.8.0.0.0.0.3 (3583 drive 2)

Create the Hardware Path Entry for Ultrium Tape Drives: If devices are to be
configured with settings other than the defaults, entries defining the hardware
device paths must be placed in the /etc/rc.config.d/atdd configuration file. Create an
entry for each device that requires further configuration settings. The format for
the entries is HW_PATH[index]=DeviceHardwarePath. The index is used to identify
the device for control of the configuration settings in the next section.
For example:
ATDD_HWPATH[0]=0/4/0/0.1.0 (3580 stand alone SCSI drive)

ATDD_HWPATH[1]=1/10/0/0.5.0 (3581 SCSI drive 1)
ATDD_HWPATH[2]=1/10/0/0.6.0 (3581 SCSI drive 2)
ATDD_HWPATH[3]=0/5/0/0.0.0.255.7.9.0 (3580 stand alone FC drive)
ATDD_HWPATH[4]=0/8/0/0.8.0.0.0.0.2 (3583 SCSI drive 1 with SDG)
ATDD_HWPATH[5]=0/8/0/0.8.0.0.0.0.3 (3583 SCSI drive 2 with SDG)
This example shows that four devices are CLAIMED by the ATDD. The first
device, 3580 Stand Alone SCSI Tape Drive at SCSI target address 1, LUN 0, has
index=0. The second device, 3581 with two 3580 SCSI Tape Drives inside at SCSI
target addresses 5 and 6, LUN 0, has index=1 and 2 . The third device, 3580 Stand
Alone FC Tape Drive at target 9, LUN 0, has index=3. The last one is 3583 with
SAN Data Gateway (SDG) Module and two 3580 SCSI Tape Drives at target 0,
LUN 2 and 3 (index=4 and 5).
Create the Hardware Path Entry: You must tell the driver which hardware path
you want to attach to. Create an entry in the /etc/rc.config.d/atdd.cfg configuration
file for each device you want the driver to attach. For example
ATDD_HWPATH[0]=56/40.1.0
ATDD_HWPATH[1]=56/40.6.0
Note: This example shows that two devices are CLAIMED by ATDD. If you have
a single 3590 device operating in one LUN mode, then you would have only
a single ATDD_HWPATH entry. If you have three tape devices attached,
three ATDD_HWPATH entries are required in the configuration file. For
3590 devices configured in random 2 LUN mode, two hardware path entries
are required. One is needed for the drive (LUN 0), and one is needed for the
ACF (LUN 1).
At least one hardware path entry is required in the configuration file.
Create the Device Specific Configuration Entries (Optional): The ATDD is

shipped with default settings for all configuration parameters. To change these
settings, an entry is made in the configuration file assigning an appropriate value
to the desired configuration variable. Each device may have a different value for
each configuration variable. The index number 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 allows application control back from the device before rewind is complete for
the device at hardware path 56 / 40.1.0 (based on the hardware path entry in
“Create the Hardware Path Entry” on page 69).
Example 2:

ATDD_TRAILER[1]=1
This allows write operations after an early end-of-tape warning for the device at
hardware path 56 / 40.6.0. Refer to Table 8 on page 74 and Table 9 on page 75 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.
Power Off the Tape Drives

When the ATDD software is initially installed , it attaches itself to all tape drives
that are in the CLAIMED state as shown by entering the command:
# ioscan -fk -C tape
Before you continue, make sure all devices that report CLAIMED with the
preceding command are devices 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 be configured by this
driver, power Off the tape drive and run ioscan without the '-k' argument as
follows:
# ioscan -f -C tape
Install the Drive Using the ATDD Installation Script

An installation script (Install Atdd) is provided to automate driver installation and
perform some checking functions. It copies the latest version of the driver to the
software depot and installs the latest driver version.
| To install ATDD with the script, download the install script with the driver at fix
| central, then run the install 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: If a previous version of ATDD is installed on your system, uninstall it before

attempting to install the latest version.
To install ATDD manually, follow the steps in “Install Drivers Manually” on page
60.
Copy the Software to the Software Depot

Attention: If you do not copy the ATDD software into a depot, you will not be
able to uninstall the product readily.
# swcopy -p -s /driver_location/atdd.x.x.x.x atdd (preview option)

# swcopy -s /driver_location/atdd.x.x.x.x atdd

Use swlist to verify that the ATDD software is in the depot:
# swlist -d atdd
Review the ATDD README File

After copying the ATDD software to the depot, use the swlist command to view
the README file under the directory /opt/OMImag/Readme.
# swlist -d -a readme atdd
The README file lists the system configuration requirements, including required
system software patches and required tape related firmware versions. The file also
documents any changes in the installation, use, and administration of the software
that occurred after this documentation was completed. It is therefore very
important that you review it before proceeding with the software installation.
Install the ATDD Software

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 using the HP-UX
swinstall command. If the target root file system is the primary, the ATDD software
is configured automatically upon installation.
Configuration requires restarting the system and rebuilding the kernel. This
requires you to issue the swinstall command with the -x autoreboot option set to
TRUE, as described below.
If the target is an alternate root file system, the ATDD software is not configured
automatically.
Note: If an earlier version of the product is already installed on the target root file
system, the existing version is replaced. This is true even if the version
already installed is more recent than the version being installed.
The following commands install ATDD from the depot to the default root file
system:
# swinstall -p atdd (preview option)

# swinstall atdd
If you get an error message stating that this product needs to restart the system,
reissue the swinstall command with the autoreboot option set as follows:
# swinstall -p -x autoreboot=true atdd (preview option)

# swinstall -x autoreboot=true atdd
You can use swlist to list the software 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

After the installation is completed, run the ioscan command to list the tape drives
found:
# ioscan -fknC tape
============================================================================================
tape 1 0/3/0/0.6.0 atdd CLAIMED DEVICE IBM 03590B11
tape 4 0/5/0/0.1.23.232.0.0.2 atdd CLAIMED DEVICE IBM ULT3580-TD1
If you have enabled ACDD, run the following ioscan command to view the
medium changers found:
# ioscan -fnkC autoch
=======================================================================
/dev/rmt/0chng
autoch 2 0/6/0/0.1.17.255.5.10.1 acdd CLAIMED DEVICE IBM 03590E11
/dev/rmt/2chng
/dev/rmt/4chng
Adding an IBM Tape Device Using the Currently Installed ATDD

To add an IBM tape device using the currently installed ATDD, perform the
following steps:
1. Modify the /stand/system file, adding a stanza in the form of:
driver 56/48.3.0 atdd
with the adapter/drive path for your device.
2. Modify /etc/rc.config.d/atdd.cfg, adding the hardware path and instance:
ATDD_HWPATH[#]=56/48.3.0
Where: # denotes the next instance and the adapter/drive path for your device.
3. Build the kernel as root:
# mk_kernel -o /stand/vmunix -s/stand/system
4. Restart the system:
# shutdown -ry now
or
# reboot
5. After the system is up, run /opt/OMImag/bin/atdd_mksf to create the new special
files for the device.
atdd_mksf -ti <instance>
Where: <instance> is the number from the ioscan output for the newly installed
device. This command echoes to console but does NOT create special files. To
create the special files, pipe the command to sh as follows:
# atdd_mksf -ti <instance> | sh
Note: A manual process is required for applications using the HP native spt or sctl
drivers as a changer driver (the sctl driver for the ext_bus C700 or C720, the
spt for the other ext_bus). This manual process requires having the right

driver in the kernel, possibly a binding statement in the kernel, and making
a device file. Related man pages are scsi_ctl (7) and scsi_pt (7).
Other Administrative Tasks

To determine the versions of ATDD currently installed on the default root file
system:
# swlist -a state atdd
To determine the versions of ATDD stored in the default depot:
# swlist -d state atdd
To view the set of files that is installed with ATDD:
# swlist -l file atdd
To remove ATDD from the depot:
# swremove -d atdd
If more than one level of ATDD exists in the depot, explicitly specify the level to
# swremove -d atdd,r=4.9.0.0
Supported Configuration Parameters

This chapter describes the supported configuration values for multiple device types
being configured on the same system. The configuration parameters are global.
Because the configuration parameters are global to all devices, it is necessary to
use configuration values that perform reliably on all devices attached to your
system. If you are experiencing difficulties, ensure that your driver is configured
properly. To check your current configuration, use the atdd_cfg program located in
/opt/OMImag/bin for the static PB driver and in /opt/atdd/bin for the PCI driver. For
program usage, execute as follows:
For PB driver:
# /opt/OMImag/bin/atdd_cfg -h
For PCI driver:
# /opt/atdd/bin/atdd_cfg -h
Configuration Parameter Definitions

This section describes the configuration parameters and values. Modifying the
default settings is not recommended unless instructed to do so. The ATDD is
shipped with default values that allow the most reliable execution across various
device types.
Device-Specific Parameters
Some of the configuration parameters are device-specific, while others are
driver-specific. Table 8 on page 74 shows the parameters that are device-specific,
what they mean, and their values.

Table 8. 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 default)
Indicator
v 1=On (suppress)
FORCE_NARROW (Precision Bus Width at which the driver v 0=Wide (16 bit wide data transfers, by
Driver only) negotiates for data transfers default)
v 1=Narrow (8 bit wide data transfers)
DISABLE_COPYIN_THRESHOLD Protect against nonaligned v 0=Off (check buffers for alignment, by
(Precision Bus Driver only) buffers default)
v 1=On (use buffers without checking
alignment)
COPY_THRESHOLD (Precision Bus Minimum buffer size to start Size in bytes to force alignment check, 0 by
Driver only) checking for proper alignment default.
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 Logical Value returned for writes past EOM, 28 by
End Of Tape) default.
RESERVE Multiple open for the device v 1=On (reserve the device after to open,
by default)
v 0=Off (do not reserve the device after to
open) (multiple open support)
|| RESERVE_KEY The user specifies the Persistent v 0 (the driver assigns the key by default)
| Reservation key that will be used
|| by the device driver when the
v A string of 1-8 character ASCII
|| Persistent Reservation is used.
alphanumeric key such as "key12345". If
| less than 8 characters are used, the
| remaining characters will be set to
| 0x00(NULL)
WFM_IMMEDIATE Immediate Mode for Write File v 0=Off (wait for write file mark
Mark completion, by default)
v 1=On (return before write file mark is
complete)

Table 8. Device-Specific Parameter Definitions (continued)

PRE_V3_COMPAT Use to share tapes with blocksize v 0=Off (always write or read the date
> 256kb with HP-UX 11i v2 or using the blocksize defined by user, by
earlier. Supported in HP-UX 11i default)
v3 only.
v 1=On (split the blocksize less than 256 kb
during the read or write)
Driver-Specific Parameters
Some of the configuration parameters are device-specific, while others are
driver-specific. Table 9 shows the parameters that are driver-specific, what they
mean, and their values.
Table 9. Driver-Specific Parameters (Global)
INSTANCE ATDD Device Number (Read Only)
DEVICES Number of Configured Devices (Read Only)
MINPHYS Check/Adjust Transfer Count v 0=Use OMI minphys
(Precision Bus
v 1=Use HP-UX minphys
Driver only)
Modifying Configuration Parameters

To change a configuration parameter, use the atdd_cfg program located in
/opt/OMImag/bin for the PB driver and in /opt/atdd/bin for the PCI driver. You can
update the current value.
v In HP-UX 11.0, 11i v1 and v2:
For example, if you want to change the COMPRESSION parameter to 0 for the
device at hardware path 0/4/0/0.1.0, do the following:
# atdd_cfg -g INSTANCE 0/4/0/0.1.0

INSTANCE: 2
The ATDD instance number for this device is returned. You must use this
INSTANCE value (1) to set the COMPRESSION value for this device.
# atdd_cfg -s COMPRESSION 0 2
Or, to get or modify COMPRESSION by using the hardware path:
# atdd_cfg -g COMPRESSION 0/4/0/0.1.0
# atdd_cfg -s COMPRESSION 0 0/4/0/0.1.0
v In HP-UX 11i v3:
The usage of atdd_cfg command is:
atdd_cfg -d special_file [-o parameter [-w value]]
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 specific parameter, run #atdd_cfg -d special_file -o parameter -w

value
For example,
# atdd_cfg -d /dev/rtape/tape14_BESTn -o COMPRESSION -w 0
Success
To set a new BOOT default value for the configuration parameter, you must
modify or add an entry in the atdd.cfg configuration file located in /etc/rc.config.d for
the static driver or the atdd configuration file located 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:
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 additional instructions about using the configuration program, use
the -h option as follows:
# atdd_cfg -h
Configurable Kernel Parameters (Tunable)

ATDD provides the following variety of configurable kernel parameters that allow
the users to customize for specific setup:
v atdd_log_trace
Log the sense data in syslog when a hardware or medium error is occurred, see
“Sense Data Logging” on page 84 for additional details. This parameter is
enabled by default on 11i v3 and later, but disabled by default in 11iv3 and
earlier.
v alternate_pathing/atdd_alternate_pathing
Enable or disable the alternate path support for CPF/DPF (see the specific
operating system section that covers CPF and DPF support for detail). This
parameter is enabled by default.
v atdd_disable_reserve/atdd_disable_res
Allows the user to disable the reservation management from ATDD. This
parameter off by default.
v atdd_loadbalance

Allows the user to disable automatic load balancing from ATDD. This parameter
is On (1) by default and supported on 11iv3 only
v atdd_reserve_type
The drive is reserved in the SCSI-2 Reserve command when Data Path Failover
(DPF) is disabled by default. To reserve the drive using Persistent Reserve In
and Out commands, the user can set the value of atdd_reserve_type to 3. The
default value for the tunable: 1 - Reserve(6) command; 2 - Reserve(10) command
(Unsupported); 3 - Persistent Reserve In/Out commands
To change the value of tunable, run the command kctune/kmtune or SAM (System
Administration Manager) tool.
Special Files
For each drive configured by ATDD, twelve or thirteen special files are created:
twelve special files are generated for a 3590 with ACF set to Manual, Automatic,
System, Accumulate, Random, or Library mode. A thirteenth 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).
ATDD creates the tape device special files in three forms: the standard or long file
name, an alternative short file name based on the instance number, and an
alternative short file name not based on the instance number. BEST represents the
operational capabilities likely to be required, including the highest density/format
and data compression, if supported by the device. Each set of special file names
(long and short) contains four special files that have all combinations of n and b
options, as shown in Table 10 and Table 11. For more information, refer to the mt(7)
man pages.
Table 10. Special Files
BSD Rewind on
Special File Name Compatibility Close
/dev/rmt/<instance#>m No Yes
/dev/rmt/<instance#>mb Yes Yes
/dev/rmt/<instance#>mn No No
/dev/rmt/<instance#>mnb Yes No
/dev/rmt/s<#>m No Yes
/dev/rmt/s<#>mb Yes Yes
/dev/rmt/s<#>mn No No
/dev/rmt/s<#>mnb Yes No
/dev/rmt/<instance#>t<target>d<LUN>BEST No Yes
/dev/rmt/<instance#>t<target>d<LUN>BESTb Yes Yes
/dev/rmt/<instance#>t<target>d<LUN>BESTn No No
/dev/rmt/<instance#>t<target>d<LUN>BESTnb Yes No
/dev/rmt/<instance#>chng N/A N/A
Table 11. New Special Files in HP-UX 11i v3

BSD Rewind on
/dev/rtape/tape#_BEST No Yes

Table 11. New Special Files in HP-UX 11i v3 (continued)

BSD Rewind on
/dev/rtape/tape#_BESTb Yes Yes
/dev/rtape/tape#_BESTn No No
/dev/rtape/tape#_BESTnb Yes No
/dev/rchgr/autoch# N/A N/A

atdd_lssf in /opt/OMImag/bin for the static driver and in /opt/atdd/bin for the
DLKM driver lists information about a special file. For example:
#atdd_lssf /dev/rmt/393mnb
atdd card instance 30 available at address Major = 79 Minor = Ox1E90C0
settings = No Rewind, Berkeley, Best Format,
IBM 03590H1A /dev/rmt/393mnb
v In HP-UX 11i v3:
ATDD supports the HP-UX lssf, insf and rmsf commands. To display special file
information, enter the lssf command. For example,
# lssf /dev/rtape/tape14_BESTnb
atdd Berkeley No-Rewind best density available at address 64000/0xfa00/0x32
/dev/rtape/tape14_BESTnb
# 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.

Persistent naming support is used to ensure that attached devices are always
configured with the same logical name across system reboots. For this purpose, the
HP-UX tape driver creates an additional set of device special files with a prefix of
“s” for the configured tape drives in HP-UX 11.0, 11i v1 and v2, such as s55m in
the following example.
# ioscan -funC tape
===================================================================================
tape 103 1/0/0/0.97.25.255.2.7.0 atdd CLAIMED DEVICE IBM 03592E05
/dev/rmt/103m /dev/rmt/c10t7d0BESTn /dev/rmt/s55mb
/dev/rmt/103mb /dev/rmt/c10t7d0BEST /dev/rmt/s55mn
/dev/rmt/103mn /dev/rmt/c10t7d0BESTb /dev/rmt/s55m
/dev/rmt/103mnb /dev/rmt/c10t7d0BESTnb /dev/rmt/s55mnb
In HP-UX 11i v3, HP introduces the native multi-pathing and path-independent

persistent Device Special Files (DSFs) and the auto discovery of devices greatly to
enhance the overall manageability. The ATDD does not create the additional set of
device special files with a prefix of “s”.
The persistent DSF format for tape devices introduced with the Agile view in
HP-UX 11i v3 is:
# ioscan -funNC tape
===================================================================
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
# ioscan -funNC autoch

=================================================================
autoch 8 64000/0xfa00/0xa acdd CLAIMED DEVICE IBM 03584L22
/dev/rchgr/autoch8
To map a persistent DSF to its legacy DSF, enter the following:

# ioscan -m dsf /dev/rtape/tape1_BESTb
Persistent DSF Legacy DSF(s)
========================================
/dev/rtape/tape1_BESTb /dev/rmt/c3t15d0BESTb
/dev/rmt/c9t6d0BESTb

Notes:
1. The library control path failover feature code must be installed prior to
enabling the path failover support in the HP-UX ATDD device driver. Refer to
“Automatic Failover” on page 10 for what feature code may be required for
your machine type.
2. It is a requirement that applications must open the primary path for CPF

Path failover support is enabled automatically when the device driver is installed;
however, the driver provides a kernel parameter you can use to enable library
control path failover. To enable the failover support in the ATDD driver, perform
the following steps after installing the driver:
1. Set the alternate_pathing parameter:
# /opt/atdd/bin/atdd_failover -a 1
2. Reconfigure CPF for the devices:
# /opt/atdd/bin/atdd_claim
v In HP-UX 11i v3:
Run kctune to enable the kernel tunable of atdd_alternate_pathing. ATDD
handles the CPF in the next open.
# kctune atdd_alternate_pathing=1
* 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) 0 0 Immed
(now) 1 1
You can check if the driver has recognized multiple control paths for your
library by running:
#ioscan -funC autoch
If you see .altpath next to one of the special files in HP-UX 11.0, 11i v1 and v2,
then you have 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 265 or “Display All Paths” on page 308 in tapeutil 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, perform the following steps:
1. Clear the alternate_pathing parameter:
2. Reconfigure CPF for the devices:
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.
(now) 0 0

When ATDD is loaded into the kernel, the first logical medium changer device that
it sees in the system is the primary path for that medium changer. The other
logical medium changers that ATDD attached for the same medium changer are
configured as alternate paths. The device driver supports up to 16 physical paths
for a single device.
On HP-UX 11i v3, the HP-UX system always selects the best path for ATDD to
open so the primary path is dynamically assigned from the system. ATDD does
not provide any .altpath special file.
The primary and alternate path information can be obtained by using the
following command on HP-Ux 11.0, 11i v1 and v2:
# ioscan -funC autoch
The following is an example of what you might see:

/dev/rmt/0chng
/dev/rmt/1chng.altpath
Querying Primary and Alternate Path Configurations

You can display the primary and alternate path configuration for all devices by
running the ioscan command, as explained in section “Determine the Device
Hardware Path for IBM Tape Drives” on page 58.
Disable and Enable Primary and Alternate Paths

When you load the ATDD device driver with the alternate_pathing parameter set
to ON, by default, all the available paths for a physical device are enabled.

If it is necessary to disable a path and not perform path fail over (for example due
to maintenance), run commands to disable and then later enable the primary and
alternate paths.
The commands to enable and disable primary and alternate paths are tape
diagnostic and utility functions.
Note: See Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 231..
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 alternate physical path when a permanent error occurs
on one path.
2. Dynamic load balancing for devices using multiple Host Bus Adapters (HBA).
On HP-UX 11i v3, HP-UX system always pickups a best path for ATDD to
open; ATDD doesn't perform a dynamic load balancing in open.
Notes:
1. Data Path Failover is not supported when using block sizes greater than 256K,
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).
3. Data Path Failover is supported for 3592 tape drives on HP-UX 11.0, 11i v1, v2
and v3, and for Ultrium-3 and Ultrium-4 drives on HP-UX 11i v1, v2 and v3.

Path failover support is turned on automatically when the device driver is
installed. However, you need to provide the data path failover feature key and
reclaim the devices using the atdd_claim script. The feature key is a string with 16
characters and numbers.
To enable the failover support in the IBMtape device driver software, perform the
following steps after installing the driver:
1. Edit the following line in your /sbin/init.d/atdd file:
DPF_KEYS="1234567890123456; 0987654321123456 "
Notes:
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 needs to
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 11.0, 11i v1 and v2:
3. In HP-UX 11.0, 11i v1 and v2, you can check whether the driver has recognized
multiple data paths for your drives by running:
#ioscan -funC tape
If you see a ".altpath" next to one of the special files, then you have 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.
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, perform the following steps:
In HP-UX 11.0, 11i v1 and v2:

1. Clear the alternate_pathing parameter. (You can ignore the message about
rebooting the system.)# /opt/atdd/bin/atdd_failover -a 0
2. Reconfigure DPF for the devices:
In HP-UX 11i v3:
Run kctune to disable the kernel tunable of atdd_alternate_pathing. ATDD handles

the DPF in the next open.
(now) 0 0
If you want to turn the data path failover feature back on in the ATDD driver,
perform the following steps:
In HP-UX 11.0, 11i v1 and v2:

1. Set the alternate_pathing parameter. (You can ignore the message about
rebooting the system.)
2. Reconfigure DPF for the devices:
In HP-UX 11i v3:
Run kctune to enable the kernel tunable of atdd_alternate_pathing. ATDD handles

the DPF in the next open.
(now) 1 1

When ATDD is loaded into the kernel, the first logical device that it sees in the
system is the primary path for that medium changer. The other logical paths that
ATDD attached for the same tape drive are configured as alternate paths. The
device driver supports up to 16 physical paths for a single device. In HP-UX 11i

v3, the HP-UX system always pickups a best path for ATDD to open so the
primary path is dynamically assigned from the system. ATDD does not provide
any .atlpath special file.
The primary and alternate path information can be obtained by issuing the
following command except in HP-UX 11i v3:
# ioscan -funC tape
The following is an example of the output for this command:

/home/root# ioscan -funC tape
===============================================================================
tape 0 0/1/0/0.101.22.255.1.1.1 atdd CLAIMED DEVICE IBM ULT3580-TD3 /dev/rmt/0m
tape 1 0/1/0/0.101.22.255.1.2.1 atdd CLAIMED DEVICE IBM ULT3580-TD3 /dev/rmt/1m.altpath

running ioscan, as explained in section “Primary and Alternate Paths” on page 82.
Diagnostic Tool (ITDT),” on page 231..

alternate paths.
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 which provide information regarding the problem.

device has been opened it will log a reservation conflict in the HP-UX system log
of /var/adm/syslog/syslog.log. Prior to logging the error the device driver will issue a
Persistent Reserve In command to determine if a SCSI Persistent Reservation is
active on the reserving host to get the reserving host initiator WWPN (World Wide
Port Name) and reserve key. If successful, the device driver will log this
information in the detail data below. After initially logging the reserving host
WWPN, subsequent reservation conflicts from the same reserving host WWPN and
reservation key will not be logged to prevent multiple entries in the system log

until either the reserving host WWPN or reservation key is different than the one
initially logged or the device driver has reserved the device and then another
Here are the log examples:

1. The information is logged when the drive is reserved with a Persistent
Reservation.
atdd: device=rtape41 Reserved. Reserving host key DF25382049E627E6
WWPN 21:00:00:E0:8B:11:8B:B1
2. The information is logged when the drive is reserved with a SCSI-2 Reserve.
atdd: device=rtape41 Reserved. Device reserved with legacy reserve.
Sense Data Logging

When the tape drive responds with CHECK CONDITION status and associated
sense keys of 0x1 (Recovery Error), 0x3 (Medium Error), 0x4 (Hardware Error) and
0xB (Aborted Command) for a hardware or medium error, the sense data is logged
into the system log file (typically /var/adm/syslog/syslog.log). The sense data logging
feature is disabled by default on 11.0, 11i v1 and 11i v2 and enabled by default on
11i v3. To enable the support dynamically, run /opt/atdd/bin/atdd_cfg with the -c
option.
# /opt/atdd/bin/atdd_cfg -c 1
* The requested changes have been applied to the currently running system.
atdd_log_trace (before) 0 Default Immed
(now) 1 1
Support_info Script
Run the support_info script, located 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 should be verified for correctness.
Log in as userid "root" on the system which 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
DLKM
/opt/atdd/bin/support_info > support_info.out
Tracing Facility
Running the ATDD_trace utility, located 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 displayed by enabling more trace flags. Issuing atdd_trace -f 0x1fffffff
turns on every trace.
Enter the following commands to start the trace:

1. First, determine which items need to be traced and set the trace flags 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 11iv3, run the sam utility or # kctune atdd_trace_level=1 command
to set the trace level to 1. The default set is 3.
The set of trace flags is displayed in Table 12.
Table 12. 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
2. Clear the trace buffer:

For the Static driver:/opt/OMImag/bin/atdd_trace -c
For the DLKM driver:/opt/atdd/bin/atdd_trace -c
3. To have trace data displayed immediately in a readable format as it is collected:
For the Static driver:/opt/OMImag/bin/atdd_trace -b
For the DLKM driver:/opt/atdd/bin/atdd_trace -b
4. Start the operations on a tape device.
5. To display collected trace data in a readable format at any time:
For the Static driver:/opt/OMImag/bin/atdd_trace -d
For the DLKM driver:/opt/atdd/bin/atdd_trace -d
6. The atdd_trace output can be redirected to place the trace data in a readable
format into a file, by entering:
For the PB driver:/opt/OMImag/bin/atdd_trace >trace.txt
For the PCI driver:/opt/atdd/bin/atdd_trace >trace.txt
7. In HP-UX 11i v3, the ATDD trace is logged into syslog of /var/adm/syslog/
syslog.log once the kernel tunable of atdd_direct_trace is enabled. To set a
value (0 or 1) to atdd_direct_trace, run # kctune atdd_direct_trace=value.

Atdd_d Log Daemon

The device driver provides a log daemon (atdd_d) facility for the Enterprise Tape
System 359x to automatically store drive dumps, to retrieve and store SIM/MIM
(Service and Media Information Messages) data, and to log error messages into the
/var/adm/atdddirectory. The atdd_d log daemon is not automatically started in 11.0,
11i v1 and v2 but not in 11i v3, when the driver is installed.
The following steps document how to start and configure the daemon:
1. Start the daemon by running:
For the Static driver:
#/opt/OMImag/bin/atdd_d
For the DLKM driver:
#/opt/atdd/bin/atdd_d
2. Check whether the daemon is running by entering:
#ps -ef | grep atdd_d
3. To view and/or modify the settings for the daemon, enter:
# /opt/OMImag/bin/atdd_d -h
usage: atdd_d [options]
# /opt/atdd/bin/atdd_d -h
usage: atdd_d [options]
[-d <log directory>] default is /var/adm/atdd
[-n <maximum number of dumps>] default is 10
[-z <maximum size of a dump>] default is 1048576
[-s <maximum size of a log>] default is 100000
For example, to decrease the number of drive dumps to store from 10 to 6 and
change the log directory to /tmp/drive_dump, do the following:
#/opt/OMImag/bin/atdd_d -n 6 -d/tmp/drive_dump
#/opt/atdd/bin/atdd_d -n 6 -d/tmp/drive_dump
4. View the atdd_d.log, which provides information about the daemon start time,
message type (1 for the drive dump, 2 for SIM/MIM data, and 3 for Error
message), time stamp, H/W path, and size. Refer to an example in Figure 10 on
page 87.

Figure 10. Example of atdd_d.log Output
Note: No entry is made in the log file when the daemon stops. Run #ps -ef |
grep atdd_d to check if the daemon is stopped.
5. Stop the daemon by using the following commands:
Get the daemon process id: #ps -ef | grep atdd_d
kill the daemon process: #kill -9 process_id
Problems and Solutions

Table 13 describes problems and possible solutions for errors you may encounter
with the DLKM driver.
Table 13. Problems, Reasons, and Solutions
Problem Reason and Solution
The system hangs running rmsf -H on HP-UX 11i. DLKM Infrastructure does not set the correct flag in the
device switch table entry for a DLKM driver that uses.
Install HP patch PHKL_29818
ATDD DLKM modules are not loaded in the running The current kernel is not matching the symbol table
kernel. (DLKM) in /stand/dlkm
A message in the file /var/adm/syslog/syslog.log Need to rebuild the kernel by running the following
"vmunix: WARNING: modpath: DLKM is not initialized" commands:
#cd /stand/build
#/usr/lbin/sysadm/system_prep -s /stand/build/system
#/usr/sbin/mk_kernel -s /stand/build/system
#mv /stand/system /stand/system.prev
#mv /stand/build/system /stand/system
#kmupdate /stand/build/vmunix_test
#shutdown -ry now
A message in the file /var/adm/syslog/syslog.log ATDD DLKM Module's component files are not copied
"modld: Attempt to load unregistered module " to certain subdirectories of /usr/conf and /stand
Remove ATDD and try to install it again.

Table 13. Problems, Reasons, and Solutions (continued)

Problem Reason and Solution
# kmtune | grep atdd The file .kmsystune_lock was removed manually.
kmtune: Cannot open file -- /stand/.kmsystune_lock Use the following command to create the
.kmsystune_lock file again:
# touch /stand/.kmsystune_lock
IBM tape devices not claimed in ioscan -fnk display As "root", verify the drivers loaded in the running kernel
using `kmadmin -s`
If status is "LOADED"
then run ’atdd_claim -b’ to claim all IBM devices,
then run ’atdd_claim -t’ to claim the tape drives,
then run ’atdd_claim -c’ to claim the changers.
If status is "UNLOADED"
then run ’kmadmin -L atdd’ to load the ATDD,
then run ’kmadmin -L acdd’ to load the ACDD,
then run ’atdd_claim’ to claim the tape devices.
If status is still "UNLOADED", then check the entries of
the files 'atdd' and/or 'acdd' in /etc/loadmods
If no atdd and/or acdd file entries exist, the driver may
be statically bound to the kernel or the ATDD package
may not be installed. Check the installation running the
following command:
# swlist atdd
No special files found in /dev/rmt Execute the atdd_mksf and acdd (if you have changers
managed by the acdd driver) scripts found in
/opt/atdd/bin
atdd_mksf and acdd_mksf
Note: The script prints out the commands that are

necessary to create the special files. To create the files
you must "pipe" the output to shell (sh), using the
following commands:
atdd_mksf | sh
acdd_mksf | sh
The special files for a device are duplicates. Remove all of the special files for the device in /dev/rmt
Create the special files again by running the commands
atdd_mksf or acdd_mksf
No special files are created by HP Stape and Schgr after Create the special files by running the command:
installing ATDD # insf -e
Cannot open Special File and the system log has the Wrong DENSITY setting. Check the current value by
following message: running the command:
Invalid SCSI request in data at bit 7 of byte 4 atdd_cfg -g DENSITY
Try setting value to 0 (zero) by running the command:
atdd_cfg -s DENSITY 0
An attempt to read data times out and returns an error Make sure the SILI configuration parameter is "1". This
and the system log has the following messages: can be checked by running the command:
A SCSI command timed out and was aborted. atdd_cfg -g SILI
If the value of SILI = 0, try setting the value to 1, by
running the following command: atdd_cfg -s SILI 1
Table 14 on page 89 describes problems and possible solutions for errors you may
encounter with the static driver.

Table 14. Troubleshooting (Problems and Solutions)

Problem Solution
No special files found in /dev/rmt Issue the following commands:
cd /opt/OMImag/bin
atdd_mksf | sh
If you are using the PB drivers or are not using the Verify that the hardware path for the device is listed in
standard device driver defaults with PCI drivers: the configuration file:
/etc/rc.config.d/atdd.cfg
If the hardware path is missing or incorrect, the driver
was not installed properly.
Claimed by HP Stape driver Run the command: # lsdev to check that the atdd is in
the current kernel:
1. If the atdd is not in the output, rebuild the kernel or
reinstall atdd;
2. If the atdd is in the output:
a. Rebuild the system I/O configuration:
1) Remove /stand/ioconfig and /etc/ioconfig after to
backup the files;
2) Reboot the system;
3) On System Console, enter the command: #
/sbin/ioinit -c while the autobooting is
halted;
4) Run the command: # /sbin/insf -e
5) Enter the command: # ^D to exit the I/O
configuration
b. Consider reinstalling the HP-UX operating system
if the system is new or this is a new update.
Cannot open Special File. The system log has the Wrong DENSITY setting. Check the current value by:
following message: atdd_cfg -g DENSITY <atdd_inst>
Invalid SCSI request in data at bit 7 of byte 4 Try setting it to 0 (zero):
atdd_cfg -s DENSITY 0 <atdd_inst>
An attempt to read data times out and returns an error. Check that the SILI configuration parameter is 1 by
The system log has the following messages: executing:
A SCSI command timed out and was aborted. atdd_cfg -g SILI <atdd_inst>
LLIO: Detected PowerFail (probably caused by SCSI bus If the SILI parameter is zero, try setting it to 1:
or device reset). atdd_cfg -s SILI 1 <atdd_inst>
An attempt to read data times out and returns an error. Check that the FORCE_NARROW parameter is valid for
The system log has the following messages: this device by executing:
A SCSI command timed out and was aborted. atdd_cfg -g FORCE_NARROW <atdd_inst>
scsi3: ....date code... If FORCE_NARROW is 1, try setting it to 0:
scsi3: ....timestamp... atdd_cfg -s FORCE_NARROW 0 <atdd_inst>


Chapter 5. Linux Tape and Medium Changer Device Driver
Purpose . . . . . . . . . . . . . . . 91 Special Files . . . . . . . . . . . . . . 104
Data Flow . . . . . . . . . . . . . . . 91 Special Files for the Tape Device . . . . . . 104
Product Requirements . . . . . . . . . . . 92 Special Files for the Medium Changer Device 104
Hardware Requirements for Intel and AMD | Persistent Naming Support . . . . . . . . 105
Opteron Processors . . . . . . . . . . . 92 Control Path Failover Support for Tape Libraries 106
Hardware Requirements for IBM System p Configuring and Unconfiguring Path Failover
Models . . . . . . . . . . . . . . . 92 Support . . . . . . . . . . . . . . 106
Hardware Requirements for IBM System z Primary and Alternate Paths . . . . . . . 107
Models . . . . . . . . . . . . . . . 93 Querying Primary and Alternate Path
Software Requirements for Intel and AMD Configuration . . . . . . . . . . . . 107
Opteron Processors . . . . . . . . . . . 93 Disable and Enable Primary and Alternate Paths 107
Software Requirements for IBM System p Models 94 Data Path Failover and Load Balancing Support for
Software Requirements for IBM System z Models 94 Tape Drives . . . . . . . . . . . . . . 108
Installation and Configuration Instructions . . . . 94 Primary and Alternate Paths . . . . . . . 109
Conventions Used . . . . . . . . . . . 94 Querying Primary and Alternate Path
Components Created During Installation . . . 94 Configuration . . . . . . . . . . . . 109
Installation Procedure . . . . . . . . . . 95 Disable and Enable Primary and Alternate Paths 109
Updating Procedure . . . . . . . . . . 96 | Tape Reserve Type. . . . . . . . . . . 110
Querying the Installed Package . . . . . . . 96 Open Source Device Driver - lin_tape . . . . . 110
Configuring Tape and Medium Changer Devices IBMtape and lin_tape Comparison . . . . . 110
on Intel-Compatible Systems . . . . . . . 96 Installation . . . . . . . . . . . . . 110
Configuring Tape and Medium Changer Devices Driver parameters and special device files . . . 111
on IBM System p Models . . . . . . . . . 97 Path Failover Support . . . . . . . . . 111
Configuring Tape and Medium Changer Devices lin_taped Daemon . . . . . . . . . . . 111
on IBM System z Models . . . . . . . . . 97 System-Managed Encryption . . . . . . . . 111
Uninstall Procedure. . . . . . . . . . . 99 Device Driver Configuration . . . . . . . 111
Tape Drive, Media, and Device Driver Parameters 99 Querying Tape Drive Configuration . . . . . 113
Configuration Parameters. . . . . . . . . 99 Problem Determination . . . . . . . . . . 114
Nonchangeable Parameters . . . . . . . . 100 Configure and Run lin_taped Daemon . . . . 114
Changeable Parameters . . . . . . . . . 101 Reservation Conflict Logging . . . . . . . 118
This chapter describes the IBM Linux Tape and Medium Changer Device Driver
(lin_tape).
For tape diagnostic and utility functions refer to Chapter 9, “IBM Tape Diagnostic
Tool (ITDT),” on page 231..
Purpose
The lin_tape and medium changer device driver is designed specifically to take
advantage of the features 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 demount the cartridges), as well as 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 described in this chapter covers the Linux Device Driver (lin_tape
device driver) and the interface between the application and the tape device.
Figure 11 on page 92 illustrates a typical data flow process.

Linux Device Driver (lin_tape)
IBMtape Host Bus Tape

Application
Device Adapter Device
Program
a250181
Driver Driver
Figure 11. Data Flow for Linux Device Driver (lin_tape)
More current information on supported hardware and software configurations for
lin_tape can be found on our System Storage Interoperation Center website:
http://www.ibm.com/systems/support/storage/config/ssic/.
Hardware Requirements for Intel and AMD Opteron

Processors
One or more of the following processors is required by the lin_tape device driver:
v 32-bit Intel-compatible processors (uniprocessor or SMP) capable of running the
Linux operating system
v 64-bit Intel® Itanium processors (uniprocessor or SMP) capable of running the
Linux operating system
v Intel processors that support Extended Memory 64 Technology (EM64T)
v AMD Opteron processors capable of running the Linux operating system
One or more of the following host bus adapters:

v Adaptec 2940U2W (LVD; Ultrium drives only)
v Adaptec 2944UW (HVD) SCSI Host Bus Adapter
v Adaptec SCSI Adapter 29160 or IBM P/N 19K4646 for IBM System x® - Single
Port LVD
v Adapted SCSI Adapter 39160 - Dual Port LVD
v Adaptec SCSI Adapter 29320 - Single Port LVD
v Adaptec SCSI Adapter 39320 - Dual Port LVD
v LSI Logic SAS3800X SAS Adapters
v IBM SAS Host Bus Adapter Controller Part Number 25R8060
v QLogic QLA2200F, QLA2300F, QLA2310FL, QLA2340L, QLA2342L, QLA2460,
QLA2462, QLE2560, and QLE2562 Fibre Channel Adapters
v Emulex LP1150, LP9002L, LP9802, LP10000, LP11000, LP11002, LPe12000,
LPe12002, and LPe1250 Fibre Channel Adapters
v IBM 42D0485, 42D0494, 42D0501, and 42D0510 8 GB Adapters
Hardware Requirements for IBM System p Models

One or more of the following processors is required by the lin_tape device driver:
v IBM low, middle, or high range System p (also known as pSeries) servers
running a 64-bit Linux operating system
v IBM POWER5™ servers running a 64-bit Linux operating system
One or more of the following host bus adapters:

v PCI-X DDR Dual -x4 SAS Adapter (FC 5900)

v System p (also known as pSeries) Feature Code 5712 PCI-X Dual Channel
Ultra320 SCSI Adapter
v System p (also known as pSeries) Feature Code 5736 (571A) or 1912 PCI-X DDR
Dual Channel Ultra320 SCSI Adapter
v System p (also known as pSeries) Feature Code 6228 Fibre Channel Adapter
v System p (also known as pSeries) Feature Code 6239 Fibre Channel PCI-X
Adapter
v System p (also known as pSeries) Feature Code 5716 Fibre Channel PCI-X
Adapter
v System p (also known as pSeries) Feature Code 5758 and 5759 Fibre Channel
PCI-X Adapter
v System p (also known as pSeries) Feature Code 5773 and 5774 Fibre Channel
PCI-E Adapter
v System p (also known as pSeries) Feature Code 5735 8 GB Fibre Channel
Adapter
Hardware Requirements for IBM System z Models

One or more of the following processors is required by the lin_tape device driver
running Linux on System z® in 31-bit or 64-bit:
v IBM System z 800 (z800) or 900 (z900) models
v IBM System z 890 (z890) or 990 (z990) models
v IBM System z9® models
One or more of the following host bus adapters with Fibre Channel Protocol
support:
v FICON® Express card (feature 2315 or 2318)
v FICON Express card (feature 2319 or 2320)
v FICON Express2 card (feature 3319 or 3320)
v FICON Express4 card (feature 3321, 3322, or 3324)
Note: Using a single Fibre Channel host bus adapter (HBA) for concurrent tape
and disk operations is not recommended. Tape and disk devices require
characteristics. Under stress conditions (high I/O rates for tape, disk, or
both) where disk and tape subsystems share a common HBA, stability
problems have been observed. These issues are resolved by separating disk
and tape I/O streams onto separate HBAs and using SAN zoning to
minimize contention. IBM is focused on assuring server and storage
configuration interoperability. IBM strongly recommends that your
implementation plan includes provisions for separating disk and tape
workloads.
Software Requirements for Intel and AMD Opteron Processors

The lin_tape device driver supports the following Linux distributions:
v Red Hat Enterprise Linux Server
v SUSE LINUX Enterprise Server
v Asianux
Chapter 5. Linux Tape and Medium Changer Device Driver 93

Software Requirements for IBM System p Models

The lin_tape device driver supports the following Linux distributions for Linux for
System p (also known as pSeries) (64-bit kernel):
v Red Hat Enterprise Linux
v Asianux
Software Requirements for IBM System z Models

The lin_tape device driver supports the following Linux distribution for Linux on
System z 31-bit and 64-bit:
v Red Hat Enterprise Linux

The lin_tape device driver for Linux is provided in a source rpm package. The
utility tools for lin_tape are supplied in binary rpm packages. Refer to Appendix A,
“Accessing Documentation and Software Online,” on page 317. They will be
downloaded with the driver.
The following sections describe installation, configuration, uninstalling, and

verification procedures for lin_tape and its utility tools. Refer to Linux
documentation for tar command information and any Linux distribution
| supporting rpm for rpm command information. You must have root authority to
proceed with the installation of the driver. See the README file that can be
downloaded with the driver at Fix Central. For more information about
downloading drivers please see Appendix A, “Accessing Documentation and
Software Online,” on page 317.
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 perform the instructions.
Commands that you are to type are indicated with a leading ">" character, which
indicates the shell prompt.
Note: This is performed using tape diagnostic and utility functions.
Components Created During Installation

The lin_tape package consists of the device driver and a number of associated files.
Components created during lin_tape installation (from the rpm package) are listed
in Table 15.
Table 15. Components Created During lin_tape Installation
Component Description
/lib/modules/(Your system's kernel Device driver module for current kernel
name)/kernel/drivers/scsi/lin_tape.ko version

Table 15. Components Created During lin_tape Installation (continued)

Component Description
/usr/bin/lin_taped lin_taped daemon
/etc/lin_taped.conf lin_taped daemon configuration file
/usr/share/doc/lin_tape-xxx/ ReadMe file for lin_tape using IBM
lin_tape_359X.Readme (for Red Hat) TotalStorage devices
/usr/share/doc/packages/lin_tape/
lin_tape_359X.Readme (for SUSE LINUX)
/usr/share/doc/lin_tape-xxx/lin_taped.Readme ReadMe file for lin_taped daemon
(for Red Hat)
/usr/share/doc/packages/lin_tape/
lin_taped.Readme (for SUSE LINUX)
/usr/share/doc/lin_tape-xxx/copying (for Red License documentation for lin_tape
Hat)
/usr/share/doc/packages/lin_tape/copying (for
SUSE LINUX)
If lin_tape is already installed on your system, refer to the “Updating Procedure”
on page 96 in this chapter. This section assumes 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 running Linux for S/390® or Linux for
zSeries®, ensure that the OpenFCP adapter device driver zfcp is loaded in the
kernel. Please refer to the section “Configuring Tape and Medium Changer Devices
on IBM System z Models” on page 97 in this chapter 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, perform 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 wish to install it.
2. Run rpmbuild --rebuild <filename>, where: <filename> is the name of the
RPM file. This creates a binary RPM package 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,
there is a line that indicates the filename 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 filesystem 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 may uninstall the driver first, then install the newer version. For example:
>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.
Querying the Installed Package

The query is supported for the lin_tape device driver rpm package only.
The installed rpm package can be queried by running the following commands to
display information associated with the package.
To display information about lin_tape:

>rpm -qi lin_tape
To display the file list, enter the command:

>rpm -ql lin_tape
To display the states of files in the package, for example, normal, not installed, or
replaced:
>rpm -qs lin_tape
Configuring Tape and Medium Changer Devices on

Intel-Compatible Systems
If you have not physically attached your tape and medium changer devices to
your Linux server, perform the following steps:
1. Halt the Linux server.
2. Power down the Linux server.
3. Physically attach the tape and medium changers to the host bus adapter cards.
Consult your hardware documentation for details.
4. Power on the tape and medium changer devices. Verify that they have
completed the initialization process.
5. Power on and boot the Linux server.
Note: Hot plugging SCSI devices while the Linux server is running may 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 installing the Qlogic driver, 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 onto 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.
If you have the StorWatch Specialist installed, you can use the Specialist to do this
configuration. For further information about the StorWatch Specialist, refer to the
IBM Storage Area Network Data Gateway Installation and User's Guide. You can
download the guide from the Web at:
http://www.storage.ibm.com/hardsoft/products/sangateway/support/cdr/
Document/sdgdoc.htm
When you run the lin_tape kernel module, it creates special files in the /dev
directory.
Configuring Tape and Medium Changer Devices on IBM

System p Models
Follow the same instructions as documented in the previous section. You need to
configure the Emulex Linux device driver if you have fibre channel tape devices
attached to your System p (also known as pSeries) system.
Configuring Tape and Medium Changer Devices on IBM

System z Models
The fibre channel topology supported for System z is point-to-point and fabric.
Please refer to the Linux on System z fibre channel documents for more details on
the supported configurations for fibre channel device attachment. The Linux fibre
channel adapter device driver zfcp is available in the kernel that supports zSeries
Fibre Channel Protocol. The zfcp device configuration methods in 2.6 and 2.4
kernels are different. For 2.6 kernels, refer to appropriate chapter in the Linux on
System z document entitled "Linux on System z: Device Drivers, Features, and
Commands".
For 2.4 kernels, there are three ways to load the zfcp device driver in order 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 you reboot the system, the zfcp is
automatically loaded and the tape devices can be seen from the system.
First you need to 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 World Wide Port Name. It is "0x1" in the previous
example.
wwpn World Wide Port Name identifying 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 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.
We recommend, for tape attachment, that each logical unit number be
associated with a unique devno. If you use the same devno numbers for several
logical units, you should ensure that each <unit-scsi-lun> is unique. After
/etc/zfcp.conf is created, run the following commands:
>mk_initrd>zipl
Then, reboot the system. After it is booted up, your tape device should 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 modifying the /etc/modules.conf file, save and close it. Then run the
following command:
>depmod -A
>modprobe zfcp
This 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, etc.
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 in order 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 allow you 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 may issue the following commands;
> echo "0xf1c0 0x1:0x5005076300402733 0x0:0x0000000000000000;\
0xf1c1 0x1:0x5005076300402733 0x0:0x0001000000000000" > /proc/scsi/zfcp/add_map
> echo "scsi add-single-device 0 0 1 0" > /proc/scsi/scsi
> echo "scsi add-single-device 1 0 1 1" > /proc/scsi/scsi
The "scsi add-single-device" takes four parameters, corresponding to the four

parameters "scsi", "Channel", "Id", and "Lun" in the /proc/scsi/scsi file. The value
of "scsi" is 0 for the first devno, 1 for the second devno (if it is different from
the first devno), and so on. The value of "Channel" can start from 0 for each
different "scsi" value. The value of "Id" is the one you use for <unit scsi-lun> in
the previous mapping. The value of "Lun" is the logical unit number of the
target device, for example, the last number in the previous mapping. Currently,
the zfcp device driver does not support dynamically removing the attached
devices. If you need to remove the tape devices from the system, do "rmmod
zfcp". Then you can delete the entry in /etc/modules.conf and reload zfcp, or
reload zfcp first and dynamically add the devices you want. After you have
done all the mapping, if you can see all of the attached tape devices in
/proc/scsi/scsi, you have successfully attached those devices to your system. Next
you may install the lin_tape device driver. Refer to the "“Installation
Procedure” on page 95" section in this chapter for the instructions on how to
install lin_tape.
Uninstall 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.
Run the following command:

>rpm -e lin_tape ---to remove
Tape Drive, Media, and Device Driver Parameters

This chapter describes the parameters that control the operating modes of the IBM
Linux Tape and Medium Changer Device Driver.
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 is performed using tape diagnostic and utility functions.
The nonchangeable configuration parameters are:

v Autoloading
v Density code
v Emulate autoloader
v Hook word
v Maximum block size
v Minimum block size
v Medium type

v Read SILI bit

v Record space mode
v Write protect
The changeable configuration parameters are:

v Block size
v Buffered mode
v Capacity scaling
v Compression
v Disable auto drive dump
v Disable SIM logging
v Logging
v Logical write protect
v Maximum SCSI transfer length
v Read past filemark
v Rewind immediate
v Trace
v Trailer labels
Nonchangeable Parameters
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
This parameter currently is not supported and should be ignored.
Hook Word
This parameter is not supported in the lin_tape device driver.

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.

Maximum Block Size

This parameter is the maximum block size for the device.
Minimum Block Size

This parameter is the minimum block size for the device.
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.
Read SILI Bit

SILI bit currently is not supported due to limitations associated with the Linux
environment. SILI bit support may be enabled in future releases of the lin_tape.
Record Space Mode

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).
Volume ID for Logging

This parameter is the volume ID of the currently loaded tape. The lin_tape device
driver ignores this field.
Write Protect
This parameter is set to TRUE if the currently mounted tape is logically or
physically write protected.
Changeable Parameters
and device driver when a device is opened. The changeable parameters are
detailed as follows:
Block Size
This parameter specifies the block size 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 103 for additional guidance.
Buffered Mode
This parameter specifies if read and write operations should 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 only supported for the standard
300 GB rewritable data cartridge. 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, the 60GB (Economy Data)
cartridge for the IBM 3592 cannot be capacity scaled and is always 100%.
Compression
Hardware compression is implemented in the device hardware. This parameter
turns the hardware compression feature On and Off. If compression is enabled, the
effective performance can increase, based on the compressibility of the data.
The installation default is On (use compression).
Disable Auto Drive Dump

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 which 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 may specify another directory in the /etc/lin_taped.conf file. Please refer
to “Configure and Run lin_taped Daemon” on page 114 in this chapter for details.
Disable SIM logging

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 may specify another directory in the /etc/lin_taped.conf file. Please refer to
“Configure and Run lin_taped Daemon” on page 114 in this chapter for details.
This capacity is not applicable to IBM Ultrium tape drives.
Logging (Volume Logging)

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 may specify another directory in
/etc/lin_taped.conf file. Please refer to “Configure and Run lin_taped Daemon” on
page 114 in this chapter for details.
Note: This is volume logging, which is different from error logging. lin_tape
provides error logging whenever the lin_taped daemon is running. Please
refer to “Configure and Run lin_taped Daemon” on page 114 in this chapter
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.
Maximum SCSI Transfer Length

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 has been 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 may increase the
maximum transfer length to enhance the data throughput. This can be done using
| ITDT using 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 usually greater than
256KB. It can not be changed by the STIOCSETP ioctl call any more.
Read Past Filemark

If this parameter is set to true, when a read operation encounters a filemark, it
returns the number of bytes read before encountering the filemark and positions
the tape head after the filemark. If the read_past_filemark parameter is set to false,
when the read operation encounters a filemark, if data was read, the read function
returns the number of bytes read, and positions the tape head before the filemark.
If no data was read, then the read returns 0 bytes read and positions the tape head
after the filemark.
This installation default is FALSE.
Rewind Immediate
This parameter sets the immediate bit for rewind commands. If it is set to On, the
rewind tape operation executes faster, but the next command takes a long time to
finish unless the physical rewind operation has completed. Setting this parameter
reduces the amount of time it takes to close a device for a Rewind on Close special
file.
The installation default is Off (no rewind immediate).
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 may specify another directory in /etc/lin_taped.conf file. Please refer to
“Configure and Run lin_taped Daemon” on page 114 for details.
Trailer Labels
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.
The installation default is On (with trailer labels).
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.
Special Files for the Tape Device

Each tape device has a set of special files providing access to the same physical
drive but providing different attributes. Table 16 shows the attributes of the special
files.
Note: The asterisk (*) in IBMtape* represents a number assigned to a particular

device, such as IBMtape0.
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 16. Special Files for IBM TotalStorage Tape Devices
Special File Name Rewind on Close
/dev/IBMTape* YES
/dev/IBMTape*n NO
Special Files for the Medium Changer Device

After the driver is installed and a medium changer device is configured and made
available for use, access to the robotic device is provided through the IBMchanger
special file in the /dev directory. The asterisk (*) represents a number assigned to a
particular device, such as IBMchanger0. The term IBMchanger is used for a SCSI
medium changer device. The IBMchanger* special file provides a path for issuing
commands to control the medium changer robotic device.
The file descriptor that results from opening the IBMchanger special file does not
support the following operations:
v Read

v Write
v Open in Append mode
v Commands designed for a tape device
| Persistent Naming Support

| Lin_tape persistent naming is implemented through the Linux udev utility. Udev is
| a service that monitors changes in system hardware configuration and performs
| actions based on what devices are attached to the Linux system. It can be
| configured to create symbolic links (persistent names) to a device based on
| attributes that a driver exports for that device. The persistent name may then be
| used as the device name to open and perform IO to a tape drive or medium
| changer. This will make it possible to reference a static name, such as
| /dev/lin_tape/by-id/lin_tape4801101, which will always be associated with the
| same physical device, rather than being required to reference the device name
| /dev/IBMtape0, which may 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. Please refer to the man
| pages for udevadm or udevinfo for details on usage.
| Udev, udevinfo, and udevadm are not implemented or maintained by the lin_tape
| driver, and the man pages for a given system will supercede all information in this
| document. For questions on using these utilities you should contact your Linux
| support representative. However, this section provides an example on using udev
| for implementing a persistent name. The example should be customized to fit a
| user’s needs and environment.
| If there is a tape device attached to the Linux system with world-wide port name
| “0x123456789ABCDEF0” with a current device name of /dev/IBMtape0, a user
| could run udevadm info to obtain information on exported attributes for this
| device. This could be done as follows:
| >udevadm info --attribute-walk --name /dev/IBMtape0
| The output of this command should include something similar to the following:
| ATTRS{serial_num}=="123456789"
| ATTRS{ww_node_name}=="0x123456789ABCDEF1"
| ATTRS{ww_port_name}=="0x123456789ABCDEF0"
| Note: Variations exist between kernels. For example, if you are using udevinfo,
| you should enter the previous command as
| >udevinfo -a -p `udevinfo -q path -n /dev/IBMtape0`
| Also, on some kernels an attribute ATTRS{xxx} will be replaced by

| SYSFS{xxx}. Furthermore, some kernels use a '=' (single equal sign) to
| indicate an attribute match as well as an assignment, whereas other kernels
| use a '==' (double equal sign) for a match and '=' for assignment. You
| should place the attribute from the attribute list into your rules file exactly
| as it appears in the attribute list, as described below.
| We can use the ww_port_name in a .rules file that will assign a symbolic link to a
| device that has the listed world-wide port name. The file will typically be placed
| in /etc/udev/rules.d, but this location may be changed by the udev_rules

| directive in the /etc/udev/rules.conf file. In this example, we create a file 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_tape480110
| Assuming that the udev service is running and configured correctly, the user can
| install or reinstall lin_tape using modprobe, and the symbolic link should be
| created in the /dev/lin_tape/by-id folder. One line should be added to the
| 98-lin_tape.rules file for each symbolic link desired.

Note: The library control path failover feature code must be installed prior to
enabling control path failover support in the Linux lin_tape device driver.
Refer to “Automatic Failover” on page 10 to determine which feature code is
required for your machine type.
The Linux lin_tape device driver control path failover support configures multiple
physical control paths to the same logical library within the device driver and
provide automatic failover to an alternate control path when a permanent error
occurs on one path. This is transparent to the running application.

Control 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 library control path failover. To enable the
failover support in the lin_tape device driver software, you need do the following
steps after installing the lin_tape rpm package:
1. lin_taped stop (stop the lin_taped daemon)
2. rmmod lin_tape (unload the lin_tape driver from the memory)
3. Add the following line in your /etc/modules.conf file for 2.4 kernels or
/etc/modprobe.conf.local file for 2.6 kernels:
options lin_tape alternate_pathing=1
4. depmod
5. modprobe lin_tape (re-load the lin_tape driver into memory)
6. lin_taped (re-start lin_taped daemon)
You can ignore the "Unresolved symbols in /lib/modules/<your kernel

name>/drivers/scsi/lin_tape.ko" message after the "depmod" command. You can check
if the lin_tape driver has recognized multiple control paths for your library by
reading the /proc/scsi/IBMchanger file.
v cat/proc/scsi/IBMchanger
If your library lists "Primary" or "Alternate" under "FO Path", you have
successfully enabled control path failover feature for your library. If it is "NA"
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 perform the following steps:
1. lin_taped stop
2. rmmod lin_tape
3. Delete the following line in your /etc/modules.conf file:


4. depmod
5. modprobe lin_tape
6. lin_taped

When lin_tape is loaded into kernel memory, the first logical medium changer
device that lin_tape sees in the system is the primary path for that medium
changer. The other logical medium changers that lin_tape attached for the same
medium changer are configured as alternate paths. The device driver supports up
to 16 physical paths for a single device. The primary and alternate path
information can be obtained by the following command:
v cat /proc/scsi/IBMchanger
The following is an example of a /proc/scsi/IBMchanger file:

v lin_tape version: 3.0.3
v lin_tape major number: 253
Attached Changer Devices:
Number Model SN HBA FO Path

0 03584L22 IBM1234567 qla2xxx Primary
1 03584L22 IBM1234567 qla2xxx Alternate
2 03584L22 IBM1234567 qla2xxx Alternate

v Be able to identify the actual number of physical devices configured on the
logical device labeled as the primary path for each physical device. However,
there can be multiple logical devices labeled as an alternate path for the same
devices.
v Provide information about which logical devices configured on the system have

reading the /proc/scsi/IBMchanger file, as explained in section “Primary and
Alternate Paths.”

Once you load the lin_tape device driver with the alternate_pathing parameter to
be ON, by default, all the available paths for a physical device are enabled.
alternate paths.

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 need to
perform the following steps after installing the lin_tape rpm package.
>lin_taped stop (stop the lin_taped daemon)
>rmmod lin_tape (unload the lin_tape driver from the memory
If you have IBM 3592 tape drives, add the following line in your
/etc/modules.conf file for 2.4 kernels or /etc/modprobe.conf.local file for 2.6
kernels:
If you have IBM LTO tape drives, the library needs to have 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 LTO4 drives.
Add the following line in your /etc/modules.conf file for 2.4 kernels or
/etc/modprobe.conf.local file for 2.6 kernels:
options lin_tape alternate_pathing=1 dpf_keys="abcdefghijklmnop"
"abckdefghijklmnop" is an example of a data path failover feature key. If you have

multiple libraries and multiple data path failover feature keys, input your keys as
follows:
dpf_keys="key1;key2;..."
Save the file, then run the following commands:

>depmod
>modprobe lin_tape (re-load the lin_tape driver into memory)
>lin_taped (re-start lin_taped daemon)
You may ignore the "Unresolved symbols in /lib/modules/<your kernel

name>/drivers/scsi/lin_tape.ko" message after the depmod command. You can check if
the lin_tape driver has recognized multiple paths for your tape drive by reading
the /proc/scsi/IBMtape file:
>cat /proc/scsi/IBMtape
If your tape drive lists "Primary" or "Alternate" under "FO Path", you have
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 may do the following steps:

>lin_taped stop
>rmmod lin_tape
Delete the following line in your /etc/modules.conf file: options lin_tape

alternate_pathing=1
>depmod
>modprobe lin_tape
>lin_taped

When the lin_tape device driver is loaded into kernel memory with path failover
support enabled, the first logic device that lin_tape sees always becomes the
primary path. The other logical devices that lin_tape sees are configured as the
alternate paths. The device driver supports up to 16 physical paths for a single
device.
The primary and alternate path information can be obtained by the following
command:
>cat /proc/scsi/IBMtape
The following is an example of a /proc/scsi/IBMtape:

lin_tape version: 3.0.3
lin_tape major number: 253
Attached Tape Devices:
Number Model SN HBA FO Path

0 03592 IBM1234567 qla2xxx Primary
1 03592 IBM1234567 qla2xxx Alternate

information only to:
v Be able to identify the actual number of physical devices configured on the
logical device labeled the primary path for each physical device. However, there
may be many (multiple) logical devices labeled as an alternate path for the same
devices.
v Provide information about which logical devices configured on the system have

reading the /proc/scsi/IBMtape file, as explained in section “Primary and Alternate
Paths.”

alternate paths.

| Tape Reserve Type

| This parameter will cause lin_tape to issue SCSI-3 persistent reserves to a tape
| drive whenever a reservation is attempted. Note that persistent reserves are
| automatically issued if data path failover is used, and therefore setting the
| parameter should be unnecessary. This parameter can only be set when lin_tape is
| installed. To set it, add the following line to /etc/modprobe.conf (or
| /etc/modprobe.conf.local):
| options lin_tape tape_reserve_type=persistent
|
Open Source Device Driver - lin_tape
The lin_tape device driver is the new device driver for the Linux 2.6 kernels to
replace the closed-source driver IBMtape. In most respects, it behaves the same as
the closed-source IBMtape device driver. This section covers significant differences
between the IBMtape driver and the lin_tape driver.
IBMtape and lin_tape Comparison

Table 17 compares the names for various components of the IBMtape and lin_tape
device drivers.
Table 17. IBMtape and lin_tape Comparison
Component IBMtape Lin_tape
Driver name IBMtape lin_tape
Module name IBMtape.ko lin_tape.ko
Special files /dev/IBMtape0 No change
/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 should be replaced with lin_tape in all of the installation instructions.
Refer to the section “Installation and Configuration Instructions” on page 94 of this
chapter 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.

Driver parameters and special device files

The driver parameters have not changed for the lin_tape driver. However, it is
important to note that the module parameters, such as "alternate_pathing" and
"dpf_keys", must now be applied to the lin_tape module, instead of the IBMtape
module. For example, in the /etc/modprobe.conf (for Red Hat) or
/etc/modprobe.conf.local (for SUSE) file, add the following line for LTO library's
path failover:
options lin_tape alternate_pathing=1 dpf_keys="abcdefghijklmnop"
abckdefghijklmnop is an example of a data path failover feature key.
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 104 and “Special Files
for the Medium Changer Device” on page 104 of this chapter for details on special
device files.
Path Failover Support

Path failover support in lin_tape is the same, except that with the lin_tape driver,
failover support is provided through the lin_taped daemon. If the lin_taped
daemon is not running, neither control path failover nor data path failover is
attempted. The lin_taped daemon is started automatically when the lin_tape driver
is loaded.
To check if the lin_taped daemon is running, run the following command:
lin_taped status
This command indicates if the lin_taped daemon is running or not. If the

/proc/scsi/IBMtape and /proc/scsi/IBMchanger files indicate "NA" for "FO Path",
this indicates that failover support for that device is not enabled. If all other
settings are correct, but "FO Path" is incorrectly indicating "NA", confirm that the
lin_taped daemon is running.
For details about the path failover support, refer to the sections "“Control Path
Failover Support for Tape Libraries” on page 106" and "“Data Path Failover and
Load Balancing Support for Tape Drives” on page 108" of this chapter.
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 has been renamed to lin_taped.conf. Refer to “Configure and
Run lin_taped Daemon” on page 114 of this chapter for detailed information.

Note: System-managed encryption (SME) on Linux requires that the lin_taped
daemon is running.

Linux System-Managed Encryption
The device driver SME settings can be set for all drives at once using 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 should not need to be
changed. A value of 0 causes the device driver to ignore encryption key requests
for system-managed encryption drives, and is not desirable.
v The default value for default_sys_encryption_write is 2.
This value causes the device driver to leave the encryption write-from-BOP
settings alone. It does not turn on or turn off encryption writing, but instead
uses the settings that are already in the drive. If encryption has not been set up
previously, then the drive writes unencrypted data. A value of 0 causes the
device driver to write unencrypted data. A value of 1 causes the device driver to
write encrypted data.
The module options can be specified in the /etc/modprobe.conf or

/etc/modeprobe.conf.local files, the same as other lin_tape module parameters.
For example, to turn on SME to write/read encrypted data:

1. Add the following line:
options lin_tape default_sys_encryption_write=1
2. Then run the following commands:
>lin_taped stop
>rmmod lin_tape
>depmod
>modprobe lin_tape (reinstall back)
>lin_taped (restart the daemon)
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", and have the same definitions
and values as the similarly named "default" parameters, except that the settings
only apply 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.
For example, to change the "sys_encryption_write" setting for IBMtape0 to ON

(which has a value of 1), enter the following at a command prompt:
echo 1">/sys/class/lin_tape/IBMtape0/sys_encryption_write
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 or /etc/modprobe.conf.local.

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.

The following is an example of the output when the drive is configured for
system-managed encryption, with encryption turned on:
issuing query encryption status...
encryption capable......Yes
encryption method.......METHOD_SYSTEM
encryption state........ON

and the tape device are functioning correctly.
Configure and Run lin_taped Daemon

Starting with lin_tape version 1.2.5, the lin_tape device driver provides an error
diagnostic daemon (lin_taped) which provides the following capabilities:
1. Error logging and tracing
2. When drive dumps, log sense data, and/or SIM/MIM error information are
created by the tape drive, the daemon automatically retrieves that data and
saves it to the hard drive on your Linux system.
3. Failover and load balancing
4. Encryption
Because lin_taped requires a minimal amount of system resource and because it
provides these necessary diagnostic capabilities, IBM recommends that you leave
the daemon enabled at all times.
Install lin_taped
lin_taped is automatically installed at /usr/bin/lin_taped when you install the
lin_tape device driver using the rpm or tar package. Refer to “Installation and
Configuration Instructions” on page 94 for instructions on installing the lin_tape
device driver.
Configure lin_taped
You can customize the operation of lin_taped by modifying its configuration file,
which is located at /etc/lin_taped.conf. The daemon only reads the configuration file
when it starts; consequently, if you make modifications to the configuration file,
then 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_tape device driver and
are defined as follows:
0 With tracing set to 0, very minimal tracing is recorded from the lin_tape
device driver.
1 With tracing set to 1, lin_taped records information associated with each
ioctl called. If a device error occurs and SCSI sense data is obtained from
the device, a subset of that sense data is also recorded. This is the default
setting for tracing.
2 With tracing set to 2, lin_taped records tracing messages for each SCSI
command. If a device error occurs and SCSI sense data is obtained from
the device, all sense data is also recorded. This tracing level should only be
used when a specific problem is being diagnosed due to the potential for
huge amounts of data being generated.
Set the lin_tapeTrace variable in the /etc/lin_taped.conf file to 0, 1, or 2, depending on

what level of tracing you desire. If the lin_tapeTrace variable is set to an invalid
number, the lin_taped daemon does not start.
Tracing information is written to a file named /var/log/lin_tape.trace, by default.

Information is written into the file until it is 1 MB in size, by default. After 1 MB of
information is written, the file is archived (using the Linux ar command) into file

lin_tape.a in the same directory. In the archive, the filename is renamed to

lin_tape.trace.timestamp, where: timestamp reflects the time that the file was archived.
You may 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 (using the Linux ar command) into file lin_tape.a in the
same directory. In the archive, the filename is renamed to lin_tape.errorlog.timestamp,
where: timestamp reflects the time that the file was archived.
You may 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.
Whenever the lin_taped daemon is running, error logging is enabled if tracing is

enabled. Following is an example an error log record:
IBMtape0---E0001 Tue Sep 10 14:04:57 2002
Scsi Path : 03 00 00 00
CDB Command : 01 00 00 00 00 00
Status Code : 08 00 00 01
Sense Data : 70 00 04 00 00 00 00 58 00 00 00 00 00 00 FF 0B
C4 77 00 00 00 06 01 40 00 00 00 00 00 00 01 00
10 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Description : Hardware Error
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 four bytes represent driver_byte,
host_byte, msg_byte, and status_byte, respectively. "Sense Data" is the full SCSI
sense data returned from the target. "Description" is a person-readable text string
obtained by parsing the sense key field of the sense data.
The following circumstances are not logged in the lin_tape.errorlog file:

1. Sense key is 0, and the sense data indicates an overlength or an underlength
read, or encountering a file mark or the end of data
2. Sense key is 2, and the ASC/ASCQ indicates the device is becoming ready
3. Sense key is 6, indicating a unit attention
4. Sense key is 8, and the ASC/ASCQ indicates the end of 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, etc.) and timestamp reflects the time 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 may
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 can have a value of 0 or a positive decimal
number.
v lin_tapeAutoLogSenseFileOverWrite which can have a value of 0 or 1.
By default, lin_tapeMaxLogSenseFiles is 0 and lin_tapeAutoLogSenseFileOverWrite is 1,

which means that every time log sense data is created, it is written to a new file.
If lin_tapeMaxLogSenseFiles is 0, lin_tapeAutoLogSenseFileOverWrite is ignored, and

each time log sense data is obtained, it is written to a new file.
If lin_tapeMaxLogSenseFiles is a positive number and

lin_tapeAutoLogSenseFileOverWrite is 0, each time log sense data is created,
lin_taped writes that data to a file until lin_tapeMaxLogSenseFiles have been created;
then lin_taped stops creating new files, even if new log sense data is produced.
If lin_tapeMaxLogSenseFiles is a positive number and

lin_tapeAutoLogSenseFileOverWrite is 1, each time log sense data is created,
lin_taped writes that data to a file until lin_tapeMaxLogSenseFiles have been created;
then when new log sense data is detected, lin_taped deletes the oldest log sense
file and creates a new file with the newest log sense data; thus, only the newest
data is kept.
Automatically Retrieve a Drive Dump: 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, where lin_tapen is the device special file (for
example, lin_tape1, lin_tape2, etc.) and timestamp reflects the time the file was
created. Each time a drive dump is obtained, it is written to a new file. The IBM
service organization may request that you forward drive dumps to them for
analysis.
The drive dumps are stored in the /var/log directory by default. You may specify
another directory in the /etc/lin_taped.conf file.
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.
By default, lin_tapeMaxDumpFiles is 0 and lin_tapeAutoDriveDumpFileOverWrite is 1,

which means that every time a drive dump is obtained, it is written to a new file.
If lin_tapeMaxDumpFiles is 0, lin_tapeAutoDriveDumpFileOverWrite is ignored, and

each time a drive dump is obtained, it is written to a new file.
If lin_tapeMaxDumpFiles is a positive number and

lin_tapeAutoDriveDumpFileOverWrite is 0, each time a dump is obtained, lin_taped
writes that data to a file until lin_tapeMaxDumpFiles have been created; then
lin_taped stops creating new files, even if new drive dumps are produced.

If lin_tapeMaxDumpFiles is a positive number and

lin_tapeAutoDriveDumpFileOverWrite is 1, each time a dump is obtained, lin_taped
writes that data to a file until lin_tapeMaxDumpFiles have been created; then when
a new drive dump is detected, lin_taped deletes the oldest drive dump file and
creates a new file with the newest drive dump data; thus, only the newest data is
kept.
Automatically Retrieved SIM/MIM Data: 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, etc.) and timestamp reflects the time the file was
created. Each time SIM/MIM data is obtained, it is written to a new file. The IBM
service organization may 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 may specify
another directory in the /etc/lin_taped.conf file.
tailor to affect the number of SIM/MIM files that are kept on your system:
v lin_tapeMaxSimMimDataFiles which can have a value of 0 or a positive decimal
number.
v lin_tapeAutoSimMimDataOverWrite which can have a value of 0 or 1.
By default, lin_tapeMaxSimMimDataFiles is 0 and lin_tapeAutoSimMimDataOverWrite

is 1, which means that every time SIM/MIM data is obtained, it is written to a
new 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.
If lin_tapeMaxSimMimDataFiles is a positive number and

lin_tapeAutoSimMimDataOverWrite is 0, each time SIM/MIM data is obtained,
lin_taped writes that data to a file until lin_tapeMaxSimMimDataFiles have been
created; then lin_taped stops creating new files, even if new SIM/MIM data are
created.
If lin_tapeMaxSimMimDataFiles is a positive number and

lin_tapeAutoSimMimDataOverWrite is 1, each time SIM/MIM data is obtained,
lin_taped writes that data to a file until lin_tapeMaxSimMimDataFiles have been
created; then when new SIM/MIM data is detected, lin_taped deletes the oldest
SIM/MIM file and creates a new file with the newest SIM/MIM data; thus, only
the newest data is kept.
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 may selectively enable/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.
The parameters and their definitions are as follows:

trace This parameter is set to On by default, which enables lin_tape tracing of
activities and error logging on a particular tape drive. Set this parameter to
off to stop tracing and error logging.

logging
This parameter is set to On by default and enables logging of log sense
data. Setting this flag to Off suppresses volume logging for this device.
disable_sim_logging
This parameter controls the logging of SIM/MIM data for a device. By
default it is set to Off which causes SIM/MIM data to be logged. Set this
flag to On to suppress the logging of SIM/MIM records.
disable_auto_drive_dump
This parameter controls the saving of drive dumps for a device. By default
it is set to Off which causes drive dumps to be saved. Set this flag to On to
suppress the saving of drive dumps.
Run 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
tape device attached. If you add a new tape device into your Linux system,
lin_taped automatically creates a special file under the /dev directory. If you are
running the lin_tape device driver, version 1.3.x or less, lin_taped does not
automatically start if there is no tape device attached. After you attach a new tape
device, you'll need to start the lin_taped daemon.
You can invoke lin_taped from the command line. lin_taped takes zero or more of
the parameters as listed in the following:
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 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 should be used
after modifying the /etc/lin_taped.conf file while lin_taped is running.
lin_taped status
Prints a message on stdout 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 need to stop the lin_taped daemon first;
otherwise you get a "Device or Resource Busy" error.

When the device driver receives a reservation conflict on a tape drive command it
will log the conflict to the kernel debug buffer (which is typically echoed to
/var/log/messages). Prior to logging the error the device driver will determine if
a SCSI Persistent Reservation is active on the target tape drive and, if it is, will get
the reserving host initiator WWPN (World Wide Port Name). If successful, the
device driver will post the message
lin_tape: reserve held by xxxxxxxx

to the debug buffer. To prevent multiple identical entries in the error log,
subsequent reservation conflicts from the same reserving host WWPN will not be
logged.

Chapter 6. Solaris Tape and Medium Changer Device Driver
Purpose . . . . . . . . . . . . . . . 121 Disable and Enable Primary and Alternate Paths 151
Data Flow . . . . . . . . . . . . . . 121 Data Path Failover and Load Balancing Support for
Product Requirements . . . . . . . . . . 122 Tape Drives . . . . . . . . . . . . . . 151
Hardware Requirements. . . . . . . . . 122 Configuring and Deconfiguring Path Failover
Software Requirements . . . . . . . . . 124 Support . . . . . . . . . . . . . . 151
Installation and Configuration Instructions . . . 124 Primary and Alternate Paths . . . . . . . 153
Preventing Conflicts with Other Device Drivers 125 Querying Primary and Alternate Path
Preinstallation Considerations . . . . . . . 125 Configuration . . . . . . . . . . . . 153
Installing and Updating IBMtape . . . . . . 126 Disable and Enable Primary and Alternate Paths 154
Configuring IBM tape devices with Fibre System-Managed Encryption . . . . . . . . 154
Channel and SAS HBAs . . . . . . . . . 132 Device Driver Configuration . . . . . . . 154
Solaris Zones Support . . . . . . . . . 136 Querying Tape Drive Configuration . . . . . 155
Configuration Parameters . . . . . . . . 139 Testing Data Encryption Configuration and
Removing IBMtape . . . . . . . . . . 143 Connectivity. . . . . . . . . . . . . 155
Adding or Removing Devices . . . . . . . 143 Field Support Information . . . . . . . . 155
Deconfiguring Tape Devices . . . . . . . 143 Problem Determination . . . . . . . . . . 155
Tapelist Utility Program . . . . . . . . . 144 Functional Verification . . . . . . . . . 156
Special Files . . . . . . . . . . . . . . 145 | Sense Data Logging . . . . . . . . . . 156
Device Behaviors . . . . . . . . . . . 146 Installation Problems . . . . . . . . . . 156
File Naming Conventions . . . . . . . . 148 Tape Monitor Daemon (tmd) . . . . . . . 157
Persistent Naming Support . . . . . . . . . 149 Tracing Facility . . . . . . . . . . . . 158
Control Path Failover Support for Libraries . . . 150 Dynamic Tracing Utility . . . . . . . . . 159
Configuring and Deconfiguring Path Failover Setting the IBM_trace Level for Static Tracing 160
Support . . . . . . . . . . . . . . 150 Running Diags_info Script . . . . . . . . 161
Primary and Alternate Paths . . . . . . . 150 iostat Command . . . . . . . . . . . 161
Querying Primary and Alternate Path Reservation Conflict Logging . . . . . . . 161
Configuration . . . . . . . . . . . . 151
This chapter provides an overview of the IBM SCSI Tape and Medium Changer
Device Driver for Solaris, also known as IBMtape.
Purpose
This device driver product provides attachment for IBM Magnetic Tape and
| Library System products to Sun Microsystems SPARC and x64 Servers running the
Solaris operating system.
It is designed specifically to take advantage of the features provided by IBM tape

and library systems, including control of the random access medium changer
facility (move, element information, and inventory) present in some devices. The
goal is to give applications access to the functions required for basic operations
(such as backup and restore), as well as the advanced functions 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 IBMtape. Figure 12 on page 122 shows the data flow between
IBMtape, the application program, the SCSI adapter device driver, and the IBM
tape system.

Solaris Device Driver (IBMtape)
SCSI or
IBMtape FC IBM
Application
Device Host Bus Tape
Program
a2500266
Driver Adapter Subsystem
Driver
Figure 12. Data Flow for Solaris Device Driver (IBMtape)
IBMtape.
The following hardware is required and supported by IBMtape:
v One of the following SCSI-2 Differential Host Bus Adapters:
– Sun Microsystems S-Bus Differential SCSI-2 Host Adapter
– Sun S-Bus Ultra Differential SCSI-2 Fast/Wide Host Adapter
– Sun Dual-Channel Differential Ultra SCSI Host Adapter PCI (requires FC 9799
for 3590 or FC 5099 for IBM Magstar MP 3570 or 3575)
– Sun Microsystems Differential Fast/Wide SCSI-2 Host Adapter (DWIS/S)
Host Adapter (UDWIS/S) (P/N X1062A)
v One or more of the following SCSI High Voltage Differential (HVD) host bus
adapters (359x only):
– Sun Microsystems Differential Fast/Wide SCSI-2 Host Adapter (DWIS/S)
Host Adapter (UDWIS/S) (P/N X1062A)
– Sun Microsystems SBus Ultra Differential Fast/Wide Intelligent SCSI-2 Host
Adapter (UDWIS/S) (P/N X1065A)
– Sun Microsystems Dual-channel Differential UltraSCSI Host Adapter, PCI
(P/N X6541A)
v One or more of the following SCSI Low Voltage Differential (LVD) host bus
adapters on Solaris Version 8, or later (Ultrium only):
– Sun Microsystems PCI Adapter with two fast Ethernet Interfaces and two
SCSI Interfaces (P/N X2222A)
– Sun Microsystems Dual Fast Ethernet + Dual SCSI PCI Adapter (Dual
VHDCI)
– Sun Microsystems PCI Dual Channel Gigabit Ethernet UTP & Dual Channel
SE Ultra-2 SCSI Adapter (P/N X4422A)
– Sun Microsystems PCI-X Single and Dual Ultra320 SCSI Host Adapter SCSI
Adapter (P/N SG-XPCI1SCSILM320-Z and SG-XPCI2SCSILM320-Z )
v One or more of the following Serial Attached SCSI (SAS) host bus adapters on
Solaris Version 10, or later (Ultrium only):
– Sun StorageTek PCI-X SAS HBA (SG-XPCI8SAS-E-Z)
– Sun StorageTek PCI-Express SAS HBA (SG-XPCIE8SAS-E-Z)
v The IBM 2108–G07 (IBM SAN Data Gateway) and IBM 2108–R03 (IBM SAN
Data Gateway Router) can be used to attach SCSI models of the IBM 357x, 3590,
and VTS of products with any of the supported FC–AL host bus adapters.

v The Ultrium tape drives and Enterprise Tape drives 3590 (Model E) and 3592
with Fibre Channel Attachment are supported with the following adapters:
– QLogic HBA:
QLA2200F, QLA2310FL, QLA2340/2340L, QLA2342/2342L, QLA2460/2462
PCI and PCI-X Fibre Channel Host Bus Adapters
QLE2560/2562 PCI-E Fibre Channel Host Bus Adapters
QLE2460/2462 PCI-E Fibre Channel Host Bus Adapters on x64 system only.
– Emulex HBA:
LP8000(PCI), LP8000S(S-Bus), LP9002C(cPCI), LP9002L(PCI), LP9002S(S-Bus),
LP9042DC(PCI-X), LP9802(PCI-X),
LP10000(PCI-X), LP11000/11002 (PCI-X) Fibre Channel Host Bus Adapters
LPe12000/12002 PCI-E Fibre Channel Host Bus Adapters
LPe11000/11002 PCI-E Fibre Channel Host Bus Adapters on x64 system only
– AMCC HBA:
FCX/2-6562(PCI-X), FCX-6562(PCI-X), FCC/2–6562(cPCI),
FCC-6562(cPCI), FCE-6460(PCI) and FCE-1473(S-Bus) Fibre Channel Adapters
– Sun Branded HBA:
Sun StorEdge 2 Gb FC PCI Single Channel network adapter (X6767A)
Sun StorEdge 2 Gb FC PCI Dual Channel network adapter (X6768A)
Sun StorageTek Enterprise Class 4 Gb FC PCI-X HBAs (SG-XPCI2FC-QF4 and
SG-XPCI1FC-QF4)
Sun StorageTek Enterprise Class 4 Gb FC PCI-E HBAs (SG-XPCIE2FC-QF4,
SG-XPCIE1FC-QF4, SG-XPCIE2FC-EM4, and SG-XPCIE1FC-EM4)
Sun StorageTek Enterprise Class 8 Gb FC PCI-E HBAs (SG-XPCIE1FC-EM8-Z.
SG-XPCIE2FC-EM8-Z, SG-XPCIE1FC-QF8-Z, and SG-XPCIE2FC-QF8-Z)
| – Brocade HBA:
| Brocade 8 GB FC PCI-E Host Bus Adapters (825, 815)
| Brocade 4 GB FC PCI-E Host Bus Adapters (425, 415)
| A known issue:
| Brocade HBAs do not support L-port topology. Direct attach configuration to
| our Tape Storage products is therefore not supported with these cards.
v Table 18 indicates which SCSI-attached devices are supported through the IBM
2108-G07 (IBM SAN Data Gateway) and IBM 2108-R03 (IBM SAN Data Gateway
Router) with which fibre-channel host bus adapters.
Table 18. SCSI Supported Devices
QLogic QLogic
DEVICE QLA2100 QLA2200F Emulex LP8000 Emulex LP8000S
Magstar MP X
3570
Magstar MP X
3575
Enterprise 3590, X X X X
models B11,
B1A, E11, and
E1A
VTS model B18 X X X X
VTS models B10, X X X
B20
Chapter 6. Solaris Tape and Medium Changer Device Driver 123

IBM Enterprise Tape Drive 3590, Models B11, B1A, E11, and E1A
IBM Magstar MP 3570 Tape Subsystem Model C
Notes:
1. Using a single Fibre Channel host bus adapter (HBA) for concurrent tape and
disk operations is not recommended. Tape and disk devices require
been observed. These issues are resolved by separating disk and tape I/O
streams onto separate HBAs and using SAN zoning to minimize contention.
IBM is focused on assuring server and storage configuration interoperability. It
strongly recommends that your implementation plan includes provisions for
separating disk and tape workloads.
2. For IBM Ultrium drives with the Fibre Channel attachment, the Sun Solaris
operating system requires that the Fibre Channel addressing mode of the drive
be set to hard addressing.
3. The most recent supported HBA information can be found at:
http://www-03.ibm.com/systems/support/storage/config/hba/index.wss .
The following software is required and supported by IBMtape:
v Sun Microsystems Solaris operating system Version 2.6, 7, 8, 9, or 10 on SPARC
servers. For Solaris Version 2.6, Sun patch 105867-01 is required.
v Sun Microsystems Solaris operating system Version 10 on x64 servers.
v SCSI Host Bus Adapter (HBA) driver as supplied by the HBA manufacturer.
Refer to the manufacturer’s documentation for the SCSI adapter driver to
determine which adapter driver is required.

IBM SCSI Tape Drive and Medium Changer Device Driver for Solaris is an
installable kernel module, supplied as a standard Solaris software package. When
installed, its package name is IBMtape. The following sections describe installation,
removal, configuration, and verification procedures for IBMtape. Refer to the
Solaris documentation for general information about installable packages.
The IBMtape package consists of the device driver and a number of associated files
and utilities. For components created during IBMtape installation, refer to Table 19.
Table 19. 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

Table 19. IBMtape Components (continued)

Component (Note) Description
/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 updating IBMtape, the working copies of IBMtape.conf, tmd.conf and
ibmekm.conf are not overwritten by the package file contents. This 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.
Preventing Conflicts with Other Device Drivers

IBMtape only attempts to claim and operate the devices described in “Hardware
Requirements” on page 122. However, the Solaris operating system includes a SCSI
tape device driver named st, which claims any SCSI-compliant tape drive that it
detects, including devices that IBMtape manages. In order to avoid conflicts
between IBMtape and st, you must prevent st from claiming and attempting to
operate IBMtape-owned devices. Likewise, other suppliers’ SCSI tape device
drivers that you have installed must be prevented from claiming IBMtape-owned
devices.
| 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 Sun FC and SAS HBAs” on
| page 133 for the details.
Attention: Failure to prevent more than one device driver from operating the
same tape drive may 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.
Follow these steps to install or update IBMtape. Before starting the step-by-step
procedure, note the following general considerations:
v Differential SCSI-2 support must already exist on the machine before installing
IBMtape. 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 may restart the system as part of the IBMtape installation. Take appropriate
precautions that this 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 may change. These numbers are assigned by Solaris
during the driver attachment process, and the sequencing cannot be specified by
the device driver or installer.
Installing and Updating IBMtape

There are several steps that must be taken prior to installing or updating IBMtape
on your system to ensure proper installation and system integrity. These are:
1. Notify users that system maintenance and a restart is performed.
2. Select a time when all system activity can be stopped to perform the
installation.
3. Login to the target system as root.
4. Ensure that all user and tape drive activity on the system is halted.
5. If tape drives not owned by IBMtape are installed on the system, list the
low-density device special files and find the SCSI addresses with which they
are currently associated.
% ls -l /dev/rmt/*l
lrwxrwxrwx 1 root root 72 Aug 26 15:47 /dev/rmt/5l ->
../../devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/st@2,0:l
In the preceding example, /dev/rmt/5l and the related 5m, 5h, and so on, are
controlled by the st device driver and are associated with the device at SCSI
address 2, LUN 0. 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 an installation has two non-IBM devices owned by st at
SCSI addresses 2 and 8. The low-density devices are accessed as special files
/dev/rmt/5l and /dev/rmt/6l. For the equipment listing after recording the device
information, refer to Table 20.
Table 20. IBMtape Install or Update
SCSI Address/LUN
DEVICE Old Special File Old Driver (Old)
QIC /dev/rmt/5l st 2/0
QIC /dev/rmt/6l st 8/0
6. If this is an update to IBMtape, there are already IBMtape-owned devices

installed. In that case, list the primary device special files and find the SCSI
addresses with which they are currently associated.
% ls -l /dev/rmt/*st /dev/rmt/*smc
lrwxrwxrwx 1 root other 46 Aug 26 16:36 /dev/rmt/0st ->
../../devices/pci@6,4000/scsi@3/IBMtape@b,0:st
lrwxrwxrwx 1 root other 47 Aug 26 16:36 /dev/rmt/1smc ->

../../devices/pci@6,4000/scsi@3/IBMtape@b,1:smc

| Note: When the drive is configured with Sun 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 above device special file is created by IBMtape. Refer to the section
| “Special Files” on page 145 for more 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 an installation has only an IBMtape-owned device
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 recording the
device information, refer to Table 21.
Table 21. Solaris Device Driver - IBMtape - Equipment Listing Example 1
SCSI Address/LUN
DEVICE Old Special File 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 Sun FC and SAS
| HBAs” on page 133 for the details.
same SCSI tape drive may cause system panics or data loss on the tape drive.
a. If the system has only IBMtape-owned devices 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 pound 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;
#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 should not be 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 those two addresses.
1) Edit /kernel/drv/st.conf, and comment out SCSI target entries for
addresses 7–15 by placing a pound sign (#) in the first column of each
target entry. In the following example, the entries for SCSI address 7
and 8 have been commented out. Repeat this operation for all entries
in the target address range 7–15.
#target=7 lun=0;
#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) Later, after the IBMtape package has been 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 have been configured
to avoid conflicting with IBMtape.
8. Remove all special file entries under /dev/rmt. This 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 132, and follow the instruction requirements for the
| selected HBA in the host machine before and/or after installing IBMtape.
10. If you are updating the level of IBMtape, remove the currently installed
IBMtape package. If this is a new installation of IBMtape, skip this step.
a. Use pkgrm to remove the current level.
% /usr/sbin/pkgrm IBMtape
Respond to the pkgrm prompts.

b. Examine the results from pkgrm. If you see these messages, one or more
IBMtape-owned tape drives or tape monitor daemon (TMD) were still in
use. Identify the drives and TMD process ID (pid), and end the processes
that are using them. If you cannot identify the processes, you must restart
the system to free the tape drive, then continue with the installation from
this point.
...
Device busy
Cannot unload module: IBMtape
Will be unloaded upon reboot.
...
11. Select one of the following methods to install the IBMtape package, depending
on the package distribution medium and the location of system resources.
Note: If this is a new install 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 have 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, perform the
| following steps. You may have obtained a package file by downloading it
| from IBM’s Fix Central website: http://www.ibm.com/support/fixcentral. For
| further information please see Appendix A, “Accessing Documentation and
| Software Online,” on page 317. This example presumes a package file named
| IBMtape.4.0.2.7 located 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 owned by st or another third-party SCSI tape device driver, you
should have already modified the configuration files for the non-IBM device
drivers and restricted them to target addresses in the range 0–6.
Edit IBMtape.conf, located in /usr/kernel/drv, and comment out entries for SCSI
target addresses 0–7 and 15 by placing a pound sign (#) in the first column of
each line making up the entries. In the following example, the entries for
address 0, LUN 0 and address 0, LUN 1 have been commented out. Repeat
the operation for all stanzas in the address range 0–7 and address 15. Note
that each SCSI target address has a stanza for both LUN 0 and LUN 1.
#name="IBMtape" class="scsi"
#target=0 lun=0
#block_size=0
#buffering=1
#immediate=0
#trailer=0
#sili=0;
#target=0 lun=1
#block_size=0
#buffering=1
#immediate=0
#trailer=0
#sili=0;
In SAN environment, the fibre channel HBA driver may map the SCSI target
address out of the range 15 and LUN over the number 1. You create a new
entry with the mapped SCSI target in IBMtape.conf. In the following example,
a IBM tape device is mapped to the SCSI target 32 and LUN 15.
name="IBMtape" class="scsi"
target=32 lun=15
block_size=0

buffering=1
immediate=0
trailer=0
sili=0;
Alternatively, you can modify the configuration file or use the utility 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 perform 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 attached, you may 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
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
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 to be owned by st or another SCSI tape device driver,
refer to the manufacturer’s hardware reference for any special
instructions about readdressing. Then readdress each device to an
address in the range 0–6. For each tape drive that is readdressed,
record the new SCSI address along side the special file number and old
SCSI address that you recorded previously.
2) Readdress all tape drives that are owned by IBMtape to addresses in
the range 8–14. Refer to the appropriate IBM hardware references for
any special instructions about readdressing. For each tape drive that is
readdressed, record the new SCSI address along side the special file
number and old SCSI address, if any, that you recorded previously.
For example, suppose an installation has two non-IBM devices owned
by st at SCSI addresses 9 and B (12 in decimal). 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, at
address 10, or X'0A'. Depending on the addresses chosen for the
non-IBM devices, after readdressing and recording device information,
refer to Table 22 for the possible equipment listing.


SCSI SCSI
Old Special Address/LUN Address/LUN
DEVICE File Old Driver (Old) (New)
QIC /dev/rmt/2l st 9/0 3/0
QIC /dev/rmt/3l st b/0 5/0
3590-B11 drive – – – a/0
3590-B11 changer – – – a/1
Note: The SCSI target address of fibre channel tape device may be over 15.
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 install.
% 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 an installation previously had two non-IBM devices
owned by st at SCSI addresses 2 and–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 chosen,
after completing installation and recording device information, refer to
Table 24 for the possible equipment listing entries.
SCSI SCSI
Old Special Old Address/ Address/ New New Special
DEVICE File Driver LUN (Old) LUN (New) Driver File (Note)
QIC /dev/rmt/5l st 2/0 2/0 st /dev/rmt/0l
QIC /dev/rmt/6l st 8/0 0/0 st /dev/rmt/1l
3590-B11 – – – 8/0 IBMtape /dev/rmt/2st
drive
3590-B11 – – – 8/1 IBMtape /dev/rmt /3smc
changer
Note: Based on the listing, you can see that the tape drive accessed previously as
/dev/rmt/5 is now accessed as /dev/rmt/0, the new medium changer is accessible as
/dev/rmt/3smc, and so on.
| 18. Perform validation of "configuration conflict" to avoid the device being

| configured with more than one device driver.
| a. List the device special files in /dev/rmt and check if any unexpected device
| special file is created by non-IBMtape driver.
| b. Verify whether same SCSI address or WWNN is pointed to different
| device special files owned by the different device driver. For example, a

| same tape drive is configured by st driver with the special file of /dev/rmt/0
| and by IBMtape driver with /dev/rmt/15st at the same SCSI address (target
| 0 and LUN 0).
| lrwxrwxrwx 1 root root 49 Jul 28 2009 /dev/rmt/0 ->
| ../../devices/pci@81,2000/fibre-channel@1/st@0,0:
| lrwxrwxrwx 1 root sys 56 Jul 28 2009 /dev/rmt/15st ->
| ../../devices/pci@80,2000/fibre-channel@1/IBMtape@0,0:st
| c. Run the system command or other utility to verify if the device can be
| opened using both device special file names.
| Using the device special files in above example, load the cartridge in the
| drive and run # mt -f /dev/rmt/* stat command
| (1) IBMtape opens the drive.
| # mt -f /dev/rmt/15stn stat
| IBM_ULT3580-TD5 tape drive:
| sense key(0x0)= No Additional Sense residual= 0 retries= 0
| file no= 0 block no= 0
| (2) st opens the drive.
| # mt -f /dev/rmt/0n stat
| IBM_ULT3580-TD5 tape drive:
| sense key(0x0)= No Additional Sense residual= 0 retries= 0
| file no= 0 block no= 0
| (3) st fails to open the drive.
| # mt -f /dev/rmt/0n stat
| /dev/rmt/0n: No such file or directory
19. Verify operation of the newly installed or readdressed equipment.
20. Notify users of any changed device special files numbers.
Configuring IBM tape devices with Fibre Channel and SAS

HBAs
Users may experience difficulty attaching an IBM tape device with an IBM tape
driver on a fibre network. The following sections describe how to configure IBM
| tape devices with QLogic, Emulex, Sun, Brocade and AMCC Fibre Channel HBAs:
v “Configuring IBM tape devices with QLogic FC HBAs”
v “Configuring IBM tape devices with Emulex FC HBAs” on page 133
v “Configuring IBM tape devices with Sun FC and SAS HBAs” on page 133
v “Configuring IBM tape devices with AMCC FC HBAs” on page 135
| v “Configuring IBM tape devices with Brocade FC HBAs” on page 135
Configuring IBM tape devices with QLogic FC HBAs

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 Sun
| branded QLogic FC HBA driver (qlc), refer to the section “Configuring IBM tape
| devices with Sun FC and SAS HBAs.”
Configuring IBM tape devices with Emulex FC HBAs

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 fails to configure the changer, you may need to add the entries for LUN
0 and 1:
name="IBMtape" parent="lpfc" target=X lun=0;
name="IBMtape" parent="lpfc" target=X lun=1;
4. Update the entry for the device in the IBMtape.conf file, if necessary. The current
entry in IBMtape.conf adds 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;
# rem_drv IBMtape
# /opt/IBMtape/tmd
| To configure an IBM tape device with an Emulex FC HBA running with Sun
| branded Emulex FC HBA (emlxs) driver, refer to the section “Configuring IBM
| tape devices with Sun FC and SAS HBAs.”
Configuring IBM tape devices with Sun FC and SAS HBAs

To configure an IBM tape device with a Sun FC HBA, complete the following
steps:
1. Attach the IBM tape devices on the host.
2. Install the appropriate patch for the Sun 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.pULTRIUM-TD1"
IBMtape "scsiclass,01.vIBM.pULT3580-HH3"
IBMtape "scsiclass,01.vIBM.pULTRIUM-HH3"
IBMtape "scsiclass,01.vIBM.p03592J1A"
IBMtape "scsiclass,01.vIBM.p03592E05"
IBMtape "scsiclass,01.vIBM.p03592E06"
For the medium changers:
IBMtape "scsiclass,08.vIBM.p03584L32"
IBMtape "scsiclass,08.vIBM.p03584L22"
IBMtape "scsiclass,08.vIBM.pULT3582-TL"
IBMtape "scsiclass,08.vIBM.pULT3583-TL"
IBMtape "scsiclass,08.vIBM.pULT3581-TA"
IBMtape "scsiclass,08.vIBM.pULT3581-TA2"
IBMtape "scsiclass,08.vIBM.p3576-MTL"
IBMtape "scsiclass,08.vIBM.p3573-TL"
IBMtape "scsiclass,08.vIBM.p3577-TL"
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 strongly
recommended that you back up these entries in a file, and that you
re-enter the entries when you upgrade the IBMtape driver before
running the #pkgadd command.

Configuring IBM tape devices with AMCC FC HBAs

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;
5. Update the entry for the device in IBMtape.conf if necessary. The current entry
in IBMtape.conf adds target 255 with LUN 0 and 1. For instance, use the
following command to add an entry for a mapped device with a target 200 and
LUN 3:
name="IBMtape" class="scsi" target=200 lun=3;
# rem_drv IBMtape
# /opt/IBMtape/tmd
| Configuring IBM tape devices with Brocade FC HBAs

| To configure an IBM tape device with an 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 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.pULTRIUM-TD1"
| IBMtape "scsiclass,01.vIBM.pULT3580-HH3"
| IBMtape "scsiclass,01.vIBM.pULTRIUM-HH3"

| IBMtape "scsiclass,01.vIBM.p03592J1A"
| IBMtape "scsiclass,01.vIBM.p03592E05"
| IBMtape "scsiclass,01.vIBM.p03592E06"
| For the medium changers:
| IBMtape "scsiclass,08.vIBM.p03584L32"
| IBMtape "scsiclass,08.vIBM.p03584L22"
| IBMtape "scsiclass,08.vIBM.pULT3582-TL"
| IBMtape "scsiclass,08.vIBM.pULT3583-TL"
| IBMtape "scsiclass,08.vIBM.pULT3581-TA"
| IBMtape "scsiclass,08.vIBM.pULT3581-TA2"
| IBMtape "scsiclass,08.vIBM.p3576-MTL"
| IBMtape "scsiclass,08.vIBM.p3573-TL"
| IBMtape "scsiclass,08.vIBM.p3577-TL"
| 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.
Solaris Zones Support

The Solaris Zones partitioning technology on Solaris 10 is used to virtualize
operating system services and provide an isolated and secure environment for
running applications. Every Solaris system contains a global zone with ID 0, where
the IBMtape driver is installed. Zones hosted by a global zone are known as
non-global zones, which have their own node name, virtual network interface, and
storage assignment.
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 install script installs the driver in the global zone and installs some of
IBMtape utilities running a non-root user in all zones.
Since the tape devices in non-global zones are configured from the global zone, a
script program called ztapelist was developed to help the user display the IBM
tape devices and to dynamically assign or remove 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.
Use the ztapelist utility on the command line as follows:
Synopsis
/opt/IBMtape/ztapelist [-l] [-c] [-z zonename] [-a] [-d] [-h]
Options and Usage
ztapelist recognizes the following options:
-l Displays IBM tape device information with the column headers for all
zones

-c Displays IBM tape device information without the column headers for all
zones
-z zonename Shows IBM tape devices in a zone
-a Dynamically adds IBM tape devices to each non-global zone without
additional arguments
zonename inst#_1 inst#_2 inst#_3 ...

Dynamically sets IBM tape devices not greater than 7 in a non-global
zone
zonename all
Dynamically sets all IBM tape devices on the system in a non-global
zone
-d Removes the IBM tape device from a non-global zone
-h Displays help information
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
Running in non-global zone camshaft ...

------- ------------- ----------------- ------------------ -------- ---------- ------------- -------------
Running in non-global zone softail ...

------- ------------- ------------- ------------ ---------- -------- --------------- ------------------
193 /dev/rmt/27st 03592E05(e/e) 000001365066 2/0 1A38 500507630019F016 500507630059F016
To add the tape devices in non-global zones, run # /opt/IBMtape/ztapelist -a, as

shown in the following example:

# ztapelist -a
Issuing this function will assign the tape devices in non-global zone
Do you wish to continue? [y/n]: y
------- ---------------- ------------ -------------- ------------ ---------- ---------------- --------------
193 /dev/rmt/27st 03592E05(e/e) 000001365066 2/0 1A38 500507630019F016 500507630059F016
206 /dev/rmt/31st ULT3580-TD3 1210003557 7/0 73P5 500507630019F007 500507630059F007
Enter Instance Number (Inst #) of a device to be added: 200
ID NAME STATUS PATH

0 global running /
1 camshaft running /zones/zone1
2 softail running /zones/zone2
Enter the zonename where the device will be added: camshaft
------- --------------- ---------------- ----------------- --------- ------- --------------- ---------------
Do you wish to continue to add the devices? [y/n]: y

Enter Instance Number (Inst #) of a device to be added: 193
Enter the zonename where the device will be added: softail
------- --------------- ---------------- ----------------- --------- ------- --------------- ---------------
193 /dev/rmt/27st 03592E05(e/e) 000001365066 2/0 1A38 500507630019F016 500507630059F016
Do you wish to continue to add the devices? [y/n]: n

#
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:

# /opt/IBMtape/ztapelist -d
Issuing this function will remove the tape devices from non-global zone
Do you wish to continue? [y/n]: y
Do you want to remove the tape devices from all of non-global zones? [y/n]: n
ID NAME STATUS PATH
0 global running /
Enter the zonename where the devices will be removed: camshaft

Do you want to remove all of the tape devices from this zone? [y/n]: n
------- ---------------- ------------- ----------------- ----------- -------- ------------------ -----------------
Enter Instance Number (Inst #) of a device to be removed: 201

Removing this tape device /dev/rmt/30smc for this zone camshaft ...
------- -------------- ------------------ ---------------- ---------- -------- ------------------- ------------------
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 /
Enter the zonename where the devices will be removed: softail

Do you want to remove all of the tape devices from this zone? [y/n]: y
Removing all of tape devices for this zone softail ...
------- ------------------- --------------- ------------------ --------- -------- -------------- -------------------
Do you wish to continue to remove the devices from other zone? [y/n]: n
When using devices controlled by IBMtape, 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 located in the /usr/kernel/drv directory.
During installation of IBMtape, the working copy of IBMtape.conf is preserved, if it

exists. During removal of IBMtape, the working copy of IBMtape.conf is not
deleted. These conventions allow configuration settings to remain across updates of
IBMtape. A reference copy of IBMtape.conf with factory default settings is always
installed in the /opt/IBMtape directory.
Note: IBM requires that the Solaris native SCSI tape device driver st be 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
125 for more information about multiple driver access to a device.
same tape drive may 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:

% /opt/IBMtape/tmd -s for IBMtape.4.0.9.2 and later

% /usr/sbin/rem_drv IBMtape
% /usr/sbin/add_drv -m ’* 0666 bin bin’ IBMtape
% /opt/IBMtape/tmd for IBMtape.4.0.9.2 and later
Default settings in IBMtape.conf can be overridden for a particular device (and only
while the device is kept open) using the ioctl application programming interface
(API) of the device driver. The parameter settings made through the API revert
back to the default values in IBMtape.conf the next time the device is opened. Refer
to the IBM TotalStorage and System Storage Tape Device Drivers: Programming Reference
for more information about changing configuration parameters under program
control.
IBMtape.conf contains one stanza for each SCSI target address/LUN pair owned by
IBMtape. The reference IBMtape.conf file supplied with the package contains a
stanza for every possible SCSI target and LUN combination 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 returning status:
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,
which causes the SCSI rewind command to return control to the application
program before the command actually completes on the tape drive:
target=0 lun=0
block_size=0
buffering=1
rew_immediate=1
trailer=0
sili=0;
If immediate is set to 1 and rew_immediate is set to 0, the setting of

rew_immediate is ignored.
The name variable identifies IBMtape as the device driver, and class identifies the
type of device 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
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 having that target address and LUN.
After installation of the IBMtape package is complete, you may eliminate

unnecessary probing for devices by commenting out unused target/LUN pairs. In

this example, the stanzas for target 0, LUN 0 and target 0, LUN 1 have been
commented out. Those address/LUN combinations are not probed, which saves
time during a restart or manual reload of IBMtape. However, if an IBM device is
addressed at target 0, LUN 0 or target 0, LUN 1, it is not detected.
#target=0 lun=0
#block_size=0
#buffering=1
#immediate=0
#trailer=0
#sili=0;
#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 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.
Remember that 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 using an ioctl function call, but the change is effective
only while the device remains open. Working configuration parameters revert back
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 more information about changing configuration parameters through program
control.
Table 25 lists and describes the set of configuration parameters recognized by the
IBMtape device driver.
Table 25. Configuration Parameters Recognized by IBMtape
Parameter Values Description
block_size (0=variable length) This option specifies the device block size that is 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 using
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 additional 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 using 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.

Table 25. Configuration Parameters Recognized by IBMtape (continued)

Parameter Values Description
buffering (0=Off, 1=On) When a write command is processed, the data is either directly stored on the
physical tape or buffered in device hardware. Buffering can be turned On and
Off with this option. If buffering is disabled, the effective performance of the
device may be degraded seriously, because the tape devices cannot take
advantage of their buffering optimization. Buffer flushing (or committing data
to the tape) can be controlled by the application through the
STIOC_SYNC_BUFFER ioctl function
immediate (0=Off, 1=On) If immediate is set to 0, the SCSI commands Write FM, Locate, Load-Unload,
Erase, and Rewind return with status when the command actually completes
on the tape drive. If immediate is set to 1, these commands return with status
before the command actually completes.
| reserve_key (A string of 1-8 The user specifies the Persistent Reservation key that will be used by the
| character ASCII device driver when the Persistent Reservation is used.
| alphanumeric key
| such as "key12345". The reserve key is assigned by the driver by default.
| If less than 8
| characters are used,
| the remaining
| characters will be
| set to 0x00(NULL).
| reserve_type (1=reserve(6), This parameter specifies the SCSI Reservation type that will be used by the
| 2=reserve(10), device driver, either a SCSI Reserve(6) command or a SCSI Persistent Reserve
| 3=persist_reserve) command. The SCSI Reserve(10) command is unsupported recently.
The reserve type 1 is set by default.

Note: This parameter is not used if the Data Path Failover is supported.
rew_immediate (0=Off, 1=On) If rew_immediate is set to 0, the SCSI Rewind command returns with status
when the command actually completes on the tape drive. If it is set to set to
1, the Rewind command returns with status before the command actually
completes. If immediate is set to 1, the setting of rew_immediate is ignored.
trailer (0=Off, 1=On) If a tape drive encounters logical end-of-tape (EOT) during a write operation,
it returns a check condition status. The driver returns 0 bytes written to
notify the application of this EOT situation. A check condition is also
returned by the tape drive for every subsequent write operation when past
EOT. If trailer is enabled, writing records past EOT is allowed by the device
driver. Following the first time the write operation notifies the application of
EOT, all subsequent EOT notifications are suppressed by the driver, and the
actual number of bytes written is returned. When physical end of media is
reached, all write operations fail with a return code of -1, regardless of the
trailer setting. When trailer is enabled, managing the media past EOT is the
application’s responsibility.
sili (0=Off, 1=On) Normally, during a read operation, if a larger block of data is requested than
is actually read from the tape, the tape device raises a check condition. The
IBMtape device driver must perform error handling procedures, which add
overhead to the read operation. The IBMtape driver does not surface this as
an error condition to the application and ultimately returns the actual
number of bytes read. However, this driver error processing results in less
than optimum read performance in some scenarios. When SILI mode is
enabled, the tape device is forced to Suppress Illegal Length Indication
during read operations. This eliminates the error processing performed by the
driver and results in improved read performance for some scenarios. The
actual number of bytes read is still returned to the application in SILI mode.

Removing IBMtape
All active processes using IBM devices supported by the IBM SCSI Tape and
Medium Changer Device Driver for Solaris must be stopped in order for the
removal procedure to complete successfully.
Use the pkgrm command to remove the IBMtape package from the system.
% /usr/sbin/pkgrm IBMtape
Adding or Removing Devices

To add support for a new IBM tape system or to remove support for a previously
attached IBM tape system, perform the following steps:
1. Edit the IBMtape.conf file in the /usr/kernel/drv directory to reflect the change in
IBM device support. Either add a new stanza to provide support for a device
that is to be added, or remove (comment out) a stanza for a device that is no
longer supported.
2. When adding support for a new device, ensure that the target and LUN values
in the configuration file stanza match the target and LUN settings of the IBM
device. Refer to “Configuration Parameters” on page 139 for more information
about the IBMtape.conf configuration file.
3. Shut down and power Off the host system.
4. Plug the new device into the SCSI bus or unplug the existing device from the
bus. Pay particular attention to proper SCSI cabling and termination.
5. Power On and start the host system.
Notes:
a. It is possible to reinitialize the IBMtape device driver without restarting the
system. This 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 has to be
stopped by running the /opt/IBMtape/tmd -s command to unload the
IBMtape driver from the kernel. Running the /opt/IBMtape/tmd command
restarts the daemon afterwards 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
When the IBMtape device driver is reloaded, it reads the IBMtape.conf file and
acknowledge changes made in the file. This method can be used to modify
configuration parameters.
Note: It is strongly suggested that the host system and all devices attached to
the SCSI bus be powered Off before adding or removing devices from
the SCSI bus. Hot plugging SCSI devices can cause hardware damage
and disruption of reliable system operation.
Deconfiguring Tape Devices

In some special situations, the user cannot modify IBMtape.conf to deconfigure
some tape devices with IBMtape driver, when more than one device is configured
with the same target address, or the tape devices are attached on the FC or SAS
HBA running with Sun HBA driver.

In IBMtape.4.1.9.2 and later, a configuration parameter defined exclude_dev_list is

introduced to allow users to exclude some devices from the configuration with
IBMtape.
Deconfigure the tape device using the following:

1. Add the entry of “exclude_dev_list” in IBMtape.conf located in
/usr/kernel/drv.
exclude_dev_list=”sn1,sn2,sn3,...” ;
Where: “sn” is the serial number of the excluded device, 10-characters long for
LTO drive, 12-characters long for 359x drive and 16-characters long for changer.
The serial number can be found running the following command:
/opt/IBMtape/tapelist -l
2. Re-install IBMtape driver or reboot the system to allow IBMtape update the
configuration.
Tapelist Utility Program

A Tapelist Utility Program called tapelist is installed in the /opt/IBMtape directory
as part of the IBMtape package. The tapelist utility provides the user a listing of
tape, medium changer and SAN data gateway devices configured with the
IBMtape driver. It also displays the information of HBA with IBM tape drive
attachment and the current status of load balancing. The following is an example
of a Tapelist Utility Program output.
# tapelist
Instance : 697
Special File : /dev/rmt/6st
Device : 03592E05(e/e)
Serial Number : 000001300168
TGT/LUN : 7/0
Ucode : 04C4
World Wide NN : 5005076302000127
World Wide PN : 5005076302400127
Dev Phy Path : /devices/pci@1f,2000/QLGC,qla@1/IBMtape@7,0:st
Path Type : N/A
# 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
Library (/dev/rmt/7smc) Info:

2899 /dev/rmt/7smc 03584L32 0000000T00390401 6/1 806c N/A N/A
265 2898 /dev/rmt/6st ULT3580-TD4(e) 1300000044 6/0 82F0 500507630019F009 500507630059F009
Library 3494 Info:

322 /dev/rmt/10st 03592J1A 000001300147 1/0 0464 5005076300000000 5005076300400000

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.
The usage of the tapelist program is as follows:

-l Print for all of the configured devices with the column headers in long list
-L Display the tape drives information in the tape library
-c Don’t print column headers in long list for all of the configured devices
-t Display HBA information and current load balancing status
-f Print the list for a particular file only
-A List the tape devices by HBA
-a Print out the info of all of FC HBAs
-h Help menu
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
performing input/output (I/O) operations to each supported device. The device
special file names created by the IBMtape device driver are similar to the SCSI tape
special files generally 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 actually 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 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.
There may also be entries 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 ->

10000/IBMtape@2,0:st
lrwxrwxrwx root other 79 Aug 26 18:54 0stb ->
10000/IBMtape@2,0:stb
lrwxrwxrwx root other 80 Aug 26 18:54 0stbn ->
10000/IBMtape@2,0:stbn
lrwxrwxrwx root other 79 Aug 26 18:54 0stc ->
10000/IBMtape@2,0:stc
lrwxrwxrwx root other 80 Aug 26 18:54 0stcb ->
10000/IBMtape@2,0:stcb
lrwxrwxrwx root other 81 Aug 26 18:54 0stcbn ->
10000/IBMtape@2,0:stcbn
lrwxrwxrwx root other 80 Aug 26 18:54 0stcn ->
10000/IBMtape@2,0:stcn
lrwxrwxrwx root other 79 Aug 26 18:54 0stn ->
10000/IBMtape@2,0:stn
These entries show the device hierarchy established to support I/O for an IBM
SCSI tape system. The attachment path of the device special files spans from the
system board, through the S-bus, to the Sun F/W SCSI adapter (supported by the
QLGC, isp SCSI adapter device driver), to the IBM device at SCSI target 2 and
LUN 0 (supported by the IBMtape device driver). All nine of these special files are
associated with the same IBM device (device number 0).
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 may be opened at any one time. The
smc special file may 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, based on the IBM device type being 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 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 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 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 and 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 more information on device special files and major and minor numbers,
consult the Solaris mtio man pages.

File Naming Conventions

Table 26 shows the special file naming convention and the associated device
attributes recognized by the IBMtape device driver.
Table 26. IBM SCSI Tape/Medium Changer Special Files for Solaris
BSD Compatibility (Note
Special File Name 1) Rewind on Close (Note 2) Compression (Note 3)
/dev/rmt/[0–255]smc (Note 4) N/A N/A N/A
/dev/rmt/[0–255]stn (Note 5) No No No
/dev/rmt/[0–255]stcn (Note 5) No No Yes
/dev/rmt/[0–255]st (Note 5) No Yes No
/dev/rmt/[0–255]stc (Note 5) No Yes Yes
/dev/rmt/[0–255]stbn (Note 5) Yes No No
/dev/rmt/[0–255]stcbn (Note 5) Yes No Yes
/dev/rmt/[0–255]stb (Note 5) Yes Yes No
/dev/rmt/[0–255]stcb (Note 5) Yes Yes Yes
Notes:
1. The BSD (b) device special file modifies close behavior for non-rewind devices. If the device is opened for no
rewind on close in non-BSD mode, and if the last command before closing the device was a read, then the tape
is positioned after the filemark immediately following the last block read. If the device is opened for no rewind
on close in BSD mode, and if the last command before closing the device was a read, the tape is left positioned
exactly where it was following the last block read. If the device is opened for rewind on close the BSD mode is
not relevant.
2. The no rewind on close (n) device special file does not rewind the tape during a close operation. Otherwise, the
tape is rewound when the device is closed. If the last operation before closing the device was a write or write
filemark, then a sufficient number of filemarks is written so that two filemarks follow the data.
For the non-rewind special files, the tapes are positioned between the trailing filemarks before closing. If the
device is then reopened and more data is written, it is separated by a single filemark from the previous data.
3. The compression (c) device special file determines whether the tape device uses built-in hardware compression
while storing data on the tape. The compression mode of the device can also be set to the desired state
programmatically through the STIOC_SET_PARM ioctl, regardless of the default compression mode established
by the special file originally used to open the device.
4. The smc special file is created only for IBM tape systems that provide medium changer capability. For IBM tape
libraries and autoloaders, the smc special file is the only file created because the IBMtape device driver supports
only the medium changer portion and does not support the tape drive portion of these devices. For the IBM
3490E Magnetic Tape System, there is no smc special file created.
5. Only one st special file may be opened at one time. The smc special file may be opened by itself or in
conjunction with one of the st type files. The smc special file accepts only medium changer commands. Tape
drive commands issued to the medium changer fail, with errno set to 22, invalid argument.
Aside from the normal configuration with the medium changer answering as a distinct target/LUN pair, some
supported devices can be configured with a nonstandard integrated medium changer reporting at the same
target and LUN as the tape drive. In such a case, both st and smc special files accept a limited subset of medium
changer commands. If you want to use this nonstandard mode, consult the appropriate hardware reference to
determine whether the drive supports such a configuration.


The device special file names are created by the IBMtape driver in the order that
the tape devices are presented by the Solaris system. Each device special file name
is maintained with the same logical name across reboots, even when an existing
device is powered off or not connected.
However, the logical names of devices may be changed due to the swapping of
connecting cables, HBA mapping changes, tape device driver updates, or other
reasons.
The user can rename the logical name by editing the /etc/devlink.tab system file for
the persistent name binding and reloading the IBMtape driver as follows:
1. Before the persistent name binding, make sure that the IBM tape devices are
configured at the different target and LUN addresses if the devices are attached
on more than one HBA.
The Ultrium-3 tape drive is connected to two Emulex HBAs with the same
address of target 3 and LUN 0 via a switch in the following example. You have
to use the HBA utility, follow HBA vendor instructions, or both to persistently
bind the tape devices at the different mapped target and LUN.
# 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
------ --------------- ----------- --------- ---------- ----------------------------------------
Note: Device persistent binding is not provided on Sun HBAs, so this

persistent name approach cannot be used with the same physical drive
that is attached to multiple Sun HBA ports.
2. Start persistent name binding. In this example, the user renames 4st and 7st to
10st and 11st.
a. Create the entry for persistent naming. Determine the target address from
the Device Physical Path in the output of tapelist -l and add the planned
device special file name in the entry. Here, 4st and 7st drives are located at
3,0 (target 3, LUN 0) and 18,0 (target 24 (0x18), LUN 0) at the device
physical paths of /devices/pci@6,2000/pci@1/fibre-channel@5/IBMtape@3,0
and /devices/pci@1f,2000/pci@1/fibre-channel@5/IBMtape@18,0. Add the
address and device file name into the entries:
type=ddi_byte:tape;addr=3,0; rmt/10\M0
type=ddi_byte:tape;addr=18,0; rmt/11\M0
Notes:
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 Sun HBA
with the path of /devices/pci@1,0/pci1022,7450@1/pci1077,141@1/
fp@0,0/tape@w500507630059f007,0.
b. Add the above entry into the /etc/devlink.tab system file.
c. Remove existing links created by the IBMtape driver from /dev/rmt by
running the # rm command.
d. Run the # devfsadm command without any options to enable IBMtape to
create the new device special file name as defined in the entries in
/etc/devlink.tab. A system reboot is also required if the tape device is
attached on Sun HBA.
e. Run tapelist to list the device special files.
# tapelist -l
------ ------------- ------------ ------------- ---------- -------------------------
Control Path Failover Support for Libraries
Configuring and Deconfiguring Path Failover Support

Control path failover (CPF) support is enabled automatically by default when the
IBMtape device driver is installed on Solaris system. The Solaris IBMtape device
driver provides a driver configuration parameter failover for you to enable or
disable the library control path failover support. To enable the CPF support for all
of the paths, no any action is required. To disable the CPF support for all of the
paths or a particular path, use the following steps:
1. To disable CPF support for all the paths, add and set the failover parameter to
off at the beginning of IBMtape.conf file in the directory of /usr/kernel/drv.
2. To disable a particular path, add and set the failover parameter to off in the
path entry in IBMtape.conf file. For example, name="IBMtape" class="scsi"
target=3 lun=1 failover=0;
3. Stop the TMD (tape monitor daemon) running on the system and unload the
IBMtape driver module from the current kernel:
# /usr/sbin/rem_drv IBMtape
4. Reload the IBMtape driver module in the kernel and start the daemon:
# /usr/sbin/add_drv -m ’ 0666 bin bin’ IBMtape
# /opt/IBMtape/tmd

enabled, the first device configured always becomes the primary path. When a
second or more logical device is configured with path failover support enabled for
the same physical device, it configures as an alternate path. The device driver
supports up to 16 physical paths for single a device.
The primary and alternate 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 Figure 13.
#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
/devices/pci@If,2000/QLGC,qla@1/IBMtape@2,1 Alt_path_1
/devices/pci@If,2000/QLGC,qla@1/IBMtape@5,1 Alt_path_2
Figure 13. Example of Control Path Failover Support Command Output

information only; it is used to:
1. Identify the actual number of physical devices configured on the system and a
specific logical device associated with them. There is only one logical device
labeled the primary path for each physical device. However, there can be
multiple logical devices labeled as an alternate path for the same devices.
path failover enabled.

the tapelist utility.

Once you install the IBMtape device driver, by default, all the available paths for a
physical device are enabled.
Note: The tape drive failover feature code must be installed prior to enabling the
DPF for IBM Ultrium tape drive in the Solaris IBMtape device driver. Refer
to “Automatic Failover” on page 10 to determine which feature code is
required for your machine type.
Configuring and Deconfiguring Path Failover Support

| Path failover support for tape drives is enabled automatically when the device
| driver with the version of IBMtape.4.2.1.0 or later is installed, and is disabled by
| default at the previous version. When path failover support is enabled for a logical
device, it remains set until the device is deleted or the support is deconfigured.
The path failover setting is retained even if the system is rebooted. 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 may be desirable at times to configure
some, but not all, logical paths to a device with the support enabled. Follow the
above steps to enable the DPF support:
1. To enable the support globally on all currently configured devices, add an entry
of dpf_support=1 at the beginning of the IBMtape.conf file, such as
dpf_support=1;
2. Or, to enable a particular path, add the parameter dpf_support and turn it on
in the path entry in the IBMtape.conf file. For example,
name="IBMtape" class="scsi" target=3 lun=0 dpf_support=1;
3. For the IBM Ultrium tape drive, you need to enter the DPF feature key(s) in the
parameter dpf_keys at the beginning of the IBMtape.conf file in the directory
/usr/kernel/drv. For example:
dpf_keys="A729E60F7B119411, C7A0B9ef2c1a4360, a729e60f7b118460";
Notes:
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.
IBMtape driver module from the current kernel
# /opt/IBMtape/tmd
| This 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;
# /opt/IBMtape/tmd
To disable the support on a single logical device, following these steps:

1. To enable the support globally on all currently configured devices, add an entry
dpf_support=1 at the beginning of the IBMtape.conf file, such as
dpf_support=1;
2. To disable a particular path, add the parameter dpf_support and turn it off in
the path entry in the IBMtape.conf file. For example,
name="IBMtape" class="scsi" target=3 lun=0 dpf_support=0;

# /opt/IBMtape/tmd

enabled, the first device configured always becomes the primary path. When a
second logical device is configured with path failover support enabled for the same
physical device, it configures as an alternate path. A third logical device is
configured as the next alternate path, and so on. The device driver supports up to
16 physical paths for a single device.
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 Figure 14.
#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
Figure 14. Example of Data Path Failover Support Command Output

logical device labeled the primary path for each physical device. However,
there may be many (multiple) logical devices labeled as an alternate path for
the same devices.

the tapelist utility.


Once you enter the parameter dpf_support in the IBMtape.conf file and install the
IBMtape device driver, all the available paths for a physical device are enabled.
| 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 dpf_support=0
| 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:
| # /usr/sbin/add_drv -m ’ 0666 bin bin’ IBMtape
| # /opt/IBMtape/tmd
| To enable a path from a disabled state, you may 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) 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 can be set on global or a specific tape drive in
IBMtape.conf in /usr/kernel/drv. There are 2 new configuration parameters added
for encryption:
sys_encryption_proxy “ON/OFF” Use System Encryption FCP Proxy Manager
sys_encryption_write “OFF/ON/CUSTOM” System Encryption for Write
Commands at BOP
The sys_encryption_proxy parameter enables device driver system-managed

encryption for a tape drive by setting the value to ON (default set).
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 using system-managed encryption to
control write encryption without device driver intervention. The parameter is set to
“CUSTOM” by default.
Note: If sys_encryption_write is set to ON, an application can not open a tape

drive using the append mode.
To make a global setting to enable SME in IBMtape.conf:

sys_encryption_write=1; # System Encryption for Write Commands at BOP
Solaris System-Managed Encryption
To enable SME for a particular target:

name="IBMtape"
class="scsi"
target=0
lun=0
block_size=0
buffering=1
immediate=0
trailer=0
sili=0
sys_encryption_write=1;
To disable SME in a particular target:

name="IBMtape"
class="scsi"
target=0
lun=0
block_size=0
buffering=1
immediate=0
trailer=0
sili=0
sys_encryption_proxy=0;

| This is a tape diagnostic and utility function, refer to Chapter 9, “IBM Tape
| Diagnostic Tool (ITDT),” on page 231..
Testing Data Encryption Configuration and Connectivity

| There is a data encryption test available to validate the ibmekm.conf file server
| entries and test tape drive to server connectivity operations.
| This is a tape diagnostic and utility function, refer to Chapter 9, “IBM Tape
| Diagnostic Tool (ITDT),” on page 231..
Field Support Information

When encryption failures require field support and/or development analysis, run
/opt/IBMtape/diags_info script to generate a file of diags.out. Tape drive dumps
and EKM server logs may be needed in addition to this information.
The following sections describe the service and diagnostic aids that are part of the
IBM SCSI Tape and Medium Changer Device Driver for Solaris package.
Procedures for verifying correct installation of the device, basic problem
determination guidelines, and outlines of the utility program included with the
IBMtape package are included.

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 installation was successful
/usr/bin/pkginfo IBMtape
The following information should 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 attached to
the system is functioning correctly, enter the following command:
/opt/IBMtape/tapeutil -f /dev/rmt/nst -o chk -v
substituting for n the number 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 (using the ls command) can be helpful in determining the proper
special file name. For medium changer devices, the special file name
/dev/rmt/nsmc should be used.
IBM xxxxxxxx configured at /dev/rmt/nst.
Where: xxxxxxxx is the model number of the IBM tape system and n is the
same number specified in the verify command.
3. To verify that the IBMtape device driver is loaded in kernel memory, enter the
following command:
/usr/sbin/modinfo | /usr/bin/grep IBMtape
165 f5f10000 15c0s 109 1 IBMtape (IBM SCSI Tape/Medium Changer DD)
The first five fields 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
| Sense Data Logging

| When the tape drive responds with CHECK CONDITION status and associated
| sense keys of 0x1 (Recovery Error), 0x3 (Medium Error), 0x4 (Hardware Error) and
| 0xB (Aborted Command) for a hardware or medium error, the sense data is logged
| into the system log file (typically /var/adm/messages).
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
may be of assistance. If you cannot solve the problems after checking the
following, 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, powered On,
and online. It is not necessary for the tape drive to have a cartridge 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 Sun native tape device driver (st) is not contending for the same
IBM device by consulting the st.conf file in the /kernel/drv directory and
commenting out conflicting stanzas.
Tape Monitor Daemon (tmd)

The Tape Monitor Daemon is introduced in the version of IBMtape.4.0.9.2 or later.
It is designed to run concurrently with the IBMtape driver and to automatically
retrieve and store the IBM tape drive diagnostic information (drive dump) into the
/var/opt/IBMtape directory. The daemon is automatically started when the driver
is installed, even no any tape device is attached on the system. An entry "
name="IBMtape" parent="pseudo" instance=16383; " is also entered into the
configuration file of /usr/kernel/drv/IBMtape.conf automatically for the daemon
during the IBMtape driver installation.
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.
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.
The file name of dump presents some useful information. An example of the dump
file is:
IBMtape.000001300148.2004-04-09-14:54:14.dump.gz
Here, 000001300148 represents the serial number of the tape device,

2004-04-09-14:54:14 is the time stamp for the dump retrieval.
A message is also logged in the syslog file of /var/adm/messages after a drive

dump is retrieved by tmd. For example,
Apr 9 14:54:21 Java tmd[3279]: Drive dump saved to /var/opt/IBMtape
IBMtape.000001300148.2004-04-09-14:54:14.dump.

Tracing Facility
IBMtape incorporates a tracing facility that is useful for performing 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 160 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 27. 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 should generally be used only when
directed by IBM support personnel.
Table 27. Tracing Facility
Trace Level Items Traced
0 Severe error conditions only. For installations with extremely small /var file
systems, this setting can prevent filling the file system unexpectedly.
However, this may be at the cost of not recording messages 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 generally
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 has 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.
The second line decodes selected fields from the sense data that follows it. The
decoded information shows that sense data was generated during a Move Medium
command. Looking up the decoded Sense Key /ASC/ASCQ combination in the
3590 hardware reference, we find that the command failed because the move from
location was empty. The actual sense data follows the decoded fields.
Note: Solaris, rather than printing multiple sixteen byte lines of hexidecimal
zeroes, 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) 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) 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:
$ ls -l /dev/rmt | grep "/pci@6,4000/scsi@2,1/IBMtape@2,0"
lrwxrwxrwx 1 root other 48 Aug 26 11:49 8st ->
../../devices/pci@6,4000/scsi@2,1/IBMtape@2,0:st
lrwxrwxrwx 1 root other 49 Aug 26 11:49 8stb ->
../../devices/pci@6,4000/scsi@2,1/IBMtape@2,0:stb
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.
Dynamic Tracing Utility

A dynamic tracing utility named tapedtrc is introduced in the IBMtape.4.1.6.0 or
later driver to dynamically set, reset, start, stop and query IBMtape tracing at any
time for debugging use. The program is located in the /opt/IBMtape directory, with
the tracing level set to 0 by default.

Use the tapedtrc program from the command line as follows:

/opt/IBMtape/tapedtrc [option]
options:
[set] - Set IBMtape trace level and/or start the tracing
[set] level - Set trace to a particular trace level
[get] - Query the current IBMtape trace level
[start] - Start IBMtape tracing
[stop] - Stop IBMtape tracing without the trace level reset
[clean] - Stop the IBMtape tracing and reset IBMtape trace
level to 0
[help] - IBM tapedtrc help menu
Setting the IBM_trace Level for Static Tracing

The user can still enable or disable static IBMtape tracing and set the IBM trace
level in /etc/system or by running the adb system command. The host is required to
reboot to enable or disable the tracing when the trace level is set in /etc/system. The
IBMtape driver must be loaded in the kernel. If the tracing is enabled or disabled
using the adb command, the tracing starts or stops at the next device open.
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
When IBM_trace is set in /etc/system, it affects tracing during driver loading,

initialization, and operation.
You may also set or modify the IBM_trace value manually in an adb session.
Because the driver must already be loaded and initialized before using this
method, 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 pound
signs (#) or exclamation and pound 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
!#
!# Set default for input values to base 10.
adb> a$d
radix=10 base ten
!#
!# Display current IBM_tape value as unsigned decimal integer.
adb> IBM_trace/u
IBM_trace:
IBM_trace: 0
!#
!# Set new IBM_trace value.
!# adb will confirm the old and new values.
adb> IBM_trace/w 2
IBM_trace: 0 = 2
!#
!# Quit session.
adb> $q
#
# Back to the shell.
ksh>

Running Diags_info Script

Run the diags_info script located in the /opt/IBMtape directory. This script detects
the problems on the configuration files, gathers important system HBAs and
configuration information. The script should be run as root. If not run as root, the
information should be labeled as such, but the value of the information is
degraded when run as a non-root user.
To facilitate capture of data, the script places information in a file called diags.out
in the directory locating the script. 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.

device has been opened it will log a reservation conflict in the Solaris system log of
/var/adm/messages. Prior to logging the error the device driver will issue a
Persistent Reserve In command to determine if a SCSI Persistent Reservation is
active on the reserving host to get the reserving host initiator WWPN (World Wide
Port Name) and reserve key. If successful, the device driver will log this
information in the detail data below. After initially logging the reserving host
WWPN, subsequent reservation conflicts from the same reserving host WWPN and
reservation key will not be logged to prevent multiple entries in the system log
until either the reserving host WWPN or reservation key is different than the one
initially logged or the device driver has reserved the device and then another
Here are the log examples:

1. The information is logged when the drive is reserved with a Persistent
Reservation.
log_reserve: Reserving host key 46E48C49413E6EB1 WWPN 210000E08B118BB1
2. The information is logged when the drive is reserved with a SCSI-2 Reserve.
log_reserve: Reservation Conflict: read full status failure (rc 16)
3. The information is logged when the drive is reserved but the host reservation
information isn't available.
log_reserve: Reservation Conflict: No reserving host information is available.


Chapter 7. Windows Tape and Medium Changer Device Driver
Purpose . . . . . . . . . . . . . . . 163 Data Path Failover Support for Tape Drives . . . 170
Data Flow . . . . . . . . . . . . . . 163 Configuring and Unconfiguring Data Path
Product Requirements . . . . . . . . . . 164 Failover Support . . . . . . . . . . . 171
Hardware Requirements. . . . . . . . . 164 | Reserve Type if DPF is disabled . . . . . . 171
Software Requirements . . . . . . . . . 165 Querying Primary and Alternate Path
Installation and Configuration Instructions . . . 165 Configuration . . . . . . . . . . . . 171
Windows Server 2003, and Windows Server Checking Disablement of Data Path Failover
2008 Instructions . . . . . . . . . . . 165 Setting. . . . . . . . . . . . . . . 171
Persistent Naming Support on Windows Server System-Managed Encryption . . . . . . . . 172
2003 and Windows Server 2008 . . . . . . . 169 Device Driver Configuration . . . . . . . 172
Control Path Failover Support for Tape Libraries 170 Configuration File . . . . . . . . . . . 173
Configuring and Unconfiguring Control Path Querying Tape Drive Configuration Settings . . 173
Failover Support . . . . . . . . . . . 170 Problem Determination . . . . . . . . . . 173
Querying Primary and Alternate Path Windows Server 2003 Instructions . . . . . 173
Configuration . . . . . . . . . . . . 170 Reservation Conflict Logging . . . . . . . 175
Checking Disablement of Control Path Failover
Setting. . . . . . . . . . . . . . . 170
This chapter describes the hardware requirements, software requirements, and

installation notes for the Microsoft Windows device drivers for IBM TotalStorage
and System Storage tape devices.
Purpose
The Windows tape and medium changer device driver is designed specifically to
take advantage of the features 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 demount the cartridges), as well as 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 described in this chapter covers the Windows device driver and the
interface between the application and the tape device.
Figure 15 illustrates a typical data flow process.
Windows Tape Host Bus

Application and Medium Tape
Program Adapter Device
Changer Device Driver
a2500268
Driver
Figure 15. Data Flow for Windows Device Driver (IBMmag)

Windows Device Driver
The most current information on supported hardware and software configurations
for the Windows tape and medium changer device driver can be found in the
| README files. The README files are downloaded with the latest driver which
| can be obtained at http://www.ibm.com/support/fixcentral. For further
| information please see Appendix A, “Accessing Documentation and Software
| Online,” on page 317. For a listing of all supported configurations, please visit:
http://www-03.ibm.com/systems/support/storage/config/ssic/
displayesssearchwithoutjs.wss?start_over=yes.
One of more of the following processors is required by the IBMtape device driver:
v For the Windows Server 2003, and Windows Server 2008 operating systems, a
32-bit Intel compatible processor.
v For the Windows Server 2003 and the Windows Server 2008 operating systems, a
64-bit Itanium processor.
v For the Windows Server 2003 and the Windows Server 2008 operating systems, a
processor that supports extended 64-bit architectures (Intel EM64T and AMD64).
One or more of the following SCSI host adapters:

v Adaptec 2940U2W or IBM P/N 33L5000 for IBM System x (also known as
xSeries®) (LVD)
v Adaptec 2944UW (HVD)
v Adaptec SCSI Adapter 29160 or IBM P/N 19K4646 for IBM System x (also
known as xSeries) - Single Port LVD
v Adaptec SCSI Adapter 39160 - Dual Port LVD
v Adaptec SCSI Card 39320-R (LVD) and 39320D-R (dual port LVD)
v Adaptec SCSI Card 29320ALP or IBM P/N 13N2249 (LVD)
v Symbios SYM22910 64-bit PCI-to-Ultra-2 SCSI Dual Channel Host Adapter (LVD)
from LSI Logic Corporation
v IBM Ultra320 SCSI Controller 2 P/N 13N2249 (SCSI LVD)
v IBM Ultra320 SCSI Controller 2 P/N 39R8743 (SCSI LVD)
One or more of the following SAS host bus adapters:

v LSI Logic SAS3800X SAS Adapters
v IBM SAS Host Bus Adapter Controller Part Number 25R8060
One or more of the following Fibre Channel host bus adapters:

v IBM xSeries and Netfinity® FAStT Host Adapter P/N 19K1246
v IBM xSeries and Netfinity FAStT Host Adapter P/N 24P0960
v DS4000® FC 4Gbps PCI-X Single Port HBA P/N 39M5894
v DS4000 FC 4Gbps PCI-X Dual Port HBA P/N 39M5895
v QLogic 4Gb FC Single-Port PCIe HBA P/N 39R6525
v QLogic 4Gb FC Dual-Port PCIe HBA P/N 39R6527
v Qlogic QLA2310
v Qlogic QLA2340
v Qlogic QLA2342
v Qlogic QLA2460

v Qlogic QLA2462
v Qlogic QLE2460 (not supported for Windows 2008 SPI for IA64 servers)
v Qlogic QLE2462 (not supported for Windows 2008 SPI for IA64 servers)
| v Brocade 825
| v Brocade 815
| v Brocade 425
| v Brocade 415
One or more of the following FC-AL host bus adapters:

v Qlogic QLE2460/2 4Gb PCI-E FC HBA, QLA2310FL, QLA2340, QLA2340L,
QLA2342, QLA2342L, QLA2342L, QLA2460, QLA2462 Fibre Channel Adapters
v Emulex LPe11000/2 4Gb PCI-E FC HBA, LP1150, LP8000 and LP9002L,
LP402DC, LP952L, LP9802, LP9802DC, LP10000, LP11000, LP11002 Fibre Channel
Adapters
v IBM Netfinity P/N 00N6881, 19K1246, 24P0960, 39M5894, 39M5895
Attention: Using a single Fibre Channel host bus adapter (HBA) for concurrent
tape and disk operations is not recommended. Tape and disk devices require
been observed. These issues are resolved by separating disk and tape I/O streams
onto separate HBAs and using SAN zoning to minimize contention. IBM is focused
on assuring server and storage configuration interoperability. It strongly
recommends that your implementation plan includes provisions for separating disk
and tape workloads.
The software requirements are supported:
v SCSi or FC adapter device driver
v Microsoft Windows Server 2003 Build 3790 or later
v Microsoft Windows Server 2008 SP1 Build 6001 or later

This section includes instructions for installing and configuring the Windows tape
and medium changer device driver on Windows Server 2003/Windows Server
2008.
Windows Server 2003, and Windows Server 2008 Instructions

This section describes how to install, remove, and uninstall the Windows tape and
medium changer device drivers on Windows Server 2003, and Windows Server
2008.
Installation Overview
The installation process consists of the following steps:
1. Verify that the hardware and software requirements have been met.
2. Install the host bus adapters and drivers.
3. Shut down the system.
4. Connect the tape and medium changer devices to the host bus adapters.
5. Power on the tape and medium changer devices.
Chapter 7. Windows Tape and Medium Changer Device Driver 165

6. Set the tape and medium changer device addresses.

7. Reboot the system.
8. Log on as Administrator.
9. Install and configure the devices and device drivers using the installation
application.
All drives accessible from a medium changer must be on the same physical SCSI
bus as the changer.
Installation Procedures
These procedures make the following assumptions:
v No other driver is installed that claims the tape and medium changer devices.
v If you are updating the device driver from a Microsoft certified version to an
uncertified version, it is recommended that you first uninstall the certified driver
by referring to the uninstall procedures in this documentation.
v The host bus adapter is installed, configured properly, and is running supported
microcode and driver levels.
v Drivers are identified by the following conventions, where: nnnn refers to a
version of the driver. If there is more than one version, use the latest.
– Windows Server 2003, 32-bit
IBMTape.x86_nnnn.zip
– Windows Server 2008, 32-bit
IBMTape.x86_w08_nnnn.zip
– Windows Server 2003 for Itanium (IA64) 64-bit architecture
IBMTape.i64_nnnn.zip
– Windows Server 2008 for Itanium (IA64) 64-bit architecture
IBMTape.i64_w08_nnnn.zip
– Windows Server 2003 for extended 64-bit architectures (Intel EM64T and
AMD64)
IBMTape.x64_nnnn.zip
– Windows Server 2008 for extended 64-bit architectures (Intel EM64T and
AMD64)
IBMTape.x64_w08_nnnn.zip
To install the device drivers, follow this procedure:

| 2. Download and install the appropriate driver. Refer to Appendix A, “Accessing
| Documentation and Software Online,” on page 317 for installation instructions.
3. Unzip the driver package to a hard drive directory of your choice, other than
the root directory.
4. Ensure that the tape and medium changer devices are connected to your host
bus adapter and configured properly by locating the devices in Device
Manager.
5. For driver packages prior to v6.1.8.9, double-click install.exe in the driver
package.
For all subsequent levels, double-click either install_exclusive.exe or
install_nonexclusive.exe.

v With install_exclusive.exe, the driver issues automatic reserves on open

and also prevent multiple open handles from the host to a drive from
existing at the same time, as is required by applications such as Tivoli
Storage Manager.
v With install_nonexclusive.exe, the driver permits open handles from the
host to a drive to exist at the same time, as is required by applications such
as Microsoft Removable Storage Manager (RSM).
The necessary .sys files for correct driver operation are installed, and all IBM
devices are associated with the driver. Refer to Figure 16.
a2500267
Figure 16. Installation Application in Windows Explorer
Notes:
a. There are additional installation features available through the command
line interface (CLI), which include the following:
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 pop-up messages requiring
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
v Disabling DPF from installation (-f), available in driver packages v6.2.0.1
and later
| v Enabling Persistent Reserve from installation if DPF is disabled (-p),
| available in driver packages v6.2.0.6 and later.
To install the device drivers using any of these features, instead of double
clicking the install executable file, open a command-line window and cd to
the driver package directory. For the usage information, type
install_exclusive.exe -h or install_nonexclusive.exe -h at the prompt.

b. If the Windows "Found New Hardware" Wizard begins during installation,

cancel the wizard. The install application performs the necessary steps.
6. If you are installing a driver that has not been certified by the Microsoft
Windows Hardware Quality Laboratories (WHQL), a warning screen opens.
Refer to Figure 17. If you want to continue installing the driver, select Continue
Anyway.
Note: All drivers released by IBM have been through a complete test to ensure
that they are stable and conform to specified requirements.
a250215
Figure 17. Windows Logo Testing screen
7. If you are installing a Windows Server 2008 driver that has not been certified
by the Microsoft Windows Hardware Quality Laboratories (WHQL), it likely
has a Verisign digital signature. During installation, you may be presented with
a prompt to install the software. Mark the "Always trust software from IBM
Corporation" check box and click Install. You should only see this screen the
first time that you install the drivers, provided you click the Always trust
software box.
8. To verify that the tape and medium changer devices and drivers are installed
correctly, follow the instructions in Appendix B, “Verifying Proper Attachment
of Your Devices,” on page 319.
Device Removal or Disable Procedure

If you need to remove a device, or if you are altering the hardware configuration,
you should 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 TotalStorage or Magstar device you wish to uninstall and select
Uninstall .... If you wish to disable the device without uninstalling it, you may
select Disable.
3. You are prompted to confirm the uninstallation. Click OK.

4. In Device Manager, under System devices, right click Changer Bus

Enumerator and select Uninstall.
5. In Device Manager, under System devices, right click Tape Bus Enumerator
and select Uninstall.
Note: This removal procedure removes the device from the device tree, but it does
not uninstall the device driver files from your hard disk.
Uninstalling the Device Drivers

To uninstall the device drivers from the system, which includes deleting the system
files and deallocating other system resources, complete the following:
1. Complete the steps under Device Removal or Disable Procedure to remove the
tape and medium changer devices.
2. Double-click uninst.exe in the driver package.
Note: This removes all the files in the system directories that were created
during the installation of the device driver. It does not delete the .zip file
or the files that were extracted from the .zip file. If you desire to remove
these files, you need to delete them manually.
Persistent Naming Support on Windows Server 2003 and Windows

Server 2008
The Windows tape driver has an option for enabling device object names that
persist across reboots of the operating system. For example, if your tape drive has
the name \.\tape4801101 and the persistent naming option is used, then
\\.\tape4801101 is reserved for use by that device after an operating system
reboot.
Perform the following steps to enable this feature:

1. Add a DWORD value to the registry called PersistentNaming and assign it a
value 1 at:
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtp2kx
2. Reboot your system. On reboot, the system writes information to the registry to
associate the World-Wide Node Name from Inquiry p. 0x83 with the persistent
name used by the operating system.
v If the World-Wide Node Name is unavailable, or if the drive is a virtual (that
is, emulated) drive, then the device serial number is used rather than the
World-Wide Node Name.
v If the PersistentNaming option is not specified in the registry, then there is
no guarantee that your devices can claim the same device name after reboot
or driver initialization.
You can find registry subkeys with persistent naming information at

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtpbs2kx
Alternately, you can use the Windows Device Manager to examine the device
number in order to determine that persistent naming is enabled on your host.
Persistent names contain tape device numbers 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 path discovered claims the
persistent device name, and 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.

To take advantage of Windows Control Path Failover (CPF) support, the
appropriate feature code must be installed. Refer to “Automatic Failover” on page
10 for what feature code may be required for your machine type.
Configuring and Unconfiguring Control Path Failover Support

Control Path Failover support is enabled automatically when the device driver is
| installed by default. It can be disabled from installation using -f CLI option or it
may be disabled or reenabled for the entire set of attached medium changers by
modifying the registry.
1. Open the reg folder of the driver package.
2. Double click DisableCPF.reg or EnableCPF.reg.
3. Reboot the system. This is necessary for any registry modification to take effect.

To check if the control path failover has been enabled in the device driver and
display the primary and alternate paths, you may use the tape diagnostic and
utility tool.
Checking Disablement of Control Path Failover Setting

If you have disabled the control path failover in device driver’s setting by double
clicking the DisableCPF.reg file and reboot your system, you may go into the
registry by issuing the Windows regedit command to confirm that CPF has been
disabled. Look for a line like the following if your system is Windows Server 2003
or Windows Server 2008:
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ibmcg2kx]
"FailoverDisabled"=dword:00000001
This indicates that CPF has been disabled in the driver. This setting only takes
effect after your system is rebooted.
Data Path Failover Support for Tape Drives

To take advantage of Windows Data Path Failover (DPF) support, the appropriate
feature code must be installed. Refer to “Automatic Failover” on page 10 for what
feature code may be required for your machine type.

Configuring and Unconfiguring Data Path Failover Support

Data Path Failover support is enabled automatically when the device driver is
| installed by default. It can be disabled from installation using -f CLI option or it
may be disabled or reenabled for the entire set of attached drives or medium
changers by modifying the registry.
1. Open the reg folder of the driver package.
2. Double click DisableDPF.reg or EnableDPF.reg.
3. Reboot the system. This is necessary for any registry modification to take effect.
For LTO generation 3 or lower, for tape drives that require a data path license key
on the host side to enable DPF, the device driver looks for a file called
%system_root%:\IBM_DPF.txt for the key, where: %system_root% is the drive letter
where Windows has been installed, typically C, (for example, C:\IBM_DPF.txt).
The file should contain 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, and if the file contains a valid DPF
license key, the DPF feature is enabled and any eligible devices have multi-path
support.
Note: For LTO generation 3 running the latest drive microcode, there is no longer
a requirement to provide a DPF license key in IBM_DPF.txt. The microcode
now handles the enablement of the DPF feature.
| Reserve Type if DPF is disabled

| If DPF is disabled SCSI-2 reserve is used by default to handle the reservation on
| tape drives. If Persistent Reserve is desired rather than SCSI-2 reserve
| ReserveTypePersistent.reg will enable it (ReserveTypeRegular.reg will disable it and
| then SCSI-2 reserve will be used) or -p CLI option installation (only if -f was used
| to disable DPF) will enable Persistent Reserve from installation.
| Note: If DPF is not disabled Persistent Reserve will be used.
| Querying Primary and Alternate Path Configuration

To check if the data path failover has been enabled in the device driver and
display the primary and alternate paths you may use the tape diagnostic and
utility tool.
Checking Disablement of Data Path Failover Setting

If you have disabled the data path failover in device driver’s setting by double
clicking the DisableDPF.reg file and reboot your system, you may go into the
registry by issuing the Windows regedit command to confirm that DPF has been
disabled. Look for a line like the following if your system is Windows Server 2003
or Windows Server 2008:
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ibmtp2kx]
"FailoverDisabled"=dword:00000001
This indicates that DPF has been disabled in the driver. This setting only takes
effect after your system is rebooted.

If you have enabled Persistent Reserve on DPF disabled look for a line like this:
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ibmtp2kx]
"ReserveType"=dword:00000001
If you use ReserveTypeRegular.reg then the ReserveType value will be set to 0.

System-managed encryption parameters on Windows are placed in the registry
under the key for the device driver. The parameters are populated in user-created
subkey containing the serial number of the device. The registry keys
(sys_encryption_proxy and sys_encryption_write) are used to determine SME
enablement and invocation of the EKM proxy on write, respectively.
Note: Leading zeros in the serial number should be excluded. For example, if the
serial number of the encryption-capable tape drive were 0123456789, the
user would create the following registry key:
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtp2k3\123456789
Under this key, the user would create DWORD values called sys_encryption_proxy
and/or sys_encryption_write, and assign them values corresponding with the
desired 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\ibmtp2k3
When this option is chosen, the settings 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 should not need to be
changed. A value of 0 causes the device driver to ignore encryption key requests
for system-managed encryption drives, and is not desirable.
v The default value for sys_encryption_write is 2.
This value causes the device driver to leave the encryption write-from-BOP
settings alone. It does not turn on or turn off encryption writing, but instead
uses the settings that are already in the drive. If encryption has not been set up
previously, then the drive writes unencrypted data. A value of 0 causes the
device driver to write unencrypted data. A value of 1 causes the device driver to
write encrypted data.
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.

Windows System-Managed Encryption
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).
The format for the EKM server parameters is:
Server<tab>Timout<tab>IPAddress:Port
For example, if the Windows installation is installed at c:\, the ekm server is
named ekmtest, the desired 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
Querying Tape Drive Configuration Settings

| There is an ITDT command to query the encryption settings of a tape drive. In
| ITDT-SE this can be done by using either the “Standard Edition - Scan Menu
| Commands” on page 247 section or the Tapeutil menu commands using command
| “[35] Query Encryption Status” on page 267.
| In ITDT-GE it can be accomplished by using the Diagnostic/Maintenance tab (see

| “Encryption” on page 298) or by “Query Encryption Status” on page 313 using the
| Tapeutil tab.
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, available from:
http://www.sysinternals.com
Windows Server 2003 Instructions

Using the Debug Version
To install and use the debug version of the device driver, perform the following
steps after the driver has initially been installed:
1. Quiesce all activity on the tape and medium changer.
2. Exit all applications that are using the tape and medium changer devices.
3. Locate the \checked folder for the device driver level that you are running. This
folder is in the highest level directory of the driver package, and it contains
checked versions of the tape and medium changer device drivers,
ibmtpxxyyy.sys and ibmcgxxyyy.sys, where:
v xx = ft for the filter driver, bs for the bus driver, or blank for the base driver,
and
v 2k3 for Windows Server 2003, or 2k8 for Windows Server 2008. Refer to
Figure 18 on page 174.
Note: The last driver level to include support for Windows 2000 is V6.1.4.8.
Subsequent levels include support for Windows Server 2003 and
Windows Server 2008 only, and therefore only contain 2k3 and 2k8

files.
dd000002
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.
6. Start the debugger to capture the DbgPrint messages.
7. Issue the commands to the driver. You should see debug statements printed to
the debugger window.
Windows 2008 Instructions

1. Quiesce all activity on the tape and medium changer.
3. If the driver is currently installed perform the Uninstall the devices procedure
described in a previous section.
4. Locate the \checked folder described at step 3 from the Windows Server 2003
instructions and additionally of the .sys files you will find .inf and .cat files.
This is because Windows 2008 drivers are digitally signed.
5. Copy the files from the \checked folder to the highest level directory of the
driver package overwriting the files in there (a previous backup of this files or
having a copy of the original driver package is recommended).
6. Perform the Installation procedure.
7. Follow steps 6 and 7 from the Windows Server 2003.
Restoring the Non-Debug Version

To restore the non-debug version of the driver, perform the following steps:
1. Quiesce all activity on the tape and medium changer devices.

3. Located in the highest level directory of the driver package, are non-debug
versions of the tape and medium changer device drivers, ibmtpxxyyy.sys and
ibmcgxxyyy.sys, where:
v xx = ft for the filter driver, bs for the bus driver, or blank for the base driver,
and
v yyy = 2k for Windows 2000, or 2k3 for Windows Server 2003, or 2k8 for
Windows Server 2008. Refer to Figure 18 on page 174.
Note: The last driver level to include support for Windows 2000 is V6.1.4.8.
Subsequent levels include support for Windows Server 2003 and
Windows Server 2008 only, and only contain 2k3 files.
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. Reboot the system. When the driver has started and commands are issued to it,
the driver no longer produces debug output.
Note: For Windows Server 2008 is necessary to Uninstall the devices and then
Install the non-debug version of the driver.

device has been opened it will log a reservation conflict in the Windows eventlog.
Prior to logging the error the device driver will issue a Persistent Reserve In
command to determine if a SCSI Persistent Reservation is active on the reserving
host to get the reserving host initiator WWPN (World Wide Port Name). If
successful, the device driver will log this information as follows:
Reserving host key: kkkkkkkk WWPN: xxxxxxxx
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 will not be logged to prevent multiple
entries in the error log until either the reserving host WWPN is different than the
one initially logged or the device driver has reserved the device and then another

Chapter 8. 3494 Enterprise Tape Library Support
Purpose . . . . . . . . . . . . . . . 177 Special Files . . . . . . . . . . . . . 203
MTLIB Program . . . . . . . . . . . . 178 3494 Enterprise Tape Library Attachment Test 203
Syntax and Examples. . . . . . . . . . 178 Problem Determination . . . . . . . . . 203
MTEVENT Program . . . . . . . . . . . 189 HP-UX . . . . . . . . . . . . . . . 205
Library Driver Information . . . . . . . . . 189 Data Flow . . . . . . . . . . . . . 205
Software Interface . . . . . . . . . . . 189 Product Requirements . . . . . . . . . 206
Library Manager Event Notification . . . . . 189 Installation Instructions . . . . . . . . . 207
Synchronous and Asynchronous Operations . . 190 3494 Enterprise Tape Library Attachment Test 210
Operation Complete Notification . . . . . . 190 Problem Determination . . . . . . . . . 211
Unsolicited Notification . . . . . . . . . 190 Linux . . . . . . . . . . . . . . . . 212
Driver Message Queue . . . . . . . . . 190 Data Flow . . . . . . . . . . . . . 212
Volume Categories . . . . . . . . . . 190 Product Requirements . . . . . . . . . 213
IBM TotalStorage Virtual Tape Server Subsystem Installation and Configuration Instructions . . 214
Attachment . . . . . . . . . . . . . 191 3494 Enterprise Tape Library Attachment Test 217
3494 Library Emulation . . . . . . . . . . 193 Problem Determination . . . . . . . . . 217
Overview. . . . . . . . . . . . . . 193 Solaris . . . . . . . . . . . . . . . . 218
3494 Emulation Design . . . . . . . . . 193 Data Flow . . . . . . . . . . . . . 218
Using the 3494 API Emulation and MTLIB Product Requirements . . . . . . . . . 219
Program . . . . . . . . . . . . . . 194 Installation Instructions . . . . . . . . . 220
SMC Library Names . . . . . . . . . . 194 3494 Enterprise Tape Library Attachment Test 223
Volume Categories . . . . . . . . . . 194 Problem Determination . . . . . . . . . 223
Asynchronous Library Operations . . . . . 195 Windows . . . . . . . . . . . . . . . 224
Performance Considerations . . . . . . . 195 Data Flow . . . . . . . . . . . . . 224
AIX . . . . . . . . . . . . . . . . 196 Product Requirements . . . . . . . . . 225
Data Flow . . . . . . . . . . . . . 196 Installation Instructions . . . . . . . . . 226
Product Requirements . . . . . . . . . 196 3494 Enterprise Tape Library Attachment Test 230
Installation Instructions . . . . . . . . . 197 Problem Determination . . . . . . . . . 230
Purpose
The IBM 3494 Library device driver is a device driver providing attachment for the
IBM TotalStorage 3494 Enterprise Automated Tape Library and IBM TotalStorage
Virtual Tape Server (VTS) to a server. The programs 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 Sun/Solaris
v Microsoft Windows NT®
v Microsoft Windows 2000
v Tru64
v SGI/IRIX

3494 Enterprise Tape Library Support
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 189.
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 TotalStorage 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 appended with a slash (/). 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
and correspond to the order in which they were configured in the Tape Library.
The -D flag, in conjunction with the -E flags, can be used to display the attached
VTS devices and the number of the VTS library.
Syntax and Examples

Figure 19 shows the syntax for the mtlib program .
Figure 19. Syntax Diagram for mtlib program

The mtlib program has the following flags:

Flag Description
-f[filename] Device special file for the drive, for example, /dev/rmt0 (AIX),
/dev/rmt/0st (Sun), /dev/rmt/0m (HP), /dev/IBMtape0 (Linux),
\\.\tape0 (Windows)
-x[number] Device number of the drive, for example, 518350
-l[filename] On AIX, library special file name, for example, /dev/lmcp0,
/dev/lmcp0/vts1. For non-AIX, the logical name of the library, for
example, libmgrc7.
-q[type] Query the library information option:
Type Description
V Volume data
L Library data
S Statistical data
I Inventory data
C Category inventory data
D Device data
E Expanded volume data
K Inventory volume count data
R Reserved category list
A Category attribute list
M All mounted volumes
-D Return an array of devices configured in the specified library
-E Return (if used with the -D option) an array of expanded
information for all devices configured in the specified library,
including the control unit ID, device, and VTS library number
-m Mount option
-d Demount option
-c[requestid] Cancel the pending request option
-n No wait mode
-i[requestid] Query the request ID status option
-C Change the category of a volume
-a Audit the specified volume
-k[flags] Assign a category (with one of the following flags) to a device in
the library:
Type Description
O Enable the category order
C Clear the cartridge loader
G Generate the first mount
A Enable the auto mount
Chapter 8. 3494 Enterprise Tape Library Support 179

X Remove the device category assignment
Note: Valid combinations are OG, OA, GA, and OGA.

-r Reserve the category
-R Release the category
-S Set the category attribute
Note: The categories must be reserved before using this option.

-s[category] Source or starting category
-t[category] Target category
-V[volser] Volume serial number
-L[list] Filename containing a list of the volume serial numbers. Each
Volume Serial should be entered as one per line in the file.
-N[name] Category name to assign to the category (valid characters are
uppercase A-Z, 0-9, -, *, or blank).
-h[hostid] Host ID for the reserve or release category or the R/A option for
the query command.
-u Include usage date in the expanded volume data (used in
conjunction with the -qE option). The default is the ISO format
with a period separator. The format can be specified with the -F
option.
-F[flags] Format or separator for volume usage and date with the -u option:
Type Description
I ISO/Japan yyyy.mm.dd
E Europe dd.mm.yyyy
U U.S.A. mm.dd.yyyy
p Period separator mm.dd.yyyy
d Dash separator mm-dd-yyyy
s Slash separator mm/dd/yyyy
-v Verbose
-#[num_categories]
Number of categories to reserve
-A Query library addresses and status.
-? Help text
Note: The -l argument is required.

The report in Figure 20 was produced by:

mtlib -l /dev/lmcp0 -f /dev/rmt5 -qD (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -f /dev/rmt5 -qD (for AIX VTS library 1)
mtlib -1 libmgrc7 -f /dev/rmt/5st -qD (for Sun)
mtlib -1 libmgrc7 -f /dev/rmt/5m -qD (for HP)
mtlib -1 libmgrc7 -f /dev/IBMtape5 -qD (for Linux)
mtlib -l libmgrc7 -f \\.\tape0 -qD (for Windows)
Device Data:
mounted volser............TAF500
mounted category..........FF00
device category...........0000
device state..............Device installed in Library.
Device available to Library.
Volume is loaded.
ACL is installed.
device class..............3590-B1A
extended device status....00
Figure 20. Device Query

mtlib -l /dev/lmcp0 -qV -VCS2000 (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qV -VCS2000 (for AIX VTS library 1)
mtlib -l libmgrc7 -qV -VCS2000 (for Sun, HP, Linux, SGI, Tru64, and Windows)
Volume Data:
volume state.........00
logical volume.......No
volume class.........3590 1/2 inch cartridge tape
volume type..........HPCT 320m nominal length
volser...............CS2000
category.............FE00
subsystem affinity...04 03 05 06 01 02 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
Figure 21. Volume Query


mtlib -l /dev/lmcp0 -qE -VCS2000 (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qE -VCS2000 (for AIX VTS library 1)
mtlib -l libmgrc7 -qE -VCS2000 (for Sun, HP, Linux, SGI, Tru64, and Windows)
Expanded Volume Data:

volume status........00
logical volume.......No
volume class.........3590 1/2 inch cartridge tape
volume type..........HPCT 320m nominal length
volser...............CS2000
device category......FF00
Figure 22. Expanded Volume Query

mtlib -l /dev/lmcp0 -qE -u -VCS2000 (for AIX physical library)
mtlib -1 libmgrc7 -qE -u -VCS2000 (for Sun, HP, Linux, SGI, Tru64, and Windows)
Expanded Volume Data with Usage:

volume status............00
logical volume...........No
volume class.............3590 1/2 inch cartridge tape
volume type..............HPCT 320m nominal length
volser...................CS2000
device category..........FF00
last used (yyyy.mm.dd)...2001.08.26
Figure 23. Expanded Volume Data with Usage

mtlib -l /dev/lmcp0 -qK -v (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qK -v (for AIX VTS library 1)
mtlib -l libmgrc7 -qK -v (for Sun, HP, Linux, SGI, Tru64, and Windows)
Performing Query Inventory Volume Count Data using /dev/lmcp0

Inventory Volume Count Data:
sequence number......12345
number of volumes....207
category.............0000
Figure 24. Inventory Count Data

mtlib -l /dev/lmcp0 -D (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -D (for AIX VTS library 1)
mtlib -l libmgrc7 -D (for Sun, HP, Linux, SGI, Tru64, and Windows)
Refer to also the tapeutil subcommand mtdevice.

0, 00515820 003490C2A00
1, 00515821 003490C2A01
Figure 25. Tape Library Device Number

mtlib -l /dev/lmcp0 -DE (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -DE (for AIX VTS library 1)
mtlib -1 libmgrc7 -DE (for Sun, HP, Linux, SGI, Tru64, and Windows)
Refer to also the tapeutil subcommand mtdevice.
Type Mod Serial # Devnum Cuid Device VTS Library

003590 B1A 13-10800 00108000 1 0
003590 B1A 13-10800 00108001 1 1
003590 B18 13-01817 00018170 2 0 1
003590 B18 13-01817 00018171 2 1 1
003590 B18 13-01817 00018172 2 2 1
003590 B18 13-01817 00018175 2 3 1
003490 C2A 13-01817 00FF0100 3 0 1
003490 C2A 13-01817 00FF0101 3 1 1
003490 C2A 13-01817 00FF0110 3 2 1
003490 C2A 13-01817 00FF0111 3 3 1
003490 C2A 13-01817 00FF0120 3 4 1
003490 C2A 13-01817 00FF0121 3 5 1
003490 C2A 13-01817 00FF0130 3 6 1
003490 C2A 13-01817 00FF0131 3 7 1
Figure 26. Expanded Tape Library Device List


mtlib -l /dev/lmcp0 -qL (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qL (for AIX VTS library 1)
mtlib -l libmgrc7 -qL (for Sun, HP, Linux, SGI, Tru64, and Windows)
Library Data:
Operational state..........Paused Operational State
Intervention Required
functional state...........00
input stations.............1
output stations............1
input/output status........All input stations empty
All output stations empty
machine type...............3494
sequence number............10491
number of cells............1056
available cells............1014
subsystems.................6
convenience capacity.......30
accessor config............01
accessor status............Accessor available
Gripper 1 available
Gripper 2 installed
Vision system operational
comp avail status..........Primary library manager installed.
Primary library manager available.
Secondary library manager installed.
Secondary library manager available.
Primary hard drive installed.
Primary hard drive available.
Secondary hard drive installed.
Secondary hard drive available.
Convenience input station installed.
Convenience input station available.
Convenience output station installed.
Convenience output station available.
library facilities.........00
bulk input capacity........0
bulk input empty cells.....0
bulk output capacity.......0
bulk output empty cells....0
avail 3490 cleaner cycles..0
avail 3590 cleaner cycles..91
Figure 27. Library Data


mtlib -l /dev/lmcp0 -qS (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qS (for AIX VTS library 1)
mtlib -l libmgrc7 -qS (for Sun, HP, Linux, SGI, Tru64, and Windows)
Statistical Data:
hour index...........10
machine type.........003494
model number.........L10
manufacturer.........IBM
plant................13
drives...............6
mounted drives.......1
max mounted drives...2
min mounted drives...1
avg mounted drives...1
max mounted time.....22
min mounted time.....16
avg mounted time.....19
pending mounts.......0
max pending mounts...2
min pending mounts...0
avg pending mounts...0
mounts/hour..........18
index mounts/hour....0
pre-mounts/hour......0
max mount time.......27
min mount time.......16
avg mount time.......19
pending demounts.....0
max pending demounts.2
min pending demounts.0
avg pending demounts.0
demounts/hour........16
index demounts/hour..0
post-demounts/hour...0
max demount time.....28
min demount time.....19
avg demount time.....24
pending ejects.......0
max pending ejects...0
min pending ejects...0
avg pending ejects...0
ejects/hour..........0
max eject time.......0
min eject time.......0
avg eject time.......0
pending audits.......0
max pending audits...0
min pending audits...0
avg pending audits...0
audits/hour..........0
max audit time.......0
min audit time.......0
avg audit time.......0
input stores/hour....0
Figure 28. Statistical Data


mtlib -l /dev/lmcp0 -qI-v (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qI -v (for AIX VTS library 1)
mtlib -l libmgrc7 -qI -v (for Sun, HP, Linux, SGI, Tru64, and Windows)
Performing Query Inventory Data using /dev/lmcp0

Inventory Data:
inventory records
record 1......category............012C
volser..............008273
volume state........00
logical volume......No
volume class........3590 1/2 inch cartridge tape
volume type.........HPCT 320m nominal length
record 2......category value......FF00
volser..............064435
volser..............ALTML1
•
•
•
record 42......category............FF00
volser..............TST039
record 43......category............FF00
volser..............TST182
volume state........Volume present in Library,
but Inaccessible
volser..............XYZ464
Note: All available records are produced as output per request.

Fewer records are shown here for the sake of brevity.
Figure 29. Inventory Query


mtlib -l /dev/lmcp0 -qC -sFF00 -v (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qC -sFF00 -v (for AIX VTS library 1)
mtlib -l libmgrc7 -qC -sFF00 -v (for Sun, HP, Linux, SGI, Tru64, and Windows)
Performing Query Category Inventory Data using /dev/lmcp0

Inventory by Category Data:
category.............FF00
inventory records
record 1......category ...........FF00
volser..............CS2017
volser..............FVT896
volser..............IHG319
•
•
•
volser..............SLT500
volser..............TAF195
volser..............MOO801
Note: All available records are produced as output per request.

Fewer records are shown here for the sake of brevity.
Figure 30. Category Inventory Query


mtlib -l /dev/lmcp0 -r -#2 -h roadster (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -r -#2 -h roadster (for AIX VTS library 1)
mtlib -l libmgrc7 -r -#2 -h roadster (for Sun, HP, Linux, SGI, Tru64, and Windows)
Reserved Category List:

system token...............roadster
total number reserved......0002
category......0101
category......0102
Figure 31. Reserve Category Command

mmtlib -l /dev/lmcp0 -qR -h roadster (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -qR -h roadster (for AIX VTS library 1)
mtlib -l libmgrc7 -qR -h roadster (for Sun, HP, Linux, SGI, Tru64, and Windows)
Reserved Category List:

total number reserved......0002
category......0101
category......0102
Figure 32. Reserve Category List

mtlib -l /dev/lmcp0 -S -S101 -NSCRATCH (for AIX physical library)
mtlib -l /dev/lmcp0 -S -S102 -NWORKING (for AIX physical library)
mtlib -l /dev/lmcp0 -qA -h roadster (for AIX physical library)
mtlib -l /dev/lmcp0/vts1 -S -S101 -NSCRATCH (for AIX VTS library 1)
mtlib -l /dev/lmcp0/vts1 -S -S102 -NWORKING (for AIX VTS library 1)
mtlib -l /dev/lmcp0/vts1 -qA -h roadster (for AIX VTS library 1)
mtlib -l libmgrc7 -S -S101 -NSCRATCH (for Sun, HP, Linux, SGI, Tru64, and Windows)
mtlib -l libmgrc7 -S -S102 -NWORKING (for Sun, HP, Linux, SGI, Tru64, and Windows)
mtlib -l libmgrc7 -qA -h roadster (for Sun, HP, Linux, SGI, Tru64, and Windows)
Category Attribute List:

category 0101 –– name: SCRATCH
category 0102 –– name: WORKING
Figure 33. Category Attribute List


mtlib -l /dev/lmcp0 -A (for AIX physical library)
mtlib -l tire -A (for Sun, HP, Linux, SGI, Tru64, and Windows)
Library Address Information:

library name...............tire
host identification........roadster
primary address............9.115.45.52
primary status.............Online
alternate address..........9.115.45.51
alternate status...........Offline
Figure 34. Library Address Information
MTEVENT Program
The mtevent program is a command-line interface to the MTIOCLEW command.
The mtevent program has the following flags:

Flag Description
-l[filename] Library special file name or logical name of the library, for
example, /dev/lmcp0, /dev/lmcp0/vts1, or libmgrc7
-t[timeout] Number of seconds to wait for the event to occur
(0=no timeout)
Notes:
1. The -l flag is required.
2. If the -t flag is not supplied, then no timeout is performed.
Library Driver Information

The lmcpd communicates to the tape library through symbolic names defined in the
/etc/ibmatl.conf file. One or more symbolic names can be configured for each tape
library online to the system. A symbolic name is used to perform the various
library functions (such as mounting and demounting volumes).
Software Interface
The C object module provides three subroutines for communicating with the IBM
TotalStorage 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 (as 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.
Library Manager Event Notification

In addition to performing library operations, the lmcpd is responsible for receiving
the various Library Manager notifications. The daemon monitors several types of
events. When the daemon receives an event, it checks a list of processes waiting
for an event to determine where to deliver it. If no process is waiting for the event

3494 Enterprise Tape Library Driver
that has arrived, then the event is discarded. The applications can use the Library
Event Wait call to request notification of all Library Manager events. Refer to the
IBM Tape Device Drivers: Programming Reference for more information.
Synchronous and Asynchronous Operations

Two types of library operations are supported: synchronous and asynchronous.
The Library Manager responds to the synchronous operation immediately. These
operations are completed when the library responds to the request. An example of
a synchronous operation is the Library Query call. An asynchronous operation
(such as a mount operation) takes longer to complete. In an asynchronous
operation, the library returns an initial response when the command is accepted
for execution. When the command is completed, it returns a delayed response
message indicating the status of the operation.
Operation Complete Notification

When the Mount, Demount, Audit, or Set Volume category operation is sent to the
library, a message identifier is assigned to the operation. This identifier is returned
to lmcpd. When the operation is completed, an operation complete notification is
sent to the daemon. The daemon makes a determination (based on the initial
message identifier) as to which user process to notify that the operation is
complete. The Mount, Demount, Audit, or Set Volume category operations have an
option that allows the user process to wait or not wait for the operation complete
message. If the user process does not wait for the final complete, the initial
message identifier is returned to the caller, and it can be used in subsequent
Library Query Message ID operations to solicit the status of the asynchronous
operation.
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 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 received by the lmcpd.
Driver Message Queue

The driver maintains a message queue for any process that has an open LMCP file
descriptor. This queue, which has a depth of four entries, is implemented on a
first-in, first-out basis. The purpose of this message is to reduce the possibility of
missing a message when several messages occur in a short period of time. All
queue entries are discarded when the LMCP file descriptor is closed. When an
application issues the MTIOCLEW input/output control (ioctl) call, the driver
returns the oldest entry from the message queue and deletes it. If no entries are in
the queue, then the calling process is put to sleep until a message is received.
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 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 associated with the category to be mounted as determined by the
flags of the command on the specified device.
A category is a four digit hexadecimal number in the X'0000'–X'FFFF' range. The

assigned categories are:
X'0000' NULL category (not usable or not assigned)
X'0001'–X'FEFF' General programming use
X'FFFF' VOLSER specific
The X'FF00'–X'FFFE' categories are reserved for hardware functions:

X'FF00' Insert
X'FF01'–X'FF0F' Reserved
X'FF10' Eject
X'FF11' Bulk eject
X'FF12'–X'FFF8' Reserved
X'FFF9' Service volume
X'FFFA' Manually ejected
X'FFFB' Purge volume
X'FFFE' Cleaner volume
The following three categories are available for programming use:

Insert When a tape volume is received in the input station, the volume
label is read and assigned to this category. This category cannot be
assigned by a user process.
Eject The volumes assigned to this category are moved from their cell
into the output station. After the volume is delivered, it is removed
from the inventory. The Library Set Volume Category command is
the only command that can change the category of a volume to the
eject category.
Bulk eject The volumes that are assigned to this category are moved from
their current cell to the bulk output area in the 3494 Tape Library.
Refer to the IBM TotalStorage Enterprise Automated Tape Library
Operator Guide for more information about the bulk output area.
The Library Set Volume Category command is the only command
that can change the category of a volume to the bulk eject category.
The X'FFFF' category is available for general programming use, except that any
mount request to this category must apply to a specific volume assigned to the
category (and not based on the category alone).
IBM TotalStorage Virtual Tape Server Subsystem Attachment

The device driver supports the IBM TotalStorage Virtual Tape Server (VTS)
subsystem attachment with a 3494 Enterprise Tape Library on AIX, HP-UX,
Windows, and Sun/Solaris systems. An attached VTS subsystem provides virtual
tape drives that are accessible with the VTS SCSI attachment feature. Volumes
within the VTS subsystem are logical tape volumes. A logical tape volume appears

to the host as a normal physical tape volume, except that the VTS logical volumes
are unique to the VTS subsystem and are accessible only by virtual tape drives
within the VTS subsystem.
Access to a VTS subsystem is specified to the device driver as a logical library

within the attached Tape Library as vts1, vts2, and so on. For example, issuing a
Query Inventory command to the 3494 lib returns the physical volumes in the 3494
Tape Library, where: 3494 lib is a library configured in the /etc/ibmat1.conf file.
Issuing a Query Inventory command to 3494 lib/vts1 returns the logical volumes in
the first VTS subsystem attached to the 3494 Enterprise Tape Library.

3494 Library Emulation

The 3494 Library Emulation support provides the ability to use applications that
were written for the 3494 API on host attached SCSI Medium Changer Libraries,
specifically for migration to the 3584 Ultra Scalable Library with 3592 drives.
Overview
Existing customer scripts using the mtlib program and customer or ISV
applications require no or minor changes to use, depending on the 3494 functions
being used. Customer and ISV applications only need to be recompiled with the
new libibm.o object module in order to use the emulation support. The mtlib 3494
user command line interface program that has the same syntax and output on
every operating system and also provides a common utility for SCSI Medium
Changer Libraries. Current operating system device driver utilities vary by
syntax/output, require a knowledge of SCSI Medium Changers to use, and require
multiple commands to perform a single mtlib command.
3494 Emulation Design

The 3494 Emulation support adds a libsmc extension to the current libibm.o object
module that applications compile with for existing 3494 support. The libsmc
extension contains the 3494 API Emulation support, which issues SCSI Medium
changer commands to the library using the operating system SCSI Medium
Changer device driver.
Figure 35 and Figure 36 on page 194 show the 3494/SMC data flow between
existing applications and components and the new libsmc extension.
3494/ SMC Library Data Flow
Tape Device Adapter Library

Driver Device Driver Tape Drive
Application
LIBIBM.O 3494
Object LMCPD TCP/IP
Library Manager
Module
SMC Device Adapter SCSI Medium

a28t1001
LIBSMC
Driver Device Driver Changer
Figure 35. 3494/SMC Library Data Flow

LIBSMC and O/S Components
AIX
libsmc_aix.c Atape Device
libsmc.c Driver
3494 API
Emulation Solaris
libsmc_sun.c IBMtape Device
Driver
SCSI Medium HPUX

Changer libsmc_hp.c atdd Device
Commands Driver
Linux
libsmc_linux.c IBMtape Device
Driver
Windows
a28t1002
libsmc_win.c IBMtape Device
Driver
Figure 36. LIBSMC and OS Components
Using the 3494 API Emulation and MTLIB Program

Refer to the IBM Tape Device Drivers Installation and User's Guide and the IBM Tape
Device Drivers Programmer's Reference for the complete description of 3494 library
support and the mtlib program and syntax.
SMC Library Names

The library name on the open_ibmatl ("libname") or mtlib -l libname parameter
determines whether a 3494 library or an SMC library is being used. If the library
name is a logical operating system SMC library name then the libsmc support is
used. Otherwise, the lmcpd support is used.
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
To issue an mtlib command on Linux to a 3584 library named IBMchanger0:

mtlib -l IBMchanger0 -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.

Because volume categories are not supported, the following API and mtlib
command options cannot be used. Applications and mtlib scripts that use these
functions might require changes.
v Reserve category mtlib -r option
v Release category mtlib -R option
v Change a volume category mtlib -C option
v Set category attribute mtlib -S option
v Assign a category mtlib -k option
v Mount from a category mtlib -m -s option
Asynchronous Library Operations

The 3494 library performs all mount, demount, audit, and eject operations
asynchronously and initially returns a request id to the host for the operation. The
request id can then be queried at any time to determine if the operation is still
pending, completed, or is unknown. SMC libraries perform these operations
synchronously and do not support a request id.
An application can select to wait for an asynchronous operation to complete by

setting the API wait_flg to one or using mtlib without the -n option. The operation
is synchronous on both a 3494 and SMC library and no request id is returned to
the application. These applications and mtlib scripts do not require any changes.
If an application selects to not wait for an asynchronous operation to complete by

setting the API wait_flg to zero or using mtlib with the -n option, the operation on
an SMC library is still synchronous and request id 0 is returned to the application.
Most applications and scripts do not use the return request id to determine when
the operation completes and use the no wait option for performance only. For
example, 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 using
the wait option.
Applications that use the Query Message ID or mtlib -i option to determine when
the return request id operation completes may require changes, such as polling for
a mount issued with the no wait option since any request id is always unknown
on an SMC library because the operation has already completed.
The performance time of mtlib commands issued to a SCSI 3584 library versus a
3494 vary and some performance times may be significantly higher. The mtlib
commands such as -qV and -qI for example 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.

AIX 3494 Enterprise Tape Library Driver
AIX
The software consists of an Automated Tape Library Device Driver (atldd), an
application daemon (lmcpd) that communicates with the 3494 Library Manager
(LM), and a utility program (mtlib), which provides a command-line interface to
the library. Either an Ethernet or Token-Ring LAN or an RS-232 serial connection
can be used for the physical connection between the host and the 3494 LM.
The daemon, known to AIX specifically as the IBM Library Manager Control Point
Daemon (lmcpd), communicates with tape libraries 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 198. 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 providing 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 more
information refer to Figure 37.
Figure 37. Data Flow for AIX 3494 Enterprise Tape Library Driver
The following hardware and software components are supported by IBM.

The library driver supports the following hardware:
v One of the following options, depending on the connection (RS-232 or LAN)
required for the Library Manager:
– RS-232:
One standard 25 pin null modem D-shell RS-232 cable
(maximum of 15.24 meters [50 feet])
– LAN:
- Token Ring or Ethernet Adapter support in an RS/6000 or pSeries
workstation attached to the Library Manager
- LAN cabling (as required)
v IBM System Storage TS1120 Tape Drive Model EO5
| v IBM System Storage TS1130 Tape Drive Model E06
| v 3592 Tape Drive Model J1A
The following software is required for the library driver:
| v AIX 5L, Version 5.3, and later releases on IBM POWER-based servers.
v AIX Tape and Medium Changer Device Driver (Atape)
Appendix A, “Accessing Documentation and Software Online,” on page 317
Installation Instructions
Use the standard set of AIX methods to install and configure the LMCP devices.
You must have root authority to perform these operations.
Refer to Appendix A, “Accessing Documentation and Software Online,” on page
317 for information on obtaining the latest versions of the device driver and the
latest documentation.
Enter the following command to list the currently installed version of the 3494
Enterprise Library Driver:
lslpp -l atldd.driver
Connecting the IBM TotalStorage Enterprise Tape Library

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 eight 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.
Note: The cable (RS-232 or LAN) must be in place before the software is installed
to ensure proper initialization of the driver.
Configuring the Serial Port

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
Select the following options:

1. TTY Menu: Add a tty device.
2. Selection Menu: Select the appropriate parent serial adapter.
3. Add TTY Menu: Enter the port number.
Press F4 to generate a list of possible values.
4. Add TTY Menu: Set baud rate to 9600.
5. Add TTY Menu: eight data bits, one stop bit, no parity.
6. Add TTY Menu: Set Enable program to Off.
Press F4 to generate a list of possible values.
7. Add TTY Menu: Set Enable LOGIN to disable.
Use the Tab key to toggle the value.
8. Press the Return key to configure the tty device.
Repeat steps 1 through 8 for each tape library connected to the workstation.
Configuring the IBM 3490E or TotalStorage 3590 Tape Drive

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 199 for
instructions.
Defining Tape Libraries to the Daemon

After the software is installed and the desired 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 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
installed, the second IP address of the dual LAN card should 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 eight 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.
Alternate LAN Connection is used to specify an alternate IP address for a 3494 High
Availability LAN attached configuration. If the High Availability Library has a dual
LAN card installed, the second IP address of the dual LAN card should be entered
after the first alternate LAN connection IP address.

Note: For RS-232 attachments, the alternate LAN connection is not applicable.
Failover for RS-232 connections proceeds over the single serial line.
The following examples show how to define the library name:

libmgrc7 /dev/tty0 mercury
This stanza defines the libmgrc7 library 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 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 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
Configuring the Library Manager Control Point

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. Perform 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
Figure 38).

System Management
Move cursor to desired item and press Enter.
Software Installation and Maintenance

Devices
Physical & Logical Storage
Security & Users
Diskless Workstation Management & Installation
Communications Applications and Services
Spooler (Print Jobs)
Performance & Resource Scheduling
System Environments
Processes & Subsystems
Applications
Using SMIT (information only)
F1=Help F2=Refresh F3=Cancel F8=Image

F9=Shell F10=Exit Enter=Do
Figure 38. SMIT Main Menu
2. Select Devices (item 2) from the smit main menu.

Use the up (↑) arrow and down (↓) arrow keys to move the cursor to the
desired item on the menu.
Press Enter or click Do if you are processing smit in a windowed
environment.
3. Select Tape Drive from the Devices menu (refer to Figure 39).
Devices
Configure Devices Added after IPL

Printer/Plotter
TTY
Asynchronous Adapters
PTY
Console
Fixed Disk
CD ROM Drive
Optical Disk Drive
Diskette Drive
Tape Drive
•
•
•
Figure 39. SMIT Devices Menu
The Tape Drive menu is displayed (refer to Figure 40).

Tape Drive
List All Defined Tape Drives

List All Supported Tape Drives
Add a Tape Drive
Change / Show Characteristics of a Tape Drive
Remove a Tape Drive
Configure a Defined Tape Drive
Generate Error Report
Trace a Tape Drive
Figure 40. SMIT Tape Drive Menu
4. Select Add a Tape Drive from the Tape Drive menu (Figure 40). The Tape
Drive Type menu is displayed (refer to Figure 41).
5. Select the Library Manager control point from the Tape Drive Type menu
(refer to Figure 41).
Tape Drive Type
8mm scsi 2.3 GB 8 mm Tape Drive

9trk scsi 1/2 Inch 9 Track Tape Drive
150mb scsi 150 MB 1/4 Inch Tape Drive
ost scsi Other SCSI Tape Drive
drive 3420 3420 Tape Drive
atl library LAN/TTY Library Manager Control Point
Figure 41. Tape Drive Type Menu
The Add an LMCP Logical Device menu is displayed (refer to Figure 42).
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 defined in the
/etc/ibmatl.conf file. Refer to “Defining Tape Libraries to the Daemon” on page
198 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.
Add an LMCP Logical Device
Type or select values in entry fields.

Press Enter AFTER making all desired changes.
[Entry Fields]
Logical Name of LMCP (optional) []
Library Name (F4 to list library names) [libmgrc7] +
Command Timeout in Minutes []
Figure 42. Add an LMCP Logical Device Menu

6. The COMMAND STATUS window opens with the Command: OK status. The
logical name of the Library Manager control point is displayed as Defined
(refer to Figure 43).
COMMAND STATUS
Command: OK stdout: yes stderr: no
Before command completion, additional instructions may appear below.
lmcp0 Defined
Figure 43. LMCP COMMAND STATUS Window
7. Repeat steps 4 through 6 to define any additional Library Manager control

points.
8. Return to the smit Tape Drive menu (refer to Figure 40).
9. Select Configure a Defined Tape Drive from the smit Tape Drive menu. A list
of LMCP devices is displayed (refer to Figure 44).
Tape Drive
rmt0 Available 00-00-0S-50 2.3 GB 8 mm Tape Drive

rmt1 Defined 00-01-01-20 IBM SSD 3490E Tape Drive
lmcp0 Defined LAN/TTY Library Manager Control Point
F1=Help F2=Refresh F3=Cancel

F8=Image F10=Exit Enter=Do
Figure 44. Configure an LMCP Selection List
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 Figure 45).
COMMAND STATUS
Command: OK stdout: yes stderr: no
Before command completion, additional instructions may appear below.
lmcp0 Available
Figure 45. Configure a Defined LMCP COMMAND STATUS Window
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 have completed the configuration of Library Manager control points to
the system.
Loading the Daemon

The lmcpd is loaded during the system initialization. During the initial installation
of the driver, you must load the daemon manually using the following command:

cfgmgr
You can access the 3494 Enterprise Tape Library after the above command is
executed.
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.
Deconfiguring the Library Manager Control Point

In the following examples, replace the letter n with the appropriate number for the
chosen device.
Deconfigure the LMCP device using one of the following procedures:

1. The first method deconfigures the device but leaves the device defined in the
configuration database. It is similar to taking the device offline.
Enter the following command to deconfigure the /dev/lmcpn device but leave it
defined in the device database:
rmdev -l lmcpn
2. The second method takes the device offline and removes the device definition
from the device database.
rmdev -l lmcpn -d
The device driver modules are not unloaded from the kernel until the last tape
device is deconfigured.
Uninstall Procedure
All devices using the atldd driver must be closed and not in use when atldd is
uninstalled or the uninstall fails.
You can uninstall the atldd 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.
3494 Enterprise Tape Library Attachment Test

The following procedure tests the attachment of a 3494 Enterprise Tape Library to
an AIX system. The procedure assumes that your device is defined as /dev/lmcp0.
1. Open an AIX window.
2. Enter mtlib -l /dev/lmcp0-qI
3. Enter mtlib -l /dev/lmcp0 -qL
A set of tools is provided with the device driver to determine if 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 using the smit or the errpt command. The error templates follow the same
form as the default AIX error log entries.
AIX Device Driver Trace Facility

The AIX trace facility is supported for the device driver. The trace event is
identified with a hookword. The hookword used by the device driver is 426. The trace
can be initiated at any time before an operation on a tape device.
Enter the following command to start the trace:

trace -a -j 426
This command starts the trace in the background and collects only the trace events
with the 426 hookword.
Enter the following command to stop the trace:

trcstop
This command stops the trace after the tape operations are performed.
Enter the following command to view the trace:

trcrpt > lmcp.trace.out
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 needed by trcrpt.
Daemon Trace Facility

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: The -a argument takes precedence over the -l argument.

HP-UX 3494 Enterprise Tape Library Driver
HP-UX
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,
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 HP-UX operating system, this is a program that runs unattended in
the background to perform a standard service. Some daemons are triggered
automatically to perform their task, others operate periodically.
This software is known as a driver throughout this document because it provides

the software and interface necessary to drive the 3494 Tape Library. However, the
product does not consist of a device driver in the true sense of the term. That is, it is
not an extension of the operating system kernel, such as a SCSI tape device driver.
A typical environment for the HP-UX Automated Tape Library Driver is an HP

workstation that acts as a data server on a network with SCSI tape devices
providing 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 Enterprise Library Manager. An application links
with the supplied C object module using the interface described in the IBM Tape
Device Drivers: Programming Reference. The subroutines in this module communicate
with the lmcpd to perform the various library operations 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 Symbolic Name to the lmcpd” on page 221 for more
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 47 on page 213 illustrates the data flow.

Tape Device Adapter Physical

Application
C
Object
Module
TCP/IP Library
LMCPD Manager
a250106
Figure 46. Data Flow for HP-UX 3494 Enterprise Tape Library Driver
The following software and hardware are required to use this product.
The following hardware is required for the library driver:
v 3494 Enterprise Tape Library with 3590 drives in HP-UX 11.0, 11i v1 and v2 and
3592 drives in 11.0, 11i v1, v2 and v3.
v IBM Virtualization Engine TS7510 and TS7520 in HP-UX 11.0, 11i v1 and v2
v Enterprise Model B10, B18, and B20 Virtual Tape Server (direct attached only)
v One of the following options depending on which LAN connection is used for
the Enterprise Library Manager:
– Token-Ring Attach:
Enterprise FC 5219 (Token-Ring Adapter)
Token-Ring adapter card for HP workstation
Token-Ring cables (as required)
– Ethernet Attach:
Enterprise FC 5220 (Ethernet Adapter)
Ethernet port or adapter for HP workstation
Ethernet cables (as required)
v HP-UX Version 10.20, 11.0, 11i v1, v2, and v3
v IBM Tape and Medium Changer Device Driver for HP-UX

Software Compatibility
The following optional software is supported by the library driver:
IBM Tivoli Distributed Storage Manager for HP-UX
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 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 installing the IBM Tape Library
driver for HP-UX. Install and configure the LAN support before proceeding with
the installation of the lmcpd package. For more information, refer to the HP-UX
documentation appropriate for the LAN support that you are using.
appropriately for installing the lmcpd software.
You must have root authority to perform this installation procedure.
The distribution diskette contains a swinstall process that includes the lmcpd
daemon with other associated files and utilities.
Command Sequence Information

Please take note of the following facts about the command sequences described in
this section:
v In some of the examples, filenames given on the command line must be
v All the SD commands (for example, swinstall, swcopy) can be run initially with
the '-p' flag to preview the command. After observing the preview output, you
can reissue the command without the '-p' flag to perform 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
may produce useful information and error messages, so 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 an earlier version of the product is installed on the machine, execute the
uninstall procedure before you enter the following commands. Refer to
“Uninstall Procedure” on page 223 for more information.
The following files are installed on the system:

v /etc/lmcpd (Library Manager control point daemon)
v /etc/ibmatl.conf (configuration file)
v /usr/lib/libibm.o (32 bit application interface object module)
v /usr/lib/libibm64.o (64 bit application interface object module)
v /usr/lib/libibmz.0 (32 bit application interface object module with +z option)

v /usr/lib/libibm64z.0 (64 bit application interface object module with +Z option)

v /usr/lib/libibm_ia64.0 (64 bit application interface object module with +z option for
Itanium system)
v /usr/lib/libibm_ia64z.0 (64 bit application interface object module with +Z option
for Itanium system)
v /usr/include/sys/mtlibio.h (application interface header file)
v /usr/bin/mtlib (tape library driver utility program)
v /usr/bin/intlib64 (64 bit tape library driver utility program)
v /usr/bin/mtevent (tape library driver utility program)
v /usr/bin/trcatl (tape library driver diagnostic program)
v /opt/lmcpd (subdirectory)
v /opt/lmcpd/ibmatl.conf (backup configuration file)
Note: If this is an update of 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.
Install the Product Manually

Installing the product manually requires two steps, detailed in the following
sections:
1. “Copy the Software to the Software Depot” on page 208
2. “Install the Product” on page 208
Copy the Software to the Software Depot

Attention: If you do not copy the lmcpd software into a depot, you cannot easily
uninstall the software.
Copy the appropriate driver to the Software Depot. For example:
# swcopy -p -s /driver_location/lmcpd.hpux.x.x.x.x lmcpd (preview option)

# swcopy -s /driver_location/lmcpd.hpux.x.x.x.x lmcpd
Use swlist to verify that the lmcpd software is in the depot:
# swlist -d lmcpd
Install the Product

When the software is in the depot, the lmcpd software can be installed to the root
file system using the HP-UX swinstall command.
The following commands install lmcpd from the depot to the default root file
system:
# swinstall -p lmcpd (preview option)

# swinstall lmcpd
Use swlist to list the software 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
Connecting the IBM TotalStorage 3494 Enterprise Automated

Tape Library
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 proper initialization of the daemon. For each 3494 Enterprise Tape Library
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.
Defining the Library Device to LMCPD

After the software is installed and all desired 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 is used to identify each tape library. The symbolic names must be
unique across all libraries 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 installed, the second IP address of the dual LAN
card should be entered after the first IP address.
host machine. This identifier has a maximum length of eight 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.
Alternate LAN Connection is used to specify an alternate IP address for an

Enterprise High Availability LAN configuration. If the High Availability Library
has a dual LAN card installed, the second IP address of the dual LAN card should
be entered after the first alternate LAN connection IP address.

3494a 9.115.32.21 jupiter
This stanza defines the 3494a library 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.
libmgrc9 9.115.46.15 telos 9.115.46.17
This stanza defines the libmgrc9 High Availability library connected through
9.115.46.15 and 9.115.46.17.
libmgrc7 9.115.32.21 9.115.32.22 mercury

libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14
Adding or Deleting Entries in the Library Device

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 kill 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 starting
the lmcpd again.
Uninstall Procedure
Attention: Do not try to uninstall the lmcpd software by deleting the files that
make up the lmcpd fileset. It is best to use the swremove command.
Halt all library activity before starting the uninstall procedure. Kill the lmcpd
daemon if it is currently executing.
To remove the lmcpd software from the root file system enter:
# swremove -p lmcpd
# swremove lmcpd
Other Administrative Tasks

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 installed with the lmcpd software:
# swlist -l file lmcpd
To remove the lmcpd software from the depot:
# swremove -d lmcpd
If more than one level of lmcpd exists in the depot, explicitly specify the level to
# swremove -d lmcpd,r=4.1.8.0

an HP-UX system. The procedure assumes that your device is defined in
/etc/ibmatl.conf as L3494.
1. Bring up a shell prompt.

2. Enter mtlib -l L3494 -qI

3. Enter mtlib -l L3494 -qL
A set of tools is provided with the software to determine if 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 more information about using syslog, refer
to your system administration manuals.

The following trace facility is available for the lmcpd daemon:
trcatl -[ald]
Arguments:
Examples:
trcatl -l libmgrc7

Linux 3494 Enterprise Tape Library Driver
Linux
Manager of the 3494 Enterprise Tape Library through Ethernet or Token Ring LAN,
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 is a program that runs unattended, in
the background, to perform a standard service. Some daemons are triggered
automatically to perform their task; others operate periodically.

the software and interface necessary to drive the 3494 Tape Library. However, the
product does not include a device driver in the true sense of the term. That is, it is
not an extension of the operating system kernel, such as a tape device driver.
A typical environment for the Linux Automated Tape Library Driver is a Linux
workstation that acts as a data server on a network with tape devices providing
backup or restore and data server functions.
communication with the Library Manager. An application links with the supplied
C object module using the interface described in the IBM Tape Device Drivers:
Programming Reference. The subroutines in this module communicate with the lmcpd
to perform the various library operations 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 Symbolic Name to the lmcpd” on page 221 for more
information.
Data Flow


Application
C
Object
Module
TCP/IP Library
LMCPD Manager
a250106
Figure 47. Data Flow for Linux 3494 Enterprise Tape Library Driver
IBM.
v IBM TotalStorage 3494 Enterprise Tape Library with IBM 3590 and 3592 drives
with the Fibre Channel Attachment
v IBM System Storage TS1120 Tape Drive
v IBM Virtualization Engine TS7510
v One of the following options, depending on which LAN connection is used for
the Enterprise Library Manager:
– Token-Ring Attach:
Enterprise FC 5219 (Token-Ring Adapter)
Token-Ring adapter card for Linux workstation
Token-Ring cables (as required)
– Ethernet Attach:
Enterprise FC 5220 (Ethernet Adapter)
Ethernet port or adapter for Linux workstation
Ethernet cables (as required)
The following software is supported by the library driver:
v For Linux distribution support, refer to 93
v IBM Tape and Medium Changer Device Driver (IBMtape) for Linux


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 supporting rpm for rpm
command information. You must have root authority to proceed with the
installation of the driver.
In the subsequent pages, you will see file names with xxxx or x.x.x.x in them. The
xxxx or x.x.x.x refer to the version of the driver, which will change as IBM releases
new driver levels. Use the actual driver version numbers as you perform the
procedures.
Install and configure the LAN support before proceeding with installation of the
ibmatl package. For more information, refer to the Linux documentation
appropriate to the LAN support you are using.
The following files are installed on your system:

/etc/lmcpd (library manager control point daemon)
/etc/ibmatl.conf (configuration file)
/usr/lib/libibm.o (application interface object module)
/usr/lib/libibm64.o (64-bit application interface object module for 64-bit
IBM zSeries system only)
/usr/include/sys/mtlibio.h (application interface header file)
/usr/bin/mtlib (tape library driver utility program)
/usr/bin/mtlib64 (64-bit tape library driver utility program for 64-bit IBM
zSeries system only)
/usr/bin/mtevent (tape library driver utility program)
/usr/bin/trcatl (tape library driver diagnostic program)
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 this is an update of the ibmatl package, the existing /etc/ibmatl.conf file is
preserved (it is not overwritten).
If ibmatl is already installed on your system, refer to “Updating Procedure” on
page 216. This section assumes that you are installing ibmatl on a system where it
is not installed.
Run the following command to install ibmatl rpm package:

>rpm -ivv ibmatl.x.x.x.x.os.rpm
Connecting the TotalStorage Enterprise 3494 Tape Library

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 proper
initialization of the daemon. For each 3494 Tape Library 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.
Defining the Library Device to the lmcpd

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:
unique across all libraries 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
be entered after the first IP address.
Identifier parameter 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.
Alternate LAN Connection is used to specify an alternate IP address for a 3494 High
Availability LAN configuration. If the High Availability Library has a dual LAN
card installed, the second IP address of the dual LAN card should be entered after
the first alternate LAN connection IP address.

3494a 9.115.32.21 jupiter
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
libmgrc9 9.115.46.15 telos 9.115.46.17
This stanza defines the libmgrc9 High Availability library that is connected through
9.115.46.15 and 9.115.46.17.
libmgrc7 9.115.32.21 9.115.32.22 mercury
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.

Adding or Deleting Entries in the Library Device

-kill <pid>) to kill the lmcpd process, and enter the /etc/lmcpd command to start the
daemon again.
Ensure that activity on all libraries is completed before restarting the lmcpd.
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
Querying the Installed Package

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 associated with the package.
To display information about ibmatl:
>rpm -qi ibmatl
To display the package's file list, enter the command:
> rpm -ql ibmatl
To display the states of files in the package, for example, normal, not installed, or
replaced:
>rpm -qs ibmatl
Verifying the Install/Update

If the IBMtape device driver is installed from the rpm package, issue the following
command:
>rpm -V ibmatl
Starting ibmatl
Start the daemon using the following command:
/etc/lmcpd
Uninstall Procedure
Attention: Do not try to uninstall the ibmatl software simply by removing the
files that make up the ibmatl fileset. It is best to use the rpm -e command or the
uninstall script.
Note: Halt all library activity before starting the uninstall procedure.
For the rpm package, run the command rpm -e:
rpm -evv ibmatl

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

a Linux system. The procedure assumes that your device is defined in
2. Enter mtlib -l L3494 -ql
A set of tools is provided with the software to determine if 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

trcatl -[ald]
Arguments:
Examples:
trcatl -l libmgrc7

Solaris 3494 Enterprise Tape Library Driver
Solaris
Manager of the 3494 Tape Library through RS-232 or LAN, 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.

the software and interface necessary to drive the Tape Library. However, the
product does not consist of a device driver in the true sense of the term. That is, it is
not an extension of the operating system kernel, such as a SCSI tape device driver.
A typical environment for the IBM Sun Automated Tape Library Driver is a Sun
workstation that acts as a data server on a network with SCSI tape devices
providing backup or restore and data server functions.
communication with the 3494 Library Manager. An application links with the
supplied C object module using the interface described in the IBM Tape Device
Drivers: Programming Reference. The subroutines in this module communicate with
the lmcpd to perform the various library operations using 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 221 for more information.
Data Flow


Application
C
Object TCP/IP
Module
LMCPD Library
Manager
Native
TTY
a250093
Device
Driver
Figure 48. Data Flow for Solaris 3494 Enterprise Tape Library Driver
The following software and hardware are supported by this product.
The following hardware is supported by the library driver:
v 3494 Enterprise Tape Library with SCSI-attached 3490E (Model C1A or C2A),
3590 and 3592 drives
v IBM TotalStorage Virtual Tape Server (Models B10, B18, and B20)
v One of the following options depending on which connection (RS-232 or LAN)
is required for the Enterprise Library Manager:
– RS-232:
One standard 25 pin null modem D-shell RS-232 cable

(maximum of 15.24 meters [50 feet])
– LAN:
- Token-Ring or Ethernet adapter card in a Sun workstation attached to the
3494 Enterprise Library Manager
- LAN cable

v Sun Microsystems Solaris Version 2.6, 7, 8, 9, or 10
v IBM Tape and Medium Changer Device Driver for Solaris
Software Compatibility
The following optional software is supported by the library driver:
IBM Tivoli Distributed Storage Manager for Solaris
The IBM Tape Library driver for Solaris is installed using the standard Sun package
facility. The IBM Tape Library Driver for Solaris is the lmcpd package.
The LAN or TTY support must exist on the machine before installing the IBM Tape
Library daemon for SunOS. Install and configure the LAN or TTY adapter and the
associated LAN or TTY adapter device driver before proceeding with the
installation of the lmcpd package. For more information, refer to the documentation
appropriate for the LAN or TTY adapter and the LAN or TTY adapter device
driver that you are using.
You must have root authority to perform this installation procedure.
Note: If an earlier version of the product is installed on the machine, execute the
uninstall procedure before you enter the following commands. Refer to
“Uninstall Procedure” on page 223 for more information.
The following files are installed on the system:

/etc/lmcpd (Library Manager control point daemon)
/etc/ibmatl.conf (configuration file)
/usr/lib/libibm.o (application interface object module)
/usr/lib/libibm64.o (64 bit application interface object module)
/usr/include/sys/mtlibio.h (application interface header file)
/usr/bin/mtlib (tape library driver utility program)
/usr/bin/mtevent (tape library driver utility program)
/usr/bin/trcatl (tape library driver diagnostic program)
/opt/lmcpd (subdirectory)
/opt/lmcpd/ibmatl.conf (backup configuration file)
Note: If this is an update of 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,
enter the following command:
/usr/sbin/pkgrm lmcpd
To install the package from the directory that 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
Connecting the 3494 Enterprise Tape Library

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 proper initialization of the daemon.
For each 3494 Tape Library connected with an RS-232 cable, follow the directions
in “Configuring the Serial Port” on page 221. For each 3494 Tape Library 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 hostname of your workstation to the Enterprise Library Manager by

following the instructions in the IBM TotalStorage Enterprise Automated Tape Library
Operator Guide, in the Add LAN Host section.
Configuring the Serial Port

After the 3494 Tape Library is connected to the workstation, you must configure
the serial port to which it is connected.
Set the following TTY port attributes:

Baud rate: 9600
Data bits: 8
Stop bits: 1
Parity: None
Defining the Symbolic Name to the lmcpd

After the software is installed and all of the desired 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:
unique across all libraries 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
installed, the second IP address of the dual LAN card should be entered after the
first IP address.
host machine. This identifier has a maximum length of eight 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.
Alternate LAN Connection is used to specify an alternate IP address for an

Enterprise High Availability LAN-attached configuration. If the High Availability
Library has a dual lan card installed, the second IP address of the dual LAN card
should be entered after the first alternate LAN connection IP address.
Note: For RS-232 attachments, the alternate LAN connection is not applicable.
Failover for RS-232 connections proceeds over the single serial line.

3494a /dev/ttya mercury
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
libmgrc9 9.115.46.15 telos 9.115.46.17
This stanza defines the libmgrc9 High Availability library that is connected through
9.115.46.15 and 9.115.46.17.
libmgrc7 9.115.32.21 9.115.32.22 mercury
libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14
Adding or Deleting Entries in the Library

-kill <pid>) to kill 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 restarting
the lmcpd.

Uninstall Procedure
Halt all library activity before starting the uninstall procedure. Kill the lmcpd
daemon if it is currently executing. Enter the following command to uninstall the
library support from your workstation:
/usr/sbin/pkgrm lmcpd

a Sun Solaris system. The procedure assumes that your device is defined in
A set of tools is provided with the software to determine if 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

trcatl -[ald]
Arguments:
Examples:
trcatl -l libmgrc7

Windows 3494 Enterprise Tape Library Driver
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 that provides a command-line interface to the service, and a static library
and DLL that can be used to provide a communication interface with the service.
A typical environment for the Windows Automated Tape Library Service is a

workstation running Microsoft Windows operating system that acts as a data
server on a network with SCSI tape devices providing backup or restore and data
server functions.
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 may 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 perform 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 228 for
more information.
Data Flow

Figure 49. Data Flow for Windows 3494 Enterprise Tape Library Driver
IBM.
v 3494 Enterprise Tape Library with Enterprise Tape System 3590 and 3592 drives
v IBM TotalStorage Virtual Tape Server (Models B10, B18, and B20)
The following options are required for operation of the Enterprise Library
Manager:
v Token-Ring or Ethernet adapter card in an Intel- compatible workstation running
Microsoft Windows and attached to the 3494 Enterprise Tape Library
v LAN cable
v A workstation running Microsoft Windows Server 2003
v A workstation running Microsoft Windows Server 2008
v IBM Windows Tape Device Driver or the ADSM/TSM Device Driver for
Microsoft Windows NT if using ADSM/TSM

The IBM Tape Library service for Microsoft Windows is installed by executing the
install binary, which has the format ibmatl.x.x.x.x.x86.exe for 32-bit Windows 200x
running on x86, ibmatl.x.x.x.x.i64.exe for 64-bit Windows 2003 running on IA64, and
ibmatl.x.x.x.x.x64.exe for 64-bit Windows Server 2003 and Windows Server 2008
running on AMD64 and EM64T.
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 perform the installation of the service and its associated
software:
1. Verify that the prerequisites are satisfied. Refer to “Product Requirements” on
page 225.
2. Ensure that the workstation is on the LAN.
4. If the IBM Automated Tape Library Service is currently installed, ensure that
all programs and services that use the service are stopped, and then remove it
from the system.
5. Ensure that the IBM Automated Tape Library Service is not running.
v On Windows NT, click the Start button, move to Settings, then click
Control Panel. Double-click the Services icon.
v On Windows 2000 and 2003, click the Start button, move to Settings, then
click Control Panel. Double-click the Administrative Tools icon, then
double-click the Services icon.
v On Windows 2008, click the Start button, 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 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 On Windows NT, 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 execute ibmatl driver.
8. You see some windows displayed indicating the image is being unpacked and
read and the InstallShield Wizard is being set up. After these are displayed,
the screen stops on a window entitled Welcome to the IBM Automated Tape
Library Setup Program. Follow the instructions on the window, then select
Next.
9. The Software License Agreement window opens. Read the contents, then
click Yes if you accept the terms. If you do not accept the terms, the
installation script exits.
Windows 3494 Enterprise Library Service
10. The Choose Destination Location window opens. You can accept the default
destination folder by selecting Next >, or you can select Browse... and select
another destination folder by following the prompts in the subsequent dialog.
If you do not select the default destination folder, you must record your
destination folder for future reference. After you select the folder, click Next >.
11. The Setup Complete window opens. You can check the Yes, I want to view
the Read Me file prompt to read the file, then click Finish, or just click
Finish. The Read Me file is stored in the destination file that you indicated in
step 10.
12. After you click Finish, if you did not select to view the Read Me file, the
installation dialog exits. If you chose to view the Read Me, it is displayed.
After you read it, exit the Notepad application. An informational message is
displayed, indicating that the setup is complete. Click OK to exit the
installation dialog.
13. Verify that you can use the ping utility successfully for any Tape Library you
want to access from your workstation.
14. Update the c:\winnt\ibmatl.conf file, if necessary, with entries for each Tape
Library you want to access from your workstation. Refer to “Defining the
Symbolic Name to the Service” on page 228 for details.
15. On Windows NT, start the service by restarting the system or using the
Services option in the Control Panel window.
On Windows 2000 and 2003, start the service using the Services icon, which is
on the Administrative Tools icon in the Control Panel window.
On Windows 2008, start the service using the Services icon, which is on the
Administrative Tools icon.
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.
For example, to allow lmcpd.exe access to the network on Windows

2008 servers, click on the Windows Firewall icon in the Control Panel
window. Next, click on the button to allow a program or an exception,
and then click the Add Program button. Select your browser and then
select lmcpd.exe in /Windows/system32 for an x86 system or
/Windows/SysWOW64 for i64 or x64 systems.
Connecting the 3494 Enterprise Tape Library

Use a LAN connection (either Ethernet or Token-Ring) through TCP/IP to connect
the workstation to the 3494 Enterprise Tape Library. The connection must be in
place before the service is started to ensure proper initialization of the service.
Ensure that your machine has access to the Library Manager on the 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.
Identify the hostname of your workstation to the Enterprise Library Manager by

following the instructions in the IBM TotalStorage Enterprise Automated Tape Library
Operator Guide, in the Add LAN Host section.

Defining the Symbolic Name to the Service

After the software is installed and all of the desired 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 identifies each tape library. The symbolic names must be unique
across all libraries 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 installed, the second IP address of the dual LAN card should 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 eight characters. The host name
of the workstation is usually the best name to use (although it is not necessary).
This parameter only identifies 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
3494b 9.115.32.21 jupiter
The Alternate LAN Connection parameter specifies an alternate IP address for an

Enterprise High Availability LAN configuration. If the High Availability Library
be entered after the first alternate LAN connection IP address.
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
libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14
Adding or Deleting Libraries to the Service

You can add or delete entries in c:\winnt\ibmatl.conf at any time. However,
changes do not take effect until the tape service starts again.
On Windows NT, stop and start the service using the Services option in the
Control Panel window.
On Windows 200x, stop and start the service 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 starting
the service 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 226.
Follow these steps to uninstall the service and its associated software:
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 the
Start button, move to Settings, then click Control Panel.
v On Windows NT, 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 On Windows NT, 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.
8. For Windows NT, click Add/Remove....
For Windows 200x, click Change/Remove.
9. A Confirm File Deletion window opens. Click Yes.
10. After various dialogs run, a Remove Programs from Your Computer window
opens, which indicates the components that were removed successfully. Click
OK to exit the dialog.
11. For Windows NT, click Cancel on the Add/Remove Programs Properties
window.
For Windows 2000 and 2003, close the Add/Remove Programs Properties
window.
For Windows 2008, close the Programs and Features window.


a Windows system. The procedure assumes that your device is defined in
c:\winnt\ibmatl.conf as L3494.
1. Open a Windows command shell window.
A tracing tool is provided with the software to determine if ibmatl is functioning
correctly.

The following trace facility is available for the ibmatl service:
trcatl -h
usage: trcatl [-ald]
[-l <name>] name of library
[-a] all libraries defined in c:\WINNT\ibmatl.conf
[-d] delete all logfiles in c:\WINNT\
Notes:
1. Run trcatl in the window of "Command Prompt"
2. The "-a" parameter takes precedence over the "-l" parameter.
3. The trace.out is located under the directory where the trcalt runs
Examples:
trcatl -l libmgrc7
trcatl -a > trace.out

Chapter 9. IBM Tape Diagnostic Tool (ITDT)
Purpose . . . . . . . . . . . . . . . 232 [23] Forward Space Records . . . . . . . 266
Accessing ITDT . . . . . . . . . . . . 234 [24] Backward Space Records . . . . . . . 266
Supported Systems . . . . . . . . . . . 234 [25] Space to End of Data . . . . . . . . 266
Standard Edition (ITDT-SE). . . . . . . . 234 [26] Read and Write Tests . . . . . . . . 266
Graphical Edition (ITDT-GE) . . . . . . . 235 [27] Read or Write Files . . . . . . . . . 266
Supported Equipment . . . . . . . . . . 235 [28] Erase. . . . . . . . . . . . . . 267
Standard Edition - Installation . . . . . . . . 236 [29] Load Tape . . . . . . . . . . . . 267
Installing ITDT-SE on Windows Operating [30] Unload Tape . . . . . . . . . . . 267
Systems . . . . . . . . . . . . . . 236 [31] Write File Marks . . . . . . . . . . 267
Installing ITDT-SE on i5/OS Operating Systems 236 [32] Synchronize Buffers . . . . . . . . . 267
Installing ITDT-SE on Other Supported [33] Query/Set Parameter . . . . . . . . 267
Operating Systems . . . . . . . . . . 239 [34] Query/Set Tape Position . . . . . . . 267
Standard Edition - Initial Startup . . . . . . . 240 [35] Query Encryption Status . . . . . . . 267
Starting ITDT-SE on Solaris Operating Systems 240 [36] Display Message . . . . . . . . . . 268
Starting ITDT-SE on Windows Operating [37] Report Density Supp (Support) . . . . . 268
Systems . . . . . . . . . . . . . . 242 [38] Test Encryp. Path (Test Encryption Key
Starting ITDT-SE on i5/OS Operating Systems 242 Path/Setup) . . . . . . . . . . . . . 268
Starting ITDT-SE on Other Supported Operating | [39] Config. TCP/IP Port . . . . . . . . 269
Systems . . . . . . . . . . . . . . 243 [50] Element Information . . . . . . . . 269
Standard Edition - Known Issues and Limitations 243 [51] Position to Element . . . . . . . . . 269
AIX Operating Systems . . . . . . . . . 243 [52] Element Inventory . . . . . . . . . 270
HP-UX Operating Systems . . . . . . . . 243 [53] Exchange Medium . . . . . . . . . 270
Linux Operating Systems . . . . . . . . 244 [54] Move Medium . . . . . . . . . . 270
Solaris Operating Systems . . . . . . . . 244 [55] Initialize Element Status . . . . . . . 270
Windows Operating Systems . . . . . . . 245 [56] Prevent/Allow Medium Removal . . . . 270
i5/OS Operating Systems . . . . . . . . 245 [57] Initialize Element Status Range . . . . . 270
All Supported Operating Systems . . . . . 245 [58] Read Device IDs . . . . . . . . . . 270
Standard Edition - Start Menu Commands . . . 246 [59] Read Cartridge Location . . . . . . . 270
Standard Edition - Scan Menu Commands. . . . 247 [70] Dump/Force Dump/Dump . . . . . . 271
Scan . . . . . . . . . . . . . . . 248 [71] Firmware Update . . . . . . . . . 271
Test. . . . . . . . . . . . . . . . 250 Standard Edition - Tapeutil Scripting Commands 271
Dump . . . . . . . . . . . . . . . 252 allow . . . . . . . . . . . . . . . 274
Firmware Update . . . . . . . . . . . 253 devinfo . . . . . . . . . . . . . . 274
Encryption . . . . . . . . . . . . . 256 inquiry . . . . . . . . . . . . . . 274
Full Write . . . . . . . . . . . . . 258 logpage . . . . . . . . . . . . . . 274
Tape Usage . . . . . . . . . . . . . 259 loop . . . . . . . . . . . . . . . 274
Other . . . . . . . . . . . . . . . 260 modepage . . . . . . . . . . . . . 274
System Test . . . . . . . . . . . . . 260 prevent . . . . . . . . . . . . . . 275
Library Self-Test . . . . . . . . . . . 262 print . . . . . . . . . . . . . . . 275
Manual Inspect . . . . . . . . . . . . 262 qrypath . . . . . . . . . . . . . . 275
Return. . . . . . . . . . . . . . . 263 qryversion . . . . . . . . . . . . . 275
Standard Edition - Tapeutil Menu Commands . . 263 release. . . . . . . . . . . . . . . 275
[1] Open a Device . . . . . . . . . . . 264 reqsense . . . . . . . . . . . . . . 276
[2] Close a Device . . . . . . . . . . . 264 reserve . . . . . . . . . . . . . . 276
[3] Inquiry . . . . . . . . . . . . . 264 resetdrive . . . . . . . . . . . . . 276
[4] Test Unit Ready . . . . . . . . . . 264 sleep . . . . . . . . . . . . . . . 276
[5] Reserve Device. . . . . . . . . . . 265 tur . . . . . . . . . . . . . . . . 276
[6] Release Device . . . . . . . . . . . 265 vpd . . . . . . . . . . . . . . . 276
[7] Request Sense . . . . . . . . . . . 265 append . . . . . . . . . . . . . . 277
[8] Log Sense . . . . . . . . . . . . 265 bsf . . . . . . . . . . . . . . . . 277
[9] Mode Sense . . . . . . . . . . . . 265 bsr . . . . . . . . . . . . . . . . 277
[10] Query Driver Ver. (Version) . . . . . . 265 density . . . . . . . . . . . . . . 277
[11] Display All Paths . . . . . . . . . 265 display . . . . . . . . . . . . . . 277
[20] Rewind . . . . . . . . . . . . . 265 erase . . . . . . . . . . . . . . . 278
[21] Forward Space File Marks . . . . . . 265 fsf . . . . . . . . . . . . . . . . 278
[22] Backward Space File Marks . . . . . . 266 fsr . . . . . . . . . . . . . . . . 278

IBM Tape Diagnostic Tool
getparms . . . . . . . . . . . . . . 278 Tape Usage . . . . . . . . . . . . . 301

load . . . . . . . . . . . . . . . 278 System Test . . . . . . . . . . . . . 301
logsense . . . . . . . . . . . . . . 278 Library Diagnostic Self-Test. . . . . . . . 302
qrypos. . . . . . . . . . . . . . . 279 Manual Inspection Record Entry . . . . . . 303
| qrytcpip . . . . . . . . . . . . . . 279 Graphical Edition - Tapeutil Menu Commands . . 303
read . . . . . . . . . . . . . . . 279 Open . . . . . . . . . . . . . . . 307
rewind . . . . . . . . . . . . . . 279 Close . . . . . . . . . . . . . . . 307
rtest . . . . . . . . . . . . . . . 279 Inquiry . . . . . . . . . . . . . . 308
rwtest . . . . . . . . . . . . . . . 280 Test Unit Ready . . . . . . . . . . . 308
seod . . . . . . . . . . . . . . . 280 Reserve Device . . . . . . . . . . . . 308
setparm . . . . . . . . . . . . . . 280 Release Device . . . . . . . . . . . . 308
setpos . . . . . . . . . . . . . . . 281 Request Sense . . . . . . . . . . . . 308
| settcpip . . . . . . . . . . . . . . 281 Log Sense . . . . . . . . . . . . . 308
sync . . . . . . . . . . . . . . . 282 Mode Sense . . . . . . . . . . . . . 308
unload . . . . . . . . . . . . . . 282 Query Driver Version. . . . . . . . . . 308
weof . . . . . . . . . . . . . . . 282 Display All Paths . . . . . . . . . . . 308
write . . . . . . . . . . . . . . . 282 Rewind . . . . . . . . . . . . . . 309
wtest . . . . . . . . . . . . . . . 282 Forward Space Filemarks . . . . . . . . 309
audit . . . . . . . . . . . . . . . 283 Backward Space Filemarks . . . . . . . . 309
cartridgelocation . . . . . . . . . . . 283 Forward Space Records . . . . . . . . . 309
elementinfo . . . . . . . . . . . . . 283 Backward Space Records . . . . . . . . 309
exchange . . . . . . . . . . . . . . 283 Space to End of Data . . . . . . . . . . 309
inventory. . . . . . . . . . . . . . 283 Read and Write Tests . . . . . . . . . . 309
move . . . . . . . . . . . . . . . 284 Read or Write Files . . . . . . . . . . 311
position . . . . . . . . . . . . . . 284 Erase . . . . . . . . . . . . . . . 312
dump . . . . . . . . . . . . . . . 284 Load Tape . . . . . . . . . . . . . 312
ekmtest . . . . . . . . . . . . . . 284 Unload Tape. . . . . . . . . . . . . 312
encryption . . . . . . . . . . . . . 284 Write Filemarks . . . . . . . . . . . 312
ucode . . . . . . . . . . . . . . . 285 Synchronize Buffers . . . . . . . . . . 312
Deprecated Commands . . . . . . . . . 285 Query/Set Parameter . . . . . . . . . . 312
Standard Edition Scripting Commands: Known Query/Set Position . . . . . . . . . . 312
Limitations and Deviations . . . . . . . . 286 Query Encryption Status . . . . . . . . 313
Graphical Edition - Installation . . . . . . . 287 Display Message . . . . . . . . . . . 313
Windows . . . . . . . . . . . . . . 287 Report Density Support . . . . . . . . . 313
Linux . . . . . . . . . . . . . . . 287 Test Encryption Path . . . . . . . . . . 314
Graphical Edition - Known Issues and Limitations 288 Element Information . . . . . . . . . . 314
Linux . . . . . . . . . . . . . . . 288 Position to Element . . . . . . . . . . 314
Windows . . . . . . . . . . . . . . 289 Element Inventory. . . . . . . . . . . 314
All Supported Operating Systems . . . . . 289 Exchange Medium. . . . . . . . . . . 314
Graphical Edition - User Interface Description . . 289 Move Medium . . . . . . . . . . . . 314
Graphical Edition - Scan Menu Commands . . . 292 Initialize Element Status . . . . . . . . . 315
Scan . . . . . . . . . . . . . . . 293 Prevent/Allow Medium Removal . . . . . 315
Test. . . . . . . . . . . . . . . . 294 Initialize Element Status Range . . . . . . 315
Dump . . . . . . . . . . . . . . . 296 Read Device IDs . . . . . . . . . . . 315
Firmware Update . . . . . . . . . . . 297 Read Cartridge Location. . . . . . . . . 315
Encryption . . . . . . . . . . . . . 298 Dump/Force Dump/Dump . . . . . . . 315
Full Write . . . . . . . . . . . . . 299 Firmware Update . . . . . . . . . . . 316
This chapter describes the IBM Tape Diagnostic Tool.
Purpose
The IBM Tape Diagnostic Tool (ITDT) is available in two versions:
v Standard Edition (ITDT-SE) - This is a command line version.
v Graphical Edition (ITDT-GE) - This is a GUI version for the following:
– Microsoft Windows operating systems
– Linux operating systems

Both versions provided the user with a single diagnostic program for tapeutil
applications. Both SE and GE contained tapeutil functionality with SE also
providing scripting capability.
Note: The term tapeutil is a synonym for the tool that was delivered with the
device driver. For example, this tool was named tapeutil on Unix operating
systems; it was named ntutil on Microsoft Windows operating systems.
The available advanced operations provided by the IBM Tape Diagnostic Tool was
performed on Tape Drives and Tape Libraries. By using this functionality, the
customer performed maintenance tasks and ran diagnostic tasks to determine tape
drive issues. This significantly reduced product downtime and increased
productivity.
The IBM Tape Diagnostic Tool is designed to:

v Run quick or extended diagnostics on tape drives
v Invoke tape library self-test operations
v Retrieve dumps from tape drives and libraries
v Perform a firmware update on tape drives or libraries
v Test the performance of the environment by completely writing a cartridge and
measuring performance
v Verify tape drive compression
v Measure system performance
v Retrieve and display cartridge usage information
v Verify the encryption environment
This test is used to verify if data on the cartridge was actually written
encrypted.
v Scan the system to discover all supported tape and library devices.
v Perform a connection test
This test is used to verify that all devices are attached properly
v Perform a sequence of sub-tests to check if the tape device is defective and
output a pass/fail result
Note: When this test is performed, all data on the cartridge is overwritten.
v Perform a full write function
This function writes the entire cartridge, overwriting all previous data with a
selectable block size containing either compressible or incompressible data and
then outputs performance data.
v Perform a system test
Write different block sizes with compressible and incompressible data and then
outputs performance data.
v Perform a tape usage function to retrieve statistical data and error counters
v Perform a manual inspect function for devices not recognized.
The 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
Chapter 9. IBM Tape Diagnostic Tool (ITDT) 233

available with ITDT-SE is identical across all supported operating systems (unless a
particular function is not available on a particular system).
Dedicated device drivers for tapes and libraries may be installed on the target
system and there is usually an application 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 perform
the diagnostics on that device.
Accessing ITDT
| One option to access ITDT is through Appendix A, “Accessing Documentation and
| Software Online,” on page 317. When downloading an IBM driver there is a
| corequisite to download ITDT so that you will have this tool available for your use
| if it is needed.
You can also navigate to the ITDT Web page:

1. Go to the Tape Support page: http://www.ibm.com/systems/support/storage/
tape.
2. Under Product: select your product.
3. On the right side, click Download.
4. In the Tool/Utility section, click Software, then choose the latest version of
ITDT for your product.
Supported Systems
ITDT is supported on the following systems.
Standard Edition (ITDT-SE)

The Standard Edition (ITDT-SE) is supported on the following:
v AIX operating systems (64-bit pSeries/System p)
– AIX 5L 5.3
– AIX 6.1
v HP-UX operating systems
– HP-UX Version 11i v1, v2 and v3 (64-bit PA-Risc and Itanium)
v Linux operating systems
– Linux systems with Kernel 2.6, glibc 2.2.5 and later (32-bit x86)
| – Linux systems with Kernel 2.6, glibc 2.3.2 and later (64-bit x64)
| – Linux systems with Kernel 2.6, glibc 2.3.2 and later (64-bit IA-64)
– Linux systems with Kernel 2.6, glibc 2.2.5 and later (64-bit pSeries/System p)
– Linux systems with Kernel 2.6, glibc 2.3.3 and later (64-bit zSeries/System z)
| v Macintosh OS X
| – Mac OS X 10.5.6 and later (Leopard) (Intel, 32-bit)
| – Mac OS X Server 10.5.6 and later (Intel, 32-bit)
| – Mac OS X 10.6 (Snow Leopard) and later (Intel, 32 and 64-bit)
| – Mac OS X Server 10.6 and later (Intel, 32 and 64-bit)
v Solaris operating systems
| – Solaris Version 9 and 10 (64-bit SPARC and 64-bit x64)
v Windows operating systems

– Microsoft Windows Server 2003, Microsoft Windows Server 2008 (32-bit x86)
– Microsoft Windows Server 2003, Microsoft Windows Server 2008 (64-bit x64)
– Microsoft Windows Server 2003, Microsoft Windows Server 2008 (64-bit i64)
| v i5/OS® V5R3, V5R4 and IBM i 6.1 (iSeries/System i)
Graphical Edition (ITDT-GE)

The Graphical Edition (ITDT-GE) is supported on the following:
v Windows operating systems
– Microsoft Windows Server 2003/2008 (32-bit x86)
– Microsoft Windows Server 2003/2008 (64-bit x64) [with a 32-bit JVM].
v Linux operating systems
– Linux Distributions with Kernel 2.6, glibc 2.2.5 and later (x86)
Supported Equipment
The following equipment is supported for both the Standard Edition (ITDT-SE) and
the Graphical Edition (ITDT-GE):
| v IBM Ultrium 3580 Tape Drive (Generation 3, 4 and 5)
| v IBM Ultrium Tape Drives T800/F, T800V, T1600/F, T3000V/P
| v IBM System Storage 3588/TS1030 model F3A and F3B Tape Drive
| v IBM System Storage 3588/TS1040 model F4A Tape Drive
| v IBM System Storage 3588/TS1050 model F5A Tape Drive
| v IBM System Storage 3580 Half Height/TS2230 and TS2240 Tape Drive Express
| v IBM System Storage TS2250 Tape Drive
| v IBM System Storage TS2340 Tape Drive Express
| v IBM System Storage TS2350 Tape Drive
| v IBM System Storage 3592/TS1120/TS1130 Enterprise Tape System
| v IBM System Storage 3572/TS2900 Tape Library Express
| v IBM System Storage 3573/TS3100 and TS3200 Tape Library Express
| v IBM System Storage 3576/TS3310 Tape Library
The following equipment are supported System x LTO Tape drives. These drives
are not tested by the IBM System Storage Test Lab. They are also not supported by
IBM System Storage support. All queries are to be addressed to IBM System x
support.
v IBM Full High LTO Gen 1, p/n 00N8016, replacement p/n 37L5799
v IBM Full High LTO Gen 2, p/n 59P6744, replacement p/n 71P9141
v IBM Full High LTO Gen 3, p/n 25R0012 and 39M5657, replacement p/n 25R0003
and 23R4808
v IBM Half High LTO Gen 3, p/n 43W8478, replacement p/n 23R7036
v IBM Half High LTO Gen 4, p/n 44E8895, replacement p/n 45E1125
| v IBM Half High LTO Gen 5
v 3600-XXX Library and Autoloader IBM Full High LTO Gen 1, p/n 09N4048*
v 4560-SLX IBM Full High LTO Gen 2, p/n 71P9146*
v 3623-2LX IBM Full High LTO Gen 2

v 3361-4LX IBM Full High LTO Gen 3 SCSI (p/n 42C3942 and 40K2573) and Fibre
(p/n 40K2575)*
v 3362-2LX IBM Full High LTO Gen 3 SCSI (p/n 40K2596) and Fibre (p/n
42D8769)*
Note: *Please refer to Retain tip H195744. External document link:

http://www-947.ibm.com/systems/support/supportsite.wss/
docdisplay?lndocid=MIGR-5081290&brandind=5000008.
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 245 for
product support limitations.
Standard Edition - Installation

This section describes the installation procedures for the Standard Edition of ITDT
in various operating systems.
Attention:
Before using the IBM Tape Diagnostic Tool Standard Edition (ITDT-SE) with the
IBM Tape Device Driver, we recommend upgrading to the latest available IBM
Tape Device Driver level.
The [U] Tapeutil option will only work if the IBM Tape Device Driver is installed.
The -force-generic-dd startup option to bypass the IBM Tape Device Driver has no
effect on the [U] Tapeutil option commands; they will still use the IBM Tape
Device Driver if it is installed.
In a System Managed Encryption setup, the [E] Encryption test will always exit
with NO DRIVER SPECIAL FILE when ITDT-SE is started with -force-generic-dd.
Installing ITDT-SE on Windows Operating Systems

To install ITDT-SE on Windows operating systems, perform the following steps:
Note: ITDT-SE can only be used by a user with Administrator rights.

1. Download itdtinst<version>windows<arch>.exe where <arch> can be:
v AMD64 (64-bit Intel EM64T or AMD servers)
v IA64 (64-bit Itanium server)
v X86 (32-bit Intel-compatible servers)
to a directory of your choice.
2. Execute the following command:
itdtinst<version>windows<arch>.exe
Installing ITDT-SE on i5/OS Operating Systems

ITDT-SE for i5/OS or IBM i will be installed using a graphical installer based on
the InstallAnywhere installation software that needs to be executed on a Microsoft
Windows system and will install the software onto the remote i5/OS system. The
installer will generate installation information on the local Microsoft Windows

system so that the program can be removed from the remote i5/OS system by
running the uninstaller on the local Microsoft Windows system.
To install ITDT-SE on i5/OS operating systems, perform the following steps:
Note: ITDT-SE on i5/OS requires a Microsoft Windows PC with a Java™ runtime

1.4.2 or higher.
1. Start the installer itdtinst<version>I5OS.exe.
2. Read through the welcome and license screens.
a2500246
Figure 50. Welcome/Startup screen
3. Accept the License Agreement, then click the Next button.

a2500247
Figure 51. License screen
4. Enter your i5/OS system hostname or IP address and administrator credentials.

Start the installation by pressing the Install button. Click the Done button
when the installation is complete.
Note: The user name should be QSECOFR.
a2500248
Figure 52. Machine credentials screen

a2500249
Figure 53. Installation progress screen
a2500250
Figure 54. Installation complete screen
Installing ITDT-SE on Other Supported Operating Systems

To install ITDT-SE on other supported operating systems, perform the following
steps:

| Note: ITDT-SE can only be used 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 itdtinst<version><OS> to a directory of your choice.
v itdtinst<version>Aix is for AIX operating systems
v itdtinst<version>LinuxX86 is for Linux operating systems on Intel hardware
v itdtinst<version>LinuxPPC is for Linux operating systems on pSeries
v itdtinst<version>LinuxS390X is for Linux operating systems on zSeries
v itdtinst<version>Hpux is for HP-UX operating systems.
| v itdtinst<version>MacOS is for Mac OS operating systems.
v itdtinst<version>Solaris is for Solaris operating systems.
2. Perform the following command to make itdtinst<version><OS> executable:
chmod 700 itdtinst<version><OS>
| 3. Execute the following command:
| itdtinst<version><OS>
| or
| ./itdtinst<version><OS>
| depending on your operating system.
Standard Edition - Initial Startup

This section describes the startup procedures for the Standard Edition of ITDT in
various operating systems.
Starting ITDT-SE on Solaris Operating Systems

| 1. If the IBM Tape Device Driver is not used, if it is not installed, or you want to
| be able to run -force-generic-dd, then configure the sgen driver.
A script sgen_solaris_conf.sh is included in the ITDT-SE package. This script
allows the user to configure the sgen generic SCSI driver that is shipped with
Sun Solaris.
ITDT-SE requires that the sgen device driver is configured so that the devices
you want to work with can be found.
Note: For system security reasons, always reset the sgen device driver settings
after you finish working with ITDT-SE, 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 displays the screen that is used to
create a new driver configuration (see Step 2 on page 241).
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 target(s): This option adds targets to the list.
Note: Option 3 allows for the addition of individual devices one at a time,
Option 5 allows for the addition of a range of devices, eliminating the
need to add a large number of devices one by one.
v 4) or 6) Remove target(s): This option removes targets from 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 a large number of 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 using the definitions
performed 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 need to be configured with their WWPN in the sgen.conf
file. This task needs to be done manually, it is not performed by using the
sgen_solaris_conf.sh script.
The following is an example how to add those devices:

Run the command "cfgadm -al" to get the WWPN number(s).
......
c4 fc-private connected configured
c4::5005076302401924 tape connected configured
.....
Add the WW-PN number(s) into the sgen.conf file.
name="sgen" parent="fp" target=0 lun=0 fc-port-wwn="5005076302401924";
name="sgen" parent="fp" target=0 lun=1 fc-port-wwn="5005076302401924";
If you have finished the editing, the sgen driver has to be restarted.
Please enter "update_drv sgen".
To start ITDT-SE execute the following command:

./itdt
At first start, read the User License Agreement:

v Press Enter to scroll the license screens forward or b followed by Enter to go
back.
v Type i if you agree to the terms of license or q followed by Enter to quit the
application.
During the initial program startup, the input and output directories are created:
v Input directory: default directory for firmware files during Firmware Update

v Output directory: directory containing the result files, dump files and log files
after running tests
ITDT-SE does not make changes outside the installation directory.
Starting ITDT-SE on Windows Operating Systems

Start ITDT by executing the following command:
itdt.exe

back.
application.
At first program startup, the license text will be displayed and the input and
output directories will be created. ITDT-SE does not create any registry entries or
make changes outside the installation directory.
after running tests
Starting ITDT-SE on i5/OS Operating Systems

To use ITDT-SE to update firmware or pull dumps from a Tape Drive inside a Tape
Library, make sure the drives are varied online in STANDALONE MODE by
performing the following steps:
1. Issue the command WRKMLBSTS. Identify the Library and drives you want
to work with. Note their names (for example, TAPMLB01, TAP01, TAP02, ...
and so on).
2. Deallocate the corresponding drives using option 6.
3. Vary OFF the TAPMLB using option 2.
4. Enter the following command:
WRKCFGSTS *DEV TAP*
Identify the drives which were noted in Step 1, (for example, TAPMLB01,
TAP01, TAP02) and vary them ON using option 1.
5. Launch the iSeries® Q-Shell environment with the following command:
QSH
6. Change to the folder /home/itdt with the following command:
cd /home/itdt
7. Start ITDT with the following command:
./itdt
8. Update Firmware and pull dumps. See “Firmware Update” on page 253 and
“Dump” on page 252.
9. When firmware updates and dumps are complete, enter the following
command:
WRKCFGSTS *DEV TAP*
10. Vary off the TAPs that you worked with using option 2.
11. Issue the command WRKMLBSTS. Identify the Library and Drives you
worked with.
12. Vary on the TAPMLB using option 1.

13. Press F5 to refresh the screen; the TAPs belonging to the TAPMLB should
show up.
14. Allocate the TAPs back to the TAPMLB using option 4 or 5.
Starting ITDT-SE on Other Supported Operating Systems

To start ITDT-SE execute the following command:
./itdt

back.
application.
During the initial program startup, the input and output directories are created:
after running tests
ITDT-SE does not make changes outside the installation directory.
Standard Edition - Known Issues and Limitations

This section describes the known issues and limitations of the ITDT-SE program.
AIX Operating Systems

The following are the known scan limitations:
v Only devices that have the device state "available".
For FC and SAS devices, ID and LUN greater than 999 won't be displayed, they
will be masked by ###.
When logged in via telnet, backspace may not be working - an escape sequence is
inserted and the input is ignored after Enter is pressed.
HP-UX Operating Systems

Verify that the following patches are installed before starting ITDT-SE:
v PA-Risc: At least these patches:
– ld and linker tools cumulative patch
– libc cumulative patch
v Itanium/IA-64: All regular patches and the following patches:
– VxVM 3.5~IA.014 Command Patch
– VxVM 3.5~IA.014 Kernel Cumulative Patch
– Aries cumulative patch
– linker + fdp cumulative patch
Note: ITDT-SE is emulated by Aries (a binary emulator that transparently emulates

32-bit and 64-bit HP-UX PA-RISC applications on HP-UX IA-64 machines).
On HP-UX11.iV3 systems, tape libraries operated through the drive's control path
(no control path failover) may disappear from the Device List after a [F] Firmware

Update on the controlling drive. We recommend to perform repeated [S] Scan

operations to make the library reappear in the device list.
Linux Operating Systems

ITDT-SE on Linux requires glibc 2.2.5 or later.
Note: On a SLES9 s390x (64bit) configuration, you may experience a SCSI CMD
TIMEOUT when running the [T] option while using the IBM Tape Device
Driver.
For SUSE SLES9 on zSeries please ensure that the kernel update SUSE-SA:2007:035
is installed.
Solaris Operating Systems

Rescan may take 6-8 minutes, depending on the numbers of host adapters and
devices attached.
The known scan limitations: SCSI ID 0-255, LUN 0-10
If the IBM Tape Device Driver is not installed on Solaris 10, tape devices may not
be found during scan although they are configured in sgen.conf. When this event
occurs, perform 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
If the tape drive is claimed by st device driver, an entry with cxx:rmt/y, is
displayed, for example:
c11::rmt/0 tape connected configured unknown
4. Add sgen driver aliases with one of the following commands:
# update_drv -a -i ’"scsiclass,01.vIBM.pULT3580-HH4"’ sgen
(adds sgen alias for IBM drive, model ULT3580-HH4)
# update_drv -a -i ’"scsiclass,01"’ sgen

(adds sgen alias for all drives attached to the system)
# update_drv -a -i ’"scsiclass,08.vIBM.pULT3581-TA2"’ sgen

(adds sgen alias for IBM changer, model ULT3581-TA2)
# update_drv -a -i ’"scsiclass,08"’ sgen

(adds sgen alias for all changers attached to the system)
5. Check that the drives and changers are now configured with the following
command:
# cfgadm -al
6. If the drives or changers are not listed in the output of ’cfgadm -al’, reboot
the system and verify the list of configured devices with the command:
# cfgadm -al
Windows Operating Systems

After a firmware update, devices may disappear. This is a known Windows
problem.
See the Article ID: 812024 at:

http://support.microsoft.com/kb/812024/en-us
Repeated Scan operations may help to rediscover the device.
When switching applications on Windows while ITDT-SE is running, an extra ESC

character may appear on the input line, when this occurs, the input is ignored after
pressing the Enter key.
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 shipped with the
Windows operating system.
On Microsoft Windows systems where the maximum transfer size is limited to less
than 64kB, the Dump and Firmware update operations will not work.
i5/OS Operating Systems

ITDT-SE on i5/OS supports only tape drives; it does not support autoloaders and
libraries. Media changers and media changer operations are not supported with
this release of ITDT-SE. To test a tape drive inside a library, the cartridge must be
imported manually before starting the Device Test.
The Tape Drive must be varied online. If the Tape Drive is operated through a
Tape Library, the Library must be varied offline. See “Starting ITDT-SE on i5/OS
Operating Systems” on page 242 for details.
As the Library is varied offline, the Encryption Test does not deliver decrypted
data in a Library Managed Encryption environment.
ITDT-SE on i5/OS V5R4 requires the following PTF installed:
PTF: SI25023 Release: 540 Abstract: OSP-MEDIA-TAPE-THREADS-MSGCEE0200-

T/QTAHRMGR QTARDCAP FAILS
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 attached to
LTO Gen 4 HH tape drives (No support for LTO 3 HH SAS).
All Supported Operating Systems

This section describes the known issues and limitations of the ITDT-SE program on
all other supported operating systems.
Prevent/Allow Medium Removal is missing as a Tape Drive option, but can still
be performed by using the [56] Prevent/Allow Medium Removal option for Tape
Libraries while the tape device is opened.

User Interface Issues

If you press the arrow keys on most Unix operating system consoles, the input is
ignored after pressing the Enter key.
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
additional text as this is interpreted as an entry to a specific row in the field. To
avoid this, use an underscore character ( _ ) instead of the space character.
Command Timeout
There is no instant operation termination upon SCSI command timeout; for
example, when the SCSI cable is unplugged after starting POST A.
When a command timeout condition occurs, ITDT may still continue to perform
more operations (like unmounting the cartridge) instead of instantly terminating
with a timeout condition.
3576/TS3310 Tape Library

Library Firmware Update using ITDT-SE is not supported with the 3576/TS3310.
Update the Firmware using the 3576/TS3310 Web User Interface.
3494 Tape Library

Drives in a 3494 tape library or an STK silo library are supported, only the [T] Test
option won’t work due to device-specific restrictions for handling cartridges.
Standard Edition - Start Menu Commands

After program startup, ITDT-SE displays the start screen menu.
a2500231
Figure 55. Start Screen Menu
The following commands are available on the start screen menu:

v S - Scan for tape drives
Opens the screen for the Scan function (refer to “Standard Edition - Scan Menu
Commands” on page 247).
v U - Tapeutil

Opens the screen for the Tapeutil operation commands. These commands are the
standardized tapeutil functions with most of the options available that were
available with the previous tapeutil functions (refer to “Standard Edition -
Tapeutil Menu Commands” on page 263).
v H - Help
Help starts and displays the available online help.
v Q - Quit
Quits the function.
Standard Edition - Scan Menu Commands

When using ITDT-SE, after entering S on the start screen, the Scan function starts
and displays the first device list screen. This screen contains the S, T, D, F, E, W, U,
and O commands. Entering the O command displays the second device list screen.
The second screen contains the Y, L, I, and R commands.
a2500232
Figure 56. Scan Menu
The following commands are described in this section:

v S - “Scan” on page 248
v T - “Test” on page 250
v D - “Dump” on page 252
v F - “Firmware Update” on page 253
v E - “Encryption” on page 256
v W - “Full Write” on page 258
v U - “Tape Usage” on page 259
v O - “Other” on page 260

a2500233
Figure 57. More Scan Options
v Y - “System Test” on page 260

v L - “Library Self-Test” on page 262
v I - “Manual Inspect” on page 262
v R - “Return” on page 263
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 proper attachment of the devices.
Before continuing, make sure no other program is accessing the devices used by
ITDT-SE. For example, stop the backup jobs that are accessing the devices when
using ITDT-SE, or if not sure, stop the entire backup application.
After starting ITDT-SE, type the S key followed by the Enter key 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 243 for more details.
During the scan operation, a bar in the lower left edge of the screen shows that the
scan operation is still in progress.
Once the scan is finished, the first device list screen is displayed.

Name of
current screen
Selected device
Device number
Command
a2500252
Command prompt
Figure 58. Device List Screen
The first device list screen shows all detected devices and the connection
information (host adapter number, bus number, SCSI/FCP ID and LUN) 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.
Scrollable data is indicated by "VVVVVVVVV" at the bottom of the screen. To

scroll down to access non-displayed entries, type + and press the Enter key.
Note: For fast down scrolling, type + followed by a space and the number of lines
to scroll down then press the Enter key.
To scroll back, use - instead of +.
Note: For fast up (backward) scrolling, type - followed by a space and the number
of lines to scroll up then press the Enter key.
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 will be detected.
v Solaris, when no IBM tape device driver is in use:
– Ensure that sgen is correctly configured:
file /kernel/drv/sgen.conf
is correctly configured (see “Starting ITDT-SE on Solaris Operating Systems”

on page 240).
– Solaris 10, see (see “Standard Edition - Known Issues and Limitations” on
page 243)
v More than 12 devices displayed - scroll down the Device List.

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.
If you need to bypass the IBM Tape Device Driver for diagnostic purposes, start
ITDT-SE with the following command:
itdt -force-generic-dd
| Note: For operating system specific information on how to use this command,
| please visit the corresponding Initial Startup sections.
Once the desired device is displayed, select the device for test. Only one device can
be selected.
Test
| The Test function [T] checks if the tape device is defective and outputs a pass/fail
| result.
Attention: The test functionality erases user data on the cartridge that is used for
the test.
For the library or autoloader test, the [L] library test should be selected.
Notes:
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 perform the test function, it is recommended that a new or rarely used cartridge
is used. Scaled (capacity-reduced) cartridges should not be used to test the device.
To test tape drives within a library, the library must be in online mode.
1. Start ITDT-SE, then type S and press the Enter key to scan for the devices.
Select the device you want to test by entering its number and press the Enter
key.
2. Type T followed by the Enter key to activate the test.
If no cartridge is inserted, ITDT-SE prompts to insert a cartridge. Either insert a

cartridge and press the Enter key or stop the test by entering C followed by the
Enter key.
Note: If ITDT-SE detects data on the cartridge, the Device Test screen displays a
message (as shown in Figure 59 on page 251).

a2500234
Figure 59. Data Delete Question
Type Y followed by the Enter key to continue the test if you are absolutely
sure that data on the cartridge can be overwritten. If you are unsure, type N
followed by the Enter key to stop the test.
During the test, the program shows a progress indicator in form of a bar of hash
marks (#) (1) that shows the progress of a single sub-test as well as a description
of that sub-test. The user may stop the test by selecting the abort option
(exceptions: POST A, POST B – see below).
| During the test, a progress indicator will be shown on the test screen. Messages
| from the test steps will be shown in the status field.
1 2
a2500235
Figure 60. Test Running
The test sequence contains the following steps:

| 1. Mount Medium
| 2. [Medium Qualification] – only if the previous step indicated this requirement
| 3. Load/Write/Unload/Read/Verify
| 4. POST A
| 5. Performance Test (run 2 times if first run failed with performance failure)
| 6. POST B

| 7. Unmount Medium
| 8. Get FSC
| 9. Get Logs
The test can be stopped by typing A followed by the Enter key at any time except
during the POST tests, which are not interruptible.
Note: It may take some time until the test actually stops.
a2500236
Figure 61. Test Results
When all sub-tests are finished, ITDT-SE shows a screen that displays the
attachment and device information as in the first device list screen, together with
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 may be requested by
the IBM Support Center.
If you want to use other ITDT-SE functions, type R followed by the Enter key to
return to the first device list screen; otherwise, type Q followed by the Enter key to
exit the program.
Dump
Perform the following to start the Dump [D] process:
2. Select the device you want to retrieve a dump from by entering its number and
press the Enter key.
3. Type D and press the Enter key to start the dump retrieval for the selected
device. The ongoing dump process is performed (it takes less than 1 minute).

Dump Filenames
Log Filenames
a2500237
Figure 62. Dump
When the dump process is performed on a tape library or autoloader other than
the 3584/TS3500, the Dump function stores one log file in the output folder of the
program (*.blz). For the 3584/TS3500, a dump file (*.a.gz) will be stored in the
output folder.
Note: When the Dump function is performed for tape libraries or autoloaders
other than the 3584/TS3500, the Log file only contains Log Sense and Mode
Sense pages, while a Drive or 3584/TS3500 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 i-Series Navigator to transfer the file
return to the device list; otherwise, type Q followed by the Enter key to exit the
program.
Firmware Update
The Firmware Update [U] upgrades the firmware of tape drives and tape libraries.
See “Supported Equipment” on page 235 for a list of supported products.
Note: See “3576/TS3310 Tape Library” on page 246 for more information on how
to update the firmware on a 3576/TS3310 Tape Library.

a2500251
Figure 63. 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
To do a Firmware Update perform the following steps:

2. Select the device you want to update by typing the number of the device and
pressing the Enter key.
3. Type F and press the Enter key to display the Firmware Update screen.
4. To select the needed firmware update perform one of the following:
v If the firmware file you downloaded is listed in the Content field of the
Firmware Update screen, type the corresponding line number and press the
Enter key.
v If the firmware file is stored in a directory other than the one displayed in
FW Dir, then type F followed by a space and the fully qualified path to the
directory containing the firmware file, then press the Enter key.
For example, enter the following to change the firmware directory (Unix):
f /home/user/firmware
v If no files are displayed in the Content field, check the Dir OK field on the
right side of the screen. It indicates true if the directory exists, false
otherwise.
v If the content of the displayed FW Dir has changed, type D and press the
Enter key to refresh the directory content.

Note: The selected filename is reset to the first item (#0) after using the
Refresh function.
v If the displayed directory contains more files than those shown, type + and
press the Enter key to scroll down the list. For fast down scrolling type +
followed by a space and the number of lines to scroll down then press the
Enter key. To scroll back, use - instead of +.
Scrollable data is indicated by "VVVVVVVVVVVVVVVVV".
a2500253
VVVVV = More data
Figure 64. Scrollable Data screen
5. After selecting the firmware file, type C and press the Enter key to continue.
6. Before starting the firmware update, make sure the file 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 the Enter key to change
the selected firmware file. Go to Step 4 on page 254.
Note: The selected filename is reset to the first item in the list when
returning to that dialog from the Start Update dialog.
7. If you decide to run the firmware update, type S and press the Enter key 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 the Enter key to return to the Device List.
Note: If ITDT-SE detects a FIPS-certified drive firmware, it displays a warning

dialog. Before continuing, ensure that you use a FIPS-certified firmware
to update the drive.
8. After completion, the Status field on the bottom right side indicates PASSED if
the firmware was updated successfully and FAILED otherwise.
Type R and press the Enter key to return to the Device List.

Encryption
The Encryption [E] function is used to verify if data on the cartridge was actually
written encrypted. It reads both decrypted and raw data from the cartridge into
two separate files on disk. The user can then verify that the data differs to ensure
that encryption worked.
The Encryption function does not provide a Write - Read test.
The Encryption function is only supported on encryption enabled drives and

requires an encryption infrastructure including the Encryption Key Manager (EKM)
to be properly set up. An encrypted data cartridge must be used.
The Encryption function is supported for the following encryption environments:

v System Managed: IBM tape device driver must be installed and in use by ITDT
to read decrypted data
v Library Managed
v Application Managed: Only raw encrypted data will be read (result file *.ENC)
Note: On i5/OS, media changers and media changer operations are not supported
with 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 242 for
details). As the Library is varied offline, the Encryption function does not
deliver decrypted data in a Library Managed Encryption environment.
1. After starting ITDT-SE, type S followed by the Enter key to activate the device
scan.
2. Select the device you want to test by entering its number and press the Enter
key. Type E and press the Enter key to start the encryption test.
3. 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 the Enter
key to enter the start record number. Type L followed by a blank and the data
length, then press the Enter key to enter the data length, maximum 100000 KB.

a2500245
Figure 65. Encryption Start screen
5. If you entered the values correctly, press the Enter key to start the encryption.
During the encryption, the program shows a progress indicator in form of a bar
of hash marks (#) that shows the progress of a single sub-test as well as
information about that sub-test.
The Encryption function can be stopped by typing A followed by the Enter key
at any time.
Note: It may take some time until the Encryption function actually stops.
If all encryption operations are finished, ITDT-SE shows a screen that displays the
Status field on the bottom 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
Table 28 defines the abort codes.

Table 28. Definitions of Abort Codes
ABORT CODE ROOT CAUSE
LOCATE FAILED Start position as requested by the user could not be
reached
MEDIUM NOT ENCRYPTED ITDT detected medium as non-encrypted
NO DRIVER SPECIAL FILE System-Managed environment, but generic device file
is used instead of IBM device driver special file
DRIVE ENCRYPTION DISABLED Mode Sense detected disabled drive encryption
UNEXPECTED DATA v Set Raw read mode failed
v One of the commands failed
END OF MEDIUM End of medium encountered before the given amount
of data could be read

Table 28. Definitions of Abort Codes (continued)

ABORT CODE ROOT CAUSE
END OF DATA End of data encountered before the given amount of
data could be read
READ FAILED
ENCRYPTION ERROR
INVALID PARAMETER User entered data length of 0kB
return to the device list; otherwise, type Q followed by the Enter key to exit the
program.
Full Write
The Full Write [F] function writes the entire cartridge with a given 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.
Notes:
1. The Full Write function takes approximately 2 hours when writing
incompressible data, less time for compressible data.
2. The Full Write function runs only on tape drives, not on autoloaders or
libraries.
The Full Write test can be used to:

v Demonstrate that the drive is capable of writing the full amount of data on a
cartridge.
v Identify system issues with compression.
Drive data compression is always switched on during the full write. When run
with compressible data, the output shows the compression rate. If the
compression rate is higher than 1.0 but the system does not appear to be able to
compress data on the cartridge, then check the device driver and software
settings to see if they disable compression.
scan.
2. Select the device you want to write to by entering its number and press the
Enter key. Type W and press the Enter key to start the full write.
ITDT-SE then switches to the Full Write screen. If no cartridge is inserted,
ITDT-SE prompts to insert a cartridge. Either insert a cartridge and press the
Enter key or stop the test by typing C followed by the Enter key.
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 the Enter key to continue the test if you are
absolutely sure that data on the cartridge can be overwritten. If you are
unsure, type N followed by the Enter key to stop the test.

3. The system prompts for entry of a transfer size between 16 KB and the
maximum block size supported by the system (maximum possible value is 512
KB) . This is a check for the type of supported block size is performed. Enter
the appropriate values for your system.
4. 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 hash marks (#) that shows the progress of the full write.
The full write can be stopped by typing A followed by the Enter key at any
time.
Note: It may take some time until the full write actually 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 zeroes, so that the
| data could be compressed by the drive with a maximum compression ratio.
| "Compressible = No" means that a data pattern was written that the drive
| could almost not 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 could be compressed to 1 byte on the
| medium. 100.0 means 100 bytes could be compressed down to 1 byte on the
| medium.
If you want to use other ITDT-SE functions, type R followed by the Enter key
to return to option 4 the device list; otherwise, type Q followed by the Enter
key to exit the program.
a2500243
Figure 66. Full Write Results
Tape Usage
The Tape Usage [U] function retrieves statistical data and error counters from a
cartridge.

a2500244
Figure 67. Tape Usage Screen
scan.
2. Select the device you want to test by entering its number and press the Enter
key.
3. Type U followed by the Enter key 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 the Enter key
or stop the test by entering C followed by the Enter key.
During the get logs operation, the program shows a progress indicator in form of a
bar of hash marks (#) that shows the progress of a single sub-operation as well as a
description of that operation.
If all sub-operations are finished, ITDT-SE shows a Tape Usage completion screen.
The Status field on the bottom right side indicates PASSED if the log retrieval
completed successfully and ABORTED otherwise.
Other
Other [O] - type O followed by the Enter key to display a screen with the
following commands:
v “System Test”
v “Library Self-Test” on page 262
v “Manual Inspect” on page 262
v “Return” on page 263
System Test
The System Test [Y] is a short test that performs the following:
v Reveals system performance bottlenecks. Compressible data throughput values
can reveal bandwidth limitations 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.
The System Test only runs on tape drives, not on autoloaders or libraries. To
perform a System Test on tape drives within a library, the library must be in online
mode.

2. Type O and press the Enter key to display the second device list screen.
3. On the second device list screen, type Y and press the Enter key 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 the
Enter key or stop the test by typing C followed by the Enter key.
Note: If ITDT-SE detects data on the cartridge, it shows the System Test screen,
and displays the following message:
Overwrite data?
Type Y followed by the Enter key to continue the test if you are
absolutely sure that data on the cartridge can be overwritten. If you are
unsure, type N followed by the Enter key to stop the test.
The System Test is performed 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. System Test writes the amount of data with all supported block sizes in
powers of two down to 16kB (at maximum 512, 256, 128, 64, 32, 16), first
with incompressible, then with compressible data, and then displays
performance data and progress screen.
c. At the end of the test, a summary screen is displayed.
a2500245
Figure 68. System Test Results
| Compressible = Yes" means that the data written was just zeroes, so that the


| medium.
The System Test can be stopped by typing A followed by the Enter key at any
time.
Note: It may take some time until the System Test actually stops.
return to the device list; otherwise press Q followed by the Enter key to exit the
program.
Library Self-Test
The Library Self-Test [L] starts and monitors the library-internal self-test. This test
only runs on libraries and autoloaders, not on tape drives.
3. On the second device list screen, type L and press the Enter key to start the
Library Self-Test.
A Device Test screen is displayed and a functionality test on the tape library is
performed.
At the end of the test, a results screen is displayed.
The Library Self-Test can be stopped by typing A followed by the Enter key at
any time.
Note: It may take some time until the Library Self-Test actually stops.
return to the device list; otherwise press Q followed by the Enter key to exit the
program.
Manual Inspect
Manual Inspect [I] creates a manual inspection record if a device does not appear
in the device list. This test is intended for devices that are not recognized or have a
technical problem which can not be determined by ITDT-SE.
If a tape drive cannot be identified using a device scan, the user can manually
create a test record for the drive. The system prompts for 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 some additional inspection information.
The result are saved into binary and text output files that have the same format as
the output files generated by the test.
3. On the second device list screen, type I and press the Enter key to open the
Manual Inspection screen.
4. On the next screen, type M followed by a space and the model name and press
the Enter key. For example: M ULT3580-TD1
5. Enter the required information to complete the items in the screen:
a. Type N followed by a space and the serial number and press the Enter key.

b. Type T followed by a space and the content of the Message Display and
c. Optionally, type A followed by a space and additional information text and
6. After all information has been entered, type S and press the Enter key to save
the data.
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-SE
output folder.
return to the first device list screen; otherwise press Q followed by the Enter key to
exit the program.
Return
Return [R] - type R followed by the Enter key to go back to the first device list
screen.
Standard Edition - Tapeutil Menu Commands

When the user executes the U command on the ITDT-SE start screen, the Tapeutil
operation screen is displayed.
Note: On any screen, to execute a command, press the shortkey displayed in

brackets [ ], followed by the Enter key.

v “[1] Open a Device” on page 264
v “[2] Close a Device” on page 264
v “[3] Inquiry” on page 264)
v “[4] Test Unit Ready” on page 264
v “[5] Reserve Device” on page 265
v “[6] Release Device” on page 265
v “[7] Request Sense” on page 265
v “[8] Log Sense” on page 265
v “[9] Mode Sense” on page 265
v “[10] Query Driver Ver. (Version)” on page 265
v “[11] Display All Paths” on page 265
v “[20] Rewind” on page 265)
v “[21] Forward Space File Marks” on page 265
v “[24] Backward Space Records” on page 266
v “[23] Forward Space Records” on page 266
v “[22] Backward Space File Marks” on page 266
v “[25] Space to End of Data” on page 266
v “[26] Read and Write Tests” on page 266
v “[27] Read or Write Files” on page 266
v “[28] Erase” on page 267
v “[29] Load Tape” on page 267
v “[30] Unload Tape” on page 267

v “[31] Write File Marks” on page 267

v “[32] Synchronize Buffers” on page 267
v “[33] Query/Set Parameter” on page 267
v “[34] Query/Set Tape Position” on page 267
v “[35] Query Encryption Status” on page 267
v “[36] Display Message” on page 268
v “[37] Report Density Supp (Support)” on page 268
v “[38] Test Encryp. Path (Test Encryption Key Path/Setup)” on page 268
| v “[39] Config. TCP/IP Port” on page 269
v “[50] Element Information” on page 269
v “[51] Position to Element” on page 269
v “[52] Element Inventory” on page 270
v “[53] Exchange Medium” on page 270
v “[54] Move Medium” on page 270
v “[55] Initialize Element Status” on page 270
v “[56] Prevent/Allow Medium Removal” on page 270
v “[57] Initialize Element Status Range” on page 270
v “[58] Read Device IDs” on page 270
v “[59] Read Cartridge Location” on page 270
v “[70] Dump/Force Dump/Dump” on page 271
v “[71] Firmware Update” on page 271
[1] Open a Device

When you select the Open a Device command [1]:
1. ITDT checks if a device is already opened.
2. You are prompted for a device special file name.
3. You are prompted for an open mode (rw, ro, wo, append).
4. ITDT opens the device you selected.
[2] Close a Device

When you select the Close a Device command [2]:
1. ITDT checks if the device is already closed.
2. ITDT closes the device.
[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.
[4] Test Unit Ready

When you select the Test Unit Ready (TUR) command [4], ITDT issues the Test
Unit Ready ioctl command.

[5] Reserve Device

When you select the Reserve Device command [5], ITDT issues a reserve command
for the device.
[6] Release Device

When you select the Release Device command [6], ITDT issues a release command
for the device.
[7] Request Sense

When you select the Request Sense command [7]:
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.
[8] Log Sense

When you select the Log Sense command [8]:
1. You are prompted for Log Sense Page.
2. ITDT issues a mode sense command.
3. ITDT performs a hexadecimal dump page.
[9] Mode Sense

When you select the Mode Sense command [9]:
1. You are prompted for Mode Sense Page.
2. ITDT issues mode sense command.
3. ITDT performs a hexadecimal dump page.
[10] Query Driver Ver. (Version)

When you select the Query Driver Version command [10]:
1. ITDT issues the required command to get driver version.
2. ITDT prints driver version.
[11] Display All Paths

When you select the Display All Paths command [11]:
1. ITDT issues an ioctl command.
2. ITDT outputs decoded path information for all paths.
[20] Rewind
When you select the Rewind command [20], ITDT issues the ioctl rewind command
for the device.
[21] Forward Space File Marks

When you select the Forward Space File Marks command [21]:
1. You are prompted for the number of file marks to space forward.
2. ITDT issues (extrinsic) ioctl command.

[22] Backward Space File Marks

When you select the Backward Space File Marks command [22]:
1. You are prompted for the number of file marks.
[23] Forward Space Records

When you select the Forward Space Records command [23]:
1. You are prompted for the number of records to space forward.
[24] Backward Space Records

When you select the Backward Space Records command [24]:
1. You are prompted for the number of records to space backward.
[25] Space to End of Data

When you select the Space to End of Data (EOD) command [25], ITDT issues the
(extrinsic) ioctl command.
[26] Read and Write Tests

When you select the Read and Write Tests command [26]:
v You are prompted for block size (If you just press Enter, the default block size is
10240).
v You are prompted for the number of blocks per read/write (If you just press
Enter, the default number of blocks is 20).
v You are prompted for the number of repetitions (If you just press Enter, the
default number of repetitions is 1).
You can then select one of the following options:

v Read data from tape (to run Read only test)
v Write data to tape (to run Write only test)
v Write/Read/Verify (to run Read and Write test)
ITDT performs the selected test and displays the transfer size and block size used
for this test, the number of records read/written, and the total bytes transferred.
[27] Read or Write Files

When you select the Read or Write Files command [27]:
v You are prompted to specify the filename of the source file (for Write test) or the
destination file (for Read test).
v You are prompted for the number of records to be read.
You can then select one of the following options:

v Read File from Tape: ITDT reads a file from tape and stores data into a file with
the given filename.
v Write File to Tape: ITDT reads data from file with the given filename and writes
data to tape.

ITDT displays the number of records read/written, the transfer size and the total
bytes transferred.
[28] Erase
When you select the Erase command [28], ITDT issues the (extrinsic) ioctl
command.
[29] Load Tape

When you select the Load Tape command [29], ITDT issues the load tape
command.
[30] Unload Tape

When you select the Unload Tape command [30], ITDT issues the unload tape
command.
[31] Write File Marks

When you select the Write File Marks command [31]:
1. You are prompted for the number of file marks to write.
2. ITDT issues the (extrinsic) ioctl command.
[32] Synchronize Buffers

When you select the Synchronize Buffers command [32], ITDT issues the ioctl
command.
[33] Query/Set Parameter

When you select the Query/Set Parameter command [33]:
1. ITDT displays non-changeable parameters.
Note: The list of non-changeable parameters is operating system specific.

2. ITDT displays changeable parameters.
Note: The list of changeable parameters is operating system specific.

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.
[34] Query/Set Tape Position

When you select the Query/Set Tape Position command [34]:
1. ITDT displays the current position
2. You are prompted for a new position to set.
3. ITDT issues the Set Position ioctl command.
[35] Query Encryption Status

When you select the Query Encryption Status command [35]:
1. ITDT issues Get Encryption State ioctl command.
2. ITDT displays encryption settings (Encryption capability, Encryption Method,
Encryption state).

[36] Display Message

When you select the Display Message command [36]:
1. You are prompted for the text of message 0 (8 characters or less).
2. You are prompted for the text of message 1 (8 characters or less)
3. You are prompted for message type (msg0, msg1, flash0, flash1, alt).
4. ITDT issues the Display Message ioctl command.
Not all drives have a display. The 3592 drive is the only one at this time that has
display message capability since it is the only one with a display that is more than
1 character long. Eight is the limit of the characters on a display screen.
[37] Report Density Supp (Support)

When you select the Report Density Support command [37]:
1. ITDT prints report status text for all supported media.
2. ITDT issues Report Density Support ioctl command to retrieve all supported
media.
3. ITDT prints all requested reports. Data is printed in a decoded way. Scroll the
screen to print each one of the following:
v Density name
v Assigning organization
v Description
v Primary density code
v Secondary density code
v Write OK
v Duplicate
v Default
v Bits per MM
v Media Width
v Tracks
v Capacity (megabytes).
4. ITDT prints report status text for current media
5. ITDT issues Report Density Support ioctl command to retrieve current media
6. ITDT prints report data in a decoded way.
[38] Test Encryp. Path (Test Encryption Key Path/Setup)

When you select the Test Encryption Key Path/Setup command [38]:
Note: Not supported for the HP-UX operating system.

1. ITDT prints status message that server configuration and connections are tested
2. ITDT issues the Encryption Diagnostics ioctl command, Ping Diag
3. ITDT prints number of servers available or error message
4. ITDT issues the Encryption Diagnostics ioctl command, Basic Encryption Diag
5. ITDT prints completion code or error message
6. ITDT issues the Encryption Diagnostics ioctl command, Full Encryption Diag
7. ITDT prints completion code or error message.

| [39] Config. TCP/IP Port

| Drive Ethernet port configuration, only available for LTO-5 drives. First, the
| current Ethernet settings will be read and displayed, then the user will get
| prompted for every parameter to be changed:
| ITDT- Set TCP/IP Port
| +-----------------+
| Address IPV4 | 2.3.4.5 |
| +-----------------+
| Port V4 | 5050 |
| +------+
| Subnet Mask Length | 24 |
| +------+
|
|
|
| <Specify Address IPV4 | [enter] for 2.3.4.5>
| Pressing the Enter key will step to the next parameter without changing the
| current one. Once all parameters are changed, the configuration will be written to
| the drive and a screen similar to the following will appear:
| IBM Tape Diagnostic Tool Standard Edition - Device Test
| Host Bus ID LUN Model Serial Ucode Device
| +----+----+----+-----+--------------+------------+------+---------------------+
| | 0 | 0 | ## | 636 | ULT3580-TD5 | 1013000074 | A1W0 | |
| +----+----+----+-----+--------------+------------+------+---------------------+
| +-----------------------------------------------------------------------------+
| | Setting TCP/TP Configuration... |
| | Reading current TCP/TP Configuration... |
| | Number of Port Descriptors 1 |
| | Port Descriptor for Port 1 |
| | Number of Socket Descriptors 2 |
| | Get Adapter:1 IPV4 2.3.4.5:5050/24 Wed Feb 03 02:55:21.195 2010 |
| | |
| | |
| | |
| | |
| +-----------------------------------------------------------------------------+
| +----------------+ +---------------------------+
| Result: | PASSED | Code: | OK |
| +----------------+ +---------------------------+
|
|
| <[Q] Quit | [N] Next | [P] Previous | + | - | [Enter] Return>
| [50] Element Information

When you select the Element Information command [50]:
1. ITDT issues the ioctl command
2. ITDT displays number of robots, first robot address, number of slots, first slot
address, number of i/e elements, first element address, number of drives, first
drive address.
[51] Position to Element

When you select the Position to Element command [51]:
1. You are prompted for destination address

[52] Element Inventory

When you select the Element Inventory command [52]:
1. ITDT issues the Element Info ioctl command.
2. ITDT issues the Element Inventory ioctl command.
3. ITDT displays decoded element inventory info, type n followed by return to
show next page of information.
[53] Exchange Medium

When you select the Exchange Medium command [53]:
1. You are prompted for source address.
2. You are prompted for first destination address.
3. You are prompted for second destination address.
[54] Move Medium

When you select the Move Medium command [54]:
1. You are prompted for source address.
2. You are prompted for destination address.
[55] Initialize Element Status

When you select the Initialize Element Status command [55]:
1. ITDT prints command summary.
[56] Prevent/Allow Medium Removal

When you select the Prevent/Allow Medium Removal command [56]:
1. You are prompted to select (1) for Prevent Removal, or (0) for Allow Removal.
[57] Initialize Element Status Range

When you select the Initialize Element Status Range command [57]:
1. You are prompted for the first slot address.
2. You are prompted for the number of slots.
[58] Read Device IDs

When you select the Read Device IDs command [58], ITDT retrieves the device ID
information for all available drives and displays the information. Type n followed
by Enter to show the next page.
[59] Read Cartridge Location

When you select the Read Cartridge Location command [59]:
1. You are prompted for the address of the first slot.
2. You are prompted for number of elements.
3. ITDT verifies that the given address range is valid, otherwise prints error
message and exit.
4. ITDT issues the READ_CARTRIDGE_LOCATION ioctl command.


6. ITDT verifies that the address range is valid; otherwise print error message and
exit.
7. If no slots are found in Element Info data, print error message and exit.
9. ITDT prints decoded storage element information, Type n followed by Enter to
show next page.
[70] Dump/Force Dump/Dump

When you select the Dump/Force Dump/Dump command [70]:
v ITDT retrieves dump.
v ITDT issues Force Dump command.
v ITDT retrieves second dump.
v ITDT displays name of stored dump files and the output directory where they
are stored. The dump filenames start with the serial number of the device.
[71] Firmware Update

When you select the Firmware Update command [71]:
1. ITDT displays the default input directory where the firmware files should be
stored. The following are examples of the directory:
v Example input directory (Windows): c:\itdt\input
v Example input directory (Unix): /home/user/itdt/input
2. You are prompted to specify a different input directory if required, or to press
Enter to keep the standard ITDT directory.
3. You are prompted to specify the firmware file name and press Enter to start.
4. ITDT performs firmware update and displays progress status and result.
Note: See “3576/TS3310 Tape Library” on page 246 for more information on
how to update the firmware on a 3576/TS3310 Tape Library.
http://www.ibm.com/storage/lto.
Standard Edition - Tapeutil Scripting Commands

Scripting has been enabled with the 4.0 release of ITDT SE. ITDT-SE provides
backward compatibility for existing tapeutil scripts. While some legacy commands
exists they will not be documented in their entirety as they will be phased out over
time. New scripts should always use those listed in this guide, the Common
Command set (CS), and existing scripts need to be modified for forward
compatibility with ITDT.
Following you will find a list of commands, on each command you will find the
command, a description, parameter list, and which platforms are supported. Some
commands will have numbers after them, this means there is a corresponding
menu command in “Standard Edition - Tapeutil Menu Commands” on page 263.
| The following are the generic invocation parameters as in use by the legacy
| command sets:
| -f filename

| Note: "filename" is a device special file for the drive/changer, for example:
| /dev/rmt0 (AIX), /dev/rmt/0st (Sun), /dev/rmt/0m (HP),
| /dev/IBMtape0 (Linux), \\.\tape0 (Windows)
| For a complete list of the filename syntax, please refer the section "Special Files" on
| each platform.
The calling convention for the Common Command set will be:
itdt -f filename [Open Mode] Subcommand [Subcommand ...]
The Open Mode flag is supported on all platforms. If the flag is not set, the device
will be opened in read/write mode. Additional parameters that may be required
for opening the device will be automatically detected and set.
Valid Open Modes are
-w 0 for Read/Write
-w 1 for Write Only
-w 2 for Read Only
-w 3 for Append only
Note that the new command set will enable legacy commands on every platform,
even if that wasn't supported by Tapeutil before. The output will follow current
Tapeutil conventions, but if there is different output for a single command on
various platforms, the output will be implemented according to the AIX output as
the primary scripting platform.
Note that Tapeutil allowed undocumented abbreviations for some of the

commands, for example it was possible to shorten “inquiry” to “inq” or “inqu” or
“inqui” and so on. The following command abbreviations will be supported with
ITDT-SE too: inq(uiry), req(sense), pos(ition), ele(mentinfo), inv(entory), devid(s),
cartridge(location). A list of Deprecated Commands are below at “Deprecated
Commands” on page 285. Also there is a list of unsupported commands and
known exceptions at the end of this section in “Standard Edition Scripting
Commands: Known Limitations and Deviations” on page 286.
The following commands are described in these sections:
The General commands are:

v “allow” on page 274
v “devinfo” on page 274
v “inquiry” on page 274
v “logpage” on page 274
v “loop” on page 274
v “modepage” on page 274
v “prevent” on page 275
v “print” on page 275
v “qrypath” on page 275
v “qryversion” on page 275
v “release” on page 275
v “reqsense” on page 276
v “reserve” on page 276
v “resetdrive” on page 276
v “sleep” on page 276

v “tur” on page 276

v “vpd” on page 276
The Tape commands are:

v “append” on page 277
v “bsf” on page 277
v “bsr” on page 277
v “density” on page 277
v “display” on page 277
v “erase” on page 278
v “fsf” on page 278)
v “fsr” on page 278
v “getparms” on page 278
v “load” on page 278
v “logsense” on page 278
v “qrypos” on page 279
| v “qrytcpip” on page 279
v “read” on page 279
v “rewind” on page 279
v “rtest” on page 279
v “rwtest” on page 280
v “seod” on page 280
v “setparm” on page 280
v “setpos” on page 281
| v “settcpip” on page 281
v “sync” on page 282
v “unload” on page 282
v “weof” on page 282
v “write” on page 282
v “wtest” on page 282
The Medium Changer Subcommands are:

v “audit” on page 283
v “cartridgelocation” on page 283
v “elementinfo” on page 283
v “exchange” on page 283
v “inventory” on page 283
v “move” on page 284
v “position” on page 284
The Service Aid commands are:

v “dump” on page 284
v “ekmtest” on page 284
v “encryption” on page 284
v “ucode” on page 285

allow
(Deprecated: unlock, -o rem) Allow medium removal for tape or changer devices
(unlock door). The counter command for this is prevent.
Parameters:
None
Supported platforms: All
devinfo
(Deprecated: -o gdi) Show device information (device type, sub type and block
size)
Parameters:
None
Supported platforms: AIX, Solaris, HP-UX
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 will print 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:
logpage Page (page in hex without the 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 is allow.
Parameters:
None
print
This subcommand prints the associated text to standard output. It can be used at
any time to display the progress of the subcommands.
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 will show 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
reserve
(Deprecated: -o res) This subcommand explicitly reserves a device by issuing the
SCSI Reserve command.
Parameters:
None
resetdrive
This subcommand issues a Send Diagnostic command (Reset Drive subcommand)
to reset the device.
Parameters:
None
Supported platforms: AIX, Linux
sleep
Sleep for the specified number of seconds before executing 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
Supported platforms: All, but on Windows this open mode is not supported by the
IBM Tape Device Driver. On HP-UX this open mode is re-mapped to r/w by the
IBM Tape Device Driver.
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]
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
Note: ITDT-SE will output detailed information on all platforms.
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.
Parameters:
display “message1” “message2”

erase
(Deprecated: -o era) This subcommand erases the tape.
Parameters:
None
fsf
(Deprecated: -o fsf) This subcommand forward spaces count filemarks. The tape is
positioned on the first block of the next file. An optional count can be specified.
The default is 1.
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
load
(Deprecated: -o lod) This subcommand issues a SCSI Load command to load a
tape. 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
Retrieve all Log Sense pages and output them as hex.
Parameters:

None
qrypos
(Deprecated: -o gpo) This subcommand displays the current tape position.
Parameters:
None
| qrytcpip
| Output the current drive TCP/IP configuration. Only supported with LTO-5. Will
| output adapter and TCP/IP address information for IPv4 with address, port and
| subnet mask – example:
| itdt -f \\.\tape0 qrytcpip
| Adapter:1 IPV4 111.222.0.77:7070/112
| Exit with code: 0
| Parameters:
| None
| Supported platforms: All
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 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]
rewind
(Deprecated: -o rew) Rewind the tape.
Parameters:
None
rtest
(Deprecated: -o rea) This subcommand performs a read test by reading a random
data pattern from the tape and verifying that it matches the written data. The rtest
subcommand can be used after the wtest subcommand to verify the 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 read on each repetition. If the block size is zero (variable), then the count

specifies the number of bytes to read on each repetition. The default is a block size
of 10240, a count of 20 blocks, and a repetition of 1.
Parameters:
read [-b Blocksize] [-c Count] [-r Repetition]
rwtest
This subcommand performs 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. 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, a count of 20 blocks, and a repetition of 1.
Parameters:
rwtest [-b Blocksize] [-c Count] [-r Repetition]
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 will use the new setparm option that corresponds to the current
interactive mode options.
Parameters: The Value will be

v 0-65535 for the blocksize parameter
v 0-100 for the capacity parameter (=percentage)
v 1 (SCSI) and 2 (AIX) for recordspacemode
v the Volume Id string for the volid parameter
v NONE|ASSO|PERS|WORM for the writeprotect parameter
v 0 for off/no and 1 for on/yes for setparm autoload, autodump, buffering,
compression, immediate, readpastfilemark, sili, simmim, trace, trailer,
volumelogging
Supported platforms: All, but only a subset of the parameters is supported by the
platform's device drivers:

Table 29. 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
setparm capacity X X X X
setparm compression X X X X X
setparm immediate X X X X
setparm readpastfilemark X
setparm recordspacemode X
setparm sili X X X
setparm simmim X
setparm trace X
setparm trailer X X X X
setparm volid X
setparm volumelogging X X
setparm writeprotect X X X X
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 using the qrypos
subcommand.
Parameters:
setpos [Blockid]
| settcpip
| Sets the drive Ethernet port TCP/IP settings for LTO-5 drives. If the optional
| parameters port and subnet_mask_length are not specified, the current settings for
| these parameters are not changed. IPv4 addresses are entered in the syntax
| a.b.c.d:port/subnet_mask_length where a,b,c,d are values with 1 to 3 digits.
| itdt -f \\.\tape0 settcpip 9.155.27.99:0/24
| Setting TCP/TP Configuration...
| Adapter:1 IPV4 111.222.0.77:7070/112
| Adapter:1 IPV6 [0001:0016:0021:01BC:15B3:1A0A:1E61:22B8]:7070/112
| Exit with code: 0
| Parameters:
| address[:port[/subnet_mask_length]]
| Supported platforms: All

sync
(Deprecated: -o syn) This subcommand will synchronize buffers/flush the tape
buffers to tape.
Parameters:
None
unload
(Deprecated: -o off / offline / rewoffl) This subcommand rewinds and unloads the
tape.
Parameters:
None
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, 1 filemark will
be written.
write
This subcommand writes the source file specified with the -s flag on the tape.
Parameters:
write -s Source
wtest
(Deprecated: -o wri) This subcommand performs 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 using the Source, Dest1, and Dest2 addresses specified.
This command performs the equivalent function of two Move Medium commands.
The first moves the cartridge from the element address specified by the Dest1
parameter to the element address specified by the Dest2 parameter. The second
moves the cartridge from the element address 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]
Note: ITDT will support the optional parameters on all platforms.
move
(Deprecated: -o mov) This subcommand issues the SCSI Move Medium command
using the source and destination addresses specified. The element addresses can be
obtained using the elementinfo subcommand.
Parameters:
move Source Dest
position
(Deprecated: -o pos) This subcommand issues the SCSI Position to Element
command using the destination specified.
Parameters:
position Dest
dump
(Deprecated: -o sdp) 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
Supported platforms: AIX, Linux, Solaris, Windows
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:
ucode Filename
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 will no longer be available and the
scripts containing these commands will need to be changed. The scripts using the
deprecated commands should be changed for future editions.
The General commands are:

v disablepath / -o dis
v enablepath / -o ena
v fuser
v kill
v passthru
v resetpath
The Tape commands are:

v bsfm
v chgpart
v -o chk
v fsfm
v getrecsize / -o grs
v idp
v list
v mediainfo / -o gmi
v qryinquiry
v qrypart
v qrysense
v retension / -o ret
v sdp
v setblk
v status / -o gds
The Medium Changer subcommands are:

v devids / -o dvc
v mount
v unmount / demount
The Service Aid commands are:

v fmrtape
v forcedump / -o fdp
v reset
v ucodelevel / -o qmc
Standard Edition Scripting Commands: Known Limitations

and Deviations
| The scripting commands idp, sdp, chgpart and qrypart are currently not supported
| with LTO5 drives. They are currently kept for legacy reasons as-is, but will be
| promoted to first-class commands for LTO5 drives with a later release.
When scripting, one should 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 out.
For some operations, the sense data length is limited to 32 bytes – this is required
by the ITDT test sequences.
| The list command will not work on Linux variants where the reported maximum
| SCSI transfer size is larger than the size the system can actually transfer.
Due to the fact that ITDT-SE opens the device read/write by default in scripting
mode, the WORM mode can not be deactivated in scripting mode. Use the Tapeutil
interactive mode instead to deactivate the WORM mode.
Scripting mode command deviations to legacy tapeutil (tapeutil will not be

changed):
1. The erg (Erase Gap) command will not be supported.
2. The mtdevice command will not be supported.
3. The tell command will not be supported.
4. The seek command will not be supported.
5. The format command will not be supported.
6. The -o qsn command will not be supported.
7. path/querypath/path / qrypath / checkpath / - o phs - output: always show
all paths.
8. devinfo - different output (decoded on all platforms)
9. inquiry - different output on Linux (like AIX in hex)
10. vpd - different behavior on Solaris (like AIX)
11. modepage - HP-UX and Solaris output deviations (like AIX)
12. inventory - additional parameters on AIX available on all platforms
13. cartridgelocation - AIX parameter deviation available on all platforms
14. mediainfo - different output -> decode on all platforms
15. setpos - logical vs. physical position, only set logical position as on AIX
16. HPUX: -o gpo -t 1|2 --> parameter -t1|2 (logical, physical) is not supported.
17. density - output all information on all platforms
18. setparm (new) - work around the inability to set all parameters on all
platforms except the undocumented HP-UX release

19. getparms (new) - retrieve all parameters on all platforms, independent of flag
set
20. qryinquiry - output the same as on AIX
21. logsense - does not output header with device/serial/volid, example:
05/12/09 15:10:44 Device: ULT3580- S/N: 1300000206 Volid: UNKNOWN
Graphical Edition - Installation
Windows
To install ITDT-GE on Windows, download the executable file
install_ITDT_GE_<version>.exe on a directory of your choice.
Double-click the downloaded file to launch the installer application.
ITDT-GE installer automatically uninstalls any previous version before installing

the current one.
ITDT-GE requires a 32-bit Java Runtime Environment (JRE) to be installed. Install

one of the following:
| v Java 1.4.2 SR11 by IBM Corporation or higher
| v Java 1.4.2_17 by Sun Microsystems or higher
Note: If IBM Java 1.5 on a Microsoft Windows system is used, ensure that it is
Java 1.5 SR6 or higher.
For the graphical user interface (GUI) a minimum screen resolution of 1024*768
pixels is required.
The supported Windows operating systems for ITDT-GE are:

v Microsoft Windows XP
v Microsoft Windows Server 2003
v Microsoft Windows Server 2008 (x86, 32-bit)
64-bit Windows x64 is supported for ITDT-GE, but 32-bit JVM must be used.
Linux
To install ITDT-GE on Linux, download the executable file
install_ITDT_GE_<version>.bin to a directory of your choice.
install_ITDT_GE_<version>.bin needs to be run by a user with root access rights.
ITDT-GE requires a 32-bit Java Runtime Environment (JRE) to be installed.
Note: The JRE delivered with Red Hat Enterprise Linux 4 and 5 (RHEL4, RHEL5)
is not supported. Install one of the following supported JREs before
launching the ITDT Installer:
| v Java 1.4.2 SR11 by IBM Corporation or higher
| v Java 1.4.2_17 by Sun Microsystems or higher
On RHEL4, RHEL5 and other Linux systems where none of the supported JREs is
available in the path do the following:

1. Add your Java directory to the path before starting the installer: The following
are examples of how to extend the search path (replace <version> with the
version that is in use).
v For IBM Java Runtime Environment:
$ export PATH=/opt/IBMJava2-142/jre/bin:$PATH
$ ./install_ITDT_GE_<version>.bin
v For Sun Microsystems Java Runtime Environment:
$ export PATH=/usr/java/j2re1.4.2_09/bin:$PATH
$ ./install_ITDT_GE_<version>.bin
Note: In the above examples, replace the directory names with your JRE
directories.
2. Create a symbolic link to the JRE to ensure that ITDT finds the right JRE before
starting ITDT-GE.
v For IBM Java Runtime Environment:
$ ln -sf /opt/IBMJava2-142/jre /opt/ibm/itdt-ge/jre
v For Sun Microsystems Java Runtime Environment:
$ ln -sf /usr/java/j2re1.4.2_09 /opt/ibm/itdt-ge/jre
Note: In the above examples, replace the directory names with your JRE
directories.
The ITDT-GE installer automatically uninstalls any previous version before

installing the current one.
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 (x86, 32-bit)
Graphical Edition - Known Issues and Limitations

This section describes the known issues and limitations of ITDT-GE.
Linux
It is strongly recommended to not operate Security Enhanced Linux (SELinux) in
enforcing mode while running ITDT-GE.
On RedHat Enterprise Linux 4 and 5 and SuSE Enterprise Linux 10 invoking the
online help may cause an error message "Problems opening link / Unable to open
web browser on {0}" to appear. 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 starting
ITDT-GE.
Gnome Desktop
If you are using the Gnome desktop, please be sure to log into the desktop session
as root to use ITDT-GE to prevent device access issues.

Windows
On Microsoft Windows systems where the maximum transfer size is limited to less
than 64kB, the Dump and Firmware update operations will not work.
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 shipped with the
Windows operating system.
Devices Disappear After Firmware Update

After a firmware update, devices may disappear. This is a known Windows
problem.
See the Article ID: 812024 at:

http://support.microsoft.com/kb/812024/en-us
Repeated Scan operations may help to rediscover the device.
All Supported Operating Systems

Command Timeout
There is no instant operation termination upon SCSI command timeout; for
example, when the SCSI cable is unplugged after starting POST A.
When a command timeout condition occurs, ITDT may still continue to perform
more operations (like unmounting the cartridge) instead of instantly terminating
with a timeout condition.
3576/TS3310 Tape Library

Library Firmware Update using ITDT-GE is not supported with the 3576/TS3310
tape library. Update the Firmware using the 3576/TS3310 Web User Interface.
3494 Tape Library

Drives in a 3494 tape library or an STK silo library are supported, only the Test
option won’t work due to device-specific restrictions for handling cartridges.
Graphical Edition - User Interface Description
a2500238
Figure 69. Graphical Edition User Interface
To start ITDT-GE on Windows click the shortcut 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 -
finally start ITDT-GE with

$ /opt/ibm/itdt-ge/itdt-ge

The User Settings dialog appears the first time 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
where <username> is the Windows user login name. The Linux default output
path is
/root/.itdt-ge/output
The Log Level should not be changed unless requested to do so by the IBM
Support Center. It is strongly recommended that this information be provided to
allow for further analysis of test results.
The interface of the GE edition is as follows:

v The main menu in the upper left
v The graphical buttons to select either the Diagnostic or the Tapeutil perspective
v The Control Center with the toolbar that contains the main actions as well as
advanced actions that can be reached by drop-down arrows
v The test tab area on the right that contains all output of the running as well as
previously finished tests
v The Status Information area on the bottom that summarizes the results of
previously run tests or notifies when a test tab requires user input
a2500262
Figure 70. Graphical Edition Preferences
It is strongly recommend that this information be provided to allow for further

analysis of test results. Click OK to save the settings and close the dialog.

The ITDT-GE interface contains the following:
a2500239
Figure 71. Graphical Edition Interface
v Main Menu (1 on Figure 71)- Located in upper left (File, Window, Help) The
following main program menu items are available:
a2500264
Figure 72. Main Program Menu Items
v Control Center (2 on Figure 71) - Located on left side (Device operations -
Scan, Test, Dump, and Update)
Additional device operations are available using drop-down arrows.
v Test Lab (3 on Figure 71) - Located from center to right side (Contains running
and previously run tests)
v Status Information (4 on Figure 71) - Located below the Test Lab (Contains
summary results of tests)
The Control Center is the primary section the ITDT-GE operations.
The following toolbar buttons for the device operations are available:

a2500265
Figure 73. Toolbar Buttons
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 checkbox.
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 additional log options.
v Update
Click the Update menu item to start the firmware update.
For each device on which the operation has been started, a tab appears 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.
Graphical Edition - Scan Menu Commands

v “Scan” on page 293
v “Test” on page 294
v “Dump” on page 296
v “Firmware Update” on page 297
v “Encryption” on page 298
v “Full Write” on page 299
v “Tape Usage” on page 301
v “System Test” on page 301
v “Library Diagnostic Self-Test” on page 302

Scan
a2500240
Figure 74. Scan Function
The scan function 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-GE operations. The scan function also serves as a connection test
that can be used to verify proper attachment of the devices.
Note: When pressing the Scan button for the first time, a dialog box is displayed,
that warns the user to stop all backup jobs.
Once the scan is finished, the device list is displayed, in the Control Center area.
A scroll bar is available to display all the devices. Once the desired device is
displayed, select the device for test. Only one device can be selected.

Test
a2500241
Figure 75. Test Menu
The test function checks if the tape device is defective and outputs a pass/fail
result.
Attention: The test functionality erases user data on the cartridge that is used for
the test.
Notes:
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 perform the Test function, it is recommended that a new or rarely used

cartridge is used. Scaled (capacity-reduced) cartridges should not be used to test
the device.
To test tape drives within a library, the library must be in online mode.
After selecting the device you want to test, start the Test function selecting the Test
menu item.
The Test function can be stopped by clicking the Abort button.
Note: It may take some time until the Test function actually stops.

a2500242
Figure 76. Test Results
Note: Information can be found in the .txt/.blz files. See the log file section (1).
The test sequence contains the following steps:

| 1. Mount Medium
| 2. [Medium Qualification] – only if the previous step indicated this requirement
| 3. Load/Write/Unload/Read/Verify
| 4. POST A
| 5. Performance Test (run 2 times if first run failed with performance failure)
| 6. POST B
| 7. Unmount Medium
| 8. Get FSC
| 9. Get Logs

Dump
a2500224
Figure 77. Dump Menu
After selecting the device you want to dump, start the Dump function by selecting
Dump -> Dump from the actions toolbar.
When the dump process is performed on a tape library or autoloader other than
the 3584/TS3500, the Dump function stores one log file in the output folder of the
program (*.blz). For the 3584/TS3500, a dump file (*.a.gz) will be stored in the
output folder. Both files start with the serial number of the device (1).

a2500225
Figure 78. Dump Results
Note: When the Dump function is performed for tape libraries or autoloaders
other than the 3584/TS3500, the Log file only contains Log Sense and Mode
Sense pages, while a Drive or 3584/TS3500 Dump contains much more
diagnostic information. (2)
Firmware Update
The Firmware Update upgrades the firmware of tape drives and tape libraries. See
“Supported Equipment” on page 235 for a list of supported products.

http://www.ibm.com/storage/lto
To do a Firmware Update perform the following steps:

1. Select the device you want to update.
2. Select the Update menu item.
3. A standard file dialog opens to select the path of where the firmware update is
located.
The path is either the default input path or the location of the last successfully
opened firmware file.
Press OK button on this file dialog to start the update on the selected device.
During the firmware update, a firmware update progress screen is displayed,
indicating the progress of the update.
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.

Note: If ITDT-GE detects a FIPS-certified drive firmware, it displays a warning

dialog. Before continuing, ensure that you use a FIPS-certified firmware
to update the drive.
Encryption
a2500226
Figure 79. Encryption Function
Note: Note that the test shown on the graphic above was run on a non-encrypted
device and is showing a failure.
The Encryption function is used to verify if data on the cartridge was actually
written encrypted. It reads both decrypted and raw data from the cartridge into
two separate files on disk. The user can then verify that the data differs to ensure
that encryption worked.
The Encryption function is only supported on encryption enabled drives and

requires an encryption infrastructure including the Encryption Key Manager (EKM)
to be properly set up.
1. After selecting the device you want to test, start the encryption function by
selecting Test -> Encryption Verification from the actions toolbar.
2. ITDT-GE then displays 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.
3. Enter the required values and click OK to start the encryption.
The Encryption function can be stopped by clicking the Abort button.
Note: It may take some time until the Encryption function actually stops.
Table 28 on page 257 defines the abort codes.

Full Write
The Full Write function writes the entire cartridge with a given 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.
Notes:
1. The Full Write function takes approximately 2 hours when writing
incompressible data, less time for compressible data.
2. The Full Write function runs only on tape drives, not on autoloaders or
libraries.
The Full Write test can be used to:

v Demonstrate that the drive is capable of writing the full amount of data on a
cartridge.
v Reveal system performance bottlenecks.
Full Write firsts runs the test with incompressible data first, then runs the test
with compressible data. If no difference in overall performance is observed, then
probably there is a bandwidth limitation caused by the system or cabling or
HBA.
v Identify system issues with compression.
Compression is always switched on during the full write. When run with
compressible data, the output shows the compression rate. If that is higher than
1.0 but your system does not appear to be able to compress data on the
cartridge, check your device driver and software settings to see if they disable
compression.
To perform a full write on tape drives within a library, the library must be in
online mode.
1. After selecting the device you want to write to, start the Full Write function by
selecting Test -> Full Write from the actions toolbar.
2. Click OK to start the full write.
ITDT-GE then displays the Full Write screen. If no cartridge is inserted,
ITDT-GE prompts to insert a cartridge. Either insert a cartridge and click OK or
stop by clicking the Abort button.
Note: If ITDT-GE detects data on the cartridge, it displays the following

message (Figure 80 on page 300):

a2500227
Figure 80. Overwrite Data
Click Yes to continue the test if you are absolutely sure that data on the
cartridge can be overwritten. If you are unsure, click No to stop the test.
3. The system prompts for entry of a transfer size between 16 KB and the
maximum block size supported by the system (maximum possible value is 512
KB). Select the appropriate value for your system.
a2500228
Figure 81. Transfer Size
4. Select the type of data to write, either: [C] Compressible or [I] Incompressible.
The full write can be stopped by clicking the Abort button.
Note: It may take some time until the full write actually stops.
| "Compressible = Yes" means that the data written was just zeroes, so that the

| medium.
If all write operations are finished, ITDT-GE displays the performance statistics
for the selected block size written on the cartridge, in the Status Information
area. If an error occurred during the full write, data is only written partially.
Tape Usage
a2500229
Figure 82. Tape Usage
The Tape Usage function retrieves statistical data and error counters from a
cartridge.
1. After selecting the device you want to test, start the Tape Usage function by
selecting Dump -> Tape Usage Log from the actions toolbar.
2. ITDT-GE then displays the tape usage screen. If no cartridge is inserted,
ITDT-GE prompts to insert a cartridge. Either insert a cartridge and click OK or
stop by clicking the Abort button.
System Test
The System Test is a short test that performs the following:
v Reveals system performance bottlenecks. Compressible data throughput values
can reveal bandwidth limitations 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.
The System Test only runs on tape drives, not on autoloaders or libraries. To
perform a System Test on tape drives within a library, the library must be in online
mode.

After selecting the device you want to test, start the System Test function by
selecting Test -> System Test from the actions toolbar.
ITDT-GE then displays the System Test screen. If no cartridge is inserted, ITDT-GE
prompts to insert a cartridge. Either insert a cartridge and click OK or stop by
clicking the Abort button.
Note: If ITDT-GE detects data on the cartridge, it displays the following message:
Overwrite data?
Click Yes to continue the test if you are absolutely sure that data on the
cartridge can be overwritten. If you are unsure, click No to stop the test.
a2500230
Figure 83. System Test
The System Test is performed as follows:

1. System Test determines the amount of data to write for each supported
blocksize (a percentage of the cartridge is written for each blocksize).
2. System Test writes the amount of data with all supported block sizes in powers
of two down to 16kB (at maximum 512, 256, 128, 64, 32, 16), first with
incompressible, then with compressible data, and then displays performance
data and progress screen.
3. At the end of the test, a summary information is displayed.
Library Diagnostic Self-Test

The Library Self-Test starts and monitors the library-internal self-test. This test only
runs on libraries and autoloaders, not on tape drives.
After selecting the device you want to test, 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 displayed in the Status Information area.
Manual Inspection Record Entry

A manual inspection record can be generated if the device does not appear in the
device list. This test is intended for devices that are not recognized or have a
technical problem which can not be determined by ITDT-GE.
If a tape drive cannot be identified using a device scan, the user can manually
create a test record for the drive. The system prompts for 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 some additional inspection information.
The result 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 additional information text.
3. After all information has been 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.
Graphical Edition - Tapeutil Menu Commands

After the initial startup, 4.0 will show two figures under the top menu. The
Graphical version now offers the same commands that are found in the SE Tapeutil
section along with the Diagnostic commands. After selecting the Tapeutil option
the following page will appear.

a2500258
Figure 84. Tapeutil Control Center
The left drop-down box within the Tapeutil Control Center is used to select
between Tape Drive Commands and Tape Library Commands. The commands
from the General Commands and Service Aid Commands ITDT-SE categories are
duplicated into the two sections to make the GUI navigation easier.
After the command category is selected, a drop-down box appears that allows the
selection of a command:

a2500259
Figure 85. Tape Drive Commands
After the command is selected, an area appears where command parameters can
be entered:
a2500260
Figure 86. Command Parameters
When the user presses the “Execute” button, the “Results” output is placed below
the Parameter section:

a2500261
Figure 87. Command Parameter Results
This screen layout will stay 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 with a green check mark. The status area can be cleared by pressing
the “Clear” button.
The general commands that are available under both menus are:
v “Open” on page 307
v “Close” on page 307
v “Inquiry” on page 308
v “Test Unit Ready” on page 308
v “Reserve Device” on page 308
v “Release Device” on page 308
v “Request Sense” on page 308
v “Log Sense” on page 308
v “Mode Sense” on page 308
v “Query Driver Version” on page 308
v “Display All Paths” on page 308
The tape drive specific commands are:
v “Rewind” on page 309
v “Forward Space Filemarks” on page 309
v “Backward Space Filemarks” on page 309
v “Forward Space Records” on page 309
v “Backward Space Records” on page 309
v “Space to End of Data” on page 309
v “Read and Write Tests” on page 309

v “Read or Write Files” on page 311

v “Erase” on page 312
v “Load Tape” on page 312
v “Unload Tape” on page 312
v “Write Filemarks” on page 312
v “Synchronize Buffers” on page 312
v “Query/Set Parameter” on page 312
v “Query/Set Position” on page 312
v “Query Encryption Status” on page 313
v “Display Message” on page 313
v “Display All Paths” on page 308
v “Report Density Support” on page 313
v “Test Encryption Path” on page 314
The tape library specific commands are:
v “Element Information” on page 314
v “Position to Element” on page 314
v “Element Inventory” on page 314
v “Exchange Medium” on page 314
v “Move Medium” on page 314
v “Initialize Element Status” on page 315
v “Prevent/Allow Medium Removal” on page 315
v “Initialize Element Status Range” on page 315
v “Read Device IDs” on page 315
v “Read Cartridge Location” on page 315
The service aid commands which are found under both menus are:
v “Dump/Force Dump/Dump” on page 315
v “Firmware Update” on page 316
Note: When issuing a command 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. There is a box under Device Name: where you enter the name of the device.
3. Below that is a Open Mode pull down menu where you select how to open the
device (rw, ro, wo, append).
4. ITDT opens the device you selected.
Close
When you select the Close command:
1. ITDT checks if the device is already closed.
2. ITDT closes the device.

Inquiry
When you select the Inquiry command:
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.
Test Unit Ready

When you select the Test Unit Ready (TUR) command, ITDT issues the Test Unit
Ready ioctl command.
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
Query Driver Version

When you select the Query Driver Version command:
1. ITDT issues the required command to get driver version.
2. ITDT prints driver version.
Display All Paths

When you select the Display All Paths command:
1. ITDT issues an ioctl command.
2. ITDT outputs decoded path information for all paths.

Rewind
When you select the Rewind command, ITDT issues the ioctl rewind command for
the device.
Forward Space Filemarks

When you select the Forward Space Filemarks command:
1. Enter the amount of Filemarks to Forward Space, in the Filemark-Count box.
3. The tape is positioned on the first block of the next file.
Backward Space Filemarks

When you select the Backward Space Filemarks command:
1. Enter the amount of Filemarks to Backward Space, in the Filemark-Count box.
3. The tape is positioned on the last block of the previous file.
Forward Space Records

When you select the Forward Space Records command:
1. Enter the amount of Records to Forward Space, in the Record-Count box.
Backward Space Records

When you select the Backward Space Records command:
1. Enter the amount of Records to Backward Space, in the Record-Count box.
Space to End of Data

When you select the Space to End of Data (EOD) command, ITDT issues the
(extrinsic) ioctl command.
Read and Write Tests

When you select the Read and Write Tests command, ITDT performs the following
functions (Read and Write Test, Read Only Test, and Write Only Test). There are
three parameter fields to fill out that have default values already in them. Next
there will be a Test pull down menu which will give you the option of "Read Data
from Tape, Write Data to Tape, and Read/Write/Verify". Once this is done, the
following steps below are followed depending on which test is selected.
v The following steps are the Read/Write steps:
1. Issues a Read Position.
2. Sets block size.
3. Generates special pattern.
4. Puts block id in bytes 0-3 of each block.
5. Prints current block number, number of bytes and blocks.
6. Issues write command.
7. Prints updated statistics.
8. If number of bytes written is different from requested bytes to write, stop
(go to Step 19 on page 310).

9. Writes two filemarks.

10. Backward spaces two filemarks.
11. Backward spaces number of records written.
12. Prints amount of data to read.
13. Issues read command.
14. If read error occurred or number of bytes read is different from requested
number of bytes to read, go to Step 19.
15. Compares data read with data written, show miscompares and if
miscompares exist, stop (go to Step 19).
16. If compare is Ok, print ok message.
17. Forward space one file mark.
18. Repeat Steps 10 to 24 until all blocks are written.
- OR -
Go to Step 4 on page 309 until all blocks are written.
19. Prints current block id and total number of bytes written.
v The following are the Read Only steps:
2. Sets block size.
4. Print amount of data to read.
number of bytes to read, stop (go to Step 19).
7. Compares data read with buffer data, show miscompares and if
- OR -
Go to Step 4 until all blocks are written.
10. Prints current block id and total number of bytes read.
11. Backward spaces number of records written.
12. Prints amount of data to read.
number of bytes to read, go to Step 19.
15. Compares data read with data written, show miscompares and if
17. Forward space one file mark.
- OR -
19. Prints current block id and total number of bytes written.
v The following are the Write Only steps:
2. Sets block size.


4. Put block id in bytes 0-3 of each block.
5. Prints current block number, number of bytes and blocks.
6. Issues write command.
7. Prints updated statistics.
8. If number of bytes written is different from requested bytes to write, stop
(go to Step 10).
- OR -
10. Print current block id and total number of bytes written.
Read or Write Files

When Read or Write Files is selected, there will be a box under File Name: in
which the path and name of the file will be entered. Under that there is a box
named Number of records to read (0 for entire file). The default that shows up in
the box is 100. Next a pull down menu bar under Test: that gives you the choice of
Read File from Tape or Write File to Tape. Once the Test is selected a Browse
button appears next to the File Name box to allow browsing for the desired file.
When you select the Read or Write Files command, ITDT performs the following
functions:
v The following steps are the Read steps:
1. Prompts if to read a file from tape
2. You are prompted for destination file name
3. You are prompted for number of records to read (If you just press Enter, the
entire file is read.)
4. Prints the file name to be opened
5. Opens the file (r/w with large file support, 666 umask)
6. Issues Query Parameters ioctl command, if it fails, quit
7. Sets blocksize to maximum possible, variable blocksize mode
8. Calculates the number of blocks to read.
9. Prints number of records to read.
10. ITDT read from tape.
11. Writes to file, stop if data count is not equal to data count requested.
12. If more data to read, go to Step 10.
13. Prints statistics.
v The following steps are the Write steps:
1. Prompts if to write a file to tape.
2. You are prompted for the source file name.
3. Prints the file name to be opened.
4. Opens the file (r/o with large file support).
5. Issues Query Parameters ioctl command, if it fails, quits.
6. Sets blocksize to maximum possible, variable blocksize mode
7. Prints write statement.
8. Reads from file.
9. Writes to tape, stop if data count written is not equal to data count
requested.

10. Prints statistics.
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:
2. The tape will rewind and then unload.
Write Filemarks
When you select the Write Filemarks command:
1. In the Filemark-Count box, enter the number of filemarks to write.
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 displays changeable parameters.
Note: The list of changeable parameters are operating system specific.

2. Select from the list of parameters that can be changed by clicking on the choice.
3. ITDT requests prompt for parameter value (if required).
4. ITDT requests safety prompt (if required).
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 just
displays the current position and queries for the one to set, then sets
the new position.
2. Enter the block id for where the tape should go to. This must be entered in
decimal. When the tape is being set the block id will be printed out in decimal
with hexadecimal in parentheses.
3. ITDT issues the Set Position ioctl and return 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.
7. You are prompted for position to set (logical or physical) or to stop.
8. You are prompted for block id in decimal or hexadecimal.

9. ITDT prints summary.

10. ITDT issues the Set Position ioctl command.
11. Repeat steps 2 through 5.
Query Encryption Status

When you select the Query Encryption Status command:
1. ITDT issues Get Encryption State ioctl command.
2. ITDT displays encryption settings (Drive EC, Encryption Method, Encryption
state).
Display Message
When you select the Display Message command:
1. ITDT provides to Parameter boxes in which you can enter 1 or 2 messages up
to 8 characters or less.
Note: Display message only works on drives that have a display panel. These
currently are the 3590 and the 3592 drives.
2. In the Type: pull down menu select which message (0 or 1) you want
displayed and if you want it to flash. There is also an alternate (alt) selection
which will alternate between messages.
4. ITDT prints message to display.
Report Density Support

When you select the Report Density Support command:
1. ITDT prints report status text for all supported media.
2. ITDT issues Report Density Support ioctl command to retrieve all supported
media.
3. ITDT prints all requested reports. Data is printed in a decoded way. Scroll the
screen to print each one of the following:
v Density name
v Assigning organization
v Description
v Primary density code
v Secondary density code
v Write OK
v Duplicate
v Default
v Bits per MM
v Media Width
v Tracks
v Capacity (megabytes).
4. ITDT prints report status text for current media.
5. ITDT issues Report Density Support ioctl command to retrieve current media.
6. ITDT prints report data in a decoded way.

Test Encryption Path

When you select the Test Encryption Path command:
Note: Not supported for the HP-UX operating system.

1. ITDT prints status message that server configuration and connections are
tested.
2. ITDT issues the Encryption Diagnostics ioctl command, Ping Diag.
3. ITDT prints number of servers available or error message.
4. ITDT issues the Encryption Diagnostics ioctl command, Basic Encryption Diag.
6. ITDT issues the Encryption Diagnostics ioctl command, Full Encryption Diag.
Element Information
When you select the Element Information command:
2. ITDT displays number of robots, first robot address, number of slots, first slot
address, number of i/e elements, first element address, number of drives, first
drive address.
Position to Element
When you select the Position to Element command:
1. In the Parameter boxes the Transport element address needs to be put in, in
decimal (picker).
2. Insert the Destination element address in decimal.
Element Inventory
When you select the Element Inventory command:
2. ITDT issues the Element Inventory ioctl command.
3. ITDT displays decoded element inventory information.
Exchange Medium
When you select the Exchange Medium command:
1. Insert source address into the Source address box in Decimal.
2. Insert the first destination address in decimal in the "First destination address"
box.
3. Insert the second destination address in decimal in the "Second destination
address" box.
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.
Initialize Element Status

When you select the Initialize Element Status command:
2. ITDT prints command summary.
Prevent/Allow Medium Removal

When you select the Prevent/Allow Medium Removal command:
1. Use the pull down menu to either prevent or allow.
Initialize Element Status Range

When you select the Initialize Element Status Range command:
1. Insert the first slot address in decimal in the provided box.
2. Insert the number of slots in the provided box.
Read Device IDs

When you select the Read Device IDs command:
2. If no drive is present, ITDT prints NO DRIVE PRESENT - and exits.
3. ITDT prints information for all drives.
Read Cartridge Location

When you select the Read Cartridge Location command:
1. You are prompted for address of the first element.
2. If address is zero, print error message and exit.
3. You are prompted for number of elements.
4. If number of elements is zero, print error message and exit.
6. ITDT verifies that the address range is valid, otherwise print error message and
exit.
7. If no slots are found in Element Info data; print error message and exit.
9. ITDT prints decoded storage element information.
Dump/Force Dump/Dump
When you select the Dump/Force Dump/Dump command:
1. ITDT retrieves dump.
2. ITDT issues Force Dump command.
3. ITDT retrieves second dump.
4. ITDT displays 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 performs firmware update and displays progress status and result.
The following site is available for the latest firmware files: http://www.ibm.com/
storage/lto.

Appendix A. Accessing Documentation and Software Online
IBM maintains the latest levels of System Storage tape drive and library device
drivers and documentation on the Internet. Obtain them by accessing the following
URL: http://www.ibm.com/support/fixcentral.
This is a portal to enter our download area. There are a few pull down menus to
get you to the correct download as follows:
1. In the Product Group pull down menu select "Storage Systems".
2. In the Product Family pull down menu that appears select "Storage Software".
3. With the Product Type pull down menu that appears select "Archive
Management".
4. In the Product pull down menu that appears select "Multilevel Grid Access
Manager Software".
5. This will in turn bring up the Installed Version pull down menu. This menu
allows you to select the installed version number or "All".
6. In the Platform pull down menu that appears select "SLES 10" or "All"..
| For details on supported tape attachment please refer to the System Storage
| Interoperation Center website: http://www.ibm.com/systems/support/storage/
| config/ssic/.
Platform Driver Downloads: To download your driver, select the correct operating
system. Two more pull down menus will appear with information already in them.
Click Continue. The next screen allows you to narrow the search if you need to,
however just clicking "Continue" will allow you to look at what is available.
The latest driver will have the highest number extension. There are numeric
| sequence numbers in each level of device and library driver, that is, for AIX it
| would be Atape.11.7.5.0.bin. As newer levels of a driver are released, a higher
numeric sequence is assigned. When downloading a driver, ITDT will also be
available to download as a tool at the same time. If you use the XXXX download
then ITDT will automatically be downloaded at the same time. There is also a link
that can be followed to the programming reference which is in a PDF format that
can be downloaded.
Information concerning supported fibre channel host bus adapters (HBAs) and
associated HBA device drivers, firmware and BIOS levels can be obtained from the
following URL: http://www-03.ibm.com/systems/support/storage/config/hba/
index.wss
The IBM_Tape_Driver_IUG.pdf file contains the current version of the IBM Tape
Device Drivers: Installation and User’s Guide which can be found at:
http://www-01.ibm.com/support/docview.wss?rs=577&uid=ssg1S7002972.
The IBM_Tape_Driver_PROGREF.pdf file contains the current version of the IBM

Tape Device Drivers: Programming Reference which can be found at:
http://www-01.ibm.com/support/docview.wss?rs=577&uid=ssg1S7003032..
| For the most-current information for the device driver you are using, consult the
| README file (not files) included in the download of your device driver.

Accessing Documentation and Software Online
Table 30 documents each driver by name and description:

Table 30. Driver Descriptions
Driver Description
AIX
Atape.n.n.n.n.bin AIX Device Driver (Atape)
atldd.n.n.n.n.bin AIX 3494 Enterprise Tape Library
Driver
HPUX
.../atdd.n.n.n.n.bin HP-UX Device Driver
lmcpd/lmcpd.hpux.n.n.n.n.bin HP-UX 3494 Enterprise Library
Driver
Linux
/ibmatl/ibmatl.n.n.n.n.arch.rpm.bin Linux 3494 Enterprise Library Driver
/lin_tape_source-lin_taped/lin_tape-x.x.x.x-x.src.rpm.bin Linux Device Driver (lin_tape) source
code
/lin_tape_source-lin_taped/lin_taped-x.x.x-dist.arch.rpm.bin Linux lin_taped daemon program
Solaris
/IBMtape.n.n.n.n.bin Solaris Device Driver (IBMtape)
/lmcpd.n.n.n.n.bin Solaris 3494 Enterprise Library Driver
Windows
| /ibmalt.n.n.n.n.arch.exe Windows 3494 Enterprise Library
Driver
| /IBMTape.arch_nnnn.zip Windows Server 2003 Driver on arch
(x86. i64, x64)
| /IBMTape.arch_w08_nnnn.zip Windows Server 2008 Driver on arch
(x86, x64)
Notes:
| 1. Valid for Windows 2008 and Windows 2008 r2
2. dist indicates a Linux distribution. arch indicates a machine architecture (for example, i386, ia64, s390).
3. The n.n.n. or n.n.n.n strings are replaced with digits to reflect the version of each driver.

Appendix B. Verifying Proper Attachment of Your Devices
Before you start to use your devices for production work with your applications,
or if you encounter difficulties with your devices, you may want to verify that the
hardware, connections, and device drivers are working together properly. Before
you can do this, you must do the following:
1. Install your hardware as indicated in the appropriate hardware manuals.
2. Power On your hardware and verify that the hardware is functioning properly
by executing commands from the front panel.
3. Attach your hardware to the host system as indicated in the appropriate
hardware manuals and as indicated in the appropriate chapters from this
manual.
4. Start your operating system as indicated in the appropriate chapters from this
manual.
5. Log into the operating system as Administrator.
6. If there are device drivers being used by your device other than the ones
documented in this manual, disable the other device drivers, and install or
enable the drivers documented in this manual.
| 7. Start ITDT (for instructions see “Standard Edition - Initial Startup” on page
| 240)
| 8. Scan for devices. Any devices that show up are properly attached.

Verifying Proper Attachment of Your Devices

Appendix C. Managing the Microcode on the IBM Tape Drive
Microcode is computer software that is stored in nonvolatile storage on your tape
device or library hardware. It controls the operation of your hardware. When your
tape device or library hardware was manufactured, a microcode load was installed
and shipped with your device.
If you are having trouble with your hardware, IBM service personnel will ask what
level of microcode you have on your hardware. If they believe you need a new
level of microcode, they may instruct you to install a newer level of microcode on
your hardware. They will 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 four digits of the current level of microcode using software,
refer to Chapter 9, “IBM Tape Diagnostic Tool (ITDT),” on page 231. The unit must
be powered On, configured properly, and ready. For additional information, refer
to the appropriate chapter in this document (based on the operating
system/platform) for details on how to have the device ready.
The following instructions are a guide to install another version of microcode on a

tape drive:
1. Ensure that the tape drive is connected to a host system and that the tape
device driver is powered-On and configured properly with no tape cartridge in
the drive. Follow the instructions in Appendix B, “Verifying Proper Attachment
of Your Devices,” on page 319 to ensure that the drive is configured properly
and ready.
| 2. Open ITDT and follow the instructions for downloading microcode. These are
| in both the SE and the GE versions. In SE it is available in all sections, scan
| menu under Firmware update, the tape utility (71) section and the scripting
| (ucode) command.

Managing Microcode on the IBM Tape Drive

Notices
References in this publication to IBM products, programs, or services do not imply
that IBM intends to make these available in all countries (or regions) in which IBM
operates.
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 can send license inquiries, in writing, to:
IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
The following paragraph does not apply to the United Kingdom or any other
country (or region) where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS

PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS
FOR A PARTICULAR PURPOSE. Some states (or regions) do not allow disclaimer
of express or implied warranties in certain transactions, therefore, this statement
may not apply to you.
This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes are
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or program(s) described in this publication
at any time without notice.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
The ITDT-SE and ITDT-GE software uses Henry Spencer's regular expression
library that is subject to the following copyright notice:
"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 may not be removed or altered."
Trademarks
The following terms are trademarks of International Business Machines
Corporation in the United States, other countries (or regions), or both:
AIX IBMLink RS/6000 System z

AIX 5L Magstar S/390 Tivoli
FICON Micro Channel StorageSmart TotalStorage
HyperFactor Netfinity System i® Virtualization Engine
i5/OS POWER5 System p xSeries
iSeries ProtecTIER System Storage z9
IBM pSeries System x zSeries
Adobe and Acrobat are either registered trademarks or trademarks of Adobe

Systems Incorporated in the United States, and/or other countries.
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 Sun Microsystems, Inc. in the
United States, other countries, or both.
Linux is a registered trademark of Linus Torvalds 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.

Index
Numerics AIX (continued)
Problem Determination (continued)
AIX (Atape) (continued)
3494 Enterprise Tape Library Driver error labels 44 (continued)
Library Driver Information 189 error log templates 44 data path 50
driver message queue 190 error logging 43 Tape Drive, Media, and Device Driver
Library Manager event trace facility 46 Parameters 26
notification 189 Special Files 33 AIX 3494 Enterprise Tape Library
operation complete Special Files for 3490E, 3590, Installation Instructions 197
notification 190 Magstar MP, or 7332 tape Configuring Library Manager
software interface 189 devices 33 Control Point 199
synchronous and asynchronous Special Files for 3575, 7331, 7334, configuring the 3490E or
operations 190 7336, or 7337 medium changer Enterprise Tape System 3590 tape
TotalStorage Virtual Tape Server devices 34 drive 198
Subsystem Attachment 191 System-Managed Encryption 40 configuring the serial port 197
unsolicited notification 190 Tape Drive Service Aids 47 Connecting the TotalStorage
volume categories 190 create an FMR tape 49 Enterprise Tape Library 197
3494 Enterprise Tape Library Support Detailed Description 47 deconfiguring the Library Manager
mtlib command 178 error log analysis 49 Control Point 203
Programs force microcode dump 47 defining tape libraries to the
MTEVENT program 189 microcode load 48 daemon 198
MTLIB 178 read dump 48 installation procedure 197
Tape Library Support Programs 177 reset drive 49 loading the daemon 202
Tape Drive, Media, and Device Driver uninstall procedure 203
Parameters Problem Determination 203
A alternate pathing 27 daemon trace facility 204
about data encryption 14 autoloading 27 device driver trace facility 204
AIX 40 block size 29 error logging 204
Device and Volume Information buffered mode 29 Product Requirements
Logging 42 capacity scaling 32 data flow 196
log file 42 compression 29 hardware requirements 197
tape log utility 43 configuration parameters 27 software requirements 197
Installation and Configuration emulate autoloader 28 Special Files 203
Instructions fail degraded media 29 AIX 3494 Enterprise Tape Library Driver
deconfiguring the 3490E, 3590, logging 29 Library Driver Information
Magstar MP, or 7332 tape logical write protect 32 TotalStorage Virtual Tape Server
device 26 maximum size of log file 29 Subsystem Attachment 196
deconfiguring the 3575, 7331, 7334, media parameters 31 AIX device parameters 50
7336, or 7337 medium changer new logical name 30 AIX System testing
device 26 read error recovery time 30 3494 Enterprise tape library
installation procedure 25 record space mode 30 attachment test 203
preinstallation considerations 25 rewind immediate 31 AIX System-Managed Encryption
uninstall procedure 26 trailer labels 31 System-Managed Encryption 40
Multiple HBA and Multi-Port volume ID for logging 33 Application-Managed Tape
Devices 10 Using Dump Support 41 Encryption 14
path failover and Failover Support dump device commands 41 Application-Managed Tape Encryption
configuring and unconfiguring AIX (Atape) Setup Tasks 15
primary and alternate Installation and Configuration
devices 40 Instructions 24
querying primary and alternate configuring tape and medium
changer devices 25
B
path configuration 39 bulk rekey 19
path failover Support 38 Installation Procedure 25
primary and alternate paths 39 Introduction and Product
Path Failover Support Requirements 21
configuring and unconfiguring Data Flow 22 C
path failover support 38 Hardware Requirements 22 Checklist 15
Persistent Naming Support 35 Product Requirements 9, 22 Comments xiv
Problem Determination 41 Purpose 9, 21 configuration 16, 41
ATRC utility 46 Software Requirements 24 connectivity 41
automatic dump facility for 3590 Performance Considerations 49
and Magstar MP tape drives 46 Before Calling Support 51
detail data 44 common utilities 50

D HP-UX (ATDD) (continued)
Installation and Configuration for PCI
HP-UX 3494 Enterprise Tape Library
Driver (continued)
Data Path Failover 9 Drivers (continued) Installation Instructions (continued)
device driver configuration 40 create hardware path entry 58 connecting the TotalStorage
device drivers determine device hardware path Enterprise tape library 209
Attachment to open systems for IBM tape drives 58 copy software to depot 208
servers 1 install driver manually 60 defining the library device to
Device drivers install the ATDD software 60 lmcpd 209
Attachment to open systems servers Overview of the Installation install manually 208
3490E tape subsystem 8 Process 56 install the product 208
7331, 7334, 7336, or 7337 tape power off tape drives 59 installation overview 207
medium changer 8 Preinstallation considerations 57 other administrative tasks 210
Magstar MP 3570 7 Installation and Configuration for uninstall procedure 210
Magstar MP 3575 tape library 8 Precision Bus Drivers 64 Problem Determination 211
drive dump 41 adding a tape device using daemon trace facility 211
currently installed ATDD 72 error logging 211
copy software to software HP-UX System testing
E depot 70 3494 Enterprise tape library
EKM server logs 41 create configuration file 65 attachment test 210
emulation 193 create device-specific configuration
Encryption 9 entries (optional) 69
encryption key manage configuration create hardware path entry 69
determine device hardware path
I
file 16 Introduction 1
error logging 41 for 3590 65
ITDT
Accessing 234
for Magstar MP 3570 tape
Introduction and Product
F subsystem 66
Requirements
failover 18 Purpose 232
for Magstar MP 3575 tape
field support 41 Purpose 232
libraries 67
install the ATDD software 71
other administrative tasks 73
G power off tape drives 70 L
general information 14 Preinstallation Considerations 64 library requirements 14
review ATDD README file 71 Library-Managed Tape Encryption 15
Persistent Naming Support 78 libsmc extension 193
H Product Requirements 53
ATDD implementation 54
Linux 111
System-Managed Encryption 111
HP-UX data flow 53 Linux (lin_tape)
Installation and Configuration hardware requirements 54 Installation and Configuration
Instructions 56 software interface to device Instructions 94
HP-UX (ATDD) driver 56 components created during
Configuration Parameter software requirements 55 installation 94
Definitions 73 Special Files 77 Configuring Tape and Medium
device-specific parameters 73 Supported Configurations 73 Changer Devices 96
driver-specific parameters 75 modifying configuration conventions used 94
Install, Uninstall, and Configuration parameters 75 installation procedure 95
create hardware path entry 69 Troubleshooting 83 querying installed package 96
determine drive hardware path for Atdd_d log daemon 86 uninstall procedure 99
3581 68 error logging 83 update procedure 96
determine drive hardware paths Problems and Solutions 87 Introduction and Product
for 3580 and 3583 with fibre Support_info script 84 Requirements 91
channel attachment 68 tracing facility 84 Product Requirements
determine drive hardware paths HP-UX 3494 Enterprise Tape Library Data Flow 91
for 3583/3584 Tape Libraries Product Requirements hardware requirements 92, 93
with SCSI attachment 68 Compatibility 206 software requirements 93, 94
Installation and Configuration for data flow 205 Special Files 104
DLKM PCI Drivers 56 hardware requirements 206 Special Files for medium changer
Installation and Configuration for PCI software compatibility 207 device 104
Drivers 60 software requirements 206 Special Files for tape device 104
command sequence HP-UX 3494 Enterprise Tape Library Tape Drive, Media, and Device Driver
information 57 Driver Parameters 99
copy software to software Installation Instructions 207 changeable parameters 101
depot 60 adding or deleting entries in the configuration parameters 99
create device-specific configuration library device 210 nonchangeable parameters 100
entries (optional) 59 command sequence Linux 3494 Enterprise Tape Library
create drive configuration file, if information 207 Installation Instructions 214
required 58

Linux 3494 Enterprise Tape Library Related Information (continued) Solaris (IBMtape) (continued)
(continued) 3592 Tape System ix functional verification 156
adding or deleting entries in the Additional Information xiv problem determination 156
library device 216 AIX xi setting the IBM_trace level 160
connecting TotalStorage Enterprise HP-UX xi tracing facility 158
3494 tape library 214 IBM 7331 8mm Tape Library xiii Special Files 145
defining the library device to IBM 7332 4mm DDS-2 Tape Cartridge device behaviors 146
atldd 215 Autoloader xiii file naming conventions 148
installation procedure 214 IBM 7332 Model 220 External 4mm Solaris 3494 Enterprise Tape Library
uninstall procedure 216 Tape Autoloader xiii Installation Instructions 220
Problem Determination 217 IBM 7334 8mm Tape Library xiii adding or deleting entries in the
daemon trace facility 217 IBM 7336 4mm Tape Library xiii library 222
error logging 217 IBM TotalStorage Enterprise Tape configuring the serial port 221
Product Requirements System 3590 xiii connecting the Enterprise tape
data flow 212 IBM TotalStorage UltraScalable Tape library 221
hardware requirements 213 Library 3584 x defining the symbolic name to the
software requirements 213 IBM TotalStorage Ultrium External lmcpd 221
Linux Enterprise Tape Drive 3580 xi preinstallation considerations 220
Installation Instructions IBM TotalStorage Ultrium Scalable uninstall procedure 223
querying the installed Tape Library 3583 xii Problem Determination 223
package 216 IBM TotalStorage Ultrium Tape daemon trace facility 223
updating procedure 216 Autoloader 3581 xi error logging 223
verifying the install/update 216 IBM TotalStorage Ultrium Tape Product Requirements
Linux System-Managed Encryption Library 3582 xii data flow 218
System-Managed Encryption 111 Linux xi hardware requirements 219
Linux verification testing Magstar MP 3570 Tape Subsystem xii software compatibility 220
3494 Enterprise tape library Magstar MP 3575 Tape Subsystem xii software requirements 220
attachment test 217 Microsoft Windows xi Solaris System testing
SGI (Silicon Graphics) xiv 3494 Enterprise tape library
Solaris xi attachment test 223
M TotalStorage Enterprise Automated
Tape Library 3494 xii
Solaris System-Managed Encryption
managing encryption 14
Tru64 xiv StorageSmart by IBM Ultrium device
Managing Microcode on the Tape
requirements drivers
Drive 321
library 14 Attachment to open systems servers
Microsoft Windows System testing
tape 14 Ultrium Products 7
3494 Enterprise tape library
Supported Hardware 9
attachment test 230
System-Managed Encryption 40, 111,
S 154, 172
system-managed encryption
N sample configuration file 16
sense data 41
configuration 16
Notices 323 System-Managed Tape Encryption 15
server logs 41
SMIT panels 40
Solaris 154
O System-Managed Encryption 154 T
Online access 317 Solaris (IBMtape) testing data encryption configuration 41
Installation and Configuration timeout value 18
Instructions 124 TotalStorage device drivers
P Adding or Removing Devices 143
installing and updating
Attachment to open systems servers
3494 Tape Library 7
Path Failover 9
IBMtape 126 3590 TotalStorage tape drive 7
Automatic Failover 10
preventing conflicts with other Virtual Tape Server 7
Load Balancing 9
device drivers 125 Trademarks 324
path failover support
removing IBMtape 143
library control path failover 79
Installation, Removal, and
Configuration
Configuration Parameters 139
U
Q preinstallation considerations 125
Ultrium device drivers
Attachment to open systems servers
querying drive configuration 40 Introduction and Product
3580 Ultrium Tape Drive 6
Requirements 121
3581 Ultrium Tape 2U
Persistent Naming Support 149
Autoloader 6
R Product Requirements and
Compatibility 122
3581 Ultrium Tape Autoloader 6
Related Information ix 3582 Ultrium Tape Library 6
Data Flow 121
3447 and 7337 Digital Linear Tape 3583 Ultrium Scalable Tape
hardware requirements 122
Library xiii Library 6
software requirements 124
3490E Tape Subsystem xii 3584 UltraScalable Tape Library 5
Service and Diagnostic Aids 155
Index 327
V
Verifying device attachment 319
W
Windows 172
Windows 3494 Enterprise Tape Library
Installation Instructions 226
adding or deleting library on the
service 228
connecting the 3494 Enterprise
tape library 227
defining the symbolic name to the
service 228
installation procedure 226
uninstall procedure 229
daemon trace facility 230
data flow 224
hardware requirements 225
Device Driver Management 165
disable procedure 168
installation overview 165
installation procedures 166
removal procedure 168
uninstalling the device
drivers 169
Introduction and Product
Requirements 163
Windows NT
Installation and Configuration
Instructions
Adding or Removing Devices 165

Readers’ Comments — We'd Like to Hear from You
Publication No. GC27-2130-09
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:
Thank you for your support.

Send your comments to the address on the reverse side of this form.
If you would like a response from IBM, please fill in the following information:
Name Address
Company or Organization
Phone No. E-mail address

___________________________________________________________________________________________________
Readers’ Comments — We'd Like to Hear from You Cut or Fold
GC27-2130-09 Along Line
_ _ _ _ _ _ _Fold
_ _ _and
_ _ _Tape
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Please
_ _ _ _ _do
_ _not
_ _ staple
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Fold
_ _ _and
_ _ Tape
______
NO POSTAGE
NECESSARY
IF MAILED IN THE
UNITED STATES
BUSINESS REPLY MAIL

FIRST-CLASS MAIL PERMIT NO. 40 ARMONK, NEW YORK
POSTAGE WILL BE PAID BY ADDRESSEE
International Business Machines Corporation

Information Development
Department GZW
9000 South Rita Road
Tucson, Arizona 85775-4401
_________________________________________________________________________________________
Fold and Tape Please do not staple Fold and Tape
Cut or Fold
GC27-2130-09 Along Line

Printed in USA
GC27-2130-09
Spine information:
IBM Tape Device Drivers IBM Tape Device Drivers Installation and User’s Guide

IBM Tape Device Drivers

Uploaded by

Copyright:

Available Formats

IBM Tape Device Drivers

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IBM Tape Device Drivers

Uploaded by

Copyright:

Available Formats

What are tape drives and libraries discussed in the document?

What are tape drives and libraries discussed in the document?

What are some common extended features supported?

What are some common extended features supported?

IBM Tape Device Drivers

Installation and User’s Guide

Installation and User’s Guide

Tenth Edition (March 2010)

© Copyright IBM Corp. 2007, 2010 iii

iv IBM Tape Device Drivers Installation and User’s Guide

© Copyright IBM Corp. 2007, 2010 v

© Copyright IBM Corp. 2007, 2010 vii

IBM Tape Device Drivers: Programming Reference, GA32-0566.

IBM System Storage TS1120 Tape Drive

IBM Ultrium Tape Drive Models T800 and T800F

IBM LTO Ultrium 3-H Tape Drive

IBM System Storage TS2230 Tape Drive

© Copyright IBM Corp. 2007, 2010 ix

IBM TotalStorage 3580 Tape Drive Models L33/L3H

IBM System Storage TS2340 Tape Drive

IBM System Storage TS3500 Tape Library (also known as IBM

IBM Virtualization Engine TS7520

IBM System Storage TS3400 Tape Library

IBM System Storage TS3310 Tape Library

IBM System Storage TS3100 Tape Library

x IBM Tape Device Drivers Installation and User’s Guide

IBM TotalStorage Ultrium Tape Autoloader 3581

IBM TotalStorage 3581 Tape Autoloader (also known as IBM

IBM TotalStorage 3583 Tape Library (also known as IBM

IBM Virtualization Engine TS7510

IBM TotalStorage Enterprise Automated Tape Library 3494

IBM 3490E Tape Subsystem

IBM Magstar MP 3570 Tape Subsystem

IBM Magstar MP 3575 Tape Subsystem

xii IBM Tape Device Drivers Installation and User’s Guide

IBM TotalStorage Enterprise Tape System 3590

IBM 7331 8mm Tape Library

IBM 7332 4mm DDS-2 Tape Cartridge Autoloader

IBM 7332 Model 220 External 4mm Tape Autoloader

IBM 7334 8mm Tape Library

IBM 7336 4mm Tape Library

IBM 3447 and 7337 Digital Linear Tape Library

How to Send Your Comments

xiv IBM Tape Device Drivers Installation and User’s Guide

Important printer note

This area indicates the Ignore the page number

IBM Tape Products

© Copyright IBM Corp. 2007, 2010 1

1 Open Systems Server 7 IBM TS3200 Tape Library

Figure 2 on page 3 illustrates an Ultrium environment that could include an IBM

2 IBM Tape Device Drivers Installation and User’s Guide

Figure 2. Example of an IBM Tape Environment

IBM Virtualization Engine TS7520

IBM Virtualization Engine TS7650

IBM System Storage TS2230/TS2240/TS2250 Tape Drive

IBM System Storage TS2340/TS2350 Tape Drive

IBM TotalStorage 3580 (Ultrium) Tape Drive (Models L33 and

4 IBM Tape Device Drivers Installation and User’s Guide

IBM System Storage TS1120/TS1130 Tape Drive (Enterprise)

IBM System Storage TS3200 Tape Library