IBM Tape Driver IUG 1

457
IBM Tape Device Drivers Installation and User’s Guide GC27-2130-08

Transcript of IBM Tape Driver IUG 1

Page 1: IBM Tape Driver IUG 1

IBM Tape Device Drivers

Installation and User’s Guide

GC27-2130-08

���

Page 2: IBM Tape Driver IUG 1
Page 3: IBM Tape Driver IUG 1

IBM Tape Device Drivers

Installation and User’s Guide

GC27-2130-08

���

Page 4: IBM Tape Driver IUG 1

Note!Before using this information and the product that it supports, be sure to read the general information under “Notices” onpage 427.

Ninth Edition (August 2009)

This ninth edition of the IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-08, replaces and makesobsolete the following manuals:v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-07

v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-06

v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-05

v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-04

v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-03

v IBM Tape Device Drivers Installation and User’s Guide, GC27-2130-02

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 International Business Machines Corporation 2007, 2009.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 5: IBM Tape Driver IUG 1

Contents

Figures . . . . . . . . . . . . . . . v

Tables . . . . . . . . . . . . . . . vii

Preface . . . . . . . . . . . . . . . ixRelated Information. . . . . . . . . . . . ixHow to Send Your Comments . . . . . . . . xivSpecial Printing Instructions . . . . . . . . . xv

Chapter 1. Introduction . . . . . . . . 1Purpose . . . . . . . . . . . . . . . . 1IBM Tape Products . . . . . . . . . . . . 1

Chapter 2. Common Extended Features 9Purpose . . . . . . . . . . . . . . . . 9Supported Hardware . . . . . . . . . . . 9Path Failover and Load Balancing . . . . . . . 12Dynamic Load Balancing . . . . . . . . . . 16Supported Devices and Feature Codes . . . . . 16Data Encryption . . . . . . . . . . . . . 17

Chapter 3. AIX Tape and MediumChanger Device Driver . . . . . . . . 23Purpose . . . . . . . . . . . . . . . 23Data Flow . . . . . . . . . . . . . . . 24Product Requirements . . . . . . . . . . . 24Installation and Configuration Instructions . . . . 26Tape Drive, Media, and Device Driver Parameters 28Special Files . . . . . . . . . . . . . . 34Persistent Naming Support . . . . . . . . . 36Control Path Failover Support for Tape Libraries . . 37Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 39System-Managed Encryption . . . . . . . . 41Problem Determination . . . . . . . . . . 43Tape Drive Service Aids . . . . . . . . . . 48Performance Considerations . . . . . . . . . 51

Chapter 4. HP-UX Tape and MediumChanger Device Driver . . . . . . . . 55Purpose . . . . . . . . . . . . . . . 55Data Flow . . . . . . . . . . . . . . . 55Product Requirements . . . . . . . . . . . 56Installation and Configuration Instructions . . . . 58Supported Configuration Parameters . . . . . . 75Special Files . . . . . . . . . . . . . . 79Persistent Naming Support . . . . . . . . . 80Control Path Failover Support for Tape Libraries . . 81Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 83Problem Determination . . . . . . . . . . 85

Chapter 5. Linux Tape and MediumChanger Device Driver . . . . . . . . 93Purpose . . . . . . . . . . . . . . . 93Data Flow . . . . . . . . . . . . . . . 93Product Requirements . . . . . . . . . . . 94Installation and Configuration Instructions . . . . 96Tape Drive, Media, and Device Driver Parameters 102Special Files . . . . . . . . . . . . . . 107Control Path Failover Support for Tape Libraries 108Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 110Open Source Device Driver - lin_tape . . . . . 112System-Managed Encryption . . . . . . . . 113Problem Determination . . . . . . . . . . 116

Chapter 6. Solaris Tape and MediumChanger Device Driver . . . . . . . 123Purpose . . . . . . . . . . . . . . . 123Data Flow . . . . . . . . . . . . . . 123Product Requirements . . . . . . . . . . 124Installation and Configuration Instructions . . . 126Special Files . . . . . . . . . . . . . . 145Persistent Naming Support . . . . . . . . . 148Control Path Failover Support for Libraries . . . 149Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 150System-Managed Encryption . . . . . . . . 153Problem Determination . . . . . . . . . . 155

Chapter 7. Windows Tape and MediumChanger Device Driver . . . . . . . 163Purpose . . . . . . . . . . . . . . . 163Data Flow . . . . . . . . . . . . . . 163Product Requirements . . . . . . . . . . 164Installation and Configuration Instructions . . . 165Persistent Naming Support on Windows Server2003 and Windows Server 2008 . . . . . . . 181Control Path Failover Support for Tape Libraries 182Data Path Failover Support for Tape Drives . . . 183System-Managed Encryption . . . . . . . . 184Problem Determination . . . . . . . . . . 185

Chapter 8. Tru64 Device Driver . . . . 189Purpose . . . . . . . . . . . . . . . 189Product Requirements . . . . . . . . . . 189

Chapter 9. 3494 Enterprise TapeLibrary Support . . . . . . . . . . 193Purpose . . . . . . . . . . . . . . . 193MTLIB Program . . . . . . . . . . . . 194MTEVENT Program . . . . . . . . . . . 205Library Driver Information . . . . . . . . . 2053494 Library Emulation . . . . . . . . . . 209AIX . . . . . . . . . . . . . . . . 212

© Copyright IBM Corp. 2007, 2009 iii

Page 6: IBM Tape Driver IUG 1

HP-UX . . . . . . . . . . . . . . . 221Linux . . . . . . . . . . . . . . . . 228Solaris . . . . . . . . . . . . . . . . 234Windows . . . . . . . . . . . . . . . 240TRU64. . . . . . . . . . . . . . . . 247SGI IRIX . . . . . . . . . . . . . . . 253

Chapter 10. IBM Tape Diagnostic Tool(ITDT). . . . . . . . . . . . . . . 259Purpose . . . . . . . . . . . . . . . 260Accessing ITDT . . . . . . . . . . . . 262Supported Systems . . . . . . . . . . . 262Supported Equipment . . . . . . . . . . 263Standard Edition - Installation . . . . . . . . 264Standard Edition - Initial Startup . . . . . . . 267Standard Edition - Known Issues and Limitations 270Standard Edition - Start Menu Commands . . . 274Standard Edition - Scan Menu Commands. . . . 274Standard Edition - Tapeutil Menu Commands . . 290Standard Edition - Tapeutil Scripting Commands 297Graphical Edition - Installation . . . . . . . 312Graphical Edition - Known Issues and Limitations 313Graphical Edition - User Interface Description . . 314Graphical Edition - Scan Menu Commands . . . 317Graphical Edition - Tapeutil Menu Commands . . 328

Appendix A. AccessingDocumentation and Software Online . 341

Appendix B. Verifying ProperAttachment of Your Devices . . . . . 343

AIX System . . . . . . . . . . . . . . 344HP-UX System . . . . . . . . . . . . . 346Linux System . . . . . . . . . . . . . 348Solaris System . . . . . . . . . . . . . 350Microsoft Windows System. . . . . . . . . 352Tru64 System . . . . . . . . . . . . . 354SGI/IRIX System . . . . . . . . . . . . 356

Appendix C. Managing the Microcodeon the IBM Tape Drive . . . . . . . 357AIX System . . . . . . . . . . . . . . 357HP-UX System . . . . . . . . . . . . . 358Linux System . . . . . . . . . . . . . 358Solaris System . . . . . . . . . . . . . 358Microsoft Windows System. . . . . . . . . 358Tru64 System . . . . . . . . . . . . . 359

Appendix D. Tape Utility Programs 361AIX System - Tape Utility Program (tapeutil) . . . 362HP-UX System - Tape Utility Program (tapeutil) 375Linux System - Tape Utility Program (IBMtapeutil) 385Solaris System - Tape Utility Program (tapeutil) 397Microsoft Windows System - Utility Program(ntutil). . . . . . . . . . . . . . . . 406Tru64 System - RAS Utility Program (IBMrasutil) 425

Notices . . . . . . . . . . . . . . 427Trademarks . . . . . . . . . . . . . . 428

Index . . . . . . . . . . . . . . . 429

iv IBM Tape Device Drivers Installation and User’s Guide

||

Page 7: IBM Tape Driver IUG 1

Figures

1. Current Attachment Array . . . . . . . . 22. Example of an IBM Tape Environment . . . . 33. Multiple HBA and multi-port devices . . . . 134. Multiple HBA and single ports . . . . . . 145. Single HBA and multi-port devices. . . . . 156. Sample Encryption Configuration File. . . . 207. Data Flow for AIX Device Driver (Atape) 248. Data Path for AIX Device Driver (Atape) 529. Data Flow for HP-UX Device Driver (ATDD) 56

10. Example of atdd_d.log Output . . . . . . 8911. Data Flow for Linux Device Driver (lin_tape) 9412. Data Flow for Solaris Device Driver

(IBMtape) . . . . . . . . . . . . . 12413. Example of Control Path Failover Support

Command Output . . . . . . . . . . 15014. Example of Data Path Failover Support

Command Output . . . . . . . . . . 15215. Data Flow for Windows Device Driver

(IBMmag) . . . . . . . . . . . . . 16316. Select Components Menu (using

IBMUltrium.WinNT.exe) . . . . . . . . 16717. Start Menu . . . . . . . . . . . . 16818. Creating Driver List . . . . . . . . . 16819. Rescanning for Tape Device . . . . . . . 16820. Install Driver Menu - Select Cancel . . . . 16921. Tape Devices Menu . . . . . . . . . 17022. Have Disk Menu . . . . . . . . . . 17123. Install Driver Menu . . . . . . . . . 17224. Windows NT Statement . . . . . . . . 17225. Tape Devices and Remove Driver Menu 17326. Control Panel Selection . . . . . . . . 17427. Add/Remove Programs Properties . . . . 17528. Drive Removal Menu . . . . . . . . . 17629. Manual Starting and Stopping Menu 17730. Installation Application in Windows Explorer 17931. Windows Logo Testing screen . . . . . . 18032. Checked folder . . . . . . . . . . . 18733. Example Output for Tru64 Device Driver and

IBM 3590 Tape Drive . . . . . . . . . 19134. Syntax Diagram for mtlib program . . . . 19435. Device Query . . . . . . . . . . . 19736. Volume Query . . . . . . . . . . . 19737. Expanded Volume Query . . . . . . . 19838. Expanded Volume Data with Usage . . . . 19839. Inventory Count Data. . . . . . . . . 19840. Tape Library Device Number . . . . . . 19941. Expanded Tape Library Device List . . . . 19942. Library Data . . . . . . . . . . . . 20043. Statistical Data . . . . . . . . . . . 20144. Inventory Query . . . . . . . . . . 20245. Category Inventory Query . . . . . . . 20346. Reserve Category Command . . . . . . 20447. Reserve Category List . . . . . . . . . 20448. Category Attribute List . . . . . . . . 20449. Library Address Information . . . . . . 20550. 3494/SMC Library Data Flow . . . . . . 209

51. LIBSMC and OS Components . . . . . . 21052. Data Flow for AIX 3494 Enterprise Tape

Library Driver . . . . . . . . . . . 21253. SMIT Main Menu . . . . . . . . . . 21654. SMIT Devices Menu . . . . . . . . . 21655. SMIT Tape Drive Menu . . . . . . . . 21756. Tape Drive Type Menu . . . . . . . . 21757. Add an LMCP Logical Device Menu 21758. LMCP COMMAND STATUS Window 21859. Configure an LMCP Selection List . . . . 21860. Configure a Defined LMCP COMMAND

STATUS Window . . . . . . . . . . 21861. Data Flow for HP-UX 3494 Enterprise Tape

Library Driver . . . . . . . . . . . 22262. Data Flow for Linux 3494 Enterprise Tape

Library Driver . . . . . . . . . . . 22963. Data Flow for Solaris 3494 Enterprise Tape

Library Driver . . . . . . . . . . . 23564. Data Flow for Windows 3494 Enterprise Tape

Library Driver . . . . . . . . . . . 24165. Data Flow for TRU 64 3494 Enterprise Tape

Library Driver . . . . . . . . . . . 24866. Data Flow for SGI IRIX 3494 Enterprise Tape

Library Driver . . . . . . . . . . . 25467. Welcome/Startup screen . . . . . . . . 26568. License screen . . . . . . . . . . . 26569. Machine credentials screen . . . . . . . 26670. Installation progress screen . . . . . . . 26671. Installation complete screen . . . . . . . 26772. Start Screen Menu . . . . . . . . . . 27473. Scan Menu . . . . . . . . . . . . 27574. More Scan Options. . . . . . . . . . 27575. Device List Screen . . . . . . . . . . 27676. Data Delete Question . . . . . . . . . 27877. Test Running. . . . . . . . . . . . 27878. Test Results . . . . . . . . . . . . 27979. Dump . . . . . . . . . . . . . . 28080. Firmware Update screen . . . . . . . . 28181. Scrollable Data screen . . . . . . . . . 28282. Encryption Start screen . . . . . . . . 28483. Full Write Results . . . . . . . . . . 28684. Tape Usage Screen . . . . . . . . . . 28785. System Test Results . . . . . . . . . 28886. Graphical Edition User Interface . . . . . 31487. Graphical Edition Preferences . . . . . . 31588. Graphical Edition Interface . . . . . . . 31689. Main Program Menu Items . . . . . . . 31690. Toolbar Buttons . . . . . . . . . . . 31791. Scan Function . . . . . . . . . . . 31892. Test Menu . . . . . . . . . . . . 31993. Test Results . . . . . . . . . . . . 32094. Dump Menu . . . . . . . . . . . . 32195. Dump Results . . . . . . . . . . . 32296. Encryption Function . . . . . . . . . 32397. Overwrite Data . . . . . . . . . . . 32598. Transfer Size . . . . . . . . . . . . 325

© Copyright IBM Corp. 2007, 2009 v

||||||||

Page 8: IBM Tape Driver IUG 1

99. Tape Usage . . . . . . . . . . . . 326100. System Test . . . . . . . . . . . . 327101. Tapeutil Control Center . . . . . . . . 328102. Tape Drive Commands . . . . . . . . 329103. Command Parameters . . . . . . . . 329

104. Command Parameter Results . . . . . . 330105. Linux Command Line Help Display . . . . 386106. Example of Base Mode . . . . . . . . 408107. Example of Library Mode . . . . . . . 409108. Symbolic Values . . . . . . . . . . 423

vi IBM Tape Device Drivers Installation and User’s Guide

||||||

||

Page 9: IBM Tape Driver IUG 1

Tables

1. Ultrium Product Comparison . . . . . . . 62. Supported Hardware by Operating System 93. Supported Devices and Feature Codes . . . 164. Interoperability between IPv4 and IPv6 Clients

and Servers . . . . . . . . . . . . 205. Feature Codes (Encryption) . . . . . . . 226. Special Files for Tape Devices . . . . . . 357. Special Files for Medium Changer Devices 358. Error Description . . . . . . . . . . 529. Device-Specific Parameter Definitions . . . . 76

10. Driver-Specific Parameters (Global) . . . . 7711. Special Files . . . . . . . . . . . . 7912. New Special Files in HP-UX 11i v3. . . . . 7913. Trace Flags . . . . . . . . . . . . . 8714. Problems, Reasons, and Solutions . . . . . 8915. Troubleshooting (Problems and Solutions) 9116. Components Created During lin_tape

Installation . . . . . . . . . . . . . 9717. Components Created During IBMtapeutil

Installation . . . . . . . . . . . . . 9718. Special Files for IBM TotalStorage Tape

Devices . . . . . . . . . . . . . 107

19. IBMtape and lin_tape Comparison . . . . 11220. SCSI Supported Devices . . . . . . . . 12521. IBMtape Components . . . . . . . . . 12622. IBMtape Install or Update . . . . . . . 12823. Solaris Device Driver - IBMtape - Equipment

Listing Example 1 . . . . . . . . . . 12924. Solaris Device Driver - IBMtape - Equipment

Listing Example 2 . . . . . . . . . . 13225. Solaris Device Driver - IBMtape - Equipment

Listing Example 3 . . . . . . . . . . 13226. Solaris Device Driver - IBMtape - Equipment

Listing Example 4 . . . . . . . . . . 13327. Configuration Parameters Recognized by

IBMtape . . . . . . . . . . . . . 14128. IBM SCSI Tape/Medium Changer Special

Files for Solaris . . . . . . . . . . . 14729. Tracing Facility . . . . . . . . . . . 15730. Definitions of Abort Codes . . . . . . . 28431. Supported Platforms . . . . . . . . . 30632. Driver Descriptions . . . . . . . . . 34233. Tape Utility Program Documentation 361

© Copyright IBM Corp. 2007, 2009 vii

||

Page 10: IBM Tape Driver IUG 1

viii IBM Tape Device Drivers Installation and User’s Guide

Page 11: IBM Tape Driver IUG 1

Preface

These publications and URLs provide user information and installation assistancefor IBM® tape drive, medium changer, and library device drivers.

Related InformationReference material, including the Adobe® PDF version of this publication, isavailable at the following ftp site:ftp://ftp.software.ibm.com/storage/devdrvr/Doc

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 PublicationsThe following publications relate to the IBM TotalStorage® Enterprise Tape System3592:v IBM TotalStorage Enterprise Tape System 3592 Operator Guide, GA32-0465v IBM TotalStorage Enterprise Tape System 3592 Introduction and Planning Guide,

GA32-0464v IBM TotalStorage Silo Compatible Tape Frame 3592 Introduction, Planning, and User’s

Guide, GA32-0463v IBM TotalStorage Enterprise Tape System 3592 Hardware Reference, GA32-0466

IBM System Storage TS1120 Tape DriveThe 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-0555v IBM System Storage TS1120 Tape Drive and Controller Operator Guide, GA32-0556v IBM System Storage TS3500 Tape Library Operator Guide, GA32-0560v IBM System Storage TS3500 Tape Library Introduction and Planning Guide,

GA32-0559v IBM System Storage 3953 Library Manager Model L05 Operator Guide, GA32-0558v IBM System Storage 3953 Tape System Introduction and Planning Guide, GA32-0557

IBM Ultrium Tape Drive Models T800 and T800FThe following publications relate to the IBM Ultrium Tape Drive Models T800 andT800F:v IBM Ultrium Tape Drive Models T800 and T800F Setup, Operator, and Service Guide,

GC26-7697

IBM LTO Ultrium 3-H Tape DriveThe 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

IBM System Storage TS2230 Tape DriveThe following publications relate to the IBM System Storage TS2230 Tape Drive:

© Copyright IBM Corp. 2007, 2009 ix

Page 12: IBM Tape Driver IUG 1

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/L3HThe following publications relate to the IBM TotalStorage 3580 Tape Drive ModelsL33/L3H:v IBM TotalStorage 3580 Tape Drive Models L33/L3H Setup, Operator, and Service

Guide, GC26-7708v IBM TotalStorage 3580 Tape Drive Models L33/L3H Quick Reference, GC26-7709

IBM System Storage TS2340 Tape DriveThe 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-2103v IBM System Storage TS2340 Tape Drive Models L43/S43 Quick Reference Card,

GC27-2104

IBM System Storage TS3500 Tape Library (also known as IBMTotalStorage 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-0408v IBM System Storage TS3500 Tape Library Maintenance Information, 19P2440

IBM Virtualization Engine TS7520The following publications relate to the IBM Virtualization Engine™ TS7520:v IBM Virtualization Engine TS7520 Hardware, Installation, Setup, and Problem

Determination Guide, GC26-7766-01v IBM Virtualization Engine TS7520 Introduction and Planning Guide, GC27-2067-00v IBM Virtualization Engine TS7500 User Guide, GC27-2068-00

IBM System Storage TS3400 Tape LibraryThe following publications relate to the IBM System Storage TS3400 Tape Library:v IBM System Storage TS3400 Tape Library Installation Quick Reference, GA32-0573v IBM System Storage TS3400 Tape Library Planning and Operator Guide, GC27-2107v IBM System Storage TS3400 Tape Library Maintenance Information, GA32-0572

IBM System Storage TS3310 Tape LibraryThe following publications relate to the IBM System Storage TS3310 Tape Library:v IBM System Storage TS3310 Tape Library Setup and Operator Guide, GA32-0477v IBM System Storage TS3310 Tape Library Maintenance Information, GA32-0478v IBM System Storage TS3310 Tape Library SCSI Reference, GA32-0476

IBM System Storage TS3100 Tape LibraryThe following publications relate to the IBM System Storage TS3100 Tape Library:v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Setup, Operator,

and Service Guide, GA32-0454v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Installation Quick

Reference, GA32-0456v IBM System Storage TS3100 Tape Library and TS3200 Tape Library SCSI Reference,

GA32-047

x IBM Tape Device Drivers Installation and User’s Guide

Page 13: IBM Tape Driver IUG 1

IBM System Storage TS3200 Tape LibraryThe following publications relate to the IBM System Storage TS3200 Tape Library:v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Setup, Operator,

and Service Guide, GA32-0454v IBM System Storage TS3100 Tape Library and TS3200 Tape Library Installation Quick

Reference, GA32-0456v IBM System Storage TS3100 Tape Library and TS3200 Tape Library SCSI Reference,

GA32-047

AIXThe following URL points to information about IBM System p® (also knownasERserver pSeries®) servers:

http://www-1.ibm.com/servers/eserver/pseries

HP-UXThe following URL relates to HP HP-UX systems:

http://www.hp.com

LinuxThe following URLs relate to Linux® distributions:

http://www.redhat.com

http://www.suse.com

SolarisThe following URL relates to Sun Solaris systems:

http://www.sun.com

Microsoft WindowsThe following URL relates to Microsoft® Windows® systems:

http://www.microsoft.com

Legacy Products

IBM TotalStorage Ultrium External Tape Drive 3580The following publications relate to the IBM TotalStorage Ultrium External TapeDrive 3580:v IBM 3580 Ultrium Tape Drive Setup, Operator, and Service Guide, GA32-0415

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

IBM TotalStorage 3581 Tape Autoloader (also known as IBMTotalStorage 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,

and Service Guide, GA32-0470

Preface xi

Page 14: IBM Tape Driver IUG 1

IBM TotalStorage 3582 Tape Library (also known as IBMTotalStorage 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 IBMTotalStorage Ultrium Scalable Tape Library 3583)The following publications relate to the IBM TotalStorage Ultrium Scalable TapeLibrary:v IBM 3583 Tape Library Setup and Operator Guide, GA32-0411v IBM 3583 Tape Library Service Guide, GA32-0425v IBM Storage Area Network Data Gateway Module Setup, Operator, and Service Guide,

GA32-0436

IBM Virtualization Engine TS7510The following publications relate to the IBM Virtualization Engine TS7510:v IBM Virtualization Engine TS7510 Hardware, Installation, Setup, and Problem

Determination Guide, GC26-7766v IBM Virtualization Engine TS7510 Introduction and Planning Guide, GC26-7767v IBM Virtualization Engine TS7510 User Guide, GC26-7769

IBM TotalStorage Enterprise Automated Tape Library 3494The following publications relate to the IBM TotalStorage Enterprise AutomatedTape Library (3494):v IBM TotalStorage Enterprise Automated Tape Library (3494) Introduction and Planning

Guide, GA32-0448v IBM TotalStorage Enterprise Automated Tape Library (3494) Operator Guide,

GA32-0449v IBM TotalStorage 3494 Tape Library Maintenance Information, SA37-0407

IBM 3490E Tape SubsystemThe 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-0219v IBM 3490 Magnetic Tape Subsystem Enhanced Capability Models E01 and E11 User’s

Guide, GA32-0298v IBM 3490 Magnetic Tape Subsystem Enhanced Capability Models C10, C11, C1A, C22,

and C2A Maintenance Information, SA37-0299v IBM 3490E Tape Subsystem, Models F01, F1, F11, and FC0, Installation, Planning, and

Operator’s Guide, GA32-0378

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

GA32-0394

IBM Magstar MP 3575 Tape SubsystemThe following publications relate to the IBM Magstar MP 3575 Tape Subsystem:

xii IBM Tape Device Drivers Installation and User’s Guide

Page 15: IBM Tape Driver IUG 1

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-0381v IBM Magstar MP 3575 Tape Library Dataserver Hardware Reference, GA32-0382

IBM TotalStorage Enterprise Tape System 3590The following publications relate to the IBM TotalStorage Enterprise Tape System3590:v IBM TotalStorage Enterprise Tape System 3590 Introduction and Planning Guide,

GA32-0329v IBM TotalStorage Enterprise Tape System 3590 Operator Guide, GA32-0330v IBM TotalStorage Enterprise Tape System 3590 Hardware Reference, GA32-0331v IBM TotalStorage Enterprise Tape System 3590 Operator’s Quick Guide, GA32-0354

IBM 7331 8mm Tape LibraryThe following publications relate to the IBM 7331 8mm Tape Library:v IBM 7331 8mm Tape Library Installation Guide, SA26-7110v IBM 7331 8mm Tape Library Operator Guide, SA26-7111

IBM 7332 4mm DDS-2 Tape Cartridge AutoloaderThe following publications relate to the IBM 7332 4mm DDS-2 Tape CartridgeAutoloader:v IBM 7332 4mm DDS-2 Tape Cartridge Autoloader Model 005 Installation Guide,

SA26-7138v IBM 7332 4mm DDS-2 Tape Cartridge Autoloader Model 005 Operator Guide,

SA26-7139v IBM 7332 4mm DDS-2 Tape Cartridge Autoloader Model 005 Service Guide,

SA26-7140

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

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

IBM 7336 4mm Tape LibraryThe 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 LibraryThe following publications relate to the IBM 3490E Tape Subsystem:v 3447 and 7337 Digital Linear Tape Library Setup and Operator Guide, GA32-0399v 3447 and 7337 Digital Linear Tape Library Service Guide, GA32-0400v 7337 Model 360 Digital Linear Tape Library Setup and Operator Guide, SA41-0051

Preface xiii

Page 16: IBM Tape Driver IUG 1

Tru64The following URL points to information about Tru64 systems:

http://www.hp.com

SGIThe following URL relates to SGI systems:

http://www.sgi.com

Other PublicationsIBM Storage Area Network Data Gateway Installation and User’s Guide, SC26-7304

Additional InformationThe following publication contains additional information related to the IBM tapedrive, 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 CommentsYour feedback is important in helping us provide the most accurate and bestquality information. If you have comments or suggestions for improving thispublication, you can send us comments electronically by using these addresses:v Internet: [email protected] IBMLink™ from U.S.A.: STARPUBS at SJEVM5v IBMLink from Canada: STARPUBS at TORIBMv IBM Mail Exchange: USIB3VVD at IBMMAILv Fax from U.S.A., Canada, and other countries: 520-799-2906

xiv IBM Tape Device Drivers Installation and User’s Guide

Page 17: IBM Tape Driver IUG 1

Special Printing InstructionsThis Tape Device Drivers Installation and User’s Guide contains different sectionsfor each type of operating system/platform; for example, AIX®, Tru64, HP-UX,Linux, Sun Solaris, Windows; and a separate section on these operating systems forthe 3494 Enterprise Tape Library.

Note: When selecting the page range for the section you wish to print, note thatthe print page range is based on the page controls for Adobe Acrobat, notthe page printed on the actual document. Enter the Adobe page numbers toprint.

Important printer note

This area indicates thepages that will actuallyprint in your specifiedrange of pages.

Ignore the page numberappearing on the page itselfwhen entering page rangesfor your printer.

If you wish to print one or more separate sections of the manual, follow thesesteps: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 thepage range for the Table of Contents and the Index page range, respectively.

Preface xv

Page 18: IBM Tape Driver IUG 1

xvi IBM Tape Device Drivers Installation and User’s Guide

Page 19: IBM Tape Driver IUG 1

Chapter 1. Introduction

This publication describes the IBM Tape and Medium Changer Device Drivers forAIX, HP-UX, Linux, Solaris, Windows and Tru64 operating systems. Not all devicesare supported on all operating systems. Refer to the specific operating systemchapters for details on device support.

PurposeThe IBM tape and medium changer device drivers are designed specifically to takeadvantage of the features provided by the IBM tape drives and medium changerdevices. The goal is to give applications access to the functions required for basictape functions (such as backup and restore) and medium changer operations (suchas cartridge mount and demount), as well as to the advanced functions needed byfull tape management systems. Whenever possible, the driver is designed to takeadvantage of the device features transparent to the application. Please note thatsome independent software vendor (ISV) applications have certain device driverrequirements. Before you install the device drivers, please refer to the ISV web siteor their support to find out what device drivers should be used for the ISV.

IBM Tape ProductsThe IBM Tape product family provides an excellent solution for customers withsmall to large storage and performance requirements.

Current ProductsFigure 1 on page 2 illustrates the attachment of various current products to anopen systems server.

© Copyright IBM Corp. 2007, 2009 1

Page 20: IBM Tape Driver IUG 1

�1� Open Systems Server �7� IBM TS3200 Tape Library

�2� IBM Virtualization EngineTS7520/TS7530

�8� IBM TS3500 Tape Library

�3� IBM Virtualization Engine TS7650 �9� IBM TS3310 Tape Library

�4� IBM TS2230/TS2240 Ultrium 3/4Half-High Tape Drive

�10� IBM TS3400 Tape Library

�5� IBM TS2340 (or 3580) Ultrium 3/4Full-High Tape Drive

�11� IBM TS3100 Tape Library

�6� IBM TS1120/TS1130 Tape Drive [alsoknown as Enterprise]

Figure 2 on page 3 illustrates an Ultrium environment that could include an IBM3583 Tape Library and an IBM TS3500 Tape Library.

1

2

3

4

5

6

System Storage

7

8

9

10

System Storage

11

dd000004

Figure 1. Current Attachment Array

Introduction

2 IBM Tape Device Drivers Installation and User’s Guide

Page 21: IBM Tape Driver IUG 1

IBM Virtualization Engine TS7520The IBM Virtualization Engine TS7520 product is a virtual-tape solution designedto help optimize tape processing. Through the implementation of an integrated,tiered storage hierarchy of disk and tape, the benefits of both technologies can beleveraged to help enhance performance and provide the capacity needed fortoday’s tape processing requirements. Deploying this innovative offering can helpreduce batch processing time and management overhead.

IBM Virtualization Engine TS7650Disk storage can be expensive, and simply increasing disk capacity year after yearis a no-win strategy. IBM Virtualization Engine TS7650 with ProtecTIER tackles theproblem by eliminating the abundance of redundant data creating more capacity inthe disks: up to 25 times more capacity. ProtecTIER, featuring HyperFactortechnology, uses powerful algorithms to filter out duplicate data so that only newdata items are stored. The result is superior inline performance, unmatchedscalability and enterprise data integrity. ProtecTIER employs blazing fastperformance, able to process up to 900 megabytes per second in a clusteredconfiguration, and it’s done in-line, de-duplicating data in real time as it is writtento your back-up device.

IBM System Storage TS2230/TS2240 Tape DriveThe IBM System Storage TS2230 Tape Drive Model H3L (Machine Type 3580,Model H3L, SAP part number 3580L3E) is a high-performance, high-capacitydata-storage device that is designed to backup and restore open systemsapplications. This model incorporates the Linear Tape Open (LTO) IBM Ultrium 3Half-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 nativestorage capacity of 400 GB per cartridge (800 GB at 2:1 compression) on theUltrium 3 data cartridge.

The IBM System Storage TS2240 Tape Drive is an excellent tape storage solutionfor businesses requiring backup or low-cost, real-time archival storage of theirdata. The TS2240, with a half-high form factor, offers the same high capacity offull-high LTO 4 tape drives. The TS2240 has a physical storage capacity of up to 1.6TB (with 2:1 compression) in conjunction with the IBM System Storage LTOUltrium 800 GB data cartridge, which provides up to double the capacity ofUltrium 3 cartridges. The native data transfer performance of the TS2240 TapeDrive has increased over the previous LTO half-high generation to up to 120MB/sec. The TS2240 Tape Drive continues to provide an excellent alternative to

OpenSystemsServer

IBMTape Drive

IBMTape Library

MediumChanger

Robot

TapeCartridges

IBM Tape Device Driver

a250116

IBMTape Drive

Figure 2. Example of an IBM Tape Environment

Introduction

Chapter 1. Introduction 3

Page 22: IBM Tape Driver IUG 1

slower and smaller capacity 1/4-inch, 4 mm and 8 mm DLT/SDLT tape drives. TheTS2240 provides added security features by supporting encryption of data with 3Gbps SAS connectivity.

IBM System Storage TS2340 Tape DriveThe IBM System Storage TS2340 Tape Drive [also known as IBM LTO4] is ahigh-performance, high-capacity data-storage device for the midrange opensystems environment. It is designed to increase maximum tape drive throughputnative data rate performance up to 120 MB/sec compared to the IBM LTOgeneration 3 Tape Drive (Ultrium 3) at 80 MB/sec native data transfer rate. Inaddition, with the use of the new IBM LTO Ultrium 800 GB Data Cartridge, theUltrium 4 Tape Drive doubles the tape cartridge capacity up to 800 GB nativephysical capacity (1600 GB with 2:1 compression). It is available with SmallComputer System Interface (SCSI) or Serial Attached SCSI (SAS) interface. TheUltrium 4 SAS Tape Drive is encryption-capable and designed to supportApplication Managed Encryption.

IBM TotalStorage 3580 (Ultrium) Tape Drive (Models L33 andL3H)The IBM TotalStorage 3580 Tape Drive Model L33/L3H offers high-capacity,performance, and technology designed for the midrange open systemsenvironment. This model incorporates the Linear Tape Open (LTO) IBMTotalStorage Ultrium Tape Drive (Generation 3), which more than doublesmaximum tape drive performance over the Generation 2 LTO Ultrium Tape Drive(Ultrium 2). This tape drive comes with a SCSI Ultra160 LVD attachment, forconnection to a wide spectrum of open system servers.

The IBM LTO Ultrium 3-H Tape Drive and IBM LTO Ultrium 4 Half-High TapeDrive are high-performance, high-capacity data-storage devices in a half-heightform factor that are designed to backup and restore open systems applications.Both drives can be integrated into an enclosure, such as a desktop unit, tapeautoloader, or tape library. They are available with a Small Computer SystemsInterface (SCSI) or with a Serial Attached SCSI (SAS) interface. The IBM LTOUltrium 3-H Tape Drive has a native storage capacity of 400 GB per cartridge (800GB at 2:1 compression). The IBM LTO Ultrium 4 Half-High Tape Drive has a nativestorage 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 3592tape drive. It provides higher levels of performance, reliability, and cartridgecapacity than the IBM TotalStorage Tape System 3590 and the 3592 tape drive. TheTS1120 tape drive has a dual-ported 4-Gbps Fibre Channel interface, Fibre Channelattachment, and a new high-technology design that increases the native data rateto 100 MB/sec.

The IBM System Storage TS1130 Tape Drive features storage capability to help youestablish easy access to data, better security, long-term retention and datagovernance and regulatory compliance. The TS1130 tape drive offershigh-performance flexible data storage with support for data encryption.

IBM System Storage TS3200 Tape LibraryThe IBM System Storage TS3200 Tape Library Express Model offers high capacityand performance technology for the midrange open systems environments. TheTS3200 Tape Library is an external 4U standalone or rack-mountable unit thatincorporates up to two IBM TotalStorage Ultrium 3 Tape Drives, and has a nativedata rate of up to 80 Mbps per drive.

Introduction

4 IBM Tape Device Drivers Installation and User’s Guide

Page 23: IBM Tape Driver IUG 1

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

IBM System Storage TS3310 Tape LibraryThe IBM System Storage TS3310 Tape Library is a modular, scalable tape librarydesigned to scale vertically with expansion for Linear Tape Open (LTO) tapecartridges, drives, and redundant power supplies. The base library module, modelL5B, is the entry point for the product family. It contains all of the necessaryrobotics and intelligence to manage the 5U high library system, which houses upto 36 cartridges (30 storage slots and 6 Input/Output slots) and two LTOgeneration 3 tape drives. The TS3310 model L5B can be expanded with theaddition of expansion units, the model E9U. Each model E9U contains 92 physicalLTO 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 supplymodules (At least one power supply module must be installed if a drive is presentin the E9U).

IBM System Storage TS3400 Tape LibraryThe IBM System Storage TS3400 TAPE LIBRARY is designed to offer highperformance drive technology and automation for the open systems environment.The TS3400 Tape Library is an addition to the family of IBM System Storage tapelibrary offerings. The TS3400 Tape Library is an external 5U stand-alone orrack-mountable unit that incorporates up to two IBM System Storage TS1120 TapeDrives Model 3592-E05 (Machine Type 3592, Model E05), which are orderedseparately. It comes with 4 Gbps dual-ported switched fabric Fibre Channelattachment. The TS1120 Tape Drive has a native data transfer rate of up to 100MB/ sec. per drive.

IBM System Storage TS3100 Tape LibraryThe IBM System Storage TS3100 (Machine Type 3573) Tape Library provides acompact, high-capacity, low-cost solution for simple, unattended data backup. Thisunique design houses up to 22 tape cartridges in a compact 2U form factor witheasy access to tape cartridges via two removable magazines and an Input/Output(I/O) Station.

Legacy Products

IBM TotalStorage Ultrium Scalable Tape Library 3583The IBM TotalStorage Ultrium Scalable Tape Library 3583 is an automated tapelibrary that incorporates IBM Ultrium tape drives in either a stand alone oroptional rack mount configuration. Three different library models are availablewith 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 3582The IBM TotalStorage Ultrium Tape Library 3582 is an entry tape libraryincorporating high-performance IBM TotalStorage Ultrium generation 2 Tape

Introduction

Chapter 1. Introduction 5

Page 24: IBM Tape Driver IUG 1

Drives for the midrange open systems environment. It can accommodate one ortwo Ultrium generation 2 Tape Drives and comes standard with a one-cartridgeI/O station and 23 data cartridge slots giving a native library capacity of 4.8 TBuncompressed native storage.

IBM TotalStorage Ultrium Tape 2U Autoloader 3581The Ultrium Tape 2U Autoloader 3581 is an external 2U stand-alone orrack-mountable unit that incorporates a single IBM LTO Ultrium 2 tape drive. TheUltrium Tape 2U Autoloader 3581 capacity is eight tape cartridges, providing amedia 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 F28comes with a Native Switched Fabric Fibre Channel attachment, for connection to awide spectrum of open systems servers.

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

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

StorageSmart by IBM Ultrium ProductsThe StorageSmart™ by IBM Ultrium family of products is compatible with the IBMbranded versions of the Ultrium family products. In this manual, where there is nospecific mention of the StorageSmart by IBM Ultrium branded set of products, thedocumentation pertaining to the IBM branded family of products should be used.Table 1 cross references the StorageSmart by IBM Ultrium product set to the IBMUltrium product set.

Table 1. Ultrium Product Comparison

StorageSmart by IBM Ultrium IBM Version of Ultrium

StorageSmart by IBM Ultrium External TapeDrive TX200

IBM TotalStorage Ultrium External TapeDrive 3580

StorageSmart by Ultrium Tape AutoloaderSL7

IBM TotalStorage Ultrium Tape Autoloader3581

StorageSmart by Ultrium Scalable TapeLibrary SL72

IBM TotalStorage Ultrium Scalable TapeLibrary 3583

No equivalent in the IBM Ultrium productset

IBM TotalStorage UltraScalable Tape Library3584

IBM TotalStorage Enterprise Automated Tape Library 3494The IBM TotalStorage Enterprise Automated Tape Library 3494 is an automatedtape library, providing an automated tape solution to a variety of system

Introduction

6 IBM Tape Device Drivers Installation and User’s Guide

Page 25: IBM Tape Driver IUG 1

environments. It provides a solution for automating tape operations such assave/restore, migration of data between direct access storage devices (DASD) andtape, and other mass data applications.

IBM TotalStorage Enterprise Tape System 3590The IBM TotalStorage Enterprise Tape System 3590 consists of a tape drivecombined with an automatic cartridge facility (ACF). In addition to the functionsthat the ACL or CSL provide for the IBM 3490E Magnetic Tape Subsystem, theACF on the Enterprise Tape System 3590 can operate as an integrated mediumchanger device to provide random access of cartridges in the magazine cells underprogram control.

Note: The 3590 drive has two Fibre Channel addressing modes. When attaching anopen systems server to a 3590 Fibre Channel drive, you must use the hardaddressing mode. When attaching a 3590 drive directly to a host (without aswitch), 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 levelof storage capability to the traditional storage product hierarchy. To the hostsoftware, a VTS subsystem looks like a 3490E Enhanced Capability Tape Subsystemwith associated Cartridge System Tape or Enhanced Capacity Cartridge SystemTape.

IBM Magstar MP 3570 Tape SubsystemThe IBM Magstar MP 3570 Tape Subsystem consists of one or two tape drives(depending on the model) integrated with a full capability medium changer roboticfacility, which provides random access of cartridges in the storage cells underprogram control.

IBM Magstar MP 3575 Tape Library DataserverThe IBM Magstar MP 3575 Tape Library Dataserver is a scalable family ofhigh-performance tape libraries that use the IBM Magstar MP tape drives. The IBMdevice drivers control both the Magstar MP tape drives and the robotic cartridgehandling mechanism in these tape libraries that instructs the robot to mount anddemount the cartridges.

IBM Virtualization Engine TS7510The IBM Virtualization Engine TS7510 product delivers and increased level ofstorage capability to the traditional storage product hierarchy. To the host software,the IBM Virtualization Engine TS7510 looks like a 3584 library with associated tapedrives.

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

IBM 7332 4mm Tape Cartridge AutoloaderThe IBM Magstar MP 3575 Tape Library Dataserver is a scalable family ofhigh-performance tape libraries that use the IBM Magstar MP tape drives. The IBMdevice drivers control both the Magstar MP tape drives and the robotic cartridgehandling mechanism in these tape libraries that instructs the robot to mount anddemount the cartridges.

Introduction

Chapter 1. Introduction 7

Page 26: IBM Tape Driver IUG 1

IBM 7331, 7334, 7336, or 7337 Tape Medium ChangerThe 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 IBM7337 product is a DLT Tape Medium Changer Library device. The AIX EnhancedDevice Driver controls the robotic cartridge handling mechanism in these tapelibraries that instructs the robot to mount and demount the cartridges. Access tothe tape drives within these libraries is through the native operating system AIXTape Device Driver.

Introduction

8 IBM Tape Device Drivers Installation and User’s Guide

Page 27: IBM Tape Driver IUG 1

Chapter 2. Common Extended Features

Purpose . . . . . . . . . . . . . . . . 9Supported Hardware . . . . . . . . . . . 9Path Failover and Load Balancing . . . . . . . 12

Automatic Failover . . . . . . . . . . . 12Multiple HBA and Multi-Port Devices . . . . 13Multiple HBA and Single Ports . . . . . . . 13Single HBA and Multi-Port Devices . . . . . 15

Dynamic Load Balancing . . . . . . . . . . 16

Supported Devices and Feature Codes . . . . . 16Data Encryption . . . . . . . . . . . . . 17

Tape and Library Requirements. . . . . . . 17Planning for Application-Managed TapeEncryption . . . . . . . . . . . . . 18Planning for System-Managed Tape Encryption 19Planning for Library-Managed Tape Encryption 21Feature Codes (Encryption) . . . . . . . . 22

PurposeThis chapter provides general information about the IBM Device Drivers. Refer tothe specific operating system chapters for details on device support.

Supported HardwareTable 2 lists the IBM device drivers that are supported.

For detailed requirements for each operating system, refer to the appropriatechapter. To obtain the most current service and documentation for this software,refer to Appendix A, “Accessing Documentation and Software Online,” on page341.

Table 2. Supported Hardware by Operating System

DEVICE AIX HP-UX

Linux

Solaris Tru64

Windows

Intel® andAMD

OpteronProcessors

Systemp

Models

Systemz®

Models 2000Server2003 NT

Server2008

IBM LTOUltrium TapeDrive

X X(not

LTO4on

HP-UX11.0)

X X X X X(not

LTO4)

X(onlyLTO1)

X X(LTO1

andLTO2only)

X

IBM SystemStorageTS1120/TS1130 TapeDrive ModelE05/E06

X X X X X X X X X

IBM SystemStorageTS2230 TapeDrive

X X X X X X X

IBM SystemStorageTS2240 TapeDrive

X X X X X X X

© Copyright IBM Corp. 2007, 2009 9

Page 28: IBM Tape Driver IUG 1

Table 2. Supported Hardware by Operating System (continued)

DEVICE AIX HP-UX

Linux

Solaris Tru64

Windows

Intel® andAMD

OpteronProcessors

Systemp

Models

Systemz®

Models 2000Server2003 NT

Server2008

IBM SystemStorageTS2340 TapeDrive

X X(not

HP-UX11.0)

X X X X X

IBM SystemStorageTS3100 TapeLibrary

X X X X X X X X X

IBM SystemStorageTS3200 TapeLibrary

X X X X X X X X X

IBM SystemStorageTS3310 TapeLibrary

X X X X X X X X X

IBM SystemStorageTS3400 TapeLibrary

X X X X X X X X

IBM SystemStorageTS3500 TapeLibrary

X X X X X X X X X

IBM SystemStorageVirtualizationEngine TS7520

X X(not

HP-UX11.0,

11i v3)

X X X X X X X X

IBM SystemStorageVirtualizationEngine TS7650

X X X X X X X

IBMTotalStorageUltraScalableTape Library3584

X X X X X X X X X X X

IBMTotalStorageEnterpriseTape System3590, ModelsB11, B1A

X X X X X X X

Device Driver Features

10 IBM Tape Device Drivers Installation and User’s Guide

Page 29: IBM Tape Driver IUG 1

Table 2. Supported Hardware by Operating System (continued)

DEVICE AIX HP-UX

Linux

Solaris Tru64

Windows

Intel® andAMD

OpteronProcessors

Systemp

Models

Systemz®

Models 2000Server2003 NT

Server2008

IBMTotalStorageEnterpriseTape System3590, ModelsE11, E1A, H11,H1A

X X X X X X X X X X

IBMTotalStorageEnterpriseTape System3592, ModelJ1A

X X X X X X X X X

IBMVirtualizationEngine TS7510

X X X X X X X X

IBMTotalStorageVirtual TapeServer, ModelsB10, B18, B20

X X X X X X

IBM MagstarMP 3570 TapeSubsystemModel B00,B01, B02, B11,B12, B1A

X X X X X

IBM MagstarMP 3570 TapeSubsystemModel C00,C01, C02, C11,C12, C1A

X X X X X

IBM MagstarMP 3570 TapeSubsystemModel L06,L12, L18, L24,L32

X X X X X

IBM 73318mm TapeLibrary Model205 or 305(support forautochangeronly)

X

Device Driver Features

Chapter 2. Common Extended Features 11

Page 30: IBM Tape Driver IUG 1

Table 2. Supported Hardware by Operating System (continued)

DEVICE AIX HP-UX

Linux

Solaris Tru64

Windows

Intel® andAMD

OpteronProcessors

Systemp

Models

Systemz®

Models 2000Server2003 NT

Server2008

IBM 73324mm TapeCartridgeAutoloaderModel 005,110, 220

X

IBM 73348mm TapeLibrary Model410

X

IBM 73364mm TapeLibrary Model205 or 305(support forautochangeronly)

X X

IBM 7337 DLTTape Library(support forautochangeronly)

X

Path Failover and Load BalancingDevice driver path failover support configures multiple physical paths to the samedevice 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 devicedrivers available on the following ftp download site:ftp://ftp.software.ibm.com/storage/devdrvr

Some devices require a path failover feature code to be installed prior to enablingthe path failover support in the device driver. Refer to Table 3 on page 16 for a listof supported devices and what path failover feature code may be required for yourmachine type.

Automatic FailoverThe automatic failover support provides error recovery on an alternate path whena permanent error occurs on the primary path. This is transparent to the runningapplication. There are two types of Path Failover, Data Path Failover (DPF) andControl Path Failover (CPF). They are closely related however the difference is thatDPF is an automatic failover support for the transfer of data, which provides error

Device Driver Features

12 IBM Tape Device Drivers Installation and User’s Guide

Page 31: IBM Tape Driver IUG 1

recovery for systems connected to tape drives while CPF is an automatic failoversupport for the transfer of commands to move tape cartridges. Below are examplesof different configurations that can be constructed.

Multiple HBA and Multi-Port DevicesConsider a multipath connection that consists of two Host Bus Adapters (HBA)connected through a fabric to a multi-port device. By having two connections fromeach device to the fabric, a configuration of four different physical paths can be setup. 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 theprimary path should have a failure, the Automatic Failover would try switching toanother configured path. Without path failover support, if a permanent path erroroccurs (because of an HBA or cable failure, for example), the application fails.However should that occur with this configuration there would still be two validphysical paths for the data to be transmitted on and the running applicationwouldn’t be affected.

Multiple HBA and Single PortsFor another example, consider the same multipath connection that consists of twoHost Adapters connected through a fabric to a single port device. Thisconfiguration would supply two physical paths to the same device, however, if theport or cable from the device fails the automatic failover would not work as thatconnection is severed and a permanent path error occurs. If however the failurewas with one of the HBAs or their cables the automatic data path failover wouldselect the other HBA and the information would continue through the alternatepath.

Drive

LibraryController

Drive

Drive

Dual HBA

Mulit-Port Drive(DPF)

Fabric

Virtual Tape Library(DPF and CPF)

a2500255

Library(CPF)

X

X

X

Figure 3. Multiple HBA and multi-port devices

Path Failover

Chapter 2. Common Extended Features 13

Page 32: IBM Tape Driver IUG 1

Drive

LibraryController

Drive

Drive

Dual HBA(DPF and CPF)

Single-Port Drive

Fabric

Virtual Tape Library

a2500256

Library

X

Figure 4. Multiple HBA and single ports

Path Failover

14 IBM Tape Device Drivers Installation and User’s Guide

Page 33: IBM Tape Driver IUG 1

Single HBA and Multi-Port DevicesYet for another example, consider a single path from the HBA through the fabric toa multi-port device. This also provides a failover path unless the failure is with theHBA or the HBA’s cable, at which point the connection is severed and a permanentpath error occurs. Whereas, if the failure should occur on the device side there isstill an alternative path available for the information to go through.

At startup or configuration, the system detects multiple logical devices of the tapedrive. Each logical device is a physical path to the same tape drive. A backup andrestore application can open and use only one logical device at a time because theyrepresent the same physical device.

Without path failover support, if a permanent path error occurs (because of anHBA or cable failure, for example), the application fails. It is possible to initiatemanual failover by restarting the application on the alternate logical device, but theapplication has to be restarted from the beginning. A long back up or restoreoperation may have been in progress when the path error occurred. Sometimesmanual failover may require operator intervention to reset the drive because aSCSI Reservation could still exist on the failing HBA path.

When the path failover support is enabled on all logical devices, the device driverconfigures them internally as a single device with multiple paths. The applicationcan still open and use only one logical device at a time. If an application opens theprimary device and a permanent path error occurs, the device driver initiatesfailover error recovery automatically on an alternate path. If successful, the currentoperation continues on an alternate path without interrupting the application. Thedata path failover error recovery first restores the previous device state, SCSIReservation, and tape position, and then retries the failing operation.

Drive

LibraryController

Drive

Drive

Single HBA

Mulit-Port Drive(DPF)

Fabric

Virtual Tape Library(DPF and CPF)

a2500257

Library(CPF)

X

X

X

Figure 5. Single HBA and multi-port devices

Path Failover

Chapter 2. Common Extended Features 15

Page 34: IBM Tape Driver IUG 1

Dynamic Load BalancingThe dynamic load balancing support optimizes resources for tape devices that havephysical connections to multiple Host Bus Adapters (HBA) in the same machine.When an application opens a device that has multiple HBA paths configured, thedevice driver determines which path has the HBA with the lowest usage, andassigns that path to the application. When another application opens a differentdevice with multiple HBA paths, the device driver again determines the path withthe lowest HBA usage and assigns that path to the second application. The devicedriver updates the usage on the HBA assigned to the application when the deviceis closed. Dynamic load balancing uses all Host Bus Adapters whenever possibleand 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 andHBA2. Initially, there are no tape drives currently in use. When the first applicationopens 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 assignsthe second application to use HBA2. A third application would be assigned toHBA1 and a fourth application would be assigned to HBA2. There would be twoapplications using HBA1 and two applications using HBA2.

If the first application finishes and closes the device, there would now be oneapplication using HBA1 and two applications using HBA2. When the nextapplication opens a tape drive, it would be assigned to HBA1, so again therewould be two applications using HBA1 and two applications using HBA2.Likewise, if the second application finishes and closes the device, HBA2 wouldhave one application using it and the next application that opens a tape drivewould be assigned to HBA2.

The dynamic load balancing support is independent from the automatic failoversupport. Regardless of the path assigned initially for load balancing, if that pathfails, the automatic failover support attempts recovery on the next available path.

Supported Devices and Feature CodesPath failover is supported only for the devices listed in Table 3. Path failoverincludes Control Path Failover (CPF) for tape libraries and Data Path Failover(DPF) for tape drives. In order to use path failover support, some devices requirefeature codes as listed in Table 3.

Table 3. Supported Devices and Feature Codes

Supported Tape Library Feature Code (FC), if required

TS1120 Standard, no FC required (DPF only)

TS1130 Standard, no FC required (DPF only)

3592 Standard, no FC required (DPF only)

TS3500 FC 1682 (CPF and DPF)

TS3400 Standard, no FC required (CPF and DPF)

TS3310 FC 1682 (CPF and DPF)

TS3320 FC 1682 (CPF and DPF)

TS7520 FC 1682 (CPF and DPF)

TS7650 Standard, no FC required (DPF only)

Path Failover

16 IBM Tape Device Drivers Installation and User’s Guide

Page 35: IBM Tape Driver IUG 1

Table 3. Supported Devices and Feature Codes (continued)

Supported Tape Library Feature Code (FC), if required

3583 FC 1680 (CPF), FC 1681 (DPF)

3582 FC 1680 (CPF), FC 1681 (DPF)

Note:

1. Path failover is not supported on parallel SCSI (except for some parallelSCSI drives on AIX operating systems). Path Failover is only supportedon SAS devices attached to Windows and Linux for Intel/AMDprocessor based servers.

2. Path failover is not supported on Virtual Tape Libraries (except for thoselisted in Table 3 on page 16) that emulate IBM tape devices.

Data Encryption

Tape and Library RequirementsEncryption support is available in the IBM encryption-capable TS1120 and UltriumLTO4 (Fibre Channel or SAS) tape drives that support encryption. Ifsystem-managed or library-managed encryption is used, the Transparent LTOEncryption feature code is required for the library with Ultrium LTO4 tape drives.This feature code is not required for TS1120 tape drives. Application-managedencryption does not require this feature code for any of encryption-capable tapedrives. Refer to “Feature Codes (Encryption)” on page 22 for the feature codenumbers.

In the open system environment, there are three methods of encryptionmanagement to choose from. These methods differ in where you choose to locateyour Encryption Key Manager (EKM) application. Your operating environmentdetermines which is the best for you, with the result that key management and theencryption policy engine may be located in any one of the three environmentallayers: application layer, system layer, and library layer.

Application-Managed Tape EncryptionThis method is best where operating environments run an application alreadycapable of generating and managing encryption policies and keys, such as Tivoli®

Storage Manager (TSM). Policies specifying when encryption is to be used aredefined through the application interface. The policies and keys pass through thedata path between the application layer and the Encryption is the result ofinteraction between the application and the encryption-enabled tape drive, and istransparent to the system and library layers.

Application-managed encryption is supported on AIX, Windows 2000, WindowsServer 2003, Windows Server 2008, Linux, Solaris, and HP-UX. It is required to usethe latest device drivers available on the following ftp down load site:ftp://ftp.software.ibm.com/storage/devdrvr/

Refer to your software vendor for support details.

Please refer to “Planning for Application-Managed Tape Encryption” on page 18for details on the hardware and software requirements for application-managed

Path Failover

Chapter 2. Common Extended Features 17

Page 36: IBM Tape Driver IUG 1

encryption. For details on setting up application-managed tape encryption refer tothe Tivoli Storage Manager documentation or for more information, visit thefollowing site:http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/index.jsp

System-Managed Tape EncryptionIn this method, key generation and management is performed by the EKM, aJava™ application running on the host. Policy controls and keys pass through thedata path between the system layer (device drivers) and the encryption-capabletape drives. Encryption is transparent to the applications.

It is required to use the latest device drivers available on the ftp down load site:ftp://ftp.software.ibm.com/storage/devdrvr/

Refer to “Planning for System-Managed Tape Encryption” on page 19 for details onthe hardware and software requirements for system-managed encryption. Fordetails on setting up system-managed encryption in different operating systemenvironment, refer to the applicable chapter for each operating system.

Library-Managed Tape EncryptionThis method is best for encryption-capable tape drives in an open attached IBMtape libraries. Scratch encryption policies specifying when to use encryption are setup through the IBM System Storage Tape Library Specialist Web interface. Policiesare based on cartridge volume serial numbers. Key generation and management isperformed by the EKM, a Java application running on a host. Policy control andkeys pass through the library-to-drive interface, therefore encryption is transparentto the applications.

Library-managed encryption is supported on AIX, Windows Server 2003, WindowsServer 2008, Linux, Solaris, and HP-UX. Please refer to “Planning forLibrary-Managed Tape Encryption” on page 21 for details on the hardware andsoftware requirements for library-managed encryption. For details on setting uplibrary-managed encryption on encryption-capable tape drives, please refer to theIBM 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 aboutencryption on the IBM encryption-capable tape drive.

In order to perform encryption on the encryption-capable tape drive, the followingis required:v Encryption-capable tape drive(s)v Encryption configuration features:

– Library code updates and Transparent LTO Encryption feature code forlibraries with Ultrium LTO4 drives

– Tape drive code updates

Application-Managed Tape Encryption Setup TasksAny 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.

Data Encryption

18 IBM Tape Device Drivers Installation and User’s Guide

Page 37: IBM Tape Driver IUG 1

4. Perform write/read operation to test encryption.5. Verify encryption of the test volume by Autonomic Management Engine

(AME): issue QUERY VOLUME FORMAT=DETAILED

Verify that Drive Encryption Key Manager is set to Tivoli Storage Manager.

Planning for System-Managed Tape Encryption

Note: Please contact your IBM Representative for additional information aboutencryption on the IBM encryption-capable tape drive. There is no SSLsupport at this time.

In order to perform encryption on the encryption-capable tape drive, the followingis required:v Encryption-capable tape drive(s)v Keystore (refer to the IBM System Storage Encryption Key Manager Introduction,

Planning, and User Guide)v Encryption configuration features:

– Encryption Key Manager (EKM)– Tape drive code updates and Transparent LTO Encryption feature code for

libraries with Ultrium LTO4 drives– Tape system library code updates

Setup Tasks for System-Managed Tape Encryption on OpenSystems Operating SystemAny task not identified as an IBM service task is the responsibility of the customer.1. Install, verify, and configure:

a. Keystoreb. EKM (Refer to the IBM System Storage Encryption Key Manager Introduction,

Planning, and User Guide for more information on both.)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 tapeutil EKM test functions to verify.

System-Managed Encryption Configuration

Note: The tape drive must be set to system-managed encryption from the drivepanel or library user interface before using device driver system-managedencryption.

After installing the device driver, then Encryption Key Manager needs to beconfigured. The servers are configured in a text file ibmekm.conf that is installed inthe /etc directory by the device driver if a current configuration file does notalready exist.

Figure 6 on page 20 is an example of the sample configuration file installed.

Data Encryption

Chapter 2. Common Extended Features 19

Page 38: IBM Tape Driver IUG 1

The following shows the different entry formats for IPv4 and IPv6 addresses in theibmekm.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 EKM server, use Table 4 to choose an appropriate IPaddress type and then add the IP address in the entry of the encryptionconfiguration file.

Table 4. Interoperability between IPv4 and IPv6 Clients and Servers

IPv4 EKMserver IPv4-onlyhost

IPv6 EKMserver IPv6-onlyhost

IPv4 EKMserverdual-stack host

IPv6 EKMserverDual-stack host

IPv4Client/IPv4-onlyhost

IPv4 (no) IPv4 IPv4

# 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

Data Encryption

20 IBM Tape Device Drivers Installation and User’s Guide

Page 39: IBM Tape Driver IUG 1

Table 4. Interoperability between IPv4 and IPv6 Clients and Servers (continued)

IPv4 EKMserver IPv4-onlyhost

IPv6 EKMserver IPv6-onlyhost

IPv4 EKMserverdual-stack host

IPv6 EKMserverDual-stack host

IPv6Client/IPv6-onlyhost

(no) IPv6 (no) IPv6

IPv4 Clientdual-stack host

IPv4 (no) IPv4 IPv4

IPv6 Clientdual-stack host

IPv4 IPv6 (no) IPv6

The timeout value in seconds is used when a request is sent to the server and thetime for the server to respond in case no response is received.

A maximum of 16 server connections can be configured for failover. When aconnection can not be made or is lost on the current server being used, theoperation is retried on the next configured server.

After configuring servers in the ibmekm.conf file then specific tape drives need tobe configured to the device driver for system-managed encryption. The devicedriver default does not enable encryption. Refer to the following sections forspecific information depending on the operating system.

Planning for Library-Managed Tape Encryption

Note: Please contact your IBM Representative for additional information aboutencryption on the IBM encryption-capable tape drive.

In order to perform encryption on the encryption-capable tape drive, the followingis required:v Encryption-capable tape drive(s)v Keystore (refer to the IBM System Storage Encryption Key Manager Introduction,

Planning, and User Guide)v Encryption configuration features:

– Encryption Key Manager (EKM)– Tape system library code updates and Transparent LTO Encryption feature

code for libraries with Ultrium LTO4 drives.– Tape drive code updates

Library-Managed Tape Encryption TasksAny task not identified as an IBM service task is the responsibility of the customer.1. Install, verify, and configure

a. Keystoreb. EKM (Refer to the IBM System Storage Encryption Key Manager Introduction,

Planning, and User Guide 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 Driveor Library Operator’s Guide).

Data Encryption

Chapter 2. Common Extended Features 21

Page 40: IBM Tape Driver IUG 1

4. Use library diagnostic functions to verify.

Bulk RekeyFor customers using Library-Managed Encryption with 3592 Enterprise TapeDrives and IBM tape and changer drivers running on open systems operatingsystem (AIX, HP-UX, Linux, Solaris, Windows), sample code for performing bulkrekey operations is available. The sample code packages are provided ″as-is″ withlimited testing, and are provided to give customers guidance on bulk rekeyoperations.

For Unix operating systems, a sample script (rekey_unix.sh) is provided and mustbe used in conjunction with the tapeutil version bundled in the same package. ForWindows operating systems, a sample c program (rekey_win.c) is provided. Bothof these sample programs must be used in conjunction with both the IBM tape andchanger drivers. In addition, data cartridges must be located in storage cells, not inI/O station cells or tape drives.

For more information and to download the sample code packages, seeftp://ftp.software.ibm.com/storage/devdrvr/sample_code.

Feature Codes (Encryption)In order to use system-managed and library-managed encryption, the TransparentLTO Encryption feature codes listed in Table 5 are required for the associated IBMtape libraries with Ultrium LTO4 tape drives. If the drives in use are TS1120 TapeDrives, this feature code is not required for system-managed or library-managedencryption. If you are using application-managed encryption, no feature code isrequired on any encryption-capable tape drives.

Table 5. Feature Codes (Encryption)

Tape Library Feature Code

TS3500 FC 1604

TS3400 Standard Feature

TS3310 FC 5900

TS3100/3200 FC 5900

Data Encryption

22 IBM Tape Device Drivers Installation and User’s Guide

Page 41: IBM Tape Driver IUG 1

Chapter 3. AIX Tape and Medium Changer Device Driver

Purpose . . . . . . . . . . . . . . . 23Data Flow . . . . . . . . . . . . . . . 24Product Requirements . . . . . . . . . . . 24

Hardware Requirements . . . . . . . . . 24Software Requirements . . . . . . . . . 26

Installation and Configuration Instructions . . . . 26Installation Procedure . . . . . . . . . . 27Configuring Tape and Medium Changer Devices 27Deconfiguring Tape Devices . . . . . . . . 28Deconfiguring Medium Changer Devices . . . 28Uninstalling . . . . . . . . . . . . . 28

Tape Drive, Media, and Device Driver Parameters 28Configuration Parameters. . . . . . . . . 29Media Parameters . . . . . . . . . . . 33Automatic Cartridge Facility Mode . . . . . 34

Special Files . . . . . . . . . . . . . . 34Special Files for Tape Devices . . . . . . . 34Special Files for Medium Changer Devices . . . 35

Persistent Naming Support . . . . . . . . . 36Changing the Logical Name After Initial Boot . . 36

Control Path Failover Support for Tape Libraries . . 37Configuring and Unconfiguring Path FailoverSupport . . . . . . . . . . . . . . 37Primary and Alternate Paths. . . . . . . . 38Querying Primary and Alternate PathConfigurations . . . . . . . . . . . . 38Configuring and Unconfiguring Primary andAlternate Devices . . . . . . . . . . . 39

Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 39

Installing Data Path Failover License Key . . . 39Configuring and Unconfiguring Path FailoverSupport . . . . . . . . . . . . . . 40

Primary and Alternate Paths. . . . . . . . 40Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 41Configuring and Unconfiguring Primary andAlternate Devices . . . . . . . . . . . 41

System-Managed Encryption . . . . . . . . 41Device Driver Configuration. . . . . . . . 41Querying Tape Drive Configuration . . . . . 42Testing Data Encryption Configuration andConnectivity . . . . . . . . . . . . . 42Error Logging . . . . . . . . . . . . 42Field Support Information . . . . . . . . 42

Problem Determination . . . . . . . . . . 43Using the Dump Support . . . . . . . . . 43Device and Volume Information Logging . . . 43Log File . . . . . . . . . . . . . . 44Tape Log Utility . . . . . . . . . . . . 44Reservation Conflict Logging . . . . . . . 44Error Logging . . . . . . . . . . . . 45Error Log Templates . . . . . . . . . . 45Automatic Dump Facility . . . . . . . . . 47Trace Facility . . . . . . . . . . . . . 47Atape System Trace (ATRC) Utility . . . . . 48Component Tracing. . . . . . . . . . . 48Atape Component Trace (ACTRC) Utility . . . 48

Tape Drive Service Aids . . . . . . . . . . 48Details of Tape Service Aids . . . . . . . . 49

Performance Considerations . . . . . . . . . 51Data Path . . . . . . . . . . . . . . 51Common AIX Utilities . . . . . . . . . . 52AIX iostat Utility for Tape Performance . . . . 52Before Calling Support . . . . . . . . . 52

This chapter describes the IBM AIX Enhanced Tape and Medium Changer DeviceDriver (Atape) for IBM tape devices.

For tape diagnostic and utility functions refer to Chapter 10, “IBM Tape DiagnosticTool (ITDT),” on page 259 or “AIX System - Tape Utility Program (tapeutil)” onpage 362.

PurposeThe IBM AIX Enhanced Tape and Medium Changer Device Driver is designedspecifically to take advantage of the features provided by the IBM tape drives andmedium changer devices. The goal is to give applications access to the functionsrequired for basic tape operations (such as backup and restore) and mediumchanger operations (such as mount and demount the cartridges), as well as to theadvanced functions needed by full tape management systems. Whenever possible,the driver is designed to take advantage of the device features transparent to theapplication. Please note that some independent software vendor (ISV) applicationshave certain device driver requirements. Before installing the device drivers, pleaserefer to the ISV web site or their support to find out what device drivers should beused for the ISV.

© Copyright IBM Corp. 2007, 2009 23

Page 42: IBM Tape Driver IUG 1

Data FlowThe software described in this chapter covers the AIX Enhanced Device Driver(Atape device driver) and the interface between the application and the tapedevice. For data flow, refer to Figure 7.

Product RequirementsThe following hardware and software components are supported by IBM.

Hardware RequirementsThe 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 VHDCIconnector):- 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)

Figure 7. Data Flow for AIX Device Driver (Atape)

AIX Device Driver (Atape)

24 IBM Tape Device Drivers Installation and User’s Guide

Page 43: IBM Tape Driver IUG 1

– 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-2Differential Fast/Wide Adapter/A

- RS/6000 or System p (also known as pSeries) FC 2416 SCSI-2 DifferentialFast/Wide Adapter/A

- RS/6000 or System p (also known as pSeries) FC 2420 SCSI-2 DifferentialHigh 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 Adapterv 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 (alsoknown as pSeries) FC 6227 or FC 6228 Gigabit Fibre Channel Adapters andFC6239 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 ChannelAdapters and FC6239 2 Gigabit Fibre Channel PCI-X Adapters:

IBM TotalStorage Enterprise Tape System 3590, Models B11, B1A, E11, E1A,H11, and H1AIBM TotalStorage Virtual Tape Server (Models B10, B18, and B20)IBM Magstar MP 3570 Tape Subsystem Model CIBM Magstar MP 3575 Tape Library Dataserver

v The IBM TotalStorage Enterprise Tape System 3592 Model J is supported withFC6239 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 thefollowing tape drives and libraries. This adapter also supports N_Port IDVirtualization (NPIV) and AIX VIOS clients if the AIX VIOS server with thisadapter 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

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 25

Page 44: IBM Tape Driver IUG 1

- TS3400 (3577) Library- TS3500 (3584) Library

– Ultrium TD4 LTO drives- TS3100 (3573-L2U) Library- TS3200 (3573-L4U) Library- TS3500 (3584) Library

– Ultrium TD3 LTO drives- TS3100 (3573-L2U) Library- TS3200 (3573-L4U) Library- TS3500 (3584) Library

Note: Using a single Fibre Channel host bus adapter (HBA) for concurrent tapeand disk operations is generally not recommended. Tape and disk devicesrequire incompatible HBA settings for reliable operation and optimalperformance characteristics. Under stress conditions (high I/O rates foreither tape, disk, or both) where disk and tape subsystems share a commonHBA, stability problems have been observed. These issues are resolved byseparating disk and tape I/O streams onto separate HBAs and using SANzoning to minimize contention. IBM is focused on assuring server/storageconfiguration interoperability. We strongly recommend that your overallimplementation plan includes provisions for separating disk and tapeworkloads.

Software RequirementsThe AIX Enhanced Device Driver (Atape device driver) supports AIX 5L™ Version5.2 and later releases on IBM POWER-based AIX servers.

To obtain the most current service and documentation for this software, refer toAppendix A, “Accessing Documentation and Software Online,” on page 341.

Installation and Configuration InstructionsThe recommended procedure for installing a new version of the device driver is touninstall the previous version.

Instructions for uninstalling the device driver are outlined below in “Uninstalling”on page 28.

Attention: At the end of the installation procedure, the installp facilityautomatically runs the AIX bosboot command to update the boot record with thenewly installed Atape files. When the bosboot command completes, the followingmessages 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 installationsummary shows that the Atape driver was installed successfully, it is not necessaryto reboot the machine at this time.

If the installation summary shows that the install failed, you should reboot themachine and attempt to install the Atape driver a second time.

AIX Device Driver (Atape)

26 IBM Tape Device Drivers Installation and User’s Guide

Page 45: IBM Tape Driver IUG 1

Installation ProcedureFor information on obtaining the latest version of device drivers and the latestdocumentation, refer to Appendix A, “Accessing Documentation and SoftwareOnline,” on page 341.

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. If you are attaching an IBM TotalStorage Enterprise Tape System3590 Model E or Model H Tape Drive with the Fibre Channel Attachment,make sure it is defined with the hard addressing option.

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 (notAtape), remove any existing device definitions for it. The following commandis an example: rmdev -l ost1 -d

Installation Procedure

Enter the following command to list the currently installed Atape.driver version:lslpp -l Atape.driver

Enter the following command to install the Atape driver in the current directoryfor exampleinstallp -acXd Atape.x.x.x.x Atape.driver

This installs and commits the Atape driver on the system.

Configuring Tape and Medium Changer DevicesAfter 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 isnot 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 thedevice 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 ormedium changer devices).or

v Power Off your subsystem and reboot the system to configure it automaticallyand make available any new tape or medium changer devices on the system.

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 27

Page 46: IBM Tape Driver IUG 1

Deconfiguring Tape Devices

Note: In the following examples, replace the letter n with the appropriate numberfor 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, butleave it defined in the device database:rmdev -l rmtn

2. The second method brings the tape device offline and removes its definitionfrom the device database.Enter the following command:rmdev -l rmtn -d

The device driver is not unloaded from the kernel until the last device isdeconfigured.

Deconfiguring Medium Changer Devices

Note: In the following examples, replace the letter n with the appropriate numberfor 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 deviceoffline, but leave it defined in the device database:rmdev -l smcn

2. The second method brings the medium changer device offline and removes itsdefinition from the device database.Enter the following command:rmdev -l smcn -d

The device driver is not unloaded from the kernel until the last device isdeconfigured.

Uninstalling

Attention: All devices that use the Atape driver must be closed and cannot be inuse when Atape is uninstalled or the uninstall fails.

You can uninstall the Atape device driver using the smit command menu touninstall software and selecting Atape.driver or using the following installpcommand:installp -u Atape.driver

Tape Drive, Media, and Device Driver ParametersThis chapter describes the parameters that control the operating modes of the AIXEnhanced Tape and Medium Changer Device Driver.

AIX Device Driver (Atape)

28 IBM Tape Device Drivers Installation and User’s Guide

Page 47: IBM Tape Driver IUG 1

Configuration ParametersThe operating parameters for the tape drive and device driver are set and changedby configuration parameters. The installation defaults are provided for allparameters initially. The AIX smit command is used to set these parameters whenconfiguring a device or to change these parameters. The AIX chdev command isused to change the configuration parameters.

The configuration parameters are used to set the operating mode of the tape driveand device driver when a device is opened. These parameters are queried by anapplication. Some parameters can be temporarily changed during the opensubroutine by an application, but they are always restored to the configurationvalues when a device is closed. The configuration parameters are:v Alternate Pathingv Autoloadingv Emulate autoloader (359x devices only)v Block sizev Buffered mode (359x devices only)v Compressionv Fail degraded media (359x devices only)v Loggingv Maximum size of the log filev New logical namev Read error recovery time (359x devices only)v Record space modev Rewind immediatev Trailer labels

Alternate PathingThis parameter enables or disables the path failover support when a device isconfigured. “Data Path Failover and Load Balancing Support for Tape Drives” onpage 39 for a description of the path failover and failover support.

The installation default is Off (path failover is not enabled).

AutoloadingThis parameter enables the autoloading feature of the device driver. It is used withthe autoloading capability of the autoloader, ACF, ACL, or CSL installed on thetape device.

Note: The autoloading feature is not supported on the IBM 3584 UltraScalable TapeLibrary and the IBM 3583 Ultrium Scalable Tape Library with more than one IBM3580 Ultrium Tape Drive installed.

Note: The autoloading feature is supported only on the following device types andconfigurations:v IBM 3490E Models C11, C22, E01, E11, F01, and F11v IBM TotalStorage Enterprise Tape System 3590, Models B11, E11, and H11v IBM Magstar MP 3570 Models B01, C01, B11, and C11v IBM Magstar MP 3570 Models B02, B12, C02, and C12 (configured in split

mode only)v IBM 7332 (all models)

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 29

Page 48: IBM Tape Driver IUG 1

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 configurationswithout Atape autoload enabled, or on other UNIX® operating systems, or ondevice 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 bythe application. When the end of tape is reached, the device driver automaticallyrewinds and unloads the tape, loads the next tape, then continues reading orwriting 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) withoutprompting for a volume change.

The installation default is Off (no autoloading).

Emulate AutoloaderThis parameter controls how the device driver operates when the ACF on the IBMTotalStorage Enterprise Tape System 3590, the IBM Magstar MP tape device, or theIBM 3490E Model Fxx is set to Random mode. If this parameter is set to On and theACF 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 isunloaded, returned to the magazine, and the next tape in the magazine is loadedautomatically into the tape drive. If this parameter is set to Off, the normal unloadoperation occurs, and the tape remains in the drive.

The emulate autoloader parameter can be used for legacy applications written forthe IBM 3490E Automated Cartridge Loader (ACL) when the IBM TotalStorageEnterprise Tape System 3590, the IBM Magstar MP 3570, or the IBM 3490 Model Fautoloader is set to Random mode. This eliminates the need to re-configure theautoloader 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 issupported only when the two drives are configured in Split mode, or in Basemode with only one drive configured and available to AIX. This featuredoes not work in Base mode if both drives are in the available state to AIX.

Block SizeThis parameter specifies the block size used for read and write operations. A valueof zero is the variable block size. Any other value is a fixed block size.

AIX Device Driver (Atape)

30 IBM Tape Device Drivers Installation and User’s Guide

Page 49: IBM Tape Driver IUG 1

The installation default is zero (use variable length) except for the IBM 7332 4mmTape Cartridge Autoloader, for which the default is a fixed block size of 1024 bytes.

Buffered ModeWhen a write command is processed, the data is either stored directly on thephysical tape or buffered in the tape device. Buffering can increase the deviceperformance.

The installation default is On (use Buffered mode).

CompressionHardware compression is implemented in the device hardware. This parameterturns the compression feature On and Off. If compression is enabled, then theeffective performance can increase based on the compressibility of the data.

The installation default is On (use compression).

Fail Degraded MediaThis parameter controls whether the device driver fails a tape operation whendegraded 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 fromthe tape, the device driver is notified when the first command is sent to the tapedrive. If this parameter is set to On, the device fails the command and returns amedia error to the application. If this parameter is set to Off, the device driverdoes not fail the command.

Degraded media is a correctable condition that prevents the IBM TotalStorageEnterprise Tape System 3590 from performing high speed Locate operations. ALocate command can take over 20 minutes, depending on the desired position andthe amount of data on the tape. This parameter is intended for use by real timeapplications that cannot tolerate long Locate commands.

The installation default is Off (do not fail the tape operation if degraded media isdetected).

LoggingThis parameter turns the volume information logging on and off. If logging is setto On, the statistical information about the device and media is saved in a log filewhen a tape is unloaded. If logging is set to Off, the information is not saved. Thisparameter has no effect on error logging because error logging is always enabled.For more information, refer to “Device and Volume Information Logging” on page43.

The installation default is Off (no logging).

Maximum Size of the Log FileThis parameter specifies the number of entries made before the log file starts towrap. Each entry is approximately 2 KB (2048 bytes). After the log file starts towrap, the number of entries stays constant. Each time a new entry is made, theoldest entry is overlaid. For more information, refer to “Device and VolumeInformation Logging” on page 43.

The installation default is 500.

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 31

Page 50: IBM Tape Driver IUG 1

New Logical NameSetting this parameter changes the logical name of the device to a new name asspecified. After the logical name is changed, the new logical name parameter iscleared.

There is no installation default value for this parameter.

Read Error Recovery TimeThis parameter controls the read error recovery time for the IBM TotalStorageEnterprise Tape System 3590. If this parameter is set to On, the recovery time forread 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 parameteris intended for use by real-time applications that cannot tolerate long delays whenreading data from the tape.

The installation default is Off (do not limit the read error recovery time).

Record Space ModeThis parameter specifies how the device driver operates when a forward orbackward space record operation encounters a filemark. The two modes ofoperation are SCSI and AIX.

The SCSI mode is the default mode of operation. When a forward or backwardspace record operation is issued to the driver and a filemark is encountered, thedevice 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 filemarkon the forward space and the beginning-of-tape side of the filemark on thebackward space).

The AIX mode returns the same EIO errno value as the SCSI mode when a filemarkis encountered except that the tape is left positioned before the filemark (thebeginning-of-tape side of the filemark on the forward space and the end-of-tapeside of the filemark on the backward space).

The installation default is SCSI mode.

Rewind ImmediateThis parameter turns the immediate bit On and Off in rewind commands. If it isset to On, then the rewind tape operation executes faster, but the next commandtakes 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 fora Rewind on Close special file.

The installation default is Off (no rewind immediate) except for the IBM 7332 4mmTape Cartridge Autoloader, for which the default is On (rewind immediate).

Trailer LabelsIf this parameter is set to On, then writing a record past the early warning markon the tape is allowed. The first write operation to detect EOM fails, and the errnovariable is set to ENOSPC. No data is written during the operation. All subsequentwrite operations are allowed to continue until the physical end of the volume isreached and EIO is returned.

This parameter can also be selected using one of three device special files thatallow 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).

AIX Device Driver (Atape)

32 IBM Tape Device Drivers Installation and User’s Guide

Page 51: IBM Tape Driver IUG 1

The installation default is Off (no trailer labels).

Media ParametersThe ability to set or change media parameters is a tape diagnostic and utilityfunction, refer to Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or“AIX System - Tape Utility Program (tapeutil)” on page 362.

The media parameters can be queried and set by ITDT or the tape diagnostic andutility function using the Query/Set Parameters option in the window.

These parameters cannot be set or changed by the configuration procedures. Themedia parameters are:v Capacity scalingv Logical write protectv Volume ID for logging

Capacity ScalingThis parameter sets the capacity or logical length of the current tape on IBMTotalStorage Enterprise Tape System 3590, IBM TotalStorage Enterprise TapeSystem 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 setat 75%, 50%, or 25% of the tape or any device specific hexadecimal value. Forexample 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 theoption to enter a hexadecimal value and enter 35. Capacity scaling remains withthe tape across mounts until it is changed.

Notes:

1. The tape position must be at the start of the tape to change this parameter fromits 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. Forexample, 60 GB media for the IBM 3592 cannot be capacity scaled and isalways 100%.

Logical Write ProtectThis parameter sets or resets the logical write protect of the current tape on IBMTotalStorage Enterprise Tape System 3590, IBM TotalStorage Enterprise TapeSystem 3592, or Magstar MP tape subsystems. The three types of logical writeprotect are: associated protect, persistent protect, and write-once read-many(WORM) protect.

Associated protect remains only while the current tape is mounted or associatedwith 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 persistentprotect) it cannot be reset on the tape. After a tape is WORM protected, it cannever be written on again.

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 33

Page 52: IBM Tape Driver IUG 1

Notes:

1. The tape position must be at the start of the tape to change this parameter fromits current value.

2. Attempting to set logical write protect that is not supported by a device or thecurrent media loaded always returns ″No″ and cannot be changed.

Volume ID for LoggingThis parameter is the volume ID of the current loaded tape. It is used in the logfile entry (if volume logging is active) to identify the entry with a particularvolume. The device driver sets the volume ID to UNKNOWN initially and whenthe tape is unloaded.

Automatic Cartridge Facility ModeIf the IBM TotalStorage Enterprise Tape System 3590 or Magstar MP tapesubsystem has an ACF installed, then the ACF mode can be queried by the tapeutilapplication using the Query/Set Parameters option in the window.

Note: ITDT does not support the IBM TotalStorage Enterprise Tape System 3590.See “AIX System - Tape Utility Program (tapeutil)” on page 362 forinformation on the tapeutil application.

Special FilesOnce 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 thestandard AIX special files for tape devices (with other files unique to the Atapedriver), are in the /dev directory.

Special Files for Tape DevicesEach tape device has a set of special files that provides access to the same physicaldrive but to different types of functions. As shown in Table 6, in addition to thetape special files, a special file is provided for tape devices that allows access to themedium changer as a separate device.

Note: The asterisk (*) represents a number assigned to a particular device (such asrmt0).

For tape drives with attached SCSI medium changer devices, the rmt*.smc specialfile provides a separate path for issuing commands to the medium changer. Whenthis special file is opened, the application can view the medium changer as aseparate SCSI device.

Both this special file and the rmt* special file can be opened at the same time. Thefile descriptor that results from opening the rmt*.smc special file does not supportthe following operations:v Readv Writev Open in Diagnostic modev 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 tothe rmt* special file. For detailed information, refer to Table 6 on page 35.

AIX Device Driver (Atape)

34 IBM Tape Device Drivers Installation and User’s Guide

Page 53: IBM Tape Driver IUG 1

Table 6. Special Files for Tape Devices

Special File NameRewind on

Close (Note 1)Retension onOpen (Note 2)

Bytes per Inch(Note 3) Trailer Label

Unload onClose

/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

/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 thesetape 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 isautomatic.

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) callscan be issued to this file without a real device attached to it, and the device driver returns a successfulcompletion. Read and write system calls return the requested number of bytes. This file can be used forapplication development or debugging problems.

6. The rmt*.smc file can be opened independently of the other tape special files.

Special Files for Medium Changer DevicesAfter the driver is installed and a medium changer device is configured and madeavailable for use, access to the robotic device is provided through the smc* specialfile in the /dev directory.

Table 7 shows the attributes of the special file. The asterisk (*) represents a numberassigned to a particular device (such as smc0). The term smc is used for a SCSImedium changer device. The smc* special file provides a path for issuingcommands to control the medium changer robotic device. For more information,refer to Table 7.

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

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 35

Page 54: IBM Tape Driver IUG 1

Table 7. Special Files for Medium Changer Devices (continued)

Special File Name Description

Note: The smc*.null file is a pseudo device similar to the /dev/null AIX special file. Thecommands can be issued to this file without a real device attached to it, and the devicedriver returns a successful completion. This file can be used for application developmentor debugging problems.

The file descriptor that results from opening the smc special file does not supportthe following operations:v Readv Writev Commands designed for a tape device

Persistent Naming SupportPersistent naming support is used to ensure that attached devices are alwaysconfigured with the same logical name based on the SCSI ID, LUN ID, and hostbus adapter (HBA), even when the system is rebooted.

When the AIX operating system is booted, the HBA performs a device discoveryand assigns a default logical name to each device found in a sequential order. Forexample, if there are three tape drives attached to a parallel SCSI adapter, eachwith a LUN ID of 0 and a target address of 0, 1, and 2 respectively, the HBAwould initially configure them as Available with the following logical names:

rmt0 target 0, lun 0 Availablermt1 target 1, lun 0 Availablermt2 target 2, lun 0 Available

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

rmt0 target 0, lun 0 Availablermt1 target 2, lun 0 Available

If the previous rmt1 target 1 device is powered on after reboot and the cfgmgrcommand is run, the HBA configures the device as rmt2 instead of rmt1:

rmt2 target 1, lun 0 Available

This is one example, but there are other cases where the logical names of devicescould change when the system is rebooted. For applications that need a consistentnaming convention for all attached devices, this is accomplished with persistentnaming support by defining a unique logical name (other than the AIX defaultnames) that are associated with the specific SCSI ID, LUN ID, and HBA that thedevice is connected to.

Changing the Logical Name After Initial BootThe 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 orcommand line.

AIX Device Driver (Atape)

36 IBM Tape Device Drivers Installation and User’s Guide

Page 55: IBM Tape Driver IUG 1

For example, a default rmt0 logical name for a tape drive could be changed tormt-0, tape0, or any descriptive name desired. In this example, if the three tapedrives are changed to rmt-0, rmt-1, and rmt-2 respectively, and the system is thenrebooted with rmt-1 powered off, the HBA detects that there are unique namespredefined 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 Availablermt-1 target 1, lun 0 Definedrmt-2 target 2, lun 0 Available

Since rmt-1 is not detected by the HBA but has been predefined at the SCSI ID andLUN ID, it remains in the defined state and is not configured for use, but the nextrmt-2 tape drive configures as the same name at the same location after reboot.

Using SMIT to Change the Logical NameTo 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 NameThe logical name of a device can be changed using the chdev command. Forexample, 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 aprimary 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 toenabling the path failover support in the Atape device driver. Refer to“Automatic Failover” on page 12 for what feature codes may be required foryour machine type.

The Atape device driver path failover support configures multiple physical controlpaths to the same logical library within the device driver and provides automaticfailover 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 SupportPath failover support is not enabled automatically when the device driver isinstalled. 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 thedevice is deleted or the support is unconfigured. The alternate path failover settingis retained even if the system is rebooted.

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 37

Page 56: IBM Tape Driver IUG 1

To enable or disable the support on a single logical device, use the smit menu toChange/Show Characteristics of a Tape Drive, select the logical device to changesuch as smc0, smc1, and so on, then select Yes or No for Enable Path FailoverSupport. The support can also be enabled or disabled using the chdev command,for example:chdev -l smc0 -aalt_pathing=yeschdev -l smc1 -aalt_pathing=yeschdev -l smc0 -aalt_pathing=nochdev -l smc1 -aalt_pathing=no

Primary and Alternate PathsWhen the device driver configures a logical device with path failover supportenabled, the first device configured always becomes the primary path. On SCSIattached 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 forthe same physical device, it configures as an alternate path. On SCSI attacheddevices, -A is appended to the location field. On Fibre attached devices, -ALT isappended to the location field of the device.

A third logical device is also configured as an alternate path with either -A or -ALTappended, and so on. The device driver supports up to 16 physical paths for asingle device.

The labeling of a logical device as either a primary or alternate path is forinformation 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 onelogical device labeled as the primary path for each physical device. However,there can be many (multiple) logical devices labeled as an alternate path for thesame devices.

2. Provide information about which logical devices configured on the system havepath failover support enabled.

Querying Primary and Alternate Path ConfigurationsYou can display the primary and alternate path configuration for all devices withthe lsdev command. There can be two or more logical devices configured for asingle physical device, but the first device configured is labeled the primary device.All other logical devices configured after the first device are labeled as alternatedevices. To see this, run the lsdev -Cc tape command and look at the location fieldin the data. Run the following command:lsdev -Cc tape | grep P

For example, you can easily determine how many physical devices are configuredwith path failover support.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “AIX System - Tape Utility Program(tapeutil)” on page 362.

AIX Device Driver (Atape)

38 IBM Tape Device Drivers Installation and User’s Guide

Page 57: IBM Tape Driver IUG 1

Configuring and Unconfiguring Primary and Alternate DevicesLogical devices configured as alternate paths can be unconfigured andreconfigured at any time after the initial configuration is run. Unconfiguring analternate 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 tothe Defined state. The primary and any other alternate devices are still available.

Likewise, configuring a new alternate path device or reconfiguring an existing onein 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 andreconfigured at any time after initial configuration is run. However, the operationis different for a primary device. When a primary device is unconfigured, thefollowing 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 alternatedevices are reconfigured as alternate paths.

These methods provide the ability to unconfigure and reconfigure physical deviceson the system when device connections or addressing changes are made.

Data Path Failover and Load Balancing Support for Tape DrivesNotes:

1. Some devices require a path failover feature code installed prior to enabling thepath failover support in the Atape device driver. Refer to “Automatic Failover”on page 12 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 onUltrium-3 and Ultrium-4 drives.

3. This function is not supported for devices that are attached through an IBMSan 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 areinitially configured at a specific SCSI ID and physical connection (drive port,host bus adapter, and switch number/port, if applicable) and in the Availablestate, changing the physical device address/connection without either rebootingor unconfiguring and reconfiguring the devices has unpredictable results and isnot supported.

Installing Data Path Failover License KeyUse the following command line script to query, add, or delete license keys for thisfeature before enabling the path failover feature as described below. The key is a16-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_keysv Install a license key: dpf_keys -a key

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 39

Page 58: IBM Tape Driver IUG 1

v Delete a license key: dpf_keys -d key

Configuring and Unconfiguring Path Failover SupportPath failover support is not enabled automatically when the device driver isinstalled. 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 thedevice is deleted or the support is unconfigured. The path failover setting isretained even if the system is rebooted.

Path failover support can be enabled on all configured devices at one time, or itcan be enabled or disabled selectively by logical device. It may be desirable attimes to configure some, but not all, logical paths to a device with the supportenabled.

To enable the support globally on all currently configured devices, run thecommand:/usr/lpp/Atape/instAtape -a

This unconfigures all devices that have path failover set to No, and reconfigures alldevices, setting path failover to Yes.

To enable or disable the support on a single logical device, use the smit menu toChange/Show Characteristics of a Tape Drive, then select Yes or No for EnablePath Failover Support. The support can also be enabled or disabled using thechdev command, for example:chdev -l rmt0 -aalt_pathing=yes

chdev -l rmt0 -aalt_pathing=no

Primary and Alternate PathsWhen the device driver configures a logical device with path failover supportenabled, the first device configured always becomes the primary path and PRI isappended to the location field of the device. When a second logical device isconfigured with path failover support enabled for the same physical device, itconfigures as an alternate path and ALT is appended to the location field. A thirdlogical device is configured as the next alternate path with ALT appended, and soon. 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 commandoutput 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 thefollowing: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)

The labeling of a logical device as either a primary or alternate path is forinformation 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 onelogical device labeled the primary path for each physical device. However,there may be many (multiple) logical devices labeled as an alternate path forthe same devices.

AIX Device Driver (Atape)

40 IBM Tape Device Drivers Installation and User’s Guide

Page 59: IBM Tape Driver IUG 1

2. Provide information about which logical devices configured on the system havepath failover support enabled.

Querying Primary and Alternate Path ConfigurationYou can display the primary and alternate path configuration for all devices withthe lsdev command. There may be two or more logical devices configured for asingle physical device, but the first device configured is labeled the primary device.All other logical devices configured after the first device are labeled as alternatedevices.

To see this, run the lsdev -Cc tape command and look at the location field in thedata. By running lsdev -Cc tape | grep PRI, for example, you can easily determinehow 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 DevicesLogical devices configured as alternate paths can be unconfigured andreconfigured at any time after the initial configuration is run. Unconfiguring analternate path device removes that device from the primary device path list,removes the ALT appended to the location field, and changes the device to theDefined state. The primary and any other alternate devices are still available.Likewise, configuring a new alternate path device or reconfiguring an existing onein the Defined state adds that device to the primary device path list, appends ALTto the location field, and makes the device available.

Logical devices that are configured as primary paths can also be unconfigured andreconfigured at any time after initial configuration is run. However, the operationis different for a primary device. When a primary device is unconfigured, thefollowing 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 alternatedevices are reconfigured as alternate paths.

These methods provide the ability to unconfigure and reconfigure physical deviceson the system when device connections or addressing changes are made.

System-Managed Encryption

Device Driver ConfigurationSystem-Managed Encryption can be set on a specific tape drive using the standardSMIT panels to Change/Show Characteristics of a tape device or the command linechdev command. There are 2 new attributes added for encryption:sys_encryption “yes/no” Use System Encryption FCP Proxy Managerwrt_encryption “off/on/custom” System Encryption for Write Commands at BOP

The sys_encryption attribute enables device driver system-managed encryption fora tape drive by setting the value to yes.

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 41

Page 60: IBM Tape Driver IUG 1

The wrt_encryption attribute controls whether the device driver can set the tapedrive to encryption enabled for write commands. When set to off, the tape driveuses encryption for read operations; write operations do not use encryption. Whenset to on, the tape drive uses encryption for both read/write operations. When setto custom, the device driver does not modify current tape drive setting. Thecustom setting is intended for applications using system-managed encryption tocontrol write encryption without device driver intervention.

Note: If wrt_encryption is set to on, an application can not open a tape driveusing the append mode.

Querying Tape Drive Configuration

This is a tape diagnostic and utility function, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “AIX System - Tape Utility Program(tapeutil)” on page 362.

Testing Data Encryption Configuration and ConnectivityThere is a data encryption test available to validate the ibmekm.conf file serverentries and test tape drive to server connectivity operations.

This is a tape diagnostic and utility function, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “AIX System - Tape Utility Program(tapeutil)” on page 362.

Error LoggingEncryption errors are logged along with other tape operation errors using thestandard TAPE_ERR1 Template “Tape Operation Error” with associated sense datain the detail data.

An encryption failure is indicated when the asc/ascq in the sense data is EFxx orEExx. Refer to the tape drive hardware reference for specific information on theasc/ascq being reported. The asc/ascq can be found in the first column of thesecond row in detail sense data. For example:Detail DataSENSE DATA0A00 0000 5A08 25FF 0000 00FF FF00 0000 0000 0000 F000 0600 0000 1458 0000 0000EF11 FF02 D105 0000 0009 0191 0002 0000 0000 0A00 0000 0000 0000 0000 0000 00000000 0000 0000 FFFF FF00 0000 FFF0 B7E3 0001 2127 0000 0000 0000 0000 3930 32202020 2000 0041 4A00 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 00000000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000

Field Support InformationWhen encryption failures require field support and/or development analysis thefollowing data should be provided for a problem on a specific tape drive from themachine (rmt1 for example) for the device driver. Tape drive dumps and EKMserver logs may be needed in addition to this information.errpt –a > errpt.rmt1lsattr –El rmt1 > lsattr.rmt1tapeutil –f /dev/rmt1 encryption > encryption.rmt1All Atape files in /var/adm/ras/Atape*

AIX System-Managed Encryption

42 IBM Tape Device Drivers Installation and User’s Guide

Page 61: IBM Tape Driver IUG 1

Problem DeterminationA set of tools is provided with the device driver to determine if the device driverand the tape device are functioning correctly. The standard AIX interface isprovided for problem determination.

Using the Dump SupportDump support is provided through the dump entry point in the driver. Refer toappropriate AIX manuals for a description of how to use the dump devices andhow 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 followingcommand:sysdumpdev -s /dev/rmt1

To perform a dump operation, use the sysdumpstart command. To send the dumpdata to the secondary dump device, enter the following command:sysdumpstart -s

Note: This command stops the system. Use the sync command to ensure that thecache 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 usingthe crash command to process it. For example:dd if=/dev/rmt1 of=tapedump1 ibs=4096 obs=512crash 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 thedump process, the dump operation fails. Set the block size to zero on the tapedevice and experiment with the ibs value for the dd command.

Device and Volume Information LoggingAn optional logging utility is provided to log the information about the device andthe media. The information is extensive for some devices and limited for otherdevices. If set to On, the logging facility gathers all available information throughthe SCSI Log Sense command.

This process is a separate facility from error logging. Error logging is routed to thesystem error log. Device information logging is sent to a separate file.

The following parameters control this utility:v Loggingv Maximum size of the log filev Volume ID for logging

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 43

Page 62: IBM Tape Driver IUG 1

Refer to “Tape Drive, Media, and Device Driver Parameters” on page 28 for adescription of these parameters.

Each time the rewind and unload sequence occurs or the STIOC_LOG_SENSE ioctlcommand is issued, an entry is added to the log. Each time a new cartridge isloaded, 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 FileThe data is logged in the /usr/adm/ras directory. The file name is dependent on eachdevice; therefore, each device has a separate log. An example of the rmt1 devicefile is:/usr/adm/ras/Atape.rmt1.log

The files are in binary format. Each entry has a header followed by the raw LogSense pages as defined for a particular device.

The first log page is always page 0x00. This page, as defined in the SCSI-2 ANSIspecification, contains all pages the device supports. Page 0x00 is followed by allpages specified in page 0x00. The format of each following page is defined in theSCSI specification and the device manual.

Tape Log UtilityA tape log utility is installed with the tapelog device driver that displays thecontents of the log file in ASCII text. The log pages are displayed as hexadecimalvalues in dump format.

The C source code (tapelog.c) for the program is in the /usr/lpp/Atape/samplesdirectory. The program contains a sample of the interface to the log file and thestructure used to read the file.

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 afile, use the AIX redirection function. For example:tapelog -l rmt0 > rmt0.log

Reservation Conflict LoggingWhen the device driver receives a reservation conflict during open or after thedevice has been opened it will log a reservation conflict in the AIX error log. Priorto logging the error the device driver will issue a Persistent Reserve In commandto determine if a SCSI Persistent Reservation is active on the reserving host to getthe reserving host initiator WWPN (World Wide Port Name) and reserve key. Ifsuccessful, 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 thereserving host initiator WWPN.

AIX Device Driver (Atape)

44 IBM Tape Device Drivers Installation and User’s Guide

Page 63: IBM Tape Driver IUG 1

After initially logging the reserving host WWPN, subsequent reservation conflictsfrom the same reserving host WWPN will not be logged to prevent multipleentries in the error log until either the reserving host WWPN is different than theone initially logged or the device driver has reserved the device and then anotherreservation conflict occurs.

If the Persistent Reserve In command fails then the detail data will contain thefollowing 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 commandv EINVAL - Device has a Persistent Reservation but does not support the

Persistent Reserve In service actionv EBUSY - Device has failed the command with reservation conflict and has a

SCSI-2 Reserve activev EIO - Unknown I/O failure occurred

Error LoggingThe 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 Analysisutility provided with the tape drive service aids. Refer to “Error Log Analysis” onpage 50. The error log can also be viewed using the smit or the errpt command.

Error Log TemplatesThe error log templates the device driver uses follow the same format as thedefault AIX tape error log entries. Each error log entry is identified by an errorlabel and contains detail data associated with the type of error. The following itemsdescribe the error labels and detail data for the templates used for logging tapedevice, media, and SCSI adapter related errors in the AIX system error log.

Error LabelsErrors are logged with an associated error label and error ID. The error labelindicates the basic type of error:v TAPE_ERR1

Tape media errorv TAPE_ERR2

Tape hardware errorv TAPE_ERR4

SCSI Adapter detected errorv TAPE_ERR5

Unknown errorv RECOVERED_ERROR

Temporary tape hardware or media errorv 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

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 45

Page 64: IBM Tape Driver IUG 1

v TAPE_DRIVE_CLEANINGTape drive needs cleaning

v RESERVE_CONFLICTReservation conflict

Detail DataDetail 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 entriescontain the raw data from Log Sense Page X'31'. Refer to the hardware referencemanual for the format of this entry. All other error log entries use the followingformat for detail data:Detail DataSENSE DATAaabb xxxx ccdd eeee eeee eeee eeee eeee ffgg hhxx ssss ssss ssss ssss ssssssss 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, andbyte gg indicates the type of error. If this field is 02, then an adapter errorwas 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 parallelSCSI 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.

AIX Device Driver (Atape)

46 IBM Tape Device Drivers Installation and User’s Guide

Page 65: IBM Tape Driver IUG 1

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 toselect it.05 ADAPTER HARDWARE FAILURE - Adapter indicated a hardwarefailure.06 ADAPTER SOFTWARE FAILURE - Adapter indicated a microcodefailure.07 WW NAME CHANGE - Adapter detected a new worldwide namefor the device.08 FUSE OR TERMINAL PWR - Blown terminator fuse or badtermination.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 thedevice. Refer to the appropriate device reference manual for the specificformat and content of these bytes.

Automatic Dump FacilityThe device driver provides an automatic dump facility for devices that supportreading 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 isavailable, 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 inthis directory as:Atape.rmtx.dump1Atape.rmtx.dump2Atape.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 thanthree dumps occur, the driver starts over at dump1; therefore the last three dumpsare always kept.

Trace FacilityThe AIX trace facility is supported for the device driver. The trace event isidentified with a hookword. The hookword used by the device driver is 326. Thetrace 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 eventswith the 326 hookword (Atape device driver).

Enter the following AIX command to stop the trace:trcstop

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 47

Page 66: IBM Tape Driver IUG 1

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 afile for viewing.

Atape System Trace (ATRC) UtilityThe atrc trace utility is also installed with the device driver to start, stop, andformat a device driver trace. To start the trace, enter the atrc command. To stopand format the trace, enter the atrc command again. The trace is formatted to anatrc.out AIX file in the current directory.

Component TracingLater releases of AIX 5.3 and above support component tracing. Unlike systemtracing that needs to be started and stopped, component tracing by default is onall the time and runs continually.

To determine if component tracing is available run the command ctctrl -q todisplay a list of supported components with their default settings. You must haveroot authority to run this command. Refer to the AIX ctctrl man page for acomplete 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 Atapetrcrpt -l Atape -o actrc.out

The Atape component trace can also be retrieved from a system dump. Thiseliminates the need to start the Atape system trace prior to a system dump or torecreate an AIX system dump when a system trace is not running. The AIX systemdump is normally stored in the /var/adm/ras directory as a vmcore.x.BZ file, where xis 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 thefollowing commands:dmpuncompress /var/adm/ras/vmcore.1.BZtrcdead -c /var/adm/ras/vmcore.1trcrpt -l Atape -o actrc.dump

Atape Component Trace (ACTRC) UtilityThe actrc component trace utility is also installed with the device driver to dumpand format the current Atape component trace. To dump and format thecomponent trace, run the command actrc. The trace is formatted to an actrc.out filein the current directory.

Tape Drive Service AidsThe service aids provided with the device driver can be called using the interactiveinterface of the tape utility program and selecting Tape Drive Service Aids underGeneral Commands or using the Service Aid Subcommands in the command-lineinterface of the tape utility program.

AIX Device Driver (Atape)

48 IBM Tape Device Drivers Installation and User’s Guide

Page 67: IBM Tape Driver IUG 1

The service aids described in the following sections are accessible through the AIXdiagnostic subsystem using the AIX diag command, or the interactive andcommand-line interfaces of the tapeutil program installed with the device driver.Refer to “Details of Tape Service Aids” and “Service Aid Subcommands” on page370.

For tape diagnostic and utility functions refer to Chapter 10, “IBM Tape DiagnosticTool (ITDT),” on page 259 or “AIX System - Tape Utility Program (tapeutil)” onpage 362.

Details of Tape Service AidsThe following service aid utilities are installed with the device driver:v Force Microcode Dumpv Read Dumpv Microcode Loadv Error Log Analysisv Reset Drivev Create an FMR Tape

Force Microcode DumpThis utility forces a dump operation on the tape drive. After the dump operation isperformed, the dump data can be transferred from the tape drive using the ReadDump 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 theoperation is completed.

Read DumpThis utility transfers the dump data from the device to a file, a diskette, or a tapecartridge.

To access this utility:1. Open the Service Aids window.2. Select Read 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.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 thedump data to a tape cartridge, enter the device name of the tape drive (forexample, /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 andthe number 7 key instead of F7.

The Read Dump operation starts, and a window opens when the operation iscompleted.

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 49

Page 68: IBM Tape Driver IUG 1

Microcode LoadThis utility downloads microcode to the device from a file or a diskette (AIXformat only).

Note: To download the microcode from a DOS diskette, you must first use the AIXdosread 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 tothe tape drive.

To access this utility:1. Open the Service Aids window.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 thefile name. Press F7 to commit.

Note: On certain terminal types, it may be necessary to press the Esc key andthe number 7 key instead of F7.

5. If the current microcode on a tape drive is Federal Information ProcessingStandard (FIPS) code, then a window opens and displays the following:

Warning: The drive is currently using FIPS code. Press Enter tocontinue with downloading new drive code.

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

The Microcode Load operation starts, and a window opens when the operation iscompleted.

Error Log AnalysisThis utility displays and analyzes the system error log entries for a specific tapedrive and can be used for problem determination. The type of error, the SCSIcommand, and the sense data (if applicable) are displayed for each entry in theerror log (one screen at a time).

To access this utility:1. Open the Service Aids window.2. Select Error Log Analysis 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.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.

AIX Device Driver (Atape)

50 IBM Tape Device Drivers Installation and User’s Guide

Page 69: IBM Tape Driver IUG 1

Reset DriveThis utility resets the tape drive.

To access this utility:1. Open the Service Aids window.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 iscompleted.

Create an FMR TapeThis utility creates a field microcode replacement (FMR) cartridge tape using theloaded functional microcode in the tape drive.

To access this utility:1. Open the Service Aids window.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 theoperation is completed.

Performance ConsiderationsThis chapter describes the parameters and issues that may affect the perceivedperformance of the tape drive. In general, AIX applications that operate at a filelevel to move data between disk storage devices and tape do not exploit the fullcapabilities of a high end tape device. The goal of this discussion is to give anoverview of the data path components involved in moving data between diskstorage devices and tape. The following chapter describes basic techniques andcommon utilities in a specific environment that can be used to understand how adevice is performing. Performance issues encountered by advanced applicationdevelopers 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 PathThe simplified model in Figure 8 shows the components involved in the data pathfor moving data at a file level between disk storage devices and tape.

Performance analysis must be approached by determining which component of thedata path impacts performance. Typically, a performance problem can be isolatedby looking at one leg of the data path at a time. The goal of this analysis is toconfirm that the tape data path is not impacting the performance adversely.

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 51

Page 70: IBM Tape Driver IUG 1

Common AIX UtilitiesThe most commonly reported cause for poor tape performance is the use of smallblock sizes or the modification of the installation defaults for the tape device.

Note: The device parameters should not be changed from the defaults for mostapplications.

The following guidelines typically result in good tape path performance for usewith 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 PerformanceIn releases of AIX 5.3 and earlier, the AIX iostat utility supports tape performancestatistics in addition to other supported devices (such as disk). To determine if theiostat utility supports the configured tape drives, run the command iostat -p. If theconfigured tape drives are supported, a list of configured tape drives are displayedwith the statistics listed for each drive. Refer to the AIX iostat man page for acomplete description of the iostat command and parameters. When using the DataPath Failover feature, only the primary path for the tape drive is listed. Thestatistics apply to both the primary and alternate paths that are used.

Before Calling SupportSystem performance tuning is not a support responsibility. If tests indicate rawtape performance is below specifications, record the exact failing command andcollect the output from the commands in Table 8 before contacting support.

Table 8. Error Description

Information Command

Configuration lscfg -v

Device parameters lsattr -E -l rmtN

Error log. Call hardware support if errorsare found for TAPE_ERR* or SCSI* errorlabels.

errpt -a

Driver version lslpp -l Atape.driver

Figure 8. Data Path for AIX Device Driver (Atape)

AIX Device Driver (Atape)

52 IBM Tape Device Drivers Installation and User’s Guide

Page 71: IBM Tape Driver IUG 1

Table 8. Error Description (continued)

Information Command

Device microcode level (may not apply to alldevices)

tapeutil -f /dev/rmtN reqsense

Trace of failing command Refer to “Trace Facility” on page 47

AIX Device Driver (Atape)

Chapter 3. AIX Tape and Medium Changer Device Driver 53

Page 72: IBM Tape Driver IUG 1

AIX Device Driver (Atape)

54 IBM Tape Device Drivers Installation and User’s Guide

Page 73: IBM Tape Driver IUG 1

Chapter 4. HP-UX Tape and Medium Changer Device Driver

Purpose . . . . . . . . . . . . . . . 55Data Flow . . . . . . . . . . . . . . . 55Product Requirements . . . . . . . . . . . 56

ATDD Implementation . . . . . . . . . 56Hardware Requirements . . . . . . . . . 56Software Requirements . . . . . . . . . 57Software Interface to the Device Driver . . . . 58

Installation and Configuration Instructions . . . . 58Installation and Configuration for PCI Drivers. . 58Installation and Configuration of Precision BusDrivers . . . . . . . . . . . . . . . 66

Supported Configuration Parameters . . . . . . 75Configuration Parameter Definitions . . . . . 75

Special Files . . . . . . . . . . . . . . 79Persistent Naming Support . . . . . . . . . 80Control Path Failover Support for Tape Libraries . . 81

Configuring and Unconfiguring Path FailoverSupport . . . . . . . . . . . . . . 81Primary and Alternate Paths. . . . . . . . 82

Querying Primary and Alternate PathConfigurations . . . . . . . . . . . . 82Disable and Enable Primary and Alternate Paths 82

Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 83

Configuring and Unconfiguring Path FailoverSupport . . . . . . . . . . . . . . 83Primary and Alternate Paths. . . . . . . . 84Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 85Disable and Enable Primary and Alternate Paths 85

Problem Determination . . . . . . . . . . 85Error Logging . . . . . . . . . . . . 85Reservation Conflict Logging . . . . . . . 85Sense Data Logging . . . . . . . . . . 86Support_info Script . . . . . . . . . . . 86Tracing Facility . . . . . . . . . . . . 86Atdd_d Log Daemon . . . . . . . . . . 87Problems and Solutions . . . . . . . . . 89

This chapter provides an overview of the IBM Tape and Medium Changer DeviceDriver for HP-UX that provides support for IBM tape drives and medium changerdevices.

For tape diagnostic and utility functions refer to Chapter 10, “IBM Tape DiagnosticTool (ITDT),” on page 259 or “HP-UX System - Tape Utility Program (tapeutil)” onpage 375.

PurposeThis device driver product provides SCSI-3 attachment for the IBM tape devices toselected Hewlett-Packard Precision Bus and PCI-based operating systems runningHP-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 theIBM tape devices (refer to “Supported Hardware” on page 9. The goal is to giveapplications access to the functions required for basic operations (such as backupand restore) and the advanced functions needed by full tape management systems.Whenever possible, the device driver is designed to take advantage of the IBMtape system features transparent to the application.

Data FlowBoth data and commands flow between the application program and the tapesubsystem by way of the IBM Tape and Medium Changer Device Driver forHP-UX (ATDD). Figure 9 on page 56 shows the relationships between the IBMTape and Medium Changer Device Driver for HP-UX, the application program, theSCSI or Fibre Channel adapter device driver, and the IBM tape subsystem.

© Copyright IBM Corp. 2007, 2009 55

Page 74: IBM Tape Driver IUG 1

Product RequirementsThe following hardware and software components are required and supported bythe IBM Tape and Medium Changer Device Driver for HP-UX (ATDD).

ATDD ImplementationATDD is actually a set of device driver implementations for operation in thefollowing 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.

Hardware RequirementsATDD 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)

ApplicationProgram

SCSI or FibreChannelAdapterDeviceDriver

ATDDDeviceDriver

IBMTape

Subsystem

a250104

Figure 9. Data Flow for HP-UX Device Driver (ATDD)

HP-UX Device Driver (ATDD)

56 IBM Tape Device Drivers Installation and User’s Guide

Page 75: IBM Tape Driver IUG 1

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 adapterv HP A6795A Fibre Channel PCI Tachyon XL2 host bus adapterv HP AB378A/B and AB379A/B PCI-X Fibre Channel Adapterv HP A6826A PCI-X Fibre Channel Adapter

Notes:

1. ATDD does not support tape devices that are attached to HSC/GSC busarchitectures.

2. For attachment of Enterprise Tape System 3590 and IBM Magstar MP devices toHP rp8400 (formerly V-Class) platforms, a feedthrough SCSI terminator, whichattaches to the A4800A Host Bus Adapter, is required. This feedthrough SCSIterminator is available as FC 9798 for Enterprise Tape System 3590 and FC 5098for the 3575 Tape Library Dataserver or MP 3570 C model tape subsystem.Attach the male end of the feedthrough SCSI terminator to the host adapterand connect the host end of the standard FC 51xx SCSI cable to thefeedthrough terminator. Terminate the SCSI bus at the last device on the bus asusual.

3. The low level FC-Tape protocol standard is not supported in the HP A5158AHBA firmware and users should restrict their SAN configurations. The jobs areaborted with HP-UX A5158A HBA configurations when errors are detected inthe SAN.The HP A5158A host adapter is not compliant with the Fibre Channel Protocolfor SCSI, second version (FCP-2), dated 17 November 2000, a draft proposed bythe American National Standard of Accredited Standards Committee (NCITS).

4. Using a single Fibre Channel host bus adapter (HBA) for concurrent tape anddisk operations is not recommended. Tape and disk devices requireincompatible HBA settings for reliable operation and optimal performancecharacteristics. Under stress conditions (high I/O rates for tape, disk, or both)where disk and tape subsystems share a common HBA, stability problems havebeen observed. These issues are resolved by separating disk and tape I/Ostreams onto separate HBAs and using SAN zoning to minimize contention.IBM is focused on assuring server and storage configuration interoperability. Itstrongly recommends that your implementation plan includes provisions forseparating disk and tape workloads.

5. The HP A6826A HBAs need the Qlogic firmware level B.11.11.02 or later. If theadapter is directly connected to a 3592 without a switch, then the topology onthe 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

Software RequirementsThe 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 isrequired.

The latest driver information can be found at the following site:ftp://ftp.software.ibm.com/storage/devdrvr/HPUX

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 57

Page 76: IBM Tape Driver IUG 1

Attention: To install ATDD in HP-UX 11i v3, some HP-UX patches must beapplied first on the system. For the detailed information, refer to the atdd.Readmefile at the following site:ftp://ftp.software.ibm.com/storage/devdrvr/HPUX/11i_PCI/

Software Interface to the Device DriverThe IBM Tape and Medium Changer Device Driver for HP-UX provides thefollowing 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 functioncall 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, mediumchanger device, and SCSI specific operations. It allows HP-UXapplications to access and control the features and attributes ofIBM SCSI tape subsystems programmatically.

For programming information, refer to the IBM Tape Device Drivers ProgrammingReference, GA32-0566.

Installation and Configuration InstructionsThe following sections describe the installation and configuration for three types ofHP-UX devices.

Installation and Configuration for PCI DriversThis chapter describes how to install, configure, and uninstall the IBM Tape andMedium Changer Device Driver for HP-UX (ATDD) for PCI-based systems. Bydefault, ATDD automatically configures all supported IBM tape drives that areattached and powered On when the system starts. ACDD, the changer part ofATDD, does not configure IBM Medium Changer devices by default because manyapplications 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 driverand acdd changer driver dynamic loadable kernel modules (DLKM). In HP-UX 11iv3, the ATDD package consists of five modules in the kernel:v atdd - static tape driver kernel modulev acdd - static changer driver kernel modulev atdd_leg - static legacy tape driver kernel modulev acdd_leg - static legacy changer driver kernel modulev 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 beset to configure (CLAIM) all attached IBM Medium Changer devices. Additionally,selected IBM Medium Changer devices can be configured by running the swinstallcommand 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 dependson whether all IBM tape drives are to be configured by ATDD or only selected

HP-UX Device Driver (ATDD)

58 IBM Tape Device Drivers Installation and User’s Guide

Page 77: IBM Tape Driver IUG 1

ones, and whether configured tape drives exhibit default behavior or requirespecific configuration settings. Additionally, for IBM Medium Changers, installationselection or post-installation configuration can determine whether all IBM MediumChangers should be configured, selectively configured, or NOT configured at all.

Preinstallation ConsiderationsMake sure your system is ready to install ATDD before you begin. Follow thesesteps 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 insteadof filename ensures this.

v All the software distributor commands (for example, swinstall or swcopy) can berun first with the -p flag to preview the command. After observing the previewoutput, you can reissue the command without the -p flag to perform the actualoperation.

v The software distributor commands are moderately complex scripts thatfrequently require several steps. The steps are typically Selection, Analysis, andExecution. Each step may produce useful information and error messages, so it isa good idea to carefully observe the results of the installation process as itoccurs.

If you encounter unexpected results during the installation, check the associatedlog file.

While using the software distributor commands, you may encounter the followingerror about mounted file systems:ERROR: "hostname/": One or more filesystems that appear in thefilesystem table are not mounted and cannot be mounted.

Many commands (for example, swinstall and swremove) attempt to mount all filesystems in the /etc/fstab file at the start of the analysis phase. This ensures that alllisted file systems are mounted before proceeding. This also helps ensure that filesare not loaded into a directory that may be below a future mount point, but itoften causes an error with NFS mounted file systems.

This error can be overridden using ’-x’ to set the mount_all_filesystems option toFALSE. When this option is used, the command finishes with a warning thatindicates no attempt is made to mount all file systems. For example:

# swinstall -x mount_all_filesystems=false -x ask=true -x autoreboot=true atddWARNING: "hostname:/": There will be no attempt to mount filesystemsthat appear in the filesystem table.

Create the Drive Configuration File, (Optional)If you are not using the standard device driver defaults, you must create aconfiguration file that directs the device driver on how to customize driverbehavior for particular IBM TotalStorage and System Storage devices. If all

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 59

Page 78: IBM Tape Driver IUG 1

configured devices are to use the device driver configuration defaults, it is notnecessary 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 61.

If you do need to create a Drive Configuration File, consult the followinginstructions.

The configuration file is named sbin/init.d/atdd and has the following syntax:ATDD_global_parameter=valueATDD_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 thedevice hardware path for IBM tape drives with a SCSI attachment, perform thefollowing 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 Channelattachment, 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 pathyou want to attach to if you are not using the installation defaults for driverbehavior. Create an entry in the /etc/rc.config.d/atdd configuration file for eachdevice you want the driver to attach. For example:

ATDD_HWPATH[0]=0/10/0/0.1.0ATDD_HWPATH[1]=0/10/0/0.6.0ATDD_HWPATH[2]=0/5/0/0.8.0.255.6.14.0

HP-UX Device Driver (ATDD)

60 IBM Tape Device Drivers Installation and User’s Guide

Page 79: IBM Tape Driver IUG 1

Note: This example shows that three devices are CLAIMED by the ATDD. If youhave a single 3590 device operating in one LUN mode, then you wouldhave only a single ATDD_HWPATH entry. If you have four tape devicesattached, four ATDD_HWPATH entries are required in the configuration file.

Create the Device Specific Configuration Entries (Optional): The ATDD isshipped with default settings for all configuration parameters. To change thesesettings, an entry is made in the configuration file assigning an appropriate valueto the desired configuration variable. Each device may have a different value foreach configuration variable. The index number associated with the configurationvariable associates the parameter setting with the device at the hardware path withthe same index.Example 1:

ATDD_IMMEDIATE[0]=1

This parameter allows application control to return from the device before therewind completes for the device at hardware path 0/10/0/0.1.0 (based on thehardware path entry in “Create the Hardware Path Entry” on page 60).Example 2:

ATDD_TRAILER[1]=1

This parameter allows write operations after an early end-of-tape warning for thedevice at hardware path 0/10/0/0.6.0. Refer to Table 9 on page 76 and Table 10 onpage 77 for a description of all configuration parameters.

Note: If you experience difficulties with your tape device, check the /etc/rc.log forerrors and correct the problem.

Power Off the Tape DrivesWhen the ATDD software is initially installed, it attaches itself to all tape drivesthat 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 precedingcommand 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 thisdriver, power Off the tape drive and run ioscan without the ’-k’ argument asfollows:

# ioscan -f -C tape

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 61

Page 80: IBM Tape Driver IUG 1

Install the Driver Using the ATDD Installation ScriptAn installation script (InstallAtdd) is provided to automate driver installation andperform some checking functions. It copies the latest version of the driver to thesoftware depot and installs the latest driver version.

To install ATDD with the script, download the install script from the ftp site, thenrun 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, oranswer ″N″ to allow the HP native changer driver to configure these MediumChanger devices.

Notes:

1. If a previous version of ATDD is installed on your system, uninstall it beforeattempting to install the latest version. Refer to “Uninstalling the software” onpage 66.

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 ManuallyInstalling the drivers manually requires the steps detailed in the following sections.1. “Copy the Software to the Software Depot” on page 62.2. “Install the ATDD Software” on page 62.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” onpage 66.

Copy the Software to the Software Depot:

Attention: If you do not copy the ATDD software into a depot, you will not beable 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 theappropriate drives are powered on, the ATDD software can be installed to the rootfile system using the HP-UX swinstall command. If the target root file system is theprimary, the ATDD software is configured automatically upon installation.

If the target is an alternate root file system, then the ATDD software is notconfigured automatically.

HP-UX Device Driver (ATDD)

62 IBM Tape Device Drivers Installation and User’s Guide

Page 81: IBM Tape Driver IUG 1

Note: If an earlier version of the product is already installed on the target root filesystem, the existing version is replaced. This is true even if the versionalready installed is more recent than the version being installed.

The following commands install ATDD from the depot to the default root filesystem 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 thecustomer, ″Would you like to activate the Medium Changer support by ATDD(Y/N)?″. Enter ″Y″ to allow the ATDD to configure all attached IBM MediumChanger devices, or answer ″N″ to allow the HP native changer driver to configurethese Medium Changer devices.

You can use swlist to list the software installed on the default root file system asfollows:

# swlist atdd

You can verify correct installation to the default root file system with the swverifycommand as follows:

# swverify atdd

After the installation is completed, run the ioscan command to list the tape drivesfound:

# ioscan -fknC tapeClass 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/dev/rmt/1m /dev/rmt/1mn /dev/rmt/c4t6d0BEST /dev/rmt/c4t6d0BESTn/dev/rmt/1mb /dev/rmt/1mnb /dev/rmt/c4t6d0BESTb /dev/rmt/c4t6d0BESTnb

tape 4 0/5/0/0.1.23.232.0.0.2 atdd CLAIMED DEVICE IBM ULT3580-TD1/dev/rmt/4m /dev/rmt/4mn /dev/rmt/c6t0d2BEST /dev/rmt/c6t0d2BESTn/dev/rmt/4mb /dev/rmt/4mnb /dev/rmt/c6t0d2BESTb /dev/rmt/c6t0d2BES

If you have enabled ACDD, run the following ioscan command to view themedium changers found:

# ioscan -fnkC autochClass I H/W Path Driver S/W State H/W Type Description=======================================================================autoch 0 0/3/0/0.5.1 acdd CLAIMED DEVICE IBM 03590E11

/dev/rmt/0chngautoch 2 0/6/0/0.1.17.255.5.10.1 acdd CLAIMED DEVICE IBM 03590E11

/dev/rmt/2chngautoch 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 devicesconfigured with ATDD and ACDD drivers. Run #ioscan -funC tape or autoch toshow the tape devices bound with the legacy atdd_leg and acdd_leg drivers.

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 63

Page 82: IBM Tape Driver IUG 1

Configure all IBM Tape Drives/Media Changers with ATDD/ACDD: By default,ATDD automatically configures all supported IBM tape drives that are attachedand powered on when the ATDD package is installed. The ACDD driver does notconfigure IBM Medium Changer devices by default. To configure all IBM MediumChanger devices on the system during the install of ATDD package, run theswinstall command with the -x ask=true command option and answer ″Yes″ to allowthe ACDD to claim these devices.

To configure all IBM Medium Changer devices on the system after the install ofthe 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 v1and v2:

Attaching Selected IBM Tape Devices to ATDD/ACDD During Auto Booting: To claima 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 IBMautoch 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 dynamicallyattach selected IBM tape device after the ATDD installation, run the followingcommands.1. To determine the HW path of the device:

HP-UX Device Driver (ATDD)

64 IBM Tape Device Drivers Installation and User’s Guide

Page 83: IBM Tape Driver IUG 1

# ioscan -fnk|grep IBMautoch 0 0/3/0/0.5.1 schgr CLAIMED DEVICE IBM 03590E11

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 ioscanand 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 changerdriver schgr with these steps:1. Determine the HW path of the device:

# ioscan -fnk |grep IBMtape 0 0/3/0/0.5.0 atdd CLAIMED DEVICE IBM 03590E11autoch 0 0/3/0/0.5.1 acdd CLAIMED DEVICE IBM 03590E11

2. Remove the I/O configuration from the system:# rmsf -H 0/3/0/0.5.1

3. Force binding:# ioscan -M schgr -H 0/3/0/0.5.1

4. Create the device special files:# insf -H 0/3/0/0.5.1

5. Verify the force binding:# ioscan -fnk |grep IBMtape 0 0/3/0/0.5.0 atdd CLAIMED DEVICE IBM 03590E11autoch 0 0/3/0/0.5.1 schgr CLAIMED DEVICE IBM 03590E11

Note: The force binding is lost after the system reboots. To keep the binding toa selected device with a particular driver after a reboot, add thesecommand-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.1rmsf -H 0/3/0/0.5.1ioscan -M schgr -H 0/3/0/0.5.1insf -H 0/3/0/0.5.1

Configure Selected IBM Tape Devices with ATDD/ACDD in HP-UX 11i v3: Bydefault, atdd driver automatically configures all supported IBM tape drives thatare attached and powered on when the ATDD package is installed. The acdddriver does not configure IBM medium changer devices by default. All of IBMmedium changers are claimed if you use acdd and acdd_leg as the changer driversduring ATDD are installed. To attach a selected IBM tape device with a particulardriver, run the system ioscan command to force a non-ATDD/ACDD driver tobind an IBM tape device, and then reboot the system. For example, to force bindthe IBM 3592E05 tape drive with the HP native tape driver estape, perform thesesteps:1. Determine the HW path of the device:

# ioscan -fNk | grep IBMtape 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:

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 65

Page 84: IBM Tape Driver IUG 1

# 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 IBMtape 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 filesthat make up the ATDD fileset. This causes a number of inconsistencies on thesystem. 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 ATDDis 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 toremove 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, runkmadmin, kmsystem, kmtute and kmadmin commands in HP-UX 11.0 and 11i v1and kcmodule, kctune commands in HP-UX 11i v2 and v3, or go to the “KernelConfiguration” 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 atddModule State Cause Descriptionatdd static explicit Advanced Tape Device Driver

Installation and Configuration of Precision Bus DriversThis chapter describes how to install, configure, and uninstall the IBM Tape andMedium Changer Device Driver for HP-UX (ATDD) for HP Precision Bus (HP-PB)systems.

Preinstallation ConsiderationsMake sure your system is ready to install ATDD before you begin. Follow thesesteps to perform the install:1. Copy the software from the distribution medium to the depot.

HP-UX Device Driver (ATDD)

66 IBM Tape Device Drivers Installation and User’s Guide

Page 85: IBM Tape Driver IUG 1

2. Check the README file and verify that your system is configuredappropriately for installing ATDD.

3. Ensure that the tape drives to be managed by ATDD are powered on.4. Install and configure the software.

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

referenced with an absolute path. Using ’pwd’/filename to reference a file insteadof filename ensures this.

v All the software distributor commands (for example, swinstall or swcopy) can firstbe run with the -p flag to preview the command. After observing the previewoutput, you can reissue the command without the -p flag to perform the actualoperation.

v The software distributor commands are moderately complex scripts thatfrequently require several steps. The steps are typically Selection, Analysis, andExecution. Each step may produce useful information and error messages. It is agood idea to observe carefully the results of the installation process as it occurs.

If you encounter unexpected results during the installation, check the associatedlog file.

While using the software distributor commands, you may encounter the followingerror about mounted file systems:ERROR: "hostname/": One or more filesystems that appear in thefilesystem table are not mounted and cannot be mounted.

Many commands (for example, swinstall and swremove) attempt to mount all filesystems in the /etc/fstab file at the start of the analysis phase. This ensures that alllisted file systems are mounted before proceeding. This also helps ensure that filesare not loaded into a directory that may be below a future mount point, but itoften causes an error with NFS mounted file systems.

This error can be overridden using ’-x’ to set the mount_all_filesystems option toFALSE. When this option is used, the command finishes with a warning indicatingthat no attempt is made to mount all file systems. For example

# swinstall -x mount_all_filesystems=false -x autoreboot=true atddWARNING: "hostname:/": There will be no attempt to mount filesystemsthat appear in the filesystem table.

Create the Configuration FileA configuration file must be created that tells the device driver how to customizeyour configuration. The file is named etc/rc.config.d/atdd.cfg and has the followingsyntax:ATDD_global_parameter=valueATDD_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: Todetermine the device hardware path, follow these steps:

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 67

Page 86: IBM Tape Driver IUG 1

1. Run ioscan to determine which SCSI adapter the 3590 drive is connected to.# ioscan -f -C ext_bus

2. Record the hardware path entry of the adapter:for example, 56/40

3. Determine the SCSI target address of the 3590 drive. The panel on the front ofthe 3590 drive displays the selected target address.

HWPATH = adapterpath.drivetargetaddress.0 (3590 one LUN mode)or

HWPATH = adapterpath.drivetargetaddress.0HWPATH = adapterpath.drivetargetaddress.1 (3590 random 2 LUN mode)For a 3590 at SCSI target address 3 in random 2 LUN mode, the devicehardware paths are:

56/40.3.056/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 (ModelsB00 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 cartridgeloader and are known as library units. To control the operation of the librarymechanism, SCSI Medium Changer commands are issued to LUN 1 of one or bothof the drive ports depending on the library configuration.

Base configuration is intended for attachment of one or two drive libraries on asingle SCSI bus. Control of the library is accomplished by sending MediumChanger commands to LUN 1 of drive 1 (the drive on the left as viewed from therear of the library). The hardware path definitions present in the atdd.cfg file mustinclude 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 eachdrive and a subset of the cartridge slots are viewed as an independent library. Inthis case, a definition for LUN 1 for each drive must be present in the atdd.cfg fileto control each logical library independently. Typically, independent SCSI buses areused 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.# ioscan -f -C ext_bus

2. Record the hardware path entry of the adapter:for example, 56/40

3. Determine the SCSI target addresses of the Magstar MP drives. The panel onthe 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 baseconfiguration, the device hardware paths are:

HP-UX Device Driver (ATDD)

68 IBM Tape Device Drivers Installation and User’s Guide

Page 87: IBM Tape Driver IUG 1

56/40.3.056/40.3.1

Determine the Device Hardware Path for Magstar MP 3575 Tape Libraries: Eachdrive in a 3575 library can support an automation path for the logical library ofwhich it is a member by sending SCSI Medium Changer commands to LUN 1 ofthe drive port. The 3575 Model L06 supports one logical library. The other 3575tape libraries (Models L12, L18, L24, and L32) can support two or three logicallibraries depending on the specific model. The first drive in each logical librarymust 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 logicallibrary 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 ofthe front panel on the library. Conceivably, LUN 1 could be configured for twodrives in the same logical library, but this is unnecessary in most instances. In thatcase, the automation conforms to the SCSI-3 Primary Commands standard formultiple port behavior (except for the handling of reservations).

Access to a logical library is on a first-come, first-served basis for hosts accessingthe same logical library on different ports. Each port can accept commands whilethe library is in use by another host by way of another port. The 3575 deviatesfrom the SCSI-3 specification in that device and element reservations issued on oneport apply only to those hosts that access that port. Initiators connected to thesame 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 pathdefinitions present in the atdd.cfg file. Target device LUN 1 also needs to beenabled at the library operator panel for drives other than the first drive in eachlogical library if they are used to accept automation commands. LUN 1 for the firstdrive in each logical library is mandatory and is enabled automatically by thelibrary 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.# ioscan -f -C ext_bus

2. Record the hardware path entry of the adapter:For example, 56/40

3. Determine the SCSI target addresses of the Magstar MP drives. The panel onthe 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 3and drive 2 at SCSI target 4), the device hardware paths are:56/40.3.056/40.4.056/40.3.1

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 69

Page 88: IBM Tape Driver IUG 1

Determine the Drive Hardware Path for IBM 3580 Ultrium Tape Drive, 3581 TapeAutoloader with SCSI Attachment: To determine the hardware path for the 3580Tape Drive and the 3581 Tape Autoloader with SCSI attachment, follow thisprocedure:1. Run ioscan to determine which SCSI adapter the IBM Ultrium drive or

autoloader is connected to:# ioscan -f -C ext_bus

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 IBM3580 Ultrium Tape Drive displays the selected SCSI target address.The LCD panel on the front of the unit can display the drive (and mediumchanger SCSI address) for the IBM 3581 Ultrium Tape Autoloader.HWPATH=adapterpath.drivetargetaddress.0 (3580 drive)orHWPATH=adapterpath.drivetargetaddress.0 (3581 drive)For an IBM 3581 Ultrium Tape Autoloader at SCSI target address 3, the drivedevice hardware path is: 0/4/0/0.3.0

Determine the Drive Hardware Paths for IBM Ultrium Tape Libraries with SCSIAttachment: To determine the hardware path for the 3582, 3583, and 3584 TapeLibraries with SCSI attachment, follow this procedure:1. Run ioscan to determine which SCSI adapter the IBM Ultrium Tape Library is

connected to:# ioscan -f -C ext_bus

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 TapeLibrary. The LCD panel on the front of the unit can display the drive (andmedium 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 atSCSI ID 3 and SCSI ID 5 are:1/8/0/0.3.01/8/0/0.5.0

Determine the Drive Hardware Paths for IBM 3580 Ultrium Tape Drive, IBMUltrium Tape Libraries with Fibre Channel Attachment: To determine thehardware path for the 3580 tape drive and the 3582, 3583, and 3584 tape librarywith 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. Forexample,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)

HP-UX Device Driver (ATDD)

70 IBM Tape Device Drivers Installation and User’s Guide

Page 89: IBM Tape Driver IUG 1

Create the Hardware Path Entry for Ultrium Tape Drives: If devices are to beconfigured with settings other than the defaults, entries defining the hardwaredevice paths must be placed in the /etc/rc.config.d/atdd configuration file. Create anentry for each device that requires further configuration settings. The format forthe entries is HW_PATH[index]=DeviceHardwarePath. The index is used to identifythe 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 firstdevice, 3580 Stand Alone SCSI Tape Drive at SCSI target address 1, LUN 0, hasindex=0. The second device, 3581 with two 3580 SCSI Tape Drives inside at SCSItarget addresses 5 and 6, LUN 0, has index=1 and 2 . The third device, 3580 StandAlone FC Tape Drive at target 9, LUN 0, has index=3. The last one is 3583 withSAN 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 pathyou want to attach to. Create an entry in the /etc/rc.config.d/atdd.cfg configurationfile for each device you want the driver to attach. For example

ATDD_HWPATH[0]=56/40.1.0ATDD_HWPATH[1]=56/40.6.0

Note: This example shows that two devices are CLAIMED by ATDD. If you havea single 3590 device operating in one LUN mode, then you would have onlya single ATDD_HWPATH entry. If you have three tape devices attached,three ATDD_HWPATH entries are required in the configuration file. For3590 devices configured in random 2 LUN mode, two hardware path entriesare required. One is needed for the drive (LUN 0), and one is needed for theACF (LUN 1).

At least one hardware path entry is required in the configuration file.

Create the Device Specific Configuration Entries (Optional): The ATDD isshipped with default settings for all configuration parameters. To change thesesettings, an entry is made in the configuration file assigning an appropriate valueto the desired configuration variable. Each device may have a different value foreach configuration variable. The index number associated with the configurationvariable associates the parameter setting with the device at the hardware path withthe same index.Example 1:

ATDD_IMMEDIATE[0]=1

This allows application control back from the device before rewind is complete forthe device at hardware path 56 / 40.1.0 (based on the hardware path entry in“Create the Hardware Path Entry” on page 71).Example 2:

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 71

Page 90: IBM Tape Driver IUG 1

ATDD_TRAILER[1]=1

This allows write operations after an early end-of-tape warning for the device athardware path 56 / 40.6.0. Refer to Table 9 on page 76 and Table 10 on page 77 fora description of all configuration parameters.

Note: If you experience difficulties with your tape device, check the /etc/rc.log forerrors and correct the problem.

Power Off the Tape DrivesWhen the ATDD software is initially installed , it attaches itself to all tape drivesthat 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 thepreceding 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 thisdriver, power Off the tape drive and run ioscan without the ’-k’ argument asfollows:

# ioscan -f -C tape

Install the Drive Using the ATDD Installation ScriptAn installation script (Install Atdd) is provided to automate driver installation andperform some checking functions. It copies the latest version of the driver to thesoftware depot and installs the latest driver version.

To install ATDD with the script, download the install script from the ftp site, thenrun 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, oranswer "N" to allow the HP native changer driver to configure these MediumChanger devices.

Note: If a previous version of ATDD is installed on your system, uninstall it beforeattempting to install the latest version.

To install ATDD manually, follow the steps in “Install Drivers Manually” on page62.

Copy the Software to the Software Depot

Attention: If you do not copy the ATDD software into a depot, you will not beable 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

HP-UX Device Driver (ATDD)

72 IBM Tape Device Drivers Installation and User’s Guide

Page 91: IBM Tape Driver IUG 1

Use swlist to verify that the ATDD software is in the depot:

# swlist -d atdd

Review the ATDD README FileAfter copying the ATDD software to the depot, use the swlist command to viewthe README file under the directory /opt/OMImag/Readme.

# swlist -d -a readme atdd

The README file lists the system configuration requirements, including requiredsystem software patches and required tape related firmware versions. The file alsodocuments any changes in the installation, use, and administration of the softwarethat occurred after this documentation was completed. It is therefore veryimportant that you review it before proceeding with the software installation.

Install the ATDD SoftwareWhen 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-UXswinstall command. If the target root file system is the primary, the ATDD softwareis configured automatically upon installation.

Configuration requires restarting the system and rebuilding the kernel. Thisrequires you to issue the swinstall command with the -x autoreboot option set toTRUE, as described below.

If the target is an alternate root file system, the ATDD software is not configuredautomatically.

Note: If an earlier version of the product is already installed on the target root filesystem, the existing version is replaced. This is true even if the versionalready installed is more recent than the version being installed.

The following commands install ATDD from the depot to the default root filesystem:

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

# swlist atdd

You can verify correct installation to the default root file system with the swverifycommand as follows:

# swverify atdd

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 73

Page 92: IBM Tape Driver IUG 1

After the installation is completed, run the ioscan command to list the tape drivesfound:

# ioscan -fknC tapeClass 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/dev/rmt/1m /dev/rmt/1mn /dev/rmt/c4t6d0BEST /dev/rmt/c4t6d0BESTn/dev/rmt/1mb /dev/rmt/1mnb /dev/rmt/c4t6d0BESTb /dev/rmt/c4t6d0BESTnb

tape 4 0/5/0/0.1.23.232.0.0.2 atdd CLAIMED DEVICE IBM ULT3580-TD1/dev/rmt/4m /dev/rmt/4mn /dev/rmt/c6t0d2BEST /dev/rmt/c6t0d2BESTn/dev/rmt/4mb /dev/rmt/4mnb /dev/rmt/c6t0d2BESTb /dev/rmt/c6t0d2BESTnb

If you have enabled ACDD, run the following ioscan command to view themedium changers found:

# ioscan -fnkC autochClass I H/W Path Driver S/W State H/W Type Description=======================================================================autoch 0 0/3/0/0.5.1 acdd CLAIMED DEVICE IBM 03590E11

/dev/rmt/0chngautoch 2 0/6/0/0.1.17.255.5.10.1 acdd CLAIMED DEVICE IBM 03590E11

/dev/rmt/2chngautoch 4 0/5/0/0.1.23.232.0.0.1 acdd CLAIMED DEVICE IBM ULT3583-TL

/dev/rmt/4chng

Adding an IBM Tape Device Using the Currently Installed ATDDTo add an IBM tape device using the currently installed ATDD, perform thefollowing steps:1. Modify the /stand/system file, adding a stanza in the form of:

driver 56/48.3.0 atddwith 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 specialfiles for the device.atdd_mksf -ti <instance>

Where: <instance> is the number from the ioscan output for the newly installeddevice. This command echoes to console but does NOT create special files. Tocreate 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 sctldrivers as a changer driver (the sctl driver for the ext_bus C700 or C720, thespt for the other ext_bus). This manual process requires having the right

HP-UX Device Driver (ATDD)

74 IBM Tape Device Drivers Installation and User’s Guide

Page 93: IBM Tape Driver IUG 1

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

Other Administrative TasksTo determine the versions of ATDD currently installed on the default root filesystem:

# 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 toremove it. For example:

# swremove -d atdd,r=4.9.0.0

Supported Configuration ParametersThis chapter describes the supported configuration values for multiple device typesbeing configured on the same system. The configuration parameters are global.Because the configuration parameters are global to all devices, it is necessary touse configuration values that perform reliably on all devices attached to yoursystem. If you are experiencing difficulties, ensure that your driver is configuredproperly. 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. Forprogram usage, execute as follows:

For PB driver:

# /opt/OMImag/bin/atdd_cfg -h

For PCI driver:

# /opt/atdd/bin/atdd_cfg -h

Configuration Parameter DefinitionsThis section describes the configuration parameters and values. Modifying thedefault settings is not recommended unless instructed to do so. The ATDD isshipped with default values that allow the most reliable execution across variousdevice types.

Device-Specific ParametersSome of the configuration parameters are device-specific, while others aredriver-specific. Table 9 on page 76 shows the parameters that are device-specific,what they mean, and their values.

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 75

Page 94: IBM Tape Driver IUG 1

Table 9. Device-Specific Parameter Definitions

Parameter Meaning Values

DENSITY Density to use whenwriting/reading tape

In hexadecimal

SILI Suppress Incorrect LengthIndicator

v 0=Off (do not suppress, by default)

v 1=On (suppress)

FORCE_NARROW (Precision BusDriver only)

Width at which the drivernegotiates for data transfers

v 0=Wide (16 bit wide data transfers, bydefault)

v 1=Narrow (8 bit wide data transfers)

DISABLE_COPYIN_THRESHOLD(Precision Bus Driver only)

Protect against nonalignedbuffers

v 0=Off (check buffers for alignment, bydefault)

v 1=On (use buffers without checkingalignment)

COPY_THRESHOLD (Precision BusDriver only)

Minimum buffer size to startchecking for proper alignment

Size in bytes to force alignment check, 0 bydefault.

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, bydefault)

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, bydefault)

v 1=On (return before rewind is complete)

TRAILER Trailer Label Processing v 0=Off (do not allow writes past earlyEOT warning, by default)

v 1=On (allow writes past early EOTwarning)

ERRNO_LEOT Error Number return for LogicalEnd Of Tape)

Value returned for writes past EOM, 28 bydefault.

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 toopen) (multiple open support)

WFM_IMMEDIATE Immediate Mode for Write FileMark

v 0=Off (wait for write file markcompletion, by default)

v 1=On (return before write file mark iscomplete)

PRE_V3_COMPAT Use to share tapes with blocksize> 256kb with HP-UX 11i v2 orearlier. Supported in HP-UX 11iv3 only.

v 0=Off (always write or read the dateusing the blocksize defined by user, bydefault)

v 1=On (split the blocksize less than 256 kbduring the read or write)

HP-UX Device Driver (ATDD)

76 IBM Tape Device Drivers Installation and User’s Guide

Page 95: IBM Tape Driver IUG 1

Driver-Specific ParametersSome of the configuration parameters are device-specific, while others aredriver-specific. Table 10 shows the parameters that are driver-specific, what theymean, and their values.

Table 10. Driver-Specific Parameters (Global)

Parameter Meaning Values

INSTANCE ATDD Device Number (Read Only)

DEVICES Number of Configured Devices (Read Only)

MINPHYS(Precision BusDriver only)

Check/Adjust Transfer Count v 0=Use OMI minphys

v 1=Use HP-UX minphys

Modifying Configuration ParametersTo 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 canupdate 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 thedevice at hardware path 0/4/0/0.1.0, do the following:

# atdd_cfg -g INSTANCE 0/4/0/0.1.0INSTANCE: 2

The ATDD instance number for this device is returned. You must use thisINSTANCE 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_BESTDENSITY=0SILI=1BLOCKSIZE=0COMPRESSION=1BUFFERING=1REWIND_IMMEDIATE=0TRAILER=1SCALING=0WRITEPROTECT=0ERRNO_LEOT=28WFM_IMMEDIATE=0RESERVE=1PRE_V3_COMPAT=0

To display a specific parameter, run #atdd_cfg -d special_file -o parameter

For example,

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 77

Page 96: IBM Tape Driver IUG 1

#/opt/atdd/bin/atdd_cfg -d /dev/tape/tape14_BESTn -o COMPRESSIONCOMPRESSION=1

To set a specific parameter, run #atdd_cfg -d special_file -o parameter -wvalue

For example,# atdd_cfg -d /dev/rtape/tape14_BESTn -o COMPRESSION -w 0Success

To set a new BOOT default value for the configuration parameter, you mustmodify or add an entry in the atdd.cfg configuration file located in /etc/rc.config.d forthe 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 atATDD_HWPATH[0] or tape14_BESTn, add the following line to your configurationfile:v In HP-UX 11.0, 11i v1 and v2:

ATDD_COMPRESSION[0]=0

v In HP-UX 11i v3:/opt/atdd/bin/atdd_cfg -d /dev/rtape/tape14_BESTn -o COMPRESSION -w 0

Note: The configuration parameters are prefixed with ATDD_ in the configurationfile. For additional instructions about using the configuration program, usethe -h option as follows:

# atdd_cfg -h

Configurable Kernel Parameters (Tunable)ATDD provides the following variety of configurable kernel parameters that allowthe 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 86 for additional details. This parameter isenabled by default on 11i v3 and later, but disabled by default in 11iv3 andearlier.

v alternate_pathing/atdd_alternate_pathingEnable or disable the alternate path support for CPF/DPF (see the specificoperating system section that covers CPF and DPF support for detail). Thisparameter is enabled by default.

v atdd_disable_reserve/atdd_disable_resAllows the user to disable the reservation management from ATDD. Thisparameter off by default.

v atdd_loadbalanceAllows the user to disable automatic load balancing from ATDD. This parameteris On (1) by default and supported on 11iv3 only

v atdd_reserve_typeThe 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 Inand Out commands, the user can set the value of atdd_reserve_type to 3. Thedefault value for the tunable: 1 - Reserve(6) command; 2 - Reserve(10) command(Unsupported); 3 - Persistent Reserve In/Out commands

HP-UX Device Driver (ATDD)

78 IBM Tape Device Drivers Installation and User’s Guide

Page 97: IBM Tape Driver IUG 1

To change the value of tunable, run the command kctune/kmtune or SAM (SystemAdministration Manager) tool.

Special FilesFor 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 forindependent operation of the ACF, if the 3590 mode is set to Random 2 LUNoperation (/dev/rmt/<instance#>chng).

ATDD creates the tape device special files in three forms: the standard or long filename, an alternative short file name based on the instance number, and analternative short file name not based on the instance number. BEST represents theoperational capabilities likely to be required, including the highest density/formatand 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 boptions, as shown in Table 11 and Table 12. For more information, refer to the mt(7)man pages.

Table 11. Special Files

Special File NameBSD

CompatibilityRewind on

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 12. New Special Files in HP-UX 11i v3

Special File NameBSD

CompatibilityRewind on

Close

/dev/rtape/tape#_BEST No Yes

/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

v In HP-UX 11.0, 11i v1 and v2:atdd_lssf in /opt/OMImag/bin for the static driver and in /opt/atdd/bin for theDLKM driver lists information about a special file. For example:

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 79

Page 98: IBM Tape Driver IUG 1

#atdd_lssf /dev/rmt/393mnbatdd card instance 30 available at address Major = 79 Minor = Ox1E90C0settings = 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 fileinformation, enter the lssf command. For example,# lssf /dev/rtape/tape14_BESTnbatdd Berkeley No-Rewind best density available at address 64000/0xfa00/0x32/dev/rtape/tape14_BESTnb

# lssf /dev/rchgr/autoch1acdd section 0 at address 64000/0xfa00/0x21 /dev/rchgr/autoch1

If the device special files are not created on the system, use the # insf commandto generate them.

Persistent Naming SupportPersistent naming support is used to ensure that attached devices are alwaysconfigured with the same logical name across system reboots. For this purpose, theHP-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 inthe following example.# ioscan -funC tapeClass I H/W Path Driver S/W State H/W Type Description===================================================================================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-independentpersistent Device Special Files (DSFs) and the auto discovery of devices greatly toenhance the overall manageability. The ATDD does not create the additional set ofdevice special files with a prefix of “s”.

The persistent DSF format for tape devices introduced with the Agile view inHP-UX 11i v3 is:# ioscan -funNC tapeClass I H/W Path Driver S/W State H/W Type Description===================================================================tape 1 64000/0xfa00/0x7 estape CLAIMED DEVICE IBM 03592E05

/dev/rtape/tape1_BEST /dev/rtape/tape1_BESTn/dev/rtape/tape1_BESTb /dev/rtape/tape1_BESTnb

# ioscan -funNC autochClass I H/W Path Driver S/W State H/W Type Description=================================================================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_BESTbPersistent DSF Legacy DSF(s)========================================/dev/rtape/tape1_BESTb /dev/rmt/c3t15d0BESTb

/dev/rmt/c9t6d0BESTb

HP-UX Device Driver (ATDD)

80 IBM Tape Device Drivers Installation and User’s Guide

Page 99: IBM Tape Driver IUG 1

Control Path Failover Support for Tape LibrariesNotes:

1. The library control path failover feature code must be installed prior toenabling the path failover support in the HP-UX ATDD device driver. Refer to“Automatic Failover” on page 12 for what feature code may be required foryour machine type.

2. It is a requirement that applications must open the primary path for CPF

Configuring and Unconfiguring Path Failover SupportPath failover support is enabled automatically when the device driver is installed;however, the driver provides a kernel parameter you can use to enable librarycontrol path failover. To enable the failover support in the ATDD driver, performthe following steps after installing the driver:v In HP-UX 11.0, 11i v1 and v2:

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. ATDDhandles 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 Changesatdd_alternate_pathing (before) 0 0 Immed

(now) 1 1

You can check if the driver has recognized multiple control paths for yourlibrary 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 yourlibrary. In HP-UX 11i v3, use the # ioscan -m dsf command and the option 53 of“Display Path” in tapeutil to verify that the multiple path is configured by thesystem and ATDD.

After the path failover support is enabled, it remains set until atdd_claim is runwith the alternate_pathing driver parameter set to OFF . The path failover settingis retained even if the system is rebooted. If you want to turn off the control pathfailover feature in the ATDD driver, perform the following steps:v In HP-UX 11.0, 11i v1 and v2:

1. Clear the alternate_pathing parameter:# /opt/atdd/bin/atdd_failover -a 0

2. Reconfigure CPF for the devices:# /opt/atdd/bin/atdd_claim

v In HP-UX 11i v3:Run kctune to disable the kernel tunable of atdd_alternate_pathing. ATDDmanages the CPF in the next open.

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 81

Page 100: IBM Tape Driver IUG 1

# kctune atdd_alternate_pathing=0* The automatic 'backup' configuration has been updated.* The requested changes have been applied to the currently

running configuration.Tunable Value Expression Changesatdd_alternate_pathing (before) 1 1 Immed

(now) 0 0

Primary and Alternate PathsWhen ATDD is loaded into the kernel, the first logical medium changer device thatit sees in the system is the primary path for that medium changer. The otherlogical medium changers that ATDD attached for the same medium changer areconfigured as alternate paths. The device driver supports up to 16 physical pathsfor a single device.

On HP-UX 11i v3, the HP-UX system always selects the best path for ATDD toopen so the primary path is dynamically assigned from the system. ATDD doesnot provide any .altpath special file.

The primary and alternate path information can be obtained by using thefollowing command on HP-Ux 11.0, 11i v1 and v2:# ioscan -funC autoch

The following is an example of what you might see:

autoch 0 0/1/0/0.101.22.255.1.1.1 acdd CLAIMED DEVICE IBM ULT3582-TL/dev/rmt/0chng

autoch 1 0/1/0/0.101.22.255.1.2.1 acdd CLAIMED DEVICE IBM ULT3582-TL/dev/rmt/1chng.altpath

Querying Primary and Alternate Path ConfigurationsYou can display the primary and alternate path configuration for all devices byrunning the ioscan command, as explained in section “Determine the DeviceHardware Path for IBM Tape Drives” on page 60.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “HP-UX System - Tape UtilityProgram (tapeutil)” on page 375.

Disable and Enable Primary and Alternate PathsWhen you load the ATDD device driver with the alternate_pathing parameter setto 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 dueto maintenance), run commands to disable and then later enable the primary andalternate paths.

The commands to enable and disable primary and alternate paths are tapediagnostic and utility functions.

Note: See Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or “HP-UXSystem - Tape Utility Program (tapeutil)” on page 375

HP-UX Device Driver (ATDD)

82 IBM Tape Device Drivers Installation and User’s Guide

Page 101: IBM Tape Driver IUG 1

Data Path Failover and Load Balancing Support for Tape DrivesThe HP-UX device driver path failover support configures multiple physical pathsto 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 toopen; 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 PathFailover (not in HP-UX 11i v3).

3. Data Path Failover is supported for 3592 tape drives on HP-UX 11.0, 11i v1, v2and v3, and for Ultrium-3 and Ultrium-4 drives on HP-UX 11i v1, v2 and v3.

Configuring and Unconfiguring Path Failover SupportPath failover support is turned on automatically when the device driver isinstalled. However, you need to provide the data path failover feature key andreclaim the devices using the atdd_claim script. The feature key is a string with 16characters and numbers.

To enable the failover support in the IBMtape device driver software, perform thefollowing 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 youhave 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 tobe added into the /sbin/init.d/atdd file if you are running the most recentdrive code.

2. Save the file, then run the following command in HP-UX 11.0, 11i v1 and v2:# /opt/atdd/bin/atdd_claim

3. In HP-UX 11.0, 11i v1 and v2, you can check whether the driver has recognizedmultiple 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 successfullyenabled control path failover feature for your library.

In HP-UX 11i v3, use the # ioscan -m dsf command and the option 53 of “DisplayPath” in tapeutil to verify that the multiple path is configured by the system andATDD.

Note: See Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or “HP-UXSystem - Tape Utility Program (tapeutil)” on page 375

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 83

Page 102: IBM Tape Driver IUG 1

After path failover support is enabled, it remains set until atdd_claim or kctune isrun with the alternate_pathing driver parameter set to OFF. The path failoversetting is retained even if the system is rebooted. If you want to turn off the datapath 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:# /opt/atdd/bin/atdd_claim

In HP-UX 11i v3:

Run kctune to disable the kernel tunable of atdd_alternate_pathing. ATDD handlesthe DPF in the next open.# kctune atdd_alternate_pathing=0

* The automatic 'backup' configuration has been updated.* The requested changes have been applied to the currently

running configuration.Tunable Value Expression Changesatdd_alternate_pathing (before) 1 1 Immed

(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.)# /opt/atdd/bin/atdd_failover -a 1

2. Reconfigure DPF for the devices:# /opt/atdd/bin/atdd_claim

In HP-UX 11i v3:

Run kctune to enable the kernel tunable of atdd_alternate_pathing. ATDD handlesthe DPF 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 Changesatdd_alternate_pathing (before) 0 0 Immed

(now) 1 1

Primary and Alternate PathsWhen ATDD is loaded into the kernel, the first logical device that it sees in thesystem is the primary path for that medium changer. The other logical paths thatATDD attached for the same tape drive are configured as alternate paths. Thedevice driver supports up to 16 physical paths for a single device. In HP-UX 11iv3, the HP-UX system always pickups a best path for ATDD to open so theprimary path is dynamically assigned from the system. ATDD does not provideany .atlpath special file.

The primary and alternate path information can be obtained by issuing thefollowing command except in HP-UX 11i v3:

HP-UX Device Driver (ATDD)

84 IBM Tape Device Drivers Installation and User’s Guide

Page 103: IBM Tape Driver IUG 1

# ioscan -funC tape

The following is an example of the output for this command:/home/root# ioscan -funC tapeClass I H/W Path Driver S/W State H/W Type Description===============================================================================tape 0 0/1/0/0.101.22.255.1.1.1 atdd CLAIMED DEVICE IBM ULT3580-TD3 /dev/rmt/0mtape 1 0/1/0/0.101.22.255.1.2.1 atdd CLAIMED DEVICE IBM ULT3580-TD3 /dev/rmt/1m.altpath

Querying Primary and Alternate Path ConfigurationYou can display the primary and alternate path configuration for all devices byrunning ioscan, as explained in section “Primary and Alternate Paths” on page 84.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “HP-UX System - Tape UtilityProgram (tapeutil)” on page 375.

Disable and Enable Primary and Alternate PathsIf it is necessary to disable a path and not perform path fail over (for example dueto maintenance), run commands to disable and then later enable the primary andalternate paths.

The commands to enable and disable primary and alternate paths are tapediagnostic and utility functions.

Note: See Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or “HP-UXSystem - Tape Utility Program (tapeutil)” on page 375

Problem DeterminationA set of tools is provided with the device driver to determine if the device driverand the tape device are functioning correctly.

Error LoggingRead 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 tothis file which provide information regarding the problem.

Reservation Conflict LoggingWhen the device driver receives a reservation conflict during open or after thedevice has been opened it will log a reservation conflict in the HP-UX system logof /var/adm/syslog/syslog.log. Prior to logging the error the device driver will issue aPersistent Reserve In command to determine if a SCSI Persistent Reservation isactive on the reserving host to get the reserving host initiator WWPN (World WidePort Name) and reserve key. If successful, the device driver will log thisinformation in the detail data below. After initially logging the reserving hostWWPN, subsequent reservation conflicts from the same reserving host WWPN andreservation key will not be logged to prevent multiple entries in the system loguntil either the reserving host WWPN or reservation key is different than the oneinitially logged or the device driver has reserved the device and then anotherreservation conflict occurs.

Here are the log examples:

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 85

Page 104: IBM Tape Driver IUG 1

1. The information is logged when the drive is reserved with a PersistentReservation.atdd: device=rtape41 Reserved. Reserving host key DF25382049E627E6WWPN 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 LoggingWhen the tape drive responds with CHECK CONDITION status and associatedsense keys of 0x1 (Recovery Error), 0x3 (Medium Error), 0x4 (Hardware Error) and0xB (Aborted Command) for a hardware or medium error, the sense data is loggedinto the system log file (typically /var/adm/syslog/syslog.log). The sense data loggingfeature is disabled by default on 11.0, 11i v1 and 11i v2 and enabled by default on11i v3. To enable the support dynamically, run /opt/atdd/bin/atdd_cfg with the -coption.# /opt/atdd/bin/atdd_cfg -c 1

* The requested changes have been applied to the currently running system.Tunable Value Expression Changesatdd_log_trace (before) 0 Default Immed

(now) 1 1

Support_info ScriptRun the support_info script, located in the /opt/OMImag/bin directory for the staticdriver and in /opt/atdd/bin for the DLKM driver. This script gathers importantsystem and configuration information. There are several sections with the keywordVERIFY, indicating information that should be verified for correctness.

Log in as userid ″root″ on the system which experienced a problem. Then run thescript 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 FacilityRunning the ATDD_trace utility, located in the /opt/OMImag/bin for the static driverand in /opt/atdd/bin for the DLKM driver, displays debug information. The utilitytraces can be started at any time before an operation on a tape device. The defaultdebug level is 0x00001003, which shows driver configuration and per instancedrive attribute configuration and errors. You can increase the amount of debuginformation displayed by enabling more trace flags. Issuing atdd_trace -f 0x1fffffffturns 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 commandto set the trace level to 1. The default set is 3.

HP-UX Device Driver (ATDD)

86 IBM Tape Device Drivers Installation and User’s Guide

Page 105: IBM Tape Driver IUG 1

The set of trace flags is displayed in Table 13.

Table 13. 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 readableformat 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 avalue (0 or 1) to atdd_direct_trace, run # kctune atdd_direct_trace=value.

Atdd_d Log DaemonThe device driver provides a log daemon (atdd_d) facility for the Enterprise TapeSystem 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.

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 87

Page 106: IBM Tape Driver IUG 1

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:For the Static driver:# /opt/OMImag/bin/atdd_d -husage: atdd_d [options]

For the DLKM driver:# /opt/atdd/bin/atdd_d -husage: 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 andchange the log directory to /tmp/drive_dump, do the following:For the Static driver:#/opt/OMImag/bin/atdd_d -n 6 -d/tmp/drive_dump

For the DLKM driver:#/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 Errormessage), time stamp, H/W path, and size. Refer to an example in Figure 10 onpage 89.

HP-UX Device Driver (ATDD)

88 IBM Tape Device Drivers Installation and User’s Guide

Page 107: IBM Tape Driver IUG 1

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_dkill the daemon process: #kill -9 process_id

Problems and Solutions

Table 14 describes problems and possible solutions for errors you may encounterwith the DLKM driver.

Table 14. 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 thedevice switch table entry for a DLKM driver that uses.Install HP patch PHKL_29818

ATDD DLKM modules are not loaded in the runningkernel.A message in the file /var/adm/syslog/syslog.log″vmunix: WARNING: modpath: DLKM is not initialized″

The current kernel is not matching the symbol table(DLKM) in /stand/dlkmNeed to rebuild the kernel by running the followingcommands:

#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″modld: Attempt to load unregistered module ″

ATDD DLKM Module’s component files are not copiedto certain subdirectories of /usr/conf and /standRemove ATDD and try to install it again.

Figure 10. Example of atdd_d.log Output

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 89

Page 108: IBM Tape Driver IUG 1

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

Problem Reason and Solution

# kmtune | grep atddkmtune: Cannot open file -- /stand/.kmsystune_lock

The file .kmsystune_lock was removed manually.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 kernelusing `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 ofthe files ’atdd’ and/or ’acdd’ in /etc/loadmodsIf no atdd and/or acdd file entries exist, the driver maybe statically bound to the kernel or the ATDD packagemay not be installed. Check the installation running thefollowing command:# swlist atdd

No special files found in /dev/rmt Execute the atdd_mksf and acdd (if you have changersmanaged by the acdd driver) scripts found in/opt/atdd/bin

atdd_mksf and acdd_mksf

Note: The script prints out the commands that arenecessary to create the special files. To create the filesyou must ″pipe″ the output to shell (sh), using thefollowing commands:

atdd_mksf | shacdd_mksf | sh

The special files for a device are duplicates. Remove all of the special files for the device in /dev/rmtCreate the special files again by running the commandsatdd_mksf or acdd_mksf

No special files are created by HP Stape and Schgr afterinstalling ATDD

Create the special files by running the command:# insf -e

Cannot open Special File and the system log has thefollowing message:Invalid SCSI request in data at bit 7 of byte 4

Wrong DENSITY setting. Check the current value byrunning the command:atdd_cfg -g DENSITYTry setting value to 0 (zero) by running the command:atdd_cfg -s DENSITY 0

An attempt to read data times out and returns an errorand the system log has the following messages:A SCSI command timed out and was aborted.

Make sure the SILI configuration parameter is ″1″. Thiscan be checked by running the command:atdd_cfg -g SILIIf the value of SILI = 0, try setting the value to 1, byrunning the following command: atdd_cfg -s SILI 1

Table 15 on page 91 describes problems and possible solutions for errors you mayencounter with the static driver.

HP-UX Device Driver (ATDD)

90 IBM Tape Device Drivers Installation and User’s Guide

Page 109: IBM Tape Driver IUG 1

Table 15. Troubleshooting (Problems and Solutions)

Problem Solution

No special files found in /dev/rmt Issue the following commands:cd /opt/OMImag/binatdd_mksf | sh

If you are using the PB drivers or are not using thestandard device driver defaults with PCI drivers:

Verify that the hardware path for the device is listed inthe configuration file:/etc/rc.config.d/atdd.cfgIf the hardware path is missing or incorrect, the driverwas not installed properly.

Claimed by HP Stape driver Run the command: # lsdev to check that the atdd is inthe current kernel:

1. If the atdd is not in the output, rebuild the kernel orreinstall atdd;

2. If the atdd is in the output:

a. Rebuild the system I/O configuration:

1) Remove /stand/ioconfig and /etc/ioconfig after tobackup the files;

2) Reboot the system;

3) On System Console, enter the command: #/sbin/ioinit -c while the autobooting ishalted;

4) Run the command: # /sbin/insf -e

5) Enter the command: # ^D to exit the I/Oconfiguration

b. Consider reinstalling the HP-UX operating systemif the system is new or this is a new update.

Cannot open Special File. The system log has thefollowing message:Invalid SCSI request in data at bit 7 of byte 4

Wrong DENSITY setting. Check the current value by:atdd_cfg -g DENSITY <atdd_inst>Try setting it to 0 (zero):atdd_cfg -s DENSITY 0 <atdd_inst>

An attempt to read data times out and returns an error.The system log has the following messages:A SCSI command timed out and was aborted.LLIO: Detected PowerFail (probably caused by SCSI busor device reset).

Check that the SILI configuration parameter is 1 byexecuting:atdd_cfg -g SILI <atdd_inst>If the SILI parameter is zero, try setting it to 1:atdd_cfg -s SILI 1 <atdd_inst>

An attempt to read data times out and returns an error.The system log has the following messages:A SCSI command timed out and was aborted.scsi3: ....date code...scsi3: ....timestamp...

Check that the FORCE_NARROW parameter is valid forthis device by executing:atdd_cfg -g FORCE_NARROW <atdd_inst>If FORCE_NARROW is 1, try setting it to 0:atdd_cfg -s FORCE_NARROW 0 <atdd_inst>

HP-UX Device Driver (ATDD)

Chapter 4. HP-UX Tape and Medium Changer Device Driver 91

Page 110: IBM Tape Driver IUG 1

HP-UX Device Driver (ATDD)

92 IBM Tape Device Drivers Installation and User’s Guide

Page 111: IBM Tape Driver IUG 1

Chapter 5. Linux Tape and Medium Changer Device Driver

Purpose . . . . . . . . . . . . . . . 93Data Flow . . . . . . . . . . . . . . . 93Product Requirements . . . . . . . . . . . 94

Hardware Requirements for Intel and AMDOpteron Processors . . . . . . . . . . . 94Hardware Requirements for IBM System pModels . . . . . . . . . . . . . . . 95Hardware Requirements for IBM System zModels . . . . . . . . . . . . . . . 95Software Requirements for Intel and AMDOpteron Processors . . . . . . . . . . . 96Software Requirements for IBM System p Models 96Software Requirements for IBM System z Models 96

Installation and Configuration Instructions . . . . 96Conventions Used . . . . . . . . . . . 96Components Created During Installation . . . 97Installation Procedure . . . . . . . . . . 97Updating Procedure . . . . . . . . . . 98Querying the Installed Package . . . . . . . 98Verifying Installation and Updating . . . . . 99Configuring Tape and Medium Changer Deviceson Intel-Compatible Systems . . . . . . . 99Configuring Tape and Medium Changer Deviceson IBM System p Models . . . . . . . . 100Configuring Tape and Medium Changer Deviceson IBM System z Models . . . . . . . . 100Uninstall Procedure . . . . . . . . . . 102

Tape Drive, Media, and Device Driver Parameters 102Configuration Parameters . . . . . . . . 102Nonchangeable Parameters . . . . . . . . 103Changeable Parameters . . . . . . . . . 104

Special Files . . . . . . . . . . . . . . 107Special Files for the Tape Device . . . . . . 107Special Files for the Medium Changer Device 107

Control Path Failover Support for Tape Libraries 108Configuring and Unconfiguring Path FailoverSupport . . . . . . . . . . . . . . 108Primary and Alternate Paths . . . . . . . 108Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 109Disable and Enable Primary and Alternate Paths 109

Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 110

Primary and Alternate Paths . . . . . . . 111Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 111Disable and Enable Primary and Alternate Paths 111

Open Source Device Driver - lin_tape . . . . . 112IBMtape and lin_tape Comparison . . . . . 112Installation . . . . . . . . . . . . . 112Driver parameters and special device files . . . 112Path Failover Support . . . . . . . . . 113lin_taped Daemon . . . . . . . . . . . 113

System-Managed Encryption . . . . . . . . 113Device Driver Configuration . . . . . . . 113Querying Tape Drive Configuration . . . . . 114Testing Data Encryption Configuration andConnectivity . . . . . . . . . . . . . 115

Problem Determination . . . . . . . . . . 116Configure and Run lin_taped Daemon . . . . 116Reservation Conflict Logging . . . . . . . 120Tape Drive Service Aids . . . . . . . . . 121

This chapter describes the IBM Linux Tape and Medium Changer Device Driver(lin_tape).

For tape diagnostic and utility functions refer to Chapter 10, “IBM Tape DiagnosticTool (ITDT),” on page 259 or “Linux System - Tape Utility Program (IBMtapeutil)”on page 385.

PurposeThe lin_tape and medium changer device driver is designed specifically to takeadvantage of the features provided by the IBM tape drives and medium changerdevices. The goal is to give applications access to the functions required for basictape operations (such as backup and restore) and medium changer operations(such as mount and demount the cartridges), as well as to the advanced functionsneeded by full tape management systems. Whenever possible, the driver isdesigned to take advantage of the device features transparent to the application.

Data FlowThe software described in this chapter covers the Linux Device Driver (lin_tapedevice driver) and the interface between the application and the tape device.

© Copyright IBM Corp. 2007, 2009 93

Page 112: IBM Tape Driver IUG 1

Figure 11 illustrates a typical data flow process.

Product RequirementsMore current information on supported hardware and software configurations forlin_tape is in the README files. The most current information is found in theREADME files on the IBM Device Drivers FTP site, which is located at:ftp://ftp.software.ibm.com/storage/devdrvr/Linux

Information specific to certain distributions are in the README files in thedistribution-specific directories under the Linux directory.

Information there includes:v Specifics on Linux distributions and kernel levelsv Supported Host Bus Adapter cards and required firmware and HBA device

driver levelsv Other important information that is not included in this manual

Hardware Requirements for Intel and AMD OpteronProcessors

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 systemv 64-bit Intel Itanium processors (uniprocessor or SMP) capable of running the

Linux operating systemv 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 Adapterv Adaptec SCSI Adapter 29160 or IBM P/N 19K4646 for IBM System x® - Single

Port LVDv Adapted SCSI Adapter 39160 - Dual Port LVDv Adaptec SCSI Adapter 29320 - Single Port LVDv Adaptec SCSI Adapter 39320 - Dual Port LVDv LSI Logic SAS3800X SAS Adaptersv IBM SAS Host Bus Adapter Controller Part Number 25R8060v QLogic QLA2200F, QLA2300F, QLA2310FL, QLA2340L, QLA2342L, QLA2460,

QLA2462, QLE2560, and QLE2562 Fibre Channel Adaptersv Emulex LP1150, LP9002L, LP9802, LP10000, LP11000, LP11002, LPe12000,

LPe12002, and LPe1250 Fibre Channel Adaptersv IBM 42D0485, 42D0494, 42D0501, and 42D0510 8 GB Adapters

IBMtapeDeviceDriver

Host BusAdapterDriver

TapeDevice

ApplicationProgram

a250181

Figure 11. Data Flow for Linux Device Driver (lin_tape)

Linux Device Driver (lin_tape)

94 IBM Tape Device Drivers Installation and User’s Guide

Page 113: IBM Tape Driver IUG 1

Hardware Requirements for IBM System p ModelsOne 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 systemv 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 Adapterv System p (also known as pSeries) Feature Code 5736 (571A) or 1912 PCI-X DDR

Dual Channel Ultra320 SCSI Adapterv System p (also known as pSeries) Feature Code 6228 Fibre Channel Adapterv System p (also known as pSeries) Feature Code 6239 Fibre Channel PCI-X

Adapterv System p (also known as pSeries) Feature Code 5716 Fibre Channel PCI-X

Adapterv System p (also known as pSeries) Feature Code 5758 and 5759 Fibre Channel

PCI-X Adapterv System p (also known as pSeries) Feature Code 5773 and 5774 Fibre Channel

PCI-E Adapterv System p (also known as pSeries) Feature Code 5735 8 GB Fibre Channel

Adapter

Hardware Requirements for IBM System z ModelsOne or more of the following processors is required by the lin_tape device driverrunning Linux on System z in 31-bit or 64-bit:v IBM System z 800 (z800) or 900 (z900) modelsv IBM System z 890 (z890) or 990 (z990) modelsv IBM System z9® models

One or more of the following host bus adapters with Fibre Channel Protocolsupport: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 tapeand disk operations is not recommended. Tape and disk devices requireincompatible HBA settings for reliable operation and optimal performancecharacteristics. Under stress conditions (high I/O rates for tape, disk, orboth) where disk and tape subsystems share a common HBA, stabilityproblems have been observed. These issues are resolved by separating diskand tape I/O streams onto separate HBAs and using SAN zoning tominimize contention. IBM is focused on assuring server and storageconfiguration interoperability. IBM strongly recommends that yourimplementation plan includes provisions for separating disk and tapeworkloads.

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 95

Page 114: IBM Tape Driver IUG 1

Software Requirements for Intel and AMD Opteron ProcessorsThe lin_tape device driver supports the following Linux distributions:v Red Hat Enterprise Linux Serverv SUSE LINUX Enterprise Serverv Asianux

Software Requirements for IBM System p ModelsThe lin_tape device driver supports the following Linux distributions for Linux forSystem p (also known as pSeries) (64-bit kernel):v Red Hat Enterprise Linuxv SUSE LINUX Enterprise Serverv Asianux

Software Requirements for IBM System z ModelsThe lin_tape device driver supports the following Linux distribution for Linux onSystem z 31-bit and 64-bit:v Red Hat Enterprise Linuxv SUSE LINUX Enterprise Server

Installation and Configuration InstructionsThe lin_tape device driver for Linux is provided in a source rpm package. Theutility tools for lin_tape are supplied in binary rpm packages. They can bedownloaded from the following FTP site:ftp://ftp.software.ibm.com/storage/devdrvr/Linux

The following sections describe installation, configuration, uninstalling, andverification procedures for lin_tape and its utility tools. Refer to Linuxdocumentation for tar command information and any Linux distributionsupporting rpm for rpm command information. You must have root authority toproceed with the installation of the driver. See the README file at:ftp://ftp.software.ibm.com/storage/devdrvr/Linux/README

This file contains the latest driver information and supersedes the information inthis publication.

Conventions Used

In subsequent pages, you see file names with x.x.x in them. The x.x.x refers to theversion of the driver, which changes as IBM releases new driver levels. Use theactual driver version numbers as you perform the instructions.

Commands that you are to type are indicated with a leading ″>″ character, whichindicates the shell prompt. Some of the commands have a ″—some text″ stringafter them, for example, ″>cd IBMtapeutil.x.x.x.i386 — to change the directory″.The ″—some text″ items are explanatory comments to the reader and should not bespecified when you enter these commands. In the previous example, all you wouldspecify is the command: cd IBMtapeutil.x.x.x.i386

Note: This is performed using tape diagnostic and utility functions.

Linux Device Driver (lin_tape)

96 IBM Tape Device Drivers Installation and User’s Guide

Page 115: IBM Tape Driver IUG 1

Components Created During InstallationThe 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 listedin Table 16.

Table 16. Components Created During lin_tape Installation

Component Description

/lib/modules/(Your system’s kernelname)/kernel/drivers/scsi/lin_tape.ko

Device driver module for current kernelversion

/usr/bin/lin_taped lin_taped daemon

/etc/lin_taped.conf lin_taped daemon configuration file

/usr/share/doc/lin_tape-xxx/lin_tape_359X.Readme (for Red Hat)

/usr/share/doc/packages/lin_tape/lin_tape_359X.Readme (for SUSE LINUX)

ReadMe file for lin_tape using IBMTotalStorage devices

/usr/share/doc/lin_tape-xxx/lin_taped.Readme(for Red Hat)

/usr/share/doc/packages/lin_tape/lin_taped.Readme (for SUSE LINUX)

ReadMe file for lin_taped daemon

/usr/share/doc/lin_tape-xxx/copying (for RedHat)

/usr/share/doc/packages/lin_tape/copying (forSUSE LINUX)

License documentation for lin_tape

The IBMtapeutil package consists of IBMtapeutil, IBMtapeconfig, and the source filesfor IBMtapeutil. Components created during lin_tape installation (from the rpmpackage) are listed in Table 17.

Note: This is performed using tape diagnostic and utility functions.

Table 17. Components Created During IBMtapeutil Installation

Component Description

/usr/bin/IBMtapeconfig Utility to create special files

/usr/bin/IBMtapeutil Utility and service aid program

Installation ProcedureIf lin_tape is already installed on your system, refer to the “Updating Procedure”on page 98 in this chapter. This section assumes you are installing the lin_tapedevice 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 forzSeries®, ensure that the OpenFCP adapter device driver zfcp is loaded in thekernel. Please refer to the section “Configuring Tape and Medium Changer Deviceson IBM System z Models” on page 100 in this chapter for how to configure andinstall zfcp.

Make sure that the C/C++ development and kernel development packages areinstalled on your system. To install the lin_tape driver with all the added value ofthe lin_taped daemon, perform the following steps:

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 97

Page 116: IBM Tape Driver IUG 1

1. Download the appropriate level of the source RPM package to a directory ofyour choice on the Linux kernel for which you wish to install it.

2. Run rpmbuild --rebuild <filename>, where: <filename> is the name of theRPM file. This creates a binary RPM package for your kernel from the sourceRPM 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 RPMpackage. 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 runrpm -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 ProcedureBefore using this procedure to update your device driver to a different level, usethe following command to obtain your existing lin_tape device driver version, ifthere is at least one tape device attached to your system:> IBMtapeutil -f /dev/IBMtape0 qryversion

Note: This is performed using tape diagnostic and utility functions.

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 andcannot be in use when lin_tape is uninstalled.

Querying the Installed PackageThe query is supported for the lin_tape device driver rpm package only.

The installed rpm package can be queried by running the following commands todisplay 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, orreplaced:

>rpm -qs lin_tape

Linux Device Driver (lin_tape)

98 IBM Tape Device Drivers Installation and User’s Guide

Page 117: IBM Tape Driver IUG 1

Verifying Installation and UpdatingRun the following command to verify the lin_tape device driver version if there isat least one tape device attached to the system:IBMtapeutil -f /dev/IBMtape0 qryversion

Note: This is performed using tape diagnostic and utility functions.

Configuring Tape and Medium Changer Devices onIntel-Compatible Systems

If you have not physically attached your tape and medium changer devices toyour 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 causehardware 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 isnot 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 andmake sure that the logical unit numbers of the control unit, medium changer, andthe connected tape drives are contiguous (otherwise, the Qlogic device driver doesnot 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 notcontiguous, use the mapCompressDatabase command to delete the invalid LUNs andmake the valid LUNs contiguous.

If you have the StorWatch Specialist installed, you can use the Specialist to do thisconfiguration. For further information about the StorWatch Specialist, refer to theIBM Storage Area Network Data Gateway Installation and User’s Guide. You candownload 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 /devdirectory.

To configure the tape devices, use the IBMtapeutil application program. ChooseQuery/Set Tape Parameters in the menu.

Note: This is performed using tape diagnostic and utility functions.

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 99

Page 118: IBM Tape Driver IUG 1

Configuring Tape and Medium Changer Devices on IBMSystem p Models

Follow the same instructions as documented in the previous section. You need toconfigure the Emulex Linux device driver if you have fibre channel tape devicesattached to your System p (also known as pSeries) system. For instructions on howto configure the Emulex device driver, refer to the lin_tape_359X_pSeries.ReadMeat ftp://ftp.software.ibm.com/storage/devdrvr/Linux.

Configuring Tape and Medium Changer Devices on IBMSystem 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 onthe supported configurations for fibre channel device attachment. The Linux fibrechannel adapter device driver zfcp is available in the kernel that supports zSeriesFibre Channel Protocol. The zfcp device configuration methods in 2.6 and 2.4kernels are different. For 2.6 kernels, refer to appropriate chapter in the Linux onSystem z document entitled ″Linux on System z: Device Drivers, Features, andCommands″.

For 2.4 kernels, there are three ways to load the zfcp device driver in order to seethe 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 persistentmapping in a SAN environment. Every time you reboot the system, the zfcp isautomatically 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 exampleof zfcp.conf:0xf1c0 0x1:0x5005076300402733 0x0:0x0000000000000000;\0xf1c1 0x1:0x5005076300402733 0x0:0x0001000000000000

The zfcp device driver uses the ″map″ module parameter to recognize aphysically 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-idLinux internal SCSI ID assigned to the Fibre Channel port of the SCSItarget device (32-bit, must not be 0, must be a unique one-to-onemapping for each World Wide Port Name. It is ″0x1″ in the previousexample.

wwpn World Wide Port Name identifying the Fibre Channel port of the SCSItarget device (64-bit). It is ″0x5005076300402733″ in the previousexample.

unit scsi-lunLinux internal SCSI Logical Unit Number (32-bit). It is ″0x0″ in theprevious example.

fcp-lunLogical Unit Number associated with the SCSI target device (64-bit). In

Linux Device Driver (lin_tape)

100 IBM Tape Device Drivers Installation and User’s Guide

Page 119: IBM Tape Driver IUG 1

the previous example, ″0x0000000000000000″ is the Logical UnitNumber 0, and ″0x0001000000000000″ is the Logical Unit Number 1.

We recommend, for tape attachment, that each logical unit number beassociated with a unique devno. If you use the same devno numbers for severallogical 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 beshown in /proc/scsi/scsi file.

2. Modify the /etc/modules.conf file to add the zfcp module parameters; thenrun the ″depmod –A″ and ″modprobe zfcp″ command.

Note: Do not use this choice together with the first one, otherwise it causesconflicts.

The zfcp map in /etc/modules.conf always takes higher priority than the mapin /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 thefollowing 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 tapedevices 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 deviceinto the system after you physically attach a fibre channel tape device to theswitch.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 systementry under the directory /proc/scsi/zfcp to allow you to dynamically add thedevice into the system. For example, to add two logical units from the examplein 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 fourparameters ″scsi″, ″Channel″, ″Id″, and ″Lun″ in the /proc/scsi/scsi file. The valueof ″scsi″ is 0 for the first devno, 1 for the second devno (if it is different fromthe first devno), and so on. The value of ″Channel″ can start from 0 for eachdifferent ″scsi″ value. The value of ″Id″ is the one you use for <unit scsi-lun> inthe previous mapping. The value of ″Lun″ is the logical unit number of the

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 101

Page 120: IBM Tape Driver IUG 1

target device, for example, the last number in the previous mapping. Currently,the zfcp device driver does not support dynamically removing the attacheddevices. If you need to remove the tape devices from the system, do ″rmmodzfcp″. Then you can delete the entry in /etc/modules.conf and reload zfcp, orreload zfcp first and dynamically add the devices you want. After you havedone 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. Nextyou may install the lin_tape device driver. Refer to the "“InstallationProcedure” on page 97″ section in this chapter for the instructions on how toinstall lin_tape.

Uninstall Procedure

Note: All tape devices that use the lin_tape driver must be closed and cannot be inuse 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 ParametersThis chapter describes the parameters that control the operating modes of the IBMLinux Tape and Medium Changer Device Driver.

Configuration ParametersThe configuration parameters are used to set the operating mode of the tape driveand device driver when a device is opened. The installation defaults are providedfor all parameters initially. Some of these parameters can be queried and set byIBMtapeutil, Query/Set Tape Parameters in the menu. These parameters are kepton reopen, but are always restored back to the default values when the lin_tapedevice driver is reinstalled.

Note: This is performed using tape diagnostic and utility functions.

The nonchangeable configuration parameters are:v Autoloadingv Density codev Emulate autoloaderv Hook wordv Maximum block sizev Minimum block sizev Medium typev Read SILI bitv Record space modev Volume ID for loggingv Write protect

The changeable configuration parameters are:v Block sizev Buffered modev Capacity scaling

Linux Device Driver (lin_tape)

102 IBM Tape Device Drivers Installation and User’s Guide

Page 121: IBM Tape Driver IUG 1

v Compressionv Disable auto drive dumpv Disable SIM loggingv Loggingv Logical write protectv Maximum SCSI transfer lengthv Read past filemarkv Rewind immediatev Tracev Trailer labels

Nonchangeable ParametersThe configuration parameters are used to set the operating mode of the tape driveand device driver when a device is opened. The nonchangeable parameters aredetailed as follows:

AutoloadingThis parameter enables the autoloading feature of the device driver. It is disabledby default and cannot be changed.

Capacity ScalingThis parameter sets the capacity or logical length of the current tape. By reducingthe capacity of the tape, the tape drive can access data faster at the expense of datacapacity. Capacity Scaling is not supported currently but might be supported infuture releases of lin_tape.

Density CodeThis parameter is the density setting for the currently loaded tape. Some tapedevices support multiple densities and report the current setting in this field. Itcannot be changed by the application.

Emulate AutoloaderThis parameter currently is not supported and should be ignored.

Hook WordThis parameter is not supported in the lin_tape device driver.

Logical Write ProtectThis parameter sets or resets the logical write protect of the current tape. Thisfeature is not supported currently but might be supported in future releases of thelin_tape.

Maximum Block SizeThis parameter is the maximum block size for the device.

Minimum Block SizeThis parameter is the minimum block size for the device.

Medium TypeThis parameter is the media type of the current loaded tape. Some tape devicessupport multiple media types and different values are reported in this field.

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 103

Page 122: IBM Tape Driver IUG 1

Read SILI BitSILI bit currently is not supported due to limitations associated with the Linuxenvironment. SILI bit support may be enabled in future releases of the lin_tape.

Record Space ModeThis parameter specifies how the device driver operates when a forward orbackward space record operation encounters a filemark. Only the SCSI mode issupported by lin_tape. When a forward or backward space record operation isissued to the driver and a filemark is encountered, the device driver returns -1 andthe errno variable is set to input/output error (EIO). On the forward spaceoperation, the tape is left-positioned after the filemark (the end of tape side of thefilemark). On the backward space operation, the tape is positioned before thefilemark (the beginning of tape side of the filemark).

Volume ID for LoggingThis parameter is the volume ID of the currently loaded tape. The lin_tape devicedriver ignores this field.

Write ProtectThis parameter is set to TRUE if the currently mounted tape is logically orphysically write protected.

Changeable ParametersThe configuration parameters are used to set the operating mode of the tape driveand device driver when a device is opened. The changeable parameters aredetailed as follows:

Block SizeThis parameter specifies the block size used for read and write operations. A valueof zero means a variable block size. Any other value is a fixed block size. Theinstallation default is zero (variable length block size). Refer to “Maximum SCSITransfer Length” on page 106 for additional guidance.

Buffered ModeThis parameter specifies if read and write operations should be buffered by thetape device. The default (recommended) value is TRUE.

Capacity ScalingThis parameter sets the capacity or logical length of the current tape on EnterpriseTape 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. Capacityscaling 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 the3592 standard 300 GB rewritable data cartridge. Capacity scaling remains with thetape across mounts until it is changed.

Note:

1. The tape position must be at the start of the tape to change thisparameter 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 thatis not supported by a device or the current media loaded always returns100% and cannot be changed. For example, the 60GB (Economy Data)cartridge for the IBM 3592 cannot be capacity scaled and is always 100%.

Linux Device Driver (lin_tape)

104 IBM Tape Device Drivers Installation and User’s Guide

Page 123: IBM Tape Driver IUG 1

CompressionHardware compression is implemented in the device hardware. This parameterturns the hardware compression feature On and Off. If compression is enabled, theeffective performance can increase, based on the compressibility of the data.

The installation default is On (use compression).

Disable Auto Drive DumpThis parameter is provided in the lin_tape version 1.2.2 or later. It is set to FALSEby default. If it is FALSE and the lin_taped daemon is running and if an erroroccurs in the drive which creates a drive dump, the lin_tape device driverautomatically retrieves the drive dump and saves it under the /var/log directory bydefault. You may specify another directory in the /etc/lin_taped.conf file. Please referto “Configure and Run lin_taped Daemon” on page 116 in this chapter for details.

Disable SIM loggingThis parameter is provided in the lin_tape version 1.2.2 or later. It is set to FALSEby default. If it is FALSE and the lin_taped daemon is running and SIM/MIM datais generated by the drive, the lin_tape device driver automatically retrieves thedata 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 116 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_tapeversion 1.2.2 and later, the lin_tape device driver provides this support. It is set toOn by default. If logging is On and the lin_taped daemon is running, the lin_tapedevice driver retrieves the full log sense data from the drive whenever a tape isunloaded, or the drive reaches a log threshold. The log file is saved in binaryformat 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” onpage 116 in this chapter for details.

Note: This is volume logging, which is different from error logging. lin_tapeprovides error logging whenever the lin_taped daemon is running. Pleaserefer to “Configure and Run lin_taped Daemon” on page 116 in this chapterfor details on error logging.

Logical Write ProtectThis parameter sets or resets the logical write protect of the current tape onEnterprise Tape System 3590 tape subsystems. The three types of logical writeprotect 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 tapedrive is reset.

2. Persistent protect remains or persists with the tape across mounts until it isreset.

3. WORM protect also remains with the tape across mounts, but unlike persistentprotect it cannot be reset on the tape. After a tape is WORM protected, it cannever be written on again.

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 105

Page 124: IBM Tape Driver IUG 1

Note: The tape position must be at the start of the tape to change this parameterfrom its current value.

Maximum SCSI Transfer LengthIn the lin_tape drivers with level lower than 3.0.3, the maximum transfer lengthper device per SCSI command is 262144 bytes (256 KB) by default. Variable blockread/write requests with transfer length greater than the maximum transfer lengthfails [errno: EINVAL]. When a fixed block size has been defined, large writerequests are subject to both the granularity of the block size and the maximumtransfer length. For example, with a fixed block size of 80000 bytes and maximumtransfer 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) andthe second transfer is 160000 (the remaining two blocks). You may increase themaximum transfer length to enhance the data throughput. This can be done eitherusing IBMtapeutil, option 48 – Query/Set Tape Parameters, or a customizedSTIOCSETP input/output control (ioctl) call. However, setting the transfer lengthgreater than the default 256 KB does not guarantee a noticeable increase in datathroughput. Maximum transfer length of 256 KB is highly recommended.

Note: This is performed using tape diagnostic and utility functions.

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 busadapter and the tape drive can support. This number is usually greater than256KB. It can not be changed by the IBMtapeutil, option 48 or the STIOCSETP ioctlcall any more.

Read Past FilemarkIf this parameter is set to true, when a read operation encounters a filemark, itreturns the number of bytes read before encountering the filemark and positionsthe 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 functionreturns 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 headafter the filemark.

This installation default is FALSE.

Rewind ImmediateThis parameter sets the immediate bit for rewind commands. If it is set to On, therewind tape operation executes faster, but the next command takes a long time tofinish unless the physical rewind operation has completed. Setting this parameterreduces the amount of time it takes to close a device for a Rewind on Close specialfile.

The installation default is Off (no rewind immediate).

TraceThis parameter turns the trace facility On or Off. With the lin_tape version 1.2.2and later, the lin_tape device driver provides this support. It is set to On bydefault. If trace is On and the lin_taped daemon is running, the lin_tape devicedriver 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 116 for details.

Linux Device Driver (lin_tape)

106 IBM Tape Device Drivers Installation and User’s Guide

Page 125: IBM Tape Driver IUG 1

Trailer LabelsIf this parameter is set to On, then writing records past the early warning mark onthe tape is allowed. The first write operation after detecting the early warningmark fails and the errno variable is set to ENOSPC. No data is written during theoperation. All subsequent write operations are allowed to continue until thephysical 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 isnot allowed. Errno variable is set to ENOSPC.

The installation default is On (with trailer labels).

Special FilesAfter 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 thestandard Linux special files for devices, are in the /dev directory.

Special Files for the Tape DeviceEach tape device has a set of special files providing access to the same physicaldrive but providing different attributes. Table 18 shows the attributes of the specialfiles.

Note: The asterisk (*) in IBMtape* represents a number assigned to a particulardevice, such as IBMtape0.

For tape drives with attached medium changer devices, the IBMchanger* special fileprovides a separate path for issuing commands to the medium changer. When thisspecial file is opened, the application can view the medium changer as a separatedevice. Both the tape and changer special file can be opened at the same time.

Table 18. 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 DeviceAfter the driver is installed and a medium changer device is configured and madeavailable for use, access to the robotic device is provided through the IBMchangerspecial file in the /dev directory. The asterisk (*) represents a number assigned to aparticular device, such as IBMchanger0. The term IBMchanger is used for a SCSImedium changer device. The IBMchanger* special file provides a path for issuingcommands to control the medium changer robotic device.

The file descriptor that results from opening the IBMchanger special file does notsupport the following operations:v Readv Writev Open in Append modev Commands designed for a tape device

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 107

Page 126: IBM Tape Driver IUG 1

Control Path Failover Support for Tape Libraries

Note: The library control path failover feature code must be installed prior toenabling control path failover support in the Linux lin_tape device driver.Refer to “Automatic Failover” on page 12 to determine which feature code isrequired for your machine type.

The Linux lin_tape device driver control path failover support configures multiplephysical control paths to the same logical library within the device driver andprovide automatic failover to an alternate control path when a permanent erroroccurs on one path. This is transparent to the running application.

Configuring and Unconfiguring Path Failover SupportControl path failover support is not enabled automatically when the device driveris installed. The Linux lin_tape device driver provides a driver parameteralternate_pathing for you to enable the library control path failover. To enable thefailover support in the lin_tape device driver software, you need do the followingsteps 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. depmod5. 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 kernelname>/drivers/scsi/lin_tape.ko″ message after the ″depmod″ command. You can checkif the lin_tape driver has recognized multiple control paths for your library byreading the /proc/scsi/IBMchanger file.v cat/proc/scsi/IBMchanger

If your library lists ″Primary″ or ″Alternate″ under ″FO Path″, you havesuccessfully 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 controlpath failover support is enabled, it remains set until the lin_tape driver is reloadedwith the alternate_pathing driver parameter set to OFF . The path failover settingis retained even if the system is rebooted. If you want to turn off the control pathfailover feature in the lin_tape device driver, you can perform the following steps:1. lin_taped stop2. rmmod lin_tape3. Delete the following line in your /etc/modules.conf file:

options lin_tape alternate_pathing=14. depmod5. modprobe lin_tape6. lin_taped

Primary and Alternate PathsWhen lin_tape is loaded into kernel memory, the first logical medium changerdevice that lin_tape sees in the system is the primary path for that medium

Linux Device Driver (lin_tape)

108 IBM Tape Device Drivers Installation and User’s Guide

Page 127: IBM Tape Driver IUG 1

changer. The other logical medium changers that lin_tape attached for the samemedium changer are configured as alternate paths. The device driver supports upto 16 physical paths for a single device. The primary and alternate pathinformation 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.3v lin_tape major number: 253

Attached Changer Devices:

Number Model SN HBA FO Path0 03584L22 IBM1234567 qla2xxx Primary1 03584L22 IBM1234567 qla2xxx Alternate2 03584L22 IBM1234567 qla2xxx Alternate

The labeling of a logical device as either a primary or alternate path is forinformation only, in order to:v 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 onelogical device labeled as the primary path for each physical device. However,there can be multiple logical devices labeled as an alternate path for the samedevices.

v Provide information about which logical devices configured on the system havepath failover support enabled.

Querying Primary and Alternate Path ConfigurationYou can display the primary and alternate path configuration for all devices byreading the /proc/scsi/IBMchanger file, as explained in section “Primary andAlternate Paths” on page 108.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “Linux System - Tape UtilityProgram (IBMtapeutil)” on page 385.

Disable and Enable Primary and Alternate PathsOnce you load the lin_tape device driver with the alternate_pathing parameter tobe 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 dueto maintenance), run commands to disable and then later enable the primary andalternate paths.

The commands to enable and disable primary and alternate paths are tapediagnostic and utility functions.

Note: See Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or “LinuxSystem - Tape Utility Program (IBMtapeutil)” on page 385

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 109

Page 128: IBM Tape Driver IUG 1

Data Path Failover and Load Balancing Support for Tape DrivesData path failover support is not enabled automatically when the device driver isinstalled. The Linux lin_tape device driver provides a driver parameteralternate_pathing for you to enable the data path failover.

To enable the failover support in the lin_tape device driver software, you need toperform 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.6kernels:options lin_tape alternate_pathing=1

If you have IBM LTO tape drives, the library needs to have path failover featurecode. The data path failover license keys are needed to enable the failover if youare running LTO2 drives or if you are running LTO3 drives with old levels of drivecode. DPF keys do not need to be added if you are running the latest drive codeon 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 havemultiple libraries and multiple data path failover feature keys, input your keys asfollows:

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 kernelname>/drivers/scsi/lin_tape.ko″ message after the depmod command. You can check ifthe lin_tape driver has recognized multiple paths for your tape drive by readingthe /proc/scsi/IBMtape file:>cat /proc/scsi/IBMtape

If your tape drive lists ″Primary″ or ″Alternate″ under ″FO Path″, you havesuccessfully 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 pathfailover support is enabled, it remains set until the lin_tape driver is reloaded withthe alternate_pathing driver parameter set to OFF . The path failover setting isretained even if the system is rebooted. If you want to turn off the data pathfailover 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_tapealternate_pathing=1

Linux Device Driver (lin_tape)

110 IBM Tape Device Drivers Installation and User’s Guide

Page 129: IBM Tape Driver IUG 1

>depmod>modprobe lin_tape>lin_taped

Primary and Alternate PathsWhen the lin_tape device driver is loaded into kernel memory with path failoversupport enabled, the first logic device that lin_tape sees always becomes theprimary path. The other logical devices that lin_tape sees are configured as thealternate paths. The device driver supports up to 16 physical paths for a singledevice.

The primary and alternate path information can be obtained by the followingcommand:>cat /proc/scsi/IBMtape

The following is an example of a /proc/scsi/IBMtape:lin_tape version: 3.0.3lin_tape major number: 253Attached Tape Devices:

Number Model SN HBA FO Path

0 03592 IBM1234567 qla2xxx Primary

1 03592 IBM1234567 qla2xxx Alternate

The labeling of a logical device as either a primary or alternate path is forinformation only to:v 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 onelogical device labeled the primary path for each physical device. However, theremay be many (multiple) logical devices labeled as an alternate path for the samedevices.

v Provide information about which logical devices configured on the system havepath failover support enabled.

Querying Primary and Alternate Path ConfigurationYou can display the primary and alternate path configuration for all devices byreading the /proc/scsi/IBMtape file, as explained in section “Primary and AlternatePaths.”

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “Linux System - Tape UtilityProgram (IBMtapeutil)” on page 385.

Disable and Enable Primary and Alternate PathsIf it is necessary to disable a path and not perform path fail over (for example dueto maintenance), run commands to disable and then later enable the primary andalternate paths.

The commands to enable and disable primary and alternate paths are tapediagnostic and utility functions.

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 111

Page 130: IBM Tape Driver IUG 1

Note: See Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or “LinuxSystem - Tape Utility Program (IBMtapeutil)” on page 385

Open Source Device Driver - lin_tapeThe lin_tape device driver is the new device driver for the Linux 2.6 kernels toreplace the closed-source driver IBMtape. In most respects, it behaves the same asthe closed-source IBMtape device driver. This section covers significant differencesbetween the IBMtape driver and the lin_tape driver.

IBMtape and lin_tape ComparisonTable 19 compares the names for various components of the IBMtape and lin_tapedevice drivers.

Table 19. 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/dev/IBMchanger0, etc.

No change

proc entry /proc/scsi/IBMtape/proc/scsi/IBMchanger

No change

Daemon name IBMtaped lin_taped

Daemon configuration file /etc/IBMtaped.conf /etc/lin_taped.conf

Daemon trace files /var/log/IBMtape.trace/var/log/IBMtape.errorlog

/var/log/lin_tape.trace/var/log/lin_tape.errorlog

The IBMtapeutil utility is the same for both the IBMtape driver and the lin_tapedriver.

Note: This is performed using tape diagnostic and utility functions.

InstallationInstallation of the lin_tape driver is the same as for the IBMtape driver, except thatIBMtape should be replaced with lin_tape in all of the installation instructions.Refer to the section “Installation and Configuration Instructions” on page 96 of thischapter for details.

The lin_tape driver cannot be installed if the IBMtape driver is already installed. Ifthe IBMtape driver is installed, first uninstall the IBMtape driver, and then installthe lin_tape driver. With RHEL4 and SLES10, driver removal also requires a rebootof the server, since the IBMtape driver module is ″permanent″ in thesedistributions.

Driver parameters and special device filesThe driver parameters have not changed for the lin_tape driver. However, it isimportant 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 IBMtapemodule. 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’spath failover:

Linux Device Driver (lin_tape)

112 IBM Tape Device Drivers Installation and User’s Guide

Page 131: IBM Tape Driver IUG 1

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 IBMtapedriver. Refer to “Special Files for the Tape Device” on page 107 and “Special Filesfor the Medium Changer Device” on page 107 of this chapter for details on specialdevice files.

Path Failover SupportPath 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_tapeddaemon is not running, neither control path failover nor data path failover isattempted. The lin_taped daemon is started automatically when the lin_tape driveris 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 othersettings are correct, but ″FO Path″ is incorrectly indicating ″NA″, confirm that thelin_taped daemon is running.

For details about the path failover support, refer to the sections "“Control PathFailover Support for Tape Libraries” on page 108″ and "“Data Path Failover andLoad Balancing Support for Tape Drives” on page 110″ of this chapter.

lin_taped DaemonThe lin_taped daemon uses the same command-line arguments as the IBMtapeddaemon. The lin_taped configuration file is the same as the IBMtapedconfiguration file, but has been renamed to lin_taped.conf. Refer to “Configure andRun lin_taped Daemon” on page 116 of this chapter for detailed information.

System-Managed Encryption

Device Driver Configuration

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

The device driver SME settings can be set for all drives at once using the″default_sys_encryption_proxy″ and ″default_sys_encryption_write″ moduleoptions.

If no options are specified in the registry, the driver uses the default values for theparameters.v The default value for default_sys_encryption_proxy is 1.

This value causes the device driver to handle encryption key requests, if thedrive is set up for system-managed encryption. This value should not need to be

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 113

Page 132: IBM Tape Driver IUG 1

changed. A value of 0 causes the device driver to ignore encryption key requestsfor 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-BOPsettings alone. It does not turn on or turn off encryption writing, but insteaduses the settings that are already in the drive. If encryption has not been set uppreviously, then the drive writes unencrypted data. A value of 0 causes thedevice driver to write unencrypted data. A value of 1 causes the device driver towrite 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=12. 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 samedefinitions and values as the similarly named ″default″ parameters, except that thesettings only apply to individual drives.

These settings are available as part of the sysfs infrastructure. For each drive, thereare 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 theparameter for that particular drive. The setting can be changed by writing adifferent 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 persistentbetween loads of the lin_tape driver. If you remove the lin_tape driver, andthen 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, isinstalled in the /etc/ directory when lin_tape is installed. Instructions formodifying this file are found within the file itself.

Querying Tape Drive ConfigurationThere is an IBMtapeutil command to query the encryption settings of a tape drive.The IBMtapeutil command is menu option 57, “Query Encryption Status”.

Note: This is performed using tape diagnostic and utility functions.

Linux System-Managed Encryption

114 IBM Tape Device Drivers Installation and User’s Guide

Page 133: IBM Tape Driver IUG 1

The following is an example of the output when the drive is configured forsystem-managed encryption, with encryption turned on:issuing query encryption status...encryption capable......Yesencryption method.......METHOD_SYSTEMencryption state........ON

Testing Data Encryption Configuration and ConnectivityThere is an IBMtapeutil command to validate the ibmekm.conf file server entriesand test tape drive to server connectivity operations. This test can be run using theIBMtapeutil menu option 58, “EKM Test”.

Note: See “Linux System - Tape Utility Program (IBMtapeutil)” on page 385 forinformation on the IBMtapeutil application.

The process involves three tests.1. The first test checks the server configuration defined in the ibmekm.conf file

and then communication to the configured servers. This test reports back thenumber of servers available.

2. The second test runs a basic diagnostic that checks the tape drive to servercommunication and reports success or fail.

3. The third test runs an enhanced diagnostic that checks a key operation betweenthe tape drive and server then reports success or fail.

The following is an example of the output of a successful test:Testing server configuration and connections...Testing complete, servers available 1Running basic drive to server encryption test...Testing complete, completion code 3Running full drive to server encryption test...Testing complete, completion code 3

If the first server test fails with one of the following errors, then the remainingtests are not run. Perform the recommended problem determination to resolve theproblem:v “Invalid argument or Operation not supported on device”

System encryption is not configured for the tape drive in the device driver. UseSMIT to set system encryption to “yes” for the tape drive. If system encryptioncan not be set then the tape drive is not encryption capable.

v “Can’t assign requested address”Either the ibmekm.conf file is missing or is invalid. Check and correct.

v “Network is down”All configured servers in the ibmekm.conf file are not available. Check all serversconfigured in the ibmekm.conf file are currently running on the server IP addressand configured correctly.

Linux System-Managed Encryption

Chapter 5. Linux Tape and Medium Changer Device Driver 115

Page 134: IBM Tape Driver IUG 1

Problem DeterminationA set of tools is provided with the device driver to determine if the device driverand the tape device are functioning correctly.

Configure and Run lin_taped DaemonStarting with lin_tape version 1.2.5, the lin_tape device driver provides an errordiagnostic daemon (lin_taped) which provides the following capabilities:1. Error logging and tracing2. When drive dumps, log sense data, and/or SIM/MIM error information are

created by the tape drive, the daemon automatically retrieves that data andsaves it to the hard drive on your Linux system.

3. Failover and load balancing4. Encryption

Because lin_taped requires a minimal amount of system resource and because itprovides these necessary diagnostic capabilities, IBM recommends that you leavethe daemon enabled at all times.

Install lin_tapedlin_taped is automatically installed at /usr/bin/lin_taped when you install thelin_tape device driver using the rpm or tar package. Refer to “Installation andConfiguration Instructions” on page 96 for instructions on installing the lin_tapedevice driver.

Configure lin_tapedYou 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 filewhen it starts; consequently, if you make modifications to the configuration file,then stop the daemon and restart it so that your modifications are recognized bythe daemon.

Tracing: Three levels of tracing are supported for the lin_tape device driver andare defined as follows:

0 With tracing set to 0, very minimal tracing is recorded from the lin_tapedevice driver.

1 With tracing set to 1, lin_taped records information associated with eachioctl called. If a device error occurs and SCSI sense data is obtained fromthe device, a subset of that sense data is also recorded. This is the defaultsetting for tracing.

2 With tracing set to 2, lin_taped records tracing messages for each SCSIcommand. If a device error occurs and SCSI sense data is obtained fromthe device, all sense data is also recorded. This tracing level should only beused when a specific problem is being diagnosed due to the potential forhuge amounts of data being generated.

Set the lin_tapeTrace variable in the /etc/lin_taped.conf file to 0, 1, or 2, depending onwhat level of tracing you desire. If the lin_tapeTrace variable is set to an invalidnumber, 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 ofinformation is written, the file is archived (using the Linux ar command) into file

Linux System-Managed Encryption

116 IBM Tape Device Drivers Installation and User’s Guide

Page 135: IBM Tape Driver IUG 1

lin_tape.a in the same directory. In the archive, the filename is renamed tolin_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 thedefault maximum size of the trace file by modifying settings in the lin_taped.conffile. Refer to the instructions in the lin_taped.conf file for details.

Error Logging: lin_taped records certain error messages from the lin_tape devicedriver in a file named /var/log/lin_tape.errorlog, by default. Information is writteninto the file until it is 1 MB in size, by default. After 1 MB of trace information iswritten, the file is archived (using the Linux ar command) into file lin_tape.a in thesame 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 orthe default maximum size of the error log file by modifying settings in thelin_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 isenabled. Following is an example an error log record:IBMtape0---E0001 Tue Sep 10 14:04:57 2002

Scsi Path : 03 00 00 00CDB Command : 01 00 00 00 00 00Status Code : 08 00 00 01Sense 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 0010 01 00 00 00 00 00 00 00 00 00 00 00 00 00 0000 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 serialnumber, and the timestamp when the error message was recorded. ″Scsi Path″ isthe 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 datablock of the SCSI command. ″Status Code″ is the returned result from the LinuxSCSI 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 SCSIsense data returned from the target. ″Description″ is a person-readable text stringobtained 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 data2. Sense key is 2, and the ASC/ASCQ indicates the device is becoming ready3. Sense key is 6, indicating a unit attention4. 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 fromthe tape drive whenever the drive reaches a log threshold, or a tape is unloadedfrom the drive, or the drive is reset through an application. This data is stored inbinary in a file named lin_tape.timestamp.log, where: lin_tapen is the device specialfile (for example, lin_tape1, lin_tape2, etc.) and timestamp reflects the time the filewas created. Each time log sense data is obtained, it is written to a new file. Usethe appropriate tape drive hardware reference manual to decode the log sensedata.

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 117

Page 136: IBM Tape Driver IUG 1

The volume logging data is stored in the /var/log directory by default. You mayspecify another directory in the /etc/lin_taped.conf file.

There are two configuration parameters in the /etc/lin_taped.conf file that you cantailor 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, andeach time log sense data is obtained, it is written to a new file.

If lin_tapeMaxLogSenseFiles is a positive number andlin_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 andlin_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 sensefile and creates a new file with the newest log sense data; thus, only the newestdata is kept.

Automatically Retrieve a Drive Dump: If a condition occurs in the drive suchthat a drive dump is created, lin_taped retrieves the drive dump and saves it in afile named lin_tapex.timestamp.dmp, where lin_tapen is the device special file (forexample, lin_tape1, lin_tape2, etc.) and timestamp reflects the time the file wascreated. Each time a drive dump is obtained, it is written to a new file. The IBMservice organization may request that you forward drive dumps to them foranalysis.

The drive dumps are stored in the /var/log directory by default. You may specifyanother directory in the /etc/lin_taped.conf file.

There are two configuration parameters in the /etc/lin_taped.conf file that you cantailor 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, andeach time a drive dump is obtained, it is written to a new file.

If lin_tapeMaxDumpFiles is a positive number andlin_tapeAutoDriveDumpFileOverWrite is 0, each time a dump is obtained, lin_tapedwrites that data to a file until lin_tapeMaxDumpFiles have been created; thenlin_taped stops creating new files, even if new drive dumps are produced.

Linux Device Driver (lin_tape)

118 IBM Tape Device Drivers Installation and User’s Guide

Page 137: IBM Tape Driver IUG 1

If lin_tapeMaxDumpFiles is a positive number andlin_tapeAutoDriveDumpFileOverWrite is 1, each time a dump is obtained, lin_tapedwrites that data to a file until lin_tapeMaxDumpFiles have been created; then whena new drive dump is detected, lin_taped deletes the oldest drive dump file andcreates a new file with the newest drive dump data; thus, only the newest data iskept.

Automatically Retrieved SIM/MIM Data: If a condition occurs in the drive suchthat a drive SIM/MIM data is created, lin_taped retrieves the data and save it in afile named lin_tapex.timestamp.simmim, where lin_tapen is the device special file (forexample, lin_tape1, lin_tape2, etc.) and timestamp reflects the time the file wascreated. Each time SIM/MIM data is obtained, it is written to a new file. The IBMservice organization may request that you forward SIM/MIM data to them foranalysis.

The SIM/MIM data is stored in the /var/log directory by default. You may specifyanother directory in the /etc/lin_taped.conf file.

There are two configuration parameters in the /etc/lin_taped.conf file that you cantailor 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_tapeAutoSimMimDataOverWriteis 1, which means that every time SIM/MIM data is obtained, it is written to anew 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 andlin_tapeAutoSimMimDataOverWrite is 0, each time SIM/MIM data is obtained,lin_taped writes that data to a file until lin_tapeMaxSimMimDataFiles have beencreated; then lin_taped stops creating new files, even if new SIM/MIM data arecreated.

If lin_tapeMaxSimMimDataFiles is a positive number andlin_tapeAutoSimMimDataOverWrite is 1, each time SIM/MIM data is obtained,lin_taped writes that data to a file until lin_tapeMaxSimMimDataFiles have beencreated; then when new SIM/MIM data is detected, lin_taped deletes the oldestSIM/MIM file and creates a new file with the newest SIM/MIM data; thus, onlythe newest data is kept.

Selective Tracing: lin_tape provides facilities by which you can disable andenable tracing, error logging, auto-retrieving drive dumps, and auto-retrievingSIM/MIM data. You may selectively enable/disable them through the IBMtapeutilQuery/Set Tape Parameters operation or through an application program whichuses the STIOC_SETP ioctl. These settings persist until the device driver isrestarted, or the host system is rebooted.

Note: See “Linux System - Tape Utility Program (IBMtapeutil)” on page 385 forinformation on the IBMtapeutil application.

The parameters and their definitions are as follows:

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 119

Page 138: IBM Tape Driver IUG 1

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

loggingThis parameter is set to On by default and enables logging of log sensedata. Setting this flag to Off suppresses volume logging for this device.

disable_sim_loggingThis parameter controls the logging of SIM/MIM data for a device. Bydefault it is set to Off which causes SIM/MIM data to be logged. Set thisflag to On to suppress the logging of SIM/MIM records.

disable_auto_drive_dumpThis parameter controls the saving of drive dumps for a device. By defaultit is set to Off which causes drive dumps to be saved. Set this flag to On tosuppress the saving of drive dumps.

Run lin_tapedIf you are running the lin_tape device driver, version 1.4.1 or higher, afterinstalling lin_tape lin_taped starts running even if your system does not have atape 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 arerunning the lin_tape device driver, version 1.3.x or less, lin_taped does notautomatically start if there is no tape device attached. After you attach a new tapedevice, you’ll need to start the lin_taped daemon.

You can invoke lin_taped from the command line. lin_taped takes zero or more ofthe parameters as listed in the following:lin_taped [start stop restart status]

lin_taped or lin_taped startStarts the daemon. If there is already a lin_taped running, the new one isaborted. (Use ″lin_taped restart″ if lin_taped is already running.)

lin_taped stopTerminates the daemon and frees all the resources associated with thedaemon. When the daemon is stopped, no information is saved.

lin_taped restartTerminates the currently running daemon and starts a new one. The newdaemon reads the /etc/lin_taped.conf file. This command should be usedafter modifying the /etc/lin_taped.conf file while lin_taped is running.

lin_taped statusPrints 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 driverfrom the running kernel, you need to stop the lin_taped daemon first;otherwise you get a ″Device or Resource Busy″ error.

Reservation Conflict LoggingWhen the device driver receives a reservation conflict on a tape drive command itwill 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 ifa SCSI Persistent Reservation is active on the target tape drive and, if it is, will getthe reserving host initiator WWPN (World Wide Port Name). If successful, thedevice driver will post the messagelin_tape: reserve held by xxxxxxxx

Linux Device Driver (lin_tape)

120 IBM Tape Device Drivers Installation and User’s Guide

Page 139: IBM Tape Driver IUG 1

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

Tape Drive Service AidsThe service aids described here are accessible through both the interactive andcommand-line mode of the IBMtapeutil. Refer to “Service Aid Subcommands” onpage 392. For information on using tape drive service aids with the IBMVirtualization Engine TS7510, please refer to the IBM System Storage VirtualizationEngine TS7510 Installation and Planning Guide at: http://www-03.ibm.com/systems/storage/index/tape.html

Details of Tape Drive Service AidsThe following service aid utilities are available through the utility programIBMtapeutil installed with the lin_tape device driver.v Force Microcode Dumpv Read Dumpv Load Microcodev Reset Drive

Force Drive Dump: This utility forces a dump operation on the tape drive. Afterthe dump operation is performed, the dump data can be saved to a file using theRead Dump utility. To access this utility, invoke IBMtapeutil, then choose ″ForceDump″ under ″Service Aids Commands″ in the menu or issue the followingcommand:IBMtapeutil -f /dev/IBMtape0 forcedump

Read Dump: This utility transfers the dump data from the device to a file, adiskette, or a tape cartridge. It follows a force drive dump operation. To access thisutility, invoke IBMtapeutil, then choose ″Dump Device″ under ″Service AidsCommands″ in the menu or issue the following command:IBMtapeutil -f /dev/IBMtape0 dump [filename]

If the filename is not specified, dump0001.dmp is used as the default. All the dumpfiles are stored under the current directory.

Load Microcode: This utility downloads microcode to the tape drive or mediumchanger from a file. To access this utility, invoke IBMtapeutil, then choose ″LoadUcode″ under ″Service Aids Commands″ in the menu or issue the followingcommand:IBMtapeutil -f /dev/IBMtape0 ucode filename

Note: The filename has to be specified. Otherwise, IBMtapeutil returns an error.

Reset Drive: This utility resets the tape drive. To access this utility, invokeIBMtapeutil, then choose ″Reset Drive″ under ″Service Aids Commands″ in themenu or issue the following command:IBMtapeutil -f /dev/IBMtape0 resetdrive

Linux Device Driver (lin_tape)

Chapter 5. Linux Tape and Medium Changer Device Driver 121

Page 140: IBM Tape Driver IUG 1

Linux Device Driver (lin_tape)

122 IBM Tape Device Drivers Installation and User’s Guide

Page 141: IBM Tape Driver IUG 1

Chapter 6. Solaris Tape and Medium Changer Device Driver

Purpose . . . . . . . . . . . . . . . 123Data Flow . . . . . . . . . . . . . . 123Product Requirements . . . . . . . . . . 124

Hardware Requirements. . . . . . . . . 124Software Requirements . . . . . . . . . 126

Installation and Configuration Instructions . . . 126Preventing Conflicts with Other Device Drivers 127Preinstallation Considerations . . . . . . . 127Installing and Updating IBMtape . . . . . . 128Configuring IBM tape devices with FibreChannel and SAS HBAs . . . . . . . . . 133Solaris Zones Support . . . . . . . . . 136Configuration Parameters . . . . . . . . 139Removing IBMtape . . . . . . . . . . 142Adding or Removing Devices . . . . . . . 142Deconfiguring Tape Devices . . . . . . . 143Tapelist Utility Program . . . . . . . . . 144

Special Files . . . . . . . . . . . . . . 145Device Behaviors . . . . . . . . . . . 146File Naming Conventions . . . . . . . . 147

Persistent Naming Support . . . . . . . . . 148Control Path Failover Support for Libraries . . . 149

Configuring and Deconfiguring Path FailoverSupport . . . . . . . . . . . . . . 149Primary and Alternate Paths . . . . . . . 149Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 150

Disable and Enable Primary and Alternate Paths 150Data Path Failover and Load Balancing Support forTape Drives . . . . . . . . . . . . . . 150

Configuring and Deconfiguring Path FailoverSupport . . . . . . . . . . . . . . 150Primary and Alternate Paths . . . . . . . 152Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 152Disable and Enable Primary and Alternate Paths 153

System-Managed Encryption . . . . . . . . 153Device Driver Configuration . . . . . . . 153Querying Tape Drive Configuration . . . . . 154Testing Data Encryption Configuration andConnectivity. . . . . . . . . . . . . 154Field Support Information . . . . . . . . 155

Problem Determination . . . . . . . . . . 155Functional Verification . . . . . . . . . 155Installation Problems . . . . . . . . . . 156Tape Monitor Daemon (tmd) . . . . . . . 156Tracing Facility . . . . . . . . . . . . 157Dynamic Tracing Utility . . . . . . . . . 159Setting the IBM_trace Level for Static Tracing 159Running Diags_info Script . . . . . . . . 160iostat Command . . . . . . . . . . . 160Reservation Conflict Logging . . . . . . . 161

This chapter provides an overview of the IBM SCSI Tape and Medium ChangerDevice Driver for Solaris, also known as IBMtape.

PurposeThis device driver product provides attachment for IBM Magnetic Tape andLibrary System products to Sun Microsystems SPARC Servers running the Solarisoperating system.

It is designed specifically to take advantage of the features provided by IBM tapeand library systems, including control of the random access medium changerfacility (move, element information, and inventory) present in some devices. Thegoal 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 fulltape management systems. Whenever possible, the device driver is designed totake advantage of the IBM tape system features transparent to the application.

Data FlowBoth data and commands flow between the application program and the tapesubsystem by way of IBMtape. Figure 12 on page 124 shows the data flow betweenIBMtape, the application program, the SCSI adapter device driver, and the IBMtape system.

© Copyright IBM Corp. 2007, 2009 123

Page 142: IBM Tape Driver IUG 1

Product RequirementsThe following hardware and software components are required and supported byIBMtape.

Hardware RequirementsThe 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 SANData 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.

ApplicationProgram

IBMtapeDeviceDriver

SCSI orFC

Host BusAdapterDriver

IBMTape

Subsystem

a2500266

Figure 12. Data Flow for Solaris Device Driver (IBMtape)

Solaris Device Driver (IBMtape)

124 IBM Tape Device Drivers Installation and User’s Guide

Page 143: IBM Tape Driver IUG 1

v The Ultrium tape drives and Enterprise Tape drives 3590 (Model E) and 3592with Fibre Channel Attachment are supported with the following adapters:– QLogic HBA:

QLA2200F, QLA2310FL, QLA2340/2340L, QLA2342/2342L, QLA2460/2462PCI and PCI-X Fibre Channel Host Bus AdaptersQLE2560/2562 PCI-E Fibre Channel Host Bus AdaptersQLE2460/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 AdaptersLPe12000/12002 PCI-E Fibre Channel Host Bus AdaptersLPe11000/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 andSG-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)

v Table 20 indicates which SCSI-attached devices are supported through the IBM2108-G07 (IBM SAN Data Gateway) and IBM 2108-R03 (IBM SAN Data GatewayRouter) with which fibre-channel host bus adapters.

Table 20. SCSI Supported Devices

DEVICEQLogic

QLA2100QLogic

QLA2200F Emulex LP8000 Emulex LP8000S

Magstar MP3570

X

Magstar MP3575

X

Enterprise 3590,models B11,B1A, E11, andE1A

X X X X

VTS model B18 X X X X

VTS models B10,B20

X X X

IBM Enterprise Tape Drive 3590, Models B11, B1A, E11, and E1AIBM Magstar MP 3570 Tape Subsystem Model CIBM Magstar MP 3575 Tape Library DataserverIBM TotalStorage Virtual Tape Server (Models B10, B18, and B20)

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 125

Page 144: IBM Tape Driver IUG 1

Notes:

1. Using a single Fibre Channel host bus adapter (HBA) for concurrent tape anddisk operations is not recommended. Tape and disk devices requireincompatible HBA settings for reliable operation and optimal performancecharacteristics. Under stress conditions (high I/O rates for tape, disk, or both)where disk and tape subsystems share a common HBA, stability problems havebeen observed. These issues are resolved by separating disk and tape I/Ostreams onto separate HBAs and using SAN zoning to minimize contention.IBM is focused on assuring server and storage configuration interoperability. Itstrongly recommends that your implementation plan includes provisions forseparating disk and tape workloads.

2. For IBM Ultrium drives with the Fibre Channel attachment, the Sun Solarisoperating system requires that the Fibre Channel addressing mode of the drivebe 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 .

Software RequirementsThe 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 todetermine which adapter driver is required.

Installation and Configuration InstructionsIBM SCSI Tape Drive and Medium Changer Device Driver for Solaris is aninstallable kernel module, supplied as a standard Solaris software package. Wheninstalled, its package name is IBMtape. The following sections describe installation,removal, configuration, and verification procedures for IBMtape. Refer to theSolaris documentation for general information about installable packages.

The IBMtape package consists of the device driver and a number of associated filesand utilities. For components created during IBMtape installation, refer to Table 21.

Table 21. 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/tapeutil Utility and service aid program

/opt/IBMtape/tapeutil.c Utility/service program sample source code

/opt/IBMtape/diags_info Diagnostic script

/opt/IBMtape/ibmekm.conf SME configuration file, reference version

/opt/IBMtape/tapelist Utility program

/opt/IBMtape/tmd Tape Monitor Daemon (TMD) program

/opt/IBMtape/tmd.conf TMD configuration file, reference version

Solaris Device Driver (IBMtape)

126 IBM Tape Device Drivers Installation and User’s Guide

Page 145: IBM Tape Driver IUG 1

Table 21. IBMtape Components (continued)

Component (Note) Description

/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 programminginterface (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 andibmekm.conf are not overwritten by the package file contents. This allows tape driveconfiguration options to be preserved across IBMtape updates. The reference copies ofIBMtape.conf, tmd.conf and ibmekm.conf are always installed in the /opt/IBMtapedirectory.

Examples of installation commands and their results throughout this chapter use apercent sign (%) to indicate the shell prompt.

Preventing Conflicts with Other Device DriversIBMtape only attempts to claim and operate the devices described in “HardwareRequirements” on page 124. However, the Solaris operating system includes a SCSItape device driver named st, which claims any SCSI-compliant tape drive that itdetects, including devices that IBMtape manages. In order to avoid conflictsbetween IBMtape and st, you must prevent st from claiming and attempting tooperate IBMtape-owned devices. Likewise, other suppliers’ SCSI tape devicedrivers that you have installed must be prevented from claiming IBMtape-owneddevices.

Attention: Failure to prevent more than one device driver from operating thesame tape drive may cause system panics or data loss on the tape drive.

The following installation and update steps describe how to prevent conflictsbetween IBMtape and other SCSI tape device drivers.

Preinstallation ConsiderationsFollow these steps to install or update IBMtape. Before starting the step-by-stepprocedure, 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 adaptersfirst, then return to this section. Refer to the differential SCSI adapterdocumentation 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 thesystem.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 127

Page 146: IBM Tape Driver IUG 1

v As a consequence of installing or reinstalling IBMtape, device special filenumbers under /dev/rmt may change. These numbers are assigned by Solarisduring the driver attachment process, and the sequencing cannot be specified bythe device driver or installer.

Installing and Updating IBMtapeThere are several steps that must be taken prior to installing or updating IBMtapeon 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 theyare currently associated.% ls -l /dev/rmt/*llrwxrwxrwx 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, arecontrolled by the st device driver and are associated with the device at SCSIaddress 2, LUN 0. Record the device type, /dev/rmt special file number,owning driver, SCSI target address and LUN. This information is requiredlater in the installation.For example, suppose an installation has two non-IBM devices owned by st atSCSI 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 deviceinformation, refer to Table 22.

Table 22. IBMtape Install or Update

DEVICE Old Special File Old DriverSCSI Address/LUN

(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 devicesinstalled. In that case, list the primary device special files and find the SCSIaddresses with which they are currently associated.% ls -l /dev/rmt/*st /dev/rmt/*smclrwxrwxrwx 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

In this example, /dev/rmt/0st (a SCSI tape drive) is controlled by IBMtape andis associated with the device at SCSI address b, LUN 0. The address isreported in hexadecimal format: The file /dev/rmt/1smc (a SCSI mediumchanger) is associated with the device at SCSI address b, LUN 1. Record thedevice type, /dev/rmt special file number, owning driver, SCSI target addressand LUN. This information is required later in the installation.For example, suppose an installation has only an IBMtape-owned deviceinstalled at SCSI address 8. The device consists of both a tape drive and SCSImedium changer. The tape drive is accessed as /dev/rmt/2st, and the medium

Solaris Device Driver (IBMtape)

128 IBM Tape Device Drivers Installation and User’s Guide

Page 147: IBM Tape Driver IUG 1

changer as /dev/rmt/3smc. For a similar equipment listing after recording thedevice information, refer to Table 23.

Table 23. Solaris Device Driver - IBMtape - Equipment Listing Example 1

DEVICE Old Special File Old DriverSCSI Address/LUN

(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 andother SCSI tape device drivers, depending on the equipment that is attachedto your system.Attention: Failure to prevent more than one device driver from operating thesame 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 claimingthe 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. Thefollowing example shows the entries for SCSI target addresses 0 and 1commented out. Repeat this operation for all target entries.#name="st" class="scsi"#target=0 lun=0;

#name="st" class="scsi"#target=1 lun=0;

2) For other non-IBM installed SCSI tape device drivers, remove thedrivers 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 tapedevices.

b. If the system has a mixture of IBMtape-owned devices and other tapedrives, follow these steps to configure st and other non-IBM SCSI tapedevice drivers so that they control a range of target addresses distinct fromthe range that IBMtape uses. These steps leave target addresses 7 and 15unclaimed by all target device drivers, because SCSI adapters typically useone 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 eachtarget entry. In the following example, the entries for SCSI address 7and 8 have been commented out. Repeat this operation for all entriesin the target address range 7–15.#name="st" class="scsi"#target=7 lun=0;

#name="st" class="scsi"#target=8 lun=0;

2) For other non-IBM installed SCSI tape device drivers, follow thesuppliers’ instructions to disable their access to all SCSI tape devices inthe address range 7–15.

3) Later, after the IBMtape package has been installed, you must alter itsconfiguration file so it does not use SCSI target addresses in the range0–7 or address 15.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 129

Page 148: IBM Tape Driver IUG 1

Now st and other non-IBM SCSI tape device drivers have been configuredto avoid conflicting with IBMtape.

8. Remove all special file entries under /dev/rmt. This ensures that stale entries donot exist after the system is restarted. New entries are created when thesystem is restarted.% rm /dev/rmt/*

9. If you are updating the level of IBMtape, remove the currently installedIBMtape 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 inuse. Identify the drives and TMD process ID (pid), and end the processesthat are using them. If you cannot identify the processes, you must restartthe system to free the tape drive, then continue with the installation fromthis point....Device busyCannot unload module: IBMtapeWill be unloaded upon reboot....

10. Select one of the following methods to install the IBMtape package, dependingon 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 tothe system, pkgadd error messages similar to the following are output:...drvconfig: Driver (IBMtape) failed to attachWarning: Driver (IBMtape) successfully added to systembut 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 driverattaches normally.If the distribution medium is a package file in a Unix file system, perform thefollowing steps. You may have obtained a package file by extracting it from adistribution diskette or by downloading it from IBM’s anonymous FTP site.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

11. If your system environment includes a mixture of IBMtape-owned devices anddevices owned by st or another third-party SCSI tape device driver, you

Solaris Device Driver (IBMtape)

130 IBM Tape Device Drivers Installation and User’s Guide

Page 149: IBM Tape Driver IUG 1

should have already modified the configuration files for the non-IBM devicedrivers and restricted them to target addresses in the range 0–6.Edit IBMtape.conf, located in /usr/kernel/drv, and comment out entries for SCSItarget addresses 0–7 and 15 by placing a pound sign (#) in the first column ofeach line making up the entries. In the following example, the entries foraddress 0, LUN 0 and address 0, LUN 1 have been commented out. Repeatthe operation for all stanzas in the address range 0–7 and address 15. Notethat 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;

#name="IBMtape" class="scsi"#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 targetaddress out of the range 15 and LUN over the number 1. You create a newentry 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=15block_size=0buffering=1immediate=0trailer=0sili=0;

Alternatively, you can modify the configuration file or use the utility providedby the fibre channel HBA driver to persistently bind the tape device to theexpected SCSI target address.

12. Shut down the system. One common method to perform a shutdown isshown here but use your installation’s normal procedures.% /usr/sbin/shutdown -y -g0 -i0

13. 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 andrecord the device type, SCSI address, and LUN. For example, supposean installation has only IBMtape-owned devices attached. An IBMdevice with tape drive and medium changer is added. It is addressedat target 4 and the information is recorded. For the results, refer toTable 24 on page 132

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 131

Page 150: IBM Tape Driver IUG 1

Table 24. Solaris Device Driver - IBMtape - Equipment Listing Example 2

DEVICEOld Special

File Old Driver

SCSIAddress/LUN

(Old)

SCSIAddress/LUN

(New)

3590-B11 drive – – – 4/0

3590-B11 changer – – – 4/1

b. If you are using distinct address ranges to separate tape drives that areIBMtape-owned from devices that are owned by st or another supplier’sdriver, 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 specialinstructions about readdressing. Then readdress each device to anaddress in the range 0–6. For each tape drive that is readdressed,record the new SCSI address along side the special file number and oldSCSI address that you recorded previously.

2) Readdress all tape drives that are owned by IBMtape to addresses inthe range 8–14. Refer to the appropriate IBM hardware references forany special instructions about readdressing. For each tape drive that isreaddressed, record the new SCSI address along side the special filenumber and old SCSI address, if any, that you recorded previously.For example, suppose an installation has two non-IBM devices ownedby st at SCSI addresses 9 and B (12 in decimal). An IBM device withtape drive and medium changer is added. To prevent conflicts betweenIBMtape and st, the non-IBM devices are all placed at addresses in therange 0–6. The new IBM device is addressed in the range 8–14, ataddress 10, or X'0A'. Depending on the addresses chosen for thenon-IBM devices, after readdressing and recording device information,refer to Table 24 for the possible equipment listing.

Table 25. Solaris Device Driver - IBMtape - Equipment Listing Example 3

DEVICEOld Special

File Old Driver

SCSIAddress/LUN

(Old)

SCSIAddress/LUN

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

14. Cable the tape drives to the system, if not yet done. Refer to themanufacturer’s hardware references for any special instructions about cabling.Ensure that each SCSI bus is terminated properly.

15. Start the system according to your installation’s normal procedures.16. 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 SCSItargets you recorded. Write the new device special file numbers and owningdriver next to the matching new SCSI addresses.

Solaris Device Driver (IBMtape)

132 IBM Tape Device Drivers Installation and User’s Guide

Page 151: IBM Tape Driver IUG 1

For example, suppose an installation previously had two non-IBM devicesowned by st at SCSI addresses 2 and–8. An IBM device with tape drive andmedium changer is added. To prevent conflicts between IBMtape and st, thenon-IBM devices are all placed at addresses in the range 0–6. The new IBMdevice is addressed in the range 8–14. Depending on the addresses chosen,after completing installation and recording device information, refer toTable 26 for the possible equipment listing entries.

Table 26. Solaris Device Driver - IBMtape - Equipment Listing Example 4

DEVICEOld Special

FileOld

Driver

SCSIAddress/

LUN (Old)

SCSIAddress/

LUN (New)New

DriverNew SpecialFile (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-B11drive

– – – 8/0 IBMtape /dev/rmt/2st

3590-B11changer

– – – 8/1 IBMtape /dev/rmt /3smc

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.

17. Verify operation of the newly installed or readdressed equipment.18. Notify users of any changed device special files numbers.

Configuring IBM tape devices with Fibre Channel and SASHBAs

Users may experience difficulty attaching an IBM tape device with an IBM tapedriver on a fibre network. The following sections describe how to configure IBMtape devices with QLogic, Emulex, Sun 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 134v “Configuring IBM tape devices with Sun FC and SAS HBAs” on page 134v “Configuring IBM tape devices with AMCC FC HBAs” on page 135

Configuring IBM tape devices with QLogic FC HBAsTo configure an IBM tape device with a QLogic FC HBA, complete the followingsteps: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 QLA2462running 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 currententry 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 withtarget 200 and LUN 3:name="IBMtape" class="scsi" target=200 LUN=3;

4. Unload and reload the IBMtape driver:

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 133

Page 152: IBM Tape Driver IUG 1

# /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.

Configuring IBM tape devices with Emulex FC HBAsTo configure an IBM tape device with an Emulex FC HBA, complete the followingsteps: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 LUN0 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 currententry in IBMtape.conf adds target 255 with LUN 0 and 1.For instance, the following command adds an entry for a mapped device withtarget 200 and LUN 3:name="IBMtape" class="scsi" target=200 lun=3;

5. Unload and reload the IBMtape driver:# /opt/IBMtape/tmd -s# rem_drv IBMtape# add_drv -m '* 0666 bin bin' IBMtape# /opt/IBMtape/tmd

6. Display information on the configured devices by running/opt/IBMtape/tapelist -l.

Configuring IBM tape devices with Sun FC and SAS HBAsTo configure an IBM tape device with a Sun FC HBA, complete the followingsteps: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 changerconfiguration with the HBA.Run # cfgadm -c configure device to configure the tape device with the HBA ifneeded.

4. Install the IBMtape tape driver by running the # pkgadd -d IBMtapecommand.

5. Enter the following appropriate lines in /etc/driver_aliases:

Solaris Device Driver (IBMtape)

134 IBM Tape Device Drivers Installation and User’s Guide

Page 153: IBM Tape Driver IUG 1

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 andXXX 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 isadded in the file for the IBM LTO2 drive:IBMtape "scsiclass,01.vIBM.pULT3580-TD2"

The following is a list of the entries for the supported IBM tape devices.For the tape drives:IBMtape "scsiclass,01.vIBM.pULT3580-TD1"IBMtape "scsiclass,01.vIBM.pULTRIUM-TD1"IBMtape "scsiclass,01.vIBM.pULT3580-TD2"IBMtape "scsiclass,01.vIBM.pULTRIUM-TD2"IBMtape "scsiclass,01.vIBM.pULT3580-TD3"IBMtape "scsiclass,01.vIBM.pULTRIUM-TD3"IBMtape "scsiclass,01.vIBM.pULT3580-HH3"IBMtape "scsiclass,01.vIBM.pULTRIUM-HH3"IBMtape "scsiclass,01.vIBM.pULT3580-TD4"IBMtape "scsiclass,01.vIBM.pULTRIUM-TD4"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 theoperating 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 systemautomatically after IBMtape is unloaded from the kernel by running the# pkgrm, rem_drv, or modunload commands. It is stronglyrecommended that you back up these entries in a file, and that youre-enter the entries when you upgrade the IBMtape driver beforerunning the #pkgadd command.

Configuring IBM tape devices with AMCC FC HBAsTo configure an IBM tape device with an AMMC FC HBA, complete the followingsteps: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.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 135

Page 154: IBM Tape Driver IUG 1

3. Run the EZ Fibre utility to find and record the mapped target and LUN of thetape 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 entryin IBMtape.conf adds target 255 with LUN 0 and 1. For instance, use thefollowing command to add an entry for a mapped device with a target 200 andLUN 3:name="IBMtape" class="scsi" target=200 lun=3;

6. Unload and reload the IBMtape driver:# /opt/IBMtape/tmd -s# rem_drv IBMtape# add_drv -m '* 0666 bin bin' IBMtape# /opt/IBMtape/tmd

7. Display information on the configured devices by running/opt/IBMtape/tapelist -l.

Solaris Zones SupportThe Solaris Zones partitioning technology on Solaris 10 is used to virtualizeoperating system services and provide an isolated and secure environment forrunning applications. Every Solaris system contains a global zone with ID 0, wherethe IBMtape driver is installed. Zones hosted by a global zone are known asnon-global zones, which have their own node name, virtual network interface, andstorage assignment.

The IBMtape driver supports the Solaris Zones environment. To install IBMtape onthe system with the virtualized zones, run the pkgadd system command from theglobal zone:#pkgadd -G -d IBMtape.x.x.x.x

The IBMtape install script installs the driver in the global zone and installs some ofIBMtape utilities running a non-root user in all zones.

Since the tape devices in non-global zones are configured from the global zone, ascript program called ztapelist was developed to help the user display the IBMtape devices and to dynamically assign or remove IBM tape devices in non-globalzones without the non-global zone reboot requirement. The utility (available inIBMtape 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 allzones

-c Displays IBM tape device information without the column headers for allzones

-z zonename Shows IBM tape devices in a zone

Solaris Device Driver (IBMtape)

136 IBM Tape Device Drivers Installation and User’s Guide

Page 155: IBM Tape Driver IUG 1

-a Dynamically adds IBM tape devices to each non-global zone withoutadditional arguments

zonename inst#_1 inst#_2 inst#_3 ...Dynamically sets IBM tape devices not greater than 7 in a non-globalzone

zonename allDynamically sets all IBM tape devices on the system in a non-globalzone

-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 andthe tape devices in the non-global zones as shown in the following example. Anoption of ztapelist -z zonename is also provided to show all of the assigned tapedevices in a particular zone.

# /opt/IBMtape/ztapelist -lRunning 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 500507630059F016194 /dev/rmt/28smc 03584L22 0000000T003904E5 2/1 805r N/A N/A200 /dev/rmt/29st ULT3580-TD4(e) 1300000044 4/0 82F0 500507630019F009 500507630059F009201 /dev/rmt/30smc 03584L32 0000000T00390401 4/1 805r N/A N/A206 /dev/rmt/31st ULT3580-TD3 1210003557 7/0 73P5 500507630019F007 500507630059F00738 /dev/rmt/32smc 03584L32 0000000T00390401 7/1 805r N/A N/A

Running in non-global zone camshaft ...Inst# Special File Device Serial No TGT/LUN Ucode World Wide NN World Wide PN------- ------------- ----------------- ------------------ -------- ---------- ------------- -------------200 /dev/rmt/29st ULT3580-TD4(e) 1300000044 4/0 82F0 500507630019F009 500507630059F009201 /dev/rmt/30smc 03584L32 0000000T00390401 4/1 805r N/A N/A

Running in non-global zone softail ...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 500507630059F016194 /dev/rmt/28smc 03584L22 0000000T003904E5 2/1 805r N/A N/A

To add the tape devices in non-global zones, run # /opt/IBMtape/ztapelist -a, asshown in the following example:

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 137

Page 156: IBM Tape Driver IUG 1

# ztapelist -aIssuing this function will assign the tape devices in non-global zoneDo you wish to continue? [y/n]: yInst# 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 500507630059F016194 /dev/rmt/28smc 03584L22 0000000T003904E5 2/1 805r N/A N/A200 /dev/rmt/29st ULT3580-TD4(e) 1300000044 4/0 82F0 500507630019F009 500507630059F009201 /dev/rmt/30smc 03584L32 0000000T00390401 4/1 805r N/A N/A206 /dev/rmt/31st ULT3580-TD3 1210003557 7/0 73P5 500507630019F007 500507630059F00738 /dev/rmt/32smc 03584L32 0000000T00390401 7/1 805r N/A N/A

Enter Instance Number (Inst #) of a device to be added: 200

ID NAME STATUS PATH0 global running /1 camshaft running /zones/zone12 softail running /zones/zone2

Enter the zonename where the device will be added: camshaftInst# Special File Device Serial No TGT/LUN Ucode World Wide NN World Wide PN------- --------------- ---------------- ----------------- --------- ------- --------------- ---------------200 /dev/rmt/29st ULT3580-TD4(e) 1300000044 4/0 82F0 500507630019F009 500507630059F009

Do you wish to continue to add the devices? [y/n]: yEnter Instance Number (Inst #) of a device to be added: 193Enter the zonename where the device will be added: softailInst# 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

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 tapedevices from the non-global zone, as shown in the following example:

Solaris Device Driver (IBMtape)

138 IBM Tape Device Drivers Installation and User’s Guide

Page 157: IBM Tape Driver IUG 1

# /opt/IBMtape/ztapelist -dIssuing this function will remove the tape devices from non-global zoneDo you wish to continue? [y/n]: yDo you want to remove the tape devices from all of non-global zones? [y/n]: n

ID NAME STATUS PATH0 global running /1 camshaft running /zones/zone12 softail running /zones/zone2

Enter the zonename where the devices will be removed: camshaftDo you want to remove all of the tape devices from this zone? [y/n]: nInst# Special File Device Serial No TGT/LUN Ucode World Wide NN World Wide PN------- ---------------- ------------- ----------------- ----------- -------- ------------------ -----------------200 /dev/rmt/29st ULT3580-TD4(e) 1300000044 4/0 82F0 500507630019F009 500507630059F009201 /dev/rmt/30smc 03584L32 0000000T00390401 4/1 805r N/A N/A

Enter Instance Number (Inst #) of a device to be removed: 201Removing this tape device /dev/rmt/30smc for this zone camshaft ...Inst# Special File Device Serial No TGT/LUN Ucode World Wide NN World Wide PN------- -------------- ------------------ ---------------- ---------- -------- ------------------- ------------------200 /dev/rmt/29st ULT3580-TD4(e) 1300000044 4/0 82F0 500507630019F009 500507630059F009

Do you wish to continue to remove the devices from this zone? [y/n]: nDo you wish to continue to remove the devices from other zone? [y/n]: y

ID NAME STATUS PATH0 global running /1 camshaft running /zones/zone12 softail running /zones/zone2

Enter the zonename where the devices will be removed: softailDo you want to remove all of the tape devices from this zone? [y/n]: yRemoving all of tape devices for this zone softail ...Inst# Special File Device Serial No TGT/LUN Ucode World Wide NN World Wide PN------- ------------------- --------------- ------------------ --------- -------- -------------- -------------------Do you wish to continue to remove the devices from other zone? [y/n]: n

Configuration ParametersWhen using devices controlled by IBMtape, certain device characteristics, such asthe default block size, can be controlled through the device driver configuration file.The IBMtape configuration file is named IBMtape.conf. The working copy of thisfile is located in the /usr/kernel/drv directory.

During installation of IBMtape, the working copy of IBMtape.conf is preserved, if itexists. During removal of IBMtape, the working copy of IBMtape.conf is notdeleted. These conventions allow configuration settings to remain across updates ofIBMtape. A reference copy of IBMtape.conf with factory default settings is alwaysinstalled in the /opt/IBMtape directory.

Note: IBM requires that the Solaris native SCSI tape device driver st be configuredso that it does not attempt to support SCSI targets that are controlled byIBMtape. Refer to “Preventing Conflicts with Other Device Drivers” on page127 for more information about multiple driver access to a device.

Attention: Failure to prevent more than one device driver from operating thesame 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 unloadedmanually from, then reloaded into, memory. If you change configuration settings inIBMtape.conf, you can make the changes effective by restarting the system. As analternative to restarting, ensure that no IBMtape-owned devices are in use, thenissue the following:

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 139

Page 158: IBM Tape Driver IUG 1

% /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 onlywhile the device is kept open) using the ioctl application programming interface(API) of the device driver. The parameter settings made through the API revertback to the default values in IBMtape.conf the next time the device is opened. Referto the IBM TotalStorage and System Storage Tape Device Drivers: Programming Referencefor more information about changing configuration parameters under programcontrol.

IBMtape.conf contains one stanza for each SCSI target address/LUN pair owned byIBMtape. The reference IBMtape.conf file supplied with the package contains astanza for every possible SCSI target and LUN combination supported by IBM tapesystems.

The following example shows the stanza for target 0, LUN 0, with IBMtape’sdefault configuration parameter values. The parameter immediate is disabled,which means that SCSI commands Write FM, Locate, Load-Unload, Erase, andRewind complete before returning status:name="IBMtape" class="scsi"target=0 lun=0block_size=0buffering=1immediate=0trailer=0sili=0;

The following example shows the stanza for target 0, LUN 0, with IBMtape’sdefault configuration parameter values and the rewind immediate mode set on,which causes the SCSI rewind command to return control to the applicationprogram before the command actually completes on the tape drive:name="IBMtape" class="scsi"target=0 lun=0block_size=0buffering=1rew_immediate=1trailer=0sili=0;

If immediate is set to 1 and rew_immediate is set to 0, the setting ofrew_immediate is ignored.

The name variable identifies IBMtape as the device driver, and class identifies thetype of device supported as SCSI.

The target and the lun variables determine the target address and LUN of IBMdevices that are controlled by that stanza. On systems with multiple SCSI adapters,a single target/LUN stanza controls the configuration settings for all devicesaddressed with that target address and LUN. Thus, two or more supported IBMdevices on the system that have the same target and LUN settings but are attachedto different SCSI buses are all affected by the configuration parameters of thesingle stanza having that target address and LUN.

After installation of the IBMtape package is complete, you may eliminateunnecessary probing for devices by commenting out unused target/LUN pairs. In

Solaris Device Driver (IBMtape)

140 IBM Tape Device Drivers Installation and User’s Guide

Page 159: IBM Tape Driver IUG 1

this example, the stanzas for target 0, LUN 0 and target 0, LUN 1 have beencommented out. Those address/LUN combinations are not probed, which savestime during a restart or manual reload of IBMtape. However, if an IBM device isaddressed at target 0, LUN 0 or target 0, LUN 1, it is not detected.#name="IBMtape" class="scsi"#target=0 lun=0#block_size=0#buffering=1#immediate=0#trailer=0#sili=0;

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

The remaining five configuration parameters specifically affect the behavior of theIBM device or devices associated with that stanza (target and LUN). All of theseparameters are specific to tape drive device operation only and have no effect onmedium changer device behavior. The default configuration parameters areadequate for most purposes. However, the values in the configuration file can bemodified to suit the specific requirements of the application or the user.

Remember that modifying a value in the configuration file determines the value ofthe parameter at device open time. When the device is open, the value of aparameter can be altered using an ioctl function call, but the change is effectiveonly while the device remains open. Working configuration parameters revert backto the default values (established by the configuration file) when the device isclosed and reopened. Refer to the IBM Tape Device Drivers: Programming Referencefor more information about changing configuration parameters through programcontrol.

Table 27 lists and describes the set of configuration parameters recognized by theIBMtape device driver.

Table 27. Configuration Parameters Recognized by IBMtape

Parameter Values Description

block_size (0=variablelength)

This option specifies the device block size that is established with the SCSI ModeSelect command during an open function call. Until this value is changed, it is theworking block size. Variable block size is established using a value of zero. Anyother positive value represents a fixed block size. The maximum supported blocksize varies for each tape device. Refer to the appropriate hardware referencemanual for additional information.Note: IBMtape does not allow odd-byte-count fixed block reads or writes. Forinstance, a fixed block size of 4096 or 4098 is allowed, but 4097 is not. If youattempt to read or write using an odd-byte-count fixed block size, the read orwrite returns -1, with errno set to 22, invalid argument. If you must read or writeodd-byte-count blocks, set block size to 0 (variable block size), then transfer oneblock’s worth of data per read or write.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 141

Page 160: IBM Tape Driver IUG 1

Table 27. 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 thephysical tape or buffered in device hardware. Buffering can be turned On and Offwith this option. If buffering is disabled, the effective performance of the devicemay be degraded seriously, because the tape devices cannot take advantage oftheir buffering optimization. Buffer flushing (or committing data to the tape) canbe 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 onthe tape drive. If immediate is set to 1, these commands return with status beforethe command actually completes.

rew_immediate (0=Off, 1=On) If rew_immediate is set to 0, the SCSI Rewind command returns with status whenthe command actually completes on the tape drive. If it is set to set to 1, theRewind command returns with status before the command actually completes. Ifimmediate 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, itreturns a check condition status. The driver returns 0 bytes written to notify theapplication of this EOT situation. A check condition is also returned by the tapedrive 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 timethe write operation notifies the application of EOT, all subsequent EOTnotifications are suppressed by the driver, and the actual number of bytes writtenis returned. When physical end of media is reached, all write operations fail witha 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 isactually read from the tape, the tape device raises a check condition. The IBMtapedevice driver must perform error handling procedures, which add overhead to theread operation. The IBMtape driver does not surface this as an error condition tothe application and ultimately returns the actual number of bytes read. However,this driver error processing results in less than optimum read performance insome scenarios. When SILI mode is enabled, the tape device is forced to SuppressIllegal Length Indication during read operations. This eliminates the errorprocessing performed by the driver and results in improved read performance forsome scenarios. The actual number of bytes read is still returned to the applicationin SILI mode.

Removing IBMtapeAll active processes using IBM devices supported by the IBM SCSI Tape andMedium Changer Device Driver for Solaris must be stopped in order for theremoval procedure to complete successfully.

Use the pkgrm command to remove the IBMtape package from the system.% /usr/sbin/pkgrm IBMtape

Adding or Removing DevicesTo add support for a new IBM tape system or to remove support for a previouslyattached 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 devicethat is to be added, or remove (comment out) a stanza for a device that is nolonger supported.

Solaris Device Driver (IBMtape)

142 IBM Tape Device Drivers Installation and User’s Guide

Page 161: IBM Tape Driver IUG 1

2. When adding support for a new device, ensure that the target and LUN valuesin the configuration file stanza match the target and LUN settings of the IBMdevice. Refer to “Configuration Parameters” on page 139 for more informationabout 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 thesystem. This is done by first unloading the device driver, then reloading thedevice driver into kernel memory.

b. For the version of IBMtape.4.0.9.2 and later, the TMD daemon has to bestopped by running the /opt/IBMtape/tmd -s command to unload theIBMtape driver from the kernel. Running the /opt/IBMtape/tmd commandrestarts 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 andacknowledge changes made in the file. This method can be used to modifyconfiguration parameters.

Note: It is strongly suggested that the host system and all devices attached tothe SCSI bus be powered Off before adding or removing devices fromthe SCSI bus. Hot plugging SCSI devices can cause hardware damageand disruption of reliable system operation.

Deconfiguring Tape DevicesIn some special situations, the user cannot modify IBMtape.conf to deconfiguresome tape devices with IBMtape driver, when more than one device is configuredwith the same target address, or the tape devices are attached on the FC or SASHBA running with Sun HBA driver.

In IBMtape.4.1.9.2 and later, a configuration parameter defined exclude_dev_list isintroduced to allow users to exclude some devices from the configuration withIBMtape.

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 forLTO 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 theconfiguration.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 143

Page 162: IBM Tape Driver IUG 1

Tapelist Utility ProgramA Tapelist Utility Program called tapelist is installed in the /opt/IBMtape directoryas part of the IBMtape package. The tapelist utility provides the user a listing oftape, medium changer and SAN data gateway devices configured with theIBMtape driver. It also displays the information of HBA with IBM tape driveattachment and the current status of load balancing. The following is an exampleof a Tapelist Utility Program output.

# tapelistInstance : 697Special File : /dev/rmt/6stDevice : 03592E05(e/e)Serial Number : 000001300168TGT/LUN : 7/0Ucode : 04C4World Wide NN : 5005076302000127World Wide PN : 5005076302400127Dev Phy Path : /devices/pci@1f,2000/QLGC,qla@1/IBMtape@7,0:stPath Type : N/A

# tapelist -thba_index hba_inst hba_driver reg_count usage_count HBA Path--------- -------- ----------- ----------- ----------- --------------------------–0 0 qla2300 4 1 /devices/pci@4,2000/fibre-channel@11 2 lpfc 4 2 /devices/pci@6,2000/pci@1/fibre-channel@42 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 librarythat is running /opt/IBMtape/tapelist -L.

# tapelist -LAddr 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/A274 2893 /dev/rmt/13st 03592E05(e/e) 000001365066 3/0 1D10 500507630019F016 500507630059F016276 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 previousscreens: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.

Solaris Device Driver (IBMtape)

144 IBM Tape Device Drivers Installation and User’s Guide

Page 163: IBM Tape Driver IUG 1

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 linefor all of the configured devices.

Special FilesAfter the IBMtape driver is installed, a set of special files is available forperforming input/output (I/O) operations to each supported device. The devicespecial file names created by the IBMtape device driver are similar to the SCSI tapespecial files generally used on Solaris systems.

Each tape instance has a set of minor numbers that provides access to the samephysical device, but each minor number provides a different function or behaviorfor the tape subsystem. These minor numbers are accessed through variations ofthe special file name for that device. The special files are created in the /dev/rmtdirectory. 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 devicespecial files. The following example shows entries returned by this command for asingle IBM tape subsystem. This listing is system dependent, so entries varyslightly 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 theIBMtape 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:smclrwxrwxrwx root other 78 Aug 26 18:54 0st ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/IBMtape@2,0:stlrwxrwxrwx root other 79 Aug 26 18:54 0stb ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/IBMtape@2,0:stblrwxrwxrwx root other 80 Aug 26 18:54 0stbn ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/IBMtape@2,0:stbnlrwxrwxrwx root other 79 Aug 26 18:54 0stc ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/IBMtape@2,0:stclrwxrwxrwx root other 80 Aug 26 18:54 0stcb ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/IBMtape@2,0:stcblrwxrwxrwx root other 81 Aug 26 18:54 0stcbn ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/IBMtape@2,0:stcbnlrwxrwxrwx root other 80 Aug 26 18:54 0stcn ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 145

Page 164: IBM Tape Driver IUG 1

10000/IBMtape@2,0:stcnlrwxrwxrwx root other 79 Aug 26 18:54 0stn ->/devices/iommu@f,e0000000/sbus@f,e0001000/QLGC,isp@3,10000/IBMtape@2,0:stn

These entries show the device hierarchy established to support I/O for an IBMSCSI tape system. The attachment path of the device special files spans from thesystem board, through the S-bus, to the Sun F/W SCSI adapter (supported by theQLGC, isp SCSI adapter device driver), to the IBM device at SCSI target 2 andLUN 0 (supported by the IBMtape device driver). All nine of these special files areassociated with the same IBM device (device number 0).

Device Behaviors

Certain device behaviors are determined by which special file in the set is openedfor device access. The smc special file controls only the medium changer portion ofthe device and accepts only medium changer operations by way of the ioctl entrypoint. The smc special file does not support the read and write entry points. Onlyone st type special file for a particular device may be opened at any one time. Thesmc 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 duringinstallation, based on the IBM device type being configured. For the IBM 3490EMagnetic Tape Subsystem, only the eight st type special files are created. For otherIBM tape drives, all nine special files shown previously are created. For IBM tapelibraries 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 presentsfurther information about the same special files, as shown in the followingexample. Again, the actual path information specified in the command varies fromsystem to system.crw-rw-rw- 1 bin bin 109,1696 Aug 26 18:54 IBMtape@2,0:smccrw-rw-rw- 1 bin bin 109,1664 Aug 26 18:56 IBMtape@2,0:stcrw-rw-rw- 1 bin bin 109,1728 Aug 26 18:54 IBMtape@2,0:stbcrw-rw-rw- 1 bin bin 109,1732 Aug 26 18:54 IBMtape@2,0:stbncrw-rw-rw- 1 bin bin 109,1688 Aug 26 18:54 IBMtape@2,0:stccrw-rw-rw- 1 bin bin 109,1752 Aug 26 18:54 IBMtape@2,0:stcbcrw-rw-rw- 1 bin bin 109,1756 Aug 26 18:54 IBMtape@2,0:stcbncrw-rw-rw- 1 bin bin 109,1692 Aug 26 18:54 IBMtape@2,0:stcncrw-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 devicedriver is in support of these special files. Major numbers are assigned by thesystem at the time the driver is installed and vary from system to system. The ninedifferent minor numbers are specific to the special file names and are used by thedevice driver to determine which special file was used to access the device andcontrol the device behavior accordingly. For example, the minor number 1696indicates 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.

Solaris Device Driver (IBMtape)

146 IBM Tape Device Drivers Installation and User’s Guide

Page 165: IBM Tape Driver IUG 1

File Naming ConventionsTable 28 shows the special file naming convention and the associated deviceattributes recognized by the IBMtape device driver.

Table 28. IBM SCSI Tape/Medium Changer Special Files for Solaris

Special File NameBSD Compatibility (Note

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 norewind on close in non-BSD mode, and if the last command before closing the device was a read, then the tapeis positioned after the filemark immediately following the last block read. If the device is opened for no rewindon close in BSD mode, and if the last command before closing the device was a read, the tape is left positionedexactly where it was following the last block read. If the device is opened for rewind on close the BSD mode isnot relevant.

2. The no rewind on close (n) device special file does not rewind the tape during a close operation. Otherwise, thetape is rewound when the device is closed. If the last operation before closing the device was a write or writefilemark, 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 thedevice 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 compressionwhile storing data on the tape. The compression mode of the device can also be set to the desired stateprogrammatically through the STIOC_SET_PARM ioctl, regardless of the default compression mode establishedby 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 tapelibraries and autoloaders, the smc special file is the only file created because the IBMtape device driver supportsonly the medium changer portion and does not support the tape drive portion of these devices. For the IBM3490E 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 inconjunction with one of the st type files. The smc special file accepts only medium changer commands. Tapedrive 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, somesupported devices can be configured with a nonstandard integrated medium changer reporting at the sametarget and LUN as the tape drive. In such a case, both st and smc special files accept a limited subset of mediumchanger commands. If you want to use this nonstandard mode, consult the appropriate hardware reference todetermine whether the drive supports such a configuration.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 147

Page 166: IBM Tape Driver IUG 1

Persistent Naming SupportThe device special file names are created by the IBMtape driver in the order thatthe tape devices are presented by the Solaris system. Each device special file nameis maintained with the same logical name across reboots, even when an existingdevice is powered off or not connected.

However, the logical names of devices may be changed due to the swapping ofconnecting cables, HBA mapping changes, tape device driver updates, or otherreasons.

The user can rename the logical name by editing the /etc/devlink.tab system file forthe 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 attachedon more than one HBA.The Ultrium-3 tape drive is connected to two Emulex HBAs with the sameaddress of target 3 and LUN 0 via a switch in the following example. You haveto use the HBA utility, follow HBA vendor instructions, or both to persistentlybind the tape devices at the different mapped target and LUN.

# tapelist -lInst# 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,0582 /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 0on HBA 2 after device persistent binding.

# tapelist -lInst# Special File Device Serial No TGT/LUN Device Physical Path------ --------------- ----------- --------- ---------- ----------------------------------------454 /dev/rmt/4st ULT3580-TD3 1210003557 3/0 /devices/pci@6,2000/pci@1/fibre-channel@5/IBMtape@3,01136 /dev/rmt/7st ULT3580-TD3 1210003557 24/0 /devices/pci@1f,2000/pci@1/fibre-channel@5/IBMtape@18,0

Note: Device persistent binding is not provided on Sun HBAs, so thispersistent name approach cannot be used with the same physical drivethat is attached to multiple Sun HBA ports.

2. Start persistent name binding. In this example, the user renames 4st and 7st to10st 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 planneddevice special file name in the entry. Here, 4st and 7st drives are located at3,0 (target 3, LUN 0) and 18,0 (target 24 (0x18), LUN 0) at the devicephysical paths of /devices/pci@6,2000/pci@1/fibre-channel@5/IBMtape@3,0and /devices/pci@1f,2000/pci@1/fibre-channel@5/IBMtape@18,0. Add theaddress and device file name into the entries:type=ddi_byte:tape;addr=3,0; rmt/10\M0type=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.

Solaris Device Driver (IBMtape)

148 IBM Tape Device Drivers Installation and User’s Guide

Page 167: IBM Tape Driver IUG 1

3) To avoid conflicts with the current device special files assigned by thesystem automatically, be sure to assign a higher number for thepersistent name.

4) The address is w500507630059f007,0 for the tape drive on the Sun HBAwith 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 isattached on Sun HBA.

e. Run tapelist to list the device special files.

# tapelist -lInst# Special File Device Serial No TGT/LUN Device Physical Path------ ------------- ------------ ------------- ---------- -------------------------454 /dev/rmt/10st ULT3580-TD3 1210003557 3/0 /devices/pci@6,2000/pci@1/fibre-channel@5/IBMtape@3,01136 /dev/rmt/11st ULT3580-TD3 1210003557 24/0 /devices/pci@1f,2000/pci@1/fibre-channel@5/IBMtape@18,0

Control Path Failover Support for Libraries

Configuring and Deconfiguring Path Failover SupportControl path failover (CPF) support is enabled automatically by default when theIBMtape device driver is installed on Solaris system. The Solaris IBMtape devicedriver provides a driver configuration parameter failover for you to enable ordisable the library control path failover support. To enable the CPF support for allof the paths, no any action is required. To disable the CPF support for all of thepaths 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 theIBMtape driver module from the current kernel:# /opt/IBMtape/tmd -s

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

Primary and Alternate PathsWhen the device driver configures a logical device with path failover supportenabled, the first device configured always becomes the primary path. When asecond or more logical device is configured with path failover support enabled forthe same physical device, it configures as an alternate path. The device driversupports up to 16 physical paths for single a device.

The primary and alternate path information can be obtained in the field of ″PathType″ running the /opt/IBMtape/tapelist command output and is similar to the

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 149

Page 168: IBM Tape Driver IUG 1

example in Figure 13.

The labeling of a logical device as either a primary or alternate path is forinformation 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 devicelabeled the primary path for each physical device. However, there can bemultiple logical devices labeled as an alternate path for the same devices.

2. Provide information about which logical devices configured on the system havepath failover enabled.

Querying Primary and Alternate Path ConfigurationYou can display the primary and alternate path configuration for all devices withthe tapelist utility.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “Solaris System - Tape UtilityProgram (tapeutil)” on page 397.

Disable and Enable Primary and Alternate PathsOnce you install the IBMtape device driver, by default, all the available paths for aphysical device are enabled.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “Solaris System - Tape UtilityProgram (tapeutil)” on page 397.

Data Path Failover and Load Balancing Support for Tape Drives

Note: The tape drive failover feature code must be installed prior to enabling theDPF for IBM Ultrium tape drive in the Solaris IBMtape device driver. Referto “Automatic Failover” on page 12 to determine which feature code isrequired for your machine type.

Configuring and Deconfiguring Path Failover SupportPath failover support for tape drives is not enabled automatically when the devicedriver is installed. It must be configured initially on each logical device afterinstallation. When path failover support is enabled for a logical device, it remains

#tapelist -1Inst# 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 Primary688 /dev/rmt/14smc 03584L32 0000000T0039 2/1 402j N/A N/A/devices/pci@If,2000/QLGC,qla@1/IBMtape@2,1 Alt_path_1694 /dev/rmt/26smc 03584L32 0000000T0039 5/1 402j N/A N/A/devices/pci@If,2000/QLGC,qla@1/IBMtape@5,1 Alt_path_2

Figure 13. Example of Control Path Failover Support Command Output

Solaris Device Driver (IBMtape)

150 IBM Tape Device Drivers Installation and User’s Guide

Page 169: IBM Tape Driver IUG 1

set until the device is deleted or the support is deconfigured. The path failoversetting is retained even if the system is rebooted. Path failover support can beenabled on all configured devices at one time, or it can be enabled or disabledselectively by logical device. It may be desirable at times to configure some, butnot all, logical paths to a device with the support enabled. Follow the above stepsto 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 asdpf_support=1;

2. Or, to enable a particular path, add the parameter dpf_support and turn it onin 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 theparameter 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 is16 characters long with a comma "," and a space " ". The IBMtape driversupports up to 36 dpf keys.

b. DPF keys do not need to be added in IBMtape.conf if you are running thelatest drive code on Ultrium-3 and Ultrium-4 drives.

4. Stop the TMD (tape monitor daemon) running on the system and unload theIBMtape driver module from the current kernel# /opt/IBMtape/tmd -s# /usr/sbin/rem_drv IBMtape

5. Reload the IBMtape driver module in the kernel and start the daemon:# /usr/sbin/add_drv -m ' 0666 bin bin' IBMtape# /opt/IBMtape/tmd

This deconfigures all devices to remove or comment out the parameterdpf_support in the IBMtape.conf file, and reboot the system or deconfigure andreconfigure all devices. For example,1. To disable the support globally on all currently configured devices, remove or

comment out the entry dpf_support=1 at the beginning of the IBMtape.conf file.# dpf_support=1; * comment out the parameter

2. Stop the TMD (tape monitor daemon) running on the system and unload theIBMtape 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 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 asdpf_support=1;

2. To disable a particular path, add the parameter dpf_support and turn it off inthe path entry in the IBMtape.conf file. For example,name="IBMtape" class="scsi" target=3 lun=0 dpf_support=0;

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 151

Page 170: IBM Tape Driver IUG 1

3. Stop the TMD (tape monitor daemon) running on the system and unload theIBMtape driver module from the current kernel:# /opt/IBMtape/tmd -s# /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

Primary and Alternate PathsWhen the device driver configures a logical device with path failover supportenabled, the first device configured always becomes the primary path. When asecond logical device is configured with path failover support enabled for the samephysical device, it configures as an alternate path. A third logical device isconfigured as the next alternate path, and so on. The device driver supports up to16 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, WWPN5005076302400127 from port 0 and 5005076302800127 from port 1), the/opt/IBMtape/tapelist command output is similar to the example in Figure 14.

The labeling of a logical device as either a primary or alternate path is forinformation 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 onelogical device labeled the primary path for each physical device. However,there may be many (multiple) logical devices labeled as an alternate path forthe same devices.

2. Provide information about which logical devices configured on the system havepath failover support enabled.

Querying Primary and Alternate Path ConfigurationYou can display the primary and alternate path configuration for all devices withthe tapelist utility.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “Solaris System - Tape UtilityProgram (tapeutil)” on page 397.

#tapelist -1Inst# 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 Primary697 /dev/rmt/5st 03592J1A 000001300168 7/0 04CE 5005076302000127 5005076302800127/devices/pci@1f,2000/QLGC,qla@1/IBMtape@7,0 Alt_path_1666 /dev/rmt/18st 03592J1A 000001300168 1/0 04CE 5005076302000127 5005076302800127/devices/pci@1f,4000/JNI,FCR@2/IBMtape@1,0 Alt_path_2670 /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

Solaris Device Driver (IBMtape)

152 IBM Tape Device Drivers Installation and User’s Guide

Page 171: IBM Tape Driver IUG 1

Disable and Enable Primary and Alternate PathsOnce you enter the parameter dpf_support in the IBMtape.conf file and install theIBMtape device driver, 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 dueto maintenance), run commands to disable and then later enable the primary andalternate paths.

Note: See Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or “SolarisSystem - Tape Utility Program (tapeutil)” on page 397

System-Managed Encryption

Device Driver ConfigurationSystem-Managed Encryption can be set on global or a specific tape drive inIBMtape.conf in /usr/kernel/drv. There are 2 new configuration parameters addedfor encryption:

sys_encryption_proxy “ON/OFF” Use System Encryption FCP Proxy Managersys_encryption_write “OFF/ON/CUSTOM” System Encryption for WriteCommands at BOP

The sys_encryption_proxy parameter enables device driver system-managedencryption 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 tapedrive to encryption enabled for write commands. When set to OFF, the tape driveuses encryption for read operations; write operations do not use encryption. Whenset to ON, the tape drive uses encryption for both read/write operations. When setto CUSTOM, the device driver does not modify current tape drive setting. Thecustom setting is intended for applications using system-managed encryption tocontrol 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 tapedrive 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

To enable SME for a particular target:name=″IBMtape″

class=″scsi″target=0lun=0block_size=0buffering=1immediate=0trailer=0sili=0sys_encryption_write=1;

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 153

Page 172: IBM Tape Driver IUG 1

To disable SME in a particular target:name=″IBMtape″

class=″scsi″target=0lun=0block_size=0buffering=1immediate=0trailer=0sili=0sys_encryption_proxy=0;

Querying Tape Drive ConfigurationThere is a tapeutil command available for encryption to query tape driveencryption settings.

The current tape drive encryption settings can be queried using the tapeutil menuwith the option “Get Drive Encryption Settings” or the command line “tapeutil –f/dev/rmt/device_special_file encryption”.

Note: See “Solaris System - Tape Utility Program (tapeutil)” on page 397 forinformation on the tapeutil application.

Following is an example of a correct tape drive configuration withsys_encryption_write set to “on”. If the sys_encryption_write parameter is set to“no”, then the tape drive “Encryption State” is Off.# tapeutil -f /dev/rmt/38stn encryption

GET_ENCRYPTION_STATE command succeeded.

Encryption settings:Encryption Capable ... YesEncryption Method .... SystemEncryption State........ ON

Testing Data Encryption Configuration and ConnectivityThere is a tapeutil command added to validate the ibmekm.conf file server entriesand test tape drive to server connectivity operations. This test can be run using thetapeutil menu in the option “EKM Test” or the command line “tapeutil–f/dev/rmt/device_special_file ekmtest”.

Note: See “Solaris System - Tape Utility Program (tapeutil)” on page 397 forinformation on the tapeutil application.

The first test checks the server configuration defined in the ibmekm.conf file andthen communication to the configured servers. This test reports back the number ofservers available. The second test runs a basic diagnostic that checks the tape driveto server communication and reports success or fail. The third test runs anenhanced diagnostic that checks a key operation between the tape drive and serverthen reports success or fail.

Following is an example of a successful test:

Solaris System-Managed Encryption

154 IBM Tape Device Drivers Installation and User’s Guide

Page 173: IBM Tape Driver IUG 1

# tapeutil –f /dev/rmt/38stn ekmtestTesting server configuration and connections...Test complete, servers available 2Running basic drive to server encryption test...Test complete, completion code 0Running full drive to server encryption test...Test complete, completion code 0

If the first server test fails with one of the following errors, then the remainingtests are not run. Perform the recommended problem determination to resolve theproblem:1. “Invalid argument or Operation not supported on device” - System encryption

is not configured for the tape drive in the device driver. Setsys_encryption_write to “ON” in IBMtape.conf for the tape drive. Ifsys_encryption_write can not be set then the tape drive is not encryptioncapable or encryption support disable.

2. “Can’t assign requested address” - Either the ibmekm.conf file is missing or isinvalid. Check and correct.

3. “Network is down” – All configured servers in the ibmekm.conf file are notavailable. Check all servers configured in the ibmekm.conf file are currentlyrunning on the server IP address and configured correctly.

4. “Permission denied” - If the full drive to server encryption test fails with apermission error , unload the tape and run the command again. If the problemis persistent, check if either the EKM server isn’t available recently or the driveisn’t claimed in EKM server.

Field Support InformationWhen encryption failures require field support and/or development analysis, run/opt/IBMtape/diags_info script to generate a file of diags.out. Tape drive dumpsand EKM server logs may be needed in addition to this information.

Problem DeterminationThe following sections describe the service and diagnostic aids that are part of theIBM SCSI Tape and Medium Changer Device Driver for Solaris package.Procedures for verifying correct installation of the device, basic problemdetermination guidelines, and outlines of the utility program included with theIBMtape package are included.

Note: See “Solaris System - Tape Utility Program (tapeutil)” on page 397 forinformation on the tapeutil application.

Functional VerificationIf you wish to verify that the installation of the IBM SCSI Tape and MediumChanger 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

Solaris System-Managed Encryption

Chapter 6. Solaris Tape and Medium Changer Device Driver 155

Page 174: IBM Tape Driver IUG 1

substituting for n the number associated with the device special file assigned tothe IBM tape system that you want to check. Listing the contents of the /dev/rmtdirectory (using the ls command) can be helpful in determining the properspecial file name. For medium changer devices, the special file name/dev/rmt/nsmc should be used.The following information should be displayed:IBM xxxxxxxx configured at /dev/rmt/nst.

Where: xxxxxxxx is the model number of the IBM tape system and n is thesame number specified in the verify command.

3. To verify that the IBMtape device driver is loaded in kernel memory, enter thefollowing command:/usr/sbin/modinfo | /usr/bin/grep IBMtape

The following information should be displayed: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 fieldsindicate the ID, load address, size, major number, and revision for the IBMtapedevice driver and vary from machine to machine

Installation ProblemsIf you are experiencing problems with installation of the IBM SCSI Tape andMedium Changer Device Driver for Solaris package, the following informationmay be of assistance. If you cannot solve the problems after checking thefollowing, 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 notdetect the presence of any supported IBM devices on the SCSI bus. Verify thatSCSI adapter device driver support is installed and configured correctly. Verifythat 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 berecognized by the IBMtape device driver.

v If you cannot open an IBM device, verify that you are using the correct specialfile. The IBM tape special files are of the form *st* in the /dev/rmt directory. TheIBM 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 sameIBM device by consulting the st.conf file in the /kernel/drv directory andcommenting 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 automaticallyretrieve and store the IBM tape drive diagnostic information (drive dump) into the/var/opt/IBMtape directory. The daemon is automatically started when the driveris installed, even no any tape device is attached on the system. An entry ″name=″IBMtape″ parent=″pseudo″ instance=16383; ″ is also entered into theconfiguration file of /usr/kernel/drv/IBMtape.conf automatically for the daemonduring the IBMtape driver installation.

Solaris Device Driver (IBMtape)

156 IBM Tape Device Drivers Installation and User’s Guide

Page 175: IBM Tape Driver IUG 1

The following options can be used to configure the tape monitor daemon runningit on the command line. Most options can also be specified in the /etc/tmd.confconfiguration file. However, the command line options override any configurationfile options.

The following options can be used to configure the tape monitor daemon runningit on the command line. Most options can also be specified in the /etc/tmd.confconfiguration file. However, the command line options override any configurationfile 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 dumpfile 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 drivedump is retrieved by tmd. For example,

Apr 9 14:54:21 Java tmd[3279]: Drive dump saved to /var/opt/IBMtapeIBMtape.000001300148.2004-04-09-14:54:14.dump.

Tracing FacilityIBMtape incorporates a tracing facility that is useful for performing problemdetermination. The tracing facility logs diagnostic information to /var/adm/messagesbased on the control variable IBM_trace. Refer to “Setting the IBM_trace Level forStatic Tracing” on page 159 for instructions on how to set the trace value.

IBM_trace values range from 0–13 and result in posted messages as shown inTable 29. Postings are cumulative, so trace level 3 also posts items for levels 2, 1,and 0. A trace value of 2 or 3 is suitable for most normal production environments,with little or no degradation of throughput. IBM_trace values of 4 and higherincreasingly degrade performance and should generally be used only whendirected by IBM support personnel.

Table 29. Tracing Facility

Trace Level Items Traced

0 Severe error conditions only. For installations with extremely small /var filesystems, this setting can prevent filling the file system unexpectedly.However, this may be at the cost of not recording messages related toserious device or system environment errors.

1 Device sense data. Sense data can help in diagnosing the source ofunexpected error conditions.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 157

Page 176: IBM Tape Driver IUG 1

Table 29. Tracing Facility (continued)

Trace Level Items Traced

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 generallyuseful only to IBMtape developers.

Note: IBMtape earlier than Version 4.0.2.7 had only IBM_trace values 0–4. Message contentand 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 systemerror messages, IBMtape tracing is handled as other kernel messages. Refer to thesyslog.conf man page and the comments in syslog.conf for information about thesystem logging operation. Changes made to syslog.conf take effect after the nextsystem restart.

The following shows trace level 2 output, with system date and time stampsremoved. Device instance 390 is opened on the first line. The device minor number12450 is decoded and shows that the SCSI medium changer (smc) special file wasopened.

The second line decodes selected fields from the sense data that follows it. Thedecoded information shows that sense data was generated during a Move Mediumcommand. Looking up the decoded Sense Key /ASC/ASCQ combination in the3590 hardware reference, we find that the command failed because the move fromlocation was empty. The actual sense data follows the decoded fields.

Note: Solaris, rather than printing multiple sixteen byte lines of hexidecimalzeroes, 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 2IBMtape(390) 0 20 1 40 a 9 1 0 0 0 0 0 0 0 a5 0IBMtape(390) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0last message repeated 1 timeIBMtape(390) 0 0 0 0 0 0 0 0 36 33 39 20 20 20 20 0IBMtape(390) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0IBMtape(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) devicespecial file was opened. The sense data for device instance 292 was generatedduring a space operation. The Sense Key/ASC/ASCQ shows that a filemark wasencountered during the space.IBMtape(292) _open: 554 Inst 292, Minor 9412 (drv), Flags 0x5,

TL 2/0/0, 4.0.2.8IBMtape(292) check_sense: cmd 0x11(space), key/asc/ascq 0x0/0/1,

defer 0, retry 0, rc 5IBMtape(292) 03570B02 SENSE DATA:IBMtape(292) f0 0 80 0 0 0 1 48 0 0 0 0 0 1 ff aIBMtape(292) c4 b1 0 20 0 5 1 91 0 34 0 0 0 0 11 0IBMtape(292) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 6IBMtape(292) 6f 28 0 ad 73 32 0 0 0 0 0 0 0 0 0 0IBMtape(292) 0 0 0 0 0 0 20 0 31 42 41 20 20 20 20 0IBMtape(292) _close: Inst 292, Minor 9412 (drv), Flags 0x5, exit(0)

Solaris Device Driver (IBMtape)

158 IBM Tape Device Drivers Installation and User’s Guide

Page 177: IBM Tape Driver IUG 1

Finally, the sense data for device instance 230, a tape drive, occurred during a testunit 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.8IBMtape(230) check_sense: cmd 0x0(test_unit_ready),

key/asc/ascq 0x2/3a/0, defer 0, retry 0, rc 5IBMtape(230) 03570B02 SENSE DATA:IBMtape(230) 70 0 2 0 0 0 0 48 0 0 0 0 3a 0 ff 2IBMtape(230) c4 8 0 30 0 6 1 40 0 0 0 0 0 0 0 0IBMtape(230) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0last message repeated 1 timeIBMtape(230) 0 0 0 0 0 0 0 0 31 42 41 20 20 20 20 0IBMtape(230) _close: Inst 230, Minor 7366 (drv), Flags 0x5, exit(0)

You can match an instance number with its corresponding device special file intwo 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 theprevious 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:stlrwxrwxrwx 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 thedevice special files that are associated with device instance 292.

Dynamic Tracing UtilityA dynamic tracing utility named tapedtrc is introduced in the IBMtape.4.1.6.0 orlater driver to dynamically set, reset, start, stop and query IBMtape tracing at anytime for debugging use. The program is located in the /opt/IBMtape directory, withthe 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 TracingThe user can still enable or disable static IBMtape tracing and set the IBM tracelevel in /etc/system or by running the adb system command. The host is required toreboot to enable or disable the tracing when the trace level is set in /etc/system. TheIBMtape driver must be loaded in the kernel. If the tracing is enabled or disabledusing the adb command, the tracing starts or stops at the next device open.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 159

Page 178: IBM Tape Driver IUG 1

The default value for IBM_trace is zero (0). You can define another IBM_tracevalue by placing an entry in /etc/system, so that IBM_trace is set at each restart. Forexample, 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 thismethod, 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 poundsigns (#) or exclamation and pound sign pairs (!#). Text lines without a prefix areadb session responses to commands.## Start adb session and set session prompt.ksh> adb -P "adb> " -k -w /dev/ksyms /dev/memphysmem 7c5e!#!# Set default for input values to base 10.adb> a$dradix=10 base ten!#!# Display current IBM_tape value as unsigned decimal integer.adb> IBM_trace/uIBM_trace:IBM_trace: 0!#!# Set new IBM_trace value.!# adb will confirm the old and new values.adb> IBM_trace/w 2IBM_trace: 0 = 2!#!# Quit session.adb> $q## Back to the shell.ksh>

Running Diags_info ScriptRun the diags_info script located in the /opt/IBMtape directory. This script detectsthe problems on the configuration files, gathers important system HBAs andconfiguration information. The script should be run as root. If not run as root, theinformation should be labeled as such, but the value of the information isdegraded when run as a non-root user.

To facilitate capture of data, the script places information in a file called diags.outin the directory locating the script. Send the output file to the location identified byyour IBM service representative.

iostat CommandIBMtape driver supports the iostat system command, which reports I/O statisticsfor the supported tape drives in IBMtape.4.1.2.7 and later versions. Refer to man(1M) iostat for the command usage.

Solaris Device Driver (IBMtape)

160 IBM Tape Device Drivers Installation and User’s Guide

Page 179: IBM Tape Driver IUG 1

Reservation Conflict LoggingWhen the device driver receives a reservation conflict during open or after thedevice 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 aPersistent Reserve In command to determine if a SCSI Persistent Reservation isactive on the reserving host to get the reserving host initiator WWPN (World WidePort Name) and reserve key. If successful, the device driver will log thisinformation in the detail data below. After initially logging the reserving hostWWPN, subsequent reservation conflicts from the same reserving host WWPN andreservation key will not be logged to prevent multiple entries in the system loguntil either the reserving host WWPN or reservation key is different than the oneinitially logged or the device driver has reserved the device and then anotherreservation conflict occurs.

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 reservationinformation isn’t available.log_reserve: Reservation Conflict: No reserving host information is available.

Solaris Device Driver (IBMtape)

Chapter 6. Solaris Tape and Medium Changer Device Driver 161

Page 180: IBM Tape Driver IUG 1

Solaris Device Driver (IBMtape)

162 IBM Tape Device Drivers Installation and User’s Guide

Page 181: IBM Tape Driver IUG 1

Chapter 7. Windows Tape and Medium Changer Device Driver

Purpose . . . . . . . . . . . . . . . 163Data Flow . . . . . . . . . . . . . . 163Product Requirements . . . . . . . . . . 164

Hardware Requirements. . . . . . . . . 164Software Requirements . . . . . . . . . 165

Installation and Configuration Instructions . . . 165Windows NT Instructions . . . . . . . . 165Windows 2000, Windows Server 2003, andWindows Server 2008 Instructions . . . . . 177

Persistent Naming Support on Windows Server2003 and Windows Server 2008 . . . . . . . 181Control Path Failover Support for Tape Libraries 182

Configuring and Unconfiguring Control PathFailover Support . . . . . . . . . . . 182Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 182Checking Disablement of Control Path FailoverSetting. . . . . . . . . . . . . . . 182

Data Path Failover Support for Tape Drives . . . 183Configuring and Unconfiguring Data PathFailover Support . . . . . . . . . . . 183Querying Primary and Alternate PathConfiguration . . . . . . . . . . . . 183Checking Disablement of Data Path FailoverSetting. . . . . . . . . . . . . . . 183

System-Managed Encryption . . . . . . . . 184Device Driver Configuration . . . . . . . 184Configuration File . . . . . . . . . . . 184Querying Tape Drive Configuration Settings . . 185

Problem Determination . . . . . . . . . . 185Windows NT Instructions . . . . . . . . 185Windows 2000/Windows Server 2003Instructions . . . . . . . . . . . . . 186Reservation Conflict Logging . . . . . . . 188

This chapter describes the hardware requirements, software requirements, andinstallation notes for the Microsoft Windows device drivers for IBM TotalStorageand System Storage tape devices.

PurposeThe Windows tape and medium changer device driver is designed specifically totake advantage of the features provided by the IBM tape drives and mediumchanger devices. The goal is to give applications access to the functions requiredfor basic tape operations (such as backup and restore) and medium changeroperations (such as mount and demount the cartridges), as well as to the advancedfunctions needed by full tape management systems. Whenever possible, the driveris designed to take advantage of the device features transparent to the application

Data FlowThe software described in this chapter covers the Windows device driver and theinterface between the application and the tape device.

Figure 15 illustrates a typical data flow process.

ApplicationProgram

Windows Tapeand Medium

Changer DeviceDriver

Host BusAdapterDriver

TapeDevice

a2500268

Figure 15. Data Flow for Windows Device Driver (IBMmag)

© Copyright IBM Corp. 2007, 2009 163

Page 182: IBM Tape Driver IUG 1

Product RequirementsThe most current information on supported hardware and software configurationsfor the Windows tape and medium changer device driver can be found in theREADME files on the IBM Device Drivers FTP site, which is located atftp://ftp.software.ibm.com/storage/devdrvr/Windows.

Hardware RequirementsOne of more of the following processors is required by the IBMtape device driver:v For the Windows NT® operating system, Intel compatible processors with a

minimum processor level of Intel 486DX or Pentium®.v For the Windows 2000, 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 LVDv Adaptec SCSI Adapter 39160 - Dual Port LVDv 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 Corporationv 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 Adaptersv 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 19K1246v IBM xSeries and Netfinity FAStT Host Adapter P/N 24P0960v DS4000® FC 4Gbps PCI-X Single Port HBA P/N 39M5894v DS4000 FC 4Gbps PCI-X Dual Port HBA P/N 39M5895v QLogic 4Gb FC Single-Port PCIe HBA P/N 39R6525v QLogic 4Gb FC Dual-Port PCIe HBA P/N 39R6527v Qlogic QLA2310v Qlogic QLA2340v Qlogic QLA2342v Qlogic QLA2460v Qlogic QLA2462v Qlogic QLE2460 (not supported for Windows 2008 SPI for IA64 servers)

Windows Device Driver

164 IBM Tape Device Drivers Installation and User’s Guide

Page 183: IBM Tape Driver IUG 1

v Qlogic QLE2462 (not supported for Windows 2008 SPI for IA64 servers)

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 Adaptersv Emulex LPe11000/2 4Gb PCI-E FC HBA, LP1150, LP8000 and LP9002L,

LP402DC, LP952L, LP9802, LP9802DC, LP10000, LP11000, LP11002 Fibre ChannelAdapters

v IBM Netfinity P/N 00N6881, 19K1246, 24P0960, 39M5894, 39M5895

Attention: Using a single Fibre Channel host bus adapter (HBA) for concurrenttape and disk operations is not recommended. Tape and disk devices requireincompatible HBA settings for reliable operation and optimal performancecharacteristics. Under stress conditions (high I/O rates for tape, disk, or both)where disk and tape subsystems share a common HBA, stability problems havebeen observed. These issues are resolved by separating disk and tape I/O streamsonto separate HBAs and using SAN zoning to minimize contention. IBM is focusedon assuring server and storage configuration interoperability. It stronglyrecommends that your implementation plan includes provisions for separating diskand tape workloads.

Software RequirementsThe software requirements are supported:v SCSi or FC adapter device driverv Microsoft Windows NT Version 4.0 with Service Pack 6 or laterv Microsoft Windows 2000 Build 2195 or later, orv Microsoft Windows Server 2003 Build 3790 or laterv Microsoft Windows Server 2008 SP1 Build 6001 or later

Installation and Configuration InstructionsThis section includes instructions for installing and configuring the Windows tapeand medium changer device driver on Windows NT and Windows 2000/WindowsServer 2003/Windows Server 2008.

Windows NT InstructionsThis section describes how to install, remove, start, and stop the Windows tapeand medium changer device driver on Windows NT.

Installation OverviewThe installation process consists of the following steps:1. Verify that the prerequisites have been satisfied.2. Install the SCSI or FC adapter.3. Install the SCSI or FC adapter device driver.4. Connect the TotalStorage/Magstar or Ultrium device to the adapter.5. Power On the TotalStorage/Magstar or Ultrium device.6. Reboot the system.7. Create an emergency repair disk (optional) using the following procedure:

a. Select Start, Help, and Find from the Windows NT desktop.b. Type Emergency in box 1.

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 165

Page 184: IBM Tape Driver IUG 1

c. Select Using the Repair Disk utility to make an emergency repair disk.d. Click Display, then follow the instructions to make an emergency repair

disk (ERD).

Note: Refer to “Software Requirements” on page 165.This step is highly recommended.

8. Install the TotalStorage/Magstar or Ultrium tape device driver.

Installation ProcedureTo install the device drivers, follow this procedure:1. Log on as Administrator.2. Download the appropriate driver from the IBM Device Drivers FTP site,

which is located at ftp://ftp.software.ibm.com/storage/devdrvr/Windows/WinNT.v For TotalStorage or Magstar tape devices, select IBMMag.WinNT.exe

v For Ultrium tape devices, select IBMUltrium.WinNT.exe

3. Go to the directory in which you saved the .exe file and double click it.4. Follow the InstallShield directions to install the package.

a. If you select compact installation, the program copies the system files ofthe latest IBM TotalStorage/Magstar or Ultrium Device Driver (DeviceDriver System Files component) to the system directories. This providesthe latest support necessary for TotalStorage or Magstar devices.

Note: This option overwrites previous versions of theTotalStorage/Magstar or Ultrium device driver installed on yoursystem.

b. If you select typical installation, all support included in the compactinstallation is done. Also, the Device Driver Depot component is installed,which includes copying all available versions included in the InstallShieldpackage to a user defined directory.

Note: This option overwrites any previous versions of theTotalStorage/Magstar or Ultrium device driver installed on yoursystem.

c. If you select custom installation, the program allows you to select thecomponents to install. Refer toFigure 16 on page 167.

Windows Device Driver

166 IBM Tape Device Drivers Installation and User’s Guide

Page 185: IBM Tape Driver IUG 1

The Device Driver Depot component includes the most recent versions ofthe device drivers. If you install this component, you are able to selectwhich versions of the device drivers to install.The Documentation component copies the PDF version of the Installationand User’s Guide and the Programming Reference to your hard drive.The Device Driver System Files component copies all the files needed fordevice driver support to the system directory.

5. After you have completed installing the device driver, enable the driver. ClickStart, move to Settings, then click Control Panel. Refer to Figure 17 on page168.

Figure 16. Select Components Menu (using IBMUltrium.WinNT.exe)

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 167

Page 186: IBM Tape Driver IUG 1

6. Double-click Tape Devices. If the TotalStorage/Magstar or Ultrium tape orchanger device was already powered On and attached to the system duringboot up, the devices should appear in the box, and Windows NT should startto generate the driver list. Refer to Figure 18.

If Microsoft Windows NT did not detect the attached TotalStorage or Magstardevice, click Detect to select the device, and Microsoft Windows NT rescansthe bus. Refer to Figure 19.

Figure 17. Start Menu

Figure 18. Creating Driver List

Figure 19. Rescanning for Tape Device

Windows Device Driver

168 IBM Tape Device Drivers Installation and User’s Guide

Page 187: IBM Tape Driver IUG 1

If you still cannot see the device, ensure that the cable is attached properly.Also, ensure that the device is terminated properly, the device is powered On,and the adapter driver is enabled.If you have more than one IBM TotalStorage/Magstar or Ultrium deviceattached on the same host system, the operating system prompts multipletimes for the same driver. Cancel the multiple driver installation requests.

Click Drivers, then click Add.... Refer to Figure 21 on page 170.

Figure 20. Install Driver Menu - Select Cancel.

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 169

Page 188: IBM Tape Driver IUG 1

7. If you installed the Device Driver System Files component in step 4 on page166, skip to step 8 on page 171. If you did not install Device Driver SystemFiles component, click Have Disk, then enter the directory where your devicedriver setup file (IBMUltrium.inf or IBMMagstar.inf) is located in the boxlabeled Copy manufacturer’s files from:. You can also Browse... to select thedirectory. Refer to Figure 22 on page 171.

Figure 21. Tape Devices Menu

Windows Device Driver

170 IBM Tape Device Drivers Installation and User’s Guide

Page 189: IBM Tape Driver IUG 1

8. Click IBM Corporation, select the device driver that matches your device,then click OK. Refer to Figure 23 on page 172.

Note: If you are using both a tape drive and a medium changer (as youwould find in a tape library, for example), select one of the IBM TapeLibraries. This installs drivers for both the medium changer and thetape drives.

Figure 22. Have Disk Menu

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 171

Page 190: IBM Tape Driver IUG 1

9. If you installed the Device Driver System Files component in step 4 on page166, Windows NT might ask the question shown in Figure 24. Click Yes, thenskip to step 11. If your system prompts you for ibmtape.sys or Magstar.sys,browse to select the drivers directory (c:\winnt\system32\drivers). The systemmay also prompt you for ntutil.exe. Browse to the system32 directory(c:\winnt\system32).

Note: See “Microsoft Windows System - Utility Program (ntutil)” on page 406for information on the ntutil application.

10. If you did not install the Device Driver System Files component in step 4 onpage 166, click No to the question in step 9. The operating system promptsyou for the location of the driver files.

11. Reboot the operating system to start the drivers.

Removal ProcedureThe Windows NT tape and medium changer device drivers manage allTotalStorage/Magstar or Ultrium devices and changers exclusively. If you useapplications that have their own device drivers that access TotalStorage/Magstar,

Figure 23. Install Driver Menu

Figure 24. Windows NT Statement

Windows Device Driver

172 IBM Tape Device Drivers Installation and User’s Guide

Page 191: IBM Tape Driver IUG 1

or Ultrium devices and changers, you must remove the Windows NT tape andmedium changer device drivers before installing and configuring those otherapplications.1. Log on as Administrator.2. Click Start, move to Settings, then click Control Panel.3. Double-click Tape Devices.4. Click the Drivers tab.5. Highlight the IBM tape device, then click Remove. When you see the message

Are you sure you want to remove this driver?, click Yes. Refer to Figure 25.

6. Click Add/Remove Programs in the Control Panel window. Refer to Figure 26on page 174.

Figure 25. Tape Devices and Remove Driver Menu

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 173

Page 192: IBM Tape Driver IUG 1

7. Highlight the IBM tape device driver, then click Add/Remove.... Refer toFigure 27 on page 175.

Figure 26. Control Panel Selection

Windows Device Driver

174 IBM Tape Device Drivers Installation and User’s Guide

Page 193: IBM Tape Driver IUG 1

8. Select the Remove option, then follow the InstallShield Wizard to uninstall thedrivers.

Figure 27. Add/Remove Programs Properties

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 175

Page 194: IBM Tape Driver IUG 1

Note: Uninstalling the drivers removes all TotalStorage/Magstar or Ultriumdevice driver files, registry settings, and other components, such as theInstallation and User’s Guide and Device Driver Depot.

9. Click Next >.10. Shut down and reboot the system.

Manual Starting and Stopping ProceduresThe TotalStorage/Magstar or Ultrium device and medium changer drivers supportbeing stopped and started without a reboot. If the TotalStorage/Magstar orUltrium device and medium changer drivers are used in conjunction with otherdrivers that support being stopped and started without a reboot, you are able toswitch between device drivers without rebooting the system.

To control manually when the TotalStorage/Magstar or Ultrium device driversstart or stop, set the startup mode to Manual, then start the device drivermanually when required.

To set the startup mode to Manual:1. Log on as Administrator.2. Click Start, move to Settings, then click Control Panel.3. Double-click Device.4. Scroll down to find the IBM tape device and medium changer drivers.5. Select the driver, click Startup..., select Manual, then click OK. Refer to

Figure 29 on page 177.

Figure 28. Drive Removal Menu.

Windows Device Driver

176 IBM Tape Device Drivers Installation and User’s Guide

Page 195: IBM Tape Driver IUG 1

6. If required for other drivers, repeat steps 4 on page 176 and 5 on page 176 ofthis procedure for each driver.

To start a driver manually:1. Ensure that the other drivers that may conflict are not started.2. Perform steps 1 through 4 of the procedure outlined above.3. Select the driver, then click Start.4. Repeat for the other driver, if necessary.

To stop a driver manually:1. Perform steps 1 through 4 of the procedure outlined above.2. Select the driver, then click Stop.

Windows 2000, Windows Server 2003, and Windows Server2008 Instructions

This section describes how to install, remove, and uninstall the Windows tape andmedium changer device drivers on Windows 2000, Windows Server 2003, andWindows Server 2008.

Note: The last driver level to include support for Windows 2000 is V6.1.4.8.Subsequent levels include support for Windows Server 2003. WindowsServer 2008 is supported beginning at V6.1.9.5.

Figure 29. Manual Starting and Stopping Menu

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 177

Page 196: IBM Tape Driver IUG 1

Installation OverviewThe 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.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 SCSIbus as the changer.

Installation ProceduresThese 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 driverby referring to the uninstall procedures in this documentation.

v The host bus adapter is installed, configured properly, and is running supportedmicrocode and driver levels.

v Drivers are identified by the following conventions, where: nnnn refers to aversion of the driver. If there is more than one version, use the latest.– Windows 2000 and Windows Server 2003, 32-bit

IBMTape.x86_nnnn.zip

– Windows Server 2008, 32-bitIBMTape.x86_w08_nnnn.zip

– Windows Server 2003 for Itanium (IA64) 64-bit architectureIBMTape.i64_nnnn.zip

– Windows Server 2008 for Itanium (IA64) 64-bit architectureIBMTape.i64_w08_nnnn.zip

– Windows Server 2003 for extended 64-bit architectures (Intel EM64T andAMD64)IBMTape.x64_nnnn.zip

– Windows Server 2008 for extended 64-bit architectures (Intel EM64T andAMD64)IBMTape.x64_w08_nnnn.zip

To install the device drivers, follow this procedure:1. Log on as Administrator.2. Download the appropriate driver from a subdirectory of:

ftp://ftp.software.ibm.com/storage/devdrvr/Windows

Drivers for Windows 2000 are in the Win2000 subdirectory. Drivers forWindows Server 2003 are in the Win2003 subdirectory. Drivers for Windows

Windows Device Driver

178 IBM Tape Device Drivers Installation and User’s Guide

Page 197: IBM Tape Driver IUG 1

Server 2008 are in the Win2008 subdirectory. When you download the files,ensure that you use FTP ″binary″ mode.

3. Unzip the driver package to a hard drive directory of your choice, other thanthe root directory.

4. Ensure that the tape and medium changer devices are connected to your hostbus adapter and configured properly by locating the devices in DeviceManager.

5. For driver packages prior to v6.1.8.9, double-click install.exe in the driverpackage.For all subsequent levels, double-click either install_exclusive.exe orinstall_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 fromexisting at the same time, as is required by applications such as TivoliStorage Manager.

v With install_nonexclusive.exe, the driver permits open handles from thehost to a drive to exist at the same time, as is required by applications suchas Microsoft Removable Storage Manager (RSM).

The necessary .sys files for correct driver operation are installed, and all IBMdevices are associated with the driver. Refer to Figure 30.

Notes:

a. There are additional installation features available through the commandline 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)

a2500267

Figure 30. Installation Application in Windows Explorer

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 179

Page 198: IBM Tape Driver IUG 1

v Disabling the Microsoft RSM service (-r), available in driver packagesv6.1.8.6 and later

v Disabling DPF from installation (-f), available in driver packages v6.2.0.1and later

To install the device drivers using any of these features, instead of doubleclicking the install executable file, open a command-line window and cd tothe driver package directory. For the usage information, typeinstall_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 MicrosoftWindows Hardware Quality Laboratories (WHQL), a warning screen opens.Refer to Figure 31. If you want to continue installing the driver, select ContinueAnyway.

Note: All drivers released by IBM have been through a complete test to ensurethat they are stable and conform to specified requirements.

7. If you are installing a Windows Server 2008 driver that has not been certifiedby the Microsoft Windows Hardware Quality Laboratories (WHQL), it likelyhas a Verisign digital signature. During installation, you may be presented witha prompt to install the software. Mark the ″Always trust software from IBMCorporation″ check box and click Install. You should only see this screen thefirst time that you install the drivers, provided you click the Always trustsoftware box.

8. To verify that the tape and medium changer devices and drivers are installedcorrectly, follow the instructions in Appendix B, “Verifying Proper Attachmentof Your Devices,” on page 343.

a250215

Figure 31. Windows Logo Testing screen

Windows Device Driver

180 IBM Tape Device Drivers Installation and User’s Guide

Page 199: IBM Tape Driver IUG 1

Device Removal or Disable ProcedureIf 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 mayselect 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 doesnot uninstall the device driver files from your hard disk.

Uninstalling the Device DriversTo uninstall the device drivers from the system, which includes deleting the systemfiles 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 createdduring the installation of the device driver. It does not delete the .zip fileor the files that were extracted from the .zip file. If you desire to removethese files, you need to delete them manually.

3. Reboot the system.

Persistent Naming Support on Windows Server 2003 and WindowsServer 2008

The Windows tape driver has an option for enabling device object names thatpersist across reboots of the operating system. For example, if your tape drive hasthe name \.\tape4801101 and the persistent naming option is used, then\\.\tape4801101 is reserved for use by that device after an operating systemreboot.

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 toassociate the World-Wide Node Name from Inquiry p. 0x83 with the persistentname 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 theWorld-Wide Node Name.

v If the PersistentNaming option is not specified in the registry, then there isno guarantee that your devices can claim the same device name after rebootor driver initialization.

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 181

Page 200: IBM Tape Driver IUG 1

You can find registry subkeys with persistent naming information atHKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtpbs2kx

Alternately, you can use the Windows Device Manager to examine the devicenumber in order to determine that persistent naming is enabled on your host.Persistent names contain tape device numbers based at 4801101 (which is thedecimal equivalent of hexadecimal 0x49424D and ASCII "IBM").

If two physical paths exist to a drive and different Windows device names arerequired (which happens, for example, when two different HBAs are connected tothe drive and Data Path Failover is disabled) the first path discovered claims thepersistent device name, and any subsequent paths that connect to the same devicereceive names according to the order in which they are discovered by the WindowsDevice Manager.

Control Path Failover Support for Tape LibrariesTo take advantage of Windows Control Path Failover (CPF) support, theappropriate feature code must be installed. Refer to “Automatic Failover” on page12 for what feature code may be required for your machine type.

Configuring and Unconfiguring Control Path Failover SupportControl Path Failover support is enabled automatically when the device driver isinstalled. It may be disabled or reenabled for the entire set of attached mediumchangers 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.

Querying Primary and Alternate Path ConfigurationTo check if the control path failover has been enabled in the device driver anddisplay the primary and alternate paths, you may use the tape diagnostic andutility tool.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “Microsoft Windows System -Utility Program (ntutil)” on page 406.

Checking Disablement of Control Path Failover SettingIf you have disabled the control path failover in device driver’s setting by doubleclicking the DisableCPF.reg file and reboot your system, you may go into theregistry by issuing the Windows regedit command to confirm that CPF has beendisabled. Look for a line like the following if your system is Windows Server 2003or 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 takeseffect after your system is rebooted.

Windows Device Driver

182 IBM Tape Device Drivers Installation and User’s Guide

Page 201: IBM Tape Driver IUG 1

Data Path Failover Support for Tape DrivesTo take advantage of Windows Data Path Failover (DPF) support, the appropriatefeature code must be installed. Refer to “Automatic Failover” on page 12 for whatfeature code may be required for your machine type.

Configuring and Unconfiguring Data Path Failover SupportData Path Failover support is enabled automatically when the device driver isinstalled. It may be disabled or reenabled for the entire set of attached drives ormedium 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 keyon 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 letterwhere 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 texton 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 DPFlicense key, the DPF feature is enabled and any eligible devices have multi-pathsupport.

Note: For LTO generation 3 running the latest drive microcode, there is no longera requirement to provide a DPF license key in IBM_DPF.txt. The microcodenow handles the enablement of the DPF feature.

Querying Primary and Alternate Path ConfigurationTo check if the data path failover has been enabled in the device driver anddisplay the primary and alternate paths you may use the tape diagnostic andutility tool.

Note: Display the primary and alternate path configuration for any device usingtape diagnostic and utility functions, refer to Chapter 10, “IBM TapeDiagnostic Tool (ITDT),” on page 259 or “Microsoft Windows System -Utility Program (ntutil)” on page 406.

Checking Disablement of Data Path Failover SettingIf you have disabled the data path failover in device driver’s setting by doubleclicking the DisableDPF.reg file and reboot your system, you may go into theregistry by issuing the Windows regedit command to confirm that DPF has beendisabled. Look for a line like the following if your system is Windows Server 2003or 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 takeseffect after your system is rebooted.

Windows Device Driver

Chapter 7. Windows Tape and Medium Changer Device Driver 183

Page 202: IBM Tape Driver IUG 1

System-Managed Encryption

Device Driver ConfigurationSystem-managed encryption parameters on Windows are placed in the registryunder the key for the device driver. The parameters are populated in user-createdsubkey containing the serial number of the device. The registry keys(sys_encryption_proxy and sys_encryption_write) are used to determine SMEenablement and invocation of the EKM proxy on write, respectively.

Note: Leading zeros in the serial number should be excluded. For example, if theserial number of the encryption-capable tape drive were 0123456789, theuser 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_proxyand/or sys_encryption_write, and assign them values corresponding with thedesired 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 thedevice driver key, found at:HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\ibmtp2k3

When this option is chosen, the settings established for all drives are overridden bythe serial-number specific settings described the previous paragraph.

If no options are specified in the registry, the driver uses the default values for theparameters.v The default value for sys_encryption_proxy is 1.

This value causes the device driver to handle encryption key requests, if thedrive is set up for system-managed encryption. This value should not need to bechanged. A value of 0 causes the device driver to ignore encryption key requestsfor 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-BOPsettings alone. It does not turn on or turn off encryption writing, but insteaduses the settings that are already in the drive. If encryption has not been set uppreviously, then the drive writes unencrypted data. A value of 0 causes thedevice driver to write unencrypted data. A value of 1 causes the device driver towrite 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.

Configuration FileThe file %system_root%:\IBMEKM.conf is used to store the IP address of the EKMserver and other network-related parameters. The phrase %system_root% refers tothe drive letter where the Windows installation is located, typically C (for exampleC:\IBMEKM.conf).

The format for the EKM server parameters is:

Windows System-Managed Encryption

184 IBM Tape Device Drivers Installation and User’s Guide

Page 203: IBM Tape Driver IUG 1

Server<tab>Timout<tab>IPAddress:Port

For example, if the Windows installation is installed at c:\, the ekm server isnamed ekmtest, the desired timeout is 10 seconds, and the IP address is 127.0.0.1 atport 4242. Then create a line in c:\IBMEKM.conf as follows:

ekmtest<tab>10<tab>127.0.0.1:4242

Querying Tape Drive Configuration SettingsThere is an ntutil command to query the encryption settings of a tape drive. Thentutil command is menu option 59, “get encryption state”.

Note: See “Microsoft Windows System - Utility Program (ntutil)” on page 406 forinformation on the ntutil application.

The following is an example of the output when the drive is configured forsystem-managed encryption, with encryption turned on:Encryption capable: TrueEncryption method: System Managed (2)Encryption state: On (1)

Problem DeterminationThere is a debug version of the device driver that can be used if you encounterproblems. The debug version of the driver issues DbgPrint messages at variousplaces during device driver execution. To capture these messages, you must start adebugger or use a tool like Debug View, available from:http://www.sysinternals.com

Windows NT Instructions

Using the Debug VersionTo install and use the debug version of the device driver, perform the followingsteps after the driver has initially been installed:1. Quiesce all activity on the tape and medium changer devices.2. Exit all applications that are using the tape and medium changer devices.3. Stop the device drive (MagStar.sys or IBMtape.sys). Refer to “Manual Starting

and Stopping Procedures” on page 176 for details on stopping the driver.4. Locate the ...\checked directory for the device driver level that you are

running. If you chose the default installation location when you installed thedrivers, the debug drivers are found at:v c:\Program files\IBM Corporation\IBM Magstar Device Drivers\n.n.n.n\checked

for TotalStorage or Magstar devices,v c:\Program files\IBM Corporation\IBM Ultrium Device Drivers\n.n.n.n\checked

for Ultrium devices,

Where: n.n.n.n are integers that indicate the driver level.To determine the driver level, find c:\winnt\system32\drivers\(ibmtape.sys ormagstar.sys) using Windows Explorer, right-click the file, select Properties, thenselect the Version tab. If you do not find a ...\checked directory for your driver,you must install the Device Driver Depot component of the Windows DeviceDriver Installation Package.

5. Go to the root prompt, for example, c:.

Windows System-Managed Encryption

Chapter 7. Windows Tape and Medium Changer Device Driver 185

Page 204: IBM Tape Driver IUG 1

6. Change to the appropriate directory by typing cd \winnt\system\drivers.7. Copy magstar.sys magstar.orig or IBMtape.sys ibmtape.orig.8. Copy magstar.sys or IBMtape.sys from the appropriate ... \checked directory to

c:\winnt\system32\drivers\(magstar.sys or ibmtape.sys). For example, if youinstalled the Ultrium device drivers at the default installation location andyour driver level was 1.1.6.9, you would issue the following command: copyc:\Program files\IBM Corporation\IBM Ultrium Device Drivers\1.1.6.9\checked\IBMtape.sys c:\winnt\system32\drivers\ibmtape.sys.

9. Start the debugger or tool that captures the DbgPrint messages.10. Start the Windows device driver. Refer to “Manual Starting and Stopping

Procedures” on page 176 for details on starting the driver.

Registry variable HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet/Services/(Magstar or Ultrium)/MsgLevel determines how many messages are issued by thedebug version of the driver. When the debug version of the driver is started forthe first time, it defines the registry variable. The variable is ignored by thenon-debug version of the driver.

Using regedt32, you can set the value of this variable, to any value fromREG_DWORD 0x0 to REG_DWORD 0x5, inclusive. The greater the value, the moremessages are issued.

Restoring the Non-Debug VersionTo restore the non-debug version of the driver, perform the following steps:1. Quiesce all activity on the tape and medium changer devices.2. Exit all applications that are using the tape and medium changer devices.3. Stop the device driver (Magstar.sys or IBMtape.sys). Refer to “Manual Starting

and Stopping Procedures” on page 176 for details on stopping the driver.4. Go to the root prompt, for example, c:.5. Change to the appropriate directory by entering cd \winnt\system\drivers.6. Copy magstar.orig magstar.sys or ibmtape.orig IBMtape.sys.7. Start the device driver. Refer to “Manual Starting and Stopping Procedures” on

page 176 for details on starting the driver.

Windows 2000/Windows Server 2003 Instructions

Using the Debug VersionTo install and use the debug version of the device driver, perform the followingsteps 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 containschecked 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,

andv yyy = 2k for Windows 2000, or 2k3 for Windows Server 2003, or 2k8 for

Windows Server 2008. Refer to Figure 32 on page 187.

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 System-Managed Encryption

186 IBM Tape Device Drivers Installation and User’s Guide

Page 205: IBM Tape Driver IUG 1

Windows Server 2008 only, and therefore only contain 2k3 and 2k8files.

4. Copy the checked version of ibmtpxxyyy.sys or ibmcgxxyyy.sys to\winnt\system32\drivers, overwriting the version of the file already there.

5. Reboot the system.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 Instructions1. Quiesce all activity on the tape and medium changer.2. Exit all applications that are using the tape and medium changer devices.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 thedriver package overwriting the files in there (a previous backup of this files orhaving 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 VersionTo restore the non-debug version of the driver, perform the following steps:1. Quiesce all activity on the tape and medium changer devices.2. Exit all applications that are using the tape and medium changer devices.

dd000002

Figure 32. Checked folder

Windows System-Managed Encryption

Chapter 7. Windows Tape and Medium Changer Device Driver 187

Page 206: IBM Tape Driver IUG 1

3. Located in the highest level directory of the driver package, are non-debugversions of the tape and medium changer device drivers, ibmtpxxyyy.sys andibmcgxxyyy.sys, where:v xx = ft for the filter driver, bs for the bus driver, or blank for the base driver,

andv yyy = 2k for Windows 2000, or 2k3 for Windows Server 2003, or 2k8 for

Windows Server 2008. Refer to Figure 32 on page 187.

Note: The last driver level to include support for Windows 2000 is V6.1.4.8.Subsequent levels include support for Windows Server 2003 andWindows 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 thenInstall the non-debug version of the driver.

Reservation Conflict LoggingWhen the device driver receives a reservation conflict during open or after thedevice 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 Incommand to determine if a SCSI Persistent Reservation is active on the reservinghost to get the reserving host initiator WWPN (World Wide Port Name). Ifsuccessful, 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 hostinitiator WWPN.

After initially logging the reserving host WWPN, subsequent reservation conflictsfrom the same reserving host WWPN will not be logged to prevent multipleentries in the error log until either the reserving host WWPN is different than theone initially logged or the device driver has reserved the device and then anotherreservation conflict occurs.

Windows System-Managed Encryption

188 IBM Tape Device Drivers Installation and User’s Guide

Page 207: IBM Tape Driver IUG 1

Chapter 8. Tru64 Device Driver

Purpose . . . . . . . . . . . . . . . 189Product Requirements . . . . . . . . . . 189

Hardware Requirements. . . . . . . . . 189

Software Requirements . . . . . . . . . 189Setting Up the Environment . . . . . . . 189

This chapter describes the Tru64 support available for the IBM TotalStorageEnterprise Tape System 3590 and the IBM 3584 UltraScalable Tape Library.

The IBM Tape Diagnostic Tool (ITDT) is not supported on the Tru64 operatingsystem, see “Tru64 System - RAS Utility Program (IBMrasutil)” on page 425 forinformation on the IBMrasutil application.

PurposeThe Tru64 Native tape and medium changer device drivers (cam_tape,cam_changer) are designed to take advantage of the features provided by tapedrives and medium changer devices. The goal is to give applications access to thefunctions required for basic tape operations (such as backup and restore) andmedium changer operations (such as mount and demount the cartridges).

Product RequirementsThe following hardware and software components are supported by IBM.

Hardware RequirementsThe following hardware is supported by the Tru64 Native Tape and MediumChanger driver:v One or more of the following IBM tape and medium changer device:

– IBM Ultrium LTO1 tape drive– IBM System Storage TS3500, 3581 and 3583 Tape Libraries– IBM TotalStorage Enterprise Tape Drive 3590, Model E11 or H11 (Rack Mount

with ACF) with FC interface– IBM TotalStorage Enterprise Tape Drive 3590, Model E1A or H1A (3494 Tape

Library Model) with FC interfacev One or more of the following Fibre Channel Host Bus Adapter:

– 64 bit PCI to Fibre Channel Host Bus Adapter (Compaq part #DS-KGPSA-CA) Version: 1.32a, F/W Rev: 3.81A4

Software RequirementsTru64 5.1A Operating System with native device driver and medium changerdevice driver.

Setting Up the EnvironmentTo set up IBM Tape and Medium changer devices to operate with the Tru64operating system:1. Confirm that Tru64 Operating System version 5.1A is properly installed.2. Confirm that the Host Bus Adapter card and appropriate firmware levels are

properly installed on a Compaq Alpha system.

© Copyright IBM Corp. 2007, 2009 189

Page 208: IBM Tape Driver IUG 1

3. Connect the tape and medium changer devices to the host bus adapter cardfollowing the instructions for the devices.

4. Power up the tape and medium changer devices, if not already powered up,and wait until they have initialized.

5. Login as root administrator or use the su command to gain superuserprivileges.

6. At the command line, issue the /sbin/hwmgr -scan scsi command to detect tapesor medium changers that are connected to the host.

7. To verify the scanned results, issue /sbin/hwmgr -view dev at the commandprompt.

8. Add a new entry to the /etc/ddr.dbase file for the particular tape or mediumchanger devices.Figure 33 on page 191 is an example output of a workingdevice configuration for an IBM TotalStorage 3590 tape drive.For more information on ddr_config utility and the ddr.dbase file, refer to theTru64 documentation and man pages.

9. Issue the /sbin/ddr_config -c /etc/ddr.base command to compile and link the newentry to the driver module.

10. The native driver creates device special files based on the information given inthe ddr.dbase file.

Tru64 Device Driver

190 IBM Tape Device Drivers Installation and User’s Guide

Page 209: IBM Tape Driver IUG 1

*SCSIDEVICE#type = tapeName = "IBM" "03590E1A" #Vendor ID and Product ID

#

PARAMETERS:TypeSubClass = rdatMaxTransferSize = 0x0ffffff #(16M-1)ReadyTimeSeconds = 45CMD_PreventAllow = supportedCMD_ExtReserveRelease = supported

DENSITY:DensityNumber = 0DensityCode = Default

DENSITY:DensityNumber = 1DensityCode = DefaultBlocking = 0x200 #block sizeBuffered = 1 #buffered mode

DENSITY:DensityNumber = 2DensityCode = DefaultCompressionCode = 0x00 #compression offBlocking = 0x8000 #block sizeBuffered = 1 #buffered mode

DENSITY:DensityNumber = 3DensityCode = DefaultCompressionCode = 0x00 #compression offBlocking = 0x10000 #block sizeBuffered = 1 #buffered mode

DENSITY:DensityNumber = 4,5,6,7DensityCode = DefaultCompressionCode = 0x01 #compression onBlocking = 0x20000 #block sizeBuffered = 1 #buffered mode

Figure 33. Example Output for Tru64 Device Driver and IBM 3590 Tape Drive

Chapter 8. Tru64 Device Driver 191

Page 210: IBM Tape Driver IUG 1

192 IBM Tape Device Drivers Installation and User’s Guide

Page 211: IBM Tape Driver IUG 1

Chapter 9. 3494 Enterprise Tape Library Support

Purpose . . . . . . . . . . . . . . . 193MTLIB Program . . . . . . . . . . . . 194

Syntax and Examples. . . . . . . . . . 194MTEVENT Program . . . . . . . . . . . 205Library Driver Information . . . . . . . . . 205

Software Interface . . . . . . . . . . . 205Library Manager Event Notification . . . . . 205Synchronous and Asynchronous Operations . . 206Operation Complete Notification . . . . . . 206Unsolicited Notification . . . . . . . . . 206Driver Message Queue . . . . . . . . . 206Volume Categories . . . . . . . . . . 206IBM TotalStorage Virtual Tape Server SubsystemAttachment . . . . . . . . . . . . . 207

3494 Library Emulation . . . . . . . . . . 209Overview. . . . . . . . . . . . . . 2093494 Emulation Design . . . . . . . . . 209Using the 3494 API Emulation and MTLIBProgram . . . . . . . . . . . . . . 210SMC Library Names . . . . . . . . . . 210Volume Categories . . . . . . . . . . 210Asynchronous Library Operations . . . . . 211Performance Considerations . . . . . . . 211

AIX . . . . . . . . . . . . . . . . 212Data Flow . . . . . . . . . . . . . 212Product Requirements . . . . . . . . . 212Installation Instructions . . . . . . . . . 213Special Files . . . . . . . . . . . . . 219Problem Determination . . . . . . . . . 219

HP-UX . . . . . . . . . . . . . . . 221Data Flow . . . . . . . . . . . . . 221Product Requirements . . . . . . . . . 222Installation Instructions . . . . . . . . . 223Problem Determination . . . . . . . . . 226

Linux . . . . . . . . . . . . . . . . 228Data Flow . . . . . . . . . . . . . 228Product Requirements . . . . . . . . . 229Installation and Configuration Instructions . . 230Problem Determination . . . . . . . . . 233

Solaris . . . . . . . . . . . . . . . . 234Data Flow . . . . . . . . . . . . . 234Product Requirements . . . . . . . . . 235Installation Instructions . . . . . . . . . 236Problem Determination . . . . . . . . . 239

Windows . . . . . . . . . . . . . . . 240Data Flow . . . . . . . . . . . . . 240Product Requirements . . . . . . . . . 241Installation Instructions . . . . . . . . . 242Problem Determination . . . . . . . . . 246

TRU64. . . . . . . . . . . . . . . . 247Data Flow . . . . . . . . . . . . . 247Product Requirements . . . . . . . . . 248Installation and Configuration Instructions . . 249Problem Determination . . . . . . . . . 251

SGI IRIX . . . . . . . . . . . . . . . 253Data Flow . . . . . . . . . . . . . 253Product Requirements . . . . . . . . . 254Installation Instructions . . . . . . . . . 255

PurposeThe IBM 3494 Library device driver is a device driver providing attachment for theIBM TotalStorage 3494 Enterprise Automated Tape Library and IBM TotalStorageVirtual Tape Server (VTS) to a server. The programs described in this chaptersupport the 3494 Enterprise Automated Tape Library on the following operatingsystems:v AIX on IBM POWER-based serversv HP-UXv Linuxv Sun/Solarisv Microsoft Windows NTv Microsoft Windows 2000v Microsoft Windows 2003v Microsoft Windows 2008v Tru64v SGI/IRIX

© Copyright IBM Corp. 2007, 2009 193

Page 212: IBM Tape Driver IUG 1

MTLIB ProgramThe mtlib program is a command-line interface used to control the 3494 EnterpriseTape 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 systemcall) as specified in the IBM Tape Device Drivers: Programming Reference, GA32-0566.Refer to “MTEVENT Program” on page 205.

The mtlib program provides an interface to the physical tape drives and volumeswithin a 3494 Tape Library and also to the virtual tape drives and volumes withinan attached IBM TotalStorage Virtual Tape Server (VTS).

To issue commands to the physical tape drives and volumes, specify a devicespecial file name, such as /dev/lmcp0 or the logical name of the library, such aslibmgrc7.

To issue commands to the virtual tape drives and volumes in an attached VTSlibrary, specify a device special file name or the logical name of the library withthe name of the logical VTS library appended with a slash (/). For example, toissue commands to the first attached VTS library, use /dev/lmcp0/vts1 orlibmgrc7/vts1. The attached VTS libraries are named logically vts1, vts2, and so onand 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 attachedVTS devices and the number of the VTS library.

Syntax and ExamplesFigure 34 shows the syntax for the mtlib program .

Figure 34. Syntax Diagram for mtlib program

3494 Enterprise Tape Library Support

194 IBM Tape Device Drivers Installation and User’s Guide

Page 213: IBM Tape Driver IUG 1

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, forexample, 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 expandedinformation 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 inthe library:

Type Description

O Enable the category order

C Clear the cartridge loader

G Generate the first mount

A Enable the auto mount

3494 Enterprise Tape Library Support

Chapter 9. 3494 Enterprise Tape Library Support 195

Page 214: IBM Tape Driver IUG 1

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. EachVolume Serial should be entered as one per line in the file.

-N[name] Category name to assign to the category (valid characters areuppercase A-Z, 0-9, -, *, or blank).

-h[hostid] Host ID for the reserve or release category or the R/A option forthe query command.

-u Include usage date in the expanded volume data (used inconjunction with the -qE option). The default is the ISO formatwith a period separator. The format can be specified with the -Foption.

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

3494 Enterprise Tape Library Support

196 IBM Tape Device Drivers Installation and User’s Guide

Page 215: IBM Tape Driver IUG 1

The report in Figure 35 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)

The report in Figure 36 was produced by: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)

Device Data:mounted volser............TAF500mounted category..........FF00device category...........0000device state..............Device installed in Library.

Device available to Library.Volume is loaded.ACL is installed.

device class..............3590-B1Aextended device status....00

Figure 35. Device Query

Volume Data:volume state.........00logical volume.......Novolume class.........3590 1/2 inch cartridge tapevolume type..........HPCT 320m nominal lengthvolser...............CS2000category.............FE00subsystem affinity...04 03 05 06 01 02 00 00

00 00 00 00 00 00 00 0000 00 00 00 00 00 00 0000 00 00 00 00 00 00 00

Figure 36. Volume Query

3494 Enterprise Tape Library Support

Chapter 9. 3494 Enterprise Tape Library Support 197

Page 216: IBM Tape Driver IUG 1

The report in Figure 37 was produced by: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)

The report in Figure 38 was produced by: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)

The report in Figure 39 was produced by: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)

The report in Figure 40 was produced by: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.

Expanded Volume Data:volume status........00logical volume.......Novolume class.........3590 1/2 inch cartridge tapevolume type..........HPCT 320m nominal lengthvolser...............CS2000device category......FF00

Figure 37. Expanded Volume Query

Expanded Volume Data with Usage:volume status............00logical volume...........Novolume class.............3590 1/2 inch cartridge tapevolume type..............HPCT 320m nominal lengthvolser...................CS2000device category..........FF00last used (yyyy.mm.dd)...2001.08.26

Figure 38. Expanded Volume Data with Usage

Performing Query Inventory Volume Count Data using /dev/lmcp0Inventory Volume Count Data:

sequence number......12345number of volumes....207category.............0000

Figure 39. Inventory Count Data

3494 Enterprise Tape Library Support

198 IBM Tape Device Drivers Installation and User’s Guide

Page 217: IBM Tape Driver IUG 1

The report in Figure 41 was produced by: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.

0, 00515820 003490C2A001, 00515821 003490C2A01

Figure 40. Tape Library Device Number

Type Mod Serial # Devnum Cuid Device VTS Library003590 B1A 13-10800 00108000 1 0003590 B1A 13-10800 00108001 1 1003590 B18 13-01817 00018170 2 0 1003590 B18 13-01817 00018171 2 1 1003590 B18 13-01817 00018172 2 2 1003590 B18 13-01817 00018175 2 3 1003490 C2A 13-01817 00FF0100 3 0 1003490 C2A 13-01817 00FF0101 3 1 1003490 C2A 13-01817 00FF0110 3 2 1003490 C2A 13-01817 00FF0111 3 3 1003490 C2A 13-01817 00FF0120 3 4 1003490 C2A 13-01817 00FF0121 3 5 1003490 C2A 13-01817 00FF0130 3 6 1003490 C2A 13-01817 00FF0131 3 7 1

Figure 41. Expanded Tape Library Device List

3494 Enterprise Tape Library Support

Chapter 9. 3494 Enterprise Tape Library Support 199

Page 218: IBM Tape Driver IUG 1

The report in Figure 42 was produced by: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 Requiredfunctional state...........00input stations.............1output stations............1input/output status........All input stations empty

All output stations emptymachine type...............3494sequence number............10491number of cells............1056available cells............1014subsystems.................6convenience capacity.......30accessor config............01accessor status............Accessor available

Gripper 1 availableGripper 2 installedVision 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.........00bulk input capacity........0bulk input empty cells.....0bulk output capacity.......0bulk output empty cells....0avail 3490 cleaner cycles..0avail 3590 cleaner cycles..91

Figure 42. Library Data

3494 Enterprise Tape Library Support

200 IBM Tape Device Drivers Installation and User’s Guide

Page 219: IBM Tape Driver IUG 1

The report in Figure 43 was produced by: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...........10machine type.........003494model number.........L10manufacturer.........IBMplant................13sequence number......000000010491drives...............6mounted drives.......1max mounted drives...2min mounted drives...1avg mounted drives...1max mounted time.....22min mounted time.....16avg mounted time.....19pending mounts.......0max pending mounts...2min pending mounts...0avg pending mounts...0mounts/hour..........18index mounts/hour....0pre-mounts/hour......0max mount time.......27min mount time.......16avg mount time.......19pending demounts.....0max pending demounts.2min pending demounts.0avg pending demounts.0demounts/hour........16index demounts/hour..0post-demounts/hour...0max demount time.....28min demount time.....19avg demount time.....24pending ejects.......0max pending ejects...0min pending ejects...0avg pending ejects...0ejects/hour..........0max eject time.......0min eject time.......0avg eject time.......0pending audits.......0max pending audits...0min pending audits...0avg pending audits...0audits/hour..........0max audit time.......0min audit time.......0avg audit time.......0input stores/hour....0

Figure 43. Statistical Data

3494 Enterprise Tape Library Support

Chapter 9. 3494 Enterprise Tape Library Support 201

Page 220: IBM Tape Driver IUG 1

The report in Figure 44 was produced by: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/lmcp0Inventory Data:

sequence number......10491number of volumes....44inventory records

record 1......category............012Cvolser..............008273volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

record 2......category value......FF00volser..............064435volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

record 3......category value......FF00volser..............ALTML1volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length•••

record 42......category............FF00volser..............TST039volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

record 43......category............FF00volser..............TST182volume state........Volume present in Library,

but Inaccessiblerecord 44......category value......FF00

volser..............XYZ464volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

Note: All available records are produced as output per request.Fewer records are shown here for the sake of brevity.

Figure 44. Inventory Query

3494 Enterprise Tape Library Support

202 IBM Tape Device Drivers Installation and User’s Guide

Page 221: IBM Tape Driver IUG 1

The report in Figure 45 was produced by: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/lmcp0Inventory by Category Data:

sequence number......10491number of volumes....30category.............FF00inventory records

record 1......category ...........FF00volser..............CS2017volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

record 2......category ...........FF00volser..............FVT896volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

record 3......category ...........FF00volser..............IHG319volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length•••

record 28......category ...........FF00volser..............SLT500volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

record 29......category ...........FF00volser..............TAF195volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

record 30......category ...........FF00volser..............MOO801volume state........00logical volume......Novolume class........3590 1/2 inch cartridge tapevolume type.........HPCT 320m nominal length

Note: All available records are produced as output per request.Fewer records are shown here for the sake of brevity.

Figure 45. Category Inventory Query

3494 Enterprise Tape Library Support

Chapter 9. 3494 Enterprise Tape Library Support 203

Page 222: IBM Tape Driver IUG 1

The report in Figure 46 was produced by: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)

The report in Figure 47 was produced by: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)

The report in Figure 48 was produced by: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)

Reserved Category List:sequence number............10491system token...............roadstertotal number reserved......0002

category......0101category......0102

Figure 46. Reserve Category Command

Reserved Category List:sequence number............10491system token...............roadstertotal number reserved......0002

category......0101category......0102

Figure 47. Reserve Category List

Category Attribute List:sequence number............10491

system token...............roadstercategory 0101 –– name: SCRATCHcategory 0102 –– name: WORKING

Figure 48. Category Attribute List

3494 Enterprise Tape Library Support

204 IBM Tape Device Drivers Installation and User’s Guide

Page 223: IBM Tape Driver IUG 1

The report in Figure 49 was produced by:mtlib -l /dev/lmcp0 -A (for AIX physical library)mtlib -l tire -A (for Sun, HP, Linux, SGI, Tru64, and Windows)

MTEVENT ProgramThe 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, forexample, /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 InformationThe 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 tapelibrary online to the system. A symbolic name is used to perform the variouslibrary functions (such as mounting and demounting volumes).

Software InterfaceThe C object module provides three subroutines for communicating with the IBMTotalStorage 3494 Enterprise Tape Library. These subroutines are open_ibmatl,close_ibmatl, and ioctl_ibmatl. The open_ibmatl and close_ibmatl routines are used toopen and close communication with the library (as the open and close system callsare used to open and close communication with a file). The ioctl_ibmatl subroutineis 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 definedfor use on the library.

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

Library Address Information:library name...............tirehost identification........roadsterprimary address............9.115.45.52primary status.............Onlinealternate address..........9.115.45.51alternate status...........Offline

Figure 49. Library Address Information

3494 Enterprise Tape Library Support

Chapter 9. 3494 Enterprise Tape Library Support 205

Page 224: IBM Tape Driver IUG 1

that has arrived, then the event is discarded. The applications can use the LibraryEvent Wait call to request notification of all Library Manager events. Refer to theIBM Tape Device Drivers: Programming Reference for more information.

Synchronous and Asynchronous OperationsTwo types of library operations are supported: synchronous and asynchronous.The Library Manager responds to the synchronous operation immediately. Theseoperations are completed when the library responds to the request. An example ofa synchronous operation is the Library Query call. An asynchronous operation(such as a mount operation) takes longer to complete. In an asynchronousoperation, the library returns an initial response when the command is acceptedfor execution. When the command is completed, it returns a delayed responsemessage indicating the status of the operation.

Operation Complete NotificationWhen the Mount, Demount, Audit, or Set Volume category operation is sent to thelibrary, a message identifier is assigned to the operation. This identifier is returnedto lmcpd. When the operation is completed, an operation complete notification issent to the daemon. The daemon makes a determination (based on the initialmessage identifier) as to which user process to notify that the operation iscomplete. The Mount, Demount, Audit, or Set Volume category operations have anoption that allows the user process to wait or not wait for the operation completemessage. If the user process does not wait for the final complete, the initialmessage identifier is returned to the caller, and it can be used in subsequentLibrary Query Message ID operations to solicit the status of the asynchronousoperation.

Unsolicited NotificationThere are situations when the Library Manager has a condition to report that is notrelated to any I/O operation. In this case, an unsolicited notification is sent to thedevice daemon. If a notification is received, then any process waiting with theLibrary Event Wait call is notified. An example of an unsolicited notification is theoperational 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 unsolicitednotifications received by the lmcpd.

Driver Message QueueThe driver maintains a message queue for any process that has an open LMCP filedescriptor. This queue, which has a depth of four entries, is implemented on afirst-in, first-out basis. The purpose of this message is to reduce the possibility ofmissing a message when several messages occur in a short period of time. Allqueue entries are discarded when the LMCP file descriptor is closed. When anapplication issues the MTIOCLEW input/output control (ioctl) call, the driverreturns the oldest entry from the message queue and deletes it. If no entries are inthe queue, then the calling process is put to sleep until a message is received.

Volume CategoriesTo facilitate the management of the tape volumes within the 3494 Tape Library, thecapability to associate the tape volumes into logical groupings is provided. Eachlogical grouping is known as a category. For example, an installation can have oneor more scratch categories that are assigned by media type or class of user.Another potential use is managing volumes for daily, weekly, and monthlybackups or volumes owned by a specific user. The lmcpd also allows a user process

3494 Enterprise Tape Library Driver

206 IBM Tape Device Drivers Installation and User’s Guide

Page 225: IBM Tape Driver IUG 1

to assign a particular category to a tape device in the library. This process allowsall the volumes associated with the category to be mounted as determined by theflags of the command on the specified device.

A category is a four digit hexadecimal number in the X'0000'–X'FFFF' range. Theassigned 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 volumelabel is read and assigned to this category. This category cannot beassigned by a user process.

Eject The volumes assigned to this category are moved from their cellinto the output station. After the volume is delivered, it is removedfrom the inventory. The Library Set Volume Category command isthe only command that can change the category of a volume to theeject category.

Bulk eject The volumes that are assigned to this category are moved fromtheir current cell to the bulk output area in the 3494 Tape Library.Refer to the IBM TotalStorage Enterprise Automated Tape LibraryOperator Guide for more information about the bulk output area.The Library Set Volume Category command is the only commandthat can change the category of a volume to the bulk eject category.

The X'FFFF' category is available for general programming use, except that anymount request to this category must apply to a specific volume assigned to thecategory (and not based on the category alone).

IBM TotalStorage Virtual Tape Server Subsystem AttachmentThe 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 virtualtape drives that are accessible with the VTS SCSI attachment feature. Volumeswithin the VTS subsystem are logical tape volumes. A logical tape volume appears

3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 207

Page 226: IBM Tape Driver IUG 1

to the host as a normal physical tape volume, except that the VTS logical volumesare unique to the VTS subsystem and are accessible only by virtual tape driveswithin the VTS subsystem.

Access to a VTS subsystem is specified to the device driver as a logical librarywithin the attached Tape Library as vts1, vts2, and so on. For example, issuing aQuery Inventory command to the 3494 lib returns the physical volumes in the 3494Tape 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 inthe first VTS subsystem attached to the 3494 Enterprise Tape Library.

3494 Enterprise Tape Library Driver

208 IBM Tape Device Drivers Installation and User’s Guide

Page 227: IBM Tape Driver IUG 1

3494 Library EmulationThe 3494 Library Emulation support provides the ability to use applications thatwere written for the 3494 API on host attached SCSI Medium Changer Libraries,specifically for migration to the 3584 Ultra Scalable Library with 3592 drives.

OverviewExisting customer scripts using the mtlib program and customer or ISVapplications require no or minor changes to use, depending on the 3494 functionsbeing used. Customer and ISV applications only need to be recompiled with thenew libibm.o object module in order to use the emulation support. The mtlib 3494user command line interface program that has the same syntax and output onevery operating system and also provides a common utility for SCSI MediumChanger Libraries. Current operating system device driver utilities vary bysyntax/output, require a knowledge of SCSI Medium Changers to use, and requiremultiple commands to perform a single mtlib command.

3494 Emulation DesignThe 3494 Emulation support adds a libsmc extension to the current libibm.o objectmodule that applications compile with for existing 3494 support. The libsmcextension contains the 3494 API Emulation support, which issues SCSI Mediumchanger commands to the library using the operating system SCSI MediumChanger device driver.

Figure 50 and Figure 51 on page 210 show the 3494/SMC data flow betweenexisting applications and components and the new libsmc extension.

3494/ SMC Library Data Flow

3494Library Manager

LibraryTape Drive

TCP/IPLMCPD

Tape DeviceDriver

AdapterDevice Driver

Application

LIBIBM.OObjectModule

LIBSMC SCSI MediumChanger

AdapterDevice Driver

SMC DeviceDriver

a28t1

001

Figure 50. 3494/SMC Library Data Flow

3494 Library Emulation

Chapter 9. 3494 Enterprise Tape Library Support 209

Page 228: IBM Tape Driver IUG 1

Using the 3494 API Emulation and MTLIB ProgramRefer to the IBM Tape Device Drivers Installation and User’s Guide and the IBM TapeDevice Drivers Programmer’s Reference for the complete description of 3494 librarysupport and the mtlib program and syntax.

SMC Library NamesThe library name on the open_ibmatl (″libname″) or mtlib -l libname parameterdetermines whether a 3494 library or an SMC library is being used. If the libraryname is a logical operating system SMC library name then the libsmc support isused. Otherwise, the lmcpd support is used.

For example, SMC libraries on AIX are named smc0, smc1, and so on. To issue anmtlib 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 CategoriesThe 3494 library supports the grouping of one or more volumes into categoriesthat can be assigned by an application and operations that can specify a categoryonly rather than a specific volume. SCSI Medium Changers do not provide asimilar function. All volumes in an SMC library are category 0000, the NULLcategory.

LIBSMC and O/S Components

HPUXatdd Device

Driver

SolarisIBMtape Device

Driver

AIXAtape Device

Driverlibsmc.c

3494 APIEmulation

SCSI MediumChanger

Commands

libsmc_aix.c

libsmc_sun.c

libsmc_hp.c

libsmc_linux.c

libsmc_win.c

LinuxIBMtape Device

Driver

WindowsIBMtape Device

Driver a28t1

002

Figure 51. LIBSMC and OS Components

3494 Library Emulation

210 IBM Tape Device Drivers Installation and User’s Guide

Page 229: IBM Tape Driver IUG 1

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

Asynchronous Library OperationsThe 3494 library performs all mount, demount, audit, and eject operationsasynchronously and initially returns a request id to the host for the operation. Therequest id can then be queried at any time to determine if the operation is stillpending, completed, or is unknown. SMC libraries perform these operationssynchronously and do not support a request id.

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

If an application selects to not wait for an asynchronous operation to complete bysetting the API wait_flg to zero or using mtlib with the -n option, the operation onan 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 whenthe operation completes and use the no wait option for performance only. Forexample, using the no wait option on a demount operation so the application cancontinue while the library is demounting the volume. These applications and mtlibscripts do not require any changes but do take the same amount of time as usingthe wait option.

Applications that use the Query Message ID or mtlib -i option to determine whenthe return request id operation completes may require changes, such as polling fora mount issued with the no wait option since any request id is always unknownon an SMC library because the operation has already completed.

Performance ConsiderationsThe performance time of mtlib commands issued to a SCSI 3584 library versus a3494 vary and some performance times may be significantly higher. The mtlibcommands such as -qV and -qI for example that require reading all the slotinformation from the library also vary in the amount of time it takes for thecommand to complete. The fewer the number of slots that are in the library, theshorter time it takes to complete the mtlib command and a larger number of slotsin the library takes longer.

3494 Library Emulation

Chapter 9. 3494 Enterprise Tape Library Support 211

Page 230: IBM Tape Driver IUG 1

AIXThe software consists of an Automated Tape Library Device Driver (atldd), anapplication daemon (lmcpd) that communicates with the 3494 Library Manager(LM), and a utility program (mtlib), which provides a command-line interface tothe library. Either an Ethernet or Token-Ring LAN or an RS-232 serial connectioncan 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 PointDaemon (lmcpd), communicates with tape libraries defined in a configuration file.This file, ibmatl.conf, is placed in the /etc directory when the software package isinstalled. Customization of this file is described in “Defining Tape Libraries to theDaemon” on page 214. A typical environment for the AIX 3494 Enterprise LibraryDriver is an RS/6000 or System p (also known as pSeries) server on a local areanetwork (LAN) with SCSI- or fibre-attached tape drives providing backup andrestore functions.

Data FlowThe software described in this chapter covers the library device driver and theinterface between the application and the library device driver. For moreinformation refer to Figure 52.

Product RequirementsThe following hardware and software components are supported by IBM.

Figure 52. Data Flow for AIX 3494 Enterprise Tape Library Driver

AIX 3494 Enterprise Tape Library Driver

212 IBM Tape Device Drivers Installation and User’s Guide

Page 231: IBM Tape Driver IUG 1

Hardware RequirementsThe library driver supports the following hardware:v 3494 Enterprise Tape Library with SCSI-attached IBM 3490E (Model C1A, C2A,

or F1A), 3590, and 3592 tape drivesv 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])IBM TotalStorage Virtual Tape Server (models B10, B18, and B20)

– 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 EO5v IBM Virtualization Engine TS7510

Software RequirementsThe following software is required for the library driver:v AIX 5L, Versions 5.1 and 5.2, and later releases on IBM POWER-based servers.v AIX Tape and Medium Changer Device Driver (Atape)

To obtain the most current service and documentation for this software, refer toAppendix A, “Accessing Documentation and Software Online,” on page 341

Installation InstructionsUse the standard set of AIX methods to install and configure the LMCP devices.You must have root authority to perform these operations.

Installation ProcedureRefer to Appendix A, “Accessing Documentation and Software Online,” on page341 for information on obtaining the latest versions of the device driver and thelatest documentation.

Enter the following command to list the currently installed version of the 3494Enterprise Library Driver:

lslpp -l atldd.driver

Connecting the IBM TotalStorage Enterprise Tape LibraryIf a TTY connection is needed, use a standard 25 pin null modem D-shell RS-232cable to connect the workstation to the 3494 Enterprise Tape Library. Place thecable on the native serial port or on the eight port or 16 port asynchronousadapter.

If a LAN connection is needed, connect the LAN cable from the Token Ring orEthernet 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 installedto ensure proper initialization of the driver.

AIX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 213

Page 232: IBM Tape Driver IUG 1

Configuring the Serial PortAfter the 3494 Tape Library is connected to the workstation, you must configurethe serial port to which it is connected. Use smit to configure the serial port. Enterthe 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 DriveTo operate the 3494 Enterprise Tape Library successfully through the configuredLMCPs, you must configure all 3490E or 3590 tape drives in the 3494 Tape Library.Refer to “Configuring the Library Manager Control Point” on page 215 forinstructions.

Defining Tape Libraries to the DaemonAfter the software is installed and the desired tape libraries are connected to thesystem, the /etc/ibmatl.conf file must be edited to define the tape libraries to thelmcpd. 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 uniqueacross all libraries defined in the /etc/ibmatl.conf file.

Connection type is used to define the type of connection to the library (either RS-232or TCP/IP). For RS-232 connections, this type is the device special file name of thetty device (for example, /dev/tty0 or /dev/tty1). For TCP/IP connections, this type isthe IP address of the Library Manager. If the Library has a dual LAN cardinstalled, the second IP address of the dual LAN card should be entered after thefirst IP address.

Note: Ensure that duplicate IP addresses are not used in this file or unpredictableresults can occur.

Identifier is used to specify a name by which the Library Manager identifies thehost machine. This identifier has a maximum of eight characters. The host name ofthe workstation is usually the best name to use (although it is not necessary). Thisparameter is used only to identify a particular host to the 3494 Enterprise LibraryManager.

Alternate LAN Connection is used to specify an alternate IP address for a 3494 HighAvailability LAN attached configuration. If the High Availability Library has a dual

AIX 3494 Enterprise Tape Library Driver

214 IBM Tape Device Drivers Installation and User’s Guide

Page 233: IBM Tape Driver IUG 1

LAN card installed, the second IP address of the dual LAN card should be enteredafter 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 theworkstation. The address of the Library Manager on the 3494 Tape Library is9.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 throughTCP/IP to the workstation. The IP addresses of the dual Library Managers are9.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 tothe workstation. The first address of the Library Manager on the 3494 Tape Libraryis 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercuryidentifier for the host. The following stanza defines the libmgrc7 High Availabilitylibrary with dual LAN cards connected through TCP/IP to the workstation. The IPaddresses of the first Library Manager are 9.115.32.21 and 9.115.32.22. The IPaddresses of the second Library Manager are 9.115.26.13 and 9.115.26.14. Thelibrary 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 PointAfter the driver is installed, a tape library is connected to the workstation, and theserial port is configured, you can configure the instances of the LMCP. Perform thefollowing procedure to define and configure the LMCP:1. Enter the following command:

smit

The system management interface tool (smit) main menu is displayed (refer toFigure 53).

AIX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 215

Page 234: IBM Tape Driver IUG 1

2. Select Devices (item 2) from the smit main menu.Use the up (↑) arrow and down (↓) arrow keys to move the cursor to thedesired item on the menu.Press Enter or click Do if you are processing smit in a windowedenvironment.

3. Select Tape Drive from the Devices menu (refer to Figure 54).

The Tape Drive menu is displayed (refer to Figure 55).

System Management

Move cursor to desired item and press Enter.

Software Installation and MaintenanceDevicesPhysical & Logical StorageSecurity & UsersDiskless Workstation Management & InstallationCommunications Applications and ServicesSpooler (Print Jobs)Problem DeterminationPerformance & Resource SchedulingSystem EnvironmentsProcesses & SubsystemsApplicationsUsing SMIT (information only)

F1=Help F2=Refresh F3=Cancel F8=ImageF9=Shell F10=Exit Enter=Do

Figure 53. SMIT Main Menu

Devices

Move cursor to desired item and press Enter.

Configure Devices Added after IPLPrinter/PlotterTTYAsynchronous AdaptersPTYConsoleFixed DiskCD ROM DriveOptical Disk DriveDiskette DriveTape Drive•••

Figure 54. SMIT Devices Menu

AIX 3494 Enterprise Tape Library Driver

216 IBM Tape Device Drivers Installation and User’s Guide

Page 235: IBM Tape Driver IUG 1

4. Select Add a Tape Drive from the Tape Drive menu (Figure 55). The TapeDrive Type menu is displayed (refer to Figure 56).

5. Select the Library Manager control point from the Tape Drive Type menu(refer to Figure 56).

The Add an LMCP Logical Device menu is displayed (refer to Figure 57).The Logical Name field for the Library Manager control point is optional. Ifthe field remains blank, a unique name is assigned automatically. Theassigned name is lmcpn, where: n is a number that indicates the LMCP entryand 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 page214 for a description of this file.The Command Timeout in Minutes field is optional and is used to specify themaximum amount of time an application waits for commands to complete,including mount and demount commands. The default is to wait forever untilthe command completes.

Tape Drive

Move cursor to desired item and press Enter.

List All Defined Tape DrivesList All Supported Tape DrivesAdd a Tape DriveChange / Show Characteristics of a Tape DriveRemove a Tape DriveConfigure a Defined Tape DriveGenerate Error ReportTrace a Tape Drive

Figure 55. SMIT Tape Drive Menu

Tape Drive Type

Move cursor to desired item and press Enter.

8mm scsi 2.3 GB 8 mm Tape Drive9trk scsi 1/2 Inch 9 Track Tape Drive150mb scsi 150 MB 1/4 Inch Tape Driveost scsi Other SCSI Tape Drivedrive 3420 3420 Tape Drivedrive 3480 3480 Tape Drivedrive 3490 3490 Tape Driveatl library LAN/TTY Library Manager Control Point

Figure 56. Tape Drive Type Menu

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 57. Add an LMCP Logical Device Menu

AIX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 217

Page 236: IBM Tape Driver IUG 1

6. The COMMAND STATUS window opens with the Command: OK status. Thelogical name of the Library Manager control point is displayed as Defined(refer to Figure 58).

7. Repeat steps 4 through 6 to define any additional Library Manager controlpoints.

8. Return to the smit Tape Drive menu (refer to Figure 55).9. Select Configure a Defined Tape Drive from the smit Tape Drive menu. A list

of LMCP devices is displayed (refer to Figure 59).

10. Select a defined Library Manager control point to configure from the LMCPSelection list.The COMMAND STATUS window opens with the Command: OK status, andthe Library Manager control point is shown as Available (refer to Figure 60).

11. Cancel the COMMAND STATUS window by pressing F3. The LMCP Selectionwindow opens again.

12. Continue selecting the Library Manager control points for configuration untilall the devices are configured.

13. Exit from the smit menu.You have completed the configuration of Library Manager control points tothe system.

Loading the DaemonThe lmcpd is loaded during the system initialization. During the initial installationof the driver, you must load the daemon manually using the following command:

COMMAND STATUS

Command: OK stdout: yes stderr: no

Before command completion, additional instructions may appear below.

lmcp0 Defined

Figure 58. LMCP COMMAND STATUS Window

Tape Drive

Move cursor to desired item and press Enter.

rmt0 Available 00-00-0S-50 2.3 GB 8 mm Tape Drivermt1 Defined 00-01-01-20 IBM SSD 3490E Tape Drivelmcp0 Defined LAN/TTY Library Manager Control Point

F1=Help F2=Refresh F3=CancelF8=Image F10=Exit Enter=Do

Figure 59. Configure an LMCP Selection List

COMMAND STATUS

Command: OK stdout: yes stderr: no

Before command completion, additional instructions may appear below.

lmcp0 Available

Figure 60. Configure a Defined LMCP COMMAND STATUS Window

AIX 3494 Enterprise Tape Library Driver

218 IBM Tape Device Drivers Installation and User’s Guide

Page 237: IBM Tape Driver IUG 1

cfgmgr

You can access the 3494 Enterprise Tape Library after the above command isexecuted.

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 onlyone instance has a parent process ID of 1.

Deconfiguring the Library Manager Control PointIn the following examples, replace the letter n with the appropriate number for thechosen 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 itdefined in the device database:rmdev -l lmcpn

2. The second method takes the device offline and removes the device definitionfrom the device database.Enter the following command:rmdev -l lmcpn -d

The device driver modules are not unloaded from the kernel until the last tapedevice is deconfigured.

Uninstall ProcedureAll devices using the atldd driver must be closed and not in use when atldd isuninstalled or the uninstall fails.

You can uninstall the atldd using the smit command menu to uninstall software andselecting atldd.driver or use the following installp command:installp -u atldd.driver

Special FilesAfter the driver is installed and a Library Manager control point is configured andmade available for use, access is provided through the special files. These specialfiles are in the /dev directory. Each instance of an LMCP has exactly one special file(for example, /dev/lmcp0) associated with it.

Problem DeterminationA set of tools is provided with the device driver to determine if it is functioningcorrectly. The standard AIX interface is provided for problem determination.

Error LoggingThe driver provides logging to the system error log for various errors. View theerror log using the smit or the errpt command. The error templates follow the sameform as the default AIX error log entries.

AIX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 219

Page 238: IBM Tape Driver IUG 1

AIX Device Driver Trace FacilityThe AIX trace facility is supported for the device driver. The trace event isidentified with a hookword. The hookword used by the device driver is 426. The tracecan 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 eventswith 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 filefor viewing. The /etc/lmcp.trcfmt file is installed into /etc during installation. Itprovides the formatting statements needed by trcrpt.

Daemon Trace FacilityThe 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-outtrcatl -l libmgrc7

Note: The -a argument takes precedence over the -l argument.

AIX 3494 Enterprise Tape Library Driver

220 IBM Tape Device Drivers Installation and User’s Guide

Page 239: IBM Tape Driver IUG 1

HP-UXThe software consists of a daemon that communicates directly with the LibraryManager 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 Cobject module that can be linked with user applications to provide acommunication interface with the daemon.

Note: In the HP-UX operating system, this is a program that runs unattended inthe background to perform a standard service. Some daemons are triggeredautomatically to perform their task, others operate periodically.

This software is known as a driver throughout this document because it providesthe software and interface necessary to drive the 3494 Tape Library. However, theproduct does not consist of a device driver in the true sense of the term. That is, it isnot 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 HPworkstation that acts as a data server on a network with SCSI tape devicesproviding backup or restore and data server functions.

The Library Manager control point daemon (lmcpd) is provided in the package. Thelmcpd is a process that is always running on the system. It provides directcommunication with the 3494 Enterprise Library Manager. An application linkswith the supplied C object module using the interface described in the IBM TapeDevice Drivers: Programming Reference. The subroutines in this module communicatewith the lmcpd to perform the various library operations using standard UNIXnamespace 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 237 for moreinformation.

Data FlowThe software described in this chapter covers the library driver. The interfacebetween the application and the library driver is described in the IBM Tape DeviceDrivers: Programming Reference. Figure 62 on page 229 illustrates the data flow.

HP-UX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 221

Page 240: IBM Tape Driver IUG 1

Product RequirementsThe following software and hardware are required to use this product.

Hardware RequirementsThe 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 v2v 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 workstationToken-Ring cables (as required)

– Ethernet Attach:Enterprise FC 5220 (Ethernet Adapter)Ethernet port or adapter for HP workstationEthernet cables (as required)

Software RequirementsThe following software is required for the library driver:v HP-UX Version 10.20, 11.0, 11i v1, v2, and v3v IBM Tape and Medium Changer Device Driver for HP-UX

To obtain the most current service and documentation for this software, refer toAppendix A, “Accessing Documentation and Software Online,” on page 341.

Application

Tape DeviceDriver

AdapterDevice Driver

LMCPD TCP/IP

PhysicalTape Drive

LibraryManager

CObjectModule

a250106

Figure 61. Data Flow for HP-UX 3494 Enterprise Tape Library Driver

HP-UX 3494 Enterprise Tape Library Driver

222 IBM Tape Device Drivers Installation and User’s Guide

Page 241: IBM Tape Driver IUG 1

Software CompatibilityThe following optional software is supported by the library driver:

IBM Tivoli Distributed Storage Manager for HP-UX

Installation InstructionsThis chapter describes how to install, configure, and uninstall the HP-UXAutomated Tape Library Support for the 3494 Enterprise Tape Library. The IBMTape Library driver for HP-UX is installed using the standard swinstall process. TheIBM Tape Library Driver for HP-UX is the lmcpd package.

Installation OverviewLAN support must exist on the machine before installing the IBM Tape Librarydriver for HP-UX. Install and configure the LAN support before proceeding withthe installation of the lmcpd package. For more information, refer to the HP-UXdocumentation appropriate for the LAN support that you are using.1. Copy the software from the distribution medium to the depot.2. Check the README file and verify that your system is configured

appropriately for installing the lmcpd software.3. Install and configure the software.

You must have root authority to perform this installation procedure.

The distribution diskette contains a swinstall process that includes the lmcpddaemon with other associated files and utilities.

Command Sequence InformationPlease take note of the following facts about the command sequences described inthis section: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 insteadof filename ensures this.

v All the SD commands (for example, swinstall, swcopy) can be run initially withthe ’-p’ flag to preview the command. After observing the preview output, youcan reissue the command without the ’-p’ flag to perform the actual operation.

v The SD commands are moderately complex scripts that usually proceed inseveral steps. The steps are typically Selection, Analysis, and Execution. Each stepmay produce useful information and error messages, so it is a good idea toobserve carefully the results of the installation process as it occurs.

If you run into unexpected results during the installation, check the associated logfile.

Note: If an earlier version of the product is installed on the machine, execute theuninstall procedure before you enter the following commands. Refer to“Uninstall Procedure” on page 239 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)

HP-UX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 223

Page 242: IBM Tape Driver IUG 1

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 ispreserved. It is not overwritten. A copy of ibmatl.conf is also installed in the/opt/lmcpd directory.

Install the Product ManuallyInstalling the product manually requires two steps, detailed in the followingsections:1. “Copy the Software to the Software Depot” on page 2242. “Install the Product” on page 224

Copy the Software to the Software Depot

Attention: If you do not copy the lmcpd software into a depot, you cannot easilyuninstall 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 ProductWhen the software is in the depot, the lmcpd software can be installed to the rootfile system using the HP-UX swinstall command.

The following commands install lmcpd from the depot to the default root filesystem:

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

HP-UX 3494 Enterprise Tape Library Driver

224 IBM Tape Device Drivers Installation and User’s Guide

Page 243: IBM Tape Driver IUG 1

# swverify lmcpd

Connecting the IBM TotalStorage 3494 Enterprise AutomatedTape LibraryYou can use a LAN connection (either Ethernet or Token Ring) through a TCP/IPconnection. The connection must be in place before the software is installed toensure proper initialization of the daemon. For each 3494 Enterprise Tape Libraryconnected through TCP/IP, ensure that your machine has access to the LibraryManager on the 3494 Enterprise Tape Library. Use the ping utility to verify that youhave network connectivity to the Library Manager. Consult your networkadministrator if you need help with this task.

Defining the Library Device to LMCPDAfter the software is installed and all desired tape libraries are connected to thesystem, the /etc/ibmatl.conf file must be edited to define the library devices to thelmcp daemon. The format of the file is:Symbolic name Connection type Identifier Alternate LAN Connection

Symbolic name is used to identify each tape library. The symbolic names must beunique across all libraries defined in the ibmatl.conf file.

Connection type defines the type of connection to the library. For TCP/IPconnections, this type is the IP address of the 3494 Enterprise Library Manager. Ifthe Library has a dual LAN card installed, the second IP address of the dual LANcard should be entered after the first IP address.

Identifier is used to specify a name by which the Library Manager identifies thehost machine. This identifier has a maximum length of eight characters. Thesymbolic network name of the host is usually the best name to use, although anyname is acceptable. This parameter is used only to identify a particular host to the3494 Library Manager.

Alternate LAN Connection is used to specify an alternate IP address for anEnterprise High Availability LAN configuration. If the High Availability Libraryhas a dual LAN card installed, the second IP address of the dual LAN card shouldbe entered after the first alternate LAN connection IP address.

The following examples show how to define the library name:3494a 9.115.32.21 jupiter

This stanza defines the 3494a library connected to the host. The address of theEnterprise Library Manager is 9.115.32.21. The tape library uses jupiter as theidentifier for the host.libmgrc9 9.115.46.15 telos 9.115.46.17

This stanza defines the libmgrc9 High Availability library connected throughTCP/IP to the workstation. The IP addresses of the dual Library Managers are9.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 tothe workstation. The first address of the Library Manager on the 3494 Tape Libraryis 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercuryidentifier for the host. The following stanza defines the libmgrc7 High Availabilitylibrary with dual LAN cards connected through TCP/IP to the workstation. The IP

HP-UX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 225

Page 244: IBM Tape Driver IUG 1

addresses of the first Library Manager are 9.115.32.21 and 9.115.32.22. The IPaddresses of the second Library Manager are 9.115.26.13 and 9.115.26.14. Thelibrary 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

Adding or Deleting Entries in the Library DeviceYou can add or delete entries in /etc/ibmatl.conf at any time. However, changes donot 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 thedaemon again.

Ensure that the library activity on all of the libraries is completed before startingthe lmcpd again.

Uninstall Procedure

Attention: Do not try to uninstall the lmcpd software by deleting the files thatmake up the lmcpd fileset. It is best to use the swremove command.

Halt all library activity before starting the uninstall procedure. Kill the lmcpddaemon if it is currently executing.

To remove the lmcpd software from the root file system enter:

# swremove -p lmcpd# swremove lmcpd

Other Administrative TasksTo determine what versions of the lmcpd software are currently installed on thedefault 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 toremove it. For example:

# swremove -d lmcpd,r=4.1.8.0

Problem DeterminationA set of tools is provided with the software to determine if the lmcpd is functioningcorrectly.

HP-UX 3494 Enterprise Tape Library Driver

226 IBM Tape Device Drivers Installation and User’s Guide

Page 245: IBM Tape Driver IUG 1

Error LoggingThe lmcpd uses the syslog facility to log the errors. Errors are logged according tothe /etc/syslog.conf file. The lmcpd uses the daemon facility for logging errors. Onlyerrors are logged with this facility. For more information about using syslog, referto your system administration manuals.

Daemon Trace FacilityThe following trace facility is available for the lmcpd daemon: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-outtrcatl -l libmgrc7

Note: The -a argument takes precedence over the -l argument.

HP-UX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 227

Page 246: IBM Tape Driver IUG 1

LinuxThe software consists of a daemon that communicates directly with the LibraryManager 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 Cobject module that can be linked with user applications to provide acommunication interface with the daemon.

Note: In the Linux operating system, this is a program that runs unattended, inthe background, to perform a standard service. Some daemons are triggeredautomatically to perform their task; others operate periodically.

This software is known as a driver throughout this document because it providesthe software and interface necessary to drive the 3494 Tape Library. However, theproduct does not include a device driver in the true sense of the term. That is, it isnot 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 Linuxworkstation that acts as a data server on a network with tape devices providingbackup or restore and data server functions.

The Library Manager control point daemon (lmcpd) is provided in the package. Thelmcpd is a process that is always running on the system. It provides directcommunication with the Library Manager. An application links with the suppliedC object module using the interface described in the IBM Tape Device Drivers:Programming Reference. The subroutines in this module communicate with the lmcpdto 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 237 for moreinformation.

Data FlowThe software described in this chapter covers the library driver. The interfacebetween the application and the library driver is described in the IBM Tape DeviceDrivers: Programming Reference. Figure 62 on page 229 illustrates the data flow.

Linux 3494 Enterprise Tape Library Driver

228 IBM Tape Device Drivers Installation and User’s Guide

Page 247: IBM Tape Driver IUG 1

Product RequirementsThe following hardware and software components are required and supported byIBM.

Hardware RequirementsThe following hardware is required for the library driver:v IBM TotalStorage 3494 Enterprise Tape Library with IBM 3590 and 3592 drives

with the Fibre Channel Attachmentv IBM System Storage TS1120 Tape Drivev IBM Virtualization Engine TS7510v 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 workstationToken-Ring cables (as required)

– Ethernet Attach:Enterprise FC 5220 (Ethernet Adapter)Ethernet port or adapter for Linux workstationEthernet cables (as required)

Software RequirementsThe following software is supported by the library driver:v For Linux distribution support, refer to 96v IBM Tape and Medium Changer Device Driver (IBMtape) for Linux

Application

Tape DeviceDriver

AdapterDevice Driver

LMCPD TCP/IP

PhysicalTape Drive

LibraryManager

CObjectModule

a250106

Figure 62. Data Flow for Linux 3494 Enterprise Tape Library Driver

Linux 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 229

Page 248: IBM Tape Driver IUG 1

To obtain the most current service and documentation for this software, refer toAppendix A, “Accessing Documentation and Software Online,” on page 341.

Installation and Configuration InstructionsThe IBM Tape Library driver for Linux, (ibmatl), is supplied in an rpm package. Thefollowing sections describe installation, removal, configuration, and verificationprocedures for ibmatl. Refer to any Linux distribution supporting rpm for rpmcommand information. You must have root authority to proceed with theinstallation of the driver.

In the subsequent pages, you will see file names with xxxx or x.x.x.x in them. Thexxxx or x.x.x.x refer to the version of the driver, which will change as IBM releasesnew driver levels. Use the actual driver version numbers as you perform theprocedures.

Install and configure the LAN support before proceeding with installation of theibmatl package. For more information, refer to the Linux documentationappropriate 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 areinstalled 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 installedat:/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 ispreserved (it is not overwritten).

Installation ProcedureIf ibmatl is already installed on your system, refer to “Updating Procedure” onpage 232. This section assumes that you are installing ibmatl on a system where itis 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 LibraryUse a LAN connection (either Ethernet or Token Ring) through TCP/IP. Theconnection must be in place before the software is installed to ensure properinitialization of the daemon. For each 3494 Tape Library connected through

Linux 3494 Enterprise Tape Library Driver

230 IBM Tape Device Drivers Installation and User’s Guide

Page 249: IBM Tape Driver IUG 1

TCP/IP, ensure that your machine has access to the Library Manager on the 3494Tape Library. Use the ping utility to verify that you have network connectivity tothe Library Manager. Consult your network administrator if you need help withthis task.

Defining the Library Device to the lmcpdAfter the software is installed and tape libraries are connected, the /etc/ibmatl.conffile must be edited to define the library devices to the lmcpd. The format of the fileis:

Symbolic name Connection type Identifier Alternate LAN Connection

Symbolic name is used to identify each tape library. The symbolic names must beunique across all libraries defined in the ibmatl.conf file.

Connection type is used to define the type of connection to the library. For TCP/IPconnections, this type is the IP address of the 3494 Library Manager. If the Libraryhas a dual LAN card installed, the second IP address of the dual LAN card shouldbe entered after the first IP address.

Identifier parameter is used to specify a name by which the Library Manageridentifies 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, althoughany name is acceptable. This parameter is used only to identify a particular host tothe 3494 Library Manager.

Alternate LAN Connection is used to specify an alternate IP address for a 3494 HighAvailability LAN configuration. If the High Availability Library has a dual LANcard installed, the second IP address of the dual LAN card should be entered afterthe first alternate LAN connection IP address.

The following examples show how to define the library name:3494a 9.115.32.21 jupiter

This stanza defines the 3494a library that is connected to the host. The address ofthe 3494 Library Manager is 9.115.32.21. The tape library uses jupiter as theidentifier for the host.

libmgrc9 9.115.46.15 telos 9.115.46.17

This stanza defines the libmgrc9 High Availability library that is connected throughTCP/IP to the workstation. The IP addresses of the dual Library Managers are9.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 tothe workstation. The first address of the Library Manager on the 3494 Tape Libraryis 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercuryidentifier for the host.libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14

This stanza defines the libmgrc7 High Availability library with dual LAN cardsconnected through TCP/IP to the workstation. The IP addresses of the first LibraryManager are 9.115.32.21 and 9.115.32.22. The IP addresses of the second LibraryManager are 9.115.26.13 and 9.115.26.14. The library uses the mercury identifier forthe host.

Linux 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 231

Page 250: IBM Tape Driver IUG 1

Adding or Deleting Entries in the Library DeviceYou can add or delete entries in /etc/ibmatl.conf at any time. However, changes donot take effect until the daemon is started again. Use the UNIX kill command (kill-kill <pid>) to kill the lmcpd process, and enter the /etc/lmcpd command to start thedaemon again.

Ensure that activity on all libraries is completed before restarting the lmcpd.

Updating ProcedureIf your current ibmatl was installed from an rpm package previously, issue thefollowing command:rpm -Uvv ibmatl.x.x.x.x.s390.rpm --for IBM Linux on S/390 systemsrpm -Uvv ibmatl.x.x.x.x.i386.rpm --for Red Hat Intel PC based systems

Querying the Installed PackageThe query function is supported for the ibmatl rpm package only.

The installed rpm package can be queried by running the following commands todisplay 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, orreplaced:

>rpm -qs ibmatl

Verifying the Install/UpdateIf the IBMtape device driver is installed from the rpm package, issue the followingcommand:

>rpm -V ibmatl

Starting ibmatlStart the daemon using the following command:

/etc/lmcpd

Uninstall Procedure

Attention: Do not try to uninstall the ibmatl software simply by removing thefiles that make up the ibmatl fileset. It is best to use the rpm -e command or theuninstall script.

Note: Halt all library activity before starting the uninstall procedure.

For the rpm package, run the command rpm -e:

rpm -evv ibmatl

Linux 3494 Enterprise Tape Library Driver

232 IBM Tape Device Drivers Installation and User’s Guide

Page 251: IBM Tape Driver IUG 1

If more than one level of ibmatl exists on the system, explicitly specify the level toremove it.

rpm -evv ibmatl-5.0.7.0

Problem DeterminationA set of tools is provided with the software to determine if the ibmatl isfunctioning correctly.

Error LoggingThe ibmatl uses the syslog facility to log the errors. Errors are logged according tothe /etc/syslog.conf file. The ibmatl uses the daemon facility for logging errors. Onlyerrors are logged with this facility. For more information about using syslog, referto your system administration manuals.

Daemon Trace FacilityThe following trace facility is available for the lmcpd daemon: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-outtrcatl -l libmgrc7

Note: The -a argument takes precedence over the -l argument.

Linux 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 233

Page 252: IBM Tape Driver IUG 1

SolarisThe software consists of a daemon that communicates directly with the LibraryManager of the 3494 Tape Library through RS-232 or LAN, a utility program thatprovides a command-line interface to the daemon, and a C object module that canbe linked with user applications to provide a communication interface with thedaemon.

This software is known as a driver throughout this document because it providesthe software and interface necessary to drive the Tape Library. However, theproduct does not consist of a device driver in the true sense of the term. That is, it isnot 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 Sunworkstation that acts as a data server on a network with SCSI tape devicesproviding backup or restore and data server functions.

The Library Manager control point daemon (lmcpd) is provided in the package. Thelmcpd is a process that is always running on the system. It provides directcommunication with the 3494 Library Manager. An application links with thesupplied C object module using the interface described in the IBM Tape DeviceDrivers: Programming Reference. The subroutines in this module communicate withthe lmcpd to perform the various library operations using standard UNIXnamespace sockets.

The lmcpd communicates with the Library Manager either through a standard 25pin null modem D-shell RS-232 cable or through TCP/IP. The /etc/ibmatl.confconfiguration file is used to define the type of attachment for each library. Refer to“Defining the Symbolic Name to the lmcpd” on page 237 for more information.

Data FlowThe software described in this chapter covers the library driver. The interfacebetween the application and the library driver is described in the IBM Tape DeviceDrivers: Programming Reference. Figure 63 on page 235 illustrates the data flow.

Solaris 3494 Enterprise Tape Library Driver

234 IBM Tape Device Drivers Installation and User’s Guide

Page 253: IBM Tape Driver IUG 1

Product RequirementsThe following software and hardware are supported by this product.

Hardware RequirementsThe following hardware is supported by the library driver:v 3494 Enterprise Tape Library with SCSI-attached 3490E (Model C1A or C2A),

3590 and 3592 drivesv IBM System Storage TS1120 Tape Drivev IBM Virtualization Engine TS7510v 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

Application

Tape DeviceDriver

AdapterDevice Driver

LMCPD

TCP/IP

NativeTTY

DeviceDriver

PhysicalTape Drive

LibraryManager

CObjectModule

a250093

Figure 63. Data Flow for Solaris 3494 Enterprise Tape Library Driver

Solaris 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 235

Page 254: IBM Tape Driver IUG 1

Software RequirementsThe following software is required for the library driver:v Sun Microsystems Solaris Version 2.6, 7, 8, 9, or 10v IBM Tape and Medium Changer Device Driver for Solaris

To obtain the most current service and documentation for this software, refer toAppendix A, “Accessing Documentation and Software Online,” on page 341.

Software CompatibilityThe following optional software is supported by the library driver:

IBM Tivoli Distributed Storage Manager for Solaris

Installation InstructionsThe IBM Tape Library driver for Solaris is installed using the standard Sun packagefacility. The IBM Tape Library Driver for Solaris is the lmcpd package.

Preinstallation ConsiderationsThe LAN or TTY support must exist on the machine before installing the IBM TapeLibrary daemon for SunOS. Install and configure the LAN or TTY adapter and theassociated LAN or TTY adapter device driver before proceeding with theinstallation of the lmcpd package. For more information, refer to the documentationappropriate for the LAN or TTY adapter and the LAN or TTY adapter devicedriver 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 theuninstall procedure before you enter the following commands. Refer to“Uninstall Procedure” on page 239 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 ispreserved. It is not overwritten. A copy of ibmatl.conf is also installed in the/opt/lmcpd directory.

Installation ProcedureUse the following commands to install the lmcpd package. Substitute the devicespecial file name for the installation source device that is appropriate for yoursystem.

Solaris 3494 Enterprise Tape Library Driver

236 IBM Tape Device Drivers Installation and User’s Guide

Page 255: IBM Tape Driver IUG 1

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 thefollowing 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 LibraryUse one of the following methods to connect the workstation to the 3494 TapeLibrary: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 toensure proper initialization of the daemon.

For each 3494 Tape Library connected with an RS-232 cable, follow the directionsin “Configuring the Serial Port” on page 237. For each 3494 Tape Library connectedthrough TCP/IP, ensure that your machine has access to the Library Manager onthe Enterprise device. Use the ping utility to verify that you have networkconnectivity to the Library Manager. Consult your network administrator if youneed help with this task.

Identify the hostname of your workstation to the Enterprise Library Manager byfollowing the instructions in the IBM TotalStorage Enterprise Automated Tape LibraryOperator Guide, in the Add LAN Host section.

Configuring the Serial PortAfter the 3494 Tape Library is connected to the workstation, you must configurethe 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 lmcpdAfter the software is installed and all of the desired tape libraries are connected tothe system, the /etc/ibmatl.conf file must be edited to define the tape libraries to thelmcpd. The format of the file is:Symbolic name Connection type Identifier Alternate LAN Connection

Symbolic name is used to identify each tape library. The symbolic names must beunique 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-232or TCP/IP). For RS-232 connections, this type is the device special file name of thetty device (for example, /dev/ttya or /dev/tty1). For TCP/IP connections, this type is

Solaris 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 237

Page 256: IBM Tape Driver IUG 1

the IP address of the Library Manager. If the Library has a dual LAN cardinstalled, the second IP address of the dual LAN card should be entered after thefirst IP address.

Identifier is used to specify a name by which the Library Manager identifies thehost machine. This identifier has a maximum length of eight characters. The hostname of the workstation is usually the best name to use (although it is notnecessary). This parameter is used only to identify a particular host to the 3494Enterprise Library Manager.

Alternate LAN Connection is used to specify an alternate IP address for anEnterprise High Availability LAN-attached configuration. If the High AvailabilityLibrary has a dual lan card installed, the second IP address of the dual LAN cardshould 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:3494a /dev/ttya mercury

This stanza defines the 3494a library that is connected by /dev/ttya to theworkstation. 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 theworkstation. The address of the Library Manager on the Enterprise Tape Library is9.115.32.21. The library uses the jupiter identifier for the host.libmgrc9 9.115.46.15 telos 9.115.46.17

This stanza defines the libmgrc9 High Availability library that is connected throughTCP/IP to the workstation. The IP addresses of the dual Library Managers are9.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 tothe workstation. The first address of the Library Manager on the 3494 Tape Libraryis 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercuryidentifier for the host. The following stanza defines the libmgrc7 High Availabilitylibrary with dual LAN cards connected through TCP/IP to the workstation. The IPaddresses of the first Library Manager are 9.115.32.21 and 9.115.32.22. The IPaddresses of the second Library Manager are 9.115.26.13 and 9.115.26.14. Thelibrary 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

Adding or Deleting Entries in the LibraryYou can add or delete entries in /etc/ibmatl.conf at any time. However, changes donot 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 thedaemon again.

Ensure that the library activity on all of the libraries is completed before restartingthe lmcpd.

Solaris 3494 Enterprise Tape Library Driver

238 IBM Tape Device Drivers Installation and User’s Guide

Page 257: IBM Tape Driver IUG 1

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

Problem DeterminationA set of tools is provided with the software to determine if the lmcpd is functioningcorrectly.

Error LoggingThe lmcpd uses the syslog facility to log the errors. Errors are logged according tothe /etc/syslog.conf file. The lmcpd uses the daemon facility for logging errors. Onlyerrors are logged with this facility. For more information about using syslog, referto your system administration manuals.

Daemon Trace FacilityThe following trace facility is available for the lmcpd daemon: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-outtrcatl -l libmgrc7

Note: The -a argument takes precedence over the -l argument.

Solaris 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 239

Page 258: IBM Tape Driver IUG 1

WindowsThe software consists of a tape library service that communicates directly with theLibrary Manager of the 3494 Enterprise Tape Library through LAN, a utilityprogram that provides a command-line interface to the service, and a static libraryand DLL that can be used to provide a communication interface with the service.

A typical environment for the Windows Automated Tape Library Service is aworkstation running Microsoft Windows operating system that acts as a dataserver on a network with SCSI tape devices providing backup or restore and dataserver functions.

The IBM Automated Tape Library service is provided in the installation package.This service is installed with STARTUP=AUTOMATIC, which means that it isstarted when the Microsoft Windows operating system is started. An applicationprogram may access those functions through API calls. The interface is describedin the IBM Tape Device Drivers: Programming Reference. The subroutines in thismodule communicate with the Enterprise Library Manager to perform the variouslibrary operations.

The service communicates with the Library Manager through TCP/IP. Thec:\winnt\ibmatl.conf configuration file is used to define the type of attachment foreach library. Refer to “Defining the Symbolic Name to the Service” on page 244 formore information.

Data FlowThe software described in this chapter covers the library driver. The interfacebetween the application and the library driver is described in the IBM Tape DeviceDrivers: Programming Reference. Figure 64 on page 241 illustrates the data flow.

Windows 3494 Enterprise Tape Library Driver

240 IBM Tape Device Drivers Installation and User’s Guide

Page 259: IBM Tape Driver IUG 1

Product RequirementsThe following hardware and software components are required and supported byIBM.

Hardware RequirementsThe following hardware is required for the library driver:v 3494 Enterprise Tape Library with Enterprise Tape System 3590 and 3592 drivesv IBM System Storage TS1120 Tape Drivev IBM Virtualization Engine TS7510v IBM TotalStorage Virtual Tape Server (Models B10, B18, and B20)

The following options are required for operation of the Enterprise LibraryManager:v Token-Ring or Ethernet adapter card in an Intel- compatible workstation (486DX

or higher) running Microsoft Windows NT or Microsoft Windows 2000 andattached to the 3494 Enterprise Tape Library

v LAN cable

Software RequirementsThe following software is required for the library driver:v A workstation running Microsoft Windows NT 4.0 with Fix Pack 3 or laterv A workstation running Microsoft Windows 2000 Build 2195 or laterv A workstation running Microsoft Windows Server 2003

Figure 64. Data Flow for Windows 3494 Enterprise Tape Library Driver

Windows 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 241

Page 260: IBM Tape Driver IUG 1

v A workstation running Microsoft Windows Server 2008v IBM Windows Tape Device Driver or the ADSM/TSM Device Driver for

Microsoft Windows NT if using ADSM/TSM

To obtain the most current service and documentation for this software, refer toAppendix A, “Accessing Documentation and Software Online,” on page 341.

Installation InstructionsThe IBM Tape Library service for Microsoft Windows is installed by executing theinstall binary, which has the format ibmatl.x.x.x.x.x86.exe for 32-bit Windows 200xrunning on x86, ibmatl.x.x.x.x.i64.exe for 64-bit Windows 2003 running on IA64, andibmatl.x.x.x.x.x64.exe for 64-bit Windows Server 2003 and Windows Server 2008running on AMD64 and EM64T.

Installation ProcedureUse the following procedure to install the IBM Automated Tape Library Service orto upgrade the software level of your service on your workstation.

Follow these steps to perform the installation of the service and its associatedsoftware:1. Verify that the prerequisites are satisfied. Refer to “Product Requirements” on

page 241.2. Ensure that the workstation is on the LAN.3. Log on as Administrator.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 itfrom 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, thendouble-click the Services icon.

v On Windows 2008, click the Start button, double-click the AdministrativeTools icon, then double-click the Services icon.

The Services window opens. Scroll through the entries until you find IBMAutomated Tape Library. If you do not find the entry for IBM AutomatedTape Library, the service is not installed; click Close. If there is an entry andthe status is blank, the service is not running; click Close. If the status isStarted, 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,

Windows 3494 Enterprise Tape Library Driver

242 IBM Tape Device Drivers Installation and User’s Guide

Page 261: IBM Tape Driver IUG 1

the screen stops on a window entitled Welcome to the IBM Automated TapeLibrary Setup Program. Follow the instructions on the window, then selectNext.

9. The Software License Agreement window opens. Read the contents, thenclick Yes if you accept the terms. If you do not accept the terms, theinstallation script exits.

10. The Choose Destination Location window opens. You can accept the defaultdestination folder by selecting Next >, or you can select Browse... and selectanother destination folder by following the prompts in the subsequent dialog.If you do not select the default destination folder, you must record yourdestination 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 viewthe Read Me file prompt to read the file, then click Finish, or just clickFinish. The Read Me file is stored in the destination file that you indicated instep 10.

12. After you click Finish, if you did not select to view the Read Me file, theinstallation dialog exits. If you chose to view the Read Me, it is displayed.After you read it, exit the Notepad application. An informational message isdisplayed, indicating that the setup is complete. Click OK to exit theinstallation dialog.

13. Verify that you can use the ping utility successfully for any Tape Library youwant to access from your workstation.

14. Update the c:\winnt\ibmatl.conf file, if necessary, with entries for each TapeLibrary you want to access from your workstation. Refer to “Defining theSymbolic Name to the Service” on page 244 for details.

15. On Windows NT, start the service by restarting the system or using theServices option in the Control Panel window.On Windows 2000 and 2003, start the service using the Services icon, which ison the Administrative Tools icon in the Control Panel window.On Windows 2008, start the service using the Services icon, which is on theAdministrative Tools icon.

Note: When a firewall is enabled on Windows, you must allow the lmcpdprogram to access the network. Do not block the network IP port of3494, which is used for communication between the 3494 library andlmcpd.

For example, to allow lmcpd.exe access to the network on Windows2008 servers, click on the Windows Firewall icon in the Control Panelwindow. Next, click on the button to allow a program or an exception,and then click the Add Program button. Select your browser and thenselect lmcpd.exe in /Windows/system32 for an x86 system or/Windows/SysWOW64 for i64 or x64 systems.

Connecting the 3494 Enterprise Tape LibraryUse a LAN connection (either Ethernet or Token-Ring) through TCP/IP to connectthe workstation to the 3494 Enterprise Tape Library. The connection must be inplace 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 LibraryManager. Consult your network administrator if you need help with this task.

Windows 3494 Enterprise Library Service

Chapter 9. 3494 Enterprise Tape Library Support 243

Page 262: IBM Tape Driver IUG 1

Identify the hostname of your workstation to the Enterprise Library Manager byfollowing the instructions in the IBM TotalStorage Enterprise Automated Tape LibraryOperator Guide, in the Add LAN Host section.

Defining the Symbolic Name to the ServiceAfter the software is installed and all of the desired tape libraries are connected tothe system, the c:\winnt\ibmatl.conf file must be edited to define the tape librariesto the service. The format of the file is:Symbolic name Connection type Identifier Alternate LAN Connection

Symbolic name identifies each tape library. The symbolic names must be uniqueacross 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 dualLAN card installed, the second IP address of the dual LAN card should be enteredafter the first IP address.

Identifier specifies a name by which the Library Manager identifies the hostmachine. This identifier has a maximum length of eight characters. The host nameof 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 tothe workstation. The address of the Library Manager on the 3494 Tape Library is9.115.32.21. The library uses the jupiter identifier for the host.3494b 9.115.32.21 jupiter

The Alternate LAN Connection parameter specifies an alternate IP address for anEnterprise High Availability LAN configuration. If the High Availability Libraryhas a dual LAN card installed, the second IP address of the dual LAN card shouldbe entered after the first alternate LAN connection IP address.

The following stanza defines the libmgrc9 High Availability library that isconnected through TCP/IP to the workstation. The IP addresses of the dualLibrary 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 throughTCP/IP to the workstation. The first address of the Library Manager on the 3494Tape Library is 9.115.32.21 and the second address is 9.115.32.22. The library usesthe 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 LANcards connected through TCP/IP to the workstation. The IP addresses of the firstLibrary Manager are 9.115.32.21 and 9.115.32.22. The IP addresses of the secondLibrary Manager are 9.115.26.13 and 9.115.26.14. The library uses the mercuryidentifier for the host.libmgrc7 9.115.32.21 9.115.32.22 mercury 9.115.26.13 9.115.26.14

Adding or Deleting Libraries to the ServiceYou 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.

Windows 3494 Enterprise Library Service

244 IBM Tape Device Drivers Installation and User’s Guide

Page 263: IBM Tape Driver IUG 1

On Windows NT, stop and start the service using the Services option in theControl Panel window.

On Windows 200x, stop and start the service using the Services icon, which is onthe Administrative Tools icon in the Control Panel window.

Ensure that the library activity on all of the libraries is completed before startingthe service again.

Uninstallation ProcedureUse the following procedure to remove the IBM Automated Tape Library Servicepermanently from your workstation.

Note: If you are upgrading the software level of your service, follow the steps in“Installation Procedure” on page 242.

Follow these steps to uninstall the service and its associated software:1. Log on as Administrator.2. Back up the c:\winnt\ibmatl.conf file if you want to keep a copy of this file

because the uninstall procedure erases the file.3. Ensure that all programs and services that use the IBM Automated Tape

Library Service are stopped.4. Ensure that the IBM Automated Tape Library Service is not running. Click 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 IBMAutomated Tape Library. If the status is blank, the service is not running;click Close. If the status is Started, click IBM Automated Tape Library, thenclick 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 andFeatures 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 windowopens, which indicates the components that were removed successfully. ClickOK to exit the dialog.

Windows 3494 Enterprise Library Service

Chapter 9. 3494 Enterprise Tape Library Support 245

Page 264: IBM Tape Driver IUG 1

11. For Windows NT, click Cancel on the Add/Remove Programs Propertieswindow.For Windows 2000 and 2003, close the Add/Remove Programs Propertieswindow.For Windows 2008, close the Programs and Features window.

Problem DeterminationA tracing tool is provided with the software to determine if ibmatl is functioningcorrectly.

Daemon Trace FacilityThe following trace facility is available for the ibmatl service:trcatl -husage: 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 libmgrc7trcatl -a > trace.out

Windows 3494 Enterprise Library Service

246 IBM Tape Device Drivers Installation and User’s Guide

Page 265: IBM Tape Driver IUG 1

TRU64The software consists of a daemon that communicates directly with the LibraryManager 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 Cobject module that can be linked with user applications to provide acommunication interface with the daemon.

Note: In the Tru64 operating system, this is a program that runs unattended, in thebackground, to perform a standard service. Some daemons are triggeredautomatically to perform their task; others operate periodically.

This software is known as a driver throughout this document because it providesthe software and interface necessary to drive the 3494 Tape Library. However, theproduct does not include a device driver in the true sense of the term. That is, it isnot an extension of the operating system kernel, such as a tape device driver.

A typical environment for the Tru64 Automated Tape Library Driver is a Tru64workstation that acts as a data server on a network with tape devices providingbackup or restore and data server functions.

The Library Manager control point daemon (lmcpd) is provided in the package. Thelmcpd is a process that is always running on the system. It provides directcommunication with the Library Manager. An application links with the suppliedC object module using the interface described in the IBM Tape Device Drivers:Programming Reference. The subroutines in this module communicate with the lmcpdto 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 237 for moreinformation.

Data FlowThe software described in this chapter covers the library driver. The interfacebetween the application and the library driver is described in the IBM Tape DeviceDrivers: Programming Reference. Figure 62 on page 229 illustrates the data flow.

TRU64 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 247

Page 266: IBM Tape Driver IUG 1

Product RequirementsThe following hardware and software components are required and supported byIBM.

Hardware RequirementsThe following hardware is supported by and required for the library driver:v IBM TotalStorage 3494 Enterprise Tape Library with IBM 3590 Model E1A or

H1A drives with Fibre Channel interface.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 Tru64 workstationToken-Ring cables (as required)

– Ethernet Attach:Enterprise FC 5220 (Ethernet Adapter)Ethernet port or adapter for Tru64 workstationEthernet cables (as required)

Software RequirementsThe following software is required for the library driver:v Tru64 5.1A operating system.

To obtain the most current service and documentation for this software, refer toAppendix A, “Accessing Documentation and Software Online,” on page 341.

Application

Tape DeviceDriver

AdapterDevice Driver

LMCPD TCP/IP

PhysicalTape Drive

LibraryManager

CObjectModule

a250106

Figure 65. Data Flow for TRU 64 3494 Enterprise Tape Library Driver

TRU64 Enterprise Tape Library Driver

248 IBM Tape Device Drivers Installation and User’s Guide

Page 267: IBM Tape Driver IUG 1

Installation and Configuration InstructionsThe IBM Tape Library driver for Tru64, (ibmatl), is a 64-bit software supplied in aproduct kit package. The following sections describe installation, removal,configuration, and verification procedures for ibmatl. You must have root authorityto 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. Thexxxx or x.x.x.x refer to the version of the driver, which will change as IBM releasesnew driver levels. Use the actual driver version numbers as you perform theprocedures.

When you are installing from a tar package of the product kit from our web site,you need to unpack the tar files and keep them in directories that were created,along with the files the installation process creates, in those directories. You willalso need to remember the name of the top level directory in order to uninstalland/or update the driver and utilities.

Install and configure the LAN support before proceeding with the installation ofthe ibmatl package. For more information, refer to the Tru64 documentationappropriate 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/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)/usr/doc/ibmatl/README (readme file)/usr/doc/ibmatl/license (license file)

Note: If this is an update of the ibmatl package, the existing /etc/ibmatl.conf file ispreserved (it is not overwritten).

Installation ProcedureObtain ibmatl driver from the IBM storage FTP server in binary and executesetld

command to install ibmatl driver:/usr/sbin/setld -l /driver_location/ibmatl.x.x.x.x.kit

Connecting the TotalStorage Enterprise 3494 Tape LibraryUse a LAN connection (either Ethernet or Token Ring) through TCP/IP. Theconnection must be in place before the software is installed to ensure properinitialization of the daemon. For each 3494 Tape Library connected throughTCP/IP, ensure that your machine has access to the Library Manager on the 3494Tape Library. Use the ping utility to verify that you have network connectivity tothe Library Manager. Consult your network administrator if you need help withthis task.

Defining the Library Device to the lmcpdAfter the software is installed and tape libraries are connected, the /etc/ibmatl.conffile must be edited to define the library devices to the lmcpd. The format of the fileis:

Symbolic name Connection type Identifier Alternate LAN Connection

TRU64 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 249

Page 268: IBM Tape Driver IUG 1

Symbolic name is used to identify each tape library. The symbolic names must beunique across all libraries defined in the ibmatl.conf file.

Connection type is used to define the type of connection to the library. For TCP/IPconnections, this type is the IP address of the 3494 Library Manager. If the Libraryhas a dual LAN card installed, the second IP address of the dual LAN card shouldbe entered after the first IP address.

Identifier parameter is used to specify a name by which the Library Manageridentifies 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, althoughany name is acceptable. This parameter is used only to identify a particular host tothe 3494 Library Manager.

Alternate LAN Connection is used to specify an alternate IP address for a 3494 HighAvailability LAN configuration. If the High Availability Library has a dual LANcard installed, the second IP address of the dual LAN card should be entered afterthe first alternate LAN connection IP address.

The following examples show how to define the library name:3494a 9.115.32.21 jupiter

This stanza defines the 3494a library that is connected to the host. The address ofthe 3494 Library Manager is 9.115.32.21. The tape library uses jupiter as theidentifier for the host.

libmgrc9 9.115.46.15 telos 9.115.46.17

This stanza defines the libmgrc9 High Availability library that is connected throughTCP/IP to the workstation. The IP addresses of the dual Library Managers are9.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 tothe workstation. The first address of the Library Manager on the 3494 Tape Libraryis 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercuryidentifier for the host. The following stanza defines the libmgrc7 High Availabilitylibrary with dual LAN cards connected through TCP/IP to the workstation. The IPaddresses of the first Library Manager are 9.115.32.21 and 9.115.32.22. The IPaddresses of the second Library Manager are 9.115.26.13 and 9.115.26.14. Thelibrary 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

Adding or Deleting Entries in the Library DeviceYou can add or delete entries in /etc/ibmatl.conf at any time. However, changes donot take effect until the daemon is started again. Use the UNIX kill command (kill-kill <pid>) to kill the lmcpd process, and enter the /etc/lmcpd command to start thedaemon again.

Ensure that activity on all libraries is completed before restarting the lmcpd.

Updating ProcedureTo update the ibmatl kit, remove the old version existing in the system first andthem update it. Issue the command to check which version of ibmatl is installed:setld -l

TRU64 Enterprise Tape Library Driver

250 IBM Tape Device Drivers Installation and User’s Guide

Page 269: IBM Tape Driver IUG 1

Uninstall the old version (yyyy):setld -d IBMATL_Vyyyy

Install the new version:setld -l /driver_location/ibmatl.x.x.x.x.kit

After the update, the lmcpd daemon is started automatically.

Querying the Installed PackageThe query function is supported for the ibmatl product kit. Run the followingcommands to display whether the ibmatl kit is installed on the system. The systemstate is listed on standard output in three columns: Subset, Status, and Description.setld -i

To display the ibmatl product kit fileset and located directory, enter:

setld -i IBMATL_Vxxxx

Verifying the Install/UpdateTo verify the existence of the installed ibmatl subset, the setld -v executes any Vphase processing included in the subset control program, except duringinstallation:setld -v IBMATL_Vxxxx

Use the fverify command to verify the files of a specific subset. The fverifycommand reports missing files and inconsistencies in file size, checksum, user ID,group ID, permissions, and file type.cd //usr/lbin/fverify -n < /usr / .smdb./IBMATL_Vxxxx.inv

Note: Once the ibmatl.conf is modified, it is normal to encounter verification errorson the file checksum and size.

Starting ibmatlStart the daemon using the following command:

/etc/lmcpd

Uninstall Procedure

Attention: Do not try to uninstall the ibmatl product kit simply by removing thefiles that make up the ibmatl fileset. It is best to use the setld -d command.

Note: Halt all library activity before starting the uninstall procedure.

Run this command to uninstall the product kit:setld -d IBMATL_Vxxxx

The existing ibmatl.conf file is always retained for future installation use afteruninstall procedures. If this file is no longer needed, you have to remove itmanually.

Problem DeterminationA set of tools is provided with the software to determine if the ibmatl isfunctioning correctly.

TRU64 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 251

Page 270: IBM Tape Driver IUG 1

Error LoggingThe ibmatl uses the syslog facility to log the errors. Errors are logged according tothe /etc/syslog.conf file. The ibmatl uses the daemon facility for logging errors. Onlyerrors are logged with this facility. For more information about using syslog, referto your system administration manuals.

Daemon Trace FacilityThe following trace facility is available for the lmcpd daemon: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-outtrcatl -l libmgrc7

Note: The -a argument takes precedence over the -l argument.

TRU64 Enterprise Tape Library Driver

252 IBM Tape Device Drivers Installation and User’s Guide

Page 271: IBM Tape Driver IUG 1

SGI IRIXThe software consists of an application daemon that communicates with the 3494Automated Tape Library’s Library Manager (LM) through Ethernet or Token RingLAN, or an RS-232 serial connection. A utility program (mtlib) provides acommand-line interface to the daemon. A C object module (libibm.o) is alsoprovided that links with user written applications to provide controlcommunication with the tape library.

Note: In a UNIX system, such as SGI IRIX, a daemon is a program that runsunattended in the background to perform a standard service. Some daemonsare triggered automatically to perform their task while others operateperiodically. The 3494 Enterprise Automated Tape Library Daemon for SGIIRIX is designed to be invoked at system IPL time and run continuously toservice applications communicating with the Tape Library.

A typical environment for the 3494 Automated Tape Library daemon for SGI IRIXis an SGI server on a Local Area Network with SCSI attached tape devicesproviding backup and restore functions for network attached clients.

The daemon, specifically known to the SGI IRIX system as the IBM LibraryManager Control Point Daemon (lmcpd), communicates with 3494 EnterpriseAutomated Tape Libraries that are defined in a configuration file. This file,ibmatl.conf, is placed in the /etc directory when the software package is installed.Customization of this file is described in “Defining the Library Device to thelmcpd” on page 257.

Application developers can use the supplied ‘C’ object module (libibm.o) tointerface software applications with lmcpd. The subroutines in this modulecommunicate with the daemon to perform mount, demount, and other librarycontrol operations. Refer to “SGI IRIX 3494 Enterprise Tape Library Driver in theIBM Tape Device Drivers: Programming Reference for details.

Data FlowFigure 66 on page 254 illustrates the software and hardware components thatcomprise an application’s communication paths with the 3494 Enterprise TapeLibrary. The path from the top left to the top right is the data path from theapplication to the actual tape devices. These software drivers are provided by theSGI IRIX operating system.

The path from the application box proceeding to the right at the bottom of thediagram shows an application linked with the supplied ‘C’ object modulecommunicating with lmcpd and the 3494 Enterprise Library Manager. The mtlibprogram (shipped with the software package) is an example of an applicationprogram that interacts with lmcpd.

SGI IRIX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 253

Page 272: IBM Tape Driver IUG 1

Product RequirementsThe following software and hardware are required to use this product.

Hardware RequirementsThe following hardware is required for the library driver:v 3494 Enterprise Tape Library with 3590 Model B1A, E1A, or H1A tape drivesv One of the following options depending on which connection (RS-232 or LAN)

is required for the Enterprise Tape Library:– RS-232: One standard 25 pin null modem D-shell RS-232 cable (maximum of

15.24 m [50 feet])

Note: One RS-422 to RS-232 converter is needed for direct attachment to anEnterprise Model HA1 (High Availability).

– LAN:- Token-Ring or Ethernet adapter support in an SGI workstation attached to

the 3494 Enterprise Tape Library- LAN cable- Enterprise FC 5219 (Token-Ring Adapter)- Enterprise FC 5220 (Ethernet Adapter)

Software RequirementsThe following software is required:v IRIX Version 6.4 or later

Application

Tape DeviceDriver

AdapterDevice Driver

LMCPD

TCP/IP

NativeTTY

DeviceDriver

PhysicalTape Drive

LibraryManager

CObjectModule

a250093

Figure 66. Data Flow for SGI IRIX 3494 Enterprise Tape Library Driver

SGI IRIX 3494 Enterprise Tape Library Driver

254 IBM Tape Device Drivers Installation and User’s Guide

Page 273: IBM Tape Driver IUG 1

v 3494 Enterprise Tape Library Daemon for SGI IRIX

Note: The device driver for the 3590 Tape Drive is provided by SGI.

Installation InstructionsThe 3494 Enterprise Tape Library Daemon for SGI IRIX can be installed by eitherusing the swmgr program menus or the inst command.

Installation ProcedureThe LAN or TTY support must exist on the machine before installing theEnterprise software for IRIX. Install and configure the LAN or TTY support beforeproceeding with the installation of the lmcpd package. For more information, referto the documentation appropriate for the LAN or TTY configuration in SGI IRIX.

You must have root authority to perform this installation procedure.

Note: If you are updating software to a newer version, you need to uninstall theexisting IBM Automated Tape Library software before installing newsoftware. Refer to “Uninstallation Procedure” on page 255 for moreinformation.

The following files are installed on the SGI IRIX 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)

Note: If this is an update of the lmcpd package, the existing /etc/ibmatl.conf file ispreserved. (It is not overwritten.)

To install the 3494 Enterprise Tape Library driver, use the inst command. Thepackage is namedibmatl.n.n.n.n.tardist

For example, to install Version 4.1.5.0 of the library driver, press Enter after youtype: inst -a -u all -f ibmatl.4.1.5.0.tardist

The Tape Library Daemon for SGI IRIX can also be installed using the swmgrprogram.

After installing the new software, you must restart the Enterprise Tape LibraryDaemon by either restarting your computer or restarting manually from acommand prompt by entering:/etc/lmcpd

Uninstallation ProcedureHalt all library activity before starting the uninstall procedure. Kill the lmcpddaemon if it is executing currently.

SGI IRIX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 255

Page 274: IBM Tape Driver IUG 1

The 3494 Enterprise Tape Library Daemon for SGI IRIX can be uninstalled byeither using the swmgr program or from the command prompt by entering:inst -a -R ibmatl

Connecting the 3494 Enterprise Tape LibraryUse one of the following methods to connect the workstation to the 3494Enterprise 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 8 port or 16 port asynchronous adapter.v Use a LAN connection (either Ethernet or Token Ring) through TCP/IP.

For each 3494 Enterprise Tape Library connected with an RS-232 cable, follow thedirections in “Configuring the Serial Port” on page 256. For each Tape Libraryconnected through TCP/IP, ensure that your system has access to the LibraryManager on the 3494 Tape Library. Use the ping utility to verify that you havenetwork connectivity to the Library Manager. Consult your network administratorif you need help with this task.

Identify the hostname of your workstation to the Enterprise Library Manager byfollowing the instructions in the IBM TotalStorage Enterprise Automated Tape LibraryOperator Guide, in the Add LAN Host section.

Configuring the Serial PortAfter the 3494 Tape Library is connected to the workstation, you must configurethe serial port to which it is connected. Use System Manager to configure the serialport.

Select the following options:1. Select System from the Toolchest.2. Select System Manager.3. Select Hardware and Devices from the System Manager window.4. Select Serial Device Manager.5. Select the right serial port in the Serial Device Manager window.6. Click Add... to add or configure the serial port.7. Follow the instructions to:

a. Specify the type of serial device: Input Device

b. Select the right port.c. Choose the name of the input device: Other

d. Choose a name for the device.e. Click OK.

The serial port you have configured should show SerialPort under Type. Bydefault, IRIX should set the port that you have just configured to the followingsettings that are needed to communicate with the 3494 Enterprise Tape Library:

Baud rate: 9600

Data bits: 8

Stop bits: 1

Parity: None

Login: Disabled

SGI IRIX 3494 Enterprise Tape Library Driver

256 IBM Tape Device Drivers Installation and User’s Guide

Page 275: IBM Tape Driver IUG 1

Defining the Library Device to the lmcpdAfter the 3494 Enterprise Tape Library Daemon for SGI IRIX is installed, configurethe attached Tape Libraries and start the daemon. Define the library devices to thedaemon by editing the /etc/ibmatl.conf file. The format of the file is:Symbolic name Connection type Identifier Alternate LAN Connection

Symbolic name is used to identify each tape library. The symbolic names must beunique across all libraries defined in the ibmatl.conf file.

Connection type is used to define the type of connection to the library (either RS-232or TCP/IP). For RS-232 connections, this type is the device special file name of theTTY device (for example, /dev/ttyd1). For TCP/IP connections, this type is the IPaddress of the Enterprise Library Manager. If the Library has a dual LAN cardinstalled, the second IP address of the dual LAN card should be entered after thefirst IP address.

Identifier is used to specify a name by which the library manager identifies the hostsystem. This identifier has a maximum length of eight characters. The symbolicnetwork name of the host is usually the best name to use (although any name isacceptable). This parameter is used only to identify a particular host to theEnterprise Library Manager.

Alternate LAN Connection is used to specify an alternate IP address for anEnterprise High Availability LAN-attached configuration. If the High AvailabilityLibrary has a dual LAN card installed, the second IP address of the dual LAN cardshould 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 proceed over the single serial line.

The following examples show how to define the library name:tire /dev/ttyd2 sitlab1

This stanza defines the tire library that is connected by /dev/ttyd2 (com2) to theworkstation. For example:3494a 9.115.32.100 jupiter

Note: The ttydn name is usually the special file name for a standard serial port onIRIX, where: n is the com port number. For additional information, refer tothe IRIX documentation.

This stanza defines the 3494a library that is connected to the host. The address ofthe Enterprise Library Manager is 9.115.32.100. The tape library uses the jupiteridentifier for the host. For example:libmgrc9 9.115.32.100 jupiter 9.115.23.54

This stanza defines the libmgrc9 library that is connected through TCP/IP to theworkstation. The IP addresses of the dual library managers are 9.115.32.100 and9.115.23.54.libmgrc7 9.115.32.21 9.115.32.22 mercury

This stanza defines libmgrc7 with a dual LAN card connected through TCP/IP tothe workstation. The first address of the Library Manager on the 3494 Tape Libraryis 9.115.32.21 and the second address is 9.115.32.22. The library uses the mercuryidentifier for the host.

SGI IRIX 3494 Enterprise Tape Library Driver

Chapter 9. 3494 Enterprise Tape Library Support 257

Page 276: IBM Tape Driver IUG 1

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 cardsconnected through TCP/IP to the workstation. The IP addresses of the first LibraryManager are 9.115.32.21 and 9.115.32.22. The IP addresses of the second LibraryManager are 9.115.26.13 and 9.115.26.14. The library uses the mercury identifier forthe host.

Starting the 3494 Enterprise Tape Library DaemonStart the 3494 Enterprise Tape Library Daemon for SGI IRIX by either restartingyour computer or starting it manually from a command prompt by entering:/etc/lmcpd

Problem DeterminationA set of tools is provided with the software to determine if thelmcpd is functioningcorrectly.

Daemon Trace Facility: The following trace facility is available for the lmcpddaemon: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-outtrcatl -l libmgrc7

Note: The -a argument takes precedence over the -l argument.

SGI IRIX 3494 Enterprise Tape Library Driver

258 IBM Tape Device Drivers Installation and User’s Guide

Page 277: IBM Tape Driver IUG 1

Chapter 10. IBM Tape Diagnostic Tool (ITDT)

Purpose . . . . . . . . . . . . . . . 260Accessing ITDT . . . . . . . . . . . . 262Supported Systems . . . . . . . . . . . 262

Standard Edition (ITDT-SE). . . . . . . . 262Graphical Edition (ITDT-GE) . . . . . . . 263

Supported Equipment . . . . . . . . . . 263Standard Edition - Installation . . . . . . . . 264

Installing ITDT-SE on Windows OperatingSystems . . . . . . . . . . . . . . 264Installing ITDT-SE on i5/OS Operating Systems 264Installing ITDT-SE on Other SupportedOperating Systems . . . . . . . . . . 267

Standard Edition - Initial Startup . . . . . . . 267Starting ITDT-SE on Solaris Operating Systems 267Starting ITDT-SE on Windows OperatingSystems . . . . . . . . . . . . . . 269Starting ITDT-SE on i5/OS Operating Systems 269Starting ITDT-SE on Other Supported OperatingSystems . . . . . . . . . . . . . . 270

Standard Edition - Known Issues and Limitations 270AIX Operating Systems . . . . . . . . . 270HP-UX Operating Systems . . . . . . . . 271Linux Operating Systems . . . . . . . . 271Solaris Operating Systems . . . . . . . . 271Windows Operating Systems . . . . . . . 272i5/OS Operating Systems . . . . . . . . 272All Supported Operating Systems . . . . . 273

Standard Edition - Start Menu Commands . . . 274Standard Edition - Scan Menu Commands. . . . 274

Scan . . . . . . . . . . . . . . . 276Test. . . . . . . . . . . . . . . . 277Dump . . . . . . . . . . . . . . . 279Firmware Update . . . . . . . . . . . 280Encryption . . . . . . . . . . . . . 283Full Write . . . . . . . . . . . . . 285Tape Usage . . . . . . . . . . . . . 286Other . . . . . . . . . . . . . . . 287System Test . . . . . . . . . . . . . 287Library Self-Test . . . . . . . . . . . 289Manual Inspect . . . . . . . . . . . . 289Return. . . . . . . . . . . . . . . 290

Standard Edition - Tapeutil Menu Commands . . 290[1] Open a Device . . . . . . . . . . . 291[2] Close a Device . . . . . . . . . . . 291[3] Inquiry . . . . . . . . . . . . . 291[4] Test Unit Ready . . . . . . . . . . 291[5] Reserve Device. . . . . . . . . . . 291[6] Release Device . . . . . . . . . . . 291[7] Request Sense . . . . . . . . . . . 291[8] Log Sense . . . . . . . . . . . . 292[9] Mode Sense . . . . . . . . . . . . 292[10] Query Driver Ver. (Version) . . . . . . 292[11] Display All Paths . . . . . . . . . 292[20] Rewind . . . . . . . . . . . . . 292[21] Forward Space File Marks . . . . . . 292[22] Backward Space File Marks . . . . . . 292

[23] Forward Space Records . . . . . . . 292[24] Backward Space Records . . . . . . . 292[25] Space to End of Data . . . . . . . . 293[26] Read and Write Tests . . . . . . . . 293[27] Read or Write Files . . . . . . . . . 293[28] Erase. . . . . . . . . . . . . . 293[29] Load Tape . . . . . . . . . . . . 293[30] Unload Tape . . . . . . . . . . . 293[31] Write File Marks . . . . . . . . . . 294[32] Synchronize Buffers . . . . . . . . . 294[33] Query/Set Parameter . . . . . . . . 294[34] Query/Set Tape Position . . . . . . . 294[35] Query Encryption Status . . . . . . . 294[36] Display Message . . . . . . . . . . 294[37] Report Density Supp (Support) . . . . . 294[38] Test Encryp. Path (Test Encryption KeyPath/Setup) . . . . . . . . . . . . . 295[50] Element Information . . . . . . . . 295[51] Position to Element . . . . . . . . . 295[52] Element Inventory . . . . . . . . . 295[53] Exchange Medium . . . . . . . . . 296[54] Move Medium . . . . . . . . . . 296[55] Initialize Element Status . . . . . . . 296[56] Prevent/Allow Medium Removal . . . . 296[57] Initialize Element Status Range . . . . . 296[58] Read Device IDs . . . . . . . . . . 296[59] Read Cartridge Location . . . . . . . 296[70] Dump/Force Dump/Dump . . . . . . 297[71] Firmware Update . . . . . . . . . 297

Standard Edition - Tapeutil Scripting Commands 297allow . . . . . . . . . . . . . . . 299devinfo . . . . . . . . . . . . . . 299inquiry . . . . . . . . . . . . . . 300logpage . . . . . . . . . . . . . . 300loop . . . . . . . . . . . . . . . 300modepage . . . . . . . . . . . . . 300prevent . . . . . . . . . . . . . . 300print . . . . . . . . . . . . . . . 300qrypath . . . . . . . . . . . . . . 301qryversion . . . . . . . . . . . . . 301release. . . . . . . . . . . . . . . 301reqsense . . . . . . . . . . . . . . 301reserve . . . . . . . . . . . . . . 301resetdrive . . . . . . . . . . . . . 302sleep . . . . . . . . . . . . . . . 302tur . . . . . . . . . . . . . . . . 302vpd . . . . . . . . . . . . . . . 302append . . . . . . . . . . . . . . 302bsf . . . . . . . . . . . . . . . . 302bsr . . . . . . . . . . . . . . . . 303density . . . . . . . . . . . . . . 303display . . . . . . . . . . . . . . 303erase . . . . . . . . . . . . . . . 303fsf . . . . . . . . . . . . . . . . 303fsr . . . . . . . . . . . . . . . . 304getparms . . . . . . . . . . . . . . 304

© Copyright IBM Corp. 2007, 2009 259

||||||||||||||||||||||||||||||||||||||||||||||||||||||

Page 278: IBM Tape Driver IUG 1

load . . . . . . . . . . . . . . . 304logsense . . . . . . . . . . . . . . 304qrypos. . . . . . . . . . . . . . . 304read . . . . . . . . . . . . . . . 304rewind . . . . . . . . . . . . . . 305rtest . . . . . . . . . . . . . . . 305rwtest . . . . . . . . . . . . . . . 305seod . . . . . . . . . . . . . . . 305setparm . . . . . . . . . . . . . . 306setpos . . . . . . . . . . . . . . . 306sync . . . . . . . . . . . . . . . 307unload . . . . . . . . . . . . . . 307weof . . . . . . . . . . . . . . . 307write . . . . . . . . . . . . . . . 307wtest . . . . . . . . . . . . . . . 307audit . . . . . . . . . . . . . . . 308cartridgelocation . . . . . . . . . . . 308elementinfo . . . . . . . . . . . . . 308exchange . . . . . . . . . . . . . . 308inventory. . . . . . . . . . . . . . 309move . . . . . . . . . . . . . . . 309position . . . . . . . . . . . . . . 309dump . . . . . . . . . . . . . . . 309ekmtest . . . . . . . . . . . . . . 309encryption . . . . . . . . . . . . . 310ucode . . . . . . . . . . . . . . . 310Deprecated Commands . . . . . . . . . 310Standard Edition Scripting Commands: KnownLimitations and Deviations . . . . . . . . 311

Graphical Edition - Installation . . . . . . . 312Windows . . . . . . . . . . . . . . 312Linux . . . . . . . . . . . . . . . 312

Graphical Edition - Known Issues and Limitations 313Linux . . . . . . . . . . . . . . . 313Windows . . . . . . . . . . . . . . 314All Supported Operating Systems . . . . . 314

Graphical Edition - User Interface Description . . 314Graphical Edition - Scan Menu Commands . . . 317

Scan . . . . . . . . . . . . . . . 318Test. . . . . . . . . . . . . . . . 319Dump . . . . . . . . . . . . . . . 321Firmware Update . . . . . . . . . . . 322Encryption . . . . . . . . . . . . . 323Full Write . . . . . . . . . . . . . 324Tape Usage . . . . . . . . . . . . . 326System Test . . . . . . . . . . . . . 326

Library Diagnostic Self-Test. . . . . . . . 327Manual Inspection Record Entry . . . . . . 327

Graphical Edition - Tapeutil Menu Commands . . 328Open . . . . . . . . . . . . . . . 331Close . . . . . . . . . . . . . . . 331Inquiry . . . . . . . . . . . . . . 332Test Unit Ready . . . . . . . . . . . 332Reserve Device . . . . . . . . . . . . 332Release Device . . . . . . . . . . . . 332Request Sense . . . . . . . . . . . . 332Log Sense . . . . . . . . . . . . . 332Mode Sense . . . . . . . . . . . . . 332Query Driver Version. . . . . . . . . . 332Display All Paths . . . . . . . . . . . 332Rewind . . . . . . . . . . . . . . 333Forward Space Filemarks . . . . . . . . 333Backward Space Filemarks . . . . . . . . 333Forward Space Records . . . . . . . . . 333Backward Space Records . . . . . . . . 333Space to End of Data . . . . . . . . . . 333Read and Write Tests . . . . . . . . . . 333Read or Write Files . . . . . . . . . . 335Erase . . . . . . . . . . . . . . . 336Load Tape . . . . . . . . . . . . . 336Unload Tape. . . . . . . . . . . . . 336Write Filemarks . . . . . . . . . . . 336Synchronize Buffers . . . . . . . . . . 336Query/Set Parameter . . . . . . . . . . 336Query/Set Position . . . . . . . . . . 336Query Encryption Status . . . . . . . . 337Display Message . . . . . . . . . . . 337Report Density Support . . . . . . . . . 337Test Encryption Path . . . . . . . . . . 338Element Information . . . . . . . . . . 338Position to Element . . . . . . . . . . 338Element Inventory. . . . . . . . . . . 338Exchange Medium. . . . . . . . . . . 338Move Medium . . . . . . . . . . . . 338Initialize Element Status . . . . . . . . . 339Prevent/Allow Medium Removal . . . . . 339Initialize Element Status Range . . . . . . 339Read Device IDs . . . . . . . . . . . 339Read Cartridge Location. . . . . . . . . 339Dump/Force Dump/Dump . . . . . . . 339Firmware Update . . . . . . . . . . . 340

This chapter describes the IBM Tape Diagnostic Tool.

PurposeThe 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

IBM Tape Diagnostic Tool

260 IBM Tape Device Drivers Installation and User’s Guide

|||||||||||||||||||||||||||||||||||||||||||||||||||||||||

||||

||||

Page 279: IBM Tape Driver IUG 1

Both versions provide the user with a single diagnostic program for tapeutilapplications. Both SE and GE contain tapeutil functionality with SE also providingscripting capability.

Note: The term tapeutil is a synonym for the tool that is delivered with the devicedriver. For example, this tool is named tapeutil on Unix operating systems; itis named ntutil on Microsoft Windows operating systems.

The available advanced operations provided by the IBM Tape Diagnostic Tool canbe performed on Tape Drives and Tape Libraries. By using this functionality, thecustomer can perform maintenance tasks and run diagnostic tasks to determinetape drive issues. This significantly reduces product downtime and increasesproductivity.

The IBM Tape Diagnostic Tool is designed to:v Run quick or extended diagnostics on tape drivesv Invoke tape library self-test operationsv Retrieve dumps from tape drives and librariesv Perform a firmware update on tape drives or librariesv Test the performance of the environment by completely writing a cartridge and

measuring performancev Verify tape drive compressionv Measure system performancev Retrieve and display cartridge usage informationv Verify the encryption environment

This test is used to verify if data on the cartridge was actually writtenencrypted.

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 properlyv 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 aselectable block size containing either compressible or incompressible data andthen outputs performance data.

Note: When this test is performed, all data on the cartridge is overwritten.v Perform a system test

Write different block sizes with compressible and incompressible data and thenoutputs performance data.

Note: When this test is performed, all data on the cartridge is overwritten.v Perform a tape usage function to retrieve statistical data and error countersv 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

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 261

Page 280: IBM Tape Driver IUG 1

available with ITDT-SE is identical across all supported operating systems (unless aparticular function is not available on a particular system).

Dedicated device drivers for tapes and libraries may be installed on the targetsystem and there is usually an application installed that uses the tape/librarydevices. When this configuration exists, ITDT-SE can coexist with the applicationso that when the application disables the device internally, ITDT-SE can performthe diagnostics on that device.

Accessing ITDTOne option to access ITDT is through the ftp web site: ftp://ftp.software.ibm.com/storage/ITDT/Current/.

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 SystemsITDT 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.2– 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.2.5 and later (64-bit x64)– Linux systems with Kernel 2.6, glibc 2.2.5 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 Solaris operating systems– Solaris Version 9 and 10 (64-bit SPARC)

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 V6R1 (iSeries/System i)

IBM Tape Diagnostic Tool

262 IBM Tape Device Drivers Installation and User’s Guide

Page 281: IBM Tape Driver IUG 1

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 EquipmentThe following equipment is supported for both the Standard Edition (ITDT-SE) andthe Graphical Edition (ITDT-GE):v IBM Ultrium 3580 Tape Drive (Generation 3 and 4)v IBM Ultrium Tape Drives T800/F, T800V, T1600/Fv IBM System Storage 3588/TS1030 model F3A and F3B Tape Drivev IBM System Storage 3588/TS1040 model F4A Tape Drivev IBM System Storage 3580 Half Height/TS2230 and TS2240 Tape Drive Expressv IBM System Storage TS2340 Tape Drive Expressv IBM 3592/TS1120/TS1130 Enterprise Tape Systemv IBM System Storage 3572/TS2900 Tape Autoloader Expressv IBM System Storage 3573/TS3100 and TS3200 Tape Library Expressv IBM System Storage 3576/TS3310 Tape Libraryv IBM System Storage 3577/TS3400 Tape Libraryv IBM System Storage 3584/TS3500 Tape Library

The following equipment are supported System x LTO Tape drives. These drivesare not tested by the IBM System Storage Test Lab. They are also not supported byIBM System Storage support. All queries are to be addressed to IBM System xsupport.v IBM Full High LTO Gen 1, p/n 00N8016, replacement p/n 37L5799v IBM Full High LTO Gen 2, p/n 59P6744, replacement p/n 71P9141v IBM Full High LTO Gen 3, p/n 25R0012 and 39M5657, replacement p/n 25R0003

and 23R4808v IBM Half High LTO Gen 3, p/n 43W8478, replacement p/n 23R7036v IBM Half High LTO Gen 4, p/n 44E8895, replacement p/n 45E1125v 3600-XXX Library and Autoloader IBM Full High LTO Gen 1, p/n 09N4048v 4560-SLX IBM Full High LTO Gen 2, p/n 71P9146v 3623-2LX IBM Full High LTO Gen 2v 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)

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

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 263

Page 282: IBM Tape Driver IUG 1

For i5/OS operating systems, see “i5/OS Operating Systems” on page 272 forproduct support limitations.

Standard Edition - InstallationThis section describes the installation procedures for the Standard Edition of ITDTin various operating systems.

Attention:

Before using the IBM Tape Diagnostic Tool Standard Edition (ITDT-SE) with theIBM Tape Device Driver, we recommend upgrading to the latest available IBMTape 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 noeffect on the [U] Tapeutil option commands; they will still use the IBM TapeDevice Driver if it is installed.

In a System Managed Encryption setup, the [E] Encryption test will always exitwith NO DRIVER SPECIAL FILE when ITDT-SE is started with -force-generic-dd.

Installing ITDT-SE on Windows Operating SystemsTo 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 SystemsITDT-SE for i5/OS or IBM i will be installed using a graphical installer based onthe InstallAnywhere installation software that needs to be executed on a MicrosoftWindows system and will install the software onto the remote i5/OS system. Theinstaller will generate installation information on the local Microsoft Windowssystem so that the program can be removed from the remote i5/OS system byrunning 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 runtime1.4.2 or higher.

1. Start the installer itdtinst<version>I5OS.exe.2. Read through the welcome and license screens.

IBM Tape Diagnostic Tool

264 IBM Tape Device Drivers Installation and User’s Guide

Page 283: IBM Tape Driver IUG 1

3. Accept the License Agreement, then click the Next button.

4. Enter your i5/OS system hostname or IP address and administrator credentials.Start the installation by pressing the Install button. Click the Done buttonwhen the installation is complete.

a2500246

Figure 67. Welcome/Startup screen

a2500247

Figure 68. License screen

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 265

Page 284: IBM Tape Driver IUG 1

Note: The user name should be QSECOFR.

a2500248

Figure 69. Machine credentials screen

a2500249

Figure 70. Installation progress screen

IBM Tape Diagnostic Tool

266 IBM Tape Device Drivers Installation and User’s Guide

Page 285: IBM Tape Driver IUG 1

Installing ITDT-SE on Other Supported Operating SystemsTo install ITDT-SE on other supported operating systems, perform the followingsteps:

Note: ITDT-SE can only be used by a user with root access rights.1. Download itdtinst<version><OS> to a directory of your choice.v itdtinst<version>Aix is for AIX operating systemsv itdtinst<version>LinuxX86 is for Linux operating systems on Intel hardwarev itdtinst<version>LinuxPPC is for Linux operating systems on pSeriesv itdtinst<version>LinuxS390X is for Linux operating systems on zSeriesv itdtinst<version>Hpux is for HP-UX 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>

Standard Edition - Initial StartupThis section describes the startup procedures for the Standard Edition of ITDT invarious operating systems.

Starting ITDT-SE on Solaris Operating Systems1. If the IBM Tape Device Driver is not used or not installed, then configure the

sgen driver.

a2500250

Figure 71. Installation complete screen

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 267

Page 286: IBM Tape Driver IUG 1

A script sgen_solaris_conf.sh is included in the ITDT-SE package. This scriptallows the user to configure the sgen generic SCSI driver that is shipped withSun Solaris.ITDT-SE requires that the sgen device driver is configured so that the devicesyou want to work with can be found.

Note: For system security reasons, always reset the sgen device driver settingsafter you finish working with ITDT-SE, using the sgen_solaris_conf.shscript.

To configure the sgen driver, start the sgen_solaris_conf.sh script with rootaccess.The following command line options are available on the SGEN driverconfiguration 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).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 Configurationscreen. 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 theneed 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 theneed 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 tothe main menu.

4. On the SGEN driver configuration screen enter command line option 5). Thisoption starts the sgen driver, new devices are found using the definitionsperformed in Step 2.

5. After the new devices are found, enter option 6) to exit thesgen_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.conffile. This task needs to be done manually, it is not performed by using thesgen_solaris_conf.sh script.

IBM Tape Diagnostic Tool

268 IBM Tape Device Drivers Installation and User’s Guide

Page 287: IBM Tape Driver IUG 1

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 configuredc4::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 Updatev 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 SystemsStart ITDT by executing the following command:itdt.exe

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.

At first program startup, the license text will be displayed and the input andoutput directories will be created. ITDT-SE does not create any registry entries ormake changes outside the installation directory.v Input directory: default directory for firmware files during Firmware Updatev Output directory: directory containing the result files, dump files and log files

after running tests

Starting ITDT-SE on i5/OS Operating SystemsTo use ITDT-SE to update firmware or pull dumps from a Tape Drive inside a TapeLibrary, make sure the drives are varied online in STANDALONE MODE byperforming 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.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 269

Page 288: IBM Tape Driver IUG 1

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 on page 269, (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 280 and“Dump” on page 279.

9. When firmware updates and dumps are complete, enter the followingcommand: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 SystemsTo 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 Updatev 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.

Standard Edition - Known Issues and LimitationsThis section describes the known issues and limitations of the ITDT-SE program.

AIX Operating SystemsThe following are the known scan limitations:v Only devices that have the device state ″available″.

IBM Tape Diagnostic Tool

270 IBM Tape Device Drivers Installation and User’s Guide

Page 289: IBM Tape Driver IUG 1

For FC and SAS devices, ID and LUN greater than 999 won’t be displayed, theywill be masked by ###.

When logged in via telnet, backspace may not be working - an escape sequence isinserted and the input is ignored after Enter is pressed.

HP-UX Operating SystemsVerify 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 emulates32-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] FirmwareUpdate on the controlling drive. We recommend to perform repeated [S] Scanoperations to make the library reappear in the device list.

Linux Operating SystemsITDT-SE on Linux requires glibc 2.2.5 or later.

Note: On a SLES9 s390x (64bit) configuration, you may experience a SCSI CMDTIMEOUT when running the [T] option while using the IBM Tape DeviceDriver.

For SUSE SLES9 on zSeries please ensure that the kernel update SUSE-SA:2007:035is installed.

Solaris Operating SystemsRescan may take 6-8 minutes, depending on the numbers of host adapters anddevices 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 notbe found during scan although they are configured in sgen.conf. When this eventoccurs, 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 sgenand containing identification of your drives and changers. Examples:

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 271

Page 290: IBM Tape Driver IUG 1

#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 enteringthe following command:

# cfgadm -al

If the tape drive is claimed by st device driver, an entry with cxx:rmt/y, isdisplayed, 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 followingcommand:

# cfgadm -al

6. If the drives or changers are not listed in the output of 'cfgadm -al', rebootthe system and verify the list of configured devices with the command:

# cfgadm -al

Windows Operating SystemsAfter a firmware update, devices may disappear. This is a known Windowsproblem.

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 ESCcharacter may appear on the input line, when this occurs, the input is ignored afterpressing the Enter key.

If you are using Adaptec SCSI Host Bus Adapters, ensure that you are using thelatest Adaptec Host Bus Adapter Drivers instead of the drivers shipped with theWindows operating system.

On Microsoft Windows systems where the maximum transfer size is limited to lessthan 64kB, the Dump and Firmware update operations will not work.

i5/OS Operating SystemsITDT-SE on i5/OS supports only tape drives; it does not support autoloaders andlibraries. Media changers and media changer operations are not supported withthis release of ITDT-SE. To test a tape drive inside a library, the cartridge must beimported manually before starting the Device Test.

IBM Tape Diagnostic Tool

272 IBM Tape Device Drivers Installation and User’s Guide

||

Page 291: IBM Tape Driver IUG 1

The Tape Drive must be varied online. If the Tape Drive is operated through aTape Library, the Library must be varied offline. See “Starting ITDT-SE on i5/OSOperating Systems” on page 269 for details.

As the Library is varied offline, the Encryption Test does not deliver decrypteddata 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 theunderlying operations require the IBM Tape Device Driver to be installed.

FC 5912 SAS HBA support is only for Power6 and V6R1 configurations attached toLTO Gen 4 HH tape drives (No support for LTO 3 HH SAS).

All Supported Operating SystemsThis section describes the known issues and limitations of the ITDT-SE program onall other supported operating systems.

A time-out may occur when using cartridgelocation in script mode should arequest for more than 5000 elements be made. This will prevent any data to beoutput.

Prevent/Allow Medium Removal is missing as a Tape Drive option, but can stillbe performed by using the [56] Prevent/Allow Medium Removal option for TapeLibraries while the tape device is opened.

User Interface IssuesIf you press the arrow keys on most Unix operating system consoles, the input isignored after pressing the Enter key.

When the Tab key is pressed as an input string for field data, the user interface iscorrupted.

Make sure that field input does not start with a number followed by space andadditional text as this is interpreted as an entry to a specific row in the field. Toavoid this, use an underscore character ( _ ) instead of the space character.

Command TimeoutThere is no instant operation termination upon SCSI command timeout; forexample, when the SCSI cable is unplugged after starting POST A.

When a command timeout condition occurs, ITDT may still continue to performmore operations (like unmounting the cartridge) instead of instantly terminatingwith a timeout condition.

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

3494 Tape LibraryDrives in a 3494 tape library or an STK silo library are supported, only the [T] Testoption won’t work due to device-specific restrictions for handling cartridges.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 273

|||

Page 292: IBM Tape Driver IUG 1

Standard Edition - Start Menu CommandsAfter program startup, ITDT-SE displays the 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 MenuCommands”).

v U - TapeutilOpens the screen for the Tapeutil operation commands. These commands are thestandardized tapeutil functions with most of the options available that wereavailable with the previous tapeutil functions (refer to “Standard Edition -Tapeutil Menu Commands” on page 290).

v H - HelpHelp starts and displays the available online help.

v Q - QuitQuits the function.

Standard Edition - Scan Menu CommandsWhen using ITDT-SE, after entering S on the start screen, the Scan function startsand 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.

a2500231

Figure 72. Start Screen Menu

IBM Tape Diagnostic Tool

274 IBM Tape Device Drivers Installation and User’s Guide

Page 293: IBM Tape Driver IUG 1

The following commands are described in this section:v S - “Scan” on page 276v T - “Test” on page 277v D - “Dump” on page 279v F - “Firmware Update” on page 280v E - “Encryption” on page 283v W - “Full Write” on page 285v U - “Tape Usage” on page 286v O - “Other” on page 287

v Y - “System Test” on page 287v L - “Library Self-Test” on page 289v I - “Manual Inspect” on page 289v R - “Return” on page 290

a2500232

Figure 73. Scan Menu

a2500233

Figure 74. More Scan Options

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 275

Page 294: IBM Tape Driver IUG 1

ScanThe Scan function [S] is used to discover all supported tape and library devicesthat are attached to the computer system so that they can be selected for thesubsequent ITDT-SE operations. The scan function also serves as a connection testthat can be used to verify proper attachment of the devices.

Before continuing, make sure no other program is accessing the devices used byITDT-SE. For example, stop the backup jobs that are accessing the devices whenusing 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 thescan function.

Depending on the operating system and the number of attached drives, the scancan take several minutes. See “Standard Edition - Known Issues and Limitations”on page 270 for more details.

During the scan operation, a bar in the lower left edge of the screen shows that thescan operation is still in progress.

Once the scan is finished, the first device list screen is displayed.

The first device list screen shows all detected devices and the connectioninformation (host adapter number, bus number, SCSI/FCP ID and LUN) alongwith product data (Model name, Unit Serial number, Microcode revision). Fordrives that are attached to a library, the Changer column shows the serial numberof the changer the drive is attached to.

Scrollable data is indicated by "VVVVVVVVV" at the bottom of the screen. Toscroll 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 linesto scroll down then press the Enter key.

Name ofcurrent screen

Selected deviceDevice number

Command

Command prompt

a2500252

Figure 75. Device List Screen

IBM Tape Diagnostic Tool

276 IBM Tape Device Drivers Installation and User’s Guide

Page 295: IBM Tape Driver IUG 1

To scroll back, use - instead of +.

Note: For fast up (backward) scrolling, type - followed by a space and the numberof 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 267).

– Solaris 10, see (see “Standard Edition - Known Issues and Limitations” onpage 270)

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 DeviceDriver is installed, the generic device driver for the operating system is usedinstead. 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, startITDT-SE with the following command:itdt -force-generic-dd

Once the desired device is displayed, select the device for test. Only one device canbe selected.

TestThe Test function [T] checks if the tape device is defective and outputs a pass/failresult.

Attention: The test functionality erases user data on the cartridge that is used forthe 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 cartridgeis 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 Enterkey.

2. Type T followed by the Enter key to activate the test.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 277

Page 296: IBM Tape Driver IUG 1

If no cartridge is inserted, ITDT-SE prompts to insert a cartridge. Either insert acartridge and press the Enter key or stop the test by entering C followed by theEnter key.

Note: If ITDT-SE detects data on the cartridge, the Device Test screen displays amessage (as shown in Figure 76).

Type Y followed by the Enter key to continue the test if you are absolutelysure that data on the cartridge can be overwritten. If you are unsure, type Nfollowed by the Enter key to stop the test.

During the test, the program shows a progress indicator in form of a bar of hashmarks (#) (�1�) that shows the progress of a single sub-test as well as a descriptionof that sub-test.

The test sequence contains the following steps:1. Mount Medium2. [Medium Qualification] – only if the previous step indicated this requirement3. Load/Unload Cycles (�2�)4. POST A

a2500234

Figure 76. Data Delete Question

a2500235

1 2

Figure 77. Test Running

IBM Tape Diagnostic Tool

278 IBM Tape Device Drivers Installation and User’s Guide

Page 297: IBM Tape Driver IUG 1

During POST A stopping the test is not allowed.5. Performance Test6. Unmount Medium7. Get FSC8. Get Logs

The test can be stopped by typing A followed by the Enter key at any time exceptduring the POST tests, which are not interruptible.

Note: It may take some time until the test actually stops.

When all sub-tests are finished, ITDT-SE shows a screen that displays theattachment and device information as in the first device list screen, together withthe test result and failure information in the code field. The screen also shows theoutput files that were generated during the test run. The files may be requested bythe IBM Support Center.

If you want to use other ITDT-SE functions, type R followed by the Enter key toreturn to the first device list screen; otherwise, type Q followed by the Enter key toexit the program.

DumpPerform the following to start the Dump [D] process:1. Start ITDT-SE, then type S and press the Enter key to scan for the devices.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).

a2500236

Figure 78. Test Results

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 279

Page 298: IBM Tape Driver IUG 1

When the dump process is performed on a tape library or autoloader other thanthe 3584/TS3500, the Dump function stores one log file in the output folder of theprogram (*.blz). For the 3584/TS3500, a dump file (*.a.gz) will be stored in theoutput folder.

Note: When the Dump function is performed for tape libraries or autoloadersother than the 3584/TS3500, the Log file only contains Log Sense and ModeSense pages, while a Drive or 3584/TS3500 Dump contains much morediagnostic information.

Retrieve the files from the ITDT-SE output subdirectory that was created duringthe installation. The following are examples of the directory:v Example output directory (Windows): c:\itdt\outputv Example output directory (Unix): /home/user/itdt/outputv Example output directory (i5/OS): /home/itdt/output

(On the IFS) use FTP or the i-Series Navigator to transfer the file

If you want to use other ITDT-SE functions, type R followed by the Enter key toreturn to the device list; otherwise, type Q followed by the Enter key to exit theprogram.

Firmware UpdateThe Firmware Update [U] upgrades the firmware of tape drives and tape libraries.See “Supported Equipment” on page 263 for a list of supported products.

Note: See “3576/TS3310 Tape Library” on page 273 for more information on howto update the firmware on a 3576/TS3310 Tape Library.

a2500237

Dump Filenames

Log Filenames

Figure 79. Dump

IBM Tape Diagnostic Tool

280 IBM Tape Device Drivers Installation and User’s Guide

Page 299: IBM Tape Driver IUG 1

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 theinstallation. 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:1. Start ITDT-SE, then type S and press the Enter key to scan for the devices.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 theEnter key.

v If the firmware file is stored in a directory other than the one displayed inFW Dir, then type F followed by a space and the fully qualified path to thedirectory 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 theright side of the screen. It indicates true if the directory exists, falseotherwise.

v If the content of the displayed FW Dir has changed, type D and press theEnter key to refresh the directory content.

a2500251

Figure 80. Firmware Update screen

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 281

Page 300: IBM Tape Driver IUG 1

Note: The selected filename is reset to the first item (#0) after using theRefresh function.

v If the displayed directory contains more files than those shown, type + andpress 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 theEnter key. To scroll back, use - instead of +.Scrollable data is indicated by "VVVVVVVVVVVVVVVVV".

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

Note: The selected filename is reset to the first item in the list whenreturning to that dialog from the Start Update dialog.

7. If you decide to run the firmware update, type S and press the Enter key tostart 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 45minutes for libraries. If you decide not to run the firmware update, type R andpress the Enter key to return to the Device List.

Note: If ITDT-SE detects a FIPS-certified drive firmware, it displays a warningdialog. Before continuing, ensure that you use a FIPS-certified firmwareto update the drive.

8. After completion, the Status field on the bottom right side indicates PASSED ifthe firmware was updated successfully and FAILED otherwise.Type R and press the Enter key to return to the Device List.

VVVVV = More data

a2500253

Figure 81. Scrollable Data screen

IBM Tape Diagnostic Tool

282 IBM Tape Device Drivers Installation and User’s Guide

Page 301: IBM Tape Driver IUG 1

EncryptionThe Encryption [E] function is used to verify if data on the cartridge was actuallywritten encrypted. It reads both decrypted and raw data from the cartridge intotwo separate files on disk. The user can then verify that the data differs to ensurethat encryption worked.

The Encryption function does not provide a Write - Read test.

The Encryption function is only supported on encryption enabled drives andrequires 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 datav Library Managedv Application Managed: Only raw encrypted data will be read (result file *.ENC)

Note: On i5/OS, media changers and media changer operations are not supportedwith this release of ITDT-SE. To test a tape drive inside a library, the TapeDrive must be varied online and the Tape Library must be varied offline(see “Starting ITDT-SE on i5/OS Operating Systems” on page 269 fordetails). As the Library is varied offline, the Encryption function does notdeliver decrypted data in a Library Managed Encryption environment.

1. After starting ITDT-SE, type S followed by the Enter key to activate the devicescan.

2. Select the device you want to test by entering its number and press the Enterkey. 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, thesystem requires the entry of the number of the start record and the amount ofdata (in KB) to be read.

4. Type S followed by a space and the start record number, then press the Enterkey to enter the start record number. Type L followed by a blank and the datalength, then press the Enter key to enter the data length, maximum 100000 KB.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 283

Page 302: IBM Tape Driver IUG 1

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 barof hash marks (#) that shows the progress of a single sub-test as well asinformation about that sub-test.The Encryption function can be stopped by typing A followed by the Enter keyat 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 theStatus field on the bottom left side that indicates PASSED if the encrypted testcompleted successfully and ABORTED otherwise.

The screen also shows the output files that were generated during the Encryptionfunction:v file serial# .n.ENC contains the raw encrypted datav file serial# .n.DEC contains the decrypted data

Table 30 defines the abort codes.

Table 30. Definitions of Abort Codes

ABORT CODE ROOT CAUSE

LOCATE FAILED Start position as requested by the user could not bereached

MEDIUM NOT ENCRYPTED ITDT detected medium as non-encrypted

NO DRIVER SPECIAL FILE System-Managed environment, but generic device fileis 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 amountof data could be read

a2500245

Figure 82. Encryption Start screen

IBM Tape Diagnostic Tool

284 IBM Tape Device Drivers Installation and User’s Guide

|

Page 303: IBM Tape Driver IUG 1

Table 30. Definitions of Abort Codes (continued)

ABORT CODE ROOT CAUSE

END OF DATA End of data encountered before the given amount ofdata could be read

READ FAILED

ENCRYPTION ERROR

INVALID PARAMETER User entered data length of 0kB

If you want to use other ITDT-SE functions, type R followed by the Enter key toreturn to the device list; otherwise, type Q followed by the Enter key to exit theprogram.

Full WriteThe Full Write [F] function writes the entire cartridge with a given block size eitherwith compressible or incompressible data and output performance data.

Attention: The Full Write function erases data on the cartridge that is used forthe test.

Notes:

1. The Full Write function takes approximately 2 hours when writingincompressible data, less time for compressible data.

2. The Full Write function runs only on tape drives, not on autoloaders orlibraries.

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 runwith compressible data, the output shows the compression rate. If thecompression rate is higher than 1.0 but the system does not appear to be able tocompress data on the cartridge, then check the device driver and softwaresettings to see if they disable compression.

1. After starting ITDT-SE, type S followed by the Enter key to activate the devicescan.

2. Select the device you want to write to by entering its number and press theEnter 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 theEnter 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 areabsolutely sure that data on the cartridge can be overwritten. If you areunsure, type N followed by the Enter key to stop the test.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 285

Page 304: IBM Tape Driver IUG 1

3. The system prompts for entry of a transfer size between 16 KB and themaximum block size supported by the system (maximum possible value is 512KB) . This is a check for the type of supported block size is performed. Enterthe 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 barof 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 anytime.

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 thecompression ratio (�1�) and the write performance (shown in �2� as the DataRate) for the selected block size. If an error occurred during the full write, datais only written partially.If you want to use other ITDT-SE functions, type R followed by the Enter keyto return to option 4 the device list; otherwise, type Q followed by the Enterkey to exit the program.

Tape UsageThe Tape Usage [U] function retrieves statistical data and error counters from acartridge.

1

2

a2500243

Figure 83. Full Write Results

IBM Tape Diagnostic Tool

286 IBM Tape Device Drivers Installation and User’s Guide

Page 305: IBM Tape Driver IUG 1

1. After starting ITDT-SE, type S followed by the Enter key to activate the devicescan.

2. Select the device you want to test by entering its number and press the Enterkey.

3. Type U followed by the Enter key to start the tape usage log retrieval. ITDT-SEthen switches to the tape usage screen. If no cartridge is inserted, ITDT-SEprompts to insert a cartridge. Either insert a cartridge and press the Enter keyor 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 abar of hash marks (#) that shows the progress of a single sub-operation as well as adescription 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 retrievalcompleted successfully and ABORTED otherwise.

OtherOther [O] - type O followed by the Enter key to display a screen with thefollowing commands:v “System Test”v “Library Self-Test” on page 289v “Manual Inspect” on page 289v “Return” on page 290

System TestThe 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. Toperform a System Test on tape drives within a library, the library must be in onlinemode.

a2500244

Figure 84. Tape Usage Screen

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 287

Page 306: IBM Tape Driver IUG 1

1. Start ITDT-SE, then type S and press the Enter key to scan for the devices.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 theEnter 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:Cartridge not empty!

Overwrite data?

Type Y followed by the Enter key to continue the test if you areabsolutely sure that data on the cartridge can be overwritten. If you areunsure, 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), firstwith incompressible, then with compressible data, and then displaysperformance data and progress screen.

c. At the end of the test, a summary screen is displayed.

The System Test can be stopped by typing A followed by the Enter key at anytime.

Note: It may take some time until the System Test actually stops.

If you want to use other ITDT-SE functions, type R followed by the Enter key toreturn to the device list; otherwise press Q followed by the Enter key to exit theprogram.

a2500245

Figure 85. System Test Results

IBM Tape Diagnostic Tool

288 IBM Tape Device Drivers Installation and User’s Guide

|

|

Page 307: IBM Tape Driver IUG 1

Library Self-TestThe Library Self-Test [L] starts and monitors the library-internal self-test. This testonly runs on libraries and autoloaders, not on tape drives.1. Start ITDT-SE, then type S and press the Enter key to scan for the devices.2. Type O and press the Enter key to display the second device list screen.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 isperformed.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 atany time.

Note: It may take some time until the Library Self-Test actually stops.

If you want to use other ITDT-SE functions, type R followed by the Enter key toreturn to the device list; otherwise press Q followed by the Enter key to exit theprogram.

Manual InspectManual Inspect [I] creates a manual inspection record if a device does not appearin the device list. This test is intended for devices that are not recognized or have atechnical problem which can not be determined by ITDT-SE.

If a tape drive cannot be identified using a device scan, the user can manuallycreate a test record for the drive. The system prompts for the user to run theSCSI/FC Wrap test for the drive (see the service manual for the drive). The resultsof 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 asthe output files generated by the test.1. Start ITDT-SE, then type S and press the Enter key to scan for the devices.2. Type O and press the Enter key to display the second device list screen.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

press the Enter key.c. Optionally, type A followed by a space and additional information text and

press the Enter key.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 furtheranalysis), and in a human-readable text file. Both files are stored in the ITDT-SEoutput folder.

If you want to use other ITDT-SE functions, type R followed by the Enter key toreturn to the first device list screen; otherwise press Q followed by the Enter key toexit the program.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 289

Page 308: IBM Tape Driver IUG 1

ReturnReturn [R] - type R followed by the Enter key to go back to the first device listscreen.

Standard Edition - Tapeutil Menu CommandsWhen the user executes the U command on the ITDT-SE start screen, the Tapeutiloperation screen is displayed.

Note: On any screen, to execute a command, press the shortkey displayed inbrackets [ ], followed by the Enter key.

The following commands are described in this section:v “[1] Open a Device” on page 291v “[2] Close a Device” on page 291v “[3] Inquiry” on page 291)v “[4] Test Unit Ready” on page 291v “[5] Reserve Device” on page 291v “[6] Release Device” on page 291v “[7] Request Sense” on page 291v “[8] Log Sense” on page 292v “[9] Mode Sense” on page 292v “[10] Query Driver Ver. (Version)” on page 292v “[11] Display All Paths” on page 292v “[20] Rewind” on page 292)v “[21] Forward Space File Marks” on page 292v “[24] Backward Space Records” on page 292v “[23] Forward Space Records” on page 292v “[22] Backward Space File Marks” on page 292v “[25] Space to End of Data” on page 293v “[26] Read and Write Tests” on page 293v “[27] Read or Write Files” on page 293v “[28] Erase” on page 293v “[29] Load Tape” on page 293v “[30] Unload Tape” on page 293v “[31] Write File Marks” on page 294v “[32] Synchronize Buffers” on page 294v “[33] Query/Set Parameter” on page 294v “[34] Query/Set Tape Position” on page 294v “[35] Query Encryption Status” on page 294v “[36] Display Message” on page 294v “[37] Report Density Supp (Support)” on page 294v “[38] Test Encryp. Path (Test Encryption Key Path/Setup)” on page 295v “[50] Element Information” on page 295v “[51] Position to Element” on page 295v “[52] Element Inventory” on page 295v “[53] Exchange Medium” on page 296

IBM Tape Diagnostic Tool

290 IBM Tape Device Drivers Installation and User’s Guide

Page 309: IBM Tape Driver IUG 1

v “[54] Move Medium” on page 296v “[55] Initialize Element Status” on page 296v “[56] Prevent/Allow Medium Removal” on page 296v “[55] Initialize Element Status” on page 296v “[58] Read Device IDs” on page 296v “[59] Read Cartridge Location” on page 296v “[70] Dump/Force Dump/Dump” on page 297v “[71] Firmware Update” on page 297

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

[3] InquiryWhen 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 ReadyWhen you select the Test Unit Ready (TUR) command [4], ITDT issues the TestUnit Ready ioctl command.

[5] Reserve DeviceWhen you select the Reserve Device command [5], ITDT issues a reserve commandfor the device.

[6] Release DeviceWhen you select the Release Device command [6], ITDT issues a release commandfor the device.

[7] Request SenseWhen 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.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 291

Page 310: IBM Tape Driver IUG 1

[8] Log SenseWhen 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 SenseWhen 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 PathsWhen you select the Display All Paths command [11]:1. ITDT issues an ioctl command.2. ITDT outputs decoded path information for all paths.

[20] RewindWhen you select the Rewind command [20], ITDT issues the ioctl rewind commandfor the device.

[21] Forward Space File MarksWhen 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 MarksWhen you select the Backward Space File Marks command [22]:1. You are prompted for the number of file marks.2. ITDT issues (extrinsic) ioctl command.

[23] Forward Space RecordsWhen you select the Forward Space Records command [23]:1. You are prompted for the number of records to space forward.2. ITDT issues (extrinsic) ioctl command.

[24] Backward Space RecordsWhen you select the Backward Space Records command [24]:1. You are prompted for the number of records to space backward.2. ITDT issues (extrinsic) ioctl command.

IBM Tape Diagnostic Tool

292 IBM Tape Device Drivers Installation and User’s Guide

Page 311: IBM Tape Driver IUG 1

[25] Space to End of DataWhen you select the Space to End of Data (EOD) command [25], ITDT issues the(extrinsic) ioctl command.

[26] Read and Write TestsWhen 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 usedfor this test, the number of records read/written, and the total bytes transferred.

[27] Read or Write FilesWhen 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 totalbytes transferred.

[28] EraseWhen you select the Erase command [28], ITDT issues the (extrinsic) ioctlcommand.

[29] Load TapeWhen you select the Load Tape command [29], ITDT issues the load tapecommand.

[30] Unload TapeWhen you select the Unload Tape command [30], ITDT issues the unload tapecommand.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 293

Page 312: IBM Tape Driver IUG 1

[31] Write File MarksWhen 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 BuffersWhen you select the Synchronize Buffers command [32], ITDT issues the ioctlcommand.

[33] Query/Set ParameterWhen 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 PositionWhen you select the Query/Set Tape Position command [34]:1. ITDT displays the current position2. You are prompted for a new position to set.3. ITDT issues the Set Position ioctl command.

[35] Query Encryption StatusWhen 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 MessageWhen 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 hasdisplay message capability since it is the only one with a display that is more than1 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.

IBM Tape Diagnostic Tool

294 IBM Tape Device Drivers Installation and User’s Guide

Page 313: IBM Tape Driver IUG 1

2. ITDT issues Report Density Support ioctl command to retrieve all supportedmedia.

3. ITDT prints all requested reports. Data is printed in a decoded way. Scroll thescreen to print each one of the following:v Density namev Assigning organizationv Descriptionv Primary density codev Secondary density codev Write OKv Duplicatev Defaultv Bits per MMv Media Widthv Tracksv Capacity (megabytes).

4. ITDT prints report status text for current media5. ITDT issues Report Density Support ioctl command to retrieve current media6. 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 tested2. ITDT issues the Encryption Diagnostics ioctl command, Ping Diag3. ITDT prints number of servers available or error message4. ITDT issues the Encryption Diagnostics ioctl command, Basic Encryption Diag5. ITDT prints completion code or error message6. ITDT issues the Encryption Diagnostics ioctl command, Full Encryption Diag7. ITDT prints completion code or error message.

[50] Element InformationWhen you select the Element Information command [50]:1. ITDT issues the ioctl command2. 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, firstdrive address.

[51] Position to ElementWhen you select the Position to Element command [51]:1. You are prompted for destination address2. ITDT issues the ioctl command.

[52] Element InventoryWhen you select the Element Inventory command [52]:1. ITDT issues the Element Info ioctl command.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 295

Page 314: IBM Tape Driver IUG 1

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 MediumWhen 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.4. ITDT issues the ioctl command.

[54] Move MediumWhen you select the Move Medium command [54]:1. You are prompted for source address.2. You are prompted for destination address.3. ITDT issues the ioctl command.

[55] Initialize Element StatusWhen you select the Initialize Element Status command [55]:1. ITDT prints command summary.2. ITDT issues the ioctl command.

[56] Prevent/Allow Medium RemovalWhen 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 RangeWhen 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.3. ITDT issues the ioctl command.

[58] Read Device IDsWhen you select the Read Device IDs command [58], ITDT retrieves the device IDinformation for all available drives and displays the information. Type n followedby Enter to show the next page.

[59] Read Cartridge LocationWhen 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.5. ITDT issues the Element Info ioctl command.6. ITDT verifies that the address range is valid; otherwise print error message and

exit.

IBM Tape Diagnostic Tool

296 IBM Tape Device Drivers Installation and User’s Guide

Page 315: IBM Tape Driver IUG 1

7. If no slots are found in Element Info data, print error message and exit.8. ITDT issues the READ_CARTRIDGE_LOCATION ioctl command.9. ITDT prints decoded storage element information, Type n followed by Enter to

show next page.

[70] Dump/Force Dump/DumpWhen 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 UpdateWhen 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 pressEnter 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 273 for more information onhow to update the firmware on a 3576/TS3310 Tape Library.

The following site is available for the latest firmware files:http://www.ibm.com/storage/lto.

Standard Edition - Tapeutil Scripting CommandsScripting has been enabled with the 4.0 release of ITDT SE. ITDT-SE providesbackward compatibility for existing tapeutil scripts. While some legacy commandsexists they will not be documented in their entirety as they will be phased out overtime. New scripts should always use those listed in this guide, the CommonCommand set (CS), and existing scripts need to be modified for forwardcompatibility with ITDT.

Following you will find a list of commands, on each command you will find thecommand, a description, parameter list, and which platforms are supported. Somecommands will have numbers after them, this means there is a correspondingmenu command in “Standard Edition - Tapeutil Menu Commands” on page 290.

The following are the generic invocation parameters as in use by the legacycommand sets:v -f Devicev Device Filename. Specify the device file, mandatory on all platforms

The calling convention for the Common Command set will be:itdt -f device Subcommand [Subcommand ...]

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 297

|

||||||

||||

||

|

|

|

|

Page 316: IBM Tape Driver IUG 1

The Open Mode flag is supported on all platforms. If the flag is not set, the devicewill be opened in read/write mode. Additional parameters that may be requiredfor opening the device will be automatically detected and set.

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 currentTapeutil conventions, but if there is different output for a single command onvarious platforms, the output will be implemented according to the AIX output asthe primary scripting platform.

Note that Tapeutil allowed undocumented abbreviations for some of thecommands, for example it was possible to shorten “inquiry” to “inq” or “inqu” or“inqui” and so on. The following command abbreviations will be supported withITDT-SE too: inq(uiry), req(sense), pos(ition), ele(mentinfo), inv(entory), devid(s),cartridge(location). For a list of available legacy commands on each of the differentplatforms, please reference Appendix D, “Tape Utility Programs,” on page 361 ifyou have any questions. A list of Deprecated Commands are below at “DeprecatedCommands” on page 310. Also there is a list of unsupported commands andknown exceptions at the end of this section in “Standard Edition ScriptingCommands: Known Limitations and Deviations” on page 311.

The following commands are described in these sections:

The General commands are:v “allow” on page 299v “devinfo” on page 299v “inquiry” on page 300v “logpage” on page 300v “loop” on page 300v “modepage” on page 300v “prevent” on page 300v “print” on page 300v “qrypath” on page 301v “qryversion” on page 301v “release” on page 301v “reqsense” on page 301v “reserve” on page 301v “resetdrive” on page 302v “sleep” on page 302v “tur” on page 302v “vpd” on page 302

The Tape commands are:v “append” on page 302v “bsf” on page 302v “bsr” on page 303v “density” on page 303v “display” on page 303v “erase” on page 303v “fsf” on page 303)

IBM Tape Diagnostic Tool

298 IBM Tape Device Drivers Installation and User’s Guide

|||

|||||

||||||||||

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

Page 317: IBM Tape Driver IUG 1

v “fsr” on page 304v “getparms” on page 304v “load” on page 304v “logsense” on page 304v “qrypos” on page 304v “read” on page 304v “rewind” on page 305v “rtest” on page 305v “rwtest” on page 305v “seod” on page 305v “setparm” on page 306v “setpos” on page 306v “sync” on page 307v “unload” on page 307v “weof” on page 307v “write” on page 307v “wtest” on page 307

The Medium Changer Subcommands are:v “audit” on page 308v “cartridgelocation” on page 308v “elementinfo” on page 308v “exchange” on page 308v “inventory” on page 309v “move” on page 309v “position” on page 309

The Service Aid commands are:v “dump” on page 309v “ekmtest” on page 309v “encryption” on page 310v “ucode” on page 310

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

Parameters:None

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 299

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

||

|

|

|

|

||

|

|

Page 318: IBM Tape Driver IUG 1

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.

Supported platforms: All

logpage(Deprecated: -o log) This subcommand issues the SCSI Log Sense command to thedevice for the specified page and displays the log sense data.

Parameters:logpage Page (page in hex without the leading x)

Supported platforms: All

loopThis subcommand loops all subsequent subcommands continuously or a numberof times if the Count parameter is specified. Also refer to the sleep subcommand.

Parameters:loop [Count]

Supported platforms: All

modepage(Deprecated: -o mod) This subcommand issues the SCSI Mode Sense command tothe device for the specified page and displays the mode sense data.

Parameters:modepage Page (page in hex without leading x)

Supported platforms: All

prevent(Deprecated: -o lck, lock) Prevent medium removal for tape or changer devices(lock door). The counter command for this is allow.

Parameters:None

Supported platforms: All

printThis subcommand prints the associated text to standard output. It can be used atany time to display the progress of the subcommands.

IBM Tape Diagnostic Tool

300 IBM Tape Device Drivers Installation and User’s Guide

|

|

|

|

|

|

|

|

||

|

|

|

|

||

|

|

|

|

||

|

|

|

|

||

|

|

|

|

||

Page 319: IBM Tape Driver IUG 1

Parameters:print Text

Supported platforms: All

qrypath(Deprecated: -o phs, path, checkpath) This subcommand displays informationabout the device and SCSI paths, such as logical parent, SCSI IDs, and the status ofthe 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.

Supported platforms: All

qryversion(Deprecated: -o drv) This subcommand prints out the current version of the IBMdevice driver.

Parameters:None

Supported platforms: All

release(Deprecated: -o rel) This subcommand explicitly releases a device and makes itavailable for other hosts by issuing the SCSI Release command.

Parameters:None

Supported platforms: All

reqsense(Deprecated: -o req) This subcommand issues the SCSI Request Sense command tothe device and displays the sense data in hex format.

Parameters:None

Supported platforms: All

reserve(Deprecated: -o res) This subcommand explicitly reserves a device by issuing theSCSI Reserve command.

Parameters:None

Supported platforms: All

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 301

|

|

|

|

|||

|

|

|

|

|

||

|

|

|

|

||

|

|

|

|

||

|

|

|

|

||

|

|

|

Page 320: IBM Tape Driver IUG 1

resetdriveThis subcommand issues a Send Diagnostic command (Reset Drive subcommand)to reset the device.

Parameters:None

Supported platforms: AIX, Linux

sleepSleep for the specified number of seconds before executing the next subcommand.

Parameters:sleep [Seconds]

Supported platforms: All

tur(Deprecated: -o tur) This subcommand issues the SCSI Test Unit Ready commandto the device.

Parameters:None

Supported platforms: All

vpdThis subcommand displays Vital Product Data (VPD) that are part of the Inquirycommand data and outputs Manufacturer, Product Identification and RevisionLevel.

Parameters:None

Note: ITDT will use the Tapeutil AIX output for all platforms.

Supported platforms: All

appendOpens 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 theIBM Tape Device Driver. On HP-UX this open mode is re-mapped to r/w by theIBM Tape Device Driver.

bsf(Deprecated: -o bsf) This subcommand backward spaces Count filemarks. The tapeis positioned on the beginning of the last block of the previous file. An optionalCount can be specified. The default is 1.

IBM Tape Diagnostic Tool

302 IBM Tape Device Drivers Installation and User’s Guide

|

||

|

|

|

|

|

|

|

|

|

||

|

|

|

|

|||

|

|

|

|

|

|

|

|

|||

|

|||

Page 321: IBM Tape Driver IUG 1

Parameters:bsf [Count]

Supported platforms: All

bsr(Deprecated: -o bsr) This subcommand backward spaces Count records. Anoptional count can be specified. The default is 1.

Parameters:bsr [Count]

Supported platforms: All

density(Deprecated: -o gdn / -o rds) This subcommand issues the SCSI Report DensitySupport command for all supported media and for the current media loaded in thedrive, and displays the results. If the drive is not loaded, the current media densityis not reported.

Parameters:None

Note: ITDT-SE will output detailed information on all platforms.

Supported platforms: All

display(Deprecated: -o msg) This subcommand displays a message on the display panel ofthe tape device. Up to 16 characters can be used for the message. If the message islonger than eight characters, the display alternates between the first eightcharacters and the remainder of the message.

Parameters:display “message1” “message2”

Supported platforms: All

erase(Deprecated: -o era) This subcommand erases the tape.

Parameters:None

Supported platforms: All

fsf(Deprecated: -o fsf) This subcommand forward spaces count filemarks. The tape ispositioned on the first block of the next file. An optional count can be specified.The default is 1.

Parameters:

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 303

|

|

|

|

||

|

|

|

|

||||

|

|

|

|

|

||||

|

|

|

|

|

|

|

|

|

|||

|

Page 322: IBM Tape Driver IUG 1

fsf [Count]

Supported platforms: All

fsr(Deprecated: -o fsr) This subcommand forward spaces count records. An optionalcount can be specified. The default is 1.

Parameters:fsr [Count]

Supported platforms: All

getparms(Deprecated: -o parms / status / -o gpa) Get and show drive, media and driverparameters.

Parameters:None

Supported platforms: All

load(Deprecated: -o lod) This subcommand issues a SCSI Load command to load atape. subcommand loops all subsequent subcommands continuously or a numberof times if the Count parameter is specified. Also refer to the sleep subcommand.

Parameters:None

Supported platforms: All

logsenseRetrieve all Log Sense pages and output them as hex.

Parameters:None

Supported platforms: All

qrypos(Deprecated: -o gpo) This subcommand displays the current tape position.

Parameters:None

Supported platforms: All

readThis subcommand reads a file, or a specified number of records, from the tape tothe destination file name specified with the -d flag. If the optional count parameteris used, only the number of records specified with the -c flag are read unless a

IBM Tape Diagnostic Tool

304 IBM Tape Device Drivers Installation and User’s Guide

|

|

|

||

|

|

|

|

||

|

|

|

|

|||

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|||

Page 323: IBM Tape Driver IUG 1

filemark is encountered before the number of specified records. If the countparameter is not used, all records up to the next filemark on tape are read.

Parameters:read -d Dest [-c Count]

Supported platforms: All

rewind(Deprecated: -o rew) Rewind the tape.

Parameters:None

Supported platforms: All

rtest(Deprecated: -o rea) This subcommand performs a read test by reading a randomdata pattern from the tape and verifying that it matches the written data. The rtestsubcommand can be used after the wtest subcommand to verify the data. Anoptional block size, count, and repetition can be specified with the -b, -c, and -rflags, respectively. If the block size is fixed, then the count specifies the number ofblocks to read on each repetition. If the block size is zero (variable), then the countspecifies the number of bytes to read on each repetition. The default is a block sizeof 10240, a count of 20 blocks, and a repetition of 1.

Parameters:read [-b Blocksize] [-c Count] [-r Repetition]

Supported platforms: All

rwtestThis subcommand performs a read and write test by writing a random datapattern on the tape, reading it, and verifying that it matches the written data. Anoptional block size, count, and repetition can be specified with the -b, -c, and -rflags, respectively. If the block size is fixed, then the count specifies the number ofblocks to write on each repetition. If the block size is zero (variable), then the countspecifies the number of bytes to write on each repetition. The default is a blocksize of 10240, a count of 20 blocks, and a repetition of 1.

Parameters:rwtest [-b Blocksize] [-c Count] [-r Repetition]

Supported platforms: All

seod(Deprecated: -o eod) Spaces to end of data on the tape.

Parameters:None

Supported platforms: All

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 305

||

|

|

|

|

|

|

|

|

|

||||||||

|

|

|

|

|||||||

|

|

|

|

|

|

|

|

Page 324: IBM Tape Driver IUG 1

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 currentinteractive mode options.

Parameters: The Value will bev 0-65535 for the blocksize parameterv 0-100 for the capacity parameter (=percentage)v 1 (SCSI) and 2 (AIX) for recordspacemodev the Volume Id string for the volid parameterv NONE|ASSO|PERS|WORM for the writeprotect parameterv 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 theplatform’s device drivers:

Table 31. 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 tothe 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 isomitted, the tape position is set to the last position saved using the qrypossubcommand.

Parameters:

IBM Tape Diagnostic Tool

306 IBM Tape Device Drivers Installation and User’s Guide

|

||

||

|

|

|

|

|

|

|||

||

||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

||||||

|||||||

|

|||||

|

Page 325: IBM Tape Driver IUG 1

setpos [Blockid]

Supported platforms: All

sync(Deprecated: -o syn) This subcommand will synchronize buffers/flush the tapebuffers to tape.

Parameters:None

Supported platforms: All

unload(Deprecated: -o off / offline / rewoffl) This subcommand rewinds and unloads thetape.

Parameters:None

Supported platforms: All

weof(Deprecated: -o eof / eof) These subcommands write count filemarks. An optionalcount can be specified. The default is 1.

Parameters:weof [Count]

Note: The weof parameter [count] is optional, if it is not supplied, 1 filemark willbe written.

Supported platforms: All

writeThis subcommand writes the source file specified with the -s flag on the tape.

Parameters:write -s Source

Supported platforms: All

wtest(Deprecated: -o wri) This subcommand performs a write test by writing a randomdata pattern on the tape. The rtest subcommand can be used after the wtestsubcommand 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 blocksize is fixed, the count specifies the number of blocks to write on each repetition. Ifthe block size is zero (variable), the count specifies the number of bytes to write oneach repetition. The default is a block size of 10240, a count of 20 blocks, and arepetition of 1.

Parameters:

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 307

|

|

|

||

|

|

|

|

||

|

|

|

|

||

|

|

||

|

|

|

|

|

|

|

||||||||

|

Page 326: IBM Tape Driver IUG 1

wtest [-b Blocksize] [-c Count] [-r Repetition]

Supported platforms: All

audit(Deprecated: -o aud / -o ier) This subcommand with no parameters issues the SCSIInitialize Element Status command to the device. Using the optional parametersAddress and Count issues the SCSI Initialize Element Status With Range commandto the device. The Address parameter specifies the starting element address andthe Count parameter, if used, specifies the number of elements to initialize. IfCount is omitted, it defaults to 1.

Parameters:audit [[Address] [Count]]

Supported platforms: All

cartridgelocationThis subcommand with no parameters issues the SCSI Read Element Statuscommand to the device to report all slots with the cartridge location information.Using the optional parameters Slot and Count issues the SCSI Read Element Statusto the device for a specific starting Slot address and optionally the Count specifiesthe number of slots to return. If Count is omitted, it defaults to 1.

Parameters:cartridgelocation [Slot [Count]]

Supported platforms: All

elementinfo(Deprecated: -o ele) This subcommand displays element information (number andaddress) of each element type.

Parameters:None

Supported platforms: All

exchange(Deprecated: -o exh) This subcommand issues the SCSI Exchange Mediumcommand 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 Dest1parameter to the element address specified by the Dest2 parameter. The secondmoves the cartridge from the element address specified by the source parameter tothe element address specified by the Dest1 parameter.

Parameters:exchange Source Dest1 Dest2

Supported platforms: All

IBM Tape Diagnostic Tool

308 IBM Tape Device Drivers Installation and User’s Guide

|

|

|

||||||

|

|

|

|

|||||

|

|

|

|

||

|

|

|

|

|||||||

|

|

|

Page 327: IBM Tape Driver IUG 1

inventory(Deprecated: -o inv) This subcommand with no parameters issues the SCSI ReadElement Status command for each element type and displays the element statusinformation. If the optional -i parameter is used, then only the import/exportelement status information is returned. If the optional -v parameter is used, thenonly 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.

Supported platforms: All

move(Deprecated: -o mov) This subcommand issues the SCSI Move Medium commandusing the source and destination addresses specified. The element addresses can beobtained using the elementinfo subcommand.

Parameters:move Source Dest

Supported platforms: All

position(Deprecated: -o pos) This subcommand issues the SCSI Position to Elementcommand using the destination specified.

Parameters:position Dest

Supported platforms: All

dump(Deprecated: -o sdp) Forces a dump of the tape drive and stores the dumps beforeand after the force dump in the ITDT-SE output folder with the ITDT-SE namingconvention (serialnumber.a.gz and serialnumber.b.gz).

Parameters:None

Supported platforms: All

ekmtestTest encryption key path/setup.

Parameters:None

Supported platforms: AIX, Linux, Solaris, Windows

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 309

|

|||||

|

|

|

|

|

|||

|

|

|

|

||

|

|

|

|

|||

|

|

|

|

|

|

|

|

Page 328: IBM Tape Driver IUG 1

encryptionQuery tape drive encryption settings and display the encryption state.

Parameters:None

Supported platforms: All

ucode(Deprecated: -o dmc) This subcommand downloads microcode to the device. TheFilename is a file that contains the ucode.

Parameters:ucode Filename

Supported platforms: All

Deprecated CommandsThe following is a list of commands that are currently available in this version ofITDT, however in a future release the following commands and some alternatecalls of the Common Command Scripting set will no longer be available and thescripts containing these commands will need to be changed. The scripts using thedeprecated commands should be changed for future editions.

The General commands are:v disablepath / -o disv enablepath / -o enav fuserv killv passthruv resetpath

The Tape commands are:v bsfmv chgpartv -o chkv fsfmv getrecsize / -o grsv idpv listv mediainfo / -o gmiv qryinquiryv qrypartv qrysensev retension / -o retv sdpv setblkv status / -o gds

IBM Tape Diagnostic Tool

310 IBM Tape Device Drivers Installation and User’s Guide

|

|

|

|

|

|

||

|

|

|

|

|||||

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

Page 329: IBM Tape Driver IUG 1

The Medium Changer subcommands are:v devids / -o dvcv mountv unmount / demount

The Service Aid commands are:v fmrtapev forcedump / -o fdpv resetv ucodelevel / -o qmc

Standard Edition Scripting Commands: Known Limitationsand Deviations

When scripting, one should be aware of the following general deviations to thelegacy tapeutil scripting command set.

The Verbose Mode parameter is ignored for the ITDT-SE implementation; insteadalways the full information is printed out.

For some operations, the sense data length is limited to 32 bytes – this is requiredby the ITDT test sequences.

The list command may not work on some Linux x86 variants for ITDT-SE as wellas legacy tapeutil.

Due to the fact that ITDT-SE opens the device read/write by default in scriptingmode, the WORM mode can not be deactivated in scripting mode. Use the Tapeutilinteractive mode instead to deactivate the WORM mode.

Scripting mode command deviations to legacy tapeutil (tapeutil will not bechanged):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 platforms13. cartridgelocation - AIX parameter deviation available on all platforms14. mediainfo - different output -> decode on all platforms15. setpos - logical vs. physical position, only set logical position as on AIX16. HPUX: -o gpo -t 1|2 --> parameter -t1|2 (logical, physical) is not supported.17. density - output all information on all platforms

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 311

|

|

|

|

|

|

|

|

|

|

|

||

||

||

||

|||

||

|

|

|

|

|

|

||

|

|

|

|

|

|

|

|

|

|

Page 330: IBM Tape Driver IUG 1

18. setparm (new) - work around the inability to set all parameters on allplatforms except the undocumented HP-UX release

19. getparms (new) - retrieve all parameters on all platforms, independent of flagset

20. qryinquiry - output the same as on AIX21. 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

WindowsTo install ITDT-GE on Windows, download the executable fileinstall_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 installingthe current one.

ITDT-GE requires a 32-bit Java Runtime Environment (JRE) to be installed. Installone of the following:v Java 1.4.2 SR3 by IBM Corporation and higherv Java 1.4.2_10 by Sun Microsystems and higher

Note: If IBM Java 1.5 on a Microsoft Windows system is used, ensure that it isJava 1.5 SR6 or higher.

For the graphical user interface (GUI) a minimum screen resolution of 1024*768pixels is required.

The supported Windows operating systems for ITDT-GE are:v Microsoft Windows XPv Microsoft Windows Server 2003v Microsoft Windows Server 2008 (x86, 32-bit)

64-bit Windows x64 is supported for ITDT-GE, but 32-bit JVM must be used.

LinuxTo install ITDT-GE on Linux, download the executable fileinstall_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 beforelaunching the ITDT Installer:v Java 1.4.2 SR3 by IBM Corporation and higherv Java 1.4.2_10 by Sun Microsystems and higher

IBM Tape Diagnostic Tool

312 IBM Tape Device Drivers Installation and User’s Guide

||

||

|

|

|

|

Page 331: IBM Tape Driver IUG 1

On RHEL4, RHEL5 and other Linux systems where none of the supported JREs isavailable 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 theversion 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 JREdirectories.

2. Create a symbolic link to the JRE to ensure that ITDT finds the right JRE beforestarting 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 JREdirectories.

The ITDT-GE installer automatically uninstalls any previous version beforeinstalling the current one.

For the graphical user interface (GUI) a minimum screen resolution of 1024*768pixels 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 LimitationsThis section describes the known issues and limitations of ITDT-GE.

LinuxIt is strongly recommended to not operate Security Enhanced Linux (SELinux) inenforcing mode while running ITDT-GE.

On RedHat Enterprise Linux 4 and 5 and SuSE Enterprise Linux 10 invoking theonline help may cause an error message ″Problems opening link / Unable to openweb browser on {0}″ to appear. Workarounds are to issue the commands:a) ln -s /usr/bin/firefox /usr/local/bin/mozillaorb) export MOZILLA_FIVE_HOME=/usr/lib/firefox<version>

Replace with the appropriate path to your installed Firefox version before startingITDT-GE.

Gnome DesktopIf you are using the Gnome desktop, please be sure to log into the desktop sessionas root to use ITDT-GE to prevent device access issues.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 313

|||

Page 332: IBM Tape Driver IUG 1

WindowsOn Microsoft Windows systems where the maximum transfer size is limited to lessthan 64kB, the Dump and Firmware update operations will not work.

Performance IssuesIf you are using Adaptec SCSI Host Bus Adapters, ensure that you are using thelatest Adaptec Host Bus Adapter Drivers instead of the drivers shipped with theWindows operating system.

Devices Disappear After Firmware UpdateAfter a firmware update, devices may disappear. This is a known Windowsproblem.

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 TimeoutThere is no instant operation termination upon SCSI command timeout; forexample, when the SCSI cable is unplugged after starting POST A.

When a command timeout condition occurs, ITDT may still continue to performmore operations (like unmounting the cartridge) instead of instantly terminatingwith a timeout condition.

3576/TS3310 Tape LibraryLibrary Firmware Update using ITDT-GE is not supported with the 3576/TS3310tape library. Update the Firmware using the 3576/TS3310 Web User Interface.

3494 Tape LibraryDrives in a 3494 tape library or an STK silo library are supported, only the Testoption won’t work due to device-specific restrictions for handling cartridges.

Graphical Edition - User Interface Description

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 Terminalwindow, then switch to root user:$ su -

finally start ITDT-GE with$ /opt/ibm/itdt-ge/itdt-ge

a2500238

Figure 86. Graphical Edition User Interface

IBM Tape Diagnostic Tool

314 IBM Tape Device Drivers Installation and User’s Guide

|

||

||||

|||

|

|

|

|

|||

|||

|||

|||

Page 333: IBM Tape Driver IUG 1

The User Settings dialog appears the first time the program is run, allowing theentry 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 isC:\Documents and Settings\<username>\.itdt-ge\output

where <username> is the Windows user login name. The Linux default outputpath is/root/.itdt-ge/output

The Log Level should not be changed unless requested to do so by the IBMSupport Center. It is strongly recommended that this information be provided toallow for further analysis of test results.

The interface of the GE edition is as follows:v The main menu in the upper leftv The graphical buttons to select either the Diagnostic or the Tapeutil perspectivev The Control Center with the toolbar that contains the main actions as well as

advanced actions that can be reached by drop-down arrowsv The test tab area on the right that contains all output of the running as well as

previously finished testsv The Status Information area on the bottom that summarizes the results of

previously run tests or notifies when a test tab requires user input

It is strongly recommend that this information be provided to allow for furtheranalysis of test results. Click OK to save the settings and close the dialog.

a2500262

Figure 87. Graphical Edition Preferences

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 315

|

|||

Page 334: IBM Tape Driver IUG 1

The ITDT-GE interface contains the following:

v Main Menu (�1� on Figure 88)- Located in upper left (File, Window, Help) Thefollowing main program menu items are available:

v Control Center (�2� on Figure 88) - 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 88) - Located from center to right side (Contains runningand previously run tests)

v Status Information (�4� on Figure 88) - Located below the Test Lab (Containssummary results of tests)

The Control Center is the primary section the ITDT-GE operations.

The following toolbar buttons for the device operations are available:

1

2

a2

50

02

39

3

4

Figure 88. Graphical Edition Interface

a2500264

Figure 89. Main Program Menu Items

IBM Tape Diagnostic Tool

316 IBM Tape Device Drivers Installation and User’s Guide

|

|||

|

|||

Page 335: IBM Tape Driver IUG 1

v Click the Scan menu item in the Control Center to display the list of tapedevices found. When the scan is complete, select one device in the Test Lab byclicking 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 theright 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 tabseven for the single operation mode is that you get a history of operations as foreach consecutive operation, a separate tab is opened.

Graphical Edition - Scan Menu CommandsThe following commands are described in this section:v “Scan” on page 318v “Test” on page 319v “Dump” on page 321v “Firmware Update” on page 322v “Encryption” on page 323v “Full Write” on page 324v “Tape Usage” on page 326v “System Test” on page 326v “Library Diagnostic Self-Test” on page 327

a2500265

Figure 90. Toolbar Buttons

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 317

|

|||

Page 336: IBM Tape Driver IUG 1

Scan

The scan function is used to discover all supported tape and library devices thatare attached to the computer system so that they can be selected for thesubsequent ITDT-GE operations. The scan function also serves as a connection testthat 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 isdisplayed, select the device for test. Only one device can be selected.

a2500240

Figure 91. Scan Function

IBM Tape Diagnostic Tool

318 IBM Tape Device Drivers Installation and User’s Guide

Page 337: IBM Tape Driver IUG 1

Test

The test function checks if the tape device is defective and outputs a pass/failresult.

Attention: The test functionality erases user data on the cartridge that is used forthe 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 usedcartridge is used. Scaled (capacity-reduced) cartridges should not be used to testthe 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 Testmenu item.

The Test function can be stopped by clicking the Abort button.

Note: It may take some time until the Test function actually stops.

a2500241

Figure 92. Test Menu

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 319

Page 338: IBM Tape Driver IUG 1

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 Medium2. [Medium Qualification] – only if the previous step indicated this requirement3. Load/Unload Cycles4. POST A

During POST A stopping the test is not allowed.5. Performance Test6. Unmount Medium7. Get FSC8. Get Logs

a2500242

1

Figure 93. Test Results

IBM Tape Diagnostic Tool

320 IBM Tape Device Drivers Installation and User’s Guide

Page 339: IBM Tape Driver IUG 1

Dump

After selecting the device you want to dump, start the Dump function by selectingDump -> Dump from the actions toolbar.

When the dump process is performed on a tape library or autoloader other thanthe 3584/TS3500, the Dump function stores one log file in the output folder of theprogram (*.blz). For the 3584/TS3500, a dump file (*.a.gz) will be stored in theoutput folder. Both files start with the serial number of the device (�1�).

a2500224

Figure 94. Dump Menu

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 321

Page 340: IBM Tape Driver IUG 1

Note: When the Dump function is performed for tape libraries or autoloadersother than the 3584/TS3500, the Log file only contains Log Sense and ModeSense pages, while a Drive or 3584/TS3500 Dump contains much morediagnostic information. (�2�)

Firmware UpdateThe Firmware Update upgrades the firmware of tape drives and tape libraries. See“Supported Equipment” on page 263 for a list of supported products.

Note: See “3576/TS3310 Tape Library” on page 273 for more information on howto update the firmware on a 3576/TS3310 Tape Library.

The following site is available for the latest firmware files:http://www.ibm.com/storage/lto

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 successfullyopened 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 45minutes for libraries.

a2500225

1

2

Figure 95. Dump Results

IBM Tape Diagnostic Tool

322 IBM Tape Device Drivers Installation and User’s Guide

Page 341: IBM Tape Driver IUG 1

Note: If ITDT-GE detects a FIPS-certified drive firmware, it displays a warningdialog. Before continuing, ensure that you use a FIPS-certified firmwareto update the drive.

Encryption

Note: Note that the test shown on the graphic above was run on a non-encrypteddevice and is showing a failure.

The Encryption function is used to verify if data on the cartridge was actuallywritten encrypted. It reads both decrypted and raw data from the cartridge intotwo separate files on disk. The user can then verify that the data differs to ensurethat encryption worked.

The Encryption function is only supported on encryption enabled drives andrequires 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 ofdata (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 30 on page 284 defines the abort codes.

a2500226

Figure 96. Encryption Function

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 323

Page 342: IBM Tape Driver IUG 1

Full WriteThe Full Write function writes the entire cartridge with a given block size eitherwith compressible or incompressible data and output performance data.

Attention: The Full Write function erases data on the cartridge that is used forthe test.

Notes:

1. The Full Write function takes approximately 2 hours when writingincompressible data, less time for compressible data.

2. The Full Write function runs only on tape drives, not on autoloaders orlibraries.

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 testwith compressible data. If no difference in overall performance is observed, thenprobably there is a bandwidth limitation caused by the system or cabling orHBA.

v Identify system issues with compression.Compression is always switched on during the full write. When run withcompressible data, the output shows the compression rate. If that is higher than1.0 but your system does not appear to be able to compress data on thecartridge, check your device driver and software settings to see if they disablecompression.

To perform a full write on tape drives within a library, the library must be inonline 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 orstop by clicking the Abort button.

Note: If ITDT-GE detects data on the cartridge, it displays the followingmessage (Figure 97 on page 325):

IBM Tape Diagnostic Tool

324 IBM Tape Device Drivers Installation and User’s Guide

Page 343: IBM Tape Driver IUG 1

Click Yes to continue the test if you are absolutely sure that data on thecartridge 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 themaximum block size supported by the system (maximum possible value is 512KB). Select the appropriate value for your system.

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.If all write operations are finished, ITDT-GE displays the performance statisticsfor the selected block size written on the cartridge, in the Status Informationarea. If an error occurred during the full write, data is only written partially.

a2500227

Figure 97. Overwrite Data

a2500228

Figure 98. Transfer Size

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 325

|

|

Page 344: IBM Tape Driver IUG 1

Tape Usage

The Tape Usage function retrieves statistical data and error counters from acartridge.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 orstop by clicking the Abort button.

System TestThe 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. Toperform a System Test on tape drives within a library, the library must be in onlinemode.

After selecting the device you want to test, start the System Test function byselecting Test -> System Test from the actions toolbar.

ITDT-GE then displays the System Test screen. If no cartridge is inserted, ITDT-GEprompts to insert a cartridge. Either insert a cartridge and click OK or stop byclicking the Abort button.

Note: If ITDT-GE detects data on the cartridge, it displays the following message:

a2500229

Figure 99. Tape Usage

IBM Tape Diagnostic Tool

326 IBM Tape Device Drivers Installation and User’s Guide

Page 345: IBM Tape Driver IUG 1

Cartridge not empty!Overwrite data?

Click Yes to continue the test if you are absolutely sure that data on thecartridge can be overwritten. If you are unsure, click No to stop the 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 withincompressible, then with compressible data, and then displays performancedata and progress screen.

3. At the end of the test, a summary information is displayed.

Library Diagnostic Self-TestThe Library Self-Test starts and monitors the library-internal self-test. This test onlyruns on libraries and autoloaders, not on tape drives.

After selecting the device you want to test, start the Library Self-Test function byselecting 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 EntryA manual inspection record can be generated if the device does not appear in thedevice list. This test is intended for devices that are not recognized or have atechnical problem which can not be determined by ITDT-GE.

a2500230

Figure 100. System Test

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 327

|

|

|

||

||

|

|

|||

Page 346: IBM Tape Driver IUG 1

If a tape drive cannot be identified using a device scan, the user can manuallycreate a test record for the drive. The system prompts for the user to run theSCSI/FC Wrap test for the drive (see the service manual for the drive). The resultsof 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 asthe output files generated by the test.1. From the Main program menu, select File -> Manual Record2. 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 furtheranalysis), and in a human-readable text file. Both files are stored in theITDT-GE output folder.

Graphical Edition - Tapeutil Menu CommandsAfter the initial startup, 4.0 will show two figures under the top menu. TheGraphical version now offers the same commands that are found in the SE Tapeutilsection along with the Diagnostic commands. After selecting the Tapeutil optionthe following page will appear.

The left drop-down box within the Tapeutil Control Center is used to selectbetween Tape Drive Commands and Tape Library Commands. The commandsfrom the General Commands and Service Aid Commands ITDT-SE categories areduplicated into the two sections to make the GUI navigation easier.

a2500258

Figure 101. Tapeutil Control Center

IBM Tape Diagnostic Tool

328 IBM Tape Device Drivers Installation and User’s Guide

|

|||

||||||

|

|

|

|

|

|

|||

Page 347: IBM Tape Driver IUG 1

After the command category is selected, a drop-down box appears that allows theselection of a command:

After the command is selected, an area appears where command parameters canbe entered:

a2500259

Figure 102. Tape Drive Commands

a2500260

Figure 103. Command Parameters

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 329

|

|||

|

|||

Page 348: IBM Tape Driver IUG 1

When the user presses the “Execute” button, the “Results” output is placed belowthe Parameter section:

This screen layout will stay within the Tapeutil perspective until the program isclosed. Outputs of subsequent operations are added to the Results field.Commands that fail are indicated with a red cross in the Status area, commandsthat succeed with a green check mark. The status area can be cleared by pressingthe “Clear” button.

The general commands that are available under both menus are:v “Open” on page 331v “Close” on page 331v “Inquiry” on page 332v “Test Unit Ready” on page 332v “Reserve Device” on page 332v “Release Device” on page 332v “Request Sense” on page 332v “Log Sense” on page 332v “Mode Sense” on page 332v “Query Driver Version” on page 332v “Display All Paths” on page 332

The tape drive specific commands are:v “Rewind” on page 333v “Forward Space Filemarks” on page 333v “Backward Space Filemarks” on page 333v “Forward Space Records” on page 333

a2500261

Figure 104. Command Parameter Results

IBM Tape Diagnostic Tool

330 IBM Tape Device Drivers Installation and User’s Guide

|

|||

Page 349: IBM Tape Driver IUG 1

v “Backward Space Records” on page 333v “Space to End of Data” on page 333v “Read and Write Tests” on page 333v “Read or Write Files” on page 335v “Erase” on page 336v “Load Tape” on page 336v “Unload Tape” on page 336v “Write Filemarks” on page 336v “Synchronize Buffers” on page 336v “Query/Set Parameter” on page 336v “Query/Set Position” on page 336v “Query Encryption Status” on page 337v “Display Message” on page 337v “Display All Paths” on page 332v “Report Density Support” on page 337v “Test Encryption Path” on page 338

The tape library specific commands are:v “Element Information” on page 338v “Position to Element” on page 338v “Element Inventory” on page 338v “Exchange Medium” on page 338v “Move Medium” on page 338v “Initialize Element Status” on page 339v “Prevent/Allow Medium Removal” on page 339v “Initialize Element Status Range” on page 339v “Read Device IDs” on page 339v “Read Cartridge Location” on page 339

The service aid commands which are found under both menus are:v “Dump/Force Dump/Dump” on page 339v “Firmware Update” on page 340

Note: When issuing a command in Tapeutil mode for ITDT GE execute must bepressed before the action takes place.

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

CloseWhen you select the Close command:1. ITDT checks if the device is already closed.2. ITDT closes the device.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 331

|

||

Page 350: IBM Tape Driver IUG 1

InquiryWhen 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 ReadyWhen you select the Test Unit Ready (TUR) command, ITDT issues the Test UnitReady ioctl command.

Reserve DeviceWhen you select the Reserve Device command, ITDT issues a reserve command forthe device.

Release DeviceWhen you select the Release Device command, ITDT issues a release command forthe device.

Request SenseWhen 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 SenseWhen 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 SenseWhen 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 VersionWhen you select the Query Driver Version command:1. ITDT issues the required command to get driver version.2. ITDT prints driver version.

Display All PathsWhen you select the Display All Paths command:1. ITDT issues an ioctl command.2. ITDT outputs decoded path information for all paths.

IBM Tape Diagnostic Tool

332 IBM Tape Device Drivers Installation and User’s Guide

|

||

|

||

Page 351: IBM Tape Driver IUG 1

RewindWhen you select the Rewind command, ITDT issues the ioctl rewind command forthe device.

Forward Space FilemarksWhen you select the Forward Space Filemarks command:1. Enter the amount of Filemarks to Forward Space, in the Filemark-Count box.2. ITDT issues (extrinsic) ioctl command.3. The tape is positioned on the first block of the next file.

Backward Space FilemarksWhen you select the Backward Space Filemarks command:1. Enter the amount of Filemarks to Backward Space, in the Filemark-Count box.2. ITDT issues (extrinsic) ioctl command.3. The tape is positioned on the last block of the previous file.

Forward Space RecordsWhen you select the Forward Space Records command:1. Enter the amount of Records to Forward Space, in the Record-Count box.2. ITDT issues (extrinsic) ioctl command.

Backward Space RecordsWhen you select the Backward Space Records command:1. Enter the amount of Records to Backward Space, in the Record-Count box.2. ITDT issues (extrinsic) ioctl command.

Space to End of DataWhen you select the Space to End of Data (EOD) command, ITDT issues the(extrinsic) ioctl command.

Read and Write TestsWhen you select the Read and Write Tests command, ITDT performs the followingfunctions (Read and Write Test, Read Only Test, and Write Only Test). There arethree parameter fields to fill out that have default values already in them. Nextthere will be a Test pull down menu which will give you the option of ″Read Datafrom Tape, Write Data to Tape, and Read/Write/Verify″. Once this is done, thefollowing 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 334).

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 333

Page 352: IBM Tape Driver IUG 1

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 333 until all blocks are written.19. Prints current block id and total number of bytes written.

v The following are the Read Only steps:1. Issues a Read Position.2. Sets block size.3. Generates special pattern.4. Print amount of data to read.5. Issues read command.6. If read error occurred or number of bytes read is different from requested

number of bytes to read, stop (go to Step 19).7. Compares data read with buffer data, show miscompares and if

miscompares exist, stop (go to Step 19).8. If compare is Ok, print ok message.9. Repeat Steps 10 to 15 until all blocks are written.

- 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.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 until all blocks are written.19. Prints current block id and total number of bytes written.

v The following are the Write Only steps:1. Issues a Read Position.2. Sets block size.

IBM Tape Diagnostic Tool

334 IBM Tape Device Drivers Installation and User’s Guide

Page 353: IBM Tape Driver IUG 1

3. Generates special pattern.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).9. Repeat Steps 10 to 15 until all blocks are written.

- OR -

Go to Step 4 until all blocks are written.10. Print current block id and total number of bytes written.

Read or Write FilesWhen Read or Write Files is selected, there will be a box under File Name: inwhich the path and name of the file will be entered. Under that there is a boxnamed Number of records to read (0 for entire file). The default that shows up inthe box is 100. Next a pull down menu bar under Test: that gives you the choice ofRead File from Tape or Write File to Tape. Once the Test is selected a Browsebutton 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 followingfunctions:v The following steps are the Read steps:

1. Prompts if to read a file from tape2. You are prompted for destination file name3. 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 opened5. Opens the file (r/w with large file support, 666 umask)6. Issues Query Parameters ioctl command, if it fails, quit7. Sets blocksize to maximum possible, variable blocksize mode8. 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 mode7. Prints write statement.8. Reads from file.9. Writes to tape, stop if data count written is not equal to data count

requested.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 335

Page 354: IBM Tape Driver IUG 1

10. Prints statistics.

EraseWhen you select the Erase command, ITDT issues the (extrinsic) ioctl command.

Load TapeITDT issues a SCSI Load command to load a tape.

Unload TapeWhen you select the Unload Tape command:1. ITDT issues the (extrinsic) ioctl command.2. The tape will rewind and then unload.

Write FilemarksWhen you select the Write Filemarks command:1. In the Filemark-Count box, enter the number of filemarks to write.2. ITDT issues the (extrinsic) ioctl command.

Synchronize BuffersWhen you select the Synchronize Buffers command, ITDT issues the ioctlcommand.

Query/Set ParameterWhen 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).5. ITDT issues the ioctl command.

Query/Set PositionWhen 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 justdisplays the current position and queries for the one to set, then setsthe new position.

2. Enter the block id for where the tape should go to. This must be entered indecimal. When the tape is being set the block id will be printed out in decimalwith 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.

IBM Tape Diagnostic Tool

336 IBM Tape Device Drivers Installation and User’s Guide

Page 355: IBM Tape Driver IUG 1

9. ITDT prints summary.10. ITDT issues the Set Position ioctl command.11. Repeat steps 2 through 5.

Query Encryption StatusWhen 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 MessageWhen 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. Thesecurrently are the 3590 and the 3592 drives.

2. In the Type: pull down menu select which message (0 or 1) you wantdisplayed and if you want it to flash. There is also an alternate (alt) selectionwhich will alternate between messages.

3. ITDT issues the ioctl command.4. ITDT prints message to display.

Report Density SupportWhen 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 namev Assigning organizationv Descriptionv Primary density codev Secondary density codev Write OKv Duplicatev Defaultv Bits per MMv Media Widthv Tracksv 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.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 337

Page 356: IBM Tape Driver IUG 1

Test Encryption PathWhen 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.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.

Element InformationWhen you select the Element Information command: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, firstdrive address.

Position to ElementWhen 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.3. ITDT issues the ioctl command.

Element InventoryWhen you select the Element Inventory command:1. ITDT issues the Element Info ioctl command.2. ITDT issues the Element Inventory ioctl command.3. ITDT displays decoded element inventory information.

Exchange MediumWhen 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.4. ITDT issues the ioctl command.

Move MediumWhen 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

IBM Tape Diagnostic Tool

338 IBM Tape Device Drivers Installation and User’s Guide

Page 357: IBM Tape Driver IUG 1

3. Insert the second destination element address in decimal in the ″Seconddestination element address″ box.

4. ITDT issues the ioctl command.

Initialize Element StatusWhen you select the Initialize Element Status command:1. ITDT issues the ioctl command.2. ITDT prints command summary.

Prevent/Allow Medium RemovalWhen you select the Prevent/Allow Medium Removal command:1. Use the pull down menu to either prevent or allow.2. ITDT issues the ioctl command.

Initialize Element Status RangeWhen 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.3. ITDT issues the ioctl command.

Read Device IDsWhen you select the Read Device IDs command:1. ITDT issues the Element Info ioctl command.2. If no drive is present, ITDT prints NO DRIVE PRESENT - and exits.3. ITDT prints information for all drives.

Read Cartridge LocationWhen 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.5. ITDT issues the Element Info 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.8. ITDT issues the READ_CARTRIDGE_LOCATION ioctl command.9. ITDT prints decoded storage element information.

Dump/Force Dump/DumpWhen 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.

IBM Tape Diagnostic Tool

Chapter 10. IBM Tape Diagnostic Tool (ITDT) 339

|

|

|

||

Page 358: IBM Tape Driver IUG 1

Firmware UpdateWhen you select the Firmware Update command, browse to the microcode file tobe used. ITDT performs firmware update and displays progress status and result.

Note: See “3576/TS3310 Tape Library” on page 314 for more information on howto update the firmware on a 3576/TS3310 Tape Library.

The following site is available for the latest firmware files: http://www.ibm.com/storage/lto.

IBM Tape Diagnostic Tool

340 IBM Tape Device Drivers Installation and User’s Guide

||

||

Page 359: IBM Tape Driver IUG 1

Appendix A. Accessing Documentation and Software Online

IBM maintains the latest levels of TotalStorage tape drive and library devicedrivers and documentation on the Internet. Obtain them by accessing the followingURL:ftp://ftp.software.ibm.com/storage/devdrvr/tapedrivers.html

This web page has links to the device driver download web pages.

Information concerning supported fibre channel host bus adapters (HBAs) andassociated HBA device drivers, firmware and BIOS levels can be obtained from thefollowing URL:http://www-03.ibm.com/systems/support/storage/config/hba/index.wss

You may also browse the FTP site and download drivers using one of thefollowing URLs:ftp://ftp.software.ibm.com/storage/devdrvrftp://207.25.253.26/storage/devdrvr

Or, you may access this information using anonymous FTP, as follows:FTP site: ftp.software.ibm.comIP Address: 207.25.253.26User ID: anonymousPassword: (Use your current e-mail address.)Directory: /storage/devdrvr

IBM provides Postscript- and PDF-formatted versions of its documentation in the/storage/devdrvr/Doc directory. Postscript documents are gzip-ed.

The IBM_Tape_Driver_IUG.pdf file contains the current version of the IBM TapeDevice Drivers: Installation and User’s Guide.

The IBM_Tape_Driver_PROGREF.pdf file contains the current version of the IBMTape Device Drivers: Programming Reference.

Device and Library Drivers for each supported platform can be found beneath/storage/devdrvr/ in the following directories:AIX/HPUX/Linux/SGI/Solaris/Tru64/Windows/

For the most-current information for the device driver you are using, consult theREADME files in the directory pertaining to your device driver. For example, forinformation on exploiting the capacity scaling feature of your IBM TotalStorageEnterprise Tape Subsystem 3592, consult the README file.

There are numeric sequence numbers in each level of device and library driver,that is, AIX/Atape.4.4.0.0.bin. As newer levels of a driver are released, a highernumeric sequence is assigned.

© Copyright IBM Corp. 2007, 2009 341

Page 360: IBM Tape Driver IUG 1

Table 32 documents each driver by name and description:

Table 32. Driver Descriptions

Driver Description

AIX/Atape.n.n.n.n.bin AIX Device Driver (Atape)

AIX/atldd.n.n.n.n.bin AIX 3494 Enterprise Tape LibraryDriver

HPUX/.../atdd.n.n.n.n.bin HP-UX Device Driver

HPUX/lmcpd/lmcpd.hpux.n.n.n.n.bin HP-UX 3494 Enterprise LibraryDriver

Linux/ibmatl/ibmatl.n.n.n.n.arch.rpm.bin Linux 3494 Enterprise Library Driver

Linux/lin_tape_source-lin_taped/lin_tape-x.x.x.x-x.src.rpm.bin Linux Device Driver (lin_tape) sourcecode

Linux/lin_tape_source-lin_taped/lin_taped-x.x.x-dist.arch.rpm.bin Linux lin_taped daemon program

Linux/lin_tape_source-lin_taped/IBMtapeutil/IBMtapeutil.n.n.n.arch.tar.bin

Linux Tape Utility (IBMtapeutil)

SGI/ibmatl.n.n.n.n.tardist SGI/IRIX Enterprise Library Driver

Solaris/IBMtape.n.n.n.n.bin Solaris Device Driver (IBMtape)

Solaris/lmcpd.n.n.n.n.bin Solaris 3494 Enterprise Library Driver

Tru64/ibmatl.tru64.n.n.n.n.kit.tar Tru64 Enterprise Library Driver

Windows/ibmatl/ibmmatl.n.n.n.n.exe 32-bit Windows 3494 EnterpriseLibrary Service

Windows/ibmatl/ibmatl.n.n.n.n.x86.exe 32-bit Windows 3494 EnterpriseLibrary Service

Windows/ibmatl/ibmalt.n.n.n.n.i64.exe 64-bit Windows 3494 Library Servicefor IA64

Windows/ibmalt/ibmalt.n.n.n.n.x64.exe 64-bit Windows 3494 Library Servicefor AMD64 and EM64T

Windows/Win2000/Latest/IBMTape.x86_nnnn.zip Windows Server 2000 Device Driveron x86

Windows/Win2003/Latest/IBMTape.x86_nnnn.zip Windows Server 2003 32-bit DeviceDriver on x86

Windows/Win2003/Latest/IBMTape.i64_nnnn.zip Windows Server 2003 64-bit DeviceDriver on IA64

Windows/Win2003Latest//IBMTape.x64_nnnn.zip Windows Server 2003 64-bit DeviceDriver on AMD64 and EM64T

Windows/Win2008/Latest/IBMTape.x86_w08_nnnn.zip Windows Server 2008 32-bit DeviceDriver on x86

Windows/Win2008/Latest/IBMTape.i64_w08_nnnn.zip Windows Server 2008 64-bit DeviceDriver on IA64

Windows/Win2008Latest//IBMTape.x64_w08_nnnn.zip Windows Server 2008 64-bit DeviceDriver on AMD64 and EM64T

Notes:

1. dist indicates a Linux distribution. arch indicates a machine architecture (for example, i386, ia64, s390).

2. The n.n.n. or n.n.n.n strings are replaced with digits on the FTP site to reflect the version of each driver.

Accessing Documentation and Software Online

342 IBM Tape Device Drivers Installation and User’s Guide

Page 361: IBM Tape Driver IUG 1

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 thehardware, connections, and device drivers are working together properly. Beforeyou 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 thismanual.

4. Start your operating system as indicated in the appropriate chapters from thismanual.

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 orenable the drivers documented in this manual.

7. Follow the subsequent instructions for your host system.

© Copyright IBM Corp. 2007, 2009 343

Page 362: IBM Tape Driver IUG 1

AIX System

Tape Device Attachment TestThe following procedure tests the attachment of a tape device to an AIX system.The procedure assumes that your device is attached at /dev/rmt0 and that there isno cartridge in the drive.

When the Hit <Enter> to Continue . . . ? message is displayed or when you aretold to enter information, press Enter after following the instruction. When theutility displays information, use the appropriate hardware manual to verify thatthe information is reasonable.1. Open an AIX window.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/rmt0 when prompted for the device name.5. Enter 1 (Read/Write).6. Enter 3 (Device Info).7. Enter 5 (Inquiry). Specify 0 when prompted for an inquiry page. This

concludes a very basic test of the device, SCSI connection, and the devicedriver. You may stop the test here or continue to perform a more completetest.

8. Enter 6 (Test Unit Ready) until no error occurs.9. Enter 22 (Rewind).

10. Enter 30 (Read and Write Tests).11. Enter 1 (Read/Write). Press the Enter key three times to accept the defaults

and run the test.12. Enter 31 (Unload Tape).13. Enter 2 (Close a Device).14. Enter Q (Quit Program).

Medium Changer Device Attachment TestThe following procedure tests the attachment of a medium changer device to anAIX system. The procedure assumes that your device is attached at /dev/rmt0. Youalso need a cartridge in at least one of the slots.

When the Hit <Enter> to Continue . . .? message is displayed or when you aretold to enter information, press Enter after following the instruction. When theutility displays information, use the appropriate hardware manual to verify thatthe information is reasonable.1. Open an AIX window.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/rmt0 when prompted for the device name.5. Enter 1 (Read/Write).6. Enter 3 (Device Info).7. Enter 5 (Inquiry). Specify 0 when prompted for an inquiry page. This

concludes a very basic test of the device, SCSI connection, and the devicedriver. You may stop the test here or continue to perform a more completetest.

AIX - Verifying Proper Attachment of Your Devices

344 IBM Tape Device Drivers Installation and User’s Guide

Page 363: IBM Tape Driver IUG 1

8. Enter 6 (Test Unit Ready) until no error occurs.9. Enter 18 (Initialize Element Status).

10. Enter 14 (Element Inventory).11. From the output of the previous step, select a writable, scratch cartridge and

determine its element ID. Also, select the element ID of an unoccupied slot.12. Enter 16 (Move Medium), then supply the address of the cartridge followed

by the address of the unoccupied slot. Verify that the cartridge moved.13. Enter 14 (Element Inventory). Verify that the inventory was updated properly.14. Enter 2 (Close a Device).15. Enter Q (Quit Program).

3494 Enterprise Tape Library Attachment TestThe following procedure tests the attachment of a 3494 Enterprise Tape Library toan AIX system. The procedure assumes that your device is defined as /dev/lmcp0.1. Open an AIX window.2. Enter mtlib -l /dev/lmcp0-qI3. Enter mtlib -l /dev/lmcp0 -qL

AIX - Verifying Proper Attachment of Your Devices

Appendix B. Verifying Proper Attachment of Your Devices 345

Page 364: IBM Tape Driver IUG 1

HP-UX System

Tape Device Attachment TestThe following procedure tests the attachment of a tape device to an HP-UX system.The procedure assumes that your device is attached at /dev/rmt/0m.

When you are told to enter information, press the Enter key after following theinstruction. When the utility displays information, use the appropriate hardwaremanual to verify that the information is reasonable.1. Bring up a shell prompt.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/rmt/0m when prompted for the device name.5. Enter 1 (Read/Write).6. Enter D (Device Info).7. Enter Inquiry Option (Inquiry).8. Enter Q to quit tapeutil.

Autochanger Device Attachment TestThe following procedure tests the attachment of an autochanger device to anHP-UX system. The procedure assumes that your device is attached at/dev/rmt/0chng and that the ACF is in Random mode. You also need a cartridge inat least one of the slots.

When you are told to enter information, press Enter after following the instruction.When the utility displays information, use the appropriate hardware manual toverify that the information is reasonable.1. Bring up a shell prompt.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/rmt/0chng when prompted for the device name.5. Enter 1 (Read/Write).6. Enter D (Device Info).7. Enter 5 (Inquiry). This concludes a very basic test of the device, SCSI

connection, and the device driver. You may stop the test here or continue toperform a more complete test.

8. Enter Test Unit Ready option until no error occurs.9. Enter Element Inventory option.

10. From the output in the previous step, select a writable, scratch cartridge anddetermine its element ID. Also, select the element ID of an unoccupied slot.

11. Enter Move Medium option, then supply the address of the cartridge and theaddress of the unoccupied slot. Verify that the cartridge moved.

12. Enter Element Inventory option. Verify that the inventory was updatedproperly.

13. Enter 2 (Close a Device).14. Enter Q (Quit Program).

HP-UX - Verifying Proper Attachment of Your Devices

346 IBM Tape Device Drivers Installation and User’s Guide

Page 365: IBM Tape Driver IUG 1

3494 Enterprise Tape Library Attachment TestThe following procedure tests the attachment of a 3494 Enterprise Tape Library toan 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

HP-UX - Verifying Proper Attachment of Your Devices

Appendix B. Verifying Proper Attachment of Your Devices 347

Page 366: IBM Tape Driver IUG 1

Linux SystemIssue the following command to verify if your host system has recognized all theattached IBM tape and medium changer devices after you installed the lin_tapedevice driver:cat /proc/scsi/scsi

You can follow the instructions below to test the attachment.

Tape Device Attachment TestThe following procedure tests the attachment of a tape device to a Linux system.The procedure assumes that your device is attached at /dev/IBMtape0 and that thereis no cartridge in the drive.

When the Hit<Enter>to Continue... message is displayed or when you are told toenter information, press Enter after following the instruction. When the utilitydisplays information, use the appropriate hardware manual to verify that theinformation is reasonable.1. Open a Linux window.2. If you want to perform a more complete test, mount a writable scratch

cartridge manually into the driver, or, if your device has an autoloaderattached, follow the ″Medium Changer Device Attachment Test″ in the nextsection to mount a writable scratch cartridge.

3. Enter IBMtapeutil. A menu is displayed.4. Enter 1 (Open a Device).5. Enter /dev/IBMtape0 when prompted for the device name.6. Enter 1 (Read/Write).7. Enter 3 (Inquiry). Specify 0 when prompted for an inquiry page. This

concludes a very basic test of the device, SCSI connection, and the devicedriver. You may stop the test here or continue to perform a more complete testas follows:

8. Enter 4 (Test Unit Ready) until no error occurs.9. Enter 20 (Rewind).

10. Enter 28 (Read and Write Tests).11. Enter 1 (Read/Write). Press the Enter key three times to accept the defaults

and run the test.12. Enter 38 (Unload Tape).13. Enter 2 (Close a Device).14. Enter Q (Quit Program).

Medium Changer Device Attachment TestThe following procedure tests the attachment of a medium changer device to aLinux system. The procedure assumes that your device is attached at/dev/IBMchanger0. You also need a cartridge in at least one of the slots.

When the Hit <Enter> to Continue ... message is displayed or when you are toldto enter information, press Enter after following the instructions. When the utilitydisplays information, use the appropriate hardware manual to verify that theinformation is reasonable.1. Open a Linux window.2. Enter IBMtapeutil. A menu is displayed.

Linux - Verifying Proper Attachment of Your Devices

348 IBM Tape Device Drivers Installation and User’s Guide

Page 367: IBM Tape Driver IUG 1

3. Enter 1 (Open a Device).4. Enter /dev/IBMchanger0 when prompted for the device name.5. Enter 3 (Inquiry). Specify 0 when prompted for an inquiry page. This

concludes a very basic test of the device, SCSI connection, and the devicedriver. You may stop the test here or continue to perform a more complete testas follows:

6. Enter 4 (Test Unit Ready).7. Enter 60 (Element Information).8. Enter 62 (Element Inventory).9. From the output of the previous step, select a writable, scratch cartridge and

determine its element ID. Also, select the element ID of an unoccupied slot.10. Enter 64 (Move Medium), then supply the address of the cartridge, followed

by the address of the unoccupied slot. Verify that the cartridge moved.11. Enter 62 (Element Inventory). Verify that the inventory was updated correctly.12. Enter 2 (Close a Device).13. Enter Q (Quit Program).

3494 Enterprise Tape Library Attachment TestThe following procedure tests the attachment of a 3494 Enterprise Tape Library toa Linux 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 -ql

3. Enter mtlib -l L3494 -qL

Linux - Verifying Proper Attachment of Your Devices

Appendix B. Verifying Proper Attachment of Your Devices 349

Page 368: IBM Tape Driver IUG 1

Solaris System

Tape Device Attachment TestThe following procedure tests the attachment of a tape device to a Sun Solarissystem. The procedure assumes that your device is attached at /dev/rmt/0st. Whenyou are told to enter information, press Enter after following the instruction. Whenthe utility displays information, use the appropriate hardware manual to verifythat the information is reasonable.1. Bring up a shell prompt.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/rmt/0st when prompted for the device name.5. Enter 1 (Read/Write).6. Enter D (Device Info).7. Enter 10 (Inquiry).8. Enter Q to quit tapeutil.

Autochanger Device Attachment TestThe following procedure tests the attachment of an autochanger device to a SunSolaris system. The procedure assumes that your device is attached at /dev/rmt/0smcand that the ACF is in Random mode. You also need a cartridge in at least one ofthe slots.

When you are told to enter information, press Enter after following the instruction.When the utility displays information, use the appropriate hardware manual toverify that the information is reasonable.1. Bring up a shell prompt.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a device).4. Enter /dev/rmt/0smc when prompted for the device name.5. Enter 1 (Read/Write).6. Enter D (Device Info).7. Enter 5 (Inquiry). This concludes a very basic test of the device, SCSI

connection, and the device driver. You may stop the test here or continue toperform a more complete test.

8. Enter 6 (Test Unit Ready) until no error occurs.9. Enter 17 (Element Inventory).

10. From the output in the previous step, select a writable, scratch cartridge anddetermine its element ID. Also, select the element ID of an unoccupied slot.

11. Enter 14 (Move Medium), then supply the address of the cartridge and theaddress of the unoccupied slot. Verify that the cartridge moved.

12. Enter 17 (Element Inventory).13. Verify that the inventory was updated properly.14. Enter 2 (Close a Device).15. Enter Q (Quit Program).

Solaris - Verifying Proper Attachment of Your Devices

350 IBM Tape Device Drivers Installation and User’s Guide

Page 369: IBM Tape Driver IUG 1

3494 Enterprise Tape Library Attachment TestThe following procedure tests the attachment of a 3494 Enterprise Tape Library toa Sun Solaris 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

Solaris - Verifying Proper Attachment of Your Devices

Appendix B. Verifying Proper Attachment of Your Devices 351

Page 370: IBM Tape Driver IUG 1

Microsoft Windows System

Tape Device Attachment TestThe following procedure tests the attachment of a tape device to a MicrosoftWindows system. The procedure assumes that your device is attached at tape0 andthat there is no cartridge in the drive.

When the message Return to continue: message is displayed or when you are toldto enter information, press Enter after following the instruction. When the utilitydisplays information, use the appropriate hardware manual to verify that theinformation is reasonable.1. Open a Windows command shell window.2. For Windows NT users, if you want to perform a more complete test and your

device has an autoloader, use the instructions in “Autochanger DeviceAttachment Test - Windows NT Only” on page 352 to mount a writablescratch cartridge in the drive. This is accomplished by following the steps inthe procedure, except that in steps 11 and 12, select the element ID of a driverather than the unoccupied slot ID.If you want to perform a more complete test and your device does not havean autoloader, mount a writable scratch cartridge manually into the drive.

3. Enter ntutil.4. Select 1 (Manual test).5. Enter 50 (poll registered devices). All devices detected by adapters (that were

attached and powered-On at system start time) should be displayed.6. Enter 20 (open).7. Enter 1 (Read/Write).8. Enter 49 (inquiry). Reply with 0 (zero) to the Drive=0, Library=1 prompt. This

step concludes a very basic test of the device, adapter connection, and thedevice driver. You may stop the test here or continue to perform a morecomplete test.

9. Enter 39 (test unit ready) until no error occurs. Each time you are promptedwith a Drive=0, Library=1 prompt, reply with 0 (zero).

10. Enter 31 (rewind).11. Enter 87 (Read/Write Test). Enter Y in response to the confirmation message.12. Enter 33 (unload).13. Enter 21 (close).14. Enter 99 (return to main menu).15. Enter 9 (Exit ntutil).

Note: See Microsoft Windows System for information on the ntutil application.

Autochanger Device Attachment Test - Windows NT OnlyThe following procedure tests the attachment of an autochanger device to aWindows NT system. The procedure assumes that your device is attached atlb1.0.0.1 and that the tape device is attached at tape0. You also need a cartridge inat least one of the slots.

Windows - Verifying Proper Attachment of Your Devices

352 IBM Tape Device Drivers Installation and User’s Guide

Page 371: IBM Tape Driver IUG 1

When the Return to continue: message is displayed or when you are told to enterinformation, press Enter after following the instruction. When the utility displaysinformation, use the appropriate hardware manual to verify that the information isreasonable.1. Open a Windows NT command shell window.2. Enter ntutil.3. Select 1 (Manual test).4. Enter 50 (poll registered devices). All devices detected by adapters (that were

attached and powered-On at system start time) should be displayed. Youshould see lb1.0.0.1 in the list of found devices.

5. Enter 8 (Library Mode).6. Enter 20 (open).7. Enter 1 (Read/Write).8. Enter 49 (inquiry). Reply with 0 (zero) to the Drive=0, Library=1 prompt. This

step concludes a very basic test of the device, adapter connection, and thedevice driver. You may stop the test here or continue to perform a morecomplete test.

9. Enter 39 (test unit ready) until no error occurs. Each time you are promptedwith a Drive=0, Library=1 prompt, reply with 1 (zero).

10. Enter 12 (ioctl initialize element status).11. Enter 10 (ioctl return library inventory).12. From the output in the previous step, select a writable, scratch cartridge and

determine its element ID. Also, select the element ID of an unoccupied slot.13. Enter 11 (ioctl move medium), then supply the address of the cartridge and

the address of the unoccupied slot. Verify that the cartridge moved.14. Enter 10 (ioctl return library inventory). Verify that the inventory was updated

properly.15. Enter 21 (close).16. Enter 99 (return to main menu).17. Enter 9 (Exit ntutil).

Note: See Microsoft Windows System for information on the ntutil application.

3494 Enterprise Tape Library Attachment TestThe following procedure tests the attachment of a 3494 Enterprise Tape Library toa Windows system. The procedure assumes that your device is defined inc:\winnt\ibmatl.conf as L3494.1. Open a Windows command shell window.2. Enter mtlib -l L3494 -qI

3. Enter mtlib -l L3494 -qL

Windows - Verifying Proper Attachment of Your Devices

Appendix B. Verifying Proper Attachment of Your Devices 353

Page 372: IBM Tape Driver IUG 1

Tru64 System

Tape Device Attachment TestThe following procedure tests the attachment of a tape device to a Tru64 system.The procedure assumes that your device is attached at /dev/ntape/tape0.

When you are asked to enter information, press the Enter key after following theinstructions. When the utility displays information, use the appropriate hardwaremanual to verify that the information is reasonable.1. Logon to the system as root, or use the su command to gain superuser

privileges.2. Bring up a shell prompt.3. Enter /sbin/scu-f/dev/ntape/tape0 (Open the Tape Device).4. Enter tur (Test Unit Ready)5. Enter Show Inquiry (Inquiry data).6. Enter quit to quit scu.

Medium Changer Device Attachment TestThe following procedure tests the attachment of a medium changer device to aTru64 system. The procedure assumes that your device is attached at/dev/changer/mc0. You also need a cartridge in at least one of the slots.

When you are asked to enter information, press the Enter key after following theinstructions. When the utility displays information, use the appropriate hardwaremanual to verify that the information is reasonable.1. Logon to the system as root, or use the su command to gain superuser

privileges.2. Bring up a shell prompt.3. Enter /sbin/scu -f /dev/changer/mc0 (Open the medium changer device).4. Enter show inquiry (Inquiry Data).

This concludes a very basic test of the device, SCSI connection, and the devicedriver. You may stop the test here or continue to perform a more completetest.

5. Enter tur (Test Unit Ready) until no error occurs.6. Enter show element (Element Inventory).7. From the output in the previous step, select a writable, scratch cartridge and

determine its element address. Also select the element address of anunoccupied slot.

8. Enter move medium source Source_address destination Destination_address to movethe cartridge from the source element address to the destination elementaddress. Verify that the cartridge moved.

9. Enter show element (Element Inventory) to verify that the inventory wasupdated properly.

10. Enter quit (Quit scu).

Tru64 - Verifying Proper Attachment of Your Devices

354 IBM Tape Device Drivers Installation and User’s Guide

Page 373: IBM Tape Driver IUG 1

3494 Enterprise Tape Library Attachment TestThe following procedure tests the attachment of a 3494 Enterprise Tape Library toa Tru64 system. The procedure assumes that your device is defined in/etc/ibmatl.conf as L3494.1. Open a window.2. Enter mtlib -l L3494 -qI3. Enter mtlib -l L3494 -qL

Tru64 - Verifying Proper Attachment of Your Devices

Appendix B. Verifying Proper Attachment of Your Devices 355

Page 374: IBM Tape Driver IUG 1

SGI/IRIX System

3494 Enterprise Tape Library Attachment TestThe following procedure tests the attachment of a 3494 Enterprise Tape Library toa SGI/IRIX 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

SGI/IRIX - Verifying Proper Attachment of Your Devices

356 IBM Tape Device Drivers Installation and User’s Guide

Page 375: IBM Tape Driver IUG 1

Appendix C. Managing the Microcode on the IBM Tape Drive

Microcode is computer software that is stored in nonvolatile storage on your tapedevice or library hardware. It controls the operation of your hardware. When yourtape device or library hardware was manufactured, a microcode load was installedand shipped with your device.

If you are having trouble with your hardware, IBM service personnel will ask whatlevel of microcode you have on your hardware. If they believe you need a newlevel of microcode, they may instruct you to install a newer level of microcode onyour hardware. They will provide you with updated microcode.

You can query the current level of microcode by issuing commands on the frontpanel of your hardware. Consult the appropriate hardware reference manual forspecific instructions on querying your microcode level.

If your device is connected to a host system that has device or library support, youcan also query the last four digits of the current level of microcode using software,refer to Chapter 10, “IBM Tape Diagnostic Tool (ITDT),” on page 259 or a operatingsystem specific tapeutil command. The unit must be powered On, configuredproperly, and ready. For additional information, refer to the appropriate chapter inthis document (based on the operating system/platform) for details on how tohave the device ready.

The following instructions are a guide to install another version of microcode on atape 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 inthe drive. Follow the instructions in Appendix B, “Verifying Proper Attachmentof Your Devices,” on page 343 to ensure that the drive is configured properlyand ready.

2. Follow the platform-specific instructions.

AIX System1. Open an AIX window.2. Enter tapeutil. A menu is displayed.3. Enter 4 (Tape Drive Service Aids).4. Select Microcode Load.5. Select the device special file identifier for the device on which to load the

microcode, then press Enter.6. Specify the special file from where the microcode image is to be read and press

F7 (Commit) to load the microcode onto the drive. When the loading iscomplete, press F10 (Exit) to return to tapeutil.

7. Enter Q (Quit Program).

© Copyright IBM Corp. 2007, 2009 357

Page 376: IBM Tape Driver IUG 1

HP-UX SystemThis procedure assumes that the /dev/rmt/0m device is being updated.1. Bring up a shell prompt.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/rmt/0m when prompted for the device name.5. Enter 1 (Read/Write).6. Select Download Microcode option.7. Specify the special file from where the microcode image is to be read, then

press the Enter key.8. Enter Q (Quit Program).

Linux SystemThis procedure assumes that the /dev/IBMtape0 tape device is being updated.1. Open a Linux window.2. Enter IBMtapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/IBMtape0 when prompted for the device name.5. Enter 1 (Read/Write).6. Select 72 (Load Ucode).7. Specify the file name from which the microcode image is to be read, then press

the Enter key.8. Enter Q (Quit Program).

Solaris SystemThis procedure assumes that the /dev/rmt/0st tape device is being updated.1. Bring up a shell prompt.2. Enter tapeutil. A menu is displayed.3. Enter 1 (Open a Device).4. Enter /dev/rmt/0st when prompted for the device name.5. Enter 1 (Read/Write).6. Select 7 (Download Microcode).7. Specify the special file from where the microcode image is to be read, then

press the Enter key.8. Enter Q (Quit Program).

Microsoft Windows SystemThis procedure assumes that the new microcode is stored in c:\mydata\d0i9_430.fmr and that the drive at tape0 is being updated. The name of the filecontaining the microcode must have the fmr extension.1. Open a Windows command shell window.2. Change to the c:\mydata directory.3. Enter ntutil.4. Select 1 (Manual test).

Managing Microcode on the IBM Tape Drive

358 IBM Tape Device Drivers Installation and User’s Guide

Page 377: IBM Tape Driver IUG 1

5. Enter 20 (open).6. Enter 1 (Read/Write).7. Enter 6 (test unit ready) until no error occurs.8. Enter 82 (Update Code).9. Enter d0i9_430.

10. Enter 21 (close).11. Enter 99 (return to main menu).12. Enter 9 (Exit ntutil).

Note: See Microsoft Windows System for information on the ntutil application.

Tru64 System1. Bring up a shell prompt.2. Enter IBMrasutil. It prompts you to enter a device filename.3. Enter /dev/device name when prompted.4. Enter 2 (Update Microcode).5. Specify the special file from which the microcode image is to be read, then

press the Enter key.6. Enter 3 (Quit).

Managing Microcode on the IBM Tape Drive

Appendix C. Managing the Microcode on the IBM Tape Drive 359

Page 378: IBM Tape Driver IUG 1

Managing Microcode on the IBM Tape Drive

360 IBM Tape Device Drivers Installation and User’s Guide

Page 379: IBM Tape Driver IUG 1

Appendix D. Tape Utility Programs

Installed with the device driver is a tape utility program (tapeutil), that exercises ortests the functions of the tape device and the device driver. The tape utilityprogram also performs basic tape and medium changer operations.

Attention: Tapeutil provides only a subset of device and command support thatITDT provides. Use ITDT in place of tapeutil for menu functions.

Note: The functions and capabilities of the tape utility program are nowperformed by the IBM Tape Diagnostic Tool (ITDT). For ITDT supportplease refer to “Supported Systems” on page 262.

Table 33. Tape Utility Program Documentation

OperatingSystem Tape Utility Program Command and Location

AIX tapeutil - See “AIX System - Tape Utility Program (tapeutil)” on page 362

HP-UX tapeutil -f drive -o qmc -v - See “HP-UX System - Tape Utility Program(tapeutil)” on page 375

Linux IBMtapeutil –f drive inquiry - See “Linux System - Tape Utility Program(IBMtapeutil)” on page 385

Solaris tapeutil -f drive -o qmc -v - See “Solaris System - Tape Utility Program(tapeutil)” on page 397

MicrosoftWindows

ntutil - See “Microsoft Windows System - Utility Program (ntutil)” on page406

© Copyright IBM Corp. 2007, 2009 361

Page 380: IBM Tape Driver IUG 1

AIX System - Tape Utility Program (tapeutil)Installed with the device driver is a tape utility program, tapeutil, that exercises ortests the functions of the tape device and the device driver. It also performs basictape and medium changer operations. The tape utility program provides twoversions (the interactive interface and the AIX command-line interface) with syntaxsimilar to the tctl and mt commands.

The C source code for the tapeutil.c program can be found in the/usr/lpp/Atape/samples directory. The program contains a sample of the interface tothe device driver and the ioctl commands supported.

Note: This utility program does not support the data path for the IBM 7331, 7336,and 7337 library devices. It can be used only for the medium changerfunctions on the IBM 7331, 7336, and 7337. The data path is supported bythe AIX base device driver and utilities, such as tctl and mt.

Interactive InterfaceThe interactive interface of the tape utility program can be called from the AIXcommand-line using the tapeutil command. A list of general subcommands,medium changer subcommands, and tape subcommands is displayed. You mustopen a device before using these commands and operations (except for the tapedrive service aids).

To open a device:1. Select Open a Device from General Commands.2. Enter the name of the device special file. Use any special file that exists for the

device, for example, /dev/rmt0, /dev/rmt0.1, /dev/rmt1.smc, or /dev/smc0.3. Enter the Read/Write, Read Only, Write Only, or Append mode to open a device.

These modes apply only to the tape devices.

After you open a device, select a command using the appropriate number for thecommand from the interface. Some commands require additional information afterthey are selected. If an error occurs, then the error number, the error text, and thedevice sense data (if applicable) are displayed.

Command-Line InterfaceThe command-line interface of the tapeutil has a syntax similar to the AIX tctl andmt commands and provides the same basic tape commands. The program alsosupports tape device, device driver, SCSI, and medium changer subcommands thatuse the additional functions of the tape device and device driver.

Call the tapeutil command from the AIX command-line or from within a shellscript. If you enter the tapeutil command without any arguments, the interactiveinterface is called.

The syntax for the command-line interface of the tape utility program is:tapeutil -f Device Subcommand [Subcommand ...]

Notes:

1. Device is the name of the device special file (for example, /dev/rmt0).2. Subcommand is any valid command for the device.

AIX - Tape Utility Program (tapeutil)

362 IBM Tape Device Drivers Installation and User’s Guide

Page 381: IBM Tape Driver IUG 1

Multiple subcommands can be combined in a single command to perform morethan one operation. The subcommands are processed one at a time in the orderspecified on the command-line. For a list of subcommands and syntax, enter thetapeutil ? command on the AIX command line.

General SubcommandsThe following general subcommands are available for the tape and mediumchanger devices.

checkpath: This subcommand issues a SCSI Inquiry command to the device on allconfigured paths to determine the status of each path and sets the path to enabledif successful or disabled if unsuccessful. The status of the primary and alternatepath is displayed when the subcommand completes. The output is the same as theqrypath and resetpath subcommands. If more than two paths are configured for thedevice, run the pathsubcommand also.

Examples:# Check the status of paths and display resultstapeutil -f/dev/rmt0 checkpath

# Check the status of more than 2 paths and display resultstapeutil -f/dev/rmt0 checkpath path

devinfo: This subcommand displays the device information returned from theIOCINFO ioctl command.

disable path Primary|Alternate: This subcommand is used to disable the devicedriver from using either the primary SCSI path or the alternate SCSI path to adevice. This subcommand is valid only if the device has both a primary andalternate path enabled.

fuser: This subcommand is similar to the AIX fusercommand. If the device specialfile is currently open, the process ID is displayed. Otherwise, it indicates the devicespecial file is not currently open.

inquiry [Page]: This subcommand issues the SCSI Inquiry command to the devicefor either standard inquiry data, with no page parameter, or for specified page data,and displays the inquiry data. The page parameter must be specified as ahexidecimal value.

Examples:# Get standard inquiry datatapeutil -f/dev/rmt0 inquiry

# get inquiry page x'83'tapeutil -f/dev/rmt0 inquiry 83

kill: This subcommand kills a currently active process on a device. Thissubcommand should be used when the standard Ctrl-C or AIX kill commandmethods cannot terminate the process. For example:# Kill any active process on rmt0tapeutil -f/dev/rmt0 kill

logpage Page: This subcommand issues the SCSI Log Sense command to thedevice for the specified page and displays the log sense data. The page parametermust be specified as a hexidecimal value. For example:# Get log page x'31'tapeutil -f/dev/rmt0 logpage 31

AIX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 363

Page 382: IBM Tape Driver IUG 1

loop [Count]: This subcommand loops all subsequent subcommands continuouslyor a number of times if the Count parameter is specified. Also refer to the sleepsubcommand.

Examples:# Continuously loop inquiry commands with a 2-second delaytapeutil -f/dev/rmt0 loop inquiry sleep 2

# Issue 3 Test Unit Ready commandstapeutil -f/dev/rmt0 loop 3 tur

modepage Page: This subcommand issues the SCSI Mode Sense command to thedevice for the specified page and displays the mode sense data. The page parametermust be specified as a hexidecimal value. For example:# Get mode page x'1D'tapeutil -f/dev/rmt0 modepage 1d

Note: Issuing this subcommand for page x’3F’ all pages is not supported.

passthru: This subcommand opens the device special file using theSC_PASSTHRU mode. This mode bypasses normal open/close processing and noSCSI commands are issued to the device during open or close.

path: 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 primarypath and all alternate paths that are configured. The output from this subcommandis similar to the qrypath subcommand, except more than one alternate path issupported by this subcommand. For example:# Display path informationtapeutil -f/dev/rmt0 path

preempt: This subcommand will clear all persistent reservations and keys on thedevice registered from the same host or other hosts.

print ″Text″: This subcommand prints the associated text to standard output. Itcan be used at any time to display the progress of the subcommands. For example:# Set volume id, erase current tape and backup myfile.tartapeutil -f/dev/rmt0 volid "My Volume" \

rewind \erase \print "Writing myfile.tar" \write -s myfile.tar

qrypath: This subcommand displays information about the device and SCSIpaths, such as logical parent, SCSI IDs, and status of the SCSI paths.

release: This subcommand explicitly releases a device and makes it available forother hosts. Refer to “Reserve and Release Commands” on page 373 for moreinformation.

reqsense: This subcommand issues the SCSI Request Sense command to thedevice and displays the sense data.

reserve: This subcommand explicitly reserves a device. Refer to “Reserve andRelease Commands” on page 373 for more information.

reset: This subcommand opens the device special file using SC_FORCED_OPENmode and causes a bus device reset to be sent to the device.

AIX - Tape Utility Program (tapeutil)

364 IBM Tape Device Drivers Installation and User’s Guide

Page 383: IBM Tape Driver IUG 1

resetpath: This subcommand is used to enable the device driver to use both theprimary SCSI path or the alternate SCSI path after one path has been disabled withthe disablepath subcommand.

sleep Seconds: This subcommand causes the tapeutil program to sleep thespecified seconds before executing the next subcommand. Also refer to the loopsubcommand.

Examples:# Issue 2 inquiry commands with a 1-second delay between commandstapeutil -f/dev/rmt0 inquiry sleep 1 inquiry

# Loop inquiry commands with a 2-second delay between commandstapeutil -f/dev/rmt0 loop inquiry sleep 2

tur: This subcommand issues the SCSI Test Unit Ready command to the device.

vpd: This subcommand obtains the vital product data (VPD) from a SCSI tapedevice. It opens the device special file in SC_DIAGNOSTIC mode and uses theSCSI pass-through ioctl command to obtain the inquiry data from the device.

Medium Changer SubcommandsThe following medium changer subcommands are available for the integrated andindependent medium changer devices.

allow: This subcommand allows medium removal by an operator. It is normallyused after the prevent subcommand to restore the device to the default state.

audit [Address[Count]]: This subcommand with no parameters issues the SCSIInitialize Element Status command to the device.

Using the optional parameters Address and Count issues the SCSI Initialize ElementStatus With Range command to the device. The Address parameter specifies thestarting element address and the Count parameter, if used, specifies the number ofelements to initialize. If Count is omitted, it defaults to 1. For example:# Initialize all elementstapeutil -f/dev/smc0 audit

# Initialize element 32tapeutil -f/dev/smc0 audit 32

# Initialize elements 36 to 40tapeutil -f/dev/smc0 audit 36 5

cartridgelocation [Slot[Count]]: This subcommand with no parameters issues theSCSI Read Element Status command to the device to report all slots with thecartridge location information. Using the optional parameters Slot and Count issuesthe SCSI Read Element Status to the device for a specific starting Slot address andoptionally the Count specifies the number of slots to return. If Count is omitted, itdefaults to 1. For example:# Return cartridge locations for all slot elementstapeutil -f/dev/smc0 cartridgelocation

# Return cartridge location for slot 1024tapeutil -f/dev/smc0 cartidgelocation 1024

# Return cartridge locations for starting slot 1024 and 10 slotstapeutil -f/dev/smc0 cartridgelocation 1024 10

AIX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 365

Page 384: IBM Tape Driver IUG 1

devids: This subcommand issues the SCSI Read Element Status command to thedevice with the read device id option for all drive elements and displays the elementstatus information, which includes the device id field.

elementinfo: This subcommand displays the information returned from theSMCIOC_ELEMENT_INFO ioctl command that contains the number and addressof each element type.

exchange ″Source″ ″Dest1″ ″Dest2″: This subcommand issues the SCSI ExchangeMedium command to the device using the Source, Dest1, and Dest2 addressesspecified. This command performs the equivalent function of two Move Mediumcommands. The first moves the cartridge from the element address specified by theDest1 parameter to the element address specified by the Dest2 parameter. Thesecond moves the cartridge from the element address specified by the sourceparameter to the element address specified by the Dest1 parameter. For example:# Exchange cartridge in slot 34 with cartridge in drive address 16# and return that cartridge to slot 40 (drive must be unloaded first)tapeutil -f/dev/smc0 exchange 34 16 40

# Use move medium commands to perform exchangetapeutil -f/dev/smc0 move 16 40 move 34 16

inventory [-i | -v Volid]: This subcommand with no parameters issues the SCSIRead Element Status command for each element type and displays the elementstatus information. If the optional -i parameter is used, then only theimport/export element status information is returned. If the optional -v parameteris used, then only the element status information for the specified Volid if found isreturned.

mount [Slot]: This subcommand mounts a tape from the specified slot into thedrive or from the first full slot into the drive if the slot is omitted. For example:# Mount cartridge from slot 3tapeutil -f/dev/smc0 mount 3

# Mount cartridge from first full slottapeutil -f/dev/smc0 mount

move ″Source″ ″Destination″: This subcommand issues the SCSI Move Mediumcommand using the source and destination addresses specified. The elementaddresses can be obtained using the elementinfo subcommand. For example:# Get slot and drive addressestapeutil -f/dev/smc0 elementinfo

# Move cartridge in slot 20 to drive at address 16tapeutil -f/dev/smc0 move 20 16

position ″Destination″: This subcommand issues the SCSI Position to Elementcommand using the destination specified. For example:# Position to slot at address 20tapeutil -f/dev/smc0 position 20

prevent: This subcommand prevents medium removal by an operator until theallow subcommand is issued or the device is reset.

unmount [Slot]: This subcommand moves a tape from the drive to the specifiedslot or the first empty one if the slot is omitted. The tape is rewound and unloadedautomatically from the drive first when this command is issued to the tape devicespecial file. For example:

AIX - Tape Utility Program (tapeutil)

366 IBM Tape Device Drivers Installation and User’s Guide

Page 385: IBM Tape Driver IUG 1

# Move tape from drive to slot 4 (tape is already unloaded)tapeutil -f/dev/rmt0.smc unmount 4

# Unload tape and move to the first empty slottapeutil -f/dev/rmt0 unmount

Tape SubcommandsThe following tape subcommands are available for the tape devices.

allow: This subcommand issues the SCSI Prevent Allow Medium Removalcommand to the device to allow medium removal by an operator. It is normallyused after the prevent subcommand to restore the device to the default state.

append: This subcommand opens the device in append mode and allows theappending of data to the end of the current tape. The subcommand can be usedwith a No Rewind on Close special file to set the tape position after the last filethat was written.# Append myfile.tar to the end of tape using dd subcommandtapeutil -f/dev/rmt0.1 appenddd if=myfile.tar of=dev/rmt0

autoload: This subcommand turns on the autoload feature only for subsequentsubcommands. For example:# Backup large.tar (requires multiple tapes) using autoload featuretapeutil -f/dev/rmt0 autoload write -s large.tar

bsf [Count]: This subcommand backward spaces the filemarks. An optional countcan be specified. The default is 1.

bsr [Count]: This subcommand backward spaces the records. An optional countcan be specified. The default is 1.

cancelerase: This subcommand cancels an erase immediate command in progress.

chgpart Number [Blockid]: This subcommand changes the current active tapepartition to a new partition specified by Number. Optionally, a Blockid can also bespecified. If Blockid is omitted, the tape is positioned at the start of the newpartition, otherwise, the tape is positioned at the Blockid specified. For example:# Change to beginning of partition 16tapeutil -f/dev/rmt0 chgpart 16

# Change to partition 0, block number 25tapeutil -f/dev/rmt0 chgpart 0 25

compress and nocompress: These subcommands turn On and Off compressiononly for subsequent subcommands.

density: This subcommand issues the SCSI Report Density command for allsupported media and for the current media loaded in the drive, and displays theresults. If the drive is not loaded, the current media density is not reported and aDrive Not Ready error is returned.

display ″Message″: This subcommand displays a message on the display panel ofthe tape device. Up to 16 characters can be used for the message. If the message islonger than eight characters, the display alternates between the first eightcharacters and the remainder of the message. For example:# Display "Test 1" and "Running" messagestapeutil -f/dev/rmt0 display "Test 1 Running"

AIX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 367

Page 386: IBM Tape Driver IUG 1

eof [Count] and weof [Count]: These subcommands write the filemarks. Anoptional count can be specified. The default is 1.

erase: This subcommand erases the tape.

erg: This subcommand performs an erase record gap operation.

fsf [Count]: This subcommand forward spaces the filemarks. An optional countcan be specified. The default is 1.

fsr [Count]: This subcommand forward spaces the records. An optional count canbe specified. The default is 1.

idp: This subcommand creates an IDP partition on tape. For example:# Create IDP partitiontapeutil -f/dev/rmt0 idp

list: This subcommand displays the content of a tape. The output lists filemarksand the size of each record found on the tape until the end of data is reached. Theoutput generated from this subcommand can be large depending on the amount ofdata on the tape and should usually be directed to a file. For example:# List tape contents to filetapeutil -f/dev/rmt0 list > tape.list

load: This subcommand issues the SCSI Load command to load the next tape.

logsense: This subcommand issues the STIOC_LOG_SENSE ioctl command anddisplays the data. If volume logging is active, then the log sense data is also savedin the log file.

mtdevice: This subcommand issues the MTDEVICE ioctl command and displaysthe library sequence number. Refer to the MTLIB command -D flag in Figure 40 onpage 199.

noautoload: This subcommand turns off the autoload feature only for subsequentsubcommands. For example:# Make sure autoload feature is off before writing file to tapetapeutil -f/dev/rmt0 noautoload write -s myfile.tar

nosili: This subcommand turns off the Suppress Incorrect Length Indication (SILI)bit in variable length SCSI Read commands for all subsequent subcommands, suchas rtest, rwtest, and read.

offline, rewoffl, and unload: These subcommands rewind and unload the tape.

parms and status: These subcommands issue the STIOCQRYP ioctl command anddisplay the current tape drive, media, and device driver parameters.

prevent: This subcommand issues the SCSI Prevent Allow Medium Removalcommand to the device to prevent medium removal by an operator until the allowsubcommand is issued or the device is reset.

qrypart: This subcommand queries and displays tape partitioning information.

AIX - Tape Utility Program (tapeutil)

368 IBM Tape Device Drivers Installation and User’s Guide

Page 387: IBM Tape Driver IUG 1

qrypos: This subcommand issues the STIOCQRYPOS ioctl command for thelogical and physical tape positions and displays the data. In addition, the currenttape position is saved and can be restored using a subsequent setpos subcommand.For example:# Append myfile.tar to the end of tape and then read backtapeutil -f/dev/rmt0.1 append \

qrypos \write -s myfile.tar \setpos \read -d temp.tar

# Verify myfile.tar was written correctlydiff myfile.tar temp.tar

read -d Destination [-c Count]: This subcommand reads a file, or a specifiednumber of records, from the tape to the destination file name specified with the -dflag. If the optional count parameter is used, only the number of records specifiedwith the -c flag are read unless a filemark is encountered before the number ofspecified records. If the count parameter is not used, all records up to the nextfilemark on tape are read. For example:# Restore myfile.tar from tapetapeutil -f/dev/rmt0 read -d myfile.tar

# Read 3 records from the tape into myfiletapeutil -f/dev/rmt0 read -d myfile -c3

rewind and retension: These subcommands rewind the tape.

rtest [-b Blocksize] [-c Count] [-r Repetition]: This subcommand performs a readtest by reading a random data pattern from the tape and verifying that it matchesthe written data. The rtest subcommand can be used after the wtest subcommandto verify the data.

An optional block size, count, and repetition can be specified with the -b, -c, and -rflags, respectively. If the block size is fixed, then the count specifies the number ofblocks to read on each repetition. If the block size is zero (variable), then the countspecifies the number of bytes to read on each repetition. The default is a block size of10240, a count of 20 blocks, and a repetition of 1. For example:# R/W test using 256 KB blocks, 5 megabytes per write, 100 timestapeutil -f/dev/rmt0 rewind \

wtest -b 262144 -c 20 -r 100 \rewind \rtest -b 262144 -c 20 -r 100

rwtest [-b Blocksize] [-c Count] [-r Repetition]: This subcommand performs aread and write test by writing a random data pattern on the tape, reading it, andverifying that it matches the written data.

An optional block size, count, and repetition can be specified with the -b, -c, and -rflags, respectively. If the block size is fixed, then the count specifies the number ofblocks to write on each repetition. If the block size is zero (variable), then the countspecifies the number of bytes to write on each repetition. The default is a block sizeof 10240, a count of 20 blocks, and a repetition of 1. For example:# R/W test using 256 KB blocks, 5 megabytes per write, 10 timestapeutil -f/dev/rmt0 rwtest -b 262144 -c 20 -r 10

sdp Number: This subcommand creates the specified Number of SDP partitions ontape. For example:

AIX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 369

Page 388: IBM Tape Driver IUG 1

# Create 32 SDP partitions and then query partitioningtapeutil -f/dev/rmt0 sdp 32 qrypart

seod: This subcommand spaces to the end of data on the tape.

setpos [Blockid]: This subcommand issues the SCSI Locate command to the deviceto set the tape position. If the optional Blockid parameter is specified, the tapeposition is set to the Blockid. Otherwise, if the Blockid parameter is omitted, the tapeposition is set to the last position saved using the qrypos subcommand. The Blockidcan be specified in decimal or in hexidecimal, with a leading x. For example:# Append myfile.tar to the end of tape and then read backtapeutil -f/dev/rmt0.1 append \

qrypos \write -s myfile.tar \setpos \read -d temp.tar

# Verify myfile.tar was written correctlydiff myfile.tar temp.tar

# Set tape position to block 32 and leave positioned on closetapeutil -f/dev/rmt0.1 setpos 32

# Set tape position to block 32 and leave positioned on closetapeutil -f/dev/rmt0.1 setpos x20

sili: This subcommand turns on the SILI bit in variable length SCSI Readcommands for all subsequent subcommands, such as rtest, rwtest, and read.

sync: This subcommand synchronizes or flushes the tape buffers to tape.

volid ″Name″: This subcommand sets the volume ID for logging. Refer to“Volume ID for Logging” on page 34 and “Volume ID for Logging” on page 374.

write -s Source: This subcommand writes the source file specified with the -s flagon the tape. For example:# Backup myfile.tar to tapetapeutil -f/dev/rmt0 write -s myfile.tar

wtest [-b Blocksize] [-c Count] [-r Repetition]: This subcommand performs awrite test by writing a random data pattern on the tape. The rtest subcommandcan 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 -rflags, respectively. If the block size is fixed, then the count specifies the number ofblocks to write on each repetition. If the block size is zero (variable), then the countspecifies the number of bytes to write on each repetition. The default is a block sizeof 10240, a count of 20 blocks, and a repetition of 1. For example:# R/W test using 256 KB blocks, 5 megabytes per write, 100 timestapeutil -f/dev/rmt0 rewind \

wtest -b 262144 -c 20 -r 100 \rewind \rtest -b 262144 -c 20 -r 100

Service Aid SubcommandsThe following service aid subcommands are available for the tape devices.

dump [Filename]: This subcommand forces a dump on the tape device and storesthe dump in the specified Filename or, if Filename is omitted, in the system/var/adm/ras directory. The device driver stores up to three dump files in this

AIX - Tape Utility Program (tapeutil)

370 IBM Tape Device Drivers Installation and User’s Guide

Page 389: IBM Tape Driver IUG 1

directory. The first dump file is named Atape.rmtx.dump1, where: x is the devicenumber (for example, rmt0). The second and third dump files are named dump2and dump3, respectively. After a third dump file is created, the next dump starts atdump1 again and overlays the previous dump file.

fmrtape: This subcommand issues a Send Diagnostic SCSI command to the deviceto create a field microcode replacement (FMR) cartridge tape. The tape is createdusing the loaded functional microcode in the device when the command is issued.

forcedump: This subcommand issues a Send Diagnostic SCSI command to force adump on the tape drive. The dump can be read using the readdump subcommand.

readbufferid ″id″ [Filename]: This subcommand reads a specific buffer id fromthe device and stores the data in the specified Filename or if Filename is omitted,displays it to standard out.

readdump [Filename]: This subcommand reads and stores a tape drive dump inthe specified filename or, if filename is omitted, in the system /var/adm/ras directory.It performs the same function as the dump subcommand above without forcing adump first.

resetdrive: This subcommand issues a Send Diagnostic SCSI command to resetthe device.

ucode ″Name″: This subcommand downloads microcode to the device. The Nameparameter can specify a diskette drive, such as /dev/rfd0, or a microcode file on theRISC machine. For example:# download microcode from diskettetapeutil -f/dev/rmt0 ucode /dev/rfd0

# download microcode from RISC filetapeutil -f/dev/rmt0 ucode /etc/microcode/device.ucode

Automatic Cartridge Facility ModeIf the device is the IBM TotalStorage Enterprise Tape System 3590 with anAutomatic Cartridge Facility (ACF) or the IBM Magstar MP 3570 library, the ACFmode can be queried using either the interactive interface of the tape utilityprogram and selecting Query/Set Parameters under Tape Commands or using thecommand-line interface and issuing the parms or status subcommand.

Block Size and SCSI Transfer SizeThe minimum and maximum block sizes for the tape device and the maximumSCSI transfer size can be queried using either the interactive interface of the tapeutility program and selecting Query/Set Parameters under Tape Commands orusing the command-line interface and issuing the parms or status subcommand.

Configuration ParametersThe configuration parameters can be queried using either the interactive interfaceof the tape utility program and selecting Query/Set Parameters under TapeCommands or using the command-line interface and issuing the parms or statussubcommand.

The configuration parameters can be changed temporarily using the interactiveinterface of the tape utility program and selecting Query/Set Parameters underTape Commands.

AIX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 371

Page 390: IBM Tape Driver IUG 1

Note: The changes are effective only while the current device is open. Allconfiguration parameters are reset to their current default values when thedevice is closed.

Capacity ScalingThe capacity scaling of the current tape can be queried or set using the interactiveinterface of the tape utility program and selecting Query/Set Parameters underTape Commands.

Logical Write ProtectThe logical write protect of the current tape can be queried or set using theinteractive interface of the tape utility program and selecting Query/Set Parametersunder Tape Commands.

Querying Primary and Alternate Path ConfigurationsYou can display the primary and alternate path configuration for all devices withthe lsdev command. There can be two or more logical devices configured for asingle physical device, but the first device configured is labeled the primary device.All other logical devices configured after the first device are labeled as alternatedevices. To see this, run the lsdev -Cc tape command and look at the location fieldin the data. Run the following command:lsdev -Cc tape | grep P

For example, you can easily determine how many physical devices are configuredwith path failover support.

You can display the primary and alternate path configuration for any device byrunning:tapeutil -f/dev/smcx path (where smcx is the logical name of any device)

This command shows specific information for the primary path and all alternatepaths, such as the logical name of the device, SCSI IDs, the current enabled status,and how many paths are configured for the device.

Querying Tape Drive Encryption SettingsThere is a tape diagnostic and utility function available for encryption to querytape drive encryption settings.

The current tape drive encryption settings can be queried using the tapeutil menuoption 38 “Get Drive Encryption Settings” or the command line tapeutil–f/dev/name encryption.

Following is an example of a correct tape drive configuration with wrt_encryptionset to on. If the wrt_encryption attribute is set to no, then the tape drive“Encryption State” is Off.>tapeutil -f/dev/rmt1 encryption

Getting drive encryption settings...Encryption settings:

Drive Encryption Capable.... YesEncryption Method........... SystemEncryption State............ On

AIX - Tape Utility Program (tapeutil)

372 IBM Tape Device Drivers Installation and User’s Guide

Page 391: IBM Tape Driver IUG 1

Reserve and Release CommandsThe device driver reserves the device automatically on the open call and releasesthe device on the close call. This prevents other applications and hosts fromaccessing the device. However, there may be situations when the reserve should bemaintained after the close call. For example, some backup programs such as tar canopen and close the device multiple times and the device is shared by multipleinitiators or hosts. In these cases, the reservation must be retained between theclose call and the next open call. This is done by explicitly reserving and retainingthe reservation on the device after close. After all work is completed on the device,the user will need to explicitly release the device and not retain the reservation.

A device reservation can be retained and released explicitly using thecommand-line interface by issuing the retain and noretain subcommands. Forexample:# Reserve device, run tar, and then release devicetapeutil -f/dev/rmt0 retaintar ... /dev/rmt0 ...tapeutil -f/dev/rmt0 noretain

After the tapeutil retain command is used, the device driver retains the reservationuntil a tapeutil noretain command is issued. If the device is unconfigured andreconfigured, then the retain reservation setting is no longer active. To configurethe device to always retain a reservation on close, issue the command:chdev -l device -a retain_reserve=yes

Testing Data Encryption Configuration and ConnectivityThere is a tapeutil command available to validate the ibmekm.conf file serverentries and test tape drive to server connectivity operations. This test can be runusing the tapeutil menu option 40 “Data Encryption Test” or the command line“tapeutil –f/dev/name ekmtest”.

Note: See “AIX System - Tape Utility Program (tapeutil)” on page 362 forinformation on the tapeutil application.

The first test checks the server configuration defined in the ibmekm.conf file andthen communication to the configured servers. This test reports back the number ofservers available. The second test runs a basic diagnostic that checks the tape driveto server communication and reports success or fail. The third test runs anenhanced diagnostic that checks a key operation between the tape drive and serverthen reports success or fail.

Following is an example of a successful test:> tapeutil –f /dev/rmt2 ekmtest

Testing server configuration and connections...Test complete, servers available 2Running basic drive to server encryption test...Test complete, completion code 0Running full drive to server encryption test...Test complete, completion code 0>

If the first server test fails with one of the following errors, then the remainingtests are not run. Perform the following recommended problem determinationsteps to resolve the problem:

AIX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 373

Page 392: IBM Tape Driver IUG 1

1. “Invalid argument or Operation not supported on device” - System encryptionis not configured for the tape drive in the device driver. Use SMIT to setsystem encryption to “yes” for the tape drive. If system encryption can not beset then the tape drive is not encryption capable.

2. “Can’t assign requested address” - Either the ibmekm.conf file is missing or isinvalid. Check and correct.

3. “Network is down” – All configured servers in the ibmekm.conf file are notavailable. Check all servers configured in the ibmekm.conf file are currentlyrunning on the server IP address and configured correctly.

Volume ID for LoggingThe volume ID used in the log entry when volume logging is active can be setusing either the interactive interface of the tape utility program and selectingQuery/Set Parameters under Tape Commands or using the command-line interfaceand issuing the volid subcommand. For example:# Unload tape, load next tape, and set volume idtapeutil -f /dev/rmt0 unload load volid "VOLSER001"

AIX - Tape Utility Program (tapeutil)

374 IBM Tape Device Drivers Installation and User’s Guide

Page 393: IBM Tape Driver IUG 1

HP-UX System - Tape Utility Program (tapeutil)This chapter describes how to install, uninstall and use the IBM HP-UX TapeUtility Program, tapeutil.

Command Sequence InformationTake note of the following facts about the command sequences described in thissection:v In some of the examples, filenames given on the command-line must be

referenced with an absolute path. Using ’pwd’/filename to reference to a fileinstead of filename ensures this.

v All the software distributor commands (for example, swinstall or swcopy) can firstbe run with the -p flag to preview the command. After observing the previewoutput, reissue the command without the -p flag to perform the actual operation.

v The software distributor commands are moderately complex scripts thatfrequently require several steps. The steps are typically Selection, Analysis, andExecution. Each step may produce useful information and error messages, so it isa good idea to carefully observe the results of the installation process as itoccurs.

If you run into unexpected results during the installation, check the associated logfile.

Product RequirementsThe following hardware and software components are required and supported byIBM and are necessary for implementation of the tapeutil.

Tapeutil ImplementationThe tapeutil program contains utility program implementations for operation in thefollowing HP-UX platform environments:v HP Precision Bus - HP-UX 10.20 and 11.00 - versions of this program are

identified by levels tapeutil.hpux.3.x.x.x

v HP PCI Bus - If you are using the ATDD version 1.7.7.2 or later, on HP-UX 11.00,use tapeutil.hpux.4.0.0.0 or later. If you are using the ATDD version 3.0.0.1 orlater, on HP-UX 11i, use tapeutil.hpux.4.0.0.0 or later. Otherwise, use tapeutil leveltapeutil.hpux.3.x.x.x.

Hardware RequirementsRefer to “Hardware Requirements” on page 56.

Install tapeutilInstalling the product manually requires the three steps detailed in the followingsections:1. “Copy the Software to the Software Depot” on page 3752. “Review the tapeutil README File” on page 3763. “Install tapeutil” on page 376

Copy the Software to the Software DepotCopy the software from its location to the Software Depot.

# swcopy -p -s /tapeutil_location/tapeutil.hpux.x.x.x.x tapeutil (preview option)# swcopy -s /tapeutil_location/tapeutil.hpux.x.x.x.x tapeutil

HP-UX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 375

Page 394: IBM Tape Driver IUG 1

Use swlist to verify that the tapeutil software is in the depot:

# swlist -d tapeutil

Review the tapeutil README FileAfter copying the tapeutil software to the depot, use the swlist command to viewthe README file in the directory /opt/tapeutil:

# swlist -d -a readme tapeutil

The README file lists the system configuration requirements, including requiredsystem software patches and required tape related firmware versions. The file alsodocuments any changes in the installation, use, and administration of the softwarethat occurred after this documentation was completed. Review it before proceedingwith the software installation.

Install tapeutilWhen the software is in the depot, the tapeutil software can be installed to the rootfile system using the HP-UX swinstall command.

The following commands install tapeutil from the depot to the default root filesystem:

# swinstall -p tapeutil (preview option)# swinstall tapeutil

You can use swlist to list the software installed on the default root file system asfollows:

# swlist tapeutil

You can verify correct installation to the default root file system with the swverifycommand:

# swverify tapeutil

Uninstalling tapeutil

Attention: Do not try to uninstall the ATDD software by simply deleting the filesthat make up the ATDD fileset. This causes a number of inconsistencies on thesystem. It is best to use the swremove command.

To remove the tapeutil software from the root file system, enter:

# swremove -p tapeutil (preview option)# swremove tapeutil

Other Administrative TasksTo determine the version of tapeutil currently installed on the default root filesystem:

# swlist -a state tapeutil

To determine the version of tapeutil stored in the default depot:

HP-UX - Tape Utility Program (tapeutil)

376 IBM Tape Device Drivers Installation and User’s Guide

Page 395: IBM Tape Driver IUG 1

# swlist -d state tapeutil

To view the set of files installed with tapeutil:

# swlist -l file tapeutil

To remove tapeutil from the depot:

# swremove -d tapeutil

Using the tapeutil ProgramA Tape and Medium Changer Utility Program called tapeutil is provided with theIBM Tape and Medium Changer Device Driver for HP-UX and installed in the/usr/bin directory. The tapeutil program fulfills several purposes:v The program provides the following service aids for IBM tape systems:

– Query Device Type/Verify Device Attachment– Query Device Serial Number– Query Device Microcode Level– Force Device Diagnostic Dump– Store Device Diagnostic Dump– Download Device Microcode

v The program provides a menu driven test tool for exercising or testing IBM tapeand medium changer devices with a full suite of supported operations:– Reading/Writing Data– Tape Motion Commands– Setting/Displaying Device Information/Status– Mounting/Demounting Cartridges– Cartridge Inventory

v In addition to the menu driven front end, the tapeutil program provides acommand-line interface, convenient for use in shell scripts.

v The source code for the tapeutil program is provided for example purposes andis installed in the /opt/tapeutil directory during the tapeutil package installation.This source code is commented and demonstrates calls to all the supporteddevice driver entry points and ioctl commands, giving the application developera starting point for interfacing to the HP-UX device driver.

Interactive Mode

The tapeutil program provides both an interactive mode and a command-linemode. If the tapeutil program is called with no command-line parameters, theinteractive mode version is started. In the interactive mode, the device to beoperated on should first be opened using option 1. Other options may then beselected. The user is prompted for additional information if required for thespecific options selected. The results of a command are displayed after it isexecuted. If an error occurs for the command, error information and device sensedata are displayed. The device can be closed using option 2, or it is closedautomatically when the Quit option is selected. The menu is displayed onceautomatically when the program is first called. To prevent unnecessary scrolling ofthe screen, the menu is not displayed again automatically after each command butinstead is refreshed only after the M (menu refresh) command is entered.

HP-UX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 377

Page 396: IBM Tape Driver IUG 1

These commands can issue the MTIOCTOP ioctl with the MT opcodes defined in/usr/include/sys/mtio.h (MT mode), or issue the STIOC_TAPE_OP ioctl with theST_OP opcodes defined in /usr/include/sys/st.h (ST mode). For detailed information,refer to the MTIOCTOP and STIOC_TAPE_OP sections in the IBM Tape DeviceDrivers Programming Reference, GA32-0566.

The default for tapeutil is the ST mode. Toggle between the MT or ST mode byusing option 8. The following commands run in the two modes:v Write File Markv Erase Tapev Rewindv Offlinev Forward/Backward Space Filev Forward/Backward Space Recordv Locate End of Data

Command-Line InterfaceIf command-line parameters are provided when the program is started, theprogram runs in command-line mode. When in command-line mode, the device isfirst opened, the specific command is issued, and the device is then closed. Theprogram can be invoked from within a shell script if desired. Results of theoperation are displayed only when executed in verbose mode. No information isdisplayed when not in verbose mode. This is particularly useful for quiet shellscript implementations. A completion code, as defined in /usr/include/sys/errno.h, forthe operation requested, is always returned from the program upon exit (in bothverbose and quiet mode).

The usage of the tapeutil program in command-line mode is as follows:tapeutil -f device -o operation [options]

Where: device is the name of the tape device special file (for example, /dev/rmt/1m)and operation is one of the values listed below. The device special file and theoperation are required. The specific options associated with a particular operationare indicated below. Parameters enclosed in square brackets are optional. All othersare required.

Service CommandsQuery Serial Number tapeutil -f f -o qsn [-w w] [-v]

Query Microcode Level tapeutil -f f -o qmc [-w w] [-v]

Force Dump tapeutil -f f -o fdp [-w w] [-v]

Store Dump tapeutil -f f -o sdp [-w w] [-v] -z z

Download Microcode tapeutil -f f -o dmc [-w w] [-v] -z z

Query Device Type tapeutil -f f -o chk [-w w] [-v]

Basic SCSI CommandsTest Unit Ready tapeutil -f f -o tur [-w w] [-v]

Inquiry/Inquiry Page tapeutil -f f -o inq [-w w] [-v] [-t t] [-x x]

Request Sense tapeutil -f f -o req [-w w] [-v]

Log Sense Page tapeutil -f f -o log [-w w] [-v] [-x x]

HP-UX - Tape Utility Program (tapeutil)

378 IBM Tape Device Drivers Installation and User’s Guide

Page 397: IBM Tape Driver IUG 1

Mode Page tapeutil -f f -o mod [-w w] [-v] -x x

Reserve on Close tapeutil -f f -o mod [-w w] [-v] -x x

Reserve tapeutil -f f -o res [-w w] [-v]

Release tapeutil -f f -o rel [-w w] [-v]

Prevent/Allow Medium Removaltapeutil -f f -o rem [-w w] [-v]-x x

Medium Changer CommandsMove Medium

tapeutil -f f -o mov [-w w] [-v] -s s -d d

Position To Elementtapeutil -f f -o pos [-w w] [-v] -s s

Element Informationtapeutil -f f -o ele [-w w] [-v]

Read Element Status with Drive IDtapeutil -f f -o dvc[-w w] [-v]

Inventory tapeutil -f f -o inv [-w w] [-v]

To Output the Inventory Data into a Filetapeutil -f f -o inv -t 1 [-w w] [-v] > filename

Audit tapeutil -f f -o aud [-w w] [-v]

Lock/Unlock Doortapeutil -f f -o lck [-w w] [-v] -x x

Note: Exchange Medium and Initial Element Status Range commands are notsupported by IBM TotalStorage and System Storage tape devices.

CPF CommandsDisplay Paths tapeutil -f f -o phs[-v]

Enable Path tapeutil -f f -o ena -p path [-v]

Disable Path tapeutil -f f -o dis -p path [-v]

Tape Drive CommandsRead tapeutil -f f -o rea [-w w] [-v] -b b -n n -m m

Write tapeutil -f f -o wri [-w w] [-v] -b b -n n -m m [-r r] [-z z]

Write File Mark tapeutil -f f -o eof [-w w] [-v] -c c

Erase Tape tapeutil -f f -o era [-w w] [-v]

Rewind tapeutil -f f -o rew [-w w] [-v]

Retension tapeutil -f f -o ret [-w w] [-v]

Offline tapeutil -f f -o off [-w w] [-v]

Load/Unload Tape tapeutil -f f -o lod [-w w] [-v] -x x

Forward Space File tapeutil -f f -o fsf [-w w] [-v] -c c

Backward Space File tapeutil -f f -o bsf [-w w] [-v] -c c

Forward Space Record tapeutil -f f -o fsr [-w w] [-v] -c c

HP-UX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 379

Page 398: IBM Tape Driver IUG 1

Backward Space Record tapeutil -f f -o bsr [-w w] [-v] -c c

Locate End of Data tapeutil -f f -o eod [-w w] [-v]

Report Tape Density tapeutil -f f -o den [-w w] [-v]

Check Device Type tapeutil -f f -o chk [-w w] [-v]

Get Record Size tapeutil -f f -o grs [-w w] [-v]

Set Record Size tapeutil -f f -o srs [-w w] [-v] -c c

Get Device Status tapeutil -f f -o gds [-w w] [-v]

Get Device Information tapeutil -f f -o gdi [-w w] [-v]

Get Media Information tapeutil -f f -o gmi [-w w] [-v]

Get Position tapeutil -f f -o gpo [-w w] [-v] -t t

Set Position tapeutil -f f -o spo [-w w] [-v] -t t -x x

Get Parameter tapeutil -f f -o gpa [-w w] [-v] -t t

Set Parameter tapeutil -f f -o spa [-w w] [-v] -t t -x x

Sync Buffer tapeutil -f f -o syn [-w w] [-v]

Display Message tapeutil -f f -o msg [-w w] [-v] -t t -y y1,y1

Note: Invoking the tapeutil program with the -h flag (for example, tapeutil -h) or-? flag (for example, tapeutil -?) displays the usage help information.

Flag DescriptionThe supported flags, their meanings, their associated operations, and theiracceptable ranges are as follows:

-? Usage Help (stand-alone flag) {no value required}

-b Block Size (rea, wri)

{0 < (block size x blocking factor) < 2097152}

-c Operation Count (eof, fsf, fsr, bsf, bsr, srs) {0–65535}

-d Destination Address (mov)

{device specific, determine range from Element Info}

-f Device Special File Name (always required)

{/dev/rmt/1st or similar}

-h Usage Help (stand alone flag) {no value required}

-m Multiples to Read or Write (rea, wri) {0–2097152}

-n Blocking Factor (rea, wri)

{0 > (block size x blocking factor) < 2097152}

-o Operation (always required) {refer to the previous list}

-p The path that is enabled or disabled

-r Random Seed (wri) {0–65535}

-s Source Address (mov, pos)

{device specific, determine range from Element Info}

-t Type of Parameter Value

HP-UX - Tape Utility Program (tapeutil)

380 IBM Tape Device Drivers Installation and User’s Guide

Page 399: IBM Tape Driver IUG 1

v (gpo) {1=logical block, 2=physical block}v (spo) {1=logical block, 2=physical block}v (gpa) {1=block size, 2=compression, 3=buffering, 4=immediate,

5=trailer, 6=write protect, 7=acf mode, 8=capacity, 9=sili}v (spa) {1=block size, 2=compression, 3=buffering, 4=immediate,

5=trailer, 6=write protect, 8=capacity, 9=sili}v (msg) {1=display msg0, 2=display msg1, 3=flash msg0,

4=flash msg1, 5=alternate msg1/msg2}v (inq) {0=standard data, 1=page code}v {0=mt mode, 1=st mode}

-v Verbose Mode (optional for all commands, stand-alone flag)

{no value required, absence of flag means quiet mode}

-w Open Mode (optional for all commands)

{1=read/write, 2=read only (default), 3=write only, 4=append}

-x Parameter Valuev (lck) {1=lock, 2=unlock}v (lod) {1=load, 2=unload}v (spo) {0–65535}v (spa) {0–65535}v (inq) {0x0–0xFF}v (log) {0x00–0xFF}v (mod) {0x00–0xFF}v (rem) {1=prevent, 2=allow}

-y Messages (msg) {message1,message2}

-z Input/Output File Namev (sdp) {path and name of the file in which to store dump}v (dmc) {path and name of the microcode image file}v (wri) {path and name of the file containing write data pattern}

Notes:

1. For read and write operations, the size of one buffer of data transferred duringa single SCSI read or write command is determined by the product of the BlockSize value and the Blocking Factor value. The number of these bufferstransferred is determined by Multiplier value. The actual total number of bytestransferred is then (Block Size) x (Blocking Factor) x (Multiplier). If the deviceis set to fixed block mode (block size not equal to zero), the product of BlockSize and Blocking Factor must be a multiple of the device block size setting.

2. For further information on the Get Parameter (gpa) and Set Parameter (spa)operations, refer to the STIOC_GET_PARM and STIOC_SET_PARM ioctlcommands in the IBM Tape Device Drivers Programming Reference, GA32-0566.

3. All media types for the 3590 tape drive support capacity scaling. Capacityscaling is only supported for the standard 300 GB re-writable Data Cartridgefor the 3592 tape drive. Attempting to set capacity scaling that is not supportedby a device or the current media loaded returns a failure.

4. If the current microcode on a tape drive is FIPS (Federal Information ProcessingStandard) code, then a window opens and displays the following:

HP-UX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 381

Page 400: IBM Tape Driver IUG 1

Warning: The drive is currently using FIPS code. Do you want tocontinue with downloading new drive code? [y/n]:

Enter n to exit without downloading new code; otherwise, enter y to continuewith the download code procedure.

The following examples should help to demonstrate and clarify the command-lineusage of the tapeutil program. For all examples, substitute the actual value of thespecial file associated with the target device.v To query the serial number of the device:

tapeutil -f /dev/rmt/0m -o qsn -v

v To request inquiry data from the device:tapeutil -f /dev/rmt/0m -o inq -v

v To request inquiry page data from the device:tapeutil -f /dev/rmt/0m -o inq -t 1 -x 0x03 -v

v To request log sense page from the device:tapeutil -f /dev/rmt/0m -o log -x 0x00 -v

v To request mode page from the device:tapeutil -f /dev/rmt/0m -o mod -x 0x02 -v

v To move a cartridge from cell 32 to the tape drive (16) for TotalStorage 3590:tapeutil -f /dev/rmt/4chng -o mo -s 32 -d 16 -v

v To write one hundred 64K blocks of data to the tape device:tapeutil -f /dev/rmt/0mn -w 1 -o wri -b 65535 -n 1 -m 100 -v

v To write two file marks to the tape device:tapeutil -f /dev/rmt/0mn -w 1 -o eof -c 2 -v

v To rewind the tape device:tapeutil -f /dev/rmt/0mn -o rew -v

v To read one hundred 64K blocks of data from the tape device:tapeutil -f /dev/rmt/0mn -o rea -b 65535 -n 1 -m 100 -v

v To report the tape density:tapeutil -f /dev/rmt/0mn -o den -v

v To prevent tape removal from the tape drive:tapeutil -f /dev/rmt/0mn -o rem -x 1 -v

v To allow tape removal from the tape drive:tapeutil -f /dev/rmt/0mn -o rem -x 2 -v

v To read the element status with the drive ID:tapeutil -f /dev/rmt/4chng -o dvc -v

v To output the inventory information into a file:tapeutil -f /dev/rmt/4chng -o inv -t 1 > inv.txt

Querying Primary and Alternate Path Configurations (ControlPath Failover)

You can display the primary and alternate path configuration for all devices byrunning the ioscan command, as explained in section “Determine the DeviceHardware Path for IBM Tape Drives” on page 60.

You can also display the primary and alternate paths configuration for any deviceby running the following command:# tapeutil -f /dev/rmt/Xchng -o phs -v

HP-UX - Tape Utility Program (tapeutil)

382 IBM Tape Device Drivers Installation and User’s Guide

Page 401: IBM Tape Driver IUG 1

Where: Xchng is the logical name of any device.

This command shows specific information for the primary path and all alternatepaths, such as the logical name of the device, the attached host bus adapter, thechannel id, the target id, the logical unit number under the target, the currentenabled status, and how many paths are configured for the device.

Disable and Enable Primary and Alternate Paths (Control PathFailover)

When you load the ATDD device driver with the alternate_pathing parameter setto 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 dueto maintenance), run commands to disable and then later enable the primary andalternate paths.

Where the -f flag is for the primary path and the -p flag is for the path that youwant to enable or disable.

This command disables the path:# tapeutil -f /dev/rmt/Xchng -o dis -p /dev/rmt/Xchng -v

This command ensures that the path is labeled as ″disabled.″

To enable a path from a disabled state, you can run the following command:# tapeutil -f /dev/rmt/Xchng -o ena -p /dev/rmt/Xchng -v

This command enables the path.

Querying Primary and Alternate Path Configuration (Data PathFailover)

You can display the primary and alternate path configuration for all devices byrunning ioscan, as explained in section “Primary and Alternate Paths” on page 84.

You can also display the primary and alternate path configuration for any deviceby running the following command:

# tapeutil -f /dev/rmt/Xm -o phs -v

Where: Xm is the logical name of any device

This command shows specific information for the primary path and all alternatepaths, such as the logical name of the device, the attached host bus adapter, thechannel ID, the target ID, the logical unit number under the target, the currentenabled status, and the number of paths configured for the device.

Disable and Enable Primary and Alternate Paths (Data PathFailover)

Once you load the ATDD device driver with the alternate_pathing parameter setto ON, by default, all the available paths for a physical device are enabled. If forsome maintenance reason you need to disable a path and do not want to fail overto this path, then run the following commands:1. To disable the path:

HP-UX - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 383

Page 402: IBM Tape Driver IUG 1

# tapeutil -f /dev/rmt/Xm -p /dev/rmt/Xm.altpath -o dis -v

2. To make sure the path is labeled as ″disabled″

# tapeutil -f /dev/rmt/Xm -o phs -v

The string /dev/rmt/Xm is the primary path and /dev/rmt/Xm.altpath is thealternate path you want to disable.

To enable a path from a disabled state, run the following command:

# tapeutil -f /dev/rmt/Xm -o ena -p /dev/rmt/Xm.altpath -v

HP-UX - Tape Utility Program (tapeutil)

384 IBM Tape Device Drivers Installation and User’s Guide

Page 403: IBM Tape Driver IUG 1

Linux System - Tape Utility Program (IBMtapeutil)Installed with the device driver is a tape utility program (IBMtapeutil) thatexercises or tests the functions of the tape device and the device driver. It alsoperforms basic tape and medium changer operations. The tape utility program canbe used in either the interactive or the command-line mode.

The C source code for the IBMtapeutil program contains a sample of the interfaceto the device driver and the ioctl commands supported by the device driver.IBMtapeutil.c may be found in the tar file IBMtapeutil.x.x.x.tar on the device driverdown load ftp site: ftp://ftp.software.ibm.com/storage/devdrvr/Linux/.

Interactive ModeThe interactive mode for the tape utility program can be invoked from thecommand line using the IBMtapeutil command. A list of general subcommands,medium changer subcommands, tape subcommands, and service aidsubcommands is displayed. You must open a device before using these commandsand operations.

To open a device:1. Select Open a Device from General Commands.2. Enter the name of the device special file. Use any special file that exists for the

device, for example, /dev/IBMtape0, /dev/IBMtape0n, or /dev/IBMchanger0.3. Enter the Read/Write, Read Only, Write Only, or Append mode to open a device.

These modes apply only to the tape devices. Append mode uses Write Only forfile access permission. After you open a device, select a command using theappropriate number for the command from the window. Some commandsrequire additional information after they are selected from the window. If anerror occurs running the command, the error number, the error text, and thedevice sense data (if applicable) are displayed.

Command-Line ModeThe command-line mode for the tape utility program (IBMtapeutil) provides thesame basic tape and changer commands as the interactive mode. Invoke theIBMtapeutil command from the Linux command line or within a shell script. If youenter the IBMtapeutil command without any arguments, the interactive mode isinvoked. The syntax for the command-line mode of the tape utility program is:IBMtapeutil -f Device Subcommand [Subcommand ...]

Note:

1. Device is the name of the device special file (for example, /dev/IBMtape0).2. Subcommand is any valid command for the device. Multiple

subcommands can be combined in a single command to perform morethan one operation. The subcommands are processed one at a time in theorder specified on the command line. For help information about thesubcommands and their syntax, enter the IBMtapeutil ? command on theLinux command line. Figure 105 on page 386 is an example of the helpinformation that is displayed.

Linux - Tape Utility Program (IBMtapeutil)

Appendix D. Tape Utility Programs 385

Page 404: IBM Tape Driver IUG 1

General SubcommandsThe following general subcommands are available for the tape and mediumchanger devices. Items shown enclosed in square brackets, for example [Page], areoptional.

disablepath ″primary″ | number: The disablepath subcommand is used todisable a path to a medium changer. IBM recommends that you leave all pathsenabled, but this subcommand can be used to disable a path. If ″primary″ isspecified, the primary path is disabled. If a numeric value is specified, that specificpath is disabled. Use the path command to obtain a list of the paths. If there isonly one path available and you attempt to disable it, this subcommand fails withan illegal argument. If you attempt to disable a data path (to the tape drive), a″function not implemented″ error is returned. This subcommand is only availablein IBMtapeutil version 1.2.0 or higher, and the IBMtape device driver, version 1.4.1or higher, on libraries that have the Control Path Failover feature enabled.

enablepath ″primary″ | number: The enablepath subcommand is used to enablea path to a medium changer that has been previously disabled with thedisablepath subcommand. If ″primary″ is specified, the primary path is enabled. Ifa numeric value is specified, that specific path is enabled. Use the path commandto obtain a list of the paths. If you attempt to enable a data path (to a tape drive),a ″function not implemented″ error is returned. This subcommand is only availablein IBMtapeutil version 1.2.0 or higher, and the lin_tape device driver, version 1.4.1or higher, on libraries that have the Control Path Failover feature enabled.

General Subcommands:

tur inquiry [Page] print "Text"reserve release reqsenseqryversion logpage "Page" modepage "Page"

Tape Subcommands:

bsf [Count] bsr [Count] eof [Count]fsf [Count] fsr [Count] weof [Count]fsfm [Count] bsfm [Count] asf [Count]compress tell seek [Count]nocompress rewind syncload erase display "Message"unload retension read -d Destination [-c Count]qrypos seod write -s Sourcesetpos [Blockid] status rtest [-b Blocksize] [-c Count] [-r Repetition]offline parms wtest [-b Blocksize] [-c Count] [-r Repetition]rewoffl list rwtest [-b Blocksize] [-c Count] [-r Repetition]prevent lock setblk [Count]allow unlock densityqryinquiry qrysense append mtdevice encryption

Medium Changer Subcommands:

allow prevent audit [Address [Count]]inventory mount [Slot] position "Destination"elementinfo unmount [Slot] move "Source" "Destination"devids exchange "Source" "Dest1" "Dest2"

Service Aid Subcommands:

dump [Filename] forcedump ucode "Name" resetdrive

Figure 105. Linux Command Line Help Display

Linux - Tape Utility Program (IBMtapeutil)

386 IBM Tape Device Drivers Installation and User’s Guide

Page 405: IBM Tape Driver IUG 1

inquiry [Page]: This subcommand issues the SCSI Inquiry command to the devicefor either standard inquiry data, when no page parameter is specified, or for aspecific inquiry page. The page parameter must be specified as a hexidecimal value.For example:# Get standard inquiry dataIBMtapeutil -f /dev/IBMtape0 inquiry

# Get inquiry page x'83'IBMtapeutil -f /dev/IBMtape0 inquiry 83

logpage ″Page″: This subcommand issues the SCSI Log Sense Page command tothe device for the specified page and displays the log sense data. The pageparameter must be specified as a hexidecimal value. For example:# Get log page x'31'IBMtapeutil -f /dev/IBMtape0 logpage 31

modepage ″Page″: This subcommand issues the SCSI Mode Sense Page commandto the device for the specified page and displays the mode sense data. The pageparameter must be specified as a hexidecimal value. For example:# Get mode page x'1D'IBMtapeutil -f /dev/IBMtape0 modepage 1d

path: This subcommand shows all the available paths to a medium changer. Thissubcommand is only available in IBMtapeutil version 1.2.0 or higher, and thelin_tape device driver, version 1.4.1 or higher, on libraries that have the ControlPath Failover feature enabled.

print ″Text″: This subcommand prints the associated text to standard output. Itcan be used at any time to display the progress of the subcommands. For example:# Rewind, erase current tape and backup myfile.tarIBMtapeutil -f /dev/IBMtape0 rewind \erase \print "Writing myfile.tar" \write -s myfile.tar

qrypath: This subcommand shows the primary path and the first alternate pathfor a medium changer. This subcommand is only available in IBMtapeutil version1.2.0 or higher, and the lin_tape device driver, version 1.4.1 or higher, on librariesthat have the Control Path Failover feature enabled.

qryversion: This subcommand issues the QUERY_DRIVER_VERSION ioctlcommand. It prints out the current version of the lin_tape driver.

release: This subcommand explicitly releases a device and makes it available forother hosts by issuing the SCSI Release command.

reqsense: This subcommand issues the SCSI Request Sense command and printsout the sense data.

reserve: This subcommand explicitly reserves a device by issuing the SCSIReserve command.

tur: This subcommand issues the SCSI Test Unit Ready command to the device.

Tape SubcommandsThe following tape subcommands are available for the tape devices.

Linux - Tape Utility Program (IBMtapeutil)

Appendix D. Tape Utility Programs 387

Page 406: IBM Tape Driver IUG 1

allow: This subcommand issues the SCSI Allow Medium Removal command tothe device to allow medium removal by an operator. It is normally used after theprevent subcommand to restore the device to the default state.

append: This subcommand opens the device in Append mode. The file accesspermission is set to Write Only.

asf [Count]: This subcommand places the tape at the beginning block of countfiles from the beginning of the tape. Positioning is done by first rewinding the tapeand then spacing forward over count filemarks. The default count is 1.

bsf [Count]: This subcommand backward spaces count filemarks. The tape ispositioned on the beginning of the last block of the previous file. An optionalcount can be specified. The default is 1.

bsfm [Count]: This subcommand backward spaces count filemarks then positionsthe tape on the end of tape (EOT) side of the filemark. An optional count can bespecified. The default is 1.

bsr [Count]: This subcommand backward spaces count records. An optional countcan be specified. The default is 1.

compress and nocompress: These subcommands turn the hardware compressionOn or Off.

density: This subcommand issues the SCSI Report Density Support command forall supported media and for the current media loaded in the drive, and displaysthe results. If the drive is not loaded, the current media density is not reported.

display ″Message″: This subcommand displays a message on the display panel ofthe tape device. Up to 16 characters can be used for the message. If the message islonger than eight characters, the display alternates between the first eightcharacters and the remainder of the message. For example:# Display "Test 1" and "Running" messagesIBMtapeutil -f /dev/IBMtape0 display "Test 1 Running"

encryption: This subcommand displays the encryption state of the drive.

eof [Count] and weof [Count]: These subcommands write count filemarks. Anoptional count can be specified. The default is 1.

erase: This subcommand erases the tape from the current position through thephysical end of the tape.

fsf [Count]: This subcommand forward spaces count filemarks. The tape ispositioned on the first block of the next file. An optional count can be specified.The default is 1.

fsfm [Count]: This subcommand forward spaces count filemarks, then positionsthe tape on the beginning of tape (BOT) side of the filemark. The tape is positionedon the last block of the previous file. An optional count can be specified. Thedefault is 1.

fsr [Count]: This subcommand forward spaces count records. An optional countcan be specified. The default is 1.

Linux - Tape Utility Program (IBMtapeutil)

388 IBM Tape Device Drivers Installation and User’s Guide

Page 407: IBM Tape Driver IUG 1

list: This subcommand rewinds the tape to the beginning of tape and displays thecontents. The output lists filemarks and the size of each record found on the tapeuntil the end of data is reached. If a record is larger than 256 KB, a read error isreturned. When the command completes, the tape is at end of data. The outputgenerated from this subcommand can be large, depending on the amount of dataon the tape, and in most cases should be directed to a file. For example:# List tape contents to fileIBMtapeutil -f /dev/IBMtape0 list > tape.list

load: This subcommand issues the SCSI Load command to load a tape.

lock: This subcommand locks the tape drive door.

mtdevice: This subcommand issues the MTDEVICE ioctl command and displaysthe library device number. The device number consists of the control unit serialnumber with a 1 digit logical unit number appended to it. Both the control unitserial number and the 1 digit logical unit number are hexadecimal. The devicenumber is only valid when an Enterprise Tape System 3590 is installed in a 3494Enterprise Tape Library.

offline, rewoffl, and unload: These subcommands rewind and unload the tape.

parms: This subcommand issues the STIOCQRYP ioctl command and displays thecurrent tape drive, media, and device driver parameters. Then the subcommandprompts users to set parameters to new values, and issues the STIOCSETP ioctlcommand to do so.

prevent: This subcommand issues the SCSI Prevent Medium Removal commandto the device to prevent medium removal by an operator until the allowsubcommand is issued or the device is reset.

qryinquiry: This subcommand issues the STIOCQRYINQUIRY ioctl command anddisplays the output.

qrypos: This subcommand issues the STIOCQRYPOS ioctl command for thecurrent logical and physical tape position and displays the data. In addition, thecurrent tape position is saved and can be restored using a subsequent setpossubcommand. For example:# Append myfile.tar to the end of tape and then read backIBMtapeutil -f /dev/IBMtape0 append \qrypos \write -s myfile.tar \setpos \read -d temp.tar# Verify myfile.tar was written correctlydiff myfile.tar temp.tar

qrysense: This subcommand issues the STIOCQRYSENSE ioctl command to obtainnew sense data.

read -d Destination [-c Count]: This subcommand reads a file or a specifiednumber of records from the current position on the tape to the destination filename specified with the -d flag. If the optional count parameter is used, only thenumber of records specified with the -c flag are read unless a filemark isencountered before the number of specified records. If the count parameter is notused, all records up to the next filemark on tape are read. For example:

Linux - Tape Utility Program (IBMtapeutil)

Appendix D. Tape Utility Programs 389

Page 408: IBM Tape Driver IUG 1

# Restore myfile.tar from tapeIBMtapeutil -f /dev/IBMtape0 read -d myfile.tar# Read 3 records from the tape into myfileIBMtapeutil -f /dev/IBMtape0 read -d myfile -c 3

rewind and retension: These subcommands rewind the tape to the beginning ofthe tape (BOT).

rtest [-b Blocksize] [-c Count] [-r Repetition]: This subcommand performs a readtest by reading a random data pattern from the tape and verifying that it matchesthe written data. The rtest subcommand can be used after the wtest subcommandto verify the data. An optional block size, count, and repetition can be specified withthe -b, -c, and -r flags, respectively. If the block size is fixed, the count specifies thenumber of blocks to read on each repetition. If the block size is zero (variable), thecountspecifies the number of bytes to read on each repetition. The default is a blocksize of 10240, a count of 20 blocks, and a repetition of 1. For example:# R/W test using 256K blocks, 5 megabytes per write, 100 timesIBMtapeutil -f /dev/IBMtape0 rewind \wtest -b 262144 -c 20 -r 100 \rewind \rtest -b 262144 -c 20 -r 100

Note: If the number of bytes read is not equal to the number of bytes specified, orthere is a data mismatch, an error message is printed and errno is set to 999.

rwtest [-b Blocksize] [-c Count] [-r Repetition]: This subcommand performs aread and write test by writing a random data pattern on the tape, reading it, andverifying that it matches the written data. An optional block size, count, andrepetition can be specified with the -b, -c, and -r flags, respectively. If the block size isfixed, the count specifies the number of blocks to write on each repetition. If theblock size is zero (variable), the count specifies the number of bytes to write on eachrepetition. The default is a block size of 10240, a count of 20 blocks, and a repetition of1. For example:# R/W test using 256K blocks, 5 megabytes per write, 10 timesIBMtapeutil -f /dev/IBMtapeutil rwtest -b 262144 -c 20 -r 10

Note: If the number of bytes written/read is not equal to the number of bytesspecified, or there is a data mismatch while reading, an error message isprinted and errno is set to 999.

seek [Count]: If the optional count parameter is specified, the tape position is setto the block whose ID is count. Otherwise, if the count parameter is omitted, thetape position is set to the last position saved using the tell subcommand. The countcan be specified in decimal or in hexidecimal (with a leading ″x″).

seod: This subcommand spaces to the end of data on the tape.

setblk [Block Size]: This subcommand sets the block size of the drive to block sizebytes per record. A block size of zero sets the drive to variable block mode. If noblock size is specified, the block is set to variable block mode.

setpos [Blockid]: This subcommand issues the SCSI Locate command to thedevice to set the tape position. If the optional Blockid parameter is specified, thetape position is set to the Blockid. Otherwise, if the Blockid parameter is omitted, thetape position is set to the last position saved using the qrypos subcommand. TheBlockid can be specified in decimal or in hexidecimal (with a leading ″x″). Forexample:

Linux - Tape Utility Program (IBMtapeutil)

390 IBM Tape Device Drivers Installation and User’s Guide

Page 409: IBM Tape Driver IUG 1

# Append myfile.tar to the end of tape and then read backIBMtapeutil -f /dev/IBMtape0n append \qrypos \write -s myfile.tar \setpos \read -d temp.tar# Verify myfile.tar was written correctlydiff myfile.tar temp.tar# Set tape position to block 32 and leave positioned on closeIBMtapeutil -f /dev/IBMtape0n setpos 32# Set tape position to block 32 and leave positioned on closeIBMtapeutil -f /dev/IBMtape0n setpos x20

status: This subcommand issues the MTIOCGET command and prints out statusinformation about the tape unit.

sync: This subcommand synchronizes or flushes the tape buffers to tape.

tell: This subcommand reports the current block position on the tape and savesthe position for use by a subsequent seek subcommand.

unlock: This subcommand unlocks the tape drive door.

write -s Source: This subcommand writes the source file specified with the -s flagon the tape. For example:# backup myfile.tar to tapeIBMtapeutil -f /dev/IBMtape0 write -s myfile.tar

wtest [-b Blocksize] [-c Count] [-r Repetition]: This subcommand performs awrite test by writing a random data pattern on the tape. The rtest subcommandcan be used after the wtest subcommand to verify the data that was written. Anoptional 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 towrite on each repetition. If the block size is zero (variable), the count specifies thenumber of bytes to write on each repetition. The default is a block size of 10240, acount of 20 blocks, and a repetition of 1. For example:# R/W test using 256K blocks, 5 megabytes per write, 100 timesIBMtapeutil -f /dev/IBMtape0 rewind \wtest -b 262144 -c 20 -r 100 \rewind \rtest -b 262144 -c 20 -r 100

Note: If the number of bytes written is not equal to the number of bytes specified,an error message is printed and errno set to 999.

Medium Changer SubcommandsThe following medium changer subcommands are available for the integrated andindependent medium changer devices.

allowThis subcommand is not supported for TotalStorage medium changer devices.

audit [Address[Count]]This subcommand with no parameters issues the SCSI Initialize Element Statuscommand to the device. The Address and Count parameters are not supported forIBM TotalStorage devices.# Initialize all elementsIBMtapeutil -f /dev/IBMtape0 audit

Linux - Tape Utility Program (IBMtapeutil)

Appendix D. Tape Utility Programs 391

Page 410: IBM Tape Driver IUG 1

devidsThis subcommand issues the SCSI Read Element Status command to the devicewith the DVCID option for all drive elements and displays the element statusinformation.

elementinfoThis subcommand displays the information returned from theSMCIOC_ELEMENT_INFO ioctl command that contains the number of and theaddress of the first of each element type.

exchange Source Dest1 Dest2This subcommand is not supported for TotalStorage devices.

inventoryThis subcommand issues the SCSI Read Element Status command for each elementtype and displays the element status information. No device identifier informationis obtained.

mount [Slot]This subcommand mounts a tape from the specified slot address into the drive orfrom the first full slot into the drive if the slot is omitted. For example:# Mount cartridge from slot 3IBMtapeutil -f /dev/IBMchanger0 mount 3# Mount cartridge from first full slotIBMtapeutil -f /dev/IBMchanger0 mount

move Source DestinationThis subcommand issues the SCSI Move Medium command using the source anddestination addresses specified. The element addresses can be obtained using theelementinfo subcommand. For example:# Get slot and drive addressesIBMtapeutil -f /dev/IBMchanger0 elementinfo# Move cartridge in slot 20 to drive at address 16IBMtapeutil -f /dev/IBMchanger0 move 20 16

position DestinationThis subcommand issues the SCSI Position to Element command using thedestination specified. For example:# Position to slot at address 20IBMtapeutil -f /dev/IBMchanger0 position 20

preventThis subcommand is not supported for TotalStorage medium changer devices.

unmount [Slot]This subcommand moves a tape from the drive to the specified slot address or thefirst empty one if slot is omitted. For example:# Move tape from drive to slot address 4 (tape is already unloaded)IBMtapeutil -f /dev/IBMchanger0 unmount 4# Unload tape and move to the first empty slotIBMtapeutil -f /dev/IBMchanger0 unmount

Service Aid SubcommandsThe following service aid subcommands are available for the devices.

Linux - Tape Utility Program (IBMtapeutil)

392 IBM Tape Device Drivers Installation and User’s Guide

Page 411: IBM Tape Driver IUG 1

dump [Filename]This subcommand is implemented using SCSI Pass Through ioctl. It stores thedump in the specified Filename or, if Filename is omitted, in dump0001.dmp in thecurrent directory. It should follow a forcedump subcommand. For example:# Force a dump and then stores the dump into file /tmp/dump1.dmpIBMtapeutil -f /dev/IBMtape0 forcedump dump /tmp/dump1.dmp

Note: If the device is not supported, or the returned status from SCSI PassThrough is not correct, this operation fails and errno is set to 999.

forcedumpThis subcommand is implemented using SCSI Pass Through ioctl. It forces a dumpon a tape device. It is usually followed by the dump subcommand.

resetdriveThis subcommand issues a STIOC_RESET_DRIVE ioctl command to reset thedevice.

ucode [Filename]This subcommand is implemented using SCSI Pass Through ioctl. It downloadsmicrocode to the device. Filename is a file that contains the ucode. For example:# download microcodeIBMtapeutil -f /dev/IBMchanger0 ucode /temp/device.ucode

Note: If the device is not supported, or the returned status from SCSI PassThrough is not correct, this operation fails and errno is set to 999.

Automatic Cartridge Facility (ACF) ModeIf the Enterprise Tape System 3590 tape subsystem has an ACF installed, the ACFmode can be queried by the IBMtapeutil application using the Query/SetParameters option in the window.

This parameter is currently not supported for IBM Ultrium devices.

Block Size and SCSI Transfer SizeThe minimum and maximum block sizes for the tape device and the maximumSCSI transfer size can be queried using either the interactive mode of the tapeutility program and selecting Query/Set Parameters under Tape Commands, or byissuing the parms subcommand when in command-line mode.

Configuration ParametersThe configuration parameters can be queried using either the interactive mode ofthe tape utility program and selecting Query/Set Parameters under TapeCommands, or by issuing the parms subcommand when in command-line mode.Some of the parameters can be changed using the interactive mode of the tapeutility program and selecting Query/Set Parameters under lin_tape Commands.

Note: All configuration parameters are reset to their default values whenever thelin_tape device driver is reinstalled.

Reserve and Release CommandsThe device driver reserves the device automatically on the open call and releasesthe device on the close call. This prevents other applications and hosts fromaccessing the device. However, there may be situations when the reserve should be

Linux - Tape Utility Program (IBMtapeutil)

Appendix D. Tape Utility Programs 393

Page 412: IBM Tape Driver IUG 1

maintained after the close call. For example, some backup programs (such as tar)can open and close the device multiple times, or a device may be shared bymultiple initiators or hosts. In these cases, the reservation must be retainedbetween the close call and the next open call. This is done by explicitly reserving thedevice. After all work is completed on the device, the user explicitly releases thedevice.

A device can be reserved and released explicitly using either the interactive modeof the tape utility program and selecting reserve or release under GeneralCommands, or by issuing reserve and release commands when in command-linemode. For example:# Reserve device, run tar, and then release deviceIBMtapeutil - f /dev/IBMtape0 reservetar ... /dev/IBMtape0 ...IBMtapeutil -f /dev/IBMtape0 release

After the reserve command is used, the device driver retains the reservation until arelease command is issued.

Tape Drive Service AidsThe service aids described here are accessible through both the interactive andcommand-line mode of the IBMtapeutil command, for more information refer to“Service Aid Subcommands” on page 392. For information on using tape driveservice aids with the IBM Virtualization Engine TS7510, please refer to the IBMSystem Storage Virtualization Engine TS7510 Installation and Planning Guide at:

http://www-03.ibm.com/systems/storage/index/tape.html.

Create Special FilesThe interactive mode of the tape utility program provides a selection to createspecial files based on attached devices. It invokes a command, lin_tapeconfig, toremove current /dev/IBMTape and /dev/IBMchanger files and generate new ones. Thecommand lin_tapeconfig can also be used directly from the Linux command line,assuming this utility program has been installed.

Note: Running lin_tapeconfig requires root authority.

Querying Primary and Alternate Path Configuration (ControlPath Failover)

IBMtapeutil -f /dev/IBMchangerx path (Where: IBMchangerx is the logical name ofany device).

This command shows specific information for the primary path and all alternatepaths, such as the logical name of the device, the attached host bus adapter, thechannel id, the target id, the logical unit number under the target, the currentenabled status, and how many paths are configured for the device.

You can display the primary and alternate path configuration for all devices byreading the /proc/scsi/IBMchanger file.You can also display the primary andalternate path configuration for any device by running the following command:

IBMtapeutil -f /dev/IBMchangerx path (IBMchangerx is the logical name of anydevice)

Linux - Tape Utility Program (IBMtapeutil)

394 IBM Tape Device Drivers Installation and User’s Guide

Page 413: IBM Tape Driver IUG 1

Disable and Enable Primary and Alternate Paths (Control PathFailover)

Once you load the lin_tape device driver with the alternate_pathing parameter to beON, by default, all the available paths for a physical device are enabled. If forsome maintenance reason you need to disable a path and do not want to fail overto this path, you can run the following commands:v IBMtapeutil -f /dev/IBMchangerx path (to know what number of this path is)v IBMtapeutil -f /dev/IBMchangerx disablepath number (where: number is the number

of the path you want to disable)v IBMtapeutil -f /dev/IBMchangerx path (to make sure the path is labeled as

″disabled″)

Correspondingly, in the /proc/scsi/IBMchanger file, the disabled path is listed as″Disabled″ under the ″FO Path″ column.

To enable a path from a disabled state, you can run the following command:v IBMtapeutil -f /dev/IBMchangerx enablepath number (where: number is the number

of the path you want to enable)

Querying Primary and Alternate Path Configuration (Data PathFailover)

You can display the primary and alternate path configuration for all devices byreading the /proc/scsi/IBMtape file.You can also display the primary and alternatepath configuration for any device by running the following command:>IBMtapeutil -f /dev/IBMtapex path (IBMtapex is the logical name of any device)

This command shows specific information for the primary path and all alternatepaths, such as the logical name of the device, the attached host bus adapter, thechannel id, the target id, the logical unit number under the target, the currentenabled status, and how many paths are configured for the device.

Once you load the lin_tape device driver with the alternate_pathing parameter to beON, by default, all the available paths for a physical device are enabled. If forsome maintenance reason you need to disable a path and do not want to fail overto this path, you can run the following commands:v IBMtapeutil -f /dev/IBMchangerx path (to know what number of this path is)v IBMtapeutil -f /dev/IBMchangerx disablepath number (where: number is the number

of the path you want to disable)v IBMtapeutil -f /dev/IBMchangerx path (to make sure the path is labeled as

″disabled″)

Correspondingly, in the /proc/scsi/IBMchanger file, the disabled path is listed as″Disabled″ under the ″FO Path″ column.

To enable a path from a disabled state, you can run the following command:v IBMtapeutil -f /dev/IBMchangerx enablepath number (where: number is the number

of the path you want to enable)

Linux - Tape Utility Program (IBMtapeutil)

Appendix D. Tape Utility Programs 395

Page 414: IBM Tape Driver IUG 1

Disable and Enable Primary and Alternate Paths (Data PathFailover)

Once you load the lin_tape device driver with the alternate_pathing parameter tobe ON, by default, all the available paths for a physical device are enabled. If forsome maintenance reason you need to disable a path and do not want to fail overto this path, you may run the following commands:>IBMtapeutil -f /dev/IBMtapex path(to know what number of this path is)>IBMtapeutil -f /dev/IBMtapex disablepath number("number" will be the number of the path you want to disable)>IBMtapeutil -f /dev/IBMtapex path(to make sure the path is labeled as "disabled")

Correspondingly, in the /proc/scsi/IBMtape file, the disabled path is listed as″Disabled″ under the ″FO Path″ column.

To enable a path from a disabled state, you may run the following command:>IBMtapeutil -f /dev/IBMtapex enablepath number("number" will be the number of the path you want to enable)

Linux - Tape Utility Program (IBMtapeutil)

396 IBM Tape Device Drivers Installation and User’s Guide

Page 415: IBM Tape Driver IUG 1

Solaris System - Tape Utility Program (tapeutil)A SCSI Tape and Medium Changer Utility Program called tapeutil is provided withthe IBM SCSI Tape and Medium Changer Device Driver for Solaris and is installedin the /opt/IBMtape directory as part of the IBMtape package. The programprovides the following service aids for IBM tape subsystems.v Download Device Microcodev Force Device Diagnostic Dumpv Query Device Microcode Levelv Query Device Serial Numberv Query Device Type/Verify Device Attachmentv Store Device Diagnostic Dump

The source code for the tapeutil program is provided for example purposes and isinstalled in the /opt/IBMtape directory during the IBMtape package installation. Thissource code is commented and demonstrates calls to all of the supported devicedriver entry points and ioctl commands, thus giving the application developer astarting point for interfacing to the IBMtape device driver.

The tapeutil program provides both an interactive mode and a command-linemode. If the tapeutil program is called with no command-line parameters, theinteractive mode is started. In the interactive mode, the device to be operated onshould first be opened using option 1. Other options may then be selected. Theuser is prompted for additional information if required for the specific optionsselected. The results of a command are displayed after it is executed. If an erroroccurs for the command, error information and device sense data is displayed. Thedevice can be closed using option 2, or it is closed automatically when the Quitoption is selected. The menu is displayed automatically one time when theprogram is first called. To prevent unnecessary scrolling of the screen, the menu isnot displayed automatically again after each command but instead is refreshedonly after the M (menu refresh) command is entered.

Interactive ModeThe program provides a menu driven test tool for exercising or testing IBM tapeand medium changer devices with a full suite of supported operations.v Cartridge Inventoryv Mounting/Demounting Cartridgesv Reading/Writing Datav Setting/Displaying Device Information/Statusv Tape Motion Commands

Command-Line ModeIn addition to the menu driven front end, the tapeutil program provides acommand-line mode that is convenient for use in shell scripts.

Note: When using the command-line calls to the tapeutil program, the tape deviceis opened and closed for each invocation. Configuration parameters that arechanged in one call to the tapeutil program are returned to default valueswhen the device is closed.

If command-line parameters are provided when the program is called, thecommand-line mode is started. For each command-line execution of the program,

Solaris - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 397

Page 416: IBM Tape Driver IUG 1

the device is first opened, the specific command is issued, and the device is thenclosed. The program can be driven from within a shell script if desired. Results ofthe operation are displayed only when executed in verbose mode. No informationis displayed when not in verbose mode. This is particularly useful for quiet shellscript implementations. A completion code, as defined in /usr/include/sys/errno.h, forthe operation requested is always returned from the program upon exit (in bothverbose and quiet mode).

The usage of the tapeutil program in command-line mode is as follows:tapeutil -f device -o operation [options]

Where: device is the name of the tape device special file (for example: /dev/rmt/1st)and operation is one of the following values. The device special file and theoperation are required. The specific options associated with a particular operationare indicated. Parameters enclosed in square brackets are optional. All others arerequired.

Service CommandsQuery Serial Number tapeutil -f f -o qsn [-w w] [-v]

Query Microcode Level tapeutil -f f -o qmc [-w w] [-v]

Force Dump tapeutil -f f -o fdp [-w w] [-v]

Store Dump tapeutil -f f -o sdp [-w w] [-v] -z z

Download Microcode tapeutil -f f -o dmc [-w w] [-v] -z z

Format Cartridge tapeutil -f f -o fmt [-w w] [-v]

Query Device Type tapeutil -f f -o chk [-w w] [-v]

Basic SCSI CommandsTest Unit Ready tapeutil -f f -o tur [-w w] [-v]

Inquiry tapeutil -f f -o inq [-w w] [-v]

Request Sense tapeutil -f f -o req [-w w] [-v]

Reserve tapeutil -f f -o res [-w w] [-v]

Release tapeutil -f f -o rel [-w w] [-v]

Medium Changer CommandsMove Medium tapeutil -f f -o mov [-w w] [-v] -s s -d d

Position To Element tapeutil -f f -o pos [-w w] [-v] -s s

Element Information tapeutil -f f -o ele [-w w] [-v]

Inventory tapeutil -f f -o inv [-w w] [-v]

Audit tapeutil -f f -o aud [-w w] [-v]

Lock/Unlock Door tapeutil -f f -o lck [-w w] [-v] -x x

Tape Drive CommandsRead tapeutil -f f -o rea [-w w] [-v] -b b -n n -m m

Write tapeutil -f f -o wri [-w w] [-v] -b b -n n -m m [-r r] [-z z]

Write File Mark tapeutil -f f -o eof [-w w] [-v] -c c

Erase Tape tapeutil -f f -o era [-w w] [-v]

Solaris - Tape Utility Program (tapeutil)

398 IBM Tape Device Drivers Installation and User’s Guide

Page 417: IBM Tape Driver IUG 1

Rewind tapeutil -f f -o rew [-w w] [-v]

Retension tapeutil -f f -o ret [-w w] [-v]

Offline tapeutil -f f -o off [-w w] [-v]

Load/Unload Tape tapeutil -f f -o lod [-w w] [-v] -t t

Forward Space File tapeutil -f f -o fsf [-w w] [-v] -c c

Backward Space File tapeutil -f f -o bsf [-w w] [-v] -c c

Forward Space Record tapeutil -f f -o fsr [-w w] [-v] -c c

Backward Space Record tapeutil -f f -o bsr [-w w] [-v] -c c

Locate End of Data tapeutil -f f -o eod [-w w] [-v]

Get Record Size tapeutil -f f -o grs [-w w] [-v]

Set Record Size tapeutil -f f -o srs [-w w] [-v] -x x

Get Device Status tapeutil -f f -o gds [-w w] [-v]

Get Device Information tapeutil -f f -o gdi [-w w] [-v]

Get Media Information tapeutil -f f -o gmi [-w w] [-v]

Get Position tapeutil -f f -o gpo [-w w] [-v] -t t

Set Position tapeutil -f f -o spo [-w w] [-v] -t t -x x

Get Parameter tapeutil -f f -o gpa [-w w] [-v] -t t

Set Parameter tapeutil -f f -o spa [-w w] [-v] -t t -x x

Sync Buffer tapeutil -f f -o syn [-w w] [-v]

Display Message tapeutil -f f -o msg [-w w] [-v] -t t -y y1,y1

Note: Invoking the tapeutil program with the -h flag (for example, tapeutil -h) oror -? flag (for example, tapeutil -?) displays the usage help information.

Flag DescriptionThe supported flags, their meanings, their associated operations, and theiracceptable ranges are as follows:

-? Usage Help (stand alone flag) {no value required}

-b Block Size (rea, wri)

{0 < (block size x blocking factor) < 2097152}

-c Operation Count (eof, fsf, fsr, bsf, bsr) {0–65535}

-d Destination Address (mov)

{device specific, determine range from Element Info}

-f Device Special File Name (always required)

{/dev/rmt/1st or similar}

-h Usage Help (stand alone flag) {no value required}

-m Multiples to Read or Write (rea, wri) {0–2097152}

-n Blocking Factor (rea, wri)

{0 > (block size x blocking factor) < 2097152}

-o Operation (always required) {refer to the previous list}

Solaris - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 399

Page 418: IBM Tape Driver IUG 1

-r Random Seed (wri) {0–65535}

-s Source Address (mov, pos)

{device specific, determine range from Element Info}

-t Type of Parameter Valuev (gpo) {1=logical block, 2=physical block}v (spo) {1=logical block, 2=physical block}v (gpa) {1=block size, 2=compression, 3=buffering, 4=immediate,

5=trailer, 6=write protect, 7=acf mode, 8=capacity, 9=sili}v (spa) {1=block size, 2=compression, 3=buffering, 4=immediate,

5=trailer, 6=write protect, 8=capacity, 9=sili}v (msg) {1=display msg0, 2=display msg1, 3=flash msg0,

4=flash msg1, 5=alternate msg1/msg2}v (lod) {1=load, 2=unload}

-v Verbose Mode (optional for all commands, stand alone flag)

{no value required, absence of flag means quiet mode}

-w Open Mode (optional for all commands)

{1=read/write, 2=read only (default), 3=write only, 4=append}

-x Parameter Valuev (lck) {1=lock, 2=unlock}v (srs) {0–65536}v (spo) {0–65535}v (spa) {0–65535}

-y Messages (msg) {message1,message2}

-z Input/Output File Namev (sdp) {path and name of the file in which to store dump}v (dmc) {path and name of the microcode image file}v (wri) {path and name of the file containing write data pattern}

Notes:

1. For read and write operations, the size of one buffer of data transferred duringa single SCSI read or write command is determined by the product of the BlockSize value and the Blocking Factor value. The number of these bufferstransferred is determined by the Multiplier value. The actual total number ofbytes transferred is then Block Size x Blocking Factor x Multiplier. If the deviceis set to fixed block mode (block size not equal to zero), the product of BlockSize and Blocking Factor must be a multiple of the device block size setting.

2. For further information about the Get Parameter (gpa) and Set Parameter (spa)operations, refer to the STIOC_GET_PARM and STIOC_SET_PARM ioctlcommands described in the IBM Tape Device Drivers: Programming Reference,GA32-0566.The following examples should help demonstrate and clarify the command-lineusage of the tapeutil program. For all examples, substitute the actual value ofthe special file associated with the target device.v To query the serial number of the device:

/opt/IBMtape/tapeutil -f /dev/rmt/0st -o qsn -v

v To request inquiry data from the device:

Solaris - Tape Utility Program (tapeutil)

400 IBM Tape Device Drivers Installation and User’s Guide

Page 419: IBM Tape Driver IUG 1

/opt/IBMtape/tapeutil -f /dev/rmt/0st -o inq -v

v To move a cartridge from cell 32 to the tape drive (16):/opt/IBMtape/tapeutil -f /dev/rmt/0smc -o mov -s 32 -d 16 -v

v To set the block size of the device to 64K:/opt/IBMtape/tapeutil -f /dev/rmt/0st -o spa -t 1 -x 65535 -v

v To write one hundred 64K blocks of data to the tape device:/opt/IBMtape/tapeutil -f /dev/rmt/0stn -w 1 -o wri -b 65535-n 1 -m 100 -v

v To write two filemarks to the tape device:/opt/IBMtape/tapeutil -f /dev/rmt/0stn -w 1 -o eof -c 2 -v

v To rewind the tape device:/opt/IBMtape/tapeutil -f /dev/rmt/0stn -o rew -v

v To read one hundred 64K blocks of data from the tape device:/opt/IBMtape/tapeutil -f /dev/rmt/0stn -o rea -b 65535 -n 1 -m 100 -v

3. For 3592 Media types, capacity scaling is only supported for the standard 300GB rewritable data cartridge.

4. Attempting to set capacity scaling that is not supported by a device or thecurrent media loaded always returns 100% and cannot be changed. Forexample, the 60GB (Economy Data) cartridge for the IBM 3592 cannot becapacity scaled and is always 100%.

Downloading Device MicrocodeThe IBM tape drives support downloading a new microcode image from the hostsystem by way of the SCSI bus.

To download microcode to these devices, perform the following steps:v Verify that the IBM tape system is powered On and online.v Verify that the tape drive does not have a tape cartridge currently loaded.v Determine the current version of microcode present on the device by entering

the following command, substituting n with the actual value from the devicespecial file associated with the target device:/opt/IBMtape/tapeutil -f /dev/rmt/nst -o qmc -v

v Determine the source of the new microcode image file (that is, diskette, such as/vol/dev/aliases/floppy0 or host file, such as /tmp/ucode_image.file).

v Enter the following command, substituting file with the actual path andfilename of the microcode image file and substituting n with the actual valuefrom the device special file associated with the destination device:/opt/IBMtape/tapeutil -f /dev/rmt/nst -o dmc -z file -v

Notes:

1. The microcode download procedure may also be performed using theinteractive mode of the tapeutil program. To call the tapeutil program in thisformat, enter the following command, then click option 1 to open the device,followed by option 4 to query the current device microcode level, and option 7to download new microcode:/opt/IBMtape/tapeutil

2. If the current microcode on a tape drive is FIPS (Federal Information ProcessingStandard) code, then a window opens and displays the following:Warning: The drive is currently using FIPS code. Do you want tocontinue with downloading new drive code? [y/n]:

Solaris - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 401

Page 420: IBM Tape Driver IUG 1

Enter n to exit without downloading new code, otherwise enter y to continuewith the download code procedure.

Forcing and Storing Device Diagnostic DumpThe IBM tape drives support forcing a diagnostic dump and storing that dump toa mounted tape cartridge or to a host system file through the SCSI bus.

To store a diagnostic dump on these devices, perform the following steps:1. Verify that the IBM tape system is powered On and online.2. Enter the following to force the dump, substituting n with the actual value

from the device special file associated with the target device:/opt/IBMtape/tapeutil -f /dev/rmt/nst/-o sdp -z file -v

3. Determine the location for the dump to be stored (that is, diskette, such as/vol/dev/aliases/floppy0 or host file, such as /tmp/diag_dump.file).

4. Enter the following command, substituting file with the actual path andfilename of the dump destination file and substituting n with the actual valuefrom the device special file associated with the dump device:/opt/IBMtape/tapeutil -f /dev/rmt/nst -o sdp -z file -v

5. The dump may also be written to a tape cartridge mounted in the dump deviceusing tapedrive for file.

Note: The diagnostic dump procedure may also be performed using the interactivemode of the tapeutil program. To call the tapeutil program in this format,enter the following command, then click option 1 to open the device andoption 6 to store the dump:/opt/IBMtape/tapeutil

Querying Primary and Alternate Path Configuration (ControlPath Failover)

You can display the primary and alternate path configuration for all devices withthe tapelist utility.

You can also display the primary and alternate path configuration for any devicerunning the tapeutil utility and selecting option 54 Query Device Paths. Forexample:Path list in the device:

Path 0 Path 1 Path 2

Current active path: Path 0

Enter path number or <enter> for all of the paths:

Instance Number ............. 201SCSI Target ................. 4SCSI LUN .................... 1Serial Number ............... 000001301084Ucode Level ................. 227BPath World Wide NN .......... N/APath World Wide PN .......... N/APath Type ....................PrimaryPath .........................EnableDevice Physical Path ........ /devices/pci@1f,2000/scsi@1/IBMtape@4,1

Instance Number ............. 231SCSI Target ................. 3SCSI LUN .................... 1

Solaris - Tape Utility Program (tapeutil)

402 IBM Tape Device Drivers Installation and User’s Guide

Page 421: IBM Tape Driver IUG 1

Serial Number ............... 000001301084Ucode Level ................. 227BPath World Wide NN .......... N/APath World Wide PN .......... N/APath Type ................... Alt_path_1Path ........................ EnableDevice Physical Path ........ /devices/pci@4,2000/pci@1/fibre-channel@4/IBMtape@3,1

Instance Number ............. 293SCSI Target ................. 2SCSI LUN .................... 1Serial Number ............... 000001301084Ucode Level ................. 227BPath World Wide NN .......... N/APath World Wide PN .......... N/APath Type ................... Alt_path_2Path ........................ EnableDevice Physical Path ........ /devices/pci@6,4000/lpfc@4/IBMtape@2,1

This option shows specific information for each path, such as the instance numberfor the logical device, device serial number, the target id, the logical unit number,the current enabled status, path type and so on. It also indicates how many pathsare configured for the device, and which path is active currently.

Disable and Enable Primary and Alternate Paths (Control PathFailover)

Once you install the IBMtape device driver, by default, all the available paths for aphysical device are enabled. If for some maintenance reason you need to disable apath and do not want to fail over to this path, you can run the following steps:1. Turn the failover parameter to off in the path entry in the IBMtape.conf file.

For example,name="IBMtape" class="scsi" target=3 lun=1 failover=0;

2. Stop the TMD (tape monitor daemon) running on the system and unload theIBMtape 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 can run the following steps:1. Remove the parameter of failover=0 in the path entry in IBMtape.conf file. For

example,name="IBMtape" class="scsi" target=3 lun=1"

2. Stop the TMD (tape monitor daemon) running on the system and unload theIBMtape 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

Solaris - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 403

Page 422: IBM Tape Driver IUG 1

Querying Primary and Alternate Path Configuration (Data PathFailover)

You can display the primary and alternate path configuration for all devices withthe tapelist utility.

You can also display the primary and alternate path configuration for any devicerunning the tapeutil utility and selecting option 54 Query Device Paths. Forexample:Path list in the device:

Path 0 Path 1 Path 2 Path 3Current active path: Path 0

Enter path number or <enter> for all of the paths:

Instance Number ................. 685SCSI Target ..................... 1SCSI LUN ........................ 0Serial Number ................... 000001300168Ucode Level ..................... 04CEPath World Wide NN .............. 5005076302000127Path World Wide PN .............. 5005076302400127Path Type ....................... PrimaryPath ............................ EnableDevice Physical Path ............ /devices/pci@1f,2000/QLGC,qla@1/IBMtape@1,0

Instance Number ................. 697SCSI Target ..................... 7SCSI LUN ........................ 0Serial Number ................... 000001300168Ucode Level ..................... 04CEPath World Wide NN .............. 5005076302000127Path World Wide PN .............. 5005076302800127Path Type ....................... Alt_path_1Path ............................ EnableDevice Physical Path ............ /devices/pci@1f,2000/QLGC,qla@1/IBMtape@7,0

Instance Number ................. 666SCSI Target ..................... 1SCSI LUN ........................ 0Serial Number ................... 000001300168Ucode Level ..................... 04CEPath World Wide NN .............. 5005076302000127Path World Wide PN .............. 5005076302800127Path Type ....................... Alt_path_2Path ............................ EnableDevice Physical Path ............ /devices/pci@1f,4000/JNI,FCR@2/IBMtape@1,0

Instance Number ................. 670SCSI Target ..................... 3SCSI LUN ........................ 0Serial Number ................... 000001300168Ucode Level ..................... 04CEPath World Wide NN .............. 5005076302000127Path World Wide PN .............. 5005076302400127Path Type ....................... Alt_path_3Path ............................ EnableDevice Physical Path ............ /devices/pci@1f,4000/JNI,FCR@2/IBMtape@3,0

This option shows specific information for each path, such as the instance numberfor the logical device, device serial number, the target id, the logical unit number,the current enabled status, path type and so on. It also indicates how many pathsare configured for the device, and which path is the current active path.

Solaris - Tape Utility Program (tapeutil)

404 IBM Tape Device Drivers Installation and User’s Guide

Page 423: IBM Tape Driver IUG 1

Disable and Enable Primary and Alternate Paths (Data PathFailover)

Once you enter the parameter dpf_support in the IBMtape.conf file and install theIBMtape device driver, all the available paths for a physical device are enabled. Iffor some maintenance reason you need to disable a path and do not want to failover to this path, 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 dpf_support=0;

2. Stop the TMD (tape monitor daemon) running on the system and unload theIBMtape 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. Remove the parameter dpf_support=0 from 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 theIBMtape 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

Solaris - Tape Utility Program (tapeutil)

Appendix D. Tape Utility Programs 405

Page 424: IBM Tape Driver IUG 1

Microsoft Windows System - Utility Program (ntutil)The Windows Utility Program (ntutil) allows easy operation of your TotalStorageor Magstar devices and changers. It is supported only with the IBM-supplieddevice drivers.

The ntutil program can be used for the following purposes:v Help determine if there are hardware or connection problemsv Determine which devices are recognized by the device and changer driversv Force a drive dumpv Load new microcode on your drive or changer devicev Send SCSI commands to drives and changersv Receive the status of SCSI commandsv Obtain sense data for SCSI commands that encounter errors

The ntutil program can be run in interactive mode or batch mode. In interactivemode, a menu is presented to issue one command at a time. The results of thatcommand are then presented. In batch mode, you use an editor to create a file thatcontains ntutil commands, which are presented to ntutil one by one.

Calling ntutilThe ntutil program can be called as a command from the command line or fromwithin a shell script:ntutil <-f input-file> <-o output-file> <-t tape-path-special-file-name>

<-c changer-path-special-file-name> <-l ><-d >

The options are:-f input-file Specifies the input file for batch mode. If a file is specified,

is specified, ntutil will execute in batch mode and read inputfrom this file. The default for this file is ntutil.in.

-o output-file Specifies the output file for batch mode.The default for this file is ntutil.OUT.

-t tape-special-file-nameSpecifies the tape device special file value (for example, tape0)to substitute when executing an open (for both batch andinteractive mode).

-c changer-special-file-nameSpecifies the changer device special file value (for example,lb0.1.2.3 for Windows NT, Changer0 for Windows 200x) to substitutewhen executing an open (for both batch and interactive mode). Thespecial value def_lun_1 specifies that an open uses the defaultlun 1 associated with the tape-special-file-name.

-l Specifies that an open will open both the tape path special file andthe changer path special file (for both batch and interactive mode).

-d Turns on internal tracing printouts in the output. Used only fortool debugging.

-b Begins ntutil in batch mode (same as -f, but the default input filentutil.in is used.

Note: If no parameters are specified, ntutil operates in interactive mode.

Windows - Utility Program (ntutil)

406 IBM Tape Device Drivers Installation and User’s Guide

Page 425: IBM Tape Driver IUG 1

Interactive ModeWhen ntutil is called without the -f flag, it defaults to interactive (or manual)mode. This mode allows a developer to interactively issue the operations to beperformed. When in interactive mode, ntutil displays a menu of functions that canbe used.

There are two modes available in interactive mode:v Base mode (LUN0) commands, such as open, close, read, write

v Library mode (LUN0 and LUN1) supports open, close, read, and write, plusmedium changer commands such as read element status and move media.

Note: On Microsoft Windows 200x platforms, library functions are available if theRemovable Storage Management component of Microsoft Windows 200x isstopped.

The other TotalStorage or Magstar devices must be in Random mode both whenstarted and to operate ntutil in Library mode.

Base mode (for example, only LUN 0 of the device specified by thetape-path-special-file-name tape0 is accessed) is shown in Figure 106 on page 408.

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 407

Page 426: IBM Tape Driver IUG 1

Library mode (LUN 0 specified by the tape-path-special-file-name, for example,tape0, and LUN 1 specified by the changer-path-special-file-name, for example,lb0.1.2.3, are accessed) is shown in Figure 107 on page 409.

Test tool version x.x.x.x |Variable settings |==================== BASE MODE ========================================|tape-special-file-name: tape0 |gp->fd0=-1 gp->fd1=-1 block size=1024 block count=1 |hex block id = 0000000000000000 |return_error_when_fail 1 exit_on_unexpected_result 0 trace_flag 0 |

|manual test menu: |=======================================================================|

1: set device special file 2: display symbols |3: set block size R/W (now !0 fixed) |5: set return error when fail 6: set/reset trace |7: set exit on unexpected result 8: Library Mode |

=======================================================================|20: open 21: close |22: read 23: write |24: read and display block 25: flush (buffer->media) |26: read block id 27: erase |28: locate block id 29: display block data |

=======================================================================|30: write filemark(s) 31: rewind |32: forward space filemark(s) 33: unload |34: reverse space filemark(s) 35: load |36: forward space record(s) 37: return error |38: reverse space record(s) 39: test unit ready |43: set media parms (block size) 44: set dev parms (compression)|46: get device information 47: restore data |48: get medium information 49: inquiry |50: poll registered devices |53: space EOD 54: display message |

=======================================================================|70: system command |

=======================================================================|80: Force Dump 81: Read Dump |82: Update MicroCode 83: Log Sense |84: Get Last Sense 85: Get Version |86: Associative/Persistent WProtect 87: Read/Write Test |88: List registered devices 89: Get MTDevice info |

=======================================================================|99: return to main menu |

=======================================================================|enter selection: |

Figure 106. Example of Base Mode

Windows - Utility Program (ntutil)

408 IBM Tape Device Drivers Installation and User’s Guide

Page 427: IBM Tape Driver IUG 1

To issue SCSI commands, the device must be open. Open a SCSI device by issuingoption 20 (Open) from library mode as shown previously. The device names can beobtained using command 88 (List registered devices) also shown previously. Tapedevice names have the format tapeN, where N is a digit, such as 0, 1, and so on.

If the device driver is stopped, and then restarted without a reboot, the name isnot the same as it was previously. Rather, the next unused name in the operatingsystem is used. For example, if there is one tape device defined on the Windowssystem, that device is named tape0 when the device driver is started the first time.If the device driver is stopped, then restarted, the name is tape1. This behaviorcontinues until the system is restarted.

Batch ModeBatch input files can contain these kinds of statements:v Commandv Commentv Delay

Test tool version x.x.x.x |Variable settings |==================== LIBRARY MODE =====================================|tape-special-file-name: tape0, changer-special-file-name: lb0.1.2.3 |gp->fd0=-1 gp->fd1=-1 block size=1024 block count=1 |hex block id = 0000000000000000 |return_error_when_fail 1 exit_on_unexpected_result 0 trace_flag 0 |

|manual test menu: |=======================================================================|

1: set device special file 2: display symbols |3: set block size R/W (now !0 fixed) |5: set return error when fail 6: set/reset trace |7: set exit on unexpected result 8: Base Mode |

=======================================================================|10: ioctl return library inventory 11: ioctl move medium |12: ioctl initialize element status 13: ioctl get changer params |

=======================================================================|20: open 21: close |22: read 23: write |24: read and display block 25: flush (buffer->media) |26: read block id 27: erase |28: locate block id 29: display block data |

=======================================================================|30: write filemark(s) 31: rewind |32: forward space filemark(s) 33: unload |34: reverse space filemark(s) 35: load (3590 System Mode) |36: forward space record(s) 37: return error |38: reverse space record(s) 39: test unit ready |43: set media parms (block size) 44: set dev parms (compression)|46: get device information 47: restore data |48: get medium information 49: inquiry |50: poll registered devices |53: space EOD 54: display message |

=======================================================================|70: system command |

=======================================================================|80: Force Dump 81: Read Dump |82: Update MicroCode 83: Log Sense |84: Get Last Sense 85: Get Version |86: Associative/Persistent WProtect 87: Read/Write Test |88: List registered devices 89: Get MTDevice info |

=======================================================================|99: return to main menu |

=======================================================================|enter selection: |

Figure 107. Example of Library Mode

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 409

Page 428: IBM Tape Driver IUG 1

v Exitv Pausev Setv Symbolsv Systemv Type

Each type of statement is described in the following section.

CommandDevice driver function is exercised by command entries in the input file.Command statements must be on a single line of the input file. The command andcommand text is case sensitive, but leading or embedded blanks are ignored.command command-text <result-text>

CommentThis statement is used to execute a tape command and to test the commandcompletion status for an expected result.

Lines that start with a pound sign (#) or a space and blank lines are comments andare ignored.

Supported Command Text FieldsThe command text specifies the tape operation to perform. The following sectionsdescribe the possible values for these fields.

close:SYNTAX: close

for example, close

FUNCTION Tested:

This command calls the device driver CloseHandle entry point and closes the tapedevice special file opened previously. The RC is always 1.

device_info:SYNTAX: device_info

for example, device_info

FUNCTION Tested:

This command calls the device driver GetTapeParameters entry point with anoperation of GET_TAPE_DRIVE_INFORMATION. If the command is successful,the information returned is in a TAPE_GET_DRIVE_PARAMETERS structure,described in the Microsoft Software Development Kit (SDK). The information isformatted and printed. This includes information such as ECC, compression,default block size, and features.

display_block (data):SYNTAX: display_block

for example, display_block

FUNCTION Tested:

Windows - Utility Program (ntutil)

410 IBM Tape Device Drivers Installation and User’s Guide

Page 429: IBM Tape Driver IUG 1

This command displays the data buffer contents for the last read or write transfer.

display_message:SYNTAX: display_message

for example, display_message

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of input/output control IOCTL_SCSI_PASS_THROUGH and a CDB[0] of0xC0 (Display Message). If the operation is successful, the message is displayed onthe operator panel. The message alternates between TESTMSG and T E S T unlessthe Manual mode display message was used previously, in which case that data isdisplayed.

dump_blocks (read and display blocks):SYNTAX: dump_blocks

dump_blocks records = n

for example, dump_blocks records = 2

FUNCTION Tested:

This command calls the device driver ReadFile entry point. It attempts to readfrom the tape device special file opened previously. The amount of data to be readdepends on the current settings of the block_size and block_count variables and onthe number of records specified. The first 16 bytes of each record are printed.

This command transfers n records. A record has a length of block_size*block_countfor Fixed-Block mode, and block_count for Variable mode. For example, ifblock_size=1024, block_count=2 and records=3, then three 2048 transfers are done.If the operation succeeds, the RC shows the total number of bytes transferred.

erase:SYNTAX: erase

for example, erase

FUNCTION Tested:

This command calls the device driver EraseTape entry point with an operation ofTAPE_ERASE_LONG. It attempts to erase, then leave at load point, the tape devicespecial file opened previously.

find_devices:SYNTAX: find_devices

for example, find_devices

FUNCTION Tested:

This command (which corresponds to the List registered devices command on theinteractive menu) searches the following registry key and looks for tape andmedium changer device identifiers:"HARDWARE\\DEVICEMAP\\Scsi\\Scsi Port W\\Scsi Bus X\\Target Id Y\\Logical Unit Id Z"

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 411

Page 430: IBM Tape Driver IUG 1

It then prints a list of those devices supported by the Windows tape and mediumchanger device drivers.

flush (buffer to media):SYNTAX: flush

for example, flush

FUNCTION Tested:

This command calls the device driver WriteTapemark entry point with anoperation of TAPE_FILEMARKS and a count of 0. This writes the data buffercontents to the tape media of the tape device special file opened previously.

force_dump:SYNTAX: force_dump

for example, force_dump

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of IOCTL_SCSI_PASS_THROUGH and a CDB[0] ofSCSIOP_SEND_DIAGNOSTIC. This forces a microcode dump.

forward_filemark:SYNTAX: forward_filemark n

for example, forward_filemark 2

FUNCTION Tested:

This command calls the device driver SetTapePosition entry point with anoperation of TAPE_SPACE_FILEMARKS and a count of n. It attempts to forwardspace n files on the cartridge in the tape device special file opened previously.

forward_record:SYNTAX: forward_record n

for example, forward_record 2

FUNCTION Tested:

This command calls the device driver SetTapePosition entry point with anoperation of TAPE_SPACE_RELATIVE_BLOCKS and a count of n. It attempts toforward space n records on the cartridge in the tape device special file openedpreviously.

get_last_sense:SYNTAX: get_last_sense

for example, get_last_sense

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of OBTAIN_SENSE. This displays the last sense data returned by a sensecommand.

Windows - Utility Program (ntutil)

412 IBM Tape Device Drivers Installation and User’s Guide

Page 431: IBM Tape Driver IUG 1

get_mtdevice:SYNTAX: get_mtdevice

for example, get_mtdevice

This command is valid for 3590 devices in an automated library only.

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of OBTAIN_MTDEVICE. This displays the library device number (inhexadecimal).

get_version:SYNTAX: get_version

for example, get_version

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of OBTAIN_VERSION. This displays the Windows Device DriversVersion ID string.

init_element_status:SYNTAX: init_element_status

for example, init_element_status

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with an opcodeof LIBRARY_AUDIT. This issues an Initialize Element Status command to thedevice.

inquiry:SYNTAX: inquiry n

for example, inquiry 0

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of IOCTL_SCSI_PASS_THROUGH and a CDB of SCSIOP_INQUIRY. Ifthe command is successful, the information returned is displayed. Specify n=0 toobtain inquiry information from the drive. Specify n=1 to obtain inquiryinformation from the changer. Only Inquiry page 0 is supported.

load (3590 System Mode and Ultrium devices):SYNTAX: load

for example, load

FUNCTION Tested:

This command calls the device driver PrepareTape entry point with an operation ofTAPE_LOAD. It attempts to load the tape media into the drive of the tape devicespecial file opened previously.

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 413

Page 432: IBM Tape Driver IUG 1

locate_block_id:SYNTAX: locate_block_id

for example, locate_block_id

FUNCTION Tested:

This command calls the device driver SetTapePosition entry point with anoperation of TAPE_LOGICAL_BLOCK. It attempts to position to the lastread_block_id value for the cartridge in the tape device special file openedpreviously or the block ID set by the set block_id function.

log_sense (page_code):SYNTAX: log_sense page_code = xx

for example, log_sense page_code = 00

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of IOCTL_SCSI_PASS_THROUGH and a CDB[0] ofSCSIOP_LOG_SENSE. This reads the log sense page specified by the page codeand displays the data.

The page_code (xx) is two hexidecimal characters that specify the log sense page tobe read.

medium_info:SYNTAX: medium_info

for example, medium_info

FUNCTION Tested:

This command calls the device driver GetTapeParameters entry point with anoperation of GET_TAPE_MEDIA_INFORMATION. If the command is successful,the information returned is in the TAPE_GET_MEDIA_PARAMETERS structuredescribed in the Microsoft SDK. The information is formatted and printed. Theinformation returned is block_size, partition count, and write protect.

move_medium:SYNTAX - Windows NT: move_medium saddr = n daddr = n

where saddr = decimal source address (moving from)daddr = decimal destination address (moving to)

for example, move_medium saddr = 11 daddr = 13

SYNTAX - Windows 2000 and Windows Server 2003 and Windows Server 2008:move_medium stype = n saddr = n dtype = n daddr = nwherestype = decimal source address type

2=SE(ChangerSlot), 3=IEE (ChangerIEPort), 4=DTE (ChangerDrive)saddr = decimal source address (moving from)dtype = decimal target address type (see stype for supported values)daddr = decimal destination address (moving to)

for example, move_medium stype = 2 saddr = 1 dtype = 4 daddr = 0

Windows - Utility Program (ntutil)

414 IBM Tape Device Drivers Installation and User’s Guide

Page 433: IBM Tape Driver IUG 1

In Windows 200x, the addresses are remapped such that the first element of eachtype is mapped to 0, the second element is mapped to 1, and so on. Issue areturn_lib_inventory_all command to obtain the mapping.FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with an opcodeof MOVE_MEDIUM. This attempts to move a data cartridge from a source elementlocation to a destination element location inside the library. If this command issuccessful, the information returned is displayed. In Windows NT, the source anddestination addresses are the decimal equivalents of the hexidecimal ElementAddresses described in the appropriate hardware manuals. In Windows 2000,Windows Server 2003, and Windows Server 2008, the addresses are remapped suchthat the first element of each type is mapped to 0, the second element is mappedto 1, and so on. Issue a return_lib_inventory_all command to obtain the mapping.

open:SYNTAX: open <tape-special-file-name> <changer-special-file-name> RW RO

where RW means read/writeRO means read only

The tape-special-file-name is in the form of tapen, and n is a numericvalue from 0...x, the value is assigned by the device driver during theboot process and can be found using the interactive modes option 50 pollregistered devices. This value may be specified explicitly in the openstatement or overridden using the command-line -t option.

The changer-special-file-name, supported on Windows NT, is in the form oflbw.x.y.z, w is the device SCSI ID, x is the changer device LUN (usually 1),y is the adapter SCSI bus (usually 0), and z is the port number where theSCSI adapter resides. These values are assigned during the boot process andcan be found using the interactive modes option 50 poll registered devices.On Windows 2000, Windows Server 2003, and Windows Server 2008, it is in theform Changerx, where x is a numeric value, usually starting with 0.This may also contain the value def_lun_1 in which case the utility willopen LUN 1 associated with the tape-special-file-name. This value may bespecified explicitly in the open statement or overridden using thecommand-line -c option. If this value is specified, the tape-special-file-namemust be specified.

For example:open RW means open the default tape-special-file-name and

changer-special-file-name if in library mode or thosespecial file names specified by the -t and -c options

open tapex RW means open tapex and if in library mode the defaultchanger-special-file-name. The -t and -c options willoverride tapex and lbw.x.y.z. The mode will be RW.

open tapex lbw.x.y.z RWmeans open tapex and if in library mode the changerspecial file lbw.x.y.z. The -t and -c options willoverride tapex and lbw.x.y.z. The mode will be RW.

FUNCTION Tested:

This command calls the device driver CreateFile entry point. It attempts to open atape device special file for LUN0 and LUN1.

poll_devices:

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 415

Page 434: IBM Tape Driver IUG 1

SYNTAX: poll_devices

for example, poll_devices

FUNCTION Tested:

This command searches the following registry key:

HARDWARE\\DEVICEMAP\\Scsi\\Scsi Port W\\Scsi Bus X\\Target Id Y\\Logical Unit Id Z for devices supported by the Windows tape and medium changerdevice drivers. This command then attempts to open each of the devices foundand issue INQUIRY and TEST UNIT READY SCSI commands to each open device.The status of all the devices is printed on the screen. Executing this commandcloses all currently open devices. If another application is using the device, thiscommand will not be able to query the status of that device.

read:SYNTAX: read

read records = n

for example, read records = 2

FUNCTION Tested:

This command calls the device driver ReadFile entry point. It attempts to readfrom the tape device special file opened previously. The amount of data to be readdepends on the current settings of the block_size and block_count variables and onthe number of records specified.

This command transfers n records. A record has have a length ofblock_size*block_count for Fixed-Block mode, and block_count for Variable mode.For example, if block_size=1024, block_count=2 and records=3, then three 2048transfers are done. If the operation succeeds, the RC shows the total number ofbytes transferred.

read_block_id:SYNTAX: read_block_id

for example, read_block_id

FUNCTION Tested:

This command calls the device driver GetTapePosition entry point with anoperation of TAPE_LOCICAL_POSITION. It attempts to read the current block IDvalue for the cartridge in the tape device special file opened previously.

read_dump:SYNTAX: read_dump

read_dump dump_name=string device=devnumwhere string is eight characters or less and devnum=0 (for tape) or 1 (for changer)

For example, read_dump dump_name = fsc0000 device = 0.

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of IOCTL_SCSI_PASS_THROUGH and a CDB[0] ofSCSIOP_READ_DATA_BUFF. This reads the dump data and writes it to a filespecified by dump_name or to a dump0000.dmp default file. Dump_name must be

Windows - Utility Program (ntutil)

416 IBM Tape Device Drivers Installation and User’s Guide

Page 435: IBM Tape Driver IUG 1

eight characters or less. Ntutil adds the .dmp extension automatically. The dump iswritten into the directory where ntutil was started.

read_write (test):SYNTAX: read_write

for example, read_write

FUNCTION Tested:

This command performs the following test on the cartridge in the tape devicespecial file opened previously:1. Rewind the tape.2. Set Media Parameters to fixed block 32K.3. Write a 32K random data block on tape.4. Rewind the tape.5. Read the block and compare the data to the data written in step 3.

restore_data:SYNTAX: restore_data

restore_data file_name=string

for example, read_data file_name=fsc0000

FUNCTION Tested:

This command calls the device driver ReadFile entry point. It attempts to perform64 KB variable block read operations on the tape device special file until either afilemark or an end of data is detected. All the data read, regardless of error, issaved in the file specified. If there is no data on the tape, the command fails, andno data is saved. The RC should be ignored in most cases, because this operationalways ends with an error (either filemark detected or end of data detected).

return_error:SYNTAX: return_error_state

for example, return_error_state

FUNCTION Tested:

This command calls GetLastError. If the command is successful, the informationreturned is displayed. There is no RC for this function.

return_lib_inventory_all:SYNTAX : return_lib_inventory_all

for example, return_lib_inventory_all

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with an opcodeof LIBRARY_INVENTORY. It attempts to return information about all thehardware components in a library. If this command is successful, the informationreturned is displayed. For Windows NT, refer to the appropriate hardware manualsfor a description of the information returned by a read element status command.

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 417

Page 436: IBM Tape Driver IUG 1

For Microsoft Windows 2000, Windows Server 2003, and Windows Server 2008, theRSM must be stopped to issue this command. A remapped inventory is returnedwhere one element is returned per line.

Each line has the following format:

Type: n, Addr: hexidecimal value, Empty or Full, access type on a new line.v n is 2, 3, or 4, which indicates SE (ChangerSlot), or IEE (ChangerIEPort), or DTE

(ChangerDrive), respectively.v hexidecimal value is a hexadecimal value that indicates the mapped address of

the item. This mapped address is used for medium operations on MicrosoftWindows 2000, Windows Server 2003, and Windows Server 2008, which isdifferent from using the actual hardware element addresses on Windows NT.

v Empty or Full indicates if the element is occupied. Note that if a cartridge is inthe drive, Empty is returned.

v access type is set to Access if the element is accessible, blank if not.

If tracing is enabled, the flags field for the element is displayed after the elementaddress. Potential values for this field are documented in theELEMENT_STATUS_abc constants in ntddchgr.h.

reverse_filemark:SYNTAX: reverse_filemark n

for example, reverse_filemark 2

FUNCTION Tested:

This command calls the device driver SetTapePosition entry point with anoperation of TAPE_SPACE_FILEMARKS and a count of n. It attempts to backwardspace n files on the cartridge in the tape device special file opened previously.

reverse_record:SYNTAX: reverse_record n

for example, reverse_record 2

FUNCTION Tested:

This command calls the device driver SetTapePosition entry point with anoperation of TAPE_SPACE_RELATIVE_BLOCKS and a count of n. It attempts tobackward space n records on the cartridge in the tape device special file openedpreviously.

rewind:SYNTAX: rewind

for example, rewind

FUNCTION Tested:

This command calls the device driver SetTapePosition entry point with anoperation of TAPE_REWIND. It attempts to rewind the tape device special fileopened previously. Status is presented when the rewind is complete.

set_device_parameters (compression):

Windows - Utility Program (ntutil)

418 IBM Tape Device Drivers Installation and User’s Guide

Page 437: IBM Tape Driver IUG 1

SYNTAX: set_device_parameters compression = n

for example, set_device_parameters compression = 0

FUNCTION Tested:

This command calls the device driver SetTapeParameters entry point with anoperation of SET_TAPE_DRIVE_INFORMATION. The compression value is arequired parameter with the command.

compression - device compression On or Off (0 for Off, any other value On).

set_media_parameters (block size):SYNTAX: set_media_parameters block_size = n

for example, set_media_parameters block_size = 0

FUNCTION Tested:

This command calls the device driver SetTapeParameters entry point with anoperation of SET_TAPE_MEDIA_INFORMATION. The block_size value is arequired parameter with the command.

block_size - device block size setting (0 for variable).

set_reset_write_protect:SYNTAX: set_reset_write_protect wp = x

for example, set_reset_write_protect wp = 1

FUNCTION Tested:

This command calls the device driver DeviceIoControl entry point with anoperation of IOCTL_SCSI_PASS_THROUGH, a CDB[0] of MODE_SELECT (0x55),and a mode page of 0x23. Refer to the appropriate hardware reference manual fordetails on Associative and Persistent Write Protect. The write protect value on themode page is updated based on the wp parameter, where wp is:1 - Set Associative Write Protect2 - Set Persistent Write Protect3 - Set Both4 - Reset Associative8 - Reset Persistent0 - Reset Both

space_eod:SYNTAX: space_eod

for example, space_eod

FUNCTION Tested:

This command calls the device driver SetTapePosition entry point with anoperation of TAPE_SPACE_END_OF_DATA. It attempts to space to the end of dataon the cartridge in the tape device special file opened previously.

test_unit_ready:SYNTAX: test_unit_ready n

for example, test_unit_ready 1

FUNCTION Tested:

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 419

Page 438: IBM Tape Driver IUG 1

This command calls the device driver DeviceIoControl entry point with anoperation of IOCTL_SCSI_PASS_THROUGH and a CDB[0] ofSCSIOP_TEST_UNIT_READY. If the operation is unsuccessful, the sense data isdisplayed. Specify 0 to send the command to the drive. Specify 1 to send thecommand to the changer.

unload:SYNTAX: unload

for example, unload

FUNCTION Tested:

This command calls the device driver PrepareTape entry point with an operation ofTAPE_UNLOAD. It attempts to rewind and unload the tape device special fileopened previously.

update_code:SYNTAX: update_code image_name = string

for example, update_code image_name = d0i9_430

FUNCTION Tested:

This command updates the microcode and calls the device driver DeviceIoControlentry point with an operation of IOCTL_SCSI_PASS_THROUGH and a CDB[0] ofSCSIOP_WRITE_DATA_BUFF. The filename portion of the image name must bespecified and is read from the directory where ntutil was started. The file extentmust be .fmr for the file.

write:SYNTAX: write

write records = nwrite records = n data = m

for example, write records = 3 data = 888

FUNCTION Tested:

This command calls the device driver WriteFile entry point. It attempts to write tothe tape device special file opened previously. The amount of data to be writtendepends on the current settings of the block_size and block_count variables and onthe number of records specified.

This command transfers n records. A record has a length of block_size*block_countfor Fixed-Block mode, and block_count for Variable mode. For example, ifblock_size=1024, block_count=2 and records=3, then three 2048 transfers are done.If the operation succeeds, the RC shows the total number of bytes transferred.

If the records attribute is not specified, the default is 1.

Each record written has random bytes preceded by an integer identifier. If the dataattribute is not specified, the identifier is a unique sequential counter. This can beoverridden by specifying data=. This value can be checked on a read command byspecifying, for example, result data=888. If data is specified, the record count mustbe specified. Data can be a decimal value from 0–4294967295.

Windows - Utility Program (ntutil)

420 IBM Tape Device Drivers Installation and User’s Guide

Page 439: IBM Tape Driver IUG 1

write_filemark:SYNTAX: write_filemark n

for example, write_filemark 2 (write 2 file marks)

FUNCTION Tested:

This command calls the device driver WriteTapemark entry point with anoperation of TAPE_FILEMARKS and a count of n. It attempts to write n filemarkson the tape media.

Supported Result Text FieldsThe result text on a command statement is used to test completion status for anexpected result. Further execution of a test case is affected by the current settingsof the return_error_when_fail and exit_on_unexpected_result variables. These can beset using a set statement.

If no result text is specified, the command is treated as successful.

In the case of rc, except as noted in the command section, a failure returns -1.Otherwise, the operation succeeded.

The syntax for result text is:< rc < n> <err < n> <cc < n>

> > ><= <= <=>= >= >=== == ==!= != !=

where:

rc = return code from the last command.err = Operating System GetLastError () value for the last command.data = expected record identifier for a read command.

For example, consider this statement in the input file:

command write 1 result rc == -1 err == WRITE_PROTECT

This means we will try to write one record to tape and we expect this to failwith return code -1, err WRITE_PROTECT.

Note: Symbolic values or integers can be used for err. See theappendix on symbolic values for a list of those recognized.

set: This statement allows setting of variables that affect how tests are executed.The syntax for a set statement is:set variable = value

for example, set return_error_when_fail = 1

Here are the variables that can be set:

return_error_when_failCan be set to 1 (true) or 0 (false). A setting of true means ntutil ends byreturning an error at the end of the test if any command does not produce acorrect expected result as specified in result text.

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 421

Page 440: IBM Tape Driver IUG 1

exit_on_unexpected_resultCan be set to 1 (true) or 0 (false). If set to true, the first occurrence of anunexpected result terminates the test.

block_idCan be set to a four byte hexidecimal value (for example, 0001aa03). This valueis used on a locate_block_id command.

block_sizeBlock size to be used for reading, writing or set_mode. Can be set to 0 toindicate Variable Block mode.

block_countNumber of blocks or bytes (Variable mode) to transfer on an individual datatransfer command.

typeText following the word type is typed on the terminal. This can be used toshow the progress of the test or to prompt for a subsequent pause statement.type string

for example, type tell operator it's lunch time

pauseThe test stops until a character is typed at the terminal. This allows for teststhat require manual intervention.

delayThe test stops for n seconds. This allows for tests that require delay formechanical completion before continuing. The syntax for the delay statementis:delay value

for example, delay 1

systemText following the word system is passed to the system for execution. Thesyntax for the system statement is:system operation

for example, system dir

symbolsThis statement prints the symbol list that may be used in result text fields.

exitThis statement causes immediate termination of the batch test. No further linesare read from the input file.

Symbolic ValuesFigure 108 on page 423 shows the values (symbolic error or error number) that canbe used for err.

Windows - Utility Program (ntutil)

422 IBM Tape Device Drivers Installation and User’s Guide

Page 441: IBM Tape Driver IUG 1

---------------------------------------------------------------------------------------| Symbolic Error | NT/Win2000| Symbolic Error |NT/Win2000 || | Error # | | Error # ||-----------------------------|---------------------------------------------|-----------|| ERROR_SUCCESS | 0 | DD_CLEANER_INST | 316 || ERROR_INVALID_FUNCTION | 1 | DD_MEDIA_NOT_EJECTED | 317 || ERROR_FILE_NOT_FOUND | 2 | DD_IOPORT_NOT_CONFIG | 318 || ERROR_PATH_NOT_FOUND | 3 | DD_FIRST_DEST_EMPTY | 319 || ERROR_TOO_MANY_OPEN_FILES | 4 | DD_END_PHYSICAL_MEDIA | 400 || ERROR_ACCESS_DENIED | 5 | DD_MEDIA_BLANK | 401 || ERROR_INVALID_HANDLE | 6 | DD_MEDIA_CORRUPTED | 402 || ERROR_NOT_ENOUGH_MEMORY | 8 | DD_MEDIA_FAILURE | 403 || ERROR_BAD_FORMAT | 9 | DD_MEDIA_INCOMPATIBILITY | 404 || ERROR_INVALID_BLOCK | 10 | DD_SECTOR_RELOCATION | 405 || ERROR_BAD_ENVIRONMENT | 11 | DD_SECTOR_OUT_OF_RANGE | 406 || ERROR_INVALID_ACCESS | 12 | DD_WRITE_PROTECT | 407 || ERROR_INVALID_DATA | 13 | DD_CLEAN_MEDIA | 408 || ERROR_OUTOFMEMORY | 14 | DD_MEDIA_FAULT | 409 || ERROR_INVALID_DRIVE | 15 | DD_CLEANING_COMPLETE | 410 || ERROR_WRITE_PROTECT | 19 | DD_LOGICAL_END_OF_MEDIA | 411 || ERROR_BAD_UNIT | 20 | DD_MEDIA_NOT_PRESENT | 412 || ERROR_NOT_READY | 21 | DD_BEGINNING_OF_MEDIA | 413 || ERROR_BAD_COMMAND | 22 | DD_ERASE_FAILURE | 414 || ERROR_CRC | 23 | DD_WRITE_TO_WRITTEN_WORM | 415 || ERROR_HANDLE_EOF | 38 | DD_WRONG_LENGTH_BLOCK | 416 || ERROR_NOT_SUPPORTED | 50 | ERROR_IO_INCOMPLETE | 996 || ERROR_DEV_NOT_EXIST | 55 | ERROR_IO_PENDING | 997 || ERROR_ALREADY_ASSIGNED | 85 | ERROR_NOACCESS | 998 || ERROR_INVALID_PARAMETER | 87 | ERROR_CANTOPEN | 1011 || ERROR_OPEN_FAILED | 110 | ERROR_CANTOPEN | 1011 || ERROR_INSUFFICIENT_BUFFER | 122 | ERROR_CANTREAD | 1012 || ERROR_INVALID_NAME | 123 | ERROR_CANTWRITE | 1013 || ERROR_BUSY_DRIVE | 142 | ERROR_END_OF_MEDIA | 1100 || DD_NO_SENSE | 200 | ERROR_FILEMARK_DETECTED | 1101 || DD_DEVICE_DRIVER_FAILURE | 201 | ERROR_BEGINNING_OF_MEDIA | 1102 || DD_EEPROM_FAILURE | 202 | ERROR_SETMARK_DETECTED | 1103 || DD_MANUAL_INTERVENTION | 203 | ERROR_NO_DATA_DETECTED | 1104 || DD_RECOVERED_ERROR | 204 | ERROR_PARTITION_FAILURE | 1105 || DD_SCSI_ADAPTER_ERROR | 205 | ERROR_INVALID_BLOCK_LENGTH | 1106 || DD_SCSI_ERROR | 206 | ERROR_DEVICE_NOT_PARTITIONED | 1107 || DD_SCSI_BUSY | 211 | ERROR_UNABLE_TO_LOCK_MEDIA | 1108 || DD_ILLEGAL_REQUEST | 207 | ERROR_UNABLE_TO_UNLOAD_MEDIA | 1109 || DD_COMMAND_ABORTED | 208 | ERROR_MEDIA_CHANGED | 1110 || DD_HARDWARE_MICROCODE | 209 | ERROR_BUS_RESET | 1111 || DD_UNIT_ATTENTION | 210 | ERROR_NO_MEDIA_IN_DRIVE | 1112 || ERROR_MORE_DATA | 234 | ERROR_IO_DEVICE | 1117 || DD_CARTRIDGE_ENTRY_FAILURE | 300 | ERROR_TOO_MANY_LINKS | 1142 || DD_CARTRIDGE_LOAD_FAILURE | 301 | | || DD_CARTRIDGE_IN_FAILED_DRIV| 302 | | || DD_CAROUSEL_NOT_LOADED | 303 | | || DD_CHANGER_FAILURE | 304 | | || DD_DRIVE_FAILURE | 305 | | || DD_DRIVE_OR_MEDIA_FAILURE | 306 | | || DD_ENTRY_EXIT_FAILURE | 307 | | || DD_ENTRY_EXIT_NOT_PRESENT | 308 | | || DD_LIBRARY_AUDIT | 309 | | || DD_LIBRARY_FULL | 310 | | || DD_MEDIA_EXPORT | 311 | | || DD_SLOT_FAILURE | 312 | | || DD_SLOT_OR_MEDIA_FAILURE | 313 | | || DD_SOURCE_EMPTY | 314 | | || DD_DESTINATION_FULL | 315 | | |----------------------------------------------------------------------------------------

Figure 108. Symbolic Values

Windows - Utility Program (ntutil)

Appendix D. Tape Utility Programs 423

Page 442: IBM Tape Driver IUG 1

Querying Primary and Alternate Path Configuration (ControlPath Failover)

To check if the control path failover has been enabled in the device driver anddisplay the primary and alternate paths, you may use the Windows utilityprogram ntutil. Open a tape library from ntutil library mode, choose option “getchanger bus info”. If you have multiple paths configured for Changer0, lists ofmultiple Changer0s are output. Each one is associated with a different bus address.One of them is marked as “Primary”. The other Changer0s that are not marked asPrimary are alternate paths for Changer0.

The following is an example of the output of “get changer bus info” option fromntutil. Changer0 and Changer1 have failover enabled, and Changer2 does not havefailover enabled. There are one path for Changer1 and two paths for Changer0. ForChanger0, the path with SCSI address 03.01.00.01 is the primary path, and the pathwith SCSI address 03.01.03.01 is an alternate path.

DEVICE NAME SERIAL FAILOVER SCSI ADDRESS ACTIVE PRIMARY-------------------------------------------------------------------------

Changer1 0000000T00390401 YES 03.01.04.01 YES PRIMARYChanger0 0000000T003904E5 YES 03.01.00.01 YES PRIMARYChanger0 0000000T003904E5 YES 03.01.03.01 YESChanger2 0000000T00361234 NO 03.01.02.01 YES PRIMARY

Querying Primary and Alternate Path Configuration (Data PathFailover)

To check if the data path failover has been enabled in the device driver anddisplay the primary and alternate paths, you may use the Windows utilityprogram ntutil. Open a tape library from ntutil base mode, choose option “get tapebus info”. If you have multiple paths configured for Tape0, lists of multiple Tape0sare output. Each one is associated with a different bus address. One of them ismarked as “Primary”. The other Tape0s that are not marked as Primary arealternate paths for Tape0.

The following is an example of the output of this option from ntutil. Tape0, 1, and3 have failover enabled. Tape2 does not have failover enabled. Tape3 has two pathsconfigured. The path with the SCSI address 03.01.05.00 is the primary path, andthe path with SCSI address 03.01.07.00 is an alternate path.

DEVICE NAME SERIAL FAILOVER SCSI ADDRESS ACTIVE PRIMARY-------------------------------------------------------------------------

Tape1 000001300486 YES 03.01.01.00 YES PRIMARYTape2 1200019801 NO 03.01.08.00 YES PRIMARYTape3 000001350051 YES 03.01.05.00 YES PRIMARYTape3 000001350051 YES 03.01.07.00 YESTape0 000001365066 YES 03.01.00.00 YES PRIMARY

Windows - Utility Program (ntutil)

424 IBM Tape Device Drivers Installation and User’s Guide

Page 443: IBM Tape Driver IUG 1

Tru64 System - RAS Utility Program (IBMrasutil)IBMrasutil is a RAS utility program which allows the operator to obtain devicedumps from IBM tape and medium changer devices for diagnostic purposes. It isalso used to update microcode on the IBM tape and medium changer devices. Thefollowing IBM devices are supported:v IBM Ultrium LTO1 tape drive inIBM System Storage TS3500, 3581 and 3583 Tape

Librariesv IBM TotalStorage Enterprise 3590 Tape Drive Models E11 or H11 (Rack Mount

with ACF)v IBM TotalStorage Enterprise 3590 Tape Drive Models E1A or H1A (3494 Tape

Library Models)

Installation Procedure from the Device Driver FTP SiteIf you want to download the RasUtil kit from the FTP site, enter this FTP address:

ftp://ftp.software.ibm.com/storage/devdrvr/Tru64

After you have downloaded the RasUtil kit from the FTP site, untar the kit firstand then run the setld command to install:tar -xvf RasUtil.x.x.x.kit.tarsetld -l RasUtil.x.x.x.kit

After installing the IBM RAS utility program, use vi or some other text editor toedit the .profile file to add the /usr/opt/RASUTIL/bin to the search path.

To find more information on how to execute the IBM RAS utility program, issue:IBMrasutil -h

UninstallingThe IBM RAS Utility Program can be uninstalled by using the setld command:setld -d IBMRASxxx

Update ProcedureTo update the RasUtil kit to a newer version, remove the old version first.setld -d IBMRASxxx

then follow the above installation steps to install the new version.

Query ProcedureYou can determine if the IBM RAS Utility Program kit is installed on the system byusing the following command.setld -i|grep IBMRAS

To display the RasUtil product kit’s fileset and the located directory, enter:setld -i IBMRASxxx

Verify ProcedureUse this command to verify the existence of the installed RasUtil program. Thesetld -v command executes any V phase processing included in the subset controlprogram except during installation.setld -v IBMRASxxx

Tru64 - RAS utility program (IBMrasutil)

Appendix D. Tape Utility Programs 425

Page 444: IBM Tape Driver IUG 1

Interactive ModeThe interactive mode for the RAS utility program can be invoked from thecommand line by using the IBMrasutil command. The program prompts you toenter a device special file name. You must open a device before you can issue anyRAS utility subcommands.

Command-Line ModeThe command-line mode for the RAS utility program (IBMrasutil) provides thesame basic RAS utility commands as the interactive mode. Invoke the IBMrasutilcommand from the Tru64 command line or from within a shell script. If you enterthe IBMrasutil command without any arguments, the interactive mode is invoked.The syntax for the command-line mode of the RAS utility program is:IBMrasutil -f Device -Option Filename

Note:

1. Device is the name of the device special file (for example,/dev/ntape/tape7)

2. Filename for input or output operations3. If only the -f option is issued, the program queries and displays the

Model Name, Serial Number and the Firmware level of the device.4. If the -f option is not issued, the interactive mode is invoked.

Command-Line Options-D filename

Read device dump information and output it into a file specified by the filename.

For example:IBMrasutil -f /dev/ntape/tape7 -D DriveDump.log

-M filename

Load the microcode from the specified file to the device.

For example:IBMrasutil -f /dev/ntape/tape7 -M 2360.bin

Tru64 - RAS utility program (IBMrasutil)

426 IBM Tape Device Drivers Installation and User’s Guide

Page 445: IBM Tape Driver IUG 1

Notices

References in this publication to IBM products, programs, or services do not implythat IBM intends to make these available in all countries (or regions) in which IBMoperates.

Any references to an IBM program or other IBM product in this publication is notintended 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’sintellectual property rights may be used instead of the IBM product. Evaluationand verification of operation in conjunction with other products, except thoseexpressly designed by IBM, is the user’s responsibility.

IBM may have patents or pending patent applications covering subject matter inthis document. The furnishing of this document does not give you any license tothese patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

The following paragraph does not apply to the United Kingdom or any othercountry (or region) where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESSFOR A PARTICULAR PURPOSE. Some states (or regions) do not allow disclaimerof express or implied warranties in certain transactions, therefore, this statementmay not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes areincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or program(s) described in this publicationat any time without notice.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

The ITDT-SE and ITDT-GE software uses Henry Spencer’s regular expressionlibrary that is subject to the following copyright notice:

″Copyright 1992, 1993, 1994, 1997 Henry Spencer. All rights reserved. This softwareis not subject to any license of the American Telephone and Telegraph Company orof the Regents of the University of California.

Permission is granted to anyone to use this software for any purpose on anycomputer system, and to alter it and redistribute it, subject to the followingrestrictions:

© Copyright IBM Corp. 2007, 2009 427

||

|||

|||

Page 446: IBM Tape Driver IUG 1

1. The author is not responsible for the consequences of use of this software, nomatter how awful, even if they arise from flaws in it.

2. The origin of this software must not be misrepresented, either by explicit claimor by omission. Since few users ever read sources, credits must appear in thedocumentation.

3. Altered versions must be plainly marked as such, and must not bemisrepresented as being the original software. Since few users ever readsources, credits must appear in the documentation.

4. This notice may not be removed or altered.″

TrademarksThe following terms are trademarks of International Business MachinesCorporation in the United States, other countries (or regions), or both:

AIX IBMLink RS/6000 System zAIX 5L Magstar S/390 TivoliFICON Micro Channel StorageSmart TotalStorageHyperFactor Netfinity System i® Virtualization Enginei5/OS POWER5 System p xSeriesiSeries ProtecTIER System Storage z9IBM pSeries System x zSeries

Adobe and Acrobat are either registered trademarks or trademarks of AdobeSystems Incorporated in the United States, and/or other countries.

Intel, Itanium, and Pentium are trademarks of Intel Corporation in the UnitedStates, other countries (or regions), or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in theUnited States, other countries, or both.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.

Microsoft, Windows, Windows NT, and Windows 2000 are trademarks of MicrosoftCorporation in the United States, other countries (or regions), or both.

UNIX is a registered trademark of The Open Group in the United States and othercountries (or regions).

Other company, product, and service names may be trademarks or service marksof others.

428 IBM Tape Device Drivers Installation and User’s Guide

||

|||

|||

|

Page 447: IBM Tape Driver IUG 1

Index

Numerics3494 Enterprise Tape Library Driver

Library Driver Information 205driver message queue 206Library Manager event

notification 205operation complete

notification 206software interface 205synchronous and asynchronous

operations 206TotalStorage Virtual Tape Server

Subsystem Attachment 207unsolicited notification 206volume categories 206

3494 Enterprise Tape Library Supportmtlib command 194Programs

MTEVENT program 205MTLIB 194

Tape Library Support Programs 193

Aabout data encryption 17AIX 41

Device and Volume InformationLogging 43

log file 44tape log utility 44

Installation and ConfigurationInstructions

deconfiguring the 3490E, 3590,Magstar MP, or 7332 tapedevice 28

deconfiguring the 3575, 7331, 7334,7336, or 7337 medium changerdevice 28

installation procedure 27preinstallation considerations 27uninstall procedure 28

Multiple HBA and Multi-PortDevices 13

path failover and Failover Supportconfiguring and unconfiguring

primary and alternatedevices 41

querying primary and alternatepath configuration 41

path failover Support 39primary and alternate paths 40

Path Failover Supportconfiguring and unconfiguring

path failover support 40Persistent Naming Support 36Problem Determination 43

ATRC utility 48automatic dump facility for 3590

and Magstar MP tape drives 47detail data 46

AIX (continued)Problem Determination (continued)

error labels 45error log templates 45error logging 45trace facility 47

Special Files 34Special Files for 3490E, 3590,

Magstar MP, or 7332 tapedevices 34

Special Files for 3575, 7331, 7334,7336, or 7337 medium changerdevices 35

System-Managed Encryption 41Tape Drive Service Aids 48

create an FMR tape 51Detailed Description 49error log analysis 50force microcode dump 49microcode load 50read dump 49reset drive 51

Tape Drive, Media, and Device DriverParameters

alternate pathing 29autoloading 29Automatic Cartridge Facility

Mode 34block size 30buffered mode 31capacity scaling 33compression 31configuration parameters 29emulate autoloader 30fail degraded media 31logging 31logical write protect 33maximum size of log file 31media parameters 33new logical name 32read error recovery time 32record space mode 32rewind immediate 32trailer labels 32volume ID for logging 34

Tape Utility (tapeutil) Program 361Automatic Cartridge Facility (ACF)

Mode 371Block Size and SCSI Transfer

Size 371Capacity Scaling 372command-line interface 362Configuration Parameters 371General Subcommands 363interactive interface 362Logical Write Protect 372Medium Changer

Subcommands 365Reserve and Release

Commands 373Service Aid Subcommands 370

AIX (continued)Tape Utility (tapeutil) Program

(continued)Tape Subcommands 367Volume ID for Logging 374

Using Dump Support 43dump device commands 43

AIX (Atape)Installation and Configuration

Instructions 26configuring tape and medium

changer devices 27Installation Procedure 27

Introduction and ProductRequirements 23

Data Flow 24Hardware Requirements 24Product Requirements 9, 24Purpose 9, 23Software Requirements 26

Performance Considerations 51Before Calling Support 52common utilities 52data path 51

Tape Drive, Media, and Device DriverParameters 28

AIX 3494 Enterprise Tape LibraryInstallation Instructions 213

Configuring Library ManagerControl Point 215

configuring the 3490E orEnterprise Tape System 3590 tapedrive 214

configuring the serial port 214Connecting the TotalStorage

Enterprise Tape Library 213deconfiguring the Library Manager

Control Point 219defining tape libraries to the

daemon 214installation procedure 213loading the daemon 218uninstall procedure 219

Problem Determination 219daemon trace facility 220device driver trace facility 220error logging 219

Product Requirementsdata flow 212hardware requirements 213software requirements 213

Special Files 219AIX 3494 Enterprise Tape Library Driver

Library Driver InformationTotalStorage Virtual Tape Server

Subsystem Attachment 212AIX device parameters 52AIX microcode 357AIX System testing 344

3494 Enterprise tape libraryattachment test 345

© Copyright IBM Corp. 2007, 2009 429

Page 448: IBM Tape Driver IUG 1

AIX System testing (continued)medium changer device attachment

test 344tape device attachment test 344

AIX System-Managed EncryptionSystem-Managed Encryption 41

Application-Managed TapeEncryption 17

Application-Managed Tape EncryptionSetup Tasks 18

Bbulk rekey 22

CChecklist 18Comments xivconfiguration 19, 42, 373connectivity 42, 373CPF commands 379

DData Path Failover 9device driver configuration 41device drivers

Attachment to open systemsservers 1

Device driversAttachment to open systems servers

3490E tape subsystem 77331, 7334, 7336, or 7337 tape

medium changer 8Magstar MP 3570 7Magstar MP 3575 tape library 7

drive dump 42

EEKM server logs 42emulation 209Encryption 9encryption key manage configuration

file 19error logging 42

Ffailover 21field support 42

Ggeneral information 17

HHP-UX

Installation and ConfigurationInstructions 58

HP-UX (ATDD)Configuration Parameter

Definitions 75device-specific parameters 75driver-specific parameters 77

Install, Uninstall, and Configurationcreate hardware path entry 71determine drive hardware path for

3581 70determine drive hardware paths

for 3580 and 3583 with fibrechannel attachment 70

determine drive hardware pathsfor 3583/3584 Tape Librarieswith SCSI attachment 70

Installation and Configuration forDLKM PCI Drivers 58

Installation and Configuration for PCIDrivers 62

command sequenceinformation 59

copy software to softwaredepot 62

create device-specific configurationentries (optional) 61

create drive configuration file, ifrequired 59

create hardware path entry 60determine device hardware path

for IBM tape drives 60install driver manually 62install the ATDD software 62Overview of the Installation

Process 58power off tape drives 61Preinstallation considerations 59

Installation and Configuration forPrecision Bus Drivers 66

adding a tape device usingcurrently installed ATDD 74

copy software to softwaredepot 72

create configuration file 67create device-specific configuration

entries (optional) 71create hardware path entry 71determine device hardware path

for 3590 67determine device hardware path

for Magstar MP 3570 tapesubsystem 68

determine device hardware pathfor Magstar MP 3575 tapelibraries 69

install the ATDD software 73other administrative tasks 75power off tape drives 72Preinstallation Considerations 66review ATDD README file 73

Persistent Naming Support 80Product Requirements 55

ATDD implementation 56data flow 55hardware requirements 56software interface to device

driver 58software requirements 57

HP-UX (ATDD) (continued)Special Files 79Supported Configurations 75

modifying configurationparameters 77

Tape Utility Program (tapeutil)copy software to software

depot 375hardware requirements 375install manually 375install the product 376other administrative tasks 376review tapeutil README file 376tapeutil command-line

interface 378tapeutil implementation 375tapeutil interactive interface 377uninstalling the software 376Using tapeutil 377

tapeutil service commands 378Troubleshooting 85

Atdd_d log daemon 87error logging 85Problems and Solutions 89Support_info script 86tracing facility 86

HP-UX (ATDD) basic SCSIcommands 378

HP-UX (ATDD) flag description 380HP-UX (ATDD) medium changer

commands 379HP-UX (ATDD) tape drive

commands 379HP-UX 3494 Enterprise Tape Library

Product RequirementsCompatibility 222data flow 221hardware requirements 222software compatibility 223software requirements 222

HP-UX 3494 Enterprise Tape LibraryDriver

Installation Instructions 223adding or deleting entries in the

library device 226command sequence

information 223connecting the TotalStorage

Enterprise tape library 225copy software to depot 224defining the library device to

lmcpd 225install manually 224install the product 224installation overview 223other administrative tasks 226uninstall procedure 226

Problem Determination 226daemon trace facility 227error logging 227

HP-UX microcode 358, 375HP-UX System testing 346

3494 Enterprise tape libraryattachment test 347

autochanger device attachmenttest 346

tape device attachment test 346

430 IBM Tape Device Drivers Installation and User’s Guide

Page 449: IBM Tape Driver IUG 1

IIntroduction 1ITDT

Accessing 262Introduction and Product

RequirementsPurpose 260

Purpose 260

Llibrary requirements 17Library-Managed Tape Encryption 18libsmc extension 209Linux 113

System-Managed Encryption 113Linux (IBMtape)

Tape Utility Program(IBMtapeutil) 385

command-line mode 385General Subcommands 386interactive mode 385

Linux (lin_tape)Installation and Configuration

Instructions 96components created during

installation 97Configuring Tape and Medium

Changer Devices 99conventions used 96installation procedure 97querying installed package 98uninstall procedure 102update procedure 98verifying/updating

installation 99Introduction and Product

Requirements 93Product Requirements

Data Flow 93hardware requirements 94, 95software requirements 96

Special Files 107Special Files for medium changer

device 107Special Files for tape device 107

Tape Drive Service Aids 121Detailed Description 121force drive dump 121load microcode 121read dump 121reset drive 121

Tape Drive, Media, and Device DriverParameters 102

changeable parameters 104configuration parameters 102nonchangeable parameters 103

Tape Utility Program (IBMtapeutil)Automatic Cartridge Facility (ACF)

Mode 393Block Size and SCSI Transfer

Size 393Configuration Parameters 393Create Special Files 394Medium Changer

Subcommands 391

Linux (lin_tape) (continued)Tape Utility Program (IBMtapeutil)

(continued)Reserve and Release

Commands 393Service Aid Subcommands 392Tape Drive Service Aids 394Tape Subcommands 387

Linux 3494 Enterprise Tape LibraryInstallation Instructions 230

adding or deleting entries in thelibrary device 232

connecting TotalStorage Enterprise3494 tape library 230

defining the library device toatldd 231

installation procedure 230uninstall procedure 232

Problem Determination 233daemon trace facility 233error logging 233

Product Requirementsdata flow 228hardware requirements 229software requirements 229

Linux EnterpriseInstallation Instructions

querying the installedpackage 232

updating procedure 232verifying the install/update 232

Linux microcode 358Linux System-Managed Encryption

System-Managed Encryption 113Linux verification testing 348

3494 Enterprise tape libraryattachment test 349

medium changer device attachmenttest 348

tape device attachment test 348

Mmanaging encryption 17Managing Microcode on the Tape

Drive 357Microsoft Windows microcode 358Microsoft Windows System testing 352

3494 Enterprise tape libraryattachment test 353

autochanger device attachment test -Windows NT only 352

tape device attachment test 352

NNotices 427

OOnline access 341

PPath Failover 9

Automatic Failover 12Load Balancing 12

path failover supportlibrary control path failover 81

Qquerying drive configuration 42, 372

RRelated Information ix

3447 and 7337 Digital Linear TapeLibrary xiii

3490E Tape Subsystem xii3592 Tape System ixAdditional Information xivAIX xiHP-UX xiIBM 7331 8mm Tape Library xiiiIBM 7332 4mm DDS-2 Tape Cartridge

Autoloader xiiiIBM 7332 Model 220 External 4mm

Tape Autoloader xiiiIBM 7334 8mm Tape Library xiiiIBM 7336 4mm Tape Library xiiiIBM TotalStorage Enterprise Tape

System 3590 xiiiIBM TotalStorage UltraScalable Tape

Library 3584 xIBM TotalStorage Ultrium External

Tape Drive 3580 xiIBM TotalStorage Ultrium Scalable

Tape Library 3583 xiiIBM TotalStorage Ultrium Tape

Autoloader 3581 xiIBM TotalStorage Ultrium Tape

Library 3582 xiiLinux xiMagstar MP 3570 Tape Subsystem xiiMagstar MP 3575 Tape Subsystem xiiMicrosoft Windows xiSGI (Silicon Graphics) xivSolaris xiTotalStorage Enterprise Automated

Tape Library 3494 xiiTru64 xiv

requirementslibrary 17tape 17

Ssample configuration file 19sense data 42server logs 42SGI IRIX 3494 Enterprise Tape Library

Installation Instructions 255configuring the serial port 256connecting the Enterprise tape

library 256defining the library device to

LMCPD 257

Index 431

Page 450: IBM Tape Driver IUG 1

SGI IRIX 3494 Enterprise Tape Library(continued)

Installation Instructions (continued)installation procedure 255problem determination 258starting the Enterprise tape library

daemon 258uninstall procedure 255

Introductiondata flow 253hardware requirements 254software requirements 254

SGI/IRIX System testing 3563494 Enterprise tape library

attachment test 356SMIT panels 41Solaris 153

System-Managed Encryption 153Solaris (IBMtape)

Installation and ConfigurationInstructions 126

Adding or Removing Devices 142installing and updating

IBMtape 128preventing conflicts with other

device drivers 127removing IBMtape 142

Installation, Removal, andConfiguration

Configuration Parameters 139preinstallation considerations 127

Introduction and ProductRequirements 123

Persistent Naming Support 148Product Requirements and

Compatibility 124Data Flow 123hardware requirements 124software requirements 126

Service and Diagnostic Aids 155Basic SCSI Commands 398downloading device

microcode 401forcing and storing device

diagnostic dump 402functional verification 155Medium Changer Commands 398problem determination 156Service Commands 398setting the IBM_trace level 159Tape Drive Commands 398tape/medium changer utility

program 397tracing facility 157

Special Files 145device behaviors 146file naming conventions 147

Solaris 3494 Enterprise Tape LibraryInstallation Instructions 236

adding or deleting entries in thelibrary 238

configuring the serial port 237connecting the Enterprise tape

library 237defining the symbolic name to the

lmcpd 237preinstallation considerations 236

Solaris 3494 Enterprise Tape Library(continued)

Installation Instructions (continued)uninstall procedure 239

Problem Determination 239daemon trace facility 239error logging 239

Product Requirementsdata flow 234hardware requirements 235software compatibility 236software requirements 236

Solaris flag description 399Solaris System testing 350

3494 Enterprise tape libraryattachment test 351

autochanger device attachmenttest 350

tape device attachment test 350Solaris System-Managed Encryption

System-Managed Encryption 153StorageSmart by IBM Ultrium device

driversAttachment to open systems servers

Ultrium Products 6Sun Solaris microcode 358Supported Hardware 9System-Managed Encryption 41, 113,

153, 184system-managed encryption

configuration 19System-Managed Tape Encryption 18

TTape Utility (tapeutil) Program 361testing data encryption configuration 42,

373timeout value 21TotalStorage device drivers

Attachment to open systems servers3494 Tape Library 63590 TotalStorage tape drive 7Virtual Tape Server 7

Trademarks 428Tru64

Installation and ConfigurationInstructions 425

Command-Line mode 426Command-Line options 426Installation procedure from the

device driver ftp site 425Interactive mode 426Query procedure 425uninstall procedure 425Update procedure 425Verify procedure 425

Introduction and ProductRequirements 189

Hardware Requirements 189Product Requirements 189Purpose 189Setting up the environment 189Software Requirements 189

Tru64 3494 Enterprise Tape LibraryInstallation Instructions 249

Tru64 3494 Enterprise Tape Library(continued)

adding or deleting entries in thelibrary device 250

connecting TotalStorage EnterpriseTape Library 3494 249

defining the library device toatldd 249

installation procedure 249uninstall procedure 251

Problem Determination 251daemon trace facility 252error logging 252

Product Requirementsdata flow 247hardware requirements 248software requirements 248

Tru64 EnterpriseInstallation Instructions

querying the installedpackage 251

updating procedure 250verifying the install/update 251

Tru64 System testing 3543494 Enterprise tape library

attachment test 355medium changer device attachment

test 354tape device attachment test 354

UUltrium device drivers

Attachment to open systems servers3580 Ultrium Tape Drive 63581 Ultrium Tape 2U

Autoloader 63581 Ultrium Tape Autoloader 63582 Ultrium Tape Library 53583 Ultrium Scalable Tape

Library 53584 UltraScalable Tape Library 5

VVerifying device attachment 343

WWindows 184

System-Managed Encryption 184Utility Program (ntutil) 406

batch mode 409calling ntutil 406command 410comment 410interactive mode 407supported command text

fields 410supported result text fields 421symbolic values 422

Windows 3494 Enterprise Tape LibraryInstallation Instructions 242

adding or deleting library on theservice 244

432 IBM Tape Device Drivers Installation and User’s Guide

Page 451: IBM Tape Driver IUG 1

Windows 3494 Enterprise Tape Library(continued)

Installation Instructions (continued)connecting the 3494 Enterprise

tape library 243defining the symbolic name to the

service 244installation procedure 242uninstall procedure 245

Problem Determinationdaemon trace facility 246

Product Requirementsdata flow 240hardware requirements 241software requirements 241

Windows Device DriverDevice Driver Management 177

disable procedure 181installation overview 178installation procedures 178removal procedure 181uninstalling the device

drivers 181Introduction and Product

Requirements 163Product Requirements

software requirements 165Windows NT

Device Driver Managementinstallation overview 165installation procedure 166manual starting and stopping

procedures 176removal procedure 172

Installation and ConfigurationInstructions

Adding or Removing Devices 165Product Requirements 165

Windows System-Managed EncryptionSystem-Managed Encryption 184

Windows Utility Program (ntutil)Batch Mode

poll_devices 415Utility Program (ntutil) 406

Index 433

Page 452: IBM Tape Driver IUG 1

434 IBM Tape Device Drivers Installation and User’s Guide

Page 453: IBM Tape Driver IUG 1

Readers’ Comments — We’d Like to Hear from You

IBM Tape Device DriversInstallation and User’s Guide

Publication No. GC27-2130-08

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 theinformation 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, yourIBM 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 anyway it believes appropriate without incurring any obligation to you. IBM or any other organizations will only usethe 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

Page 454: IBM Tape Driver IUG 1

Readers’ Comments — We’d Like to Hear from YouGC27-2130-08

GC27-2130-08

����Cut or FoldAlong Line

Cut or FoldAlong Line

Fold and Tape Please do not staple Fold and Tape

Fold and Tape Please do not staple Fold and Tape

NO POSTAGENECESSARYIF MAILED IN THEUNITED STATES

BUSINESS REPLY MAILFIRST-CLASS MAIL PERMIT NO. 40 ARMONK, NEW YORK

POSTAGE WILL BE PAID BY ADDRESSEE

International Business Machines CorporationInformation DevelopmentDepartment GZW9000 South Rita RoadTucson, Arizona 85775-4401

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

__

_

Page 455: IBM Tape Driver IUG 1
Page 456: IBM Tape Driver IUG 1

����

Printed in USA

GC27-2130-08

Page 457: IBM Tape Driver IUG 1

Spineinformation:

��

�IB

MTa

peD

evic

eD

river

sIB

MTa

peD

evic

eD

rive

rsIn

stal

latio

nan

dU

ser’s

Gui

de