dynamic link manager - support.hitachivantara.com · hitachi command suite dynamic link manager...

Hitachi Command Suite

Dynamic Link Manager(for VMware®) User Guide

MK-92DLM130-09

Document Organization

Product Version

Getting Help

Contents

© 2014 Hitachi, Ltd. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or by any means,electronic or mechanical, including photocopying and recording, or stored in a database or retrievalsystem for any purpose without the express written permission of Hitachi, Ltd.

Hitachi, Ltd., reserves the right to make changes to this document at any time without notice andassumes no responsibility for its use. This document contains the most current information availableat the time of publication. When new or revised information becomes available, this entiredocument will be updated and distributed to all registered users.

Some of the features described in this document might not be currently available. Refer to the mostrecent product announcement for information about feature and product availability, or contactHitachi Data Systems Corporation at https://portal.hds.com.

Notice: Hitachi, Ltd., products and services can be ordered only under the terms and conditions ofthe applicable Hitachi Data Systems Corporation agreements. The use of Hitachi, Ltd., products isgoverned by the terms of your agreements with Hitachi Data Systems Corporation.

Hitachi is a registered trademark of Hitachi, Ltd., in the United States and other countries. HitachiData Systems is a registered trademark and service mark of Hitachi, Ltd., in the United States andother countries.

Archivas, Essential NAS Platform, HiCommand, Hi-Track, ShadowImage, Tagmaserve, Tagmasoft,Tagmasolve, Tagmastore, TrueCopy, Universal Star Network, and Universal Storage Platform areregistered trademarks of Hitachi Data Systems.

AIX, AS/400, DB2, Domino, DS6000, DS8000, Enterprise Storage Server, ESCON, FICON,FlashCopy, IBM, Lotus, MVS, OS/390, RS/6000, S/390, System z9, System z10, Tivoli, VM/ESA,z/OS, z9, z10, zSeries, z/VM, and z/VSE are registered trademarks or trademarks of InternationalBusiness Machines Corporation.

All other trademarks, service marks, and company names in this document or web site areproperties of their respective owners.

Microsoft product screen shots are reprinted with permission from Microsoft Corporation.

Notice on Export Controls. The technical data and technology inherent in this Document may besubject to U.S. export control laws, including the U.S. Export Administration Act and its associatedregulations, and may be subject to export or import regulations in other countries. Reader agrees tocomply strictly with all such regulations and acknowledges that Reader has the responsibility toobtain licenses to export, re-export, or import the Document and any Compliant Products.

iiHitachi Dynamic Link Manager (for VMware®) User Guide

https://portal.hds.com

Contents

Preface.................................................................................................. ixIntended audience..................................................................................................... xProduct version..........................................................................................................xRelease notes............................................................................................................ xDocument revision level..............................................................................................xDocument organization..............................................................................................xiRelated documents....................................................................................................xiDocument conventions..............................................................................................xiiConventions for storage capacity values.....................................................................xiiAccessing product documentation............................................................................. xiiiGetting help............................................................................................................ xiiiComments...............................................................................................................xiii

1 Overview of HDLM................................................................................1-1What is HDLM?.......................................................................................................1-2HDLM Features.......................................................................................................1-2

2 HDLM Functions................................................................................... 2-1Devices Managed by HDLM......................................................................................2-2System Configuration.............................................................................................. 2-2

System Configuration Using an FC-SAN.............................................................. 2-2System Configuration Using an IP-SAN...............................................................2-3

LU Configuration.....................................................................................................2-6Program Configuration............................................................................................ 2-6HDLM driver and NMP positions............................................................................... 2-8Distributing a Load Using Load Balancing..................................................................2-8

Paths to Which Load Balancing Is Applied.........................................................2-10When Using the Hitachi AMS/WMS Series................................................2-10When Using the Universal Storage Platform V/VM Series, Virtual StoragePlatform Series, VSP G1000 Series, Hitachi AMS2000 Series, Hitachi SMSSeries, HUS100 Series, or HUS VM..........................................................2-11When Using a Global-Active Device for the VSP G1000 Series .................. 2-12

Load Balancing Algorithms...............................................................................2-12Performing Failovers and Failbacks Using Path Switching......................................... 2-13

Automatic Path Switching................................................................................2-13

iiiHitachi Dynamic Link Manager (for VMware®) User Guide

Automatic Failovers............................................................................... 2-14Automatic Failbacks...............................................................................2-15

Manual Path Switching.................................................................................... 2-16Path Status Transition..................................................................................... 2-17

The Online Path Statuses....................................................................... 2-17The Offline Path Statuses.......................................................................2-17Correspondence between VMware vSphere and HDLM path statuses.........2-18Status Transitions of a Path....................................................................2-18

Monitoring Intermittent Errors................................................................................2-20Checking Intermittent Errors............................................................................2-20Setting Up Intermittent Error Monitoring...........................................................2-20Intermittent Error Monitoring Actions............................................................... 2-21When a User Changes the Intermittent Error Information.................................. 2-21

Detecting Errors by Using Path Health Checking...................................................... 2-22Distributing a Load by Using the Dynamic I/O Path Control Function.........................2-22

What is the Dynamic Load Balance Control Function..........................................2-22Dynamic I/O Path Control Function.................................................................. 2-23

Error Management................................................................................................ 2-23Types of Collected Logs...................................................................................2-24Collecting Error Information.............................................................................2-26

Collecting Audit Log Data.......................................................................................2-26Categories and Audit Events that HDLM Can Output to the Audit Log................. 2-28Requirements for Outputting Audit Log Data.....................................................2-30Destination and Filtering of Audit Log Data....................................................... 2-31Audit Log Data Formats...................................................................................2-31

Integrated HDLM management using Global Link Manager.......................................2-33

3 Creating an HDLM Environment............................................................. 3-1HDLM System Requirements....................................................................................3-2

Hosts and OSs Supported by HDLM................................................................... 3-2Host OS support......................................................................................3-2Remote management client OS support.................................................... 3-2

Storage Systems Supported by HDLM................................................................ 3-3Memory and Disk Capacity Requirements........................................................... 3-4

Memory Requirements.............................................................................3-4Disk Requirements.................................................................................. 3-4

Number of LUs and Paths That Are Supported in HDLM.......................................3-4Flow for Creating an HDLM Environment.................................................................. 3-5HDLM Installation Types..........................................................................................3-5Notes on Creating an HDLM Environment................................................................. 3-5Installing HDLM...................................................................................................... 3-7

Performing a New Installation of HDLM.............................................................. 3-7New installation on remote management client..........................................3-7Unattended installation on remote management client............................... 3-8New installation on host.........................................................................3-10

Performing an Upgrade Installation of HDLM.................................................... 3-11Performing a Re-installation of HDLM............................................................... 3-12Settings When Managing HDLM by Using Global Link Manager...........................3-12

Creating a user account......................................................................... 3-12Adding the host to the Credential Store file............................................. 3-13Executing the dlmrmcenv utility..............................................................3-13Specify Windows Firewall settings...........................................................3-14

ivHitachi Dynamic Link Manager (for VMware®) User Guide

Checking the Path Configuration............................................................................ 3-15Setting Up HDLM.................................................................................................. 3-16

Checking the Current Settings..........................................................................3-16Setting Up the HDLM Functions........................................................................3-17

Setting Up Load Balancing..................................................................... 3-17Setting Up Intermittent Error Monitoring................................................. 3-18Setting Up Dynamic I/O Path Control...................................................... 3-18Setting Up Audit Log Data Collection.......................................................3-19

Checking the Updated Settings........................................................................ 3-20Setting Up Integrated Traces................................................................................. 3-20Removing HDLM................................................................................................... 3-23

Preparations for HDLM Removal.......................................................................3-23Removing HDLM.............................................................................................3-23

Removing HDLM from a host..................................................................3-24Removing HDLM from a remote management client.................................3-25

4 HDLM Operation................................................................................... 4-1HDLM Operations Using Commands......................................................................... 4-2

Notes on Using Commands................................................................................4-2Viewing Path Information..................................................................................4-2Changing the Status of Paths.............................................................................4-3

Changing the Status of Paths to Online.....................................................4-3Changing the Status of Paths to Offline(C)................................................ 4-3

Viewing LU Information.....................................................................................4-4Initializing Statistical Information for Paths.........................................................4-5Viewing and Setting Up the Operating Environment............................................ 4-5

Viewing the Operating Environment..........................................................4-5Setting Up the Operating Environment......................................................4-6

Viewing License Information..............................................................................4-6Updating the License........................................................................................ 4-7Viewing HDLM Version Information....................................................................4-7Viewing HDLM Component Information.............................................................. 4-8

Starting and Stopping the HDLM Manager................................................................ 4-9Starting the HDLM Manager.............................................................................. 4-9Stopping the HDLM Manager............................................................................. 4-9

HDLM Resident Processes......................................................................................4-10

5 Troubleshooting....................................................................................5-1Collecting Error Information.....................................................................................5-2Checking Error Information in Messages...................................................................5-2What To Do for a Path Error.................................................................................... 5-2

Examining the Messages................................................................................... 5-3Obtain Path Information....................................................................................5-3Identifying the Error Path..................................................................................5-3Narrowing Down the Hardware That Might Have Caused the Error....................... 5-4Identifying the Error Location and Correcting any Hardware Error........................ 5-4Placing the Path Online..................................................................................... 5-4

What To Do for a Program Error.............................................................................. 5-4Examining the Messages................................................................................... 5-5Obtaining Program Information......................................................................... 5-5What To Do for the Program Error..................................................................... 5-5

vHitachi Dynamic Link Manager (for VMware®) User Guide

Contacting your HDLM Vendor or Maintenance Company.....................................5-6What To Do for Other Errors....................................................................................5-6

6 Command Reference.............................................................................6-1Overview of the HDLM Command dlnkmgr................................................................6-2clear (Returns the Path Statistics to the Initial Value)................................................ 6-3

Format.............................................................................................................6-3To set the path statistics to 0...................................................................6-3To display the format of the clear operation.............................................. 6-4

Parameters...................................................................................................... 6-4To Set the Path Statistics to 0.................................................................. 6-4To Display the Format of the clear Operation............................................ 6-4

help (Displays the Operation Format)....................................................................... 6-5Format.............................................................................................................6-5Parameter........................................................................................................6-5

offline (Places Paths Offline)....................................................................................6-7Format.............................................................................................................6-7

To place paths offline.............................................................................. 6-7To Display the Format of the offline Operation.......................................... 6-7

Parameters...................................................................................................... 6-7To place paths Offline..............................................................................6-7To Display the Format of the Offline Operation..........................................6-9

online (Places Paths Online)...................................................................................6-10Format...........................................................................................................6-11

To place paths Online............................................................................ 6-11To Display the Format of the Online Operation........................................ 6-11

Parameters.....................................................................................................6-11To place paths Online............................................................................ 6-11To Display the Format of the Online Operation........................................ 6-14

set (Sets Up the Operating Environment)................................................................6-15Format...........................................................................................................6-15

To Set the Host Operating Environment.................................................. 6-15To Set the Remote Management Client Operating Environment................ 6-15To Display the Format of the Set Operation.............................................6-15

Parameters.....................................................................................................6-16To Set the Host Operating Environment.................................................. 6-16To Set the Remote Management Client Operating Environment................ 6-18To Display the Format of the Set Operation.............................................6-21

view (Displays Information)................................................................................... 6-23Format...........................................................................................................6-24

To Display Program Information for a Host..............................................6-24To Display Program Information for a Remote Management Client............6-24To Display Path Information...................................................................6-24To Display LU Information......................................................................6-25To Display the Format of the view Operation...........................................6-25

Parameters (To display program information)................................................... 6-25To Display Program Information for Hosts...............................................6-26To Display Program Information for a Remote Management Client............6-29To display path information....................................................................6-31To display LU information...................................................................... 6-45To display the format of the view operation.............................................6-55

refresh (Applies Storage System Settings to HDLM)................................................. 6-57

viHitachi Dynamic Link Manager (for VMware®) User Guide

Format...........................................................................................................6-57To Apply Storage System Settings to HDLM.............................................6-57To Display the Format of the refresh Operation....................................... 6-58

Parameters.....................................................................................................6-58To Apply Storage System Settings to HDLM.............................................6-58To Display the Format of the refresh Operation....................................... 6-59

7 Utility Reference................................................................................... 7-1Overview of the Utilities.......................................................................................... 7-2The DLMgetras Utility for Collecting HDLM Error Information......................................7-2

Format.............................................................................................................7-2Parameters...................................................................................................... 7-3List of Collected Error Information..................................................................... 7-4

The dlmrmcenv Utility for Configuring HDLM Remote Management Client Environments............................................................................................................................. 7-7

Format.............................................................................................................7-7Parameters...................................................................................................... 7-7

The installhdlm Utility for Installing HDLM.................................................................7-8Format.............................................................................................................7-8Parameters...................................................................................................... 7-8Contents of an Installation-Information Settings File........................................... 7-9About the Log File...........................................................................................7-11

The removehdlm Utility for Removing HDLM........................................................... 7-11Format...........................................................................................................7-12Parameters.....................................................................................................7-12

8 Messages............................................................................................. 8-1Before Viewing the List of Messages.........................................................................8-2

Format and Meaning of Message IDs................................................................. 8-2Terms Used in Messages and Message Explanations............................................8-2

KAPL01001 to KAPL02000....................................................................................... 8-3KAPL03001 to KAPL04000......................................................................................8-27KAPL04001 to KAPL05000......................................................................................8-28KAPL08001 to KAPL09000......................................................................................8-35KAPL09001 to KAPL10000......................................................................................8-36KAPL10001 to KAPL11000......................................................................................8-42KAPL11001 to KAPL12000......................................................................................8-46KAPL13001 to KAPL14000......................................................................................8-50KAPL15001 to KAPL16000......................................................................................8-50KAPL20001 to KAPL21000......................................................................................8-52KAPL21001 to KAPL22000......................................................................................8-60Return Codes for Hitachi Command Suite Common Agent Component...................... 8-61

Acronyms and abbreviations

Glossary

Index

viiHitachi Dynamic Link Manager (for VMware®) User Guide

viiiHitachi Dynamic Link Manager (for VMware®) User Guide

Preface

This document describes how to use the Hitachi Dynamic Link Manager.

□ Intended audience

□ Product version

□ Release notes

□ Document revision level

□ Document organization

□ Related documents

□ Document conventions

□ Conventions for storage capacity values

□ Accessing product documentation

□ Getting help

□ Comments

Preface ixHitachi Dynamic Link Manager (for VMware®) User Guide

Intended audienceThis document is intended for storage administrators who use HitachiDynamic Link Manager (HDLM) to operate and manage storage systems, andassumes that readers have:

• Knowledge of VMware vSphere and its management functionality• Knowledge of Storage system management functionality

Product versionThis document revision applies to HDLM for VMware v8.1 or later.

Release notesRead the release notes before installing and using this product. They maycontain requirements or restrictions that are not fully described in thisdocument or updates or corrections to this document.

Document revision levelRevision Date Description

MK-92DLM130-00 November 2011 Initial Release

MK-92DLM130-01 July 2012 Revision 1, supersedes and replacesMK-92DLM130-00

MK-92DLM130-02 August 2012 Revision 2, supersedes and replacesMK-92DLM130-01

MK-92DLM130-03 November 2012 Revision 3, supersedes and replacesMK-92DLM130-02

MK-92DLM130-04 February 2013 Revision 4, supersedes and replacesMK-92DLM130-03

MK-92DLM130-05 May 2013 Revision 5, supersedes and replacesMK-92DLM130-04

MK-92DLM130-06 October 2013 Revision 6, supersedes and replacesMK-92DLM130-05

MK-92DLM130-07 April 2014 Revision 7, supersedes and replacesMK-92DLM130-06

MK-92DLM130-08 August 2014 Revision 8, supersedes and replacesMK-92DLM130-07

MK-92DLM130-09 October 2014 Revision 9, supersedes and replacesMK-92DLM130-08

x PrefaceHitachi Dynamic Link Manager (for VMware®) User Guide

Document organizationThe following table provides an overview of the contents and organization ofthis document. Click the chapter title in the left column to go to that chapter.The first page of each chapter provides links to the sections in that chapter.

Chapter/Appendix Description

Chapter 1, Overview of HDLM onpage 1-1

Gives an overview of HDLM, and describes itsfeatures.

Chapter 2, HDLM Functions onpage 2-1

Describes management targets and the systemconfiguration of HDLM, and the basic terms andfunctions for HDLM.

Chapter 3, Creating an HDLMEnvironment on page 3-1

Describes the procedures for building an HDLMenvironment (including installing and setting upHDLM), and describes for canceling the settings.

Chapter 4, HDLM Operation onpage 4-1

Describes how to use HDLM by using both the HDLMcommands, and how to manually start and stop theHDLM manager.

Chapter 5, Troubleshooting onpage 5-1

Explains how to troubleshoot a path error, HDLMfailure, or any other problems that you mightencounter.

Chapter 6, Command Referenceon page 6-1

Describes all the HDLM commands.

Chapter 7, Utility Reference onpage 7-1

Describes the HDLM utilities.

Chapter 8, Messages on page 8-1 Provides information for all the possible messagesthat could be output by HDLM. It also lists andexplains the HDLM messages and shows the actionsto be taken in response to each message.

Related documentsThe following related Hitachi Command Suite documents are available on thedocumentation CD:

• Hitachi Adaptable Modular Storage Series User's Guide• Hitachi Simple Modular Storage Series User's Guide• Hitachi Unified Storage Series User's Guide• Hitachi Workgroup Modular Storage Series User's Guide• Universal Storage Platform V Series User's Guide• Universal Storage Platform VM Series User's Guide• Virtual Storage Platform Series User's Guide• VSP G1000 Series User's Guide

Preface xiHitachi Dynamic Link Manager (for VMware®) User Guide

Document conventionsThis document uses the following typographic conventions:

Convention Description

Bold Indicates text on a window, other than the window title, includingmenus, menu options, buttons, fields, and labels. Example: Click OK.

Italic Indicates a variable, which is a placeholder for actual text provided bythe user or system. Example: copy source-file target-fileNote: Angled brackets (< >) are also used to indicate variables.

Monospace Indicates text that is displayed on screen or entered by the user.Example: # pairdisplay -g oradb

< > angledbrackets

Indicates a variable, which is a placeholder for actual text provided bythe user or system. Example: # pairdisplay -g <group>Note: Italic font is also used to indicate variables.

[ ] squarebrackets

Indicates optional values. Example: [ a | b ] indicates that you canchoose a, b, or nothing.

{ } braces Indicates required or expected values. Example: { a | b } indicatesthat you must choose either a or b.

| vertical bar Indicates that you have a choice between two or more options orarguments. Examples: [ a | b ] indicates that you can choose a, b, ornothing. { a | b } indicates that you must choose either a or b.

underline Indicates the default value.Example:

[ a | b ]

PROMPT> Indicates the prompt in the window where the command is executed.PROMPT indicates the current directory path displayed in the window.

Conventions for storage capacity valuesPhysical storage capacity values (for example, disk drive capacity) arecalculated based on the following values:

Physical capacity unit Value

1 kilobyte (KB) 1,000 (103) bytes

1 megabyte (MB) 1,000 KB or 1,0002 bytes

1 gigabyte (GB) 1,000 MB or 1,0003 bytes

1 terabyte (TB) 1,000 GB or 1,0004 bytes

1 petabyte (PB) 1,000 TB or 1,0005 bytes

1 exabyte (EB) 1,000 PB or 1,0006 bytes

xii PrefaceHitachi Dynamic Link Manager (for VMware®) User Guide

Logical storage capacity values (for example, logical device capacity) arecalculated based on the following values:

Logical capacity unit Value

1 block 512 bytes

1 KB 1,024 (210) bytes

1 MB 1,024 KB or 1,0242 bytes

1 GB 1,024 MB or 1,0243 bytes

1 TB 1,024 GB or 1,0244 bytes

1 PB 1,024 TB or 1,0245 bytes

1 EB 1,024 PB or 1,0246 bytes

Accessing product documentationThe HDLM user documentation is available on the Hitachi Data SystemsPortal: https://portal.hds.com. Check this site for the most currentdocumentation, including important updates that may have been made afterthe release of the product.

Getting helpHitachi Data Systems Support Portal is the destination for technical support ofyour current or previously-sold storage systems, midrange and enterpriseservers, and combined solution offerings. The Hitachi Data Systems customersupport staff is available 24 hours a day, seven days a week. If you needtechnical support, log on to the Hitachi Data Systems Support Portal forcontact information: https://portal.hds.com.

Hitachi Data Systems Community is a new global online community for HDScustomers, partners, independent software vendors, employees, andprospects. It is an open discussion among these groups about the HDSportfolio of products and services. It is the destination to get answers,discover insights, and make connections. The HDS Community complementsour existing Support Portal and support services by providing an area whereyou can get answers to non-critical issues and questions. Join theconversation today! Go to community.hds.com, register, and completeyour profile.

CommentsPlease send us your comments on this document: [email protected] the document title and number, including the revision level (forexample, -07), and refer to specific sections and paragraphs whenever

Preface xiiiHitachi Dynamic Link Manager (for VMware®) User Guide



http://community.hds.com

possible. All comments become the property of Hitachi Data SystemsCorporation.

Thank you!

xiv PrefaceHitachi Dynamic Link Manager (for VMware®) User Guide

1Overview of HDLM

HDLM is a software package that manages paths between a host and astorage system. HDLM is designed to distribute loads across multiple pathsand will switch a given load to another path if there is a failure in the paththat is currently being used, thus improving system reliability.

This chapter gives an overview of HDLM and describes its features.

□ What is HDLM?

□ HDLM Features

Overview of HDLM 1-1Hitachi Dynamic Link Manager (for VMware®) User Guide

What is HDLM?With the widespread use of data warehousing and increasing use ofmultimedia data, the need for high-speed processing of large volumes of dataon networks has rapidly grown. To satisfy this need, networks dedicated tothe transfer of data, such as SANs, are now being used to provide access tostorage systems.

HDLM manages the access paths to these storage systems. HDLM providesthe ability to distribute loads across multiple paths and switch to another pathif there is a failure in the path that is currently being used, thus improvingsystem availability and reliability.

The figure below shows the connections between hosts and storage systems.

An ESXi server that connects to a storage system via a SAN is called a host. Amachine that connects to a host via a LAN and uses commands and utilitiesto control it is called a remote management client.

Figure 1-1 Connections Between Hosts and Storage systems

For details about the storage systems supported by HDLM, see StorageSystems Supported by HDLM on page 3-3.

HDLM FeaturesHDLM features include the following:

1-2 Overview of HDLMHitachi Dynamic Link Manager (for VMware®) User Guide

The ability to distribute a load across multiple paths. This is also known asload balancing.

When a host is connected to a storage system via multiple paths, HDLMcan distribute the load across all the paths. This prevents one, loadeddown path from affecting the processing speed of the entire system.For details on load balancing, see Distributing a Load Using LoadBalancing on page 2-8.

The ability to continue running operations between a host and storagesystem, even if there is a failure. This is also known as performing a failover.

When a host is connected to a storage system via multiple paths, HDLMcan automatically switch to another path if there is some sort of failure inthe path that is currently being used. This allows operations to continuebetween a host and a storage system.For details on performing failovers, see Performing Failovers and FailbacksUsing Path Switching on page 2-13.

The ability to bring a path that has recovered from an error back online. Thisis also known as performing a failback.

If a path is recovered from an error, HDLM can bring that path backonline. This enables the maximum possible number of paths to always beavailable and online, which in turn enables HDLM to better distribute theload across multiple paths.Failbacks can be performed manually or automatically. In an automaticfailback, HDLM automatically brings a path back online on the host sidewhen the user has fixed the physical fault in the path.For details on performing failbacks, see Performing Failovers andFailbacks Using Path Switching on page 2-13.

The ability to automatically check the status of any given path at regularintervals. This is also known as path health checking.#

Detects path errors by checking the path status at regular intervals. Thisallows you to check for any existing path errors and to resolve thempromptly and efficiently.For details on setting up and performing path health checking, seeDetecting Errors by Using Path Health Checking on page 2-22.

#This is implemented by functionality provided by VMware vSphere ESXi.

Overview of HDLM 1-3Hitachi Dynamic Link Manager (for VMware®) User Guide

1-4 Overview of HDLMHitachi Dynamic Link Manager (for VMware®) User Guide

2HDLM Functions

This chapter describes the various functions that are built into HDLM. Beforethe function specifications are explained though, this chapter will go intodetail about the HDLM management targets, system configuration, and basicterms that are necessary to know to effectively operate HDLM. After that, therest of the chapter focuses on describing all the HDLM functions, including themain ones: load distribution across paths and path switching.

□ Devices Managed by HDLM

□ System Configuration

□ LU Configuration

□ Program Configuration

□ HDLM driver and NMP positions

□ Distributing a Load Using Load Balancing

□ Performing Failovers and Failbacks Using Path Switching

□ Monitoring Intermittent Errors

□ Detecting Errors by Using Path Health Checking

□ Distributing a Load by Using the Dynamic I/O Path Control Function

□ Error Management

□ Collecting Audit Log Data

□ Integrated HDLM management using Global Link Manager

HDLM Functions 2-1Hitachi Dynamic Link Manager (for VMware®) User Guide

Devices Managed by HDLMBelow is a list of devices that can or cannot be managed by HDLM. Thedevices that can be managed by HDLM are called HDLM management-targetdevices.

HDLM management-target devices:The following devices are from the storage systems listed in Section Whatis HDLM? on page 1-2:

¢ SCSI devices¢ Hitachi storage system command devices, such as Hitachi RAID

Manager command devices

Non-HDLM management-target devices:

¢ SCSI devices other than those that are in the storage systems listedin Section What is HDLM? on page 1-2

¢ Built-in disks on a host¢ Non-disk devices (tape devices, etc.)

System ConfigurationHDLM manages routes between a host and a storage system by using theSCSI driver. A host and a storage system are connected via an FC-SAN or anIP-SAN.

System Configuration Using an FC-SANIn an FC-SAN, fiber cables connect hosts to storage systems. The cable porton the host is called a host bus adapter (HBA). The cable port on the storagesystem is called a port (P) on a channel adapter (CHA).

A logical unit (LU), which lies in a storage system, is either an input target oran output target to or from a host. The areas within an LU are called Devs.

A route that connects a host to a Dev in an LU is called a path.

HDLM assigns a unique ID to each management-target path. This ID is calledAutoPATH_ID. Sometimes, the path is also just simply called a managementtarget.

The following figure shows the configuration of an HDLM system using an FC-SAN.

2-2 HDLM FunctionsHitachi Dynamic Link Manager (for VMware®) User Guide

Figure 2-1 Configuration of an HDLM System When Using an FC-SAN

The following table lists the HDLM system components when using an FC-SAN.

Table 2-1 HDLM System Components When Using an FC-SAN

Components Description

HBA A host bus adapter. This serves as a cable port on thehost.

FC-SAN A dedicated network that is used for the transfer ofdata between hosts and storage systems

CHA A channel adapter

P A port on a CHA. This serves as a cable port on astorage system.

LU A logical unit with which a host can perform I/Ooperations. This unit can be accessed from the network.

Dev A logical area (a partition) in an LU

Path A route that connects a host to a Dev in an LU

System Configuration Using an IP-SANIn an IP-SAN, LAN cables are used to connect hosts to storage systems. Thecable port on the host is called an iSCSI host bus adapter (iSCSI HBA) or anetwork interface card (NIC). In order to use an NIC, the iSCSI softwaremust be installed ahead of time on the host. The cable port on the storage


system is called a port (P) on a channel adapter (CHA) used for iSCSIconnections.

A logical unit (LU), which lies in a storage system, is either an input target oran output target to or from a host. The areas within an LU are called Devs.

A route that connects a host to a Dev in an LU is called a path.

HDLM assigns a unique ID to each management-target path. This ID is calledAutoPATH_ID. Sometimes, the path is also just simply called a managementtarget.

The following table lists the HDLM system components when using an IP-SAN.

Figure 2-2 Configuration of an IP-SAN System When Using an iSCSI HBA


Figure 2-3 Configuration of an IP-SAN System When Using iSCSI Softwareand an NIC

Table 2-2 HDLM System Components When Using an IP-SAN on page 2-5lists the HDLM system components when using an IP-SAN.

Table 2-2 HDLM System Components When Using an IP-SAN


iSCSI software The driver software that contains the iSCSI initiator function

iSCSI HBA A host bus adapter that contains the iSCSI initiator function.This serves as a cable port on a host. The iSCSI HBA is referredto as the HBA in HDLM commands. Sometimes, it is also justsimply called an HBA in this manual.

NIC A network interface card that serves as a cable port on a host.The NIC is referred to as the HBA in HDLM commands.Sometimes, it is also just simply called an HBA in this manual.

IP-SAN A data transfer network that connects hosts and storagesystems by using the iSCSI standard.

CHA A channel adapter used for iSCSI connections

P A port on a CHA. This serves as a cable port on a storagesystem.

LU A logical unit with which the host can perform I/O operations.This unit can be accessed from the network.

Dev A logical area (a partition) in an LU

Path A route that connects a host to a Dev in an LU


LU ConfigurationThe following figure shows the LU configuration recognized by the host, afterthe installation of HDLM.

Figure 2-4 LU Configuration Recognized by the Host After the Installationof HDLM

The following table lists and describes the components recognized by thehost.

Table 2-3 Components Recognized by the Host


HLU An LU that the host recognizes via the HDLM driver. Thistype of LU is called a host LU. Regardless of how manypaths are connected to it, only one host LU is recognizedfor each LU in the storage system.

HDev A Dev in an LU that the host recognizes via the HDLMdriver. This type of Dev is called a host device.

Program ConfigurationHDLM is actually a combination of several programs. Because each programcorresponds to a specific HDLM operation, it is important to understand thename and purpose of each program, along with how they are all interrelated.

The following figure shows the configuration of the HDLM programs.


Figure 2-5 Configuration of the HDLM Programs

The following table lists and describes the functions of these programs.

Table 2-4 Functions of HDLM Programs

Program name Functions

HDLM command Provides the dlnkmgr command, which enables you to:

• Manage paths• Display error information• Set up the HDLM operating environment

HDLM utility Provides the HDLM utility, which enables you to:• Collect error information• Perform unattended installations of HDLM• Perform unattended removals of HDLM• Specify user account settings required for linking with

Global Link Manager

HDLM manager Monitors the operational status of hosts by linking withGlobal Link Manager.

HDLM driver Controls all the HDLM functions, manages paths, anddetects errors.• Save settings of an HDLM operating environment.• Perform path health checking and automatic failback,

by linking with the VMware vSphere ESXifunctionality.

• Output path error messages to syslog on ESXi .


HDLM driver and NMP positionsThe HDLM driver and NMP are positioned above the SCSI driver, causing eachapplication on a guest OS to access LUs in the storage system via the HDLMdriver and NMP.

The following figure shows the positioning of the HDLM driver and NMP.

Figure 2-6 Positioning of HDLM Driver and NMP

Distributing a Load Using Load BalancingWhen the system contains multiple paths to a single LU, HDLM can distributethe load across the paths by using multiple paths to transfer the I/O data.This function is called load balancing, and it prevents a single, heavily loadedpath from affecting the performance of the entire system.

Note that some I/O operations managed by HDLM can be distributed acrossall, available paths, and some cannot. Therefore, even when the loadbalancing function is used, a particular I/O operation might not necessarilyallocate data to every available path. RAID Manager issuing IOCTL to acommand device is an example of an I/O operation that cannot allocate datato every path.


Figure 2-7 Flow of I/O Data When the Load Balancing Function Is Not Used onpage 2-9 shows the flow of I/O data when the load balancing function isnot used. Figure 2-8 Flow of I/O Data When the Load Balancing Function IsUsed on page 2-10 shows the flow of I/O data when the load balancingfunction is used. Both figures show examples of I/O operations being issuedfor the same LU by multiple applications.

Figure 2-7 Flow of I/O Data When the Load Balancing Function Is NotUsed

When the load balancing function is not used, I/O operations converge onto asingle path (A). The load on that one path (A) will cause a bottleneck, whichmight cause problems with system performance.


Figure 2-8 Flow of I/O Data When the Load Balancing Function Is Used

When the load balancing function is used, I/O operations are distributed viamultiple paths (A, B, C, and D). This helps to prevent problems with systemperformance and helps prevent bottlenecks from occurring.

Paths to Which Load Balancing Is AppliedThis subsection describes, for each type of storage system, the paths towhich the load balancing function is applied.

When Using the Hitachi AMS/WMS Series

When HDLM performs load balancing, it differentiates between load balancingamong owner paths and among non-owner paths. An owner path is a paththat passes through the owner controller for a target LU. When you set up anLU, you have to specify which CHA to be used as the owner controller for theLU. Because different LUs might have different owner controllers, differentLUs might also have different owner paths. A non-owner path is a path thatpasses through a CHA other than the owner controller. This type of CHA isalso known as a non-owner controller. An owner path is usually used inpreference to a non-owner path. In order to prevent system performancefrom slowing down, HDLM does not perform load balancing between ownerpaths and non-owner paths. If failures occur across some of the owner paths,


load balancing will be performed among the remaining, usable owner paths.It is only when absolutely no owner paths are available, that load balancing isthen performed among the non-owner paths.

For the example in Figure 2-9 Overview of Load Balancing on page 2-11,suppose that in the owner controller of LU0 is CHA0. When the LU isaccessed, the load is balanced between the two paths A and B, which areboth owner paths. When one of the paths (A) cannot be used, then the LU isaccessed from the only other owner path (B). When both of the owner paths(A and B) cannot be used, the load is then balanced between two other, non-owner paths (C and D).

Figure 2-9 Overview of Load Balancing

When Using the Universal Storage Platform V/VM Series, Virtual StoragePlatform Series, VSP G1000 Series, Hitachi AMS2000 Series, Hitachi SMS Series,HUS100 Series, or HUS VM

All online paths are owner paths. Therefore, for the example in Figure 2-8Flow of I/O Data When the Load Balancing Function Is Used on page 2-10,the load is balanced among the four paths A, B, C, and D. If one of the pathswere to become unusable, the load would be balanced among the three,remaining paths.

Note:When using Hitachi AMS2000 series, Hitachi SMS series, or HUS100 seriesstorage, if the dynamic I/O path control function is disabled, all paths areowner paths.


When Using a Global-Active Device for the VSP G1000 Series

The default settings of the storage system specify that all paths are ownerpaths. Load balancing is performed on all paths that access the primary andsecondary volumes of global-active device pairs.

However, if the primary site and the secondary site are far apart, I/Operformance might be low for I/O issued to a site other than the location ofthe host. In such a case, specify the non-preferred path option on the storagesystem at the site where the host is not located. A path for which the non-preferred path option is specified is a non-owner path and cannot be useduntil all the owner paths become unavailable.

If you specify the non-preferred path option on the storage system when theHDLM device is already configured, execute the refresh operation of theHDLM command, or restart the host.

Load Balancing AlgorithmsThe load balancing function uses VMware vSphere PSPs or PSPs provided byHDLM. The following table lists the load balancing algorithms that HDLM canuse.

Table 2-5 Load Balancing Algorithms

Algorithm name PSP name

Extended Round Robin HTI_PSP_HDLM_EXRR

Extended Least I/Os HTI_PSP_HDLM_EXLIO

Extended Least Blocks HTI_PSP_HDLM_EXLBK

Most Recently Used (VMware) VMW_PSP_MRU

Round Robin (VMware) VMW_PSP_RR

PSPs for the Extended Round Robin, Extended Least I/Os, and ExtendedLeast Blocks algorithms are installed together with HDLM. These algorithmsdetermine which path to allocate based on whether the data of the I/O to beissued is sequential with the data of the I/O that was issued immediatelybeforehand.

If the data is sequential, the path used will be the one to which the data ofthe I/O that was issued immediately beforehand was distributed. However, ifa specified number of I/Os has been issued to a path, processing switches tothe next path.

If the data is not sequential, these algorithms select the path to be used eachtime an I/O request is issued.

• Extended Round Robin:The paths are simply selected in order from among all the connectedpaths.

• Extended Least I/Os


The path that has the least number of I/Os being processed is selectedfrom among all the connected paths.

• Extended Least BlocksThe path that has the least number of I/O blocks being processed isselected from among all the connected paths.

The default algorithm is the Extended Least I/Os algorithm, which is set whenHDLM is first installed. When an upgrade installation of HDLM is performed,the algorithm that is currently being used is inherited.

Select the load balancing algorithm most suitable for the data access patternsof your system environment. However, if there are no recognizable dataaccess patterns, we recommend using the default algorithm, the ExtendedLeast I/Os algorithm.

You can specify the load balancing function by the dlnkmgr command's setoperation. For details on the set operation, see set (Sets Up the OperatingEnvironment) on page 6-15.

Performing Failovers and Failbacks Using Path SwitchingWhen the system contains multiple paths to an LU and an error occurs on thepath that is currently being used, HDLM can switch to another functionalpath, so that the system can continue operating. This is called a failover.

If a path in which an error has occurred recovers from the error, HDLM canthen switch back to that path. This is called a failback.

Two types of failovers and failbacks are available:

• Automatic failovers and failbacks• Manual failovers and failbacks

Failovers and failbacks switch which path is being used and also change thestatuses of the paths. A path status is either online or offline. An online statusmeans that the path can receive I/Os. On the other hand, an offline statusmeans that the path cannot receive I/Os. A path will go into the offline statusfor the following reasons:

• An error occurred on the path.• A user executed the HDLM command's offline operation.

For details on the offline operation, see offline (Places Paths Offline) onpage 6-7.

For details on path statuses and the transitions of those statuses, see PathStatus Transition on page 2-17.

Automatic Path SwitchingThe following describes the automatic failover and failback functions, whichautomatically switch a path.


Automatic Failovers

If you detect an error on the path that is currently being used, you cancontinue to use the system by having the status of that path automaticallychanged to offline, and then automatically have the system switch over toanother online path. This functionality is called automatic failover. Automaticfailovers can be used for the following levels of errors:

CriticalA fatal error that might stop the system.

ErrorA high-risk error, which can be avoided by performing a failover or someother countermeasure.

For details on error levels, see Table 8-1 Format and Meaning of the MessageID KAPLnnnnn-l on page 8-2 in Format and Meaning of Message IDs onpage 8-2..

When the Hitachi AMS/WMS series is being used, HDLM will select the path tobe used next from among the various paths that access the same LU, startingwith owner paths, and then non-owner paths.

For example, in Figure 2-10 Path Switching on page 2-15, the ownercontroller of an LU is CHA0, and access to the LU is made via only one path(A). After that access path (A) is placed offline, the first choice for theswitching destination is the other path connected to CHA0 (B). If an erroralso occurs on that path (B), then the next possibility for a path comes fromone of the two paths (C or D) connected to CHA1.

When the Universal Storage Platform V/VM series, Virtual Storage Platformseries, VSP G1000 series, Hitachi AMS2000 series#, Hitachi SMS series#,HUS100 series#, or HUS VM is being used, all the paths are owner paths. Thismeans that all the paths that are accessing the same LU are possibleswitching destinations. For example, in Figure 2-10 Path Switching on page2-15, the LU is accessed using only the one path (A). However, after that pathis placed offline, the switching destination can come from any of the otherthree paths (B, C, or D).

#This storage system applies when the dynamic I/O path control function isdisabled.


Figure 2-10 Path Switching

Automatic Failbacks

When a path recovers from an error, HDLM can automatically place therecovered path back online. This function is called the automatic failbackfunction.

When using the Hitachi AMS/WMS series, HDLM will select the next path to beused first from among the online owner paths, and then from the online non-owner paths. As a result, if an owner path recovers from an error, and thenHDLM automatically places the recovered path online while a non-owner pathis in use, the path will be automatically switched over from the non-ownerpath to the owner path that just recovered from the error.

When the Universal Storage Platform V/VM series, Virtual Storage Platformseries, VSP G1000 series, Hitachi AMS2000 series#1, Hitachi SMS series#1,HUS100 series#1, or HUS VM is being used, all the paths are owner paths. Asa result, if the path that was previously used recovers from an error, andthen HDLM automatically places the recovered path online, the path that iscurrently being used will continue to be used (as opposed to switching over tothe path that was just recovered).


When an intermittent error#2 occurs in a path, automatic failback repeatedlyplaces the path offline and then online again, which can cause I/Operformance to drop. In this case, we recommend that you configureintermittent error monitoring to exclude paths with intermittent errors fromthe automatic failback process.

Automatic failback is implemented by functionality provided by VMwarevSphere ESXi, and cannot be disabled.

Intermittent error monitoring can be specified in the HDLM command's setoperation. For details on the set operation, see set (Sets Up the OperatingEnvironment) on page 6-15.

#1This storage system applies when the dynamic I/O path control function isdisabled.

#2An intermittent error means an error that occurs irregularly because ofsome reason such as a loose cable connection.

Manual Path SwitchingYou can switch the status of a path by manually placing the path online oroffline. Manually switching a path is useful, for example, when systemmaintenance needs to be done.

You can manually place a path online or offline by doing the following:

• Execute the dlnkmgr command's online or offline operation.For details on the online operation, see online (Places Paths Online) onpage 6-10. For details on the offline operation, see offline (PlacesPaths Offline) on page 6-7.

However, if there is only one online path for a particular LU, that path cannotbe manually switched offline. Also, a path with an error that has not beenrecovered from yet cannot be switched online.

HDLM uses the same algorithms to select the path that will be used next,regardless of whether automatic or manual path switching is used.

When using the Hitachi AMS/WMS series, HDLM will select the next path to beused first from among the online owner paths, and then from the online non-owner paths. When the Universal Storage Platform V/VM series, VirtualStorage Platform series, VSP G1000 series, Hitachi AMS2000 series#, HitachiSMS series#, HUS100 series#, or HUS VM is being used, all the paths thataccess the same LU as the path that is currently being used are candidatesfor the switching destination path.

Executing the online operation places the offline path online. For details onthe online operation, see online (Places Paths Online) on page 6-10. Afterthe path status is changed to online, HDLM selects the path to use in thesame way as for automatic path switching. When the Hitachi AMS/WMS seriesis being used, HDLM selects the path to use from online owner paths, and


then from online non-owner paths. When the Universal Storage PlatformV/VM series, Virtual Storage Platform series, VSP G1000 series, HitachiAMS2000 series#, Hitachi SMS series#, or HUS100 series# is being used,because all the paths are owner paths, the path to use is not switched even ifyou change the path status to online.

#This storage system applies when the dynamic I/O path control function isdisabled.

Path Status TransitionEach of the online and offline statuses described in Performing Failovers andFailbacks Using Path Switching on page 2-13 is further subdivided intoseveral statuses. The path statuses (the online path statuses and offline pathstatuses) are explained below.

The Online Path Statuses

The online path statuses are as follows:

• OnlineI/Os can be issued normally.

• Online(S)#The paths to the primary volume (P-VOL) in the HAM environment haverecovered from an error, but I/O to the P-VOL is suppressed.

• Online(D)#The paths to the primary volume (P-VOL) in an HAM environment haverecovered from an error, but I/O to the P-VOL is suppressed. If an erroroccurs in all the paths to a secondary volume (S-VOL), the status of theP-VOL paths will be automatically changed to the Online status. Tochange the status to the Online(D) status, specify the -dfha parameterfor the HDLM command's online operation.

#The status changes to this status when using HAM (High AvailabilityManager).

The Offline Path Statuses

The offline path statuses are as follows:

• Offline(C)The status in which I/O cannot be issued because the offline operationwas executed. For details on the offline operation, see offline (PlacesPaths Offline) on page 6-7.The (C) indicates the command attribute, which indicates that the pathwas placed offline by using the command.

• Offline(E)


The status indicating that an I/O could not be issued on a given path,because an error occurred on the path.The (E) in Offline(E) indicates the error attribute, which indicates that anerror occurred in the path.

Correspondence between VMware vSphere and HDLM path statuses

The following table shows the correspondence between the path statusesdisplayed by VMware vSphere and the path statuses displayed in the outputof the HDLM command's view operation.

Table 2-6 Correspondence Between VMware vSphere and HDLM PathStatuses

Path status displayed by VMwarevSphere Path status displayed by the HDLM

active, and standby Online

off Offline(C)

dead, unavailable, and perm_loss Offline(E)

Status Transitions of a Path

The following figure shows the status transitions of a path.

Figure 2-11 Path Status Transitions

Legend:


Online operation: Online operation performed by executing the dlnkmgrcommand's online operation.Offline operation: Offline operation performed by executing the dlnkmgrcommand's offline operation.

Figure 2-12 Path Status Transitions (P-VOL in HAM environment)

Legend:Online operation: Online operation performed by executing the dlnkmgrcommand's online operation.Offline operation: Offline operation performed by executing the dlnkmgrcommand's offline operation.

#1Also when an error occurs in all the paths to an S-VOL in the Online(D)status.

#2When I/O operations are processed on an S-VOL.

The last available online path for each LU cannot be placed offline byexecuting the offline operation. This ensures access to the LU. For detailson the offline operation, see offline (Places Paths Offline) on page 6-7. Apath that is recovered from an error by the automatic failback function isautomatically placed in online status.

When you are using intermittent error monitoring, the path in which theintermittent error occurred is not automatically placed online when the pathrecovers from the error. In such a case, place the path online manually.


Note:If there is a path failure immediately after a path is placed offline by usingthe dlnkmgr command, Offline(C) might change to Offline(E). If an offlineoperation was performed, wait for a fixed period of time (about 2minute), check the path status by using the dlnkmgr command, andmake sure that the status has changed to Offline(C). If it is Offline(E),retry the offline operation.

Monitoring Intermittent ErrorsAn intermittent error refers to an error that occurs irregularly because ofsomething like a loose cable. In the event of an intermittent error, automaticfailback will repeatedly occur causing I/O performance to drop. To preventthis from happening, HDLM can automatically remove the path where anintermittent error is occurring from the paths that are subject to automaticfailbacks. This process is called intermittent error monitoring.

A path in which an error occurs a specified number of times within a specifiedinterval is determined to have an intermittent error. The path where anintermittent error occurs remains in error status until the user executes theHDLM command's online operation to place the path back to online.Automatic failbacks are not performed for such paths. This status is referredto as the not subject to auto failback status.

Checking Intermittent ErrorsYou can check the paths in which intermittent errors have occurred byviewing the execution results of the HDLM command's view operation.

For details on the view operation, see view (Displays Information) on page6-23.

Setting Up Intermittent Error MonitoringWhen you set up the intermittent error monitoring function, first specifywhether to enable or disable the function. When you enable the intermittenterror monitoring function, specify the following monitoring conditions: theerror monitoring interval, and the number of times that the error needs tooccur. If you enable the intermittent error monitoring function and an erroroccurs on a particular path the specified number of times within the specifiederror monitoring interval (in minutes), then an intermittent error will occur onthe path.

You can set up intermittent error monitoring by executing the dlnkmgrcommand's set operation.

For details on how to configure intermittent error monitoring, see set (SetsUp the Operating Environment) on page 6-15.


Intermittent Error Monitoring Actions

During intermittent error monitoring, HDLM manages the history of errors#

that occurred on each path. If an error occurs on a path, HDLM counts thenumber of errors that occurred within the time period specified as the errormonitoring interval, immediately before that error occurred. If the numberreaches the specified condition, then an intermittent error will occur on thepath.

For example, if 30 is set for the error monitoring interval and 3 for thenumber of times that the error needs to occur, an intermittent error occurson the path if an error occurs three times or more within a time period from30 minutes before the error to the moment the error occurs. The path will beexcluded from automatic failbacks. A path excluded from automatic failbackhas an error status until the user executes the HDLM command's onlineoperation.

#An error means a path status transition from Online to Offline(E).

When a User Changes the Intermittent Error InformationDuring intermittent error monitoring, if a user changes any of the values setfor the intermittent error monitoring or path status, the following areinitialized: the history of errors on the paths managed by HDLM, and theinformation for the paths that were excluded from automatic failback. Thefollowing table lists the user operations that cause initialization of intermittenterror information and the target paths for initialization.

Table 2-7 User Operations That Cause Initialization of Intermittent ErrorInformation and the Target Paths for Initialization

User operation that causes initialization ofintermittent error information

Paths for whichintermittent error

information is initialized

Disabling the intermittent error monitoring function (off) All paths

Re-enabling the intermittent error monitoring function(on)

(No change in the setting values)

Changing the error monitoring interval or the nubmer oftimes that the error needs to occur

Changing the path to the blocked state (Offline(C)) The paths for which thestates have been changed

Changing the path to the active state (Online)

Restarting the host All paths

When intermittent error monitoring is enabled, if the intermittent errorinformation is initialized, monitoring starts again from that moment. To setthe paths that have been excluded from automatic failback to stay excluded,


change the paths to the blocked state (Offline(C)) before you change theintermittent error monitoring setting.

You can check whether intermittent error monitoring is being performed for apath, by executing the HDLM command's view -path operation with the -iemparameter specified, and then checking the displayed IEP item. If a numericalvalue of 0 or greater is displayed for this item, intermittent error monitoringis being performed on the path.

For details about the view operation, see view (Displays Information) on page6-23.

Detecting Errors by Using Path Health CheckingHDLM can check the status of paths for which I/O operations are not beingperformed and detect errors. This function is called path health checking.

The path health check function periodically checks the status of online pathsregardless of whether any I/O activity is occurring. If an error is detected in apath, the path health checking function switches the status of that path toOffline(E). You can use the dlnkmgr command's view operation to checkthe path error.

The health check function is implemented by functionality provided byVMware vSphere ESXi. You cannot disable the health check function orchange the interval between checks.

Distributing a Load by Using the Dynamic I/O Path ControlFunction

The result of using HDLM load balancing to distribute a load can be improved,by applying the HDLM dynamic I/O path control function to the storagesystem in which the dynamic load balance control function is installed.

What is the Dynamic Load Balance Control FunctionIn a system configuration in which multiple hosts and a storage system areconnected, the I/O processing load tends to concentrate on the controller ofthe storage system, causing throughput performance of the entire systemdecrease. The dynamic load balance controller function evaluates such loadstatuses on the controller and prevents storage system performance fromdecreasing.

The following is a list of the storage systems that provide the dynamic loadbalance controller function and are supported by HDLM.

• Hitachi AMS2000 series#

• Hitachi SMS series#

• HUS100 series


#For using the dynamic load balance controller function there arerestrictions on the versions of the microprograms you install. For details,see the release notes of HDLM.

Dynamic I/O Path Control FunctionIn a storage system in which the dynamic load balance controller function isinstalled, enable the dynamic I/O path control function to make the HDLMload balancing effective.

When the dynamic I/O path control function is enabled, the controllerselected by the dynamic load balance controller function is recognized as theowner controller. Other controllers are recognized as non-owner controllers.

The dynamic I/O path control function can be enabled or disabled based oneach host, connected storage system, or LU.

The dynamic I/O path control function can be specified by using the HDLMcommand's set operation. For details about the set operation, see set (SetsUp the Operating Environment) on page 6-15.

Error ManagementFor troubleshooting purposes, HDLM collects information and stores it into logfiles. The following figure shows the flow of data when error information iscollected on a host which is running HDLM.


Figure 2-13 Flow of Data When Path Error Information Is Collected

Logs might be collected in layers below HDLM, such as for the SCSI driver.For more details, see the VMware vSphere documentation.

Types of Collected LogsHDLM collects information about errors that occurred on ESXi hosts and on aremote management client.

• Log data for errors that occurred on the ESXi host is output to syslog onthe ESXi host, This log data corresponds to I/O errors and to changes inpath status.

• Log data for errors that occurred on a remote management client isoutput as remote management client error log data.

You can use this error information to examine the error status and analyzethe error cause.

The following table shows the error information for an ESXi host.


Table 2-8 Types of ESXi Host Error Information

Log name Description Output destination

Syslog Information about detected errors iscollected.

The default file pathis /var/log/vmkernel.log.For details on how to set thesyslog file path, refer to theVMware vSphere documentation.

For details on how to change the collection level, see Table 8-1 Format andMeaning of the Message ID KAPLnnnnn-l on page 8-2 in Format andMeaning of Message IDs on page 8-2.

The following table shows the error information for remote managementclients.

Table 2-9 Types of Remote Management Client Error Information

Log name Description Output destination

Integrated tracefile

This log collects operationlog data of the HDLMcommand.

The default file name isprogram-installation-drive:\ProgramFiles#1\HITACHI\HNTRLib2\spool\hntr2n.log (where n is a file number)

To specify the output destination folderand the file prefix for the integrated tracefile, use the Hitachi Network ObjectplazaTrace Library (HNTRLib2) utility.

Trace file This log collects traceinformation on the HDLMmanager at a user-specified level. If an erroroccurs, you might need tochange the settings andcollect trace information.

The trace file name is\Program Files\HITACHI\DynamicLinkManager\log\hdlmtr[1-64].log#2

Error log This log collects informationabout errors that occurredwhile HDLM was linked withGlobal Link Manager.

HDLM manager logs\Program Files\HITACHI\DynamicLinkManager\log\dlmmgr[1-16].log#2

Hitachi Command Suite Common AgentComponent logs

\Program Files\HITACHI\DynamicLinkManager\log\dlmwebagent[1-N].log#2

The value N depends on the settingin the dlmwebagent.properties file.

Event log This log collects audit logdata.

Event logs (application logs)

#1


In Windows Server 2003 (excluding the x86 edition) and Windows Server2008 (excluding the x86 edition), Program Files is Program Files(x86).

#2The underlined part indicates a folder specified during installation.After obtaining these files, be sure to also copy them to a backuplocation.

Collecting Error InformationYou need to collect HDLM error information both from the ESXi host and fromremote management clients. Note that, if syslog transfer is set up in the ESXihost, you need to collect syslog from the transfer destination.

Collecting from the ESXi hostYou can collect ESXi host log information by either of the followingmethods:

¢ Using a vSphere client, export the system logs.Use the default setting for specifying the sources to be collected.

¢ Log in to the ESXi host and execute the vm-support command tocollect the system logs.

Also, if a kernel panic occurs on the ESXi host, collect a core dump forinvestigation.

Collecting from the remote management clientHDLM provides the utility for collecting HDLM error information(DLMgetras).By using the DLMgetras utility, you can simultaneously collect all theinformation required for analyzing errors: information such as integratedtrace files, definition files, and information on the OS. You can use thecollected information for when you contact your HDLM vendor ormaintenance company.

For details on the DLMgetras utility, see The DLMgetras Utility for CollectingHDLM Error Information on page 7-2.

Collecting Audit Log DataHDLM and other Hitachi storage-related products provide an audit logfunction so that compliance with regulations, security evaluation standards,and industry-specific standards can be shown to auditors and evaluators. Thefollowing table describes the categories of audit log data that Hitachi storage-related products can collect.


Table 2-10 Categories of Audit Log Data That Can Be Collected

Category Explanation

StartStop An event indicating the startup or termination of hardwareor software, including:• OS startup and termination• Startup and termination of hardware components

(including micro-program)• Startup and termination of software running on storage

systems, software running on SVPs (serviceprocessors), and Hitachi Command Suite products

Failure An abnormal hardware or software event, including:• Hardware errors• Software errors (such as memory errors)

LinkStatus An event indicating the linkage status between devices:• Link up or link down

ExternalService An event indicating the result of communication between aHitachi storage-related product and an external service,including:• Communication with a RADIUS server, LDAP server,

NTP server, or DNS server,• Communication with the management server (SNMP)

Authentication An event indicating that a connection or authenticationattempt made by a device, administrator, or end-user hassucceeded or failed, including:• FC login• Device authentication (FC-SP authentication, iSCSI

login authentication, or SSL server/clientauthentication)

• Administrator or end-user authentication

AccessControl An event indicating that a resource access attempt made bya device, administrator, or end-user has succeeded orfailed, including:• Device access control• Administrator or end-user access control

ContentAccess An event indicating that an attempt to access critical datahas succeeded or failed, including:• Access to a critical file on a NAS or content access when

HTTP is supported• Access to the audit log file

ConfigurationAccess An event indicating that a permitted operation performed bythe administrator has terminated normally or failed,including:• Viewing or updating configuration information• Updating account settings, such as adding and deleting

accounts• Setting up security


Category Explanation

• Viewing or updating audit log settings

Maintenance An event indicating that a maintenance operation hasterminated normally or failed, including:• Adding or removing hardware components• Adding or removing software components

AnomalyEvent An event indicating an abnormal state such as exceeding athreshold, including:• Exceeding a network traffic threshold• Exceeding a CPU load threshold• Reporting that the temporary audit log data saved

internally is close to its maximum size limit or that theaudit log files have wrapped back around to thebeginning

An event indicating an occurrence of abnormalcommunication, including:• A SYN flood attack or protocol violation for a normally

used port• Access to an unused port (such as port scanning)

The categories of audit log data that can be collected differ depending on theproduct. The following sections explain only the categories of audit log datathat can be collected by HDLM. For the categories of audit log data that canbe collected by a product other than HDLM, see the corresponding productmanual.

Categories and Audit Events that HDLM Can Output to the Audit LogThe following table lists and explains the categories and audit events thatHDLM can output to the audit log. The severity is also indicated for each auditevent.

Table 2-11 Categories and Audit Events that Can Be Output to the AuditLog

Category Explanation Audit eventSeverity

#1 Message ID

StartStop Startup andtermination ofthe software

Startup of theHDLM managerwas successful.

6 KAPL15401-I

Startup of theHDLM managerfailed.

4 KAPL15402-W

The HDLMmanager stopped.

6 KAPL15403-I

Startup of theDLMgetras utility

6 KAPL15060-I



#1 Message ID

Termination ofthe DLMgetrasutility#2

6 KAPL15061-I

Authentication Administrator orend-userauthentication

Permission hasnot been grantedto execute theHDLM command.

4 KAPL15111-W

Permission hasnot been grantedto start or stopthe HDLMmanager.

4 KAPL15404-W

ConfigurationAccess Viewing orupdatingconfigurationinformation

Initialization ofpath statisticswas successful.

6 KAPL15101-I

Initialization ofpath statisticsfailed.

4 KAPL15102-W

An attempt toplace a pathonline or offlinewas successful.

6 KAPL15103-I

An attempt toplace a pathonline or offlinefailed.

4 KAPL15104-W

Setup of theoperatingenvironment wassuccessful.

6 KAPL15105-I

Setup of theoperatingenvironmentfailed.

4 KAPL15106-W

An attempt todisplay programinformation wassuccessful.

6 KAPL15107-I

An attempt todisplay programinformation failed.

4 KAPL15108-W

An attempt todisplay HDLMmanagement-target informationwas successful.

6 KAPL15109-I



#1 Message ID

An attempt todisplay HDLMmanagement-target informationfailed.

4 KAPL15110-W

The status of apath wassuccessfullychanged toOnline.

6 KAPL15116-I

The refreshoperation wassuccessful.

6 KAPL15121-I

The refreshoperation failed.

4 KAPL15122-W

#1The severity levels are as follows:4: Warning, 6: Information

#2If you use Ctrl + C to cancel the DLMgetras utility for collecting HDLMerror information, audit log data indicating that the DLMgetras utility hasterminated will not be output.

Requirements for Outputting Audit Log DataHDLM can output audit log data when all of the following conditions aresatisfied:

• The Event Log service is running on the remote management client.• The output of audit log data has been enabled by using the HDLM

command's set operation.

However, audit log data might still be output regardless of the aboveconditions if, for example, an HDLM utility is executed from external media.#

#:The following audit log data is output:

¢ Categories: StartStop, Authentication, and ConfigurationAccess¢ Severity: 6 (Error, Warning, or Information)

Notes:

¢ You might need to perform operations such as changing the log sizeand backing up and saving collected log data, because the amount ofaudit log data might be quite large.


Destination and Filtering of Audit Log DataAudit log data is output to event logs of the remote management client.

You can also filter the audit log output by specifying a severity level and typefor the HDLM command's set operation.

Filtering by severity:The following table lists the severity levels that can be specified.

Table 2-12 Severity Levels That Can Be Specified

Severity Audit log data to output Correspondence with eventlog type

0 Error Error

1

2

3

4 Error and Warning Warning

5

6 Error, Warning, and Information Information

7

Filtering by category:The following categories can be specified:

¢ StartStop¢ Authentication¢ ConfigurationAccess¢ All of the above

For details on how to specify audit log settings, see Setting Up the HDLMFunctions on page 3-17.

Audit Log Data FormatsThe following describes the format of audit log data:

The following is the format of audit log data. This data can be viewed in theDescription box of the Event Properties dialog box, which is opened whenan event is double-clicked in the Application Log list of the Event Vieweradministrative tool on the remote management client:

program-name [process-ID]: message-section

The following shows the format of message-section and explains its contents.

The format of message-section:


common-identifier,common-specification-revision-number,serial-number,message-ID,date-and-time,entity-affected,location-affected,audit-event-type,audit-event-result,subject-ID-for-audit-event-result,hardware-identification-information,location-information,location-identification-information,FQDN,redundancy-identification-information,agent-information,host-sending-request,port-number-sending-request,host-receiving-request,port-number-receiving-request,common-operation-ID,log-type-information,application-identification-information,reserved-area,message-text

Up to 950 bytes of text can be displayed for each message-section.

Table 2-13 Items Output in the Message Section

Item# Explanation

Common identifier Fixed to CELFSS

Common specificationrevision number

Fixed to 1.1

Serial number Serial number of the audit log message

Message ID Message ID in KAPL15nnn-l format

Date and time The date and time when the message was output. This item isoutput in the following format:yyyy-mm-ddThh:mm:ss.s time-zone

Entity affected Component or process name

Location affected Host name

Audit event type Event type

Audit event result Event result

Subject ID for auditevent result

Depending on the event, an account ID, process ID, or IPaddress is output.

Hardware identificationinformation

Hardware model name or serial number

Location information Hardware component identification information

Location identificationinformation

Location identification information

FQDN Fully qualified domain name

Redundancyidentificationinformation

Redundancy identification information

Agent information Agent information

Host sending request Name of the host sending a request

Port number sendingrequest

Number of the port sending a request

Host receiving request Name of the host receiving a request


Item# Explanation

Port number receivingrequest

Number of the port receiving a request

Common operation ID Operation serial number in the program

Log type information Fixed to BasicLog

Applicationidentificationinformation

Program identification information

Reserved area This field is reserved. No data is output here.

Message text Data related to the audit event is output.

#: The output of this item depends on the audit event.

Example of the message section for the audit event An attempt to displayHDLM management-target information was successful:

CELFSS,1.1,0,KAPL15109-I,2008-04-09T10:18:40.6+09:00,HDLMCommand,hostname=moon,ConfigurationAccess,Success,uid=root,,,,,,,,,,,,,,,"Information aboutHDLM-management targets was successfully displayed. CommandLine = dlnkmgr view -path "

Integrated HDLM management using Global Link ManagerBy using Global Link Manager, you can perform integrated path managementon systems running multiple instances of HDLM.

For large-scale system configurations using many hosts running HDLM, theoperational load for managing paths on individual hosts increases with thesize of the configuration. By linking HDLM and Global Link Manager, you cancentrally manage path information for multiple instances of HDLM and reduceoperational load. In addition, you can switch the operational status of pathsto perform system-wide load balancing, and centrally manage the system bycollecting HDLM failure information in Global Link Manager.

Global Link Manager collects and manages information about paths frominstances of HDLM installed on multiple hosts. Even if multiple users managethese hosts, they can control and view this centralized information from clientcomputers.

Note:You cannot manage a single HDLM host from multiple Global LinkManager servers. In addition, a single remote management client cannotbe shared by multiple Global Link Manager servers.

The following figure is an example of a system configuration using HDLM andGlobal Link Manager.


Figure 2-14 Example System Configuration Using HDLM and Global LinkManager


3Creating an HDLM Environment

This chapter explains how to set up an HDLM environment and also how toerase environment settings.

Make sure that you have already installed HDLM and configured the functionsettings.

□ HDLM System Requirements

□ Flow for Creating an HDLM Environment

□ HDLM Installation Types

□ Notes on Creating an HDLM Environment

□ Installing HDLM

□ Checking the Path Configuration

□ Setting Up HDLM

□ Setting Up Integrated Traces

□ Removing HDLM

Creating an HDLM Environment 3-1Hitachi Dynamic Link Manager (for VMware®) User Guide

HDLM System RequirementsCheck the following before installing HDLM:

For the requirements for using HDLM in an HAM environment, see the releasenotes of HDLM.

Hosts and OSs Supported by HDLMHDLM can be installed on computers running the following operating systems:

Host OS support

The following versions of VMware vSphere ESXi are supported as an OS forhost computers:

• VMware vSphere ESXi 5.0 Enterprise Edition/Enterprise Plus Edition• VMware vSphere ESXi 5.0 Update 1 Enterprise Edition/ Enterprise Plus

Edition• VMware vSphere ESXi 5.0 Update 2 Enterprise Edition/ Enterprise Plus


Edition• VMware vSphere ESXi 5.1 Enterprise Edition/ Enterprise Plus Edition• VMware vSphere ESXi 5.1 Update 1 Enterprise Edition/ Enterprise Plus


Edition• VMware vSphere ESXi 5.5 Enterprise Edition/ Enterprise Plus Edition• VMware vSphere ESXi 5.5 Update 1 Enterprise Edition/ Enterprise Plus


Edition

Remote management client OS support

The following table lists the operating systems that can run on a remotemanagement client.

Table 3-1 OS Support for Remote Management Clients

OS Service pack

Windows 7(x86) No service pack, or SP1

Windows 7(x64) No service pack, or SP1

Windows Server 2008(x64) No service pack, or SP2

Windows Server 2008 R2(x64) SP1

Windows Vista Enterprise(x86) SP1

3-2 Creating an HDLM EnvironmentHitachi Dynamic Link Manager (for VMware®) User Guide

OS Service pack

Windows Vista Enterprise(x64) SP1

Note:In this manual, Windows running on a 32-bit processor is referred to asx86, and Windows running on a 64-bit processor is referred to as x64.

A remote management client can run on a machine in the same LAN as thehost, or on a guest OS installed on the host itself.

VMware vSphere CLI 5.0/5.1/5.5 is a prerequisite program for a remotemanagement client. Make sure that VMware vSphere CLI is installed beforeinstalling HDLM.

JRE used when linking with Global Link Manager

When HDLM is linked with Global Link Manager, use the JRE that comes withHDLM. If either of the JRE versions listed in the table below is installed on thehost, you can also use that JRE version. To use the JRE version installed onthe host, see the Hitachi Command Suite Global Link Manager Installationand Configuration Guide.

Table 3-2 Global Link Manager

OS JRE

Windows 7(x86)Windows 7(x64)

JRE 1.8.0(32bit)

Windows Server 2008 R2(x64) JRE 1.8.0(32bit)

Windows Vista(x64) JRE 1.8.0(32bit)

Storage Systems Supported by HDLMHDLM supports the following storage systems:

If an FC-SAN is used:

• Hitachi AMS2000/AMS/WMS/SMS series• Hitachi Universal Storage Platform V• Hitachi Universal Storage Platform VM• Hitachi Virtual Storage Platform• Hitachi Virtual Storage Platform G1000• HUS100 series• HUS VM• HP StorageWorks P9500 Disk Array• HP XP7 Storage


• XP20000/XP24000

If an IP-SAN is used:

• Hitachi AMS2000/AMS/WMS/SMS series

The supported storage systems require a dual controller configuration. If youuse the system in a HUB environment, you must set a unique loop ID forevery connected host and storage system. For details about the micro-program versions for using HDLM, see the HDLM Release Notes. For detailsabout storage system settings required for using HDLM, see the maintenancedocumentation for storage systems.

Memory and Disk Capacity RequirementsThis section describes memory and disk capacity requirements.

Memory Requirements

The memory requirements for a host and remote management client are asfollows:

• Host10 MB

• Remote management client40 MB

Disk Requirements

The disk space requirements for hosts and remote management clients are asfollows:

• Host600KB

• Remote management client175 MB

Number of LUs and Paths That Are Supported in HDLMThe following table lists the number of LUs and paths that are supported byHDLM.

Table 3-3 Number of LUs and Paths That Are Supported by HDLM

Item Number supported

Number of LUs 1 to 256

Number of paths per LU 1 to 32

Total number of paths 1 to 1024


Flow for Creating an HDLM EnvironmentSet up the environment to use HDLM as follows.

Figure 3-1 Flow of HDLM Environment Setup

HDLM Installation TypesThis subsection describes the following types of HDLM installation: newinstallation, upgrade installation, and re-installation.

New installation of HDLM:Installing HDLM on a server on which HDLM has not been installed iscalled a new installation of HDLM.

Upgrade installation of HDLM:Installing a newer version of HDLM over the existing version withoutremoving the existing version is called an upgrade installation of HDLM.

Re-installation of HDLM:A re-installation of HDLM involves installing the same version of HDLMagain to repair an existing installation. You must remove HDLM before re-installing it.

Notes on Creating an HDLM EnvironmentThis section provides notes on creating an HDLM environment.

• Make sure that all HBAs that are on a single host and connected to HDLM-managed disks are of the same type and have the same microprogramversion. If you are using more than one type of HBA, paths will not beable to be switched when an error occurs.

• If the Windows version of HDLM is already installed on the machine that isto serve as the remote management client, remove it before proceeding.The VMware and Windows versions of HDLM cannot coexist on the sameremote management client.


• If you install HDLM for the first time, or perform an upgrade installation ofHDLM after the license has expired, a license key is necessary. To updatethe HDLM license, execute the dlnkmgr command's set-lic operation.The expiration date of the license key is determined by the license keyspecified in the license key file or the input license key type. Forinformation on license key types and the set operation, see set (Sets Upthe Operating Environment) on page 6-15 .

• Terminate all programs that are running before installing HDLM.• HDLM uses the Windows Installer service. Therefore, when you install

HDLM, take the following precautions:

¢ In the Startup Type setting for the Windows Installer service, specifyManual or Automatic.

¢ Before installing HDLM, make sure that no other programs are usingthe Windows Installer service.

¢ By using the auto deploy function, a VMware vCenter Server supporttool, you can specify an image file to which HDLM plugins areinstalled.To use the auto deploy function to change the HDLM settings on theOS for which provisioning is performed, you need to perform thefollowing operations:

• Execute the dlnkmgr command from the remote managementclient.

• At the auto deploy server, apply the host profile of the relevanthost.

Unless you apply the host profile, HDLM setting changes will not besaved when the host restarts.

If you install HDLM while the Startup Type setting for the WindowsInstaller service is disabled or while another program is using theWindows Installer service, the installation might fail.If this problem occurs, make sure that both of the above conditions aresatisfied, and then install HDLM again.Be aware that even though an upgrade or re-installation of HDLM failed,the Add/Remove Programs window might indicate that HDLM has beeninstalled normally.

• In Windows 7 (x64) , Windows Server 2008, and Windows Vista (x64), werecommend that you install HDLM in a folder other than Program Files.

• Notes on Linking with Global Link Manager

¢ Do not register a single HDLM host on two or more Global LinkManager servers. In addition, do not share a single remotemanagement client from multiple Global Link Manager servers.

¢ On the remote management client, to add the VMware vSphere CLIenvironment variables perlpath and vclipath to the systemenvironment variables, add the paths specified for perlpath andvclipath to the system environment variable Path as well. Whenadding a variable to Path, do not enclose the path in double quotation


marks ("). If you enclose the variable in double quotation marks ("),operations performed from Global Link Manager might fail.

Installing HDLMFirst, check whether HDLM has already been installed on the host and remotemanagement client where you are going to install HDLM. If HDLM has alreadybeen installed, follow the procedure described in Performing an UpgradeInstallation of HDLM on page 3-11 or Performing a Re-installation of HDLMon page 3-12.

When you install HDLM, Hitachi Network Objectplaza Trace Library will also beinstalled.

The file path of the Hitachi Network Objectplaza Trace Library integratedtrace information file is program-installation-destination-drive:\ProgramFiles#\HITACHI\HNTRLib2\spool\Hntr2n.log, where n is the number of theintegrated trace information file.

#For Windows 7 (x64) , Windows Server 2008, and Windows Vista (x64),Program Files is Program Files (x86).

Performing a New Installation of HDLMThe following describes how to perform a new installation of HDLM. Performthe installation process on the remote management client and the host.

The installation procedure described here assumes that VMware vSphere hasbeen installed on the host, and the host and the storage system areconnected in a multi-path configuration.

When performing a new installation on a remote management client, you canperform an unattended installation by using the HDLM install utility(installhdlm). An unattended installation enables a user to install HDLMwithout entering information during processing. For details on theinstallhdlm utility, see The installhdlm Utility for Installing HDLM on page7-8.

To manually perform an installation on the remote management client, followthe procedure in New installation on remote management client on page3-7. To perform an unattended installation, follow the procedure inUnattended installation on remote management client on page 3-8.

New installation on remote management client

1. Log on to Windows on the remote management client as a member of theAdministrators group.

2. Save the license key file directly under the drive on which Windows isinstalled.


installation-drive:\hdlm_license

3. Insert the HDLM installation DVD-ROM.4. In the displayed window, click the Install button next to for VMware in

Hitachi Dynamic Link Manager.If the window is not displayed, directly execute the installer (setup.exe).The installer is stored in drive-containing-installation-DVD-ROM:\HDLMVMware.Windows 7, Windows Server 2008, and Windows Vista support UserAccount Control (UAC). Therefore, if you execute the installer as a userother than Administrator, you might be asked for administratorpermissions. If you are asked for administrator permissions, respond tothe displayed dialog box.

5. Follow the instructions shown in the messages that appear in the window.

¢ If a license key file was saved in step 2, specify that license key file.¢ If a license key file is not being used, specify the license key directly.

6. Follow the instructions shown in the messages that appear in the window.7. When the installation finishes, restart the remote management client.8. Log on to Windows on the remote management client as a member of the

Administrators group.9. Start the command prompt for VMware vSphere CLI as an administrator.10. Execute the HDLM command's view operation to confirm that HDLM has

been installed.An example of executing the dlnkmgr command's view operation is asfollows: PROMPT>dlnkmgr -l view -sysHDLM Version : x.x.x-xxService Pack Version : HDLM Manager Ver WakeupTimeAlive x.x.x-xx yyyy/mm/dd hh:mm:ssLicense Type ExpirationPermanent -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> If x.x.x-xx is displayed in HDLM Version, the correct version of HDLM hasbeen installed.

Having installed HDLM on the remote management client, go to Newinstallation on host on page 3-10.

Unattended installation on remote management client

Notes on unattended installations


¢ Do not forcibly stop the execution of the installhdlm utility during anunattended installation of HDLM. Even if you forcibly stop theexecution of the installhdlm utility, the HDLM installation will not bestopped. Make sure that you check the results of the installation ininstallhdlm.log, if you had to forcibly stop the execution of theinstallhdlm utility.

¢ The disk capacity necessary for the execution of the installhdlmutility is as follows:A folder specified in the workdir key (if the workdir key has not beenspecified, a folder specified in the TMP or TEMP environment variable)must have at least 20 KB of free disk capacity.


2. Insert the HDLM installation DVD-ROM.3. Create an installation information settings file.

For an installation-information settings file, you need to define the licensekey file name, installation destination folder, and then any otherinformation that is required for the particular installation.HDLM provides a sample file in order to simplify the editing process of aninstallation-information settings file. The sample file is stored in thefollowing location: drive-containing-installation-DVD-ROM:\HDLM_VMware\DLMTools\sample_installhdlm.ini To use the sample file, copy it from the DVD-ROM into any folder, andthen use a text editor to edit it.Items that need to be defined in the installation-information settings fileare described in Contents of an Installation-Information Settings File onpage 7-9 below.

4. Launch the Administrator: Command Prompt window.5. Execute the following command to perform an unattended installation.

drive-containing-installation-DVD-ROM:\HDLM_VMware\DLMTools\installhdlm -f installation-information-settings-file

6. Check the results of the installation.At the command prompt, check the unattended installation resultsdisplayed by the installhdlm utility.

7. Restart the remote management client.8. Log on to Windows on the remote management client as a member of the

Administrators group.9. Start the command prompt for VMware vSphere CLI as an administrator.10. Execute the HDLM command's view operation to confirm that HDLM has

been installed.


An example of executing the dlnkmgr command's view operation is asfollows: PROMPT>dlnkmgr -l view -sysHDLM Version : x.x.x-xxService Pack Version : HDLM Manager Ver WakeupTimeAlive x.x.x-xx yyyy/mm/dd hh:mm:ssLicense Type ExpirationPermanent -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> If x.x.x-xx is displayed in HDLM Version, the correct version of HDLM hasbeen installed.

When the unattended installation on the remote management client finishes,go to New installation on host on page 3-10.

New installation on host

The VMware vSphere CLI is used to install HDLM on a host. If the VMwarevSphere CLI is not installed on the remote management client, install it andconfirm that it can be used to connect to the host before continuing.

In addition, see the HDLM Release Notes beforehand to check offline bundlefile names and plugin names.

1. Copy all the offline bundle files stored in the remote management clientto a directory on the host.Offline bundle files are stored in the following location on the remotemanagement client. HDLM-installation-folder\plugin

2. Start the VMware vSphere CLI on the remote management client.3. Change the host acceptance level.

Execute the following command to check the current acceptance level ofthe host: esxcli --server=host-name --username=user-name --password=password software acceptance get Save the command output. You will need it if you remove HDLM in thefuture.After saving the command output, execute the following command tochange the host acceptance level: esxcli --server=host-name --username=user-name --password=password software acceptance set --level=PartnerSupported


4. Install HDLM on the host.Execute the following command. In the -d parameter, specify the name ofan offline bundle file you copied in step 1.Repeat this command for each offline bundle file you copied in step 1. esxcli --server=host-name --username=user-name --password=password software vib install -d /any-directory-on-the-host/online-bundle-file-name When the installation process has completed, execute the followingcommand and make sure that the plugin name appears in the commandoutput: esxcli --server=host-name --username=user-name --password=password software vib list | findstr hdlm

5. Restart the host.6. Make sure that the SATP claim rule for HDLM has been applied.

¢ Execute the following command, and make sure that the claim ruleappears in the command output: esxcli --server=host-name --username=user-name --password=password storage nmp satp rule list | findstr HTI_SATP_HDLM

¢ If the claim rule does not appear, execute the following commandsand register the claim rule. After the registration, go back to step 5and resume the operation.

esxcli --server=host-name --username=user-name --password=password storage nmp satp rule add -V HITACHI -M "^DF600F*" -s HTI_SATP_HDLMesxcli --server=host-name --username=user-name --password=password storage nmp satp rule add -V HITACHI -M "^OPEN-*" -s HTI_SATP_HDLMesxcli --server=host-name --username=user-name --password=password storage nmp satp rule add -V HP -M "^OPEN-*" -s HTI_SATP_HDLM

7. Check the path configuration according to the procedure described inChecking the Path Configuration on page 3-15.

8. If you are managing HDLM by using Global Link Manager, set up the hostand remote management client by following the procedure described inSettings When Managing HDLM by Using Global Link Manager on page3-12.

Performing an Upgrade Installation of HDLMThe procedure for an upgrade installation of HDLM is the same as for a newinstallation.From the following, use the procedure that matches theinstallation destination:


You can use VMware vSphere Update Manager.

• Remote management clientFor details, see New installation on remote management client on page3-7 in Performing a New Installation of HDLM on page 3-7.However, the operations in step 2 and step 5 are not necessary.

• HostFor details, see New installation on host on page 3-10 in Performing aNew Installation of HDLM on page 3-7.By using an HDLM offline bundle file as a VMware vSphere UpdateManager patch, you can upgrade HDLM.Apply the offline bundle file to the host as a patch by using VMwarevSphere Update Manager, and then perform steps 5 to the end of theprocedure described in New installation on host on page 3-10 ofPerforming a New Installation of HDLM on page 3-7 .

Performing a Re-installation of HDLMBefore you can re-install HDLM, you must remove the existing installation.

To re-install HDLM:

1. Prepare for HDLM removal by following the directions in Preparations forHDLM Removal on page 3-23.

2. Remove HDLM from the host and remote management client by followingthe directions in Removing HDLM on page 3-23.

3. Install HDLM on the remote management client and the host by followingthe directions in Performing a New Installation of HDLM on page 3-7.

Settings When Managing HDLM by Using Global Link ManagerWhen managing HDLM by using Global Link Manager, the following setuptasks need to be performed for the host and remote management client:

Host settings

• Create a user account.

Remote management client settings

• Add the host to the Credential Store file.• Execute the utility for configuring HDLM remote management client

environments (dlmrmcenv).• Specify Windows Firewall settings.

Creating a user account

A user account used for performing operations on the host from the remotemanagement client needs to be created on the host.


Use either of the choices below for the user account name. If you useGLMUser, you can omit the user account name when executing the dlmrmcenvutility.

• GLMUser• Any user account name

Set the role of the created user account to Administrator.

If multiple hosts are being managed, create the same user account for allhosts.

For details on how to create a user account, see the manual for VMwarevSphere.

NotesWhen managing HDLM by using Global Link Manager, the followingrestrictions apply:

¢ Only one user account can be used by one remote managementclient.If a host is managed by using multiple user accounts, you mustprepare as many user accounts as the number of remotemanagement clients.

¢ The configuration in which one host is managed from multiplemanagement clients is not supported.

Adding the host to the Credential Store file

Add the IP address of the host# and the user account created on the host asdescribed in Creating a user account on page 3-12 to the Credential Storefile.

#Use the IP address to add the host.In addition, if you add the host by specifying the host name from GlobalLink Manager, configure the settings so that the host name of the ESXihost on the remote management client can be resolved to the IP address.

The Credential Store file stores the host information (host name, user name,and password) that is managed by VMware vSphere CLI.

The default storage location of the Credential Store is as follows:%APPDATA%\VMware\credstore\vicredentials.xmlTo add a host to the Credential Store file, execute the VMware vSphere CLIscript (credstore_admin.pl).

Executing the dlmrmcenv utility

The dlmrmcenv utility registers the user account created in Creating a useraccount on page 3-12 into the remote management client.

To execute the utility:



2. Start the VMware vSphere CLI.3. From the VMware vSphere CLI, execute the dlmrmcenv utility.

dlmrmcenv [--username "user-account-name"] [--credstore "Credential-Store-file-path"] If the name of the user account created in Creating a user account onpage 3-12 is GLMUser, you can omit the --username parameter.If the Credential Store file is stored in the default folder, you can omit the--credstore parameter.

4. Check that the KAPL20907-I message is displayed, indicating that theutility ended successfully.

Specify Windows Firewall settings

If Windows Firewall is enabled on the remote management client, thefollowing ports used by Hitachi Command Suite Common Agent Componentmust be registered in the Windows Firewall exceptions list:

• Port set for the server.agent.port property (default: 24041/tcp)• Port set for the server.http.port property (default: 24042/tcp)• Port set for the server.http.localPort property (default: 24043/tcp)

For details about the ports used by the Hitachi Command Suite CommonAgent Component, see the manual Hitachi Command Suite Global LinkManager Installation and Configuration Guide.

To add the ports to the exceptions list:

1. Launch the Administrator: Command Prompt window.2. Execute the firewall_setup command.3. Check the displayed message to make sure that the command was

executed successfully.The command ended successfully.

firewall_setup command syntax

The firewall_setup command registers ports used by Hitachi CommandSuite Common Agent Component into the exceptions list of Windows Firewallrunning on the remote management client.

The firewall_setup command is stored in the following location, dependingon whether the Device Manager agent is installed.

• Device Manager agent is installed: program-installation-destination-drive:\Program Files#\Hitachi\HDVM\HBaseAgent\bin\firewall_setup.bat


• Device Manager agent is not installed: program-installation-destination-drive:\Program Files#\HDVM\HBaseAgent\bin\firewall_setup.bat


The following table describes the firewall_setup command syntax.

Table 3-4 firewall_setup command syntax

Item Details

Synopsis firewall_setup {-set|-unset}

Description Registers the ports used by Hitachi Command Suite Common AgentComponent into the Windows Firewall exceptions list.• Port set for the server.agent.port property (default: 24041/

tcp)• Port set for the server.http.port property (default: 24042/

tcp)• Port set for the server.http.localPort property (default:

24043/tcp)When executing the command, log on as a member of theAdministrators group and execute the command from theAdministrator: Command Prompt window.

Options -setAdds firewall exceptions.

-unsetRemoves firewall exceptions.

Note:The folder that stores the Hitachi Command Suite Common AgentComponent commands is automatically added to the PATH environmentvariable of the remote management client. So, when executing thecommand, there is no need to move the current folder to the folderstoring the command.

Checking the Path ConfigurationHDLM functions, such as load balancing and failover, are only available forHDLM management-target devices that have more than one active path. Afteryou install HDLM or change the hardware configuration, check the structureand statuses of the paths.

You can use the HDLM command's view operation from the remotemanagement client to check path information.


The following describes how to check path information by using the dlnkmgrcommand's view operation. For details about the view operation, see view(Displays Information) on page 6-23.

1. Execute the following command: dlnkmgr -s host-name -u user-name -p password view -path > redirect-destination-file

2. Open redirect-destination-file and check the following:

¢ Make sure that there is at least one LU being accessed by a path.A path can be identified by PathName. The LU that is accessed by apath can be identified by both DskName and iLU.

¢ Make sure that all the paths are online.Make sure that PathStatus is Online. If a path is not online, Reducedwill be displayed.

¢ Make sure that for each path the combination of the CHA port(ChaPort), through which multiple paths are accessing the same LU,and the HBA port (the host port number and bus number displayed inthe PathName column) is different.The digits displayed on the left of PathName indicate a host portnumber. The numbers displayed between the period to the right of thehost port number and the next period indicate a bus number.

Setting Up HDLMHDLM includes functions like the load balancing function, the audit loggingfunction, etc. You can configure these functions by using the HDLMcommand's set operation from the remote management client. This sectiondescribes how to set up the HDLM functions.

Checking the Current SettingsCheck the current settings by executing the following command to set theHDLM functionality by using the dlnkmgr command's view operation. PROMPT>dlnkmgr -s host-name -u user-name -p password view -sys -sfuncHDLM Version : x.x.x-xxService Pack Version : Load Balance : on(extended lio)Intermittent Error Monitor : offDynamic I/O Path Control : off(10)KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> To check the current audit log settings, execute the following command: PROMPT>dlnkmgr -l view -sys -audlog


Audit Log : offAudit Log Category : -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Setting Up the HDLM FunctionsThe table below summarizes the functions that can be set in HDLM. Fordetails about each function, see Setting Up Load Balancing on page 3-17and subsequent sections.

Each function has a default value and a recommended value. If no function isset by the HDLM command's set operation, the default value is applied foreach function. The recommended values are used as the guideline valueswhen functions are configured.

Table 3-5 The Recommended and Default Values of Each Function

Function Default value Recommended value

Load-balancing The Extended Least I/Osalgorithm is used.

The recommended algorithmdepends on the operatingenvironment.

Intermittent ErrorMonitor

off on

Dynamic I/O pathcontrol#

off10-minute check interval

offThe recommended checkinginterval depends on theoperating environment.

Collection of audit logdata

off The recommended valuedepends on the operatingenvironment.Set on, if you want to collectaudit log data.

#This function is applied only when Hitachi AMS2000 series, Hitachi SMSseries, or HUS100 series storage is used.

Setting Up Load Balancing

You can select whether to enable load balancing.

The following is an example of using a command to set load balancing. dlnkmgr -s host-name -u user-name -p password set -lb on -lbtype exlio If you want to change the load balancing algorithm, specify one of thefollowing algorithm values after the -lbtype option:


• exrr for the Extended Round Robin algorithm• exlio for the Extended Least I/Os algorithm• exlbk for the Extended Least Blocks algorithm• vmwmru for the Most Recently Used algorithm (VMware)• vmwrr for the Round Robin algorithm (VMware)

Setting Up Intermittent Error Monitoring

To prevent I/O performance from dropping when an intermittent error occurs,we recommend that you enable intermittent error monitoring.

When intermittent error monitoring is enabled, you can specify, asintermittent error conditions, the error monitoring interval and the number oftimes that the error needs to occur. The default value for the intermittenterror-monitoring interval is 30. The default value for the number of erroroccurrences is 3.

HDLM assumes that an intermittent error has occurred on a path ifintermittent error monitoring is enabled and the specified error rate isreached. A path that is assumed to have an intermittent error is excludedfrom automatic failback. Each path is monitored.

To determine whether a path is invalid for an automatic failback, you can usethe results of the dlnkmgr command's view operation.

The following is an example of using a command to enable intermittent errormonitoring: dlnkmgr -s host-name -u user-name -p password set -iem on -intvl 20 -iemnum 2 To enable intermittent error monitoring, specify on. To disable intermittenterror monitoring, specify off. When you specify on, you can use the -intvland -iemnum parameters to specify intermittent error conditions (theconditions used by the system to determine whether an intermittent error isoccurring). In the -intvl parameter, specify the monitoring interval for anintermittent error. In the -iemnum parameter, specify the number of timesthat the error is to occur. If these parameters are omitted and 3 or moreerrors occur within 30 minutes, HDLM assumes that an intermittent error isoccurring.

Setting Up Dynamic I/O Path Control

To prevent degrading of I/O performance, this function dynamically switchesthe output controllers for HDLM, following the switching of controllersperformed by the storage system.

The dynamic I/O path control function can be set for each storage system orLU. The checking interval for reviewing the switching status information canalso be set in order to properly follow the switching of controllers performedby the storage system.


The following is an example of setting the dynamic I/O path control function:

dlnkmgr -s host-name -u user-name -p password set -dpc on -pathid 000001 -ludlnkmgr -s host-name -u user-name -p password set -dpcintvl 10Specify "on" to enable the dynamic I/O path control function, or "off" todisable the function. For the -pathid parameter, specify an LU, or the ID of apath connected to the storage system. For the -dpcintvl parameter, specifythe checking interval (in minutes) for reviewing the information about theswitching of controllers performed by the storage system.

Setting Up Audit Log Data Collection

If you want to collect audit log data, you must also specify the collection levelfor audit log data and the audit log categories.

The table below lists and describes the values for the audit log collection levelsetting. An audit log data collection level is a severity level. The default is 6.

Table 3-6 Values Indicating Audit Log Data Collection Levels

Value (severity) Explanation

0 Error-level audit log data is collected.

1

2

3

4 Error-level and Warning-level audit log data iscollected.

5

6 Error-level, Warning-level, and Information-levelaudit log data is collected.

7

The table below lists and describes the values for the audit log categorysetting.. The default is all.

Table 3-7 Values Indicating Audit Log Data Categories

Value Explanation

ss Audit log events of the StartStop category are collected.

a Audit log events of the Authentication category are collected.

ca Audit log events of the ConfigurationAccess category are collected.

all Audit log events of the StartStop, Authentication, andConfigurationAccess categories are all collected.

This example shows how to enable the collection of audit log data:


dlnkmgr -l set -audlog on -audlv 6 -category all Specify on if you want to collect audit log data, and off if you do not want tocollect audit log data. If you specify on, you can use the -audlv parameter tospecify the collection level for audit log data and the -category parameter tospecify the audit log categories.

Checking the Updated SettingsThis chapter describes steps involved in how to check the new settings byusing the dlnkmgr command's set operation after the new settings areapplied.

When you some these settings, you can display information about all of HDLMfunction settings. The following is an example of executing the command: PROMPT>dlnkmgr -s host-name -u user-name -p password view -sys -sfuncHDLM Version : x.x.x-xxService Pack Version : Load Balance : on(extended lio)Intermittent Error Monitor : on(2/20)Dynamic I/O Path Control : off(10)KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> After you have set up the collection of audit log data, use the followingcommand to make sure that the setting has been specified correctly: PROMPT>dlnkmgr -l view -sys -audlogAudit Log : on(6)Audit Log Category : allKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Setting Up Integrated TracesWhen you use HDLM, the activity logs of the HDLM command are output tothe integrated trace information file(program-installation-destination-drive:\Program Files#\HITACHI\HNTRLib2\spool\hntr2n.log(where n indicates afile number)) of the Hitachi Network Objectplaza Trace Library (HNTRLib2)installed on the remote management client.


If a lot of integrated trace information is output, the older information mightend up getting deleted in a very short amount of time. Also, if a large amount


of integrated trace information is suddenly all output at the same time, anyintegrated trace information that is overflowing the buffer might not be savedinto the integrated trace files. To save as much information as possible,change the settings for Hitachi Network Objectplaza Trace Library, increasingthe integrated trace file size and buffer size. Note that if the values are toolarge, it will place a heavy load on the system. When determining thesevalues, be sure to consider these operational tradeoffs.

The following table shows the default and recommended values for theintegrated trace file settings.

Table 3-8 Default and Recommended Values for the Integrated Trace FileSettings

Setting Default value Recommendedvalue

Integrated trace file size 256 (KB) 4096 (KB)

Number of integrated trace files 4 8

Buffer size permonitoringinterval

Monitoring cycle 10 (seconds) 5 (seconds)

Buffer size permonitoring interval

64 (KB) 256 (KB)

Number ofmessages to beoutput permonitoringinterval

Monitoring cycle 0 (seconds) 0 (seconds)

Number of messagesto be output

0 0

If Hitachi Network Objectplaza Trace Library (HNTRLib2) is already installed,the existing settings will be inherited. If you change these settings, keep inmind that programs other than HDLM also use them. If an earlier HitachiNetwork Objectplaza Trace Library (HNTRLib) is already installed, the settingswill not be inherited.

To change the integrated trace file settings:

1. On the remote management client, double-click the following file inExplorer:program-installation-destination-drive:\Program Files#\HITACHI\HNTRLib2\bin\hntr2utl2.exe#

For Windows 7 (x64) , Windows Server 2008, and Windows Vista(x64), Program Files is Program Files (x86).

The following dialog box appears.


Figure 3-2 Hitachi Network Objectplaza Trace Utility 2 Release 2.0Dialog Box.

2. In Number of Files, change the number of integrated trace files.The default is 4. You can specify a value from 1 to 16.The value you specify here will apply to n in program-installation-destination-drive:\Program Files\HITACHI\HNTRLib2\spool\Hntr2n.log (n indicates a file number).

3. In File Size(KB), change the size of an integrated trace file.The default is 256 (kilobytes). You can specify a value from 8 to 8192.Specify a value greater than or equal to the setting of Buffer Size(KB).

4. In Buffer Size(KB), change the buffer size.Change the buffer size for the monitoring cycle.The default is 64 (kilobytes). You can specify a value from 8 to 2048.Specify a value smaller than or equal to the setting of File Size(KB).

5. In Interval Timer(Sec), enter a value to shorten the monitoring cycle.The default is 10 (seconds). You can specify a value from 1 to 300.

6. In Lookout Span(Sec), enter a value to specify the interval formonitoring the number of messages to be output to the integrated tracefile.The default is 0 (seconds). You can specify a value from 0 to 3600.If you specify 0, you cannot adjust the number of messages to be outputbecause the system ignores the setting of Max Messages / Span.

7. In Max Messages / Span, enter a value to specify the maximumnumber of messages to be output to the integrated trace file at themonitoring interval specified in Lookout Span(Sec).


The default is 0. You can specify a value from 0 to 500.If you specify 0, you cannot adjust the number of messages to be output.If you specify 0 for Lookout Span(Sec), you cannot adjust the numberof messages to be output because the system ignores the MaxMessages / Span setting.

8. After you finish changing the settings, click the OK button.The dialog box closes.

9. Close all of the Hitachi program products that are using Hitachi NetworkObjectplaza Trace Library, or restart the remote management client.If you choose to restart the remote management client, you do not needto perform step 10.

10. Restart the services of the HDLM manager and Hitachi NetworkObjectplaza Trace Library for the Hitachi Network Objectplaza TraceLibrary settings to take effect.From Control Panel, choose Administrative Tools and then Servicesto open the Services window.From the list of services, select DLMManagerVM. Then, from the Actionmenu, choose Restart to restart the service.Next, from the list of services, select Hitachi Network ObjectplazaTrace Monitor 2. Then, from the Action menu, choose Restart torestart the service.

Removing HDLMThis section explains how to return the operating environment to the way itwas before HDLM was installed.

Preparations for HDLM Removal• Back up all the data on the host where HDLM is installed. Also, if

necessary, back up the data on the management target device.• Shut down any application processes and services, such as DBMS, that

use a path managed by HDLM.• If firewall exceptions have been registered by using the firewall_setup

command, remove them. Make sure that you do not use another HitachiCommand Suite product to manage the host after removing HDLM.For details about the firewall_setup command, see the description offirewall_setup syntax in Specify Windows Firewall settings on page3-14 of Settings When Managing HDLM by Using Global Link Manager onpage 3-12.

Removing HDLMThe procedure for removing HDLM is described below. Perform the removalprocess on the host and the remote management client.


Removing HDLM from a host

The removal of HDLM from a host is performed using the VMware vSphereCLI on the remote management client.


2. Start the VMware vSphere CLI on the remote management client.3. Execute the following command to check the name of the HDLM offline

bundle file. esxcli --server=host-name --username=user-name --password=password software vib list | findstr hdlm

4. Remove HDLM.Execute the command below. In the -n parameter, specify the offlinebundle file name you identified in step 3. esxcli --server=host-name --username=user-name --password=password software vib remove -n offline-bundle-file-name

5. Return the acceptance level of the host to what it was before you installedHDLM.Execute the command below. In the --level parameter, specify theacceptance level value that you noted before installing HDLM. esxcli --server=host-name --username=user-name --password=password software acceptance set --level=acceptance-level

6. Restart the host.7. Execute the following command to check the list of devices.

Check the management-target devices of HDLM. esxcli --server=host-name --username=user-name --password=password storage nmp device list : :naa.60060e8006cf2e000000cf2e00000039 Device Display Name: HITACHI Fibre Channel Disk (naa.60060e8006cf2e000000cf2e00000039) Storage Array Type: VMW_SATP_LOCAL Storage Array Type Device Config: {device config options } Path Selection Policy: VMW_PSP_MRU Path Selection Policy Device Config: Path Selection Policy Device Custom Config: Working Paths: vmhba2:C0:T0:L3 : : In the command output, search for items for which HITACHI FibreChannel Disk appears in the Device Display Name field, and make sure


that HTI_SATP_HDLM is not displayed in the Storage Array Type field forthose items.

Having removed HDLM from the host, next remove it from the remotemanagement client.

Removing HDLM from a remote management client

When removing HDLM from a remote management client, use the HDLMremoval utility (removehdlm). HDLM cannot be removed by using Programsand Features in the Control Panel.

HDLM can be removed from a remote management client in an unattendedremoval operation. In an unattended removal, responses during processingcan be omitted.

For details on the removehdlm utility, see The removehdlm Utility forRemoving HDLM on page 7-11.

1. Launch the Administrator: Command Prompt window.2. Execute the following command to start the removehdlm utility.

removehdlm To perform an unattended removal, add the -s parameter to theremovehdlm command. removehdlm -s

3. Check the removal results.Check the removal results from the command prompt. If an unattendedremoval was performed, also check the messages output tohdlmvmuninst.log.hdlmvmuninst.log is output directly under the drive on which Windows isinstalled.


4HDLM Operation

This chapter describes the procedures for operating HDLM. This includes howto operate HDLM and the HDLM manager, and how to change theconfiguration of the operating environment.

□ HDLM Operations Using Commands

□ Starting and Stopping the HDLM Manager

□ HDLM Resident Processes

HDLM Operation 4-1Hitachi Dynamic Link Manager (for VMware®) User Guide

HDLM Operations Using CommandsThis section explains how to use the HDLM command. For details on thevarious command operations, see Chapter 6, Command Reference on page6-1.

Notes on Using Commands• Execute the HDLM command from the VMware vSphere CLI on the remote

management client.• To specify a parameter value containing one or more spaces, enclose the

entire value in double quotation marks (").• If you perform either of the following operations, the length of time

required to perform the operation (number-of-paths x one second)depends on the number of paths that are managed by HDLM:

¢ An online or offline operation to change the status of paths¢ A set operation to change the load-balance settings

Viewing Path InformationThis section explains how to display path information by using an HDLMcommand.

To display path information, execute the dlnkmgr command's view operationwith the -path parameter specified. The following example shows how toexecute the command: dlnkmgr -s host-name -u user-name -p password view -path To display information only for the paths accessing the specified host device,execute the dlnkmgr command's view operation with the -path and -hdevparameters specified. The following example shows how to execute thecommand: PROMPT>dlnkmgr -s host-name -u user-name -p password view -path -hdev t10.HITACHI_770101520191Paths:000002 OnlinePaths:000002PathStatus IO-Count IO-ErrorsOnline 42 0

PathID PathName DskName iLU ChaPort Status Type IO-Count IO-Errors DNum HDevName000000 0002.0000.0000000000000000.0000 HITACHI .DF600F .77010152 0191 0B Online Own 42 0 0 t10.HITACHI_770101520191000001 0005.0000.0000000000000000.0000 HITACHI .DF600F .77010152 0191 1B Online Non 0 0 0 t10.HITACHI_770101520191KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ss

4-2 HDLM OperationHitachi Dynamic Link Manager (for VMware®) User Guide

PROMPT> For details on the displayed items and their descriptions, see view (DisplaysInformation) on page 6-23.

Changing the Status of PathsThis section explains how to change path statuses.

Changing the Status of Paths to Online

To change the status of paths to online:

1. Check the current status of the paths.To place paths online by specifying a CHA port, single path, or HBA portWWN, check the path name or PATH_ID used to manage the path.The following example shows how to execute the command: dlnkmgr -s host-name -u user-name -p password view -path

2. To change the status of paths to Online, execute the dlnkmgr command'sonline operation.The paths to be placed Online can be specified by using a CHA port,single path, or HBA port WWN. For details on how to specify paths, seeonline (Places Paths Online) on page 6-10.For example, to place a specific path online, execute the HDLMcommand's online operation with the -pathid parameter specified. Thefollowing is an example of executing the command: PROMPT>dlnkmgr -s host-name -u user-name -p password online -pathid 000001KAPL01050-I The currently selected paths will be changed to the Online status. Is this OK? [y/n]:yKAPL01061-I 1 path(s) were successfully placed Online; 0 path(s) were not. Operation name = onlinePROMPT>

3. Check to see if the statuses of all the applicable paths have changed.The following is an example of executing the command: dlnkmgr -s host-name -u user-name -p password view -path

Changing the Status of Paths to Offline(C)

1. Check the current status of the paths.To change the status of a path to Offline(C) by specifying a CHA port,single path, or HBA port WWN, check the path name or PATH_ID used tomanage the path.The following is an example of executing the command:


dlnkmgr -s host-name -u user-name -p password view -path

2. To change the status of paths to Offline(C), execute the dlnkmgrcommand's offline operation.The paths to be placed Offline(C) can be specified by using a CHA port,single path, or HBA port WWN. For details on how to specify paths, seeoffline (Places Paths Offline) on page 6-7.For example, to place a specific path offline, execute the HDLMcommand's offline operation with the -pathid parameter specified. Thefollowing is an example of executing the command: PROMPT>dlnkmgr -s host-name -u user-name -p password offline -pathid 000001KAPL01052-I The currently selected paths will be changed to the Offline(C) status. Is this OK? [y/n]:yKAPL01053-I If you are sure that there would be no problem when the path is placed in the Offline(C) status, enter y. Otherwise, enter n. [y/n]:yKAPL01061-I 1 path(s) were successfully placed Offline(C); 0 path(s) were not. Operation name = offlinePROMPT>

3. Check to see if the statuses of all the applicable paths have changed.The following is an example of executing the command: dlnkmgr -s host-name -u user-name -p password view -path

Viewing LU InformationThis section explains how to display LU information by using an HDLMcommand.

To display LU information, execute the dlnkmgr command's view operationwith the -lu parameter specified. The following is an example of executingthe command: PROMPT>dlnkmgr -s host-name -u user-name -p password view -luProduct : SANRISE_AMSSerialNumber : 77010152LUs : 1

iLU HDevName PathID Status0191 t10.HITACHI_770101520191 000000 Online 000001 OnlineKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> For details on the displayed items and their descriptions, see view (DisplaysInformation) on page 6-23.


Initializing Statistical Information for PathsThis section explains how to initialize statistical information (I/O counts andI/O errors) for all the paths managed by HDLM.

This procedure is useful when you want to check the number of I/Ooperations and I/O errors that have occurred since the last time the I/Ocounts and I/O errors were initialized to 0.

1. Check the current status of the path.The following is an example of executing the command: dlnkmgr -s host-name -u user-name -p password view -path

2. To initialize statistical information for all the paths managed by HDLM,execute the dlnkmgr command's clear operation with the -pdstparameter specified.The following is an example of executing the command: PROMPT>dlnkmgr -s host-name -u user-name -p password clear -pdstKAPL01049-I Would you like to execute the operation? Operation name = clear [y/n]:yKAPL01001-I The HDLM command completed normally. Operation name = clear, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

3. Check to see whether the statistical information for all the paths has beeninitialized.The following is an example of executing the command: dlnkmgr -s host-name -u user-name -p password view -path

Viewing and Setting Up the Operating EnvironmentThis section explains how to display and set up the HDLM operatingenvironment.

Viewing the Operating Environment

To display the operating environment, execute the dlnkmgr command's viewoperation with the -sys and -sfunc parameters specified.

The following is an example of executing the command: PROMPT>dlnkmgr -s host-name -u user-name -p password view -sys -sfuncHDLM Version : x.x.x-xxService Pack Version : Load Balance : on(extended lio)Intermittent Error Monitor : offDynamic I/O Path Control : off(10)KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ss


PROMPT> To display the operating environment of the audit log, execute the HDLMcommand's view operation with the -sys and -audlog parameters specified.

The following example shows how to execute the command: PROMPT>dlnkmgr -l view -sys -audlogAudit Log : offAudit Log Category : -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> For details on the displayed items and their descriptions, see view (DisplaysInformation) on page 6-23.

Setting Up the Operating Environment

To set up the HDLM operating environment, execute the dlnkmgr command'sset operation. This operation allows you to set up the following functions:

• Load balancing• Intermittent error monitoring• Dynamic I/O path control• Displaying the physical storage system information• Audit log data collection

For details on how to set up each function, see set (Sets Up the OperatingEnvironment) on page 6-15.

For example, to set up the load balancing function, execute the HDLMcommand's set operation with the -lb parameter specified. When theconfirmation message is displayed, enter y to execute, or n to cancel thecommand.

The following is an example of executing the command: PROMPT>dlnkmgr -s host-name -u user-name -p password set -lb on -lbtype exrrKAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: yKAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ssPROMPT> To check whether the settings have been applied, see Viewing the OperatingEnvironment on page 4-5.

Viewing License InformationThis section explains how to display license information.


To display license information, execute the dlnkmgr command's viewoperation with the -sys and -lic parameters specified.

The following is an example of executing the command: PROMPT>dlnkmgr -l view -sys -licLicense Type ExpirationPermanent -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> For details on the displayed items and their descriptions, see view (DisplaysInformation) on page 6-23.

Updating the LicenseThis section explains how to update the license.

To update the license, execute the dlnkmgr command's set operation withthe -lic parameter specified. When the confirmation message is displayed,enter y to execute, or n to cancel the command. If the license key file doesnot exist, a message asking you to enter the license key appears, so enterthe license key.

Note:When you are executing the dlnkmgr command's set operation with the -lic parameter to install the license, you can only execute it once at atime. If you attempt to execute more than one dlnkmgr commandcontaining the set operation with the -lic parameter, the followingmessage might appear and HDLM might terminate abnormally: KAPL01075-E A fatal error occurred in HDLM. The system environment is invalid. If this message appears, execute the dlnkmgr command's view operationwith the -sys -lic parameter to make sure that the license is installedcorrectly.

The following shows an example in which the command is executed: PROMPT>dlnkmgr -l set -licKAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: yKAPL01071-I A permanent license was installed.PROMPT>

Viewing HDLM Version InformationThis section explains how to display HDLM version information.


To display HDLM version information, execute the dlnkmgr command's viewoperation with the -sys parameter specified. The following is an example ofexecuting the command:

To check the version of HDLM installed on a host: PROMPT>dlnkmgr -s host-name -u user-name -p password view -sysHDLM Version : x.x.x-xxService Pack Version : Load Balance : on(extended lio)Intermittent Error Monitor : offDynamic I/O Path Control : off(10)SATP : HTI_SATP_HDLMDefault PSP : HTI_PSP_HDLM_EXLIOKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

To check the version of HDLM installed on a remote managementclient: PROMPT>dlnkmgr -l view -sysHDLM Version : x.x.x-xxService Pack Version : HDLM Manager Ver WakeupTimeAlive x.x.x-xx yyyy/mm/dd hh:mm:ssLicense Type ExpirationPermanent -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> The value displayed in HDLM version indicates the HDLM version.

Viewing HDLM Component InformationThis section explains how to display HDLM component information.

To display HDLM component information, execute the dlnkmgr command'sview operation with the -sys parameter specified. The following shows anexample in which the command is executed: PROMPT>dlnkmgr -l view -sysHDLM Version : x.x.x-xxService Pack Version : HDLM Manager Ver WakeupTimeAlive x.x.x-xx yyyy/mm/dd hh:mm:ssLicense Type ExpirationPermanent -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>


Among the displayed items, HDLM Manager indicate the HDLM componentinformation.

Starting and Stopping the HDLM ManagerIf an error occurs in the system, such as in an HDLM program, you mightneed to manually stop or start HDLM to recover from the error.

Starting the HDLM ManagerDuring installation of the remote management client, the HDLM manager isregistered as a Windows service and the startup type is set to Automatic.This means that when Windows starts, the HDLM manager will also startautomatically.

If, for some reason, the HDLM manager does not automatically start, do thefollowing:

Log on to Windows on the remote management client as a member of theAdministrators group. From Control Panel, choose Administrative Tools,and then Services. From the list of services, double-click DLMManagerVM,and then click the Start button.

Use the following dlnkmgr command's view operation from the remotemanagement client to confirm that the HDLM manager has started. PROMPT>dlnkmgr -l view -sys -msrvHDLM Manager Ver WakeupTimeAlive x.x.x-xx yyyy/mm/dd hh:mm:ssKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> When the HDLM Manager column shows Alive, the HDLM manager is active.

Stopping the HDLM ManagerWhen you remove, upgrade, or re-install HDLM, the HDLM manager willautomatically stop.

If, for some reason, the HDLM manager does not automatically stop, stop itas follows:

Log on to Windows on the remote management client as a member of theAdministrators group. In Control Panel, choose Administrative Tools, andthen Services. From the list of services, double-click DLMManagerVM, andthen click the Stop button.

Use the following dlnkmgr command's view operation from the remotemanagement client to confirm that the HDLM manager has stopped.

PROMPT>dlnkmgr -l view -sys -msrvHDLM Manager Ver WakeupTime


DeadKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT> When the HDLM Manager column shows Dead, the HDLM manager is inactive.

HDLM Resident ProcessesThe table below lists and describes the resident processes in HDLM. Tomonitor these processes, use the names below.

Table 4-1 HDLM resident processes

Process Service Description

dlmmgr.exe HDLM Manager forVMware

HDLM manager process

hbsa_service.exe HBsA Service Hitachi Command Suite CommonAgent Component# process

hntr2mon.exehntr2srv.exe

Hitachi NetworkObjectplaza TraceMonitor 2

Hitachi Network Objectplaza TraceLibrary (HNTRLib2) process

#You only need to monitor this process when HDLM is linked to Global LinkManager.


5Troubleshooting

This chapter describes how to properly use HDLM error information, and thenhow to resolve the problem, if an error has occurred in HDLM. The resolutionsfor path errors, HDLM program errors, and other types of errors are alldescribed separately. If you need technical support, see Getting help on pagexiii.

□ Collecting Error Information

□ Checking Error Information in Messages

□ What To Do for a Path Error

□ What To Do for a Program Error

□ What To Do for Other Errors

Troubleshooting 5-1Hitachi Dynamic Link Manager (for VMware®) User Guide

Collecting Error InformationCollect the error information immediately after an error occurs. If thecomputer is restarted, the error information might be deleted and you will beunable to collect it.

For details about how to collect error information, see Collecting ErrorInformation on page 2-26.

Checking Error Information in MessagesYou can check path errors by referring to the KAPL20023-E message outputto the syslog.

To obtain detailed information about a path failure, check the executionresults of the view operation as indicated by the error message.

For details on the view operation, see view (Displays Information) on page6-23.

What To Do for a Path ErrorWhen a path error is detected, HDLM performs a failover on the path andoutputs the KAPL20023-E message. This message indicates that an error hasoccurred in the components, shown in the following figure, that make up thepath.

Figure 5-1 Error Location When the KAPL20023-E Message Is Output

The following figure shows the troubleshooting procedure when theKAPL20023-E message is output.

5-2 TroubleshootingHitachi Dynamic Link Manager (for VMware®) User Guide

Figure 5-2 Troubleshooting Procedure When a Path Error Occurs

The following shows the procedure for using the HDLM command (dlnkmgr)to handle a path error.

Examining the MessagesExamine the message that is output to syslog in the host by usingapplications or tools for monitoring messages. If the KAPL20023-E messageis output, view the message to check the path in which the error hasoccurred. For details on each item displayed in messages, see Checking ErrorInformation in Messages on page 5-2.

Obtain Path InformationObtain path information.

Execute the following command from the remote management client: dlnkmgr -s host-name -u user-name -p password view -path -iem -hbaportwwn > pathinfo.txt pathinfo.txt is the redirection-output file name. Use a file name thatmatches your environment.

Identifying the Error PathCheck the obtained path information to find the path with the error. In theStatus column, the error path has the status Offline(E).


Narrowing Down the Hardware That Might Have Caused the ErrorCheck the DskName, iLU, ChaPort, and HBAPortWWN columns of the path withthe error to narrow down the hardware that may be the cause of the error.To physically identify the hardware corresponding to DskName, iLU, andChaPort, use the information provided by the storage-system managementprogram.

Identifying the Error Location and Correcting any Hardware ErrorUse the VMware vSphere and hardware management tools to identify theerror location, and then resolve the problem. For hardware maintenance,contact your hardware vendor or maintenance company, if there is amaintenance contract.

Placing the Path OnlineAfter the path has recovered from the error, use the dlnkmgr command'sonline operation to place the path back online. For details on the onlineoperation, see online (Places Paths Online) on page 6-10.

Execute the following command from the remote management client: dlnkmgr -s host-name -u user-name -p password online Executing this command places all the offline paths online.

If any path cannot be placed online due to an error, the KAPL01039-Wmessage will appear. To ignore such paths and to continue processing, typey. Type n to cancel processing.

Check the statuses of the paths that cannot be placed online, and resolve theproblem.

What To Do for a Program ErrorThe following describes what to do to handle errors that occur in an HDLMprogram. The following figure shows the troubleshooting procedure.


Figure 5-3 Troubleshooting Procedure When a Program Error Occurs

The following shows the procedure for handling a program error by using theHDLM command (dlnkmgr).

Examining the MessagesExamine the messages that are output to the host syslog. If an error occursin an HDLM program, a message is output to syslog. Examine the content ofthe message. Messages with error level E (Error) or higher require correctiveaction.

Obtaining Program InformationObtain the information that you need to report to your HDLM vendor ormaintenance company.

Use the DLMgetras utility to collect the error information. For details on thisutility and the information it collects, see The DLMgetras Utility for CollectingHDLM Error Information on page 7-2.

Some of the information collected by the DLMgetras utility might be clearedwhen the host is restarted. Because of this, whenever an error occurs,execute the DLMgetras utility as soon as possible.

What To Do for the Program ErrorFollow the recommended actions for messages in Chapter 8, Messages onpage 8-1.

If the error occurs again after you thought that you had resolved theproblem, use the dlnkmgr command's view operation to check the status ofthe HDLM program, and then do whatever is necessary to resolve theproblem. For details on the view operation, see view (Displays Information)on page 6-23.

Execute the following command from the remote management client:


dlnkmgr -s host-name -u user-name -p password view -sys If the KAPL01013-E message is output after the command is executed,restart the host.

If the same error re-occurs after you thought you had resolved the problem,go to the subsection Contacting your HDLM Vendor or Maintenance Companyon page 5-6.

Contacting your HDLM Vendor or Maintenance CompanyIf the error cannot be resolved, contact your HDLM vendor or maintenancecompany, and report the information that was collected by the DLMgetrasutility.

What To Do for Other ErrorsWhen the cause of an error may be related to HDLM but is neither a patherror nor an HDLM program error, execute the DLMgetras utility, and thenreport the collected information to the HDLM vendor or maintenance companyif there is a maintenance contract for HDLM. For details about the DLMgetrasutility and the information it collects, see The DLMgetras Utility for CollectingHDLM Error Information on page 7-2.


6Command Reference

This chapter describes the HDLM command (dlnkmgr) and its operations.

□ Overview of the HDLM Command dlnkmgr

□ clear (Returns the Path Statistics to the Initial Value)

□ help (Displays the Operation Format)

□ offline (Places Paths Offline)

□ online (Places Paths Online)

□ set (Sets Up the Operating Environment)

□ view (Displays Information)

□ refresh (Applies Storage System Settings to HDLM)

Command Reference 6-1Hitachi Dynamic Link Manager (for VMware®) User Guide

Overview of the HDLM Command dlnkmgrThis section describes how to specify the HDLM command dlnkmgr and itssubcommands (called operations in HDLM).

Command format

Enter the command using the following format:dlnkmgr [connection-options] operation [parameter [parameter-value]]dlnkmgr

The command name.

connection-optionsThe information required to log in to the target host.

operationThe type of operation.

parameterA value required for an operation.

parameter-valueA value required for an operation parameter.

Enter the host connection options in the following format:-s host-name -u user-name -p passwordhost-name

The name of the target host.

user-nameThe user name used to log in to the host.

passwordThe password used to log in to the host.

If you omit the -u or -p parameter, the command will prompt you toenter a user name or password. In this case, enter the user name orpassword as directed.Note that you do not need to specify host connection options if thefollowing environment variables are set on the remote managementclient:

¢ VI_SERVER: Host name¢ VI_USERNAME: User name¢ VI_PASSWORD: Password

Operations of the dlnkmgr command

Table 6-1 Operations of the dlnkmgr Command on page 6-3 shows theoperations of dlnkmgr and their functions.

6-2 Command ReferenceHitachi Dynamic Link Manager (for VMware®) User Guide

Table 6-1 Operations of the dlnkmgr Command

Operation Functions

clear Initializes(0) the statistics (I/O count and I/O errors) of all pathsmanaged by the HDLM system. For details, see clear (Returns the PathStatistics to the Initial Value) on page 6-3.

help Displays the format of the operations used for HDLM. For details, seehelp (Displays the Operation Format) on page 6-5.

offline Places offline an online path or paths. For details, see offline (PlacesPaths Offline) on page 6-7.

online Places online an offline path or paths. For details, see online (PlacesPaths Online) on page 6-10.

set Sets the HDLM operating environment. For details, see set (Sets Up theOperating Environment) on page 6-15.

view Displays HDLM program information, path information, and LUinformation. For details, see view (Displays Information) on page 6-23.

refresh Applies the storage system settings to HDLM. For details, see refresh(Applies Storage System Settings to HDLM) on page 6-57.

Notes:

¢ Execute the HDLM command from the VMware vSphere CLI on theremote management client.

¢ To specify a value that contains a space in its parameter, enclose theentire value in double quotes (").

¢ If you perform either of the following operations, the length of timerequired to perform the operation (number-of-paths x one second)depends on the number of paths that are managed by HDLM:

• An online or offline operation to change the status of paths• A set operation to change the load-balance settings

clear (Returns the Path Statistics to the Initial Value)The dlnkmgr command's clear operation clears the statistics (I/O count andI/O errors) of all paths that are managed by HDLM, and returns them to theirinitial value.

Format

To set the path statistics to 0

dlnkmgr [-s host-name -u user-name -p password] clear-pdst [-s]


To display the format of the clear operation

dlnkmgr [-s host-name -u user-name -p password] clear-help

Parameters

To Set the Path Statistics to 0

-pdstClears statistics (I/O count and I/O errors) of all paths managed by HDLMto the initial value (0).

Example PROMPT>dlnkmgr clear -pdstKAPL01049-I Would you like to execute the operation? Operation name = clear [y/n]:yKAPL01001-I The HDLM command completed normally. Operation name = clear, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

-sExecutes the command without displaying a message asking forconfirmation of command execution from the user. Specify this parameterif you want to skip the response to the confirmation message: forexample, when you want to execute the command in a shell script orbatch file.

Example PROMPT>dlnkmgr clear -pdst -sKAPL01001-I The HDLM command completed normally. Operation name = clear, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

To Display the Format of the clear Operation

-helpDisplays the format of the clear operation.

Example PROMPT>dlnkmgr clear -helpclear: Format dlnkmgr [Host-Connection-Options] clear -pdst [-s] Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]KAPL01001-I The HDLM command completed normally. Operation name = clear, completion time = yyyy/mm/dd hh:mm:ss


PROMPT>

help (Displays the Operation Format)The dlnkmgr command's help operation displays the list of operationsavailable for the HDLM command, or the format of individual operations.

Formatdlnkmgr [-s host-name -u user-name -p password] help

[operation] [operation] ...

Parameteroperation

Specify the HDLM command operation whose format you want to know.You can specify one of the following operations:

¢ clear¢ help¢ offline¢ online¢ set¢ view¢ refreshIf you do not specify any operations, the help operation displays alloperations available for the HDLM command.

Examples

Example 1The following example shows how to display all the operations available inthe HDLM command. PROMPT>dlnkmgr helpdlnkmgr: Format dlnkmgr [Host-Connection-Options] { clear | help | offline | online | set | view | refresh } dlnkmgr -l { help | set | view } Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]KAPL01001-I The HDLM command completed normally. Operation name = help, completion time = yyyy/mm/dd hh:mm:ss


PROMPT>

Example 2The following example shows how to display the formats of multipleoperations. PROMPT>dlnkmgr help online offline helponline: Format dlnkmgr [Host-Connection-Options] online [-path] [-s] dlnkmgr [Host-Connection-Options] online [-path] -cha -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] online [-path] -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] online [-path] -hbaportwwn HBA_Port_WWN [-s] dlnkmgr [Host-Connection-Options] online [-path] -hapath [-lu -pathid AutoPATH_ID] [-s] dlnkmgr [Host-Connection-Options] online [-path] -dfha [-lu -pathid AutoPATH_ID] [-s]

Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]

Valid value AutoPATH_ID { 000000 - 999999 }(Decimal)offline: Format dlnkmgr [Host-Connection-Options] offline [-path] -cha -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] offline [-path] -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] offline [-path] -hbaportwwn HBA_Port_WWN [-s] Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]

Valid value AutoPATH_ID { 000000 - 999999 }(Decimal)help: Format dlnkmgr help { clear | offline | online | set | view | refresh }KAPL01001-I The HDLM command completed normally. Operation name = help, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 3The following example shows how to display the operations that can bespecified by the help operation PROMPT>dlnkmgr help help


help: Format dlnkmgr help { clear | offline | online | set | view | refresh }KAPL01001-I The HDLM command completed normally. Operation name = help, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

offline (Places Paths Offline)The dlnkmgr command's offline operation places online paths offline.Specify the paths to be placed offline by specifying a CHA port, single path, orHBA port WWN.

There must always be at least one online path accessing each LU.

Note that, for a path that is placed offline by the offline operation andwhose status changes to Offline(C), the path status will not be inherited whenthe host is restarted. If the path is in a normal condition when the host isrestarted, the path will become active and its status will be Online.

Placing too many paths offline might prevent paths from being able to switchif an error occurs. Before placing a path offline, use the view operation tocheck how many online paths remain. For details about the view operation,see view (Displays Information) on page 6-23.

Format

To place paths offline

dlnkmgr [-s host-name -u user-name -p password] offline[-path]|-cha -pathid AutoPATH_ID|-pathid AutoPATH_ID|-hbaportwwn HBA-port-WWN}[-s]

To Display the Format of the offline Operation

dlnkmgr [-s host-name -u user-name -p password] offline-help

Parameters

To place paths Offline

-pathIndicates that the target of the operation is a path managed by HDLM.


This parameter is optional because offline is always used for paths, so itis assumed.Make sure that you specify the paths to be taken offline by using the -cha, -pathid, or -hbaportwwn parameter.

-cha -pathid AutoPATH_IDUse this parameter to place offline, at one time, all the paths that passthrough a specific CHA port. The command will place offline all the pathsthat pass through the CHA port to which the path with the specifiedAutoPATH_ID is connected. Paths that pass through a physical CHA porton a physical storage system will be offline.Specify the current AutoPATH_ID of the target path, which is displayed byusing the view operation. For details about the view operation, see view(Displays Information) on page 6-23. Leading zeros can be omitted(000001 and 1 indicate the same AutoPATH_ID); however, when thetarget AutoPATH_ID is 000000, enter 000000 or 0 for the parametervalue.AutoPATH_IDs are re-assigned every time the host is restarted. Alwaysmake sure that you use the view operation to find the currentAutoPATH_ID of the target path, before executing the offline operation.

ExampleThe following example shows how to place offline all the pathsconnected to the CHA port 0A. In this example, a path whoseAutoPATH_ID is 000001 is connected to the target CHA port:When the confirmation message is displayed, the user enters y tocontinue, or n to cancel the operation. PROMPT>dlnkmgr offline -cha -pathid 000001KAPL01055-I All the paths which pass the specified CHA port will be changed to the Offline(C) status. Is this OK? [y/n]:yKAPL01056-I If you are sure that there would be no problem when all the paths which pass the specified CHA are placed in the Offline(C) status, enter y. Otherwise, enter n. [y/n]:KAPL01061-I 2 path(s) were successfully placed Offline(C); 0 path(s) were not. Operation name = offlinePROMPT>

-pathid AutoPATH_IDUse this parameter to place a single path offline.Specify the current AutoPATH_ID of the target path, which is displayed byusing the view operation. For details about the view operation, see view(Displays Information) on page 6-23. Leading zeros can be omitted(000001 and 1 indicate the same AutoPATH_ID); however, when thetarget AutoPATH_ID is 000000, enter 000000 or 0 for the parametervalue.AutoPATH_IDs are re-assigned every time the host is restarted. Alwaysmake sure that you use the view operation to find the currentAutoPATH_ID of the target path, before executing the offline operation.


-hbaportwwn HBA-port-WWNUse this parameter to place offline all the paths connected to an HBA portassociated with a specific HBA port WWN. Only one set of values can bespecified for the -hbaportwwn parameter.For HBA-port-WWN, specify the value of HBAPortWWN. The parameter isnot case sensitive.To display HBAPortWWN and PathName, execute the view operation asfollows: dlnkmgr view -path -hbaportwwn For details on how to execute the view operation and display the HBAport WWN and path name, see To display path information on page 6-31in Parameters (To display program information) on page 6-25.

ExampleThe following shows an example of placing offline the paths for whichthe HBA port WWN is 10000000C93213BA while confirming commandoperation. PROMPT>dlnkmgr offline -path -hbaportwwn 10000000C93213BAKAPL01052-I The currently selected paths will be changed to the Offline(C) status. Is this OK? [y/n]: yKAPL01053-I If you are sure that there would be no problem when the path is placed in the Offline(C) status, enter y. Otherwise, enter n. [y/n]: yKAPL01061-I 1 path(s) were successfully placed Offline(C); 0 path(s) were not. Operation name = offlinePROMPT>

-sExecutes the command without displaying the message asking forconfirmation of command execution from the user. Specify this parameterif you want to skip the response to the confirmation message: forexample, when you want to execute the command in a shell script orbatch file.

ExampleThe following example shows how to place a path, whoseAutoPATH_ID is 000001, offline without asking for confirmation ofcommand execution from the user: PROMPT>dlnkmgr offline -pathid 1 -sKAPL01061-I 1 path(s) were successfully placed Offline(C); 0 path(s) were not. Operation name = offlinePROMPT>

To Display the Format of the Offline Operation

-helpDisplays the format of the offline operation.


ExampleThe following example shows how to display the format of theoffline operation: PROMPT>dlnkmgr offline -helpoffline: Format dlnkmgr [Host-Connection-Options] offline [-path] -cha -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] offline [-path] -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] offline [-path] -hbaportwwn HBA_Port_WWN [-s] Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]

Valid value AutoPATH_ID { 000000 - 999999 }(Decimal)KAPL01001-I The HDLM command completed normally. Operation name = offline, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Reference

Using the view operation together with standard OS commands enables youto filter the path information listed for a specific CHA port. For details aboutthe view operation, see view (Displays Information) on page 6-23.

We recommend that you use the following command and verify theinformation on the target paths before you execute the offline operation toplace offline all the paths connected to a specific CHA port.

ExampleThe following example shows how to filter and display the information onall the paths that pass through the CHA port 0A of the Hitachi AMS series: dlnkmgr view -path -stname | find "AMS" | find "0A" The above command will display information pertaining to only thosepaths that pass through the specified CHA port.

online (Places Paths Online)The dlnkmgr command's online operation places offline paths online. Tospecify the paths to be placed online, specify a CHA port, single path, or HBAport WWN.


Format

To place paths Online

dlnkmgr [-s host-name -u user-name -p password] online[-path]|-cha -pathid AutoPATH_ID|-pathid AutoPATH_ID|-hbaportwwn HBA-port-WWN|-hapath [-lu -pathid AutoPATH_ID]|-dfha [-lu -pathid AutoPATH_ID]][-s]

To Display the Format of the Online Operation

dlnkmgr [-s host-name -u user-name -p password] online-help

Parameters

To place paths Online

-pathIndicates that the target of the operation is a path managed by HDLM.This parameter is optional because online is always used for paths, so itis assumed.Specify the paths to be taken online by using the -cha, -pathid, or -hbaportwwn parameter. If you do not specify any of these parameters,the command will place all the offline paths online. If there is a path thatcannot be placed online, a message asks whether you would like tocontinue processing. To ignore the offline path that cannot be placedonline and to continue processing, enter y. To stop the processing, entern.

-cha -pathid AutoPATH_IDUse this parameter to simultaneously place online all paths that passthrough a specific CHA port. The command will place online all paths thatpass through the CHA port in the path specified by the -pathidparameter. Paths that pass through a specific physical CHA port on aphysical storage system will be online.Specify the current AutoPATH_ID of the target path, which is displayed byusing the view operation. For details about the view operation, see view(Displays Information) on page 6-23. Leading zeros can be omitted(000001 and 1 indicate the same AutoPATH_ID); however, when thetarget AutoPATH_ID is 000000, enter 000000 or 0 for the parametervalue.


AutoPATH_IDs are re-assigned every time the host is restarted. Alwaysmake sure that you use the view operation to find the currentAutoPATH_ID of the target path, before executing the online operation.

ExampleThe following example shows how to place online the paths connectedto the CHA port 0A. In this example, a path whose AutoPATH_ID is000002 is connected to the target CHA port:When the confirmation message is displayed, the user enters y tocontinue, or n to cancel the operation. PROMPT>dlnkmgr online -cha -pathid 000002KAPL01057-I All the paths which pass the specified CHA port will be changed to the Online status. Is this OK? [y/n]:yKAPL01061-I 2 path(s) were successfully placed Online; 0 path(s) were not. Operation name = onlinePROMPT>

-pathid AutoPATH_IDUse this parameter to place a single path online.Specify the current AutoPATH_ID of the target path, which is displayed byusing the view operation. For details about the view operation, see view(Displays Information) on page 6-23. Leading zeros can be omitted(000001 and 1 indicate the same AutoPATH_ID); however, when thetarget AutoPATH_ID is 000000, enter 000000 or 0 for the parametervalue.AutoPATH_IDs are re-assigned every time the host is restarted. Alwaysmake sure that you use the view operation to find the currentAutoPATH_ID of the target path, before executing the online operation.

-hbaportwwn HBA-port-WWNUse this parameter to place online all the paths connected to an HBA portassociated with a specific HBA port WWN. Only one set of values can bespecified for the -hbaportwwn parameter.For HBA-port-WWN, specify the value of HBAPortWWN. The parameter isnot case sensitive.To display HBAPortWWN and PathName, execute the view operation asfollows: dlnkmgr view -path -hbaportwwn For details on how to execute the view operation and display the HBAport WWN and path name, see To display path information on page 6-31in Parameters (To display program information) on page 6-25.

ExampleThe following shows an example of placing online the paths for whichthe HBA port WWN is 10000000C93213BA while confirming commandoperation.


PROMPT>dlnkmgr online -path -hbaportwwn 10000000C93213BAKAPL01050-I The currently selected paths will be changed to the Online status. Is this OK? [y/n]: yKAPL01061-I 1 path(s) were successfully placed Online; 0 path(s) were not. Operation name = onlinePROMPT>

-hapathUse this parameter to change to the Online status when the paths to theprimary volume (P-VOL) in an HAM environment are in the Online(S) orOnline(D) status. To change the status of a specific LU, use the -lu and-pathid parameters to specify the path to the LU. To change the statusof all the paths in the Online(S) and Online(D) statuses, specify only -hapath.

-dfhaUse this parameter to change the paths to the primary volume (P-VOL) inan HAM environment to Online(D). The Online(S) status changes to theOnline(D) status. When you do not specify this parameter, the status ofthe P-VOL paths in the HAM environment will be changed to theOnline(S) status. If I/O operations to the secondary volume (S-VOL)have never occurred and only the paths to the P-VOL recover from anerror, the path to the P-VOL will be in the Online status regardless of thisparameter specification. To change the status of a specific LU, use the -lu and -pathid parameters to specify the path to the LU. To change thestatus of all the paths, specify only -dfha. A regular online operation isexecuted on the paths other than the P-VOL in an HAM environment.

-lu -pathid AutoPATH_IDSpecify management-target paths for each LU (P-VOL). The target LUsare the LUs that belong to a path ID that you specify in the -pathidAutoPATH_ID parameter.


ExampleThe following example shows how to place a path, whoseAutoPATH_ID is 000002, online without asking for confirmation ofcommand execution from the user: PROMPT>dlnkmgr online -pathid 2 -sKAPL01061-I 1 path(s) were successfully placed Online; 0 path(s) were not. Operation name = onlinePROMPT>


To Display the Format of the Online Operation

-helpDisplays the format of the online operation.

ExampleThe following example shows how to display the format of the onlineoperation: PROMPT>dlnkmgr online -helponline: Format dlnkmgr [Host-Connection-Options] online [-path] [-s] dlnkmgr [Host-Connection-Options] online [-path] -cha -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] online [-path] -pathid AutoPATH_ID [-s] dlnkmgr [Host-Connection-Options] online [-path] -hbaportwwn HBA_Port_WWN [-s] dlnkmgr [Host-Connection-Options] online [-path] -hapath [-lu -pathid AutoPATH_ID] [-s] dlnkmgr [Host-Connection-Options] online [-path] -dfha [-lu -pathid AutoPATH_ID] [-s]

Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]

Valid value AutoPATH_ID { 000000 - 999999 }(Decimal)KAPL01001-I The HDLM command completed normally. Operation name = online, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Reference

Using the view operation together with standard OS commands enables youto filter the path information listed for a specific CHA port. For details aboutthe view operation, see view (Displays Information) on page 6-23.

We recommend that you use the following command and verify theinformation on the target paths before you execute the online operation toplace online all the paths connected to a specific CHA port.

ExampleThe following example shows how to filter and display the information onall paths that pass through the CHA port 0A of the Hitachi AMS series: dlnkmgr view -path -stname | find "AMS" | find "0A" The above command will display information pertaining to only thosepaths that pass through the specified CHA port.


set (Sets Up the Operating Environment)The dlnkmgr command's set operation sets the HDLM operatingenvironment.

Format

To Set the Host Operating Environment

dlnkmgr [-s host-name -u user-name -p password] set{-lb on -lbtype {exrr|exlio|exlbk|vmwmru|vmwrr}|-iem {on [-intvl error-monitoring-interval] [-iemnum number-of-times-error-is-to-occur]|off}|-expathusetimes number-of-path-use-times|-dpc {on|off} [-pathid path-ID -lu|-pathid path-ID -storage]|-dpcintvl checking-interval}[-s]

To Set the Remote Management Client Operating Environment

dlnkmgr -l set{-lic|-audlog {on [-audlv audit-log-data-collection-level] [-category [[ss] [a] [ca] [all]]|off}|-pstv {on|off}}[-s]

To Display the Format of the Set Operation

To display the format of the operation for both a host and remotemanagement client:

dlnkmgr set-help

To display the format of the operation for a host:

dlnkmgr -s host-name -u user-name -p password set-help

To display the format of the operation for a remote management client:

dlnkmgr -l set-help


Parameters

To Set the Host Operating Environment

The table below shows the defaults and recommended values for eachsetting. If you change the value of the set operation, the new value takeseffect immediately.

Table 6-2 Default and Recommended Values

Item name Default value Recommended value

Load balancing The Extended Least I/Osalgorithm is used.

The recommended algorithmdepends on the operatingenvironment.

Intermittent errormonitoring

off on

Number of timesthe same path canbe used forextended loadbalancing

100 The recommended value dependson the operating environment.

Dynamic I/O pathcontrol#

offThe checking interval is 10minutes.

offThe recommended checkinginterval depends on the operatingenvironment.

#This item is applied only when Hitachi AMS2000 series, Hitachi SMSseries, or HUS100 series storage is used.

-lb on -lbtype {exrr|exlio|exlbk|vmwmru|vmwrr}Specify the algorithm to be used for load balancing.exrr: The Extended Round Robin algorithmexlio: The Extended Least I/Os algorithmexlbk: The Extended Least Blocks algorithmvmwmru: The Most Recently Used algorithm (VMware)vmwrr: The Round Robin algorithm (VMware)

-iem {on [-intvl error-monitoring-interval] [-iemnum number-of-times-error-is-to-occur]|off}

Enables or disables intermittent error monitoring.on: Enabledoff: DisabledTo prevent I/O performance from dropping when an intermittent erroroccurs, we recommend that you enable intermittent error monitoring. Ifon is specified, in the subsequent parameters you can specify theintermittent error monitoring interval and the number of times that theerror is to occur. If the specified number of times that the error is tooccur is reached during the specified monitoring interval (in minutes) on a


path, HDLM assumes that an intermittent error is occurring on the path. Apath that is assumed to have an intermittent error is excluded fromautomatic failback. Intermittent error monitoring is performed on eachpath.If you omit the intermittent error monitoring interval or the number oftimes that the error is to occur, each setting is specified as follows:

¢ When the intermittent error monitoring interval or the number oftimes that the error is to occur has not been specified before:The intermittent error monitoring interval is set to 30 minutes, andthe number of times that the error is to occur is set to 3.

¢ When the intermittent error monitoring interval or the number oftimes that the error is to occur has been specified before:The values specified from the last time are used.

The following shows the sub-parameters that should be specified: theerror monitoring interval and the number of times that the error is tooccur:

-intvl error-monitoring-intervalSpecify the monitoring interval for an intermittent error. Use a valuefrom 1 to 1440 minutes. The default is 30.During intermittent error monitoring, if changes are made to theintermittent error monitoring interval setting, the number of errorscounted on all paths until the changes are made, and the state ofexclusion from automatic failback are initialized. Monitoring thenrestarts using the new settings.The error monitoring interval specified in this parameter is storedeven if specifying -iem off disables intermittent error monitoring.Therefore, when you re-enable intermittent error monitoring and anerror monitoring interval is not specified, intermittent error monitoringwill be started using the stored error monitoring interval.

-iemnum number-of-times-error-is-to-occurSpecify the number of times the error needs to occur for anintermittent error to be assumed. Valid values are from 1 to 99. Thedefault is 3.During intermittent error monitoring, if changes are made to thesetting for the number of times that an error is to occur, the numberof errors counted on all paths until the changes are made, and thestate of exclusion from automatic failback are initialized. Monitoringthen restarts using the new settings.The number of times that the error is to occur is stored in the system,even when -iem off is specified and intermittent error monitoring isdisabled. Therefore, when you re-enable intermittent error monitoringwithout specifying the number of times, intermittent error monitoringwill be started using the value stored in the system.

When the set -iem on operation is executed during intermittent errormonitoring, even if you do not change the error monitoring interval or thenumber of times that the error is to occur, the history of errors on all


paths managed by HDLM, and the information of the paths excluded fromautomatic failback are initialized. Intermittent error monitoring continues.

-expathusetimes number-of-path-use-timesSpecifies the number of times the same path can be used for sequentialI/O operations when the extended Round Robin (exrr), Least I/Os(exlio), or Least Blocks (exlbk) algorithm is used for load balancing.You an specify a decimal (base 10) value from 1 to 999999. The default is100.

-dpc {on|off} [-pathid path-ID -lu | -pathid path-ID -storage]Enables or disables the dynamic I/O path control function for eachstorage system or LU. The default value is "off".on: Enabledoff: Disabled

-pathid path-ID -luSets the dynamic I/O path control function to enabled or disabled foreach LU. Specify one of the IDs of the paths connected to the targetLU.

-pathid path-ID -storageSets the dynamic I/O path control function to enabled or disabled foreach storage system. Specify one of the IDs of the paths connected tothe target storage system.

If the -pathid parameter is not specified, the setting is performed foreach system, and the setting for each storage system or LU is cleared.

Notes:If the host is restarted, settings for the storage system or LU arecleared, and the host operates according to the system settings.

-dpcintvl checking-intervalSpecifies the checking interval (in minutes) for reviewing informationabout switching of controllers performed by the storage system which isused in the dynamic I/O path control function. Specify a value in therange from 5 to 1440. The default value is "10".


To Set the Remote Management Client Operating Environment

-licSpecify this option for when a license is updated. The HDLM license isprovided via a license key or license key file. A license key file is a filethat stores the HDLM license key.


If you use a license key file:Store the license key file named hdlm_license directly under theWindows installation drive, and then execute the set -lic operation.A message confirming that the license key has been registered isdisplayed, depending on the license key type defined in the licensekey file. When a temporary license key or emergency license key hasbeen registered, the expiration period is displayed (KAPL01071-I,KAPL01072-I).

If you do not use a license key file:When the set -lic operation is executed, a message (KAPL01068-I)asking the user to enter a license key appears. Enter the license key.A message confirming that the license key has been registered isdisplayed, depending on the license key type described in the licensekey file. For a temporary license key or emergency license key, theexpiration period is also displayed (KAPL01071-I, KAPL01072-I).

The following table lists and describes the license key types.

Table 6-3 License Key Types

Type Description

Permanent license key Permanent license keys are valid for using HDLMpermanently.

Temporary license key# Temporary license keys are used temporarily, for example,when a user needs to perform product evaluations.Temporary license keys are valid for 120 days after theinstallation. You cannot reuse a temporary license key.

Emergency license key Emergency license keys are used temporarily, for example,when waiting for a permanent license key to be issued.Emergency license keys are valid for 30 days after theyare entered. You cannot reuse an emergency license key.

#A temporary license key cannot be installed by using the dlnkmgrcommand's set operation.

Example 1The following example shows how to update the license key whenthe license key file exists: PROMPT>dlnkmgr -l set -licKAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: yKAPL01071-I A permanent license was installed.PROMPT>

Example 2The following example shows how to update the license key whenthe license key file does not exist:


PROMPT>dlnkmgr -l set -licKAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: yKAPL01083-I There is no license key file. File name =Windows-installation-destination-drive-name\hdlm_licenseKAPL01068-I Enter a license key:*************KAPL01071-I A permanent license was installed.PROMPT>

-audlog {on [-audlv audit-log-data-collection-level] [-category [[ss] [a] [ca]|all]]|off}

Specifies whether to collect audit log data.on: Audit Log data is collected.off: Audit Log data is not collected.

-audlv audit-log-data-collection-levelSpecifies the severity level of audit log data to be collected. Thetable below lists and describes the values used for this setting.The default is 6.

Table 6-4 Values Indicating Audit Log Data Collection Levels

Value (severity) Explanation

0 Error-level audit log data is collected.

1234 Error-level and Warning-level audit log data is collected.

56 Error-level, Warning-level, and Information-level audit log

data is collected.7

-category [[ss] [a] [ca]|all]Specifies the categories of audit log data to be collected. The tablebelow lists and describes the values used for this setting. Thedefault is all. If you specify the -category parameter withoutspecifying a value, all is assumed.

Table 6-5 Values Indicating Audit Log Data Categories

Value Explanation

ss Audit log events of the StartStop category are collected.

a Audit log events of the Authentication category arecollected.


Value Explanation

ca Audit log events of the ConfigurationAccess category arecollected.

all Audit log events of the StartStop, Authentication, andConfigurationAccess categories are collected.

-pstv {on|off}Enables or disables the display of the physical storage systeminformation. The default value is "off".on: Enabledoff: DisabledIf the display of the physical storage system information isenabled, information about the physical storage system isdisplayed. If the display of the physical storage systeminformation is disabled, information about the storage systemrecognized by the operating system is displayed. For a virtualizedstorage system, virtual information is displayed, and for a non-virtualized storage system, physical information is displayed.The display results of view operations depend on whether thedisplay of the physical storage system information is enabled ordisabled. The following table shows the display items for which thedisplay results differ.

Table 6-6 Display items for which the display results of the viewoperation differ depending on the -pstv parameter specification

Operation Display Item

view -path DskName

iLU

ChaPort (CP)

view -lu Product

SerialNumber (S/N)

iLU

ChaPort

To Display the Format of the Set Operation

-helpDisplays the format of the set operation.


Examples

Example 1

The following example displays the format of the operation for both a hostand remote management client: PROMPT>dlnkmgr set -helpset: Format dlnkmgr [Host-Connection-Options] set { -lb on -lbtype { exrr | exlio | exlbk | vmwmru | vmwrr } | -iem on [ -intvl Error-Monitor-Interval ] [ -iemnum Number-Of-Times ] | -iem off | -expathusetimes Number-Of-ExPathUseTimes | -dpc { on | off } [-pathid AutoPATH_ID { -lu | -storage } ] | -dpcintvl Dpc-Interval } [-s] dlnkmgr -l set { -lic | -audlog on [ -audlv AudlogLevel ] [ -category Category-Value ] | -audlog off | -pstv { on | off } } [-s] Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]

Valid value Error-Monitor-Interval { 1 - 1440 }(Minutes) (Default Value 30) Number-Of-Times { 1 - 99 }(Times) (Default Value 3) AutoPATH_ID { 000000 - 999999 }(Decimal) Dpc-Interval { 5 - 1440 }(Minute) (Default Value 10) AudlogLevel { 0 - 7 } (Default Value 6) Category-Value { [ss] [a] [ca] | all } (Default Value all)KAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 2

The following example displays the format of the operation for a host: PROMPT>dlnkmgr -s host-name -u user-name -p password set -helpset: Format dlnkmgr [Host-Connection-Options] set { -lb on -lbtype { exrr | exlio | exlbk | vmwmru | vmwrr }


| -iem on [ -intvl Error-Monitor-Interval ] [ -iemnum Number-Of-Times ] | -iem off | -expathusetimes Number-Of-ExPathUseTimes | -dpc { on | off } [-pathid AutoPATH_ID { -lu | -storage } ] | -dpcintvl Dpc-Interval } [-s] Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]

Valid value Error-Monitor-Interval { 1 - 1440 }(Minutes) (Default Value 30) Number-Of-Times { 1 - 99 }(Times) (Default Value 3) AutoPATH_ID { 000000 - 999999 }(Decimal) Dpc-Interval { 5 - 1440 }(Minute) (Default Value 10)KAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 3

The following example displays the format of the operation for a remotemanagement client: PROMPT>dlnkmgr -l set -helpset: Format dlnkmgr -l set { -lic | -audlog on [ -audlv AudlogLevel ] [ -category Category-Value ] | -audlog off } [-s] Valid value AudlogLevel { 0 - 7 } (Default Value 6) Category-Value { [ss] [a] [ca] | all } (Default Value all)KAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

view (Displays Information)The dlnkmgr command's view operation displays HDLM program information,path information, and LU information.


Format

To Display Program Information for a Host

dlnkmgr [-s host-name -u user-name -p password] view -sys[-sfunc|-satp|-rule|-expathusetimes][-t]

To Display Program Information for a Remote Management Client

dlnkmgr -l view -sys[-msrv|-lic|-audlog|-pstv][-t]

To Display Path Information

To display path information

dlnkmgr [-s host-name -u user-name -p password] view -path[-pstv|-vstv][-hdev host-device-name][-stname][-iem][-srt {pn|lu|cp}][-hbaportwwn][-vmruntimename][-vmstate][-t]

To display path information (by selecting a display item)

dlnkmgr [-s host-name -u user-name -p password] view -path -item[pn] [hbaportwwn] [dn] [lu] [cp] [type] [ic] [ie] [dnu] [hd][iep][vmruntimename] [vmstate] [vmpathuid] [phys] [virt] [vid] [ha][-pstv|-vstv][-hdev host-device-name][-stname][-srt {pn|lu|cp}][-t]

To display path information (by abbreviating the list items)

dlnkmgr [-s host-name -u user-name -p password] view -path -c[-pstv|-vstv][-stname][-srt {lu|cp}]


[-t]

To Display LU Information

To display LU information

dlnkmgr [-s host-name -u user-name -p password] view -lu[-pstv|-vstv][-hdev host-device-name|-pathid AutoPATH_ID][-t]

To display LU information (by selecting items to be displayed)

dlnkmgr [-s host-name -u user-name -p password] view -lu -item[ [slpr] [pn] [cp] [clpr] [type] [ic] [ie] [dnu] [iep] [dpc][lb] [vmpsp] [vmruntimename] [vmstate] [phys] [virt] [vid][ha] [hastat] |all][-pstv|-vstv][-hdev host-device-name|-pathid AutoPATH_ID][-t]

To display a summary of LU information

dlnkmgr [-s host-name -u user-name -p password] view -lu -c[-pstv|-vstv][-t]

To Display the Format of the view Operation

To display the format of the operation for both a host and remotemanagement client:

dlnkmgr view-help

To display the format of the operation for a host:

dlnkmgr -s host-name -u user-name -p password view-help

To display the format of the operation for a remote management client:

dlnkmgr -l view-help

Parameters (To display program information)This section describes the parameters for the view operation, in the followingorder:


To Display Program Information for Hosts on page 6-26

To Display Program Information for a Remote Management Client on page6-29

To display path information on page 6-31

To display LU information on page 6-45

To display the format of the view operation on page 6-55

To Display Program Information for Hosts

-sys [-sfunc|-expathusetimes|-satp|-rule]Displays program information for HDLM installed on a host.Use one of the sub-parameters (following -sys) to specify the programinformation that you want to display. If you do not specify any sub-parameters, the command displays all program information except forSATP claim rules. Table 6-7 Items of program information (for hosts) onpage 6-26 shows the parameters you can specify and the displayedinformation.

-tDoes not display the title for each information item.

Table 6-7 Items of program information (for hosts)

Parameter andprogram

information tobe displayed

Item Description

-sfuncInformationabout the HDLMfunction settings

HDLM Version HDLM version number

Service PackVersion

HDLM SP version number. This item is blank ifno SP is present.

Load Balance Settings for load balancing• Setting status:

on: Enabled

• Algorithm:One of the following load balancingalgorithms is displayed in the parenthesesfollowing on.

extended rr: The Extended Round Robinalgorithmextended lio: The Extended Least I/Osalgorithmextended lbk: The Extended Least Blocksalgorithmvmw mru: The Most Recently Usedalgorithm (VMware)vmw rr: The Round Robin algorithm(VMware)




Item Description

IntermittentError Monitor

• Setting for intermittent error monitoring:on: Enabled

off: Disabled

• Intermittent error monitoring interval andnumber of times that the error needs tooccurWhen intermittent error monitoring is on,the specified intermittent error monitoringinterval and number of times that the errorneeds to occur are displayed within theparentheses following on. The format isnumber-of-times-error-is-to-occur/monitoring-interval. The time is inminutes.

Dynamic I/OPath Control

Setting status of the dynamic I/O path controlfunction• Setting status

on: Enabled

off: Disabled

• Checking intervalThe parentheses following the settingstatus shows the checking interval forreviewing information about the switchingof controllers performed by the storagesystem. "Minute" is used as the unit.If different settings have been specified foreach storage system or LU, * is addedafter the parentheses in which thechecking interval is displayed.

-expathusetimesThe number oftimes the samepath can beused forextended loadbalancing

Times SameExPath WasUsed

The number of times the same path can beused for sequential I/O operations when theextended Round Robin (exrr), Least I/Os(exlio), or Least Blocks (exlbk) algorithm isused for load balancing.

-satpInformationabout SATP

SATP Displays HTI_SATP_HDLM.

Default PSP The default PSP of HTI_SATP_HDLM.• HTI_PSP_HDLM_EXRR: The Extended Round

Robin algorithm• HTI_PSP_HDLM_EXLIO: The Extended Least

I/Os algorithm• HTI_PSP_HDLM_EXLBK: The Extended Least

Blocks algorithm




Item Description

• VMW_PSP_MRU: The Most Recently Usedalgorithm (VMware)

• VMW_PSP_RR: The Round Robin algorithm

-ruleSATP claim rules

Vendor The storage system vendor ID in the SATPclaim rule registered in HTI_SATP_HDLM.

Model The storage system model ID in the SATP claimrule registered in HTI_SATP_HDLM.

Examples

Example 1The following example displays configuration information for HDLMfunctions on a host: PROMPT>dlnkmgr view -sys -sfuncHDLM Version : x.x.x-xxService Pack Version : Load Balance : on(extended lio)Intermittent Error Monitor : offDynamic I/O Path Control : off(10)KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 2The following example shows how to display the number of times thesame path can be used for extended load balancing: PROMPT>dlnkmgr view -sys -expathusetimesTimes Same ExPath Was Used : 100KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 3The following example displays SATP information: PROMPT>dlnkmgr view -sys -satpSATP : HTI_SATP_HDLMDefault PSP : HTI_PSP_HDLM_EXLIOKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 4


The following example displays SATP claim rules: PROMPT>dlnkmgr view -sys -ruleVendor ModelHITACHI DF600F HITACHI ^OPEN-*HP ^OPEN-*KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

To Display Program Information for a Remote Management Client

-sys [-msrv|-lic|-audlog|-pstv]Displays program information for HDLM installed on a remotemanagement client.Use one of the sub-parameters (following -sys) to specify the programinformation that you want to display. If you do not specify any sub-parameters, the command displays the version and license information forHDLM on the remote management client. Table 6-8 Items of programinformation (for remote management clients) on page 6-29 shows theparameters you can specify and the displayed information.

-tDoes not display the title for each information item.

Table 6-8 Items of program information (for remote management clients)



Item Description

-msrvInformationabout the HDLMmanager

HDLM Manager Status of the HDLM manager:• Alive: Normal

• Dead: Stopped

Ver Version number of the HDLM manager

WakeupTime Startup time of the HDLM manager

-licInformationabout the HDLMlicense

License Type License type• Permanent• Temporary• Emergency

Expiration License expiration:When using a permanent license: -When using a temporary license or emergencylicense: The license expiration period is displayed inthe format: yyyy/mm/dd (ndays after). When theview -sys -lic operation is executed, (ndays




Item Description

after) appears if there are n days left until thelicense period expires.• For example, when there are 100 days left until

the license period (2006/08/21) expires, thefollowing appears:2006/08/21(100days after)

-audlogInformationabout audit logdata collectionsettings

Audit Log Settings for audit log data collection:• Whether collection is enabled

on: Enabled

off: Disabled

• Audit log data collection level:When audit log data collection is on, thecollection level that has been set is displayedwithin the parentheses following on. Thecollection level indicates a severity level. Avalue from 0 to 7 is displayed as the collectionvalue.

Audit LogCategory

The categories of audit log data to be output aredisplayed. When more than one category isdisplayed, commas (,) are used as separators.

ss: StartStopa: Authenticationca: ConfigurationAccessIf all the above categories are specified, all isdisplayed.If the collection of audit log data is disabled, ahyphen (-) is displayed.

-pstvThe display-of-the-physical-storage-system-informationsetting

Physical StorageView

The value of the display-of-the-physical-storage-system-information setting is displayed.on: Enabled

off: Disabled

Examples

Example 1The following example displays configuration information for HDLMfunctions on a remote management client: PROMPT>dlnkmgr -l view -sysHDLM Version : x.x.x-xxService Pack Version : HDLM Manager Ver WakeupTimeAlive x.x.x-xx yyyy/mm/dd hh:mm:ss


License Type ExpirationPermanent -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 2The following example displays HDLM manager information: PROMPT>dlnkmgr -l view -sys -msrvHDLM Manager Ver WakeupTimeAlive x.x.x-xx yyyy/mm/dd hh:mm:ssKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 3The following example shows how to display information about the HDLMlicense: PROMPT>dlnkmgr -l view -sys -licLicense Type ExpirationPermanent -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 4The following example shows how to display information about the auditlog settings: PROMPT>dlnkmgr -l view -sys -audlogAudit Log : offAudit Log Category : -KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 5The following example shows how to display the value of the display-of-the-physical-storage-system-information setting: PROMPT>dlnkmgr -l view -sys -pstvPhysical Storage View : offKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>


When displaying path information, if you specify either the -item or -cparameter and also specify the -path parameter, you can select the items to


display and display a summary of path information. This section describeseach parameter, path information and displayed items.


-pathWhen you specify the -path parameter and do not specify either the -c or-item parameter, the information will be displayed about the HDLMmanaged paths without abbreviating or selecting items.In the sub-parameters (following -path), you can filter the paths to belisted using -hdev and sort the list using -srt. When you omit bothparameters, the command displays information for all the paths in orderof increasing AutoPATH_IDs.For details on what is displayed in each item, see Table 6-10 PathInformation on page 6-38.AutoPATH_IDs displayed by the -path parameter depend on the sequencein which HDLM detects the paths after a host is started up. Because ofthis, make sure that you use the path name PathName to identify a path.The sub-parameters are as follows:

-pstv|-vstvIf the -pstv parameter is specified, information about the physicalstorage system is displayed. If the -vstv parameter is specified,information about the storage system recognized by the operatingsystem is displayed. If neither parameter is specified, information isdisplayed according to the value specified in the -pstv parameter ofset operations.For information about the items that are displayed differentlydepending on the specified -pstv and -vstv parameters, see Table6-6 Display items for which the display results of the view operationdiffer depending on the -pstv parameter specification on page 6-21 inParameters on page 6-16.

-hdev host-device-nameDisplays information only for the paths accessing the specified hostdevice.The host-device-name string is case-sensitive.

-stnameUse this parameter to display the model ID of the storage system inthe product ID element of the DskName field. When this parameter isomitted, the command displays the product ID or emulation type ofthe storage system instead.For details about the information displayed for product IDs, see Table6-12 Product ID displayed by the view -path operation on page 6-44.

-iemUse this parameter to add IEP to path information and displayinformation about intermittent errors.

-srt {pn|lu|cp}


Use this parameter to sort the path information in ascending order,according to the specified sorting keys.The sorting keys are as follows: the first sorting key is the name ofthe storage system (DskName), the second sorting key is the valuespecified by the -srt parameter, and the third sorting key isAutoPATH_ID.The available parameter values to specify the second sorting key are:

• pn: Path name• lu: LU number of the storage system• cp: Port number of the CHAWhen the -srt parameter is omitted, the path information is listed inascending order of AutoPATH_IDs.

-hbaportwwnDisplays port WWN information for the HBAs connected to the storagesystem.

-vmruntimenameDisplays the runtime information for paths managed by VMwarevSphere in place of the PathName item.

-vmstateDisplays the status of paths managed by VMware vSphere. For detailson VMware vSphere path statuses, see Table 2-6 CorrespondenceBetween VMware vSphere and HDLM Path Statuses on page 2-18.

-tOmits the title for each information item.

ExampleThe following example displays path information: PROMPT>dlnkmgr view -pathPaths:000002 OnlinePaths:000002PathStatus IO-Count IO-ErrorsOnline 42 0

PathID PathName DskName iLU ChaPort Status Type IO-Count IO-Errors DNum HDevName000000 0002.0000.0000000000000000.0000 HITACHI .DF600F .77010152 0191 0B Online Own 42 0 0 t10.HITACHI_770101520191000001 0005.0000.0000000000000000.0000 HITACHI .DF600F .77010152 0191 1B Online Non 0 0 0 t10.HITACHI_770101520191KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>


To display path information, by selecting a display item

-path -itemWhen you specify the -path parameter together with the -itemparameter, the command only displays the items specified by the value ofthe -item parameter.When the value of the -item parameter is omitted, only the PathID andthe Status fields are displayed.The following table lists the correspondence between the display itemsthat can be selected by using the -item parameter and the parametervalues that can be specified after the -item parameter.

Table 6-9 Correspondence between the items displayed by the dlnkmgrview -path -item command and the values of the -item parameter

Items displayed by the dlnkmgr view-path -item command

Values specified after the -itemparameter

PathID# None

PathName pnDskName dniLU luChaPort cp

Status# None

Type typeIO-Count icIO-Errors ieDNum dnuHDevName hdIEP iepHBAPortWWN hbaportwwnVmRuntimeName vmruntimenameVmState vmstateVmPathUID vmpathuidPhysical-LDEV physVirtual-LDEV virtPhysical-DskName vidPhysical-iLU vidPhysical-ChaPort vidOrg-DskName haOrg-iLU ha


#Because both PathID and Status are always displayed, you do nothave to specify any parameters.In the sub-parameters following -path -item, you can list the paths(-hdev) and sort the list (-srt). If you omit both parameters, thecommand displays information for all the paths in ascending order ofAutoPATH_IDs.These sub-parameters are:


-hdev host-device-nameDisplays information only for the paths accessing the specified hostdevice.The host-device-name string is case-sensitive.When you specify this parameter, HDevName is displayed by default. Itis not necessary to specify hd for the -item parameter.

-stnameUse this parameter to display the model ID of the storage system inthe product ID element of the DskName field. When this parameter isomitted, the command displays the product ID or emulation type ofthe storage system instead.For details about the information to be displayed for product IDs, seeTable 6-12 Product ID displayed by the view -path operation on page6-44.When you use this parameter, DskName is displayed by default. It isnot necessary to specify dn for the -item parameter.

-srt {pn|lu|cp}Use this parameter to sort the path information in ascending order,according to the specified sorting key.The sorting keys are as follows: the first sorting key is the name ofthe storage system (DskName), the second sorting key is the valuespecified by the -srt parameter, and the third sorting key isAutoPATH_ID.The available parameter values to specify the second sorting key are:


• pn: Path name• lu: LU number of the storage system• cp: Port number of the CHA

When the -srt parameter is omitted, the path information is listedin order of ascending AutoPATH_IDs.When you use this parameter, the items used for the sorting keys(DskName, AutoPATH_ID, and the item specified by thisparameter) are displayed by default. Therefore, it is not necessaryto specify these items for the -item parameter.


ExampleThe following example displays path information withVmRuntimeName, VmState, and VmPathUID selected as displayitems: PROMPT>dlnkmgr view -path -item vmruntimename vmstate vmpathuidPaths:000002 OnlinePaths:000002PathStatus IO-Count IO-ErrorsOnline 63 0

PathID VmRuntimeName Status VmState VmPathUID000000 vmhba2:C0:T0:L0 Online active fc.200000e08b90c61c:210000e08b90c61c-fc.50060e8010027a85:50060e8010027a85-t10.HITACHI_770101520191000001 vmhba5:C0:T0:L0 Online active fc.20000024ff293611:21000024ff293611-fc.50060e8010027a81:50060e8010027a81-t10.HITACHI_770101520191KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

To display path information, by abbreviating the list items

-path -cWhen you specify the -path parameter together with the -c parameter,the command selects certain items to be displayed, and shortens thecontents of each item so that the information about each path fits into asingle line on the screen.The items that are displayed are PathID, DskName, iLU, CP, Status, andType.For details on what is displayed for each item, see Table 6-10 PathInformation on page 6-38.When you use the -c parameter, the number of characters that can bedisplayed in the product ID element of the DskName field is limited to 10.When there are 11 or more characters in the product ID, the 8th andfollowing characters are abbreviated to ellipses (...).


The sub-parameters (following -path -c) are:


-stnameUse this parameter to display the model ID of the storage system inthe product ID element of the DskName field. When this parameter isomitted, the command displays the product ID or emulation type ofthe storage system instead.For details about the information about product IDs, see Table 6-12Product ID displayed by the view -path operation on page 6-44.

-srt {lu|cp}Use this parameter to sort the path information in ascending order,according to the specified sorting key.The sorting keys are as follows: the first sorting key is the name ofthe storage system (DskName), the second sorting key is the valuespecified by the -srt parameter, and the third sorting key isAutoPATH_ID.The available parameter values to specify the second sorting key are:

• lu: LU number of the storage system• cp: Port number of the CHAWhen the -srt parameter is omitted, the path information is listed inascending order of AutoPATH_IDs.


ExampleThe following example shows how to abbreviate the display ofinformation about the paths, ordered by iLU.

PROMPT>dlnkmgr view -path -c -srt luPaths:000012 OnlinePaths:000012PathStatus IO-Count IO-ErrorsOnline 1616 0

PathID DskName iLU CP Status Type000000 HITACHI .DF600F .0051 0005 0A Online Own


000003 HITACHI .DF600F .0051 0005 1A Online Non000001 HITACHI .DF600F .0051 0014 0A Online Non000004 HITACHI .DF600F .0051 0014 1A Online Own000002 HITACHI .DF600F .0051 0015 0A Online Non000005 HITACHI .DF600F .0051 0015 1A Online Own000006 HITACHI .OPEN-3 .15001 0005 1H Online Own000009 HITACHI .OPEN-3 .15001 0005 2H Online Own000007 HITACHI .OPEN-3 .15001 0015 1H Online Own000010 HITACHI .OPEN-3 .15001 0015 2H Online Own000008 HITACHI .OPEN-3 .15001 0020 1H Online Own000011 HITACHI .OPEN-3 .15001 0020 2H Online OwnKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Items of Path information

Table 6-10 Path Information on page 6-38 describes the displayed pathinformation. The following explains the table headings:

• No summary displayed: The user specifies only the -path parameter orthe -path -item parameter.

• Summary displayed: The user specifies the -path -c parameter.

Table 6-10 Path Information

Displayed Item

DescriptionNosummarydisplayed

Summarydisplayed

Paths Total number of displayed paths, indicated by a decimalnumber.

OnlinePaths Number of online paths from within the displayed paths,indicated by a decimal number. When the value of Pathsequals the value of OnlinePaths, all paths are online. If thevalue of OnlinePaths is less than that of Paths, somepaths are offline. In this case, you should check the offlinepaths and take appropriate action for any paths that havean error status.

PathStatus Status of the displayed paths. The displayed statusindicates the following:• Online: All paths are available.

• Reduced: Some paths are not available.

Reduced means that some paths might have an errorstatus, in which case you should check the status ofindividual paths and resolve the problem for any paths thathave an error status.

IO-Count Total I/O count for all the displayed paths, indicated by adecimal number. The maximum value that can be displayed


Displayed Item


Summarydisplayed

is 232 - 1 (4294967295). If the total I/O count reaches themaximum value, it will re-start from 0.

IO-Errors Total I/O error count for all the displayed paths, indicatedby a decimal number. The maximum value that can bedisplayed is 232 - 1 (4294967295). If the total I/O errorcount reaches the maximum value, it will re-start from 0..

PathID The AutoPATH_ID indicated by a decimal number.The AutoPATH_ID is assigned every time the host isrestarted.

PathName#1 - The path name, which indicates a path. When you modifythe system configuration or replace a hardware item, youshould check the path names to identify the path that willbe affected by the change. Path name consists of thefollowing four elements, separated by periods:• Host port number (hexadecimal number)• Bus number (hexadecimal number)• Target ID (hexadecimal number)• Host LU number (hexadecimal number)For details about each element of the path name and itsrepresentation in VMware vSphere, see Table 6-11Elements of a path name on page 6-44.

DskName#1 DskName Storage system name, which identifies the storage systemthat is accessed by a path.A storage system name consists of the following threeelements, separated by periods:• Vendor ID: The name of the storage system vendor

(for example, HITACHI).

• Product ID: Indicates the storage system product ID,emulation type, or model ID (for example, DF600F).

For more details, see Table 6-12 Product ID displayedby the view -path operation on page 6-44.

• Serial number: The serial number of the storagesystem (for example, 0051).

You can identify an actual storage system by referencingthe above information from the storage systemmanagement program.

iLU#1 iLU LU number in the storage system.This number combined with the storage system name(shown in DskName) identifies the LU that is accessed by apath.• For P9500 and XP7, indicated by a hexadecimal

number. The first two characters of iLU are 00, themiddle two numbers are the CU number, and the last


Displayed Item


Summarydisplayed

two characters are the internal LU number within theCU.

• For Hitachi AMS2000/AMS/WMS/SMS series andHUS100 series, indicated by a decimal number. Theentire value of iLU is the internal LU number within thestorage system. You can identify an actual LU byreferencing iLU from the storage system managementprogram.

• For Universal Storage Platform V/VM series, HitachiVirtual Storage Platform and VSP G1000indicated by ahexadecimal number. The first two characters of iLUare the number of the logical DKC (Disk Controller), themiddle two numbers are the CU number, and the lasttwo characters are the internal LU number within theCU.

ChaPort#1 CP Port number of the CHA, which identifies the CHA port thatis mounted on the storage system.You can identify an actual CHA port by referencing thisnumber from the storage system management program.

Status Status of the path• Online: Online

• Offline(C): Offline status caused by a commandoperation

• Offline(E): Offline due to an error

• Online(S): I/O operations to the primary volume (P-VOL) in an HAM environment are suppressed.

• Online(D): The paths to the primary volume (P-VOL)in an HAM environment can be recoveredautomatically.

Paths that are in Offline(E) status require correctiveaction. The appropriate action can be determined byreferring to What To Do for a Path Error on page 5-2.

Type#1 Type Attribute of the path• Own: Owner path

• Non: Non-owner path

When connecting to Universal Storage Platform V/VMseries, Virtual Storage Platform series, VSP G1000 series,Hitachi AMS2000 series#2, Hitachi SMS series#2, HUS100series#2, or HUS VM, all paths are owner paths.

IO-Count#1 - Total I/O count for the path, indicated by a decimalnumber. The maximum value that can be displayed is 232 -1 (4294967295). If the total I/O count reaches themaximum value, it will re-start from 0.To reset the IO-Count value to 0, execute the dlnkmgrcommand's clear operation. Executing the clear operation


Displayed Item


Summarydisplayed

also resets the number of I/O errors (IO-Errors) to 0. Fordetails about the clear operation, see clear (Returns thePath Statistics to the Initial Value) on page 6-3.However, a hyphen (-) is displayed when an algorithmother than the following is used:• exrr: The Extended Round Robin algorithm

• exlio: The Extended Least I/Os algorithm

• exlbk: The Extended Least Blocks algorithm

IO-Errors#1

- Total I/O error count for the path, indicated by a decimalnumber. The maximum value that can be displayed is 232 -1 (4294967295). If the total I/O error count reaches themaximum value, it will re-start from 0.To reset the IO-Errors value to 0, execute the dlnkmgrcommand's clear operation. Executing the clear operationalso clears the number of I/O operations (IO-Count) to 0.

For details about the clear operation, see clear (Returnsthe Path Statistics to the Initial Value) on page 6-3.

DNum#1 - When Dev indicates an entire LU, 0 is displayed.

HDevName#1 - Host device name.

IEP#1 - Information about the intermittent error.This item is displayed only when you specify the -iemparameter or when you specify iep for the -itemparameter.One of the following values is displayed for each path:• -

Indicates that intermittent error monitoring is disabledor the path status is Offline(C).

• A value of at least 0Indicates the number of errors that occurred duringintermittent error monitoring (the path status isOffline(E) or Online).

• *Indicates that an intermittent error occurred (automaticfailbacks do not check the path) (the path status isOffline(E)).

HBAPortWWN#1

- A 16-digit hexadecimal number indicating the WWNinformation for an HBA connected to the storage system.This item is displayed only when you specify the -hbaportwwn parameter or when you specify hbaportwwn forthe -item parameter.

VmRuntimeName#1

- Displays the runtime information for paths managed byVMware vSphere in path information fields. If you specifythe -vmruntimename parameter together with the -path


Displayed Item


Summarydisplayed

parameter, this information is displayed instead of thePathName item.

VmState#1 - The path status managed by VMware vSphere. This item isdisplayed only when you specify the -vmstate parameter orwhen you specify vmstate for the -item parameter.

• active: Online

• standby: Online

• off: Offline status caused by a command operation(Offline(C))

• dead: Offline due to an error (Offline(E))

• unavailable: Offline due to an error (Offline(E))

• perm_loss: Offline due to an error (Offline(E))

Paths that are dead, unavailable, or perm_loss requirecorrective action. The appropriate action can be determinedby referring to What To Do for a Path Error on page 5-2.

VmPathUID#

1

- The UID of the path managed by VMware vSphere. Thisitem is displayed when specified in a value of the -path -item parameter.

Physical-LDEV

- The model ID, serial number, and iLU number of a physicalvolume are separated by periods and displayed.You can identify the physical volume from this information.If the volume is not virtualized, a hyphen (-) is displayed.

Virtual-LDEV

- Displays the model ID, serial number, and iLU number of avirtual volume, separated by periods.You can identify the virtual volume from this information. Ifthe volume is not virtualized, a hyphen (-) is displayed.

Physical-DskName

- When a path is migrated using a virtual ID, displays thename of the storage system that is connected by themigration-destination path.A storage system name consists of the following threeelements, separated by periods:• Vendor ID: The name of the storage system vendor.• Product ID: Indicates the storage system product ID,

emulation type, or model name.• Serial number: The serial number of the storage

system.When a virtual ID is not used, a hyphen (-) is displayed.

Physical-iLU

- When a path is migrated using a virtual ID, displays LUnumber in the storage system that is connected by themigration-destination path.• For HUS VM, indicated by a hexadecimal number. The

first two characters of iLU are the CU number, and the


Displayed Item


Summarydisplayed

last two characters are the internal LU number withinthe CU.

• For Hitachi Virtual Storage Platform, indicated by ahexadecimal number. The first two characters of iLUare the number of the logical DKC (Disk Controller), themiddle two numbers are the CU number, and the lasttwo characters are the internal LU number within theCU.

When a virtual ID is not used, a hyphen (-) is displayed.

Physical-ChaPort

- When a path is migrated using a virtual ID, displays portnumber of the CHA that is connected by the migration-destination path.When a virtual ID is not used, a hyphen (-) is displayed.

Org-DskName

- For HAM environments, the name of the storage system onthe secondary volume (S-VOL) is displayed.A storage system name consists of the following threeelements, separated by periods:• Vendor ID: The name of the storage system vendor.• Product ID: Indicates the storage system product ID,

emulation type, or model ID.For more details, see Table 6-12 Product ID displayedby the view -path operation on page 6-44.

• Serial number: The serial number of the storagesystem.

If an HAM environment is not used, a hyphen (-) isdisplayed.

Org-iLU - For HAM environments, an LU number on the secondaryvolume (S-VOL) is displayed.• For HUS VM, indicated by a hexadecimal number. The

first two characters of iLU are the CU number, and thelast two characters are the internal LU number withinthe CU.

• For Hitachi Virtual Storage Platform, indicated by ahexadecimal number. The first two characters of iLUare the number of the logical DKC (Disk Controller), themiddle two numbers are the CU number, and the lasttwo characters are the internal LU number within theCU.

If an HAM environment is not used, a hyphen (-) isdisplayed.

Legend:- : Not displayed

#1


The path information is displayed only when a value is specified for the -path -item parameter.


Table 6-11 Elements of a path name

Element VMware vSphere representation

Host port number (example: 0000) Host ID (host port number)

Bus number (example: 0000) Channel number (bus number)

Target ID (example: 000000000000003A) Target ID

Host LU number(example: 0005) Lun (host LU number)

Table 6-12 Product ID displayed by the view -path operation

Model names of storagesystems

Product ID

Without the -stnameparameter

With the -stnameparameter

(Displays the followingfor the model name)

Hitachi AMS2000 series product identifier# AMS

Hitachi AMS series AMS

Hitachi SMS series SMS

Hitachi WMS series WMS

HUS100 series HUS100

• Hitachi UniversalStorage Platform V

• Hitachi UniversalStorage Platform VM

Emulation type# USP_V

Hitachi Virtual StoragePlatform

VSP

VSP G1000 VSP_G1000

HUS VM HUS_VM

P9500 P9500

XP7 XP7

XP20000 XP20000

XP24000 XP24000

#


If the -c parameter is specified together with the -path parameter, whenthe number of characters exceeds 10, any characters after the 7thcharacter are displayed as an ellipsis (...).


When displaying LU information, if the -item parameter, or the -c parameteris specified at the same time as the -lu parameter, you can add and displayitems and display a summary of LU information. This section describes eachparameter and the LU information and displayed items.


-luWhen neither the -c nor -item parameter is specified with the -luparameter, the information about the LU recognized by HDLM is displayedwithout selecting items to be displayed or displaying a summary. Thesorting key is iLU and its configuration information is displayed for eachLU.For details on the content of each displayed item, see Table 6-14 LUInformation on page 6-49.The sub-parameters are:


-hdev host-device-name|-pathid AutoPATH_IDDisplays information only for the paths accessing the specified hostdevice, if the -hdev parameter is specified.If the -pathid parameter is specified, only information about the LUconnected to the path with the specified AutoPATH_ID is displayed.


ExampleThe following example shows how to display the LU informationwithout selecting items to be displayed: PROMPT>dlnkmgr view -luProduct : SANRISE_AMS


SerialNumber : 77010152LUs : 1

iLU HDevName PathID Status0191 t10.HITACHI_770101520191 000000 Online 000001 OnlineKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

To display LU information (by adding items to be displayed)

-lu -itemThe items specified with the -item option are displayed among with thosedisplayed by the -lu option.When the value of the -item parameter is omitted or all is specified, allthe items, except for DPC, Physical-LDEV, Virtual-LDEV, Physical-Product, Physical-SerialNumber, Physical-iLU, and Physical-ChaPort, Org-Product, Org-SerialNumber, and Org-iLU, that can bedisplayed are displayed.The table below lists the correspondence between the display items thatcan be added by using the -item parameter and the parameter valuesthat can be specified after the -item parameter.

Table 6-13 Correspondence between the items displayed by thedlnkmgr view -lu -item command and the values of the -item

parameter

Items displayed by the dlnkmgr view-lu -item command


SLPR slprPathName pnChaPort cpCLPR clprType typeIO-Count icIO-Errors ieDNum dnuIEP iepLB lbVmPSP vmpspVmRuntimeName vmruntimenameVmState vmstate


Items displayed by the dlnkmgr view-lu -item command


DPC dpcPhysical-LDEV physVirtual-LDEV virtPhysical-Product vidPhysical-SerialNumber vidPhysical-iLU vidPhysical-ChaPort vidOrg-Product haOrg-SerialNumber haOrg-iLU haHaStat hastat

All items are displayed all

For details on the contents of each displayed item, see Table 6-14 LUInformation on page 6-49.The sub-parameters are:


-hdev host-device-name|-pathid AutoPATH_IDDisplays information only for the paths accessing the specified hostdevice, if the -hdev parameter is specified.If the -pathid parameter is specified, only information about the LUconnected to the path with the specified AutoPATH_ID is displayed.


Example 1The following example shows the LU information displayed whenChaPort, LB, VmPSP, VmRuntimeName, and VmState are specified asadditional display items:


PROMPT>dlnkmgr view -lu -item cp lb vmpsp vmruntimename vmstateProduct : SANRISE_AMSSerialNumber : 77010152LUs : 1

iLU HDevName LB VmPSP PathID VmRuntimeName ChaPort Status VmState0191 t10.HITACHI_770101520191 exlio HTI_PSP_HDLM_EXLIO 000000 vmhba2:C0:T0:L0 1B Online active 000001 vmhba5:C0:T0:L0 0B Online activeKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 2When using Hitachi AMS2000 series, Hitachi SMS series , or HUS100series storage and displaying LU information with DPC added to thedisplay items: PROMPT>dlnkmgr view -lu -item dpcProduct : HUS100SerialNumber : 9203008 LUs : 3Dynamic I/O Path Control : on*

iLU HDevName DPC PathID Status000006 t10.HITACHI_770101520191 on 000000 Online 000003 Online000007 t11.HITACHI_770101520191 off 000001 Online 000004 Online000008 t12.HITACHI_770101520191 on 000002 Online 000005 OnlineKAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

To display a summary of LU information

-lu -cWhen the -c parameter is specified with the -lu parameter, a summaryof LU configuration information is displayed on one line. The total numberof paths recognized by HDLM and the number of online paths aredisplayed for each LU. You cannot specify the -c parameter together withthe -hdev or -pathid parameter.For details on the contents of each display item, see Table 6-14 LUInformation on page 6-49.The sub-parameters are as follows:

-pstv|-vstv


If the -pstv parameter is specified, information about the physicalstorage system is displayed. If the -vstv parameter is specified,information about the storage system recognized by the operatingsystem is displayed. If neither parameter is specified, information isdisplayed according to the value specified in the -pstv parameter ofset operations.For information about the items that are displayed differentlydepending on the specified -pstv and -vstv parameters, see Table6-6 Display items for which the display results of the view operationdiffer depending on the -pstv parameter specification on page 6-21 inParameters on page 6-16.


ExampleThe following example shows how to display a summary of LUinformation (without selecting items to be displayed): PROMPT>dlnkmgr view -lu -cProduct S/N LUs iLU HDevName Paths OnlinePathsSANRISE_AMS 77010152 1 0191 t10.HITACHI_770101520191 2 2KAPL01001-I The HDLM command completed normally. Operation name = view, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Items of LU information

Table 6-14 LU Information on page 6-49 describes the displayed LUinformation. The following explains the table headings:

• No summary displayed: The user specifies the -lu parameter.• Summary displayed: The user specifies the -lu -c parameter.

Table 6-14 LU Information

Displayed itemDescriptionNo summary

displayedSummarydisplayed

Product Model ID of the storage system

SerialNumber S/N Serial number of the storage system

LUs Total number of LUs managed by HDLM amongthe LUs in the storage system

Dynamic I/O PathControl

- The setting information about the dynamic I/Opath control function is displayed for eachstorage system.




on: The dynamic I/O path control function isenabled.off: The dynamic I/O path control function isdisabled.-: The dynamic I/O path control function is notsupported.If an LU whose settings differ from the settingsbased on the system storage unit is included, *is added after the on or off being displayed.

iLU LU number in the storage system.This number combined with the storage systemname (shown in DskName) identifies the LU thatis accessed by a path.• For P9500 and XP7, indicated by a

hexadecimal number. The first twocharacters of iLU are 00, the middle twonumbers are the CU number, and the lasttwo characters are the internal LU numberwithin the CU.

• For Hitachi AMS2000/AMS/WMS/SMS seriesand HUS100 series, indicated by a decimalnumber. The entire value of iLU is theinternal LU number within the storagesystem. You can identify an actual LU byreferencing iLU from the storage systemmanagement program.

• For Universal Storage Platform V/VM series,Hitachi Virtual Storage Platform, and VSPG1000, indicated by a hexadecimal number.The first two characters of iLU are thenumber of the logical DKC (Disk Controller),the middle two numbers are the CU number,and the last two characters are the internalLU number within the CU.

SLPR#1 - The number of the SLPR to which an LU belongs,indicated by a number from 0 to 31. A hyphen(-) is displayed if the storage logical partitionfunctionality for the storage system for thetarget LU is not supported.

HDevName HDevName Host device name.

DPC - The setting information about the dynamic I/Opath control function is displayed for each LU.on: The dynamic I/O path control function isenabled.off: The dynamic I/O path control function isdisabled.




-: The dynamic I/O path control function is notsupported.

PathID - The AutoPATH_ID. AutoPATH_ID is assignedevery time the host is restarted.

PathName#1 - The path name, which indicates a path. Whenyou modify the system configuration or replace ahardware item, you should check the pathnames to identify the path that will be affectedby the change. Path name consists of thefollowing four elements, separated by periods:• Host port number (hexadecimal number)• Bus number (hexadecimal number)• Target ID (hexadecimal number)• Host LU number (hexadecimal number)For details about each element of the path nameand its representation in VMware vSphere, seeTable 6-11 Elements of a path name on page6-44.

ChaPort#1 - Port number of the CHA, which identifies theCHA port that is mounted on the storage system.You can identify an actual CHA port byreferencing this number from the storage systemmanagement program.

CLPR#1 - The number of the CLPR to which the CHAbelongs, indicated by a number from 0 to 31.Note that a hyphen (-) is displayed if thefollowing items are subject to display:• CHA ports in the storage system that do not

support the cache logical partition function• Paths connected to the Snapshot Image of

the Copy-on-write Snapshot of the HitachiAMS2000/AMS/WMS/SMS series

Status - Status of the path• Online: Online

• Offline(C): Offline status caused by acommand operation

• Offline(E): Offline due to an error

• Online(S): I/O operations to the primaryvolume (P-VOL) in an HAM environment aresuppressed.

• Online(D): The paths to the primaryvolume (P-VOL) in an HAM environment canbe recovered automatically.

Paths that are in Offline(E) status requirecorrective action. The appropriate action can be




determined by referring to What To Do for a PathError on page 5-2.

Type#1 - Attribute of the path• Own: Owner path

• Non: Non-owner path

When connecting to Universal Storage PlatformV/VM series, Virtual Storage Platform series, VSPG1000 series, Hitachi AMS2000 series#2, HitachiSMS series#2, HUS100 series#2, or HUS VM, allpaths are owner paths.

IO-Count#1 - Total I/O count for a path. The maximum valuethat can be displayed is 232 - 1 (4294967295). Ifthe total I/O count reaches the maximum value,it is reset, and the count is re-started from 0. Toreset the IO-Count value to 0, execute thedlnkmgr command's clear operation. Executingthe clear operation also resets the number ofI/O errors (IO-Errors) to 0. For details aboutthe clear operation, see clear (Returns the PathStatistics to the Initial Value) on page 6-3.However, a hyphen (-) is displayed when analgorithm other than the following is used:• exrr: The Extended Round Robin algorithm



IO-Errors#1 - Total I/O error count for a path. The maximumvalue that can be displayed is 232 - 1(4294967295). If the total I/O error countreaches the maximum value, it is reset, and thecount is re-started from 0. To reset the IO-Errors value to 0, execute the dlnkmgrcommand's clear operation. Executing theclear operation also clears the number of I/Ooperations (IO-Count) to 0. For details about theclear operation, see clear (Returns the PathStatistics to the Initial Value) on page 6-3.

DNum#1 - When Dev indicates an entire LU, 0 is displayed.

IEP#1 - The displayed paths are assumed to be in anintermittent error status and checked whetherthose paths are to be operated for automaticfailbacks.One of the following values is displayed for eachpath:• -: Indicates that intermittent error

monitoring is disabled or the path status isOffline(C).




• A value of at least 0: Indicates the numberof errors that occurred during intermittenterror monitoring.

• *: Indicates that an intermittent erroroccurred (automatic failback does not checkthe path).

LB#1 - The algorithm being used for load balancing.• exrr: The Extended Round Robin algorithm



• vmwfixed: The Fixed algorithm (VMware)

• vmwmru: The Most Recently Used algorithm(VMware)

• vmwrr: The Round Robin algorithm(VMware)

• unknown: An algorithm other than the above

VmPSP#1 - The PSP currently in effect.

VmRuntimeName#1 - In path information fields, displays the pathruntime information managed by VMwarevSphere.

VmState#1 - The path status managed by VMware vSphere.• active: Online

• standby: Online

• off: Offline status caused by a commandoperation (Offline(C))

• dead: Offline due to an error (Offline(E))

• unavailable: Offline due to an error(Offline(E))

• perm_loss: Offline due to an error(Offline(E))

Paths that are dead, unavailable, or perm_lossrequire corrective action. The appropriate actioncan be determined by referring to What To Dofor a Path Error on page 5-2.

Physical-LDEV - The model ID, serial number, and iLU number ofa physical volume are separated by periods anddisplayed.You can identify the physical volume from thisinformation. If the volume is not virtualized, ahyphen (-) is displayed.

Virtual-LDEV - Displays the model ID, serial number, and iLUnumber of a virtual volume, separated byperiods.




You can identify the virtual volume from thisinformation. If the volume is not virtualized, ahyphen (-) is displayed.

Physical-Product - When a path is migrated using a virtual ID,displays model ID of the storage system that isconnected by the migration-destination path.When a virtual ID is not used, a hyphen (-) isdisplayed.

Physical-SerialNumber

- When a path is migrated using a virtual ID,displays serial number of the storage systemthat is connected by the migration-destinationpath.When a virtual ID is not used, a hyphen (-) isdisplayed.

Physical-iLU - When a path is migrated using a virtual ID,displays LU number in the storage system that isconnected by the migration-destination path.• For HUS VM, indicated by a hexadecimal

number. The first two characters of iLU arethe CU number, and the last two charactersare the internal LU number within the CU.

• For Hitachi Virtual Storage Platform,indicated by a hexadecimal number. Thefirst two characters of iLU are the number ofthe logical DKC (Disk Controller), the middletwo numbers are the CU number, and thelast two characters are the internal LUnumber within the CU.

When a virtual ID is not used, a hyphen (-) isdisplayed.

Physical-ChaPort - When a path is migrated using a virtual ID,displays port number of the CHA that isconnected by the migration-destination path.When a virtual ID is not used, a hyphen (-) isdisplayed.

- Paths Total number of the paths recognized by HDLMfor the LU to be displayed.

- OnlinePaths Number of available paths in the displayedpaths, indicated by a decimal number. When thevalue of Paths equals the value of OnlinePaths,all paths are online. If the value of OnlinePathsis less than that of Paths, some paths areoffline. In this case, you should check the offlinepaths and take appropriate action for any pathsthat have an error status.




Org-Product - For HAM environments, the model ID of thestorage system on the secondary volume (S-VOL) is displayed.If an HAM environment is not used, a hyphen (-)is displayed.

Org-SerialNumber - For HAM environments, the serial number of thestorage system on the secondary volume (S-VOL) is displayed.If an HAM environment is not used, a hyphen (-)is displayed.

Org-iLU - For HAM environments, an LU number in thestorage system on the secondary volume (S-VOL) is displayed.• For HUS VM, indicated by a hexadecimal

number. The first two characters of iLU arethe CU number, and the last two charactersare the internal LU number within the CU.

• For Hitachi Virtual Storage Platform,indicated by a hexadecimal number. Thefirst two characters of iLU are the number ofthe logical DKC (Disk Controller), the middletwo numbers are the CU number, and thelast two characters are the internal LUnumber within the CU.

If an HAM environment is not used, a hyphen (-)is displayed.

Legend:- : Not displayed

#1This information is displayed when one of the following conditions exist:- The user selected the item to be displayed by using the -lu -itemparameter.- all was specified.- No value was specified for the parameter.


To display the format of the view operation

-helpUse this parameter to display the view operation format.


Example 1

The following example displays the format of the operation for both a hostand remote management client: PROMPT>dlnkmgr view -helpview: Format dlnkmgr [Host-Connection-Options] view -sys [ -sfunc | -satp | -rule ] [-t] dlnkmgr [Host-Connection-Options] view -path [-iem] [-hbaportwwn] [-vmruntimename] [-vmstate] [ -hdev HostDeviceName ] [-stname] [-srt {pn | lu | cp}] [-t] dlnkmgr [Host-Connection-Options] view -path -item [pn] [dn] [lu] [cp] [type] [ic] [ie] [dnu] [hd] [iep] [hbaportwwn] [vmruntimename] [vmstate] [vmpathuid] [phys] [virt] [vid] [ha] [-pstv | -vstv] [ -hdev HostDeviceName ] [-stname] [-srt {pn | lu | cp}] [-t] dlnkmgr [Host-Connection-Options] view -path -c [-pstv | -vstv] [-stname] [-srt {lu | cp}] [-t] dlnkmgr [Host-Connection-Options] view -lu [-pstv | -vstv] [ -hdev HostDeviceName | -pathid AutoPATH_ID ] [-t] dlnkmgr [Host-Connection-Options] view -lu -item [ [slpr] [pn] [cp] [clpr] [type] [ic] [ie] [dnu] [iep] [dpc] [lb] [vmpsp] [vmruntimename] [vmstate] [phys] [virt] [vid] [ha] [hastat] | all ] [-pstv | -vstv] [ -hdev HostDeviceName | -pathid AutoPATH_ID ] [-t] dlnkmgr [Host-Connection-Options] view -lu -c [-pstv | -vstv] [-t] dlnkmgr -l view -sys [ -msrv | -lic | -audlog ] [-t] Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]KAPL01001-I The HDLM command completed normally. Operation name = help, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 2

The following example displays the format of the operation for a host: PROMPT>dlnkmgr -s host-name -u user-name -p password view -helpview: Format dlnkmgr [Host-Connection-Options] view -sys [ -sfunc | -satp | -rule ] [-t] dlnkmgr [Host-Connection-Options] view -path [-iem] [-hbaportwwn] [-vmruntimename] [-vmstate] [ -hdev HostDeviceName ] [-stname] [-srt {pn | lu | cp}] [-t]


dlnkmgr [Host-Connection-Options] view -path -item [pn] [dn] [lu] [cp] [type] [ic] [ie] [dnu] [hd] [iep] [hbaportwwn] [vmruntimename] [vmstate] [vmpathuid] [phys] [virt] [vid] [ha] [-pstv | -vstv] [ -hdev HostDeviceName ] [-stname] [-srt {pn | lu | cp}] [-t] dlnkmgr [Host-Connection-Options] view -path -c [-pstv | -vstv] [-stname] [-srt {lu | cp}] [-t] dlnkmgr [Host-Connection-Options] view -lu [-pstv | -vstv] [ -hdev HostDeviceName | -pathid AutoPATH_ID ] [-t] dlnkmgr [Host-Connection-Options] view -lu -item [ [slpr] [pn] [cp] [clpr] [type] [ic] [ie] [dnu] [iep] [dpc] [lb] [vmpsp] [vmruntimename] [vmstate] [phys] [virt] [vid] [ha] [hastat] | all ] [-pstv | -vstv] [ -hdev HostDeviceName | -pathid AutoPATH_ID ] [-t] dlnkmgr [Host-Connection-Options] view -lu -c [-pstv | -vstv] [-t] Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]KAPL01001-I The HDLM command completed normally. Operation name = help, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

Example 3

The following example displays the format of the operation for a remotemanagement client: PROMPT>dlnkmgr -l view -helpview: Format dlnkmgr -l view -sys [ -msrv | -lic | -audlog ] [-t]KAPL01001-I The HDLM command completed normally. Operation name = help, completion time = yyyy/mm/dd hh:mm:ssPROMPT>

refresh (Applies Storage System Settings to HDLM)The refresh operation applies the storage system settings to HDLM.

Format

To Apply Storage System Settings to HDLM

dlnkmgr [-s host-name -u user-name -p password] refresh -gad


To Display the Format of the refresh Operation

dlnkmgr [-s host-name -u user-name -p password] refresh -help

Parameters

To Apply Storage System Settings to HDLM

-gadThe non-preferred path option that is set to the paths to global-activedevice pair volumes is applied to the HDLM path attribute. A path forwhich the non-preferred path option is set becomes a non-owner path,and a path for which the non-preferred path option is not set becomes anowner path.If you specify the -gad parameter for the refresh operation, make surethe statuses of all paths to global-active device pair volumes are Online.If you restart the host, the settings at the time of restart are applied tothe HDLM path attribute.

ExampleTo apply the attribute of a path to a global-active device volume:

PROMPT>dlnkmgr view -lu -item type physProduct : VSP_G1000SerialNumber : 10051LUs : 1

iLU HDevName PathID Status Type Physical-LDEV001910 naa.60060e80072743000030274300001910 000000 Online Own VSP_G1000.10051.001910 000001 Online Own VSP_G1000.10051.001910 000002 Online Own VSP_G1000.10057.001A10 000003 Online Own VSP_G1000.10057.001A10KAPL01001-I The HDLM command completed normally. Operation name = view(-vstv), completion time = yyyy/mm/dd hh:mm:ssPROMPT>

PROMPT>dlnkmgr refresh -gadKAPL01001-I The HDLM command completed normally. Operation name = view(-vstv), completion time = yyyy/mm/dd hh:mm:ssPROMPT>

PROMPT>dlnkmgr view -lu -item type physProduct : VSP_G1000SerialNumber : 10051LUs : 1

iLU HDevName PathID Status Type Physical-LDEV001910 naa.60060e80072743000030274300001910 000000 Online Own VSP_G1000.10051.001910


000001 Online Own VSP_G1000.10051.001910 000002 Online Non VSP_G1000.10057.001A10 000003 Online Non VSP_G1000.10057.001A10KAPL01001-I The HDLM command completed normally. Operation name = view(-vstv), completion time = yyyy/mm/dd hh:mm:ssPROMPT>

To Display the Format of the refresh Operation

-helpUse this parameter to display the format of the refresh operation.

Example PROMPT>dlnkmgr refresh -helprefresh: Format dlnkmgr [Host-Connection-Options] refresh -gad Host-Connection-Options: [ -s SERVER | --server=SERVER ] [ -u USERNAME | --username=USERNAME ] [ -p PASSWORD | --password=PASSWORD ]KAPL01001-I The HDLM command completed normally. Operation name = refresh, completion time = yyyy/mm/dd hh:mm:ssPROMPT>


7Utility Reference

This chapter explains the utilities used by HDLM.

□ Overview of the Utilities

□ The DLMgetras Utility for Collecting HDLM Error Information

□ The dlmrmcenv Utility for Configuring HDLM Remote Management ClientEnvironments

□ The installhdlm Utility for Installing HDLM

□ The removehdlm Utility for Removing HDLM

Utility Reference 7-1Hitachi Dynamic Link Manager (for VMware®) User Guide

Overview of the UtilitiesHDLM provides the following utilities:

• The DLMgetras utility for collecting HDLM error informationWhen an error occurs, this utility collects the files that contain theinformation that you need to submit to your HDLM vendor or maintenancecompany. For details about the DLMgetras utility, see The DLMgetrasUtility for Collecting HDLM Error Information on page 7-2.

• The utility for configuring HDLM remote management client environments(dlmrmcenv)If you are managing HDLM by using Global Link Manager, this utilityregisters a managed host's user account information on a remotemanagement client. For details about the dlmrmcenv utility, see Thedlmrmcenv Utility for Configuring HDLM Remote Management ClientEnvironments on page 7-7.

• The utility for installing HDLM (installhdlm)This utility performs a new installation, upgrade installation, or re-installation of HDLM in the unattended installation mode. In addition,information set during installation can be displayed. For details about theinstallhdlm utility, see The installhdlm Utility for Installing HDLM onpage 7-8.

• The utility for removing HDLM (removehdlm)This utility removes HDLM normally, or in unattended removal mode. Fordetails about the removehdlm utility, see The removehdlm Utility forRemoving HDLM on page 7-11.

The DLMgetras Utility for Collecting HDLM Error InformationThis utility collects information that is needed to analyze HDLM errors thathave occurred: information such as integrated trace files, trace files,definition files, and OS information.

Whenever the host is restarted, some of the information that is collected bythe DLMgetras utility will be cleared. As a result, whenever an error occurs,immediately execute this utility to avoid losing any valuable information.

FormatExecute this utility from the remote management client, in the followingformat: DLMgetras {-s host-name -u user-name -p password [folder-to-which-collected-information-is-output] [-eventlogtime yyyy/mm/dd | -eventlogsize {all | maximum-file-length}] | -h} You can also use lower-case characters as follows: dlmgetras {-s host-name -u user-name -p password [folder-to-which-

7-2 Utility ReferenceHitachi Dynamic Link Manager (for VMware®) User Guide

collected-information-is-output] [-eventlogtime yyyy/mm/dd | -eventlogsize {all | maximum-file-length}] | -h}

Parametershost-name

Specify the host name for which to collect error information.

user-nameSpecify the user name used to log in to the host.

passwordSpecify the password used to log in to the host.

folder-to-which-collected-information-is-outputSpecify the output folder for the information that is to be collected by theDLMgetras utility. The output-destination folders shown in Table 7-1 Listof Error Information Collected by the DLMgetras Utility for CollectingError Information on page 7-4 are created in a folder of your choosing,and the information is then stored in the output-destination folders.

-eventlogtime yyyy/mm/ddThe utility obtains logs from each application, system, and security eventlog. The logs obtained are those output after 00:00 on the dateyyyy/mm/dd. Specify the date in the yyyy/mm/dd format.

-eventlogsize {all | maximum-file-length}all

Logs from all applications, systems, and security event logs areobtained.

maximum-file-lengthThe utility obtains logs from each application, system, and securityevent log. The logs are obtained, starting from the most recent log,until the log size reaches maximum-file-length. Specify the log size inMB. The specifiable value ranges from 1 to 4096.

-hDisplays the format of the DLMgetras utility.

Note:

¢ You cannot specify the -eventlogsize {all | maximum-file-length} parameter together with the -eventlogtime yyyy/mm/ddparameter.

¢ If neither the -eventlogsize {all | maximum-file-length}parameter nor the -eventlogtime yyyy/mm/dd parameter arespecified, the utility's default is to obtain a maximum of 8 MB of eventlog data.

¢ If the specified folder to which collected information is output alreadyexists, an overwrite confirmation message is displayed. Responding


by entering y instructs the DLMgetras utility to overwrite the existingfiles; entering n (or anything other than y) instructs the utility toterminate without executing.In the latter case, you can either rename the existing folder before re-executing the utility, or you can execute the utility with a differentfolder name specified.

¢ Windows 7, Windows Server 2008, and Windows Vista support UserAccount Control (UAC). Therefore, if you execute the DLMgetras utilityas a user other than Administrator, execute it from theAdministrator: Command Prompt window.

List of Collected Error InformationThe following table lists the types of error information collected in the targeterror information collection folder by the DLMgetras utility, which collectsHDLM error information.

Table 7-1 List of Error Information Collected by the DLMgetras Utility forCollecting Error Information

Directory that storescollected files#1 Files Explanation

Just under the folder to whichcollected information is output

getrasn.log The log file generated whenDLMgetras is executed.

folder-to-which-collected-information-is-output\HDLM-installation-destination-drive-name_\Program Files\HITACHI\DynamicLinkManager#2

hdlmversion HDLM version number

folder-to-which-collected-information-is-output\HDLM-installation-destination-drive-name_\Program Files\HITACHI\DynamicLinkManager\config#2

All files under config HDLM settings file

folder-to-which-collected-information-is-output\HDLM-installation-destination-drive-name_\Program Files\HITACHI\DynamicLinkManager\host#2

All files under host Host settings file or log file

folder-to-which-collected-information-is-output\HDLM-installation-destination-drive-name_\Program Files\HITACHI\DynamicLinkManager\log#2

All files under log HDLM log

Integrated trace file outputfolder specified in the HitachiNetwork Objectplaza TraceLibrary utility

hntrn.log#4 Integrated trace file(HNTRLib2)



(Default: folder-to-which-collected-information-is-output\installation-destination-drive-name_\Program Files#3\HITACHI\HNTRLib2\spool)

folder-to-which-collected-information-is-output\getrasinfo

application-list.txt List of installation information

dirHdlmRoot.txt All the folders and the list offiles in the HDLM installationdestination folder

dirSystemRoot.txt All the folders and the list offiles in the Windowsinstallation destination folder

dlmmgr-lic.txt Result of the dlnkmgr -lview -sys -lic command

dlmmgr-lu.txt Result of the dlnkmgr view -lu -item pn cp type ic iednu slpr clpr lb vmpspvmruntimename vmstate dpccommand

dlmmgr-lu-all.txt Result of the dlnkmgr view -lu -item all command

dlmmgr-path.txt Result of the dlnkmgr view -path -hbaportwwn command

dlmmgr-path-iem.txt Result of the dlnkmgr view -path -iem command

dlmmgr-path-item.txt Result of the dlnkmgr view -path -item pn dn lu cptype ic ie dnu hd iephbaportwwn vmruntimenamevmstate vmpathuidcommand

dlmmgr-sys.txt System information for thehost or remote managementclient, version information forHNTRLib (HNTRLib2) that isinstalled on the remotemanagement client

dlm-reg.txt Contents of the HDLM registry

esxcli.txt Host information

hntrlib-reg.txt Contents of the HNTRLibregistry

path_environ.log Environment variable Pathinformation



sysdllexe.txt Version information,timestamps for PE formatfiles, last modification dates,and file size information forexecutable files installed inthe HDLM directory, HNTRLib2directory, Hitachi commondirectory, and systemdirectory.

systeminfo.txt System information

wevApplication.evtxwevApplication.txt

Event log for applications

wevSecurity.evtxwevSecurity.txt

Event log for security

wevSetup.evtxwevSetup.txt

Event log for setup programs

wevSystem.evtxwevSystem.txt

Event log for the system

winmsd.txt Windows system information

folder-to-which-collected-information-is-output\hbsainfo

All files under hbsainfo Error information of a HitachiCommand Suite product otherthan HDLM

folder-to-which-collected-information-is-output\installation-destination-drive-name_

hdlmvminst.log HDLM installation log

#1The target error information collection folder is created in the folder towhich collected information is output. The user specifies the folder towhich collected information is output when executing the DLMgetrasutility.If you execute the DLMgetras utility without specifying the folder to whichcollected information is output, the default for the folder to whichcollected information is output is Windows-installation-destination-drive\hdlmtemp\hdlmgetras nn, where nn is a number from 00 to 99.

#2The underlined part indicates the folder specified during installation

#3For Windows 7 (x64) , Windows Server 2008, and Windows Vista (x64),Program Files is Program Files (x86).

#4


File names are created by using the value in the Hitachi NetworkObjectplaza Trace Library utility's Output (folder and prefix), adding2 onto the end, and then adding a file number onto the end of that. Thedefault file names range from hntr21.log to hntr216.log. Note that 2 ispart of the integrated trace file name and does not represent part of thefile number.

The dlmrmcenv Utility for Configuring HDLM RemoteManagement Client Environments

If you are managing HDLM by using Global Link Manager, this utility registersthe managed host's user account information on the remote managementclient.

To execute the dlmrmcenv utility, the Credential Store file must already be onthe remote management client#.

#The Credential Store file is managed by the VMware vSphere CLI, andcontains host information (host name, user name, and password).The default storage location of the Credential Store file is as follows: %APPDATA%\VMware\credstore\vicredentials.xml To create the Credential Store file, execute the VMware vSphere CLIscript (credstore_admin.pl).

FormatExecute the dlmrmcenv utility from VMware vSphere CLI.

dlmrmcenv {[--username "user-name"] [--credstore "Credential-Store-file-path"] | --output | -h}

Parameters--username "user-name"

Specifies the name of the user account that was created on the host.If the name of the user account that was created is GLMUser, thisparameter can be omitted.

--credstore "Credential-Store-file-path"Specifies the path of the Credential Store file that is stored on the remotemanagement client.If the Credential Store file is stored in the default folder, this parametercan be omitted.

--output


Displays the name of the user account that is registered on the remotemanagement client, as well as the Credential Store file path.

Example: PROMPT>dlmrmcenv --outputESXiUserName=GLMUserCredentialStoreFilePath="C:\Documents and Settings\xxxxxxxx\Application Data\VMware\credstore\vicredentials.xml"KAPL20907-I The dlmrmcenv utility completed normally.PROMPT>

-hDisplays the format for running the dlmrmcenv utility.

The installhdlm Utility for Installing HDLMThe installhdlm utility can perform a new installation, upgrade installation,or re-installation of HDLM in the unattended installation mode. How the utilityshould respond during an installation, and the HDLM function settings mustbe predefined in an installation-information settings file.

You can also use this utility later to check the information that was set duringinstallation.

The utility is stored in the following location:

drive-containing-installation-DVD-ROM:\HDLM_VMware\DLMToolsFor details about the procedure for performing an unattended installation, seeUnattended installation on remote management client on page 3-8 inPerforming a New Installation of HDLM on page 3-7.

Formatinstallhdlm {-f installation-information-settings-file-name | -v| -h}

Parameters-f installation-information-settings-file-name

Sets the information required to perform an installation.For details about the installation-information settings file, see Contents ofan Installation-Information Settings File on page 7-9.

-vDisplays the information that was set during installation.If the installation was performed without using the unattended installationfunctionality, the information specified in a dialog box is displayed.

Example:


PROMPT>installhdlm -vinstalldir=C:\Program Files\HITACHI\DynamicLinkManagerforVMwarePROMPT>

For an explanation of each display item, see Table 7-2 Keys That Can BeDefined in the [INSTALLATION_SETTINGS] Section on page 7-9.

-hDisplays the format of the installhdlm utility.

Contents of an Installation-Information Settings FileFor information about setting the installation-information settings file, seeUnattended installation on remote management client on page 3-8 inPerforming a New Installation of HDLM on page 3-7.

[INSTALLATION_SETTINGS] section

This section defines operation information for the installhdlm utility. Do notmodify any definitions of items that are not listed in Table 7-2 Keys That CanBe Defined in the [INSTALLATION_SETTINGS] Section on page 7-9.

The following table lists and describes the keys defined in the[INSTALLATION_SETTINGS] section.

Table 7-2 Keys That Can Be Defined in the [INSTALLATION_SETTINGS]Section

Key name Description

Necessity ofdefinition

Maximum

character

length#

1

Newinstallat

ion

Upgrade

installation orRe-

installation

installfile_location

Specify the absolute path name ofthe drive in which the installationDVD-ROM is inserted. If this key isomitted, the installer uses thefollowing folder:drive-containing-installation-DVD-ROM:\HDLM_VMware

Optional Optional 100

workdir Specify an absolute path to anoutput folder. Installation logs andprocessing files are output to thisfolder.#2, #3 If this key is omitted,

Optional Optional 100


Key name Description

Necessity ofdefinition

Maximum

character

length#

1

Newinstallat

ion

Upgrade

installation orRe-

installation

the installer uses the folder paththat has been defined in the TMPor TEMP environment variable.

licensekeyfile Specify an absolute path to alicense key file stored on theremote management client.#2, #3

If this key is omitted, the installeruses the following license key file:Windows-installation-drive:\hdlm_license

Optional#4

Optional#4

100

installdir Specify an absolute path to aninstallation destination folder forHDLM.#2, #3 If this key is omitted,the installer uses the followingfolder:Windows-installation-drive:\Program Files\HITACHI\DynamicLinkManagerforVMware#

5

Optional Notrequired

100

Legend:Optional: If no key or setting value is specified, the installer uses thedefault value.Not required: The specification of any key or setting value is unnecessary.If a key or setting value is specified for the key, the installer ignores thespecified value.

#1If a value exceeds the maximum length, an error will occur.

#2If a value is not of an allowable type, an error will occur.

#3The value to be specified does not have to be enclosed within doublequotation marks ("), even if the value includes space characters.

#4When you perform a new installation of HDLM, or when you perform anupgrade installation and the license is expired, you must prepare thelicense key file.


#5In Windows 7 (x64), Windows Server 2008, or Windows Vista (x64), theinstaller uses the following folder:Windows-installation-drive:\Program Files (x86)\HITACHI\DynamicLinkManagerforVMware

The following shows an example of an installation-information settings file. [INSTALLATION_SETTINGS]installfile_location=workdir=licensekeyfile=C:\temp\hdlm_licenseinstalldir=D:\Program Files\HITACHI\DynamicLinkManagerforVMware Note:

¢ If a hash mark (#) is placed at the beginning of a line in theinstallation-information settings file, that line is assumed to be acomment.

¢ If you do not want to specify a key or setting value, enter a hashmark (#) at the beginning of that particular line.

About the Log FileDuring an unattended installation, information about the installation progressis output to the log file named installhdlm.log.

The following explains the installhdlm.log file:

• The installhdlm.log file is created in the folder specified by theworkdir key in the installation-information settings file.

• If the installhdlm.log file already exists, log data will be appended tothe file. For details about the capacity of the log output folder, seeUnattended installation on remote management client on page 3-8 inPerforming a New Installation of HDLM on page 3-7.

Notes:

• The installhdlm.log file is not deleted when HDLM is removed. If thefile is no longer necessary, delete it manually.

• Creation of the installhdlm.log file might fail if, for example, the diskdoes not have sufficient unused capacity. If this happens, a message willbe output immediately before the installhdlm utility terminates.

The removehdlm Utility for Removing HDLMThe removehdlm utility removes HDLM. If you execute the removehdlm utilitywith the -s parameter specified, no dialog boxes will be displayed during anunattended removal.


Formatremovehdlm [-s | -h]

Parameters-s

Executes an unattended removal.

-hDisplays the format of the removehdlm utility.

If you execute the removehdlm utility without any parameters specified,dialog boxes will appear, such as those providing notes on removal andindicating the completion of the removal.

Note:

¢ After the removehdlm utility has been executed and the remotemanagement client restarted, the utility is automatically deleted.

¢ After executing the removehdlm utility, check the messages output tothe command prompt and the hdlmvmuninst.log file to make surethat HDLM has been removed. The hdlmvmuninst.log file is outputdirectly under the drive on which Windows is installed.


8Messages

This chapter describes the format and meaning of the message IDs, and alsothe terms used in the messages and message explanations. For details on themeaning of the return codes output by HDLM when it receives a request fromGlobal Link Manager and measures to take for them, see Return Codes forHitachi Command Suite Common Agent Component on page 8-61.

□ Before Viewing the List of Messages

□ KAPL01001 to KAPL02000











□ Return Codes for Hitachi Command Suite Common Agent Component

Messages 8-1Hitachi Dynamic Link Manager (for VMware®) User Guide

Before Viewing the List of MessagesThis section explains the following information that is needed to locatemessages and understand the explanations in the sections from KAPL01001to KAPL02000 on page 8-3.

• Format and meaning of the message IDs• Terms used in the messages and message explanations

The information is explained below.

Format and Meaning of Message IDsEach message has a message ID. The following table shows the format andmeaning of message IDs.

Table 8-1 Format and Meaning of the Message ID KAPLnnnnn-l

Format Meaning

KAPL Indicates that the message is an HDLM message.

nnnnn Message serial number for the module

l Message level• C: Critical

Fatal errors that may stop the system.• E: Error

Errors that adversely affect the system. This type of error can be avoidedby performing a failover or other countermeasures.

• W: Warning

Errors that enable the system to continue but, if left, might cause thesystem to improperly operate.

• I: Information

Information that simply indicates the operating history when the systemis operating normally.

Terms Used in Messages and Message ExplanationsThe following table shows the terms that appear in messages and the termsthat are used for explanation (meaning, description, and handling) of themessages.

Table 8-2 Terms Used in the Messages and Message Explanations

Terms Meaning

aa...aa Variable (If a message contains two or more variables, they aredisplayed as bb...bb, cc...cc, and so on.)

Operation name The operation name that is input after dlnkmgr in the command.

8-2 MessagesHitachi Dynamic Link Manager (for VMware®) User Guide

KAPL01001 to KAPL02000Message ID Message Text Explanation

KAPL01001-I The HDLM command completednormally. Operation name =aa...aa, completion time =bb...bb

DetailsThe HDLM command completedsuccessfully.When the view -path, or view -lu operation is executed, view(-pstv) is displayed if the PhysicalStorage View is disabled, andview(-vstv) is displayed if thePhysical Storage View is disabled.aa...aa: Specified operation namebb...bb: Year/month/dayhour:minute:second

ActionNone.

KAPL01002-I The HDLM command started.Operation name = aa...aa

DetailsThe HDLM command wasexecuted.aa...aa: Specified operation name

ActionNone.

KAPL01003-W No operation name is specified. DetailsAn operation name is missing.

ActionSpecify the operation name, andthen retry.

KAPL01004-W The operation name is invalid.Operation name = aa...aa

Detailsaa...aa: Specified operation name

ActionExecute the help operation of theHDLM command (dlnkmgr) tocheck the operation name, andthen retry. For details on the helpoperation, see help (Displays theOperation Format) on page 6-5.

KAPL01005-W A parameter is invalid.Operation name = aa...aa,parameter = bb...bb

Detailsaa...aa: Specified operation namebb...bb: Specified parameter

ActionExecute help operation-name ofthe HDLM command (dlnkmgr) tocheck the parameter, and thenretry. For details on the helpoperation, see help (Displays theOperation Format) on page 6-5.


Message ID Message Text Explanation

KAPL01006-W A necessary parameter is notspecified. Operation name =aa...aa

DetailsThe specified operation does notcontain the necessary parameter.aa...aa: Specified operation name

ActionExecute help operation-name ofthe HDLM command (dlnkmgr) tocheck the parameter. Specify thecorrect parameter, and then retry.For details on the help operation,see help (Displays the OperationFormat) on page 6-5.

KAPL01007-W A duplicate parameter isspecified. Operation name =aa...aa, parameter = bb...bb

Detailsaa...aa: Specified operation namebb...bb: Duplicate parameter

ActionDelete the duplicate parameter,and then retry.

KAPL01008-W A necessary parameter value isnot specified. Operation name =aa...aa, parameter = bb...bb

Detailsaa...aa: Specified operation namebb...bb: Parameter name

ActionSpecify the parameter value, andthen retry.

KAPL01009-W A parameter value is invalid.Operation name = aa...aa,parameter = bb...bb, parametervalue = cc...cc, Valid value =dd...dd

Detailsaa...aa: Specified operation namebb...bb: Parameter namecc...cc: Specified parameter valuedd...dd: Specifiable parametervalue range

ActionSpecify a correct value for theparameter, and then retry.

KAPL01013-E An error occurred in internalprocessing of the HDLMcommand. Operation name =aa...aa details = bb...bb

DetailsAn error unrelated to a useroperation occurred duringcommand processing.aa...aa: Specified operation namebb...bb: The name of the functionand processing on which the erroroccurred

ActionExecute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenance



company if there is a maintenancecontract for HDLM. For details onthe DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL01014-W No authority to execute theHDLM command. Operationname = aa...aa

DetailsYou do not have the administratorpermissions necessary to executethe HDLM command.aa...aa: Specified operation name

ActionExecute the command as a userwith Administrators grouppermissions.

KAPL01016-W The target CHA port was notfound. Operation name =aa...aa

DetailsThe path ID indicated by -pathidand required by the -chaparameter is not an object ofHDLM management.aa...aa: offline or online

ActionExecute the view operation of theHDLM command (dlnkmgr view -path), and then check the valuedisplayed in ChaPort. Specify anAutoPath_ID that passes throughthe relevant CHA port, and thenretry. For details on the viewoperation, see view (DisplaysInformation) on page 6-23.

KAPL01018-W The target device was not found.Operation name = aa...aa

DetailsThe specified host device namecould not be found.aa...aa: view

ActionExecute the view operation of theHDLM command (dlnkmgr view -path) to check the valuedisplayed in HDevName. Specify ahost device for the value ofHDevName, and then retry. Fordetails on the view operation, seeview (Displays Information) onpage 6-23.

KAPL01019-W The target path was not found.Operation name = aa...aa

Detailsaa...aa: offline, online, or view¢ offline/online operation



The specified path does notexist.

¢ view operation

The paths have not beenconfigured because creationof the HDLM environment orconfiguration changes to theHDLM operating environmenthave not finished.

Action¢ offline/online operation

Use the view operation of theHDLM command (dlnkmgr) tocheck the settings, and thenretry. For details on the viewoperation, see view (DisplaysInformation) on page 6-23.

¢ view operation

Refer to Chapter 3, Creatingan HDLM Environment onpage 3-1. Creating an HDLMEnvironment, and thenconfigure any paths thatexist. If the same messageappears again, execute theDLMgetras utility forcollecting HDLM errorinformation, acquire the errorinformation, and then contactyour HDLM vendor or thecompany for which you havea service contract. For detailson the DLMgetras utility, seeThe DLMgetras Utility forCollecting HDLM ErrorInformation on page 7-2.

KAPL01021-E Cannot execute the HDLMcommand due to insufficientmemory.

DetailsMemory required for HDLMcommand processing could not beallocated.

ActionTerminate unnecessaryapplications to increase theamount of free memory, and thentry again.

KAPL01024-W The specified parameters cannotbe specified at the same time.Operation name = aa...aa,parameters = bb...bb

Detailsaa...aa: Specified operation namebb...bb: Parameters that cannotbe specified at the same time

Action



Execute help operation of theHDLM command (dlnkmgr) tocheck which parameters can bespecified at the same time, andthen retry. For details on the helpoperation, see help (Displays theOperation Format) on page 6-5.

KAPL01036-E The Offline path cannot beplaced online. PathID = aa...aa

DetailsThe path could not be recovered.aa...aa: Path ID (decimal(base-10) number)

ActionRemove the error in the path, andthen retry.

KAPL01039-W During the online operationprocessing of the HDLMcommand, a path that cannot beplaced in the Online status wasdetected. PathID = aa...aaWould you like to continue theprocessing of the onlineoperation? [y/n]:

DetailsA path that cannot be placedOnline was detected duringmulti-path online processing. Toignore this path and performonline processing for the nextpath, enter y. To cancelprocessing, enter n.

aa...aa: Path ID (decimal(base-10) number)

ActionIf you want to continue processingof the online operation of theHDLM command for other paths,enter y. If you want to terminateprocessing, enter n. For details onthe online operation, see online(Places Paths Online) on page6-10.

KAPL01040-W The entered value is invalid. Re-enter [y/n]:

DetailsA value other than y and n wasentered. Enter y or n.

ActionEnter y or n.

KAPL01041-E The entered value is invalid. Theoperation stops. Operation name= aa...aa

DetailsCommand processing will beaborted because an incorrectvalue was entered three times ina row for a request.aa...aa: clear, offline, online,or set

ActionCheck the correct value, and thenre-execute the HDLM command.



KAPL01044-W A duplicate parameter value isspecified. Operation name =aa...aa, parameter = bb...bb,parameter value = cc...cc

DetailsThe same parameter value isspecified two or more times.aa...aa: viewbb...bb: Parameter namecc...cc: Duplicate parameter value

ActionDelete the duplicate parametervalue, and then retry.

KAPL01045-W Too many parameter values arespecified. Operation name =aa...aa, parameters = bb...bb,parameter value = cc...cc

Detailsaa...aa: offline, online, set, orviewbb...bb: Parameter namecc...cc: Parameter value

ActionExecute help operation-name ofthe HDLM command (dlnkmgr) tocheck the parameter value, andthen retry. For details on the helpoperation, see help (Displays theOperation Format) on page 6-5.

KAPL01048-W Help information cannot befound. Operation name =aa...aa.

DetailsThe specified operation is not anoperation of the HDLM command.aa...aa: Specified operation name

ActionUse the help operation of theHDLM command (dlnkmgr) tocheck the operation name. Andthen retry. For details on the helpoperation, see help (Displays theOperation Format) on page 6-5.

KAPL01049-I Would you like to execute theoperation? Operation name =aa...aa [y/n]:

DetailsThe clear/set operation will bestarted. To continue theoperation, enter y. To cancel theoperation, enter n.

aa...aa: clear or setAction

If you want to execute theoperation, enter y. If you want toterminate processing, enter n. Fordetails on the clear operation,see clear (Returns the PathStatistics to the Initial Value) onpage 6-3. For details on the setoperation, see set (Sets Up the



Operating Environment) on page6-15.

KAPL01050-I The currently selected paths willbe changed to the Online status.Is this OK? [y/n]:

DetailsThe online operation will bestarted. To continue the onlineoperation, enter y. To cancel theoperation, enter n.

ActionIf you want to execute onlineprocessing, enter y. If you wantto terminate processing, enter n.For details on the onlineoperation, see online (PlacesPaths Online) on page 6-10.

KAPL01052-I The currently selected paths willbe changed to the Offline(C)status. Is this OK? [y/n]:

DetailsThe offline operation will bestarted. To continue the offlineoperation, enter y. To cancel theoperation, enter n.

ActionIf you want to execute the offlineprocessing, enter y. If you wantto terminate processing, enter n.For details on the offlineoperation, see offline (PlacesPaths Offline) on page 6-7.

KAPL01053-I If you are sure that there wouldbe no problem when the path isplaced in the Offline(C) status,enter y. Otherwise, enter n.[y/n]:

DetailsThe offline operation will bestarted. To continue the offlineoperation, enter y. To cancel theoperation, enter n.

ActionIf you want to execute offlineprocessing, enter y. If you wantto terminate processing, enter n.For details on the offlineoperation, see offline (PlacesPaths Offline) on page 6-7.

KAPL01054-W During the offline operationprocessing of the HDLMcommand, a path that cannot beplaced in the Offline(C) statuswas detected. PathID = aa...aaWould you like to continue theprocessing of the offlineoperation? [y/n]:

DetailsA path that cannot be set toOffline(C) was detected duringmulti-path offline processing. Toignore this path and performoffline processing for the nextpath, enter y. To cancel offlineprocessing, enter n.

aa...aa: Path ID (decimal(base-10) number)

Action



If you want to continue processingthe offline operation of theHDLM command for other paths,enter y. If you want to terminateprocessing, enter n. For details onthe offline operation, see offline(Places Paths Offline) on page6-7.

KAPL01055-I All the paths which pass thespecified aa...aa will be changedto the Offline(C) status. Is thisOK? [y/n]:

DetailsMultiple paths will be collectivelyset to Offline(C) because the -cha parameter was specified. Tocollectively set multiple paths toOffline(C), enter y. To cancelthe operation, enter n.

aa...aa: CHA portAction

If you want to execute offlineprocessing for the paths thatmeet the specified requirements,enter y. If you want to terminateprocessing, enter n.

KAPL01056-I If you are sure that there wouldbe no problem when all thepaths which pass the specifiedaa...aa are placed in theOffline(C) status, enter y.Otherwise, enter n. [y/n]:

DetailsThis message re-asks the userwhether they want to set all thepaths to Offline(C). To set allthe paths to Offline(C), enter y.To cancel the operation, enter n.


If you want to execute offlineprocessing for the paths thatmeet the specified requirements,enter y. If you want to terminateprocessing, enter n.

KAPL01057-I All the paths which pass thespecified aa...aa will be changedto the Online status. Is this OK?[y/n]:

DetailsMultiple paths will be collectivelyplaced Online because the -chaparameter has been specified. Tocontinue processing, enter y. Tocancel processing, enter n.


If you want to execute onlineprocessing for the paths thatmeet the specified requirements,enter y. If you want to terminateprocessing, enter n.



KAPL01058-W The specified parameter value isnot needed. Operation name =aa...aa, parameter = bb...bb,parameter value = cc...cc

DetailsA parameter value was specifiedin a parameter that does not needa parameter value.aa...aa: Specified operation namebb...bb: Parameter namecc...cc: Parameter value

ActionExecute help operation-name ofthe HDLM command (dlnkmgr) tocheck the parameter andparameter value, and then retry.For details on the help operation,see help (Displays the OperationFormat) on page 6-5.

KAPL01059-W Cannot specify the parameteraa...aa at the same time if youspecify parameter bb...bb andparameter value cc...cc.Operation name = dd...dd

DetailsA parameter value is conflictingwith the value of anotherparameter.bb...bb: Parameter namecc...cc: Parameter valueaa...aa: Parameter namedd...dd: view or set

ActionExecute help operation-name ofthe HDLM command (dlnkmgr) tocheck the parameter andparameter value, and then retry.For details on the help operation,see help (Displays the OperationFormat) on page 6-5.

KAPL01060-I The user terminated theoperation. Operation name =aa...aa

DetailsCommand processing will beaborted because n was enteredfor a required confirmation.aa...aa: online, offline, set, orclear

ActionNone.

KAPL01061-I aa...aa path(s) were successfullyplaced bb...bb; cc...cc path(s)were not. Operation name =dd...dd

DetailsThis message indicates thenumber of the paths processed inan online/offline operation.

aa...aa: Number of paths wherethe online/offline operationwas successful (decimal (base-10)number)



bb...bb: Online, Online(S),Online(D) or Offline(C)cc...cc: Number of paths wherethe online/offline operationwas unsuccessful (decimal(base-10) number)dd...dd: online or offline

ActionNone. For details on the onlineoperation, see online (PlacesPaths Online) on page 6-10. Fordetails on the offline operation,see offline (Places Paths Offline)on page 6-7.

KAPL01062-I aa...aa path(s) were successfullyplaced Offline(C). The offlinerequest of bb...bb path(s) wereregistered; cc...cc path(s) werenot. Operation name = dd...dd

DetailsThis message indicates thenumber of paths to be processedwhen an offline request wasregistered during reserveprocessing.aa...aa: The number of paths thatwere successfully taken offline(decimal (base-10) number)bb...bb: The number of paths forwhich offline processing wasreserved (decimal (base-10)number)cc...cc: The number of paths thatwere not successfully taken offline(decimal (base-10) number)dd...dd: offline

ActionFor batch processing ofregistering paths, execute theview operation to check theregistered paths.For details on the view operation,see view (Displays Information)on page 6-23.

KAPL01063-I The target path(s) are alreadyaa...aa.

DetailsAs a result of a previous online/offline operation, the specifiedpath has already been set toOnline/Online(S)/Online(D)/Offline(C).

aa...aa: Online, Online(S),Online(D) or Offline(C)

Action



Use the view operation of theHDLM command (dlnkmgr) tocheck the status of the path. Fordetails on the view operation, seeview (Displays Information) onpage 6-23. For details on theonline operation, see online(Places Paths Online) on page6-10. For details on the offlineoperation, see offline (PlacesPaths Offline) on page 6-7.For Online(S) or Online(D)paths:To change the status of a pathfrom Online(S) or Online(D) toOnline, re-execute the HDLMcommand using the -hapathparameter.

KAPL01068-I Enter a license key: DetailsThe license key will now berenewed. Enter a license key.

ActionNone.

KAPL01069-W The entered license key isinvalid.

DetailsThe entered license key is invalid.

ActionEnter a valid license key.

KAPL01070-E The entered license key isinvalid. Renewal of the licensekey will now stop.

DetailsThe license key renewalprocessing will be abortedbecause an invalid license keywas entered three times in a row.

ActionObtain a valid license key, andthen retry.

KAPL01071-I The permanent license wasinstalled.

DetailsThe license was renewed and isregistered as a permanent license.

ActionNone.

KAPL01072-I The emergency license wasinstalled. The license expires onaa...aa.

DetailsA license was renewed and isregistered as an emergencylicense.aa...aa: Year (4 digits)/month(01-12)/day (01-31)

Action



Install a permanent license by theexpiration day.

KAPL01073-E The temporary license expired. DetailsThe temporary license hasexpired. Register a permanentlicense.

ActionRegister a permanent license.

KAPL01074-E The emergency license expired. DetailsThe emergency license hasexpired. Register a permanentlicense.

ActionRegister a permanent license.

KAPL01075-E A fatal error occurred in HDLM.The system environment isinvalid.

DetailsThe license information file ismissing.

ActionRe-install HDLM.

KAPL01076-I The permanent license has beeninstalled.

DetailsYou do not need to install alicense because a permanentlicense has already been installed.

ActionNone.

KAPL01081-E The license key file is invalid.File name = aa...aa

DetailsThe format of the license key fileis invalid.aa...aa: Windows-installation-destination-drive-name:\hdlm_license

ActionStore the license key file directlyunder the Windows installation-destination drive.

KAPL01082-E There is no installable licensekey in the license key file. Filename = aa...aa

DetailsThere is no useable license key forHDLM in the license key file.aa...aa: Windows-installation-destination-drive-name\hdlm_license

ActionMake sure that the license key fileis correct, and then re-execute.



KAPL01083-I There is no license key file. Filename = aa...aa

DetailsThere is no license key file in thedesignated folder:aa...aa: Windows-installation-destination-drive-name\hdlm_license

ActionWhen the message that promptsyou to enter the license key isdisplayed, enter the license key.Alternatively, cancel the HDLMcommand, store the license keyfile directly under the Windowsinstallation-destination drive, andthen re-execute HDLM command.

KAPL01084-W An attempt to delete the licensekey file has failed. File name =aa...aa

Detailsaa...aa: Windows-installation-destination-drive-name\hdlm_license

ActionIf a license key file exists, deleteit.

KAPL01088-W The specified parameter valuescannot be specified at the sametime. Operation name = aa...aa,parameter = bb...bb, parametervalues = cc...cc

Detailsaa...aa: viewbb...bb: Parameter namecc...cc: Parameter values thatcannot be specified at the sametime

ActionExecute help operation-name ofthe HDLM command (dlnkmgr) tocheck which parameter can bespecified, and then retry. Fordetails on the help operation, seehelp (Displays the OperationFormat) on page 6-5.

KAPL01089-E One of the following wasexecuted at the same time as anHDLM command set -licoperation: another set -licoperation, or an update of thelicense for an updateinstallation.

ActionCheck the license by using theHDLM command's view -sys -licoperation. If necessary, re-execute the HDLM command's set-lic operation. If the same errormessage is output again, contactyour HDLM vendor or themaintenance company if there is amaintenance contract for HDLM.Do not perform the followingoperations:


Message ID Message Text Explanation¢ Simultaneously execute the

HDLM command's set -licoperation with the view -sys-lic operation.

¢ Execute the HDLMcommand's set -licoperation while the license foran upgrade or re-installationis being updated.

KAPL01095-E An attempt to acquire the HDLMversion information has failed.details = aa...aa

Detailsaa...aa: Code showing the reasonfor the error

ActionRe-execute the command. If thesame error occurs again, executethe DLMgetras utility for collectingHDLM error information, acquirethe error information, and thencontact your HDLM vendor or thecompany for which you have aservice contract.

KAPL01096-E An attempt to acquire theService Pack version informationhas failed. details = aa...aa

Detailsaa...aa: Code showing the reasonfor the error

ActionRe-execute the command. If thesame error occurs again, executethe DLMgetras utility for collectingHDLM error information, acquirethe error information, and thencontact your HDLM vendor or thecompany for which you have aservice contract.

KAPL01100-I aa...aa DetailsThis message indicates theexecuted command line.aa...aa: Executed command

ActionNone.

KAPL01101-W The target HBA port was notfound. Operation name =aa...aa

DetailsThe HBA having the HBA portWWN specified in the -hbaportwwn parameter could notbe found.aa...aa: offline or online

ActionUse the view operation of theHDLM command (dlnkmgr view -path -hbaportwwn) to check the



target HBA port WWN. After that,specify the appropriate HBA portWWN, and then retry.

KAPL01102-I All the paths which pass thespecified aa...aa port will bechanged to the Offline(C) status.Is this OK? [y/n]:

DetailsMultiple paths will be collectivelyplaced Offline(C) because the -hbaportwwn parameter wasspecified. To collectively placemultiple paths Offline(C), entery. To not collectively place themOffline(C), enter n.

aa...aa: HBAAction

If you want to execute the offlineprocessing for the paths whichpass the specified target, enter y.If you want to terminate theprocessing, enter n.

KAPL01103-I If you are sure that there wouldbe no problem when all thepaths which pass the specifiedaa...aa port are placed in theOffline(C) status, enter y.Otherwise, enter n. [y/n]:

DetailsThis message re-asks the userwhether to place all the pathsOffline(C). To place all thepaths Offline(C), enter y. To notplace them Offline(C), enter n.

aa...aa: HBAAction

If you want to execute the offlineprocessing for the paths whichpass the specified target, enter y.If you want to terminate theprocessing, enter n.

KAPL01104-I All the paths which pass thespecified aa...aa port will bechanged to the Online status. Isthis OK? [y/n]:

DetailsMultiple paths will be collectivelyplaced Online because the -hbaportwwn parameter wasspecified. To collectively placemultiple paths Online, enter y. Tonot collectively place themOnline, enter n.

aa...aa: HBAAction

If you want to execute the onlineprocessing for the paths whichpass the specified target, enter y.If you want to terminate theprocessing, enter n.

KAPL01107-I The load balancing typespecified for individual LUs will

ActionIf you want to change the loadbalancing algorithm for the



become invalid when thisoperation is executed. Do youwant to execute the operationanyway? Operation name = set[y/n]:

system, enter y. If you want toterminate processing, enter n.

KAPL01117-W An error occurred duringprocessing to read the audit logconfiguration file.

DetailsAn internal error occurred whilereading the audit log configurationfile.

ActionContact your HDLM vendor or themaintenance company if there is amaintenance contract for HDLM.

KAPL01118-W An error occurred duringprocessing to output the auditlog configuration file.

DetailsAn internal parameter error whenthe audit-log data was output.



DetailsAn internal parameter error whenthe audit-log data was output.


KAPL01120-W A storage system model IDcould not be displayed. Details =aa...aa, bb...bb

DetailsA storage system model ID couldnot be displayed.aa...aa: Storage recognitioninformationbb...bb: Error code

ActionExecute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenancecompany if there is a maintenancecontract for HDLM. For details onthe DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL01133-I aa...aa path(s) were successfullyplaced bb...bb; cc...cc path(s)were successfully placeddd...dd; ee...ee path(s) werenot. Operation name = ff...ff

DetailsThe number of paths processedby an online operation is shown.



aa...aa: The number of pathswhich changed to the Onlinestatusbb...bb: Online or Online(S)cc...cc: The number of pathswhich changed to the Online(S)or Online(D) status

dd...dd: Online(S), Online(D) orOnline(S)/Online(D)ee...ee: The number of pathswhich failed to change to eitherthe Online, Online(S) orOnline(D) status

ff...ff: onlineAction

None.

KAPL01134-I The target paths are alreadyOnline or Online(S).

DetailsThe specified paths are already inthe Online or Online(S) statusas a result of an online operation.

ActionCheck path status by using theview operation.. For details on theview operation, see view(Displays Information) on page6-23.For Online(S) paths:To change the status of a pathfrom Online(S) to Online, re-execute the HDLM commandusing the -hapath parameter.

KAPL01135-W A host connection option isinvalid. Option = aa...aa

Detailsaa...aa: Specified host connectionoption

ActionExecute the help operation of theHDLM command (dlnkmgr) tocheck the host connectionoptions, and then retry. Fordetails on the help operation, seehelp (Displays the OperationFormat) on page 6-5.

KAPL01136-W The specified host connectionoptions cannot be specified atthe same time. Options =aa...aa

Detailsaa...aa: Host connection optionsthat cannot be specified at thesame time

Action



Execute the help operation of theHDLM command (dlnkmgr) tocheck the host connectionoptions, and then retry. Fordetails on the help operation, seehelp (Displays the OperationFormat) on page 6-5.

KAPL01138-W The aa...aa operation cannot beexecuted if the host connectionoption -l is specified.

Detailsaa...aa: Operation that cannot beexecuted

ActionExecute the operation-name -help operation of the HDLMcommand (dlnkmgr) to check theformat of the operation, and thenretry.

KAPL01139-W The parameter aa...aa cannot bespecified if the host connectionoption bb...bb is specified.

Detailsaa...aa: Parameter that cannot bespecifiedbb...bb: Specified host connectionoption


KAPL01140-W A duplicate host connectionoption is specified. Option =aa...aa

Detailsaa...aa: Duplicate option

ActionDelete the duplicate option, andthen retry.

KAPL01141-W There is no value specified forthe host connection option.Option = aa...aa

Detailsaa...aa: Option name

ActionSpecify the option value, and thenretry.

KAPL01142-W The parameter aa...aa cannot bespecified if you omitted the hostconnection option.

Detailsaa...aa: Parameter that cannot bespecified




KAPL01143-W The host connection optionvalue cannot be specified.Option = aa...aa

Detailsaa...aa: Option for which anoption value cannot be specified

ActionExecute the help operation of theHDLM command (dlnkmgr) tocheck the host connectionoptions, and then retry. Fordetails on the help operation, seehelp (Displays the OperationFormat) on page 6-5.

KAPL01144-W The HDLM command was notexecuted from the VMwarevSphere CLI command prompt.

DetailsThe HDLM command was notexecuted from the VMwarevSphere CLI command prompt.

ActionExecute the HDLM command fromthe VMware vSphere CLIcommand prompt.

KAPL01146-I Because no path has beenselected among the currentlydisplayed paths, the paths in theOffline(C) and Offline(E)statuses will be changed to theOnline status. Is this OK?[y/n]:

DetailsAll the paths will be placed Onlinebecause the path selectionparameter is not specified for theonline operation. To place all thepaths Online, enter y. To cancelthe operation, enter n.

ActionIf you want to execute onlineprocessing, enter y. If you wantto terminate processing, enter n.Before you execute theprocessing, be sure to execute theview operation of the HDLMcommand (dlnkmgr) to check thepath status. For details on theview operation, see view(Displays Information) on page6-23. For details on the onlineoperation, see online (PlacesPaths Online) on page 6-10.

KAPL01147-I aa...aa path(s) were successfullyplaced bb...bb; cc...cc path(s)were not. Number of targetpaths = dd...dd, operation name= ee...ee

DetailsThis message indicates thenumber of the paths processed inan online/offline operation.

aa...aa: Number of paths wherethe online/offline operationwas successful(decimal (base-10)number)bb...bb: Online or Offline(C)



cc...cc: Number of paths wherethe online/offline operationwas unsuccessful(decimal(base-10) number)dd...dd: Number of target pathsfor online or offline operation(decimal (base-10) number)ee...ee: online or offline

ActionNone. For details on the onlineoperation, see online (PlacesPaths Online) on page 6-10. Fordetails on the offline operation,see offline (Places Paths Offline)on page 6-7.

KAPL01148-E An attempt to connect to thespecified server has failed.Operation name = aa...aa

DetailsAn attempt to connect to thespecified host has failed.aa...aa: Operation name

ActionCheck the host name, user nameor password that was specified inthe HDLM command (dlnkmgr),and then retry.

KAPL01149-E An attempt to connect to theHDLM driver (HTI_HDLM_SATP)has failed. Operation name =aa...aa

DetailsThe HDLM command cannotmanage HDLM on an ESXi serverbecause the HDLM driver(HTI_HDLM_SATP) cannot beaccessed.aa...aa: clear, offline, online,set, or view

ActionThis message is output whenthere is no HDLM management-target path. If this message isoutput when an HDLMmanagement-target path exists,execute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenancecompany if there is a maintenancecontract for HDLM. For details onthe DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.



KAPL01150-E The HDLM command cannot beexecuted because the VMwarevSphere CLI is not installed.

DetailsThe VMware vSphere CLI mighthave been removed after theutility for configuring HDLMremote management clientenvironments (dlmrmcenv) wasexecuted.

ActionIf the VMware vSphere CLI wasremoved, install the VMwarevSphere CLI again, and then re-execute the dlmrmcenv utility.

For details on the dlmrmcenvutility, see The dlmrmcenv Utilityfor Configuring HDLM RemoteManagement Client Environmentson page 7-7.

KAPL01151-E HDLM commands cannot beexecuted because HDLM forWindows is installed.

DetailsHDLM for VMware and HDLM forWindows cannot be used on thesame host.

ActionRemove HDLM for VMware andinstall it on another host, orremove HDLM for Windows.

KAPL01152-E The operation was canceledbecause the path configurationis being changed. Operationname = aa...aa

DetailsThe operation was canceledbecause the path configurationwas being changed during theoperation.aa...aa: offline, online, orview

ActionCheck that the path configurationis not being changed, and thenre-execute the operation.

KAPL01153-W During the offline operationprocessing of the HDLMcommand, a path that cannot beplaced in the Offline(C) statuswas detected. PathID = aa...aa

DetailsA path that cannot be set to theOffline(C) status was detectedduring multi-path offlineprocessing.aa...aa: Path ID (decimal(base-10) number)

ActionExecute the view operation theHDLM command (dlnkmgr) tocheck the path status. For detailson the view operation, see view



(Displays Information) on page6-23.

KAPL01154-W The dynamic I/O path controlfunction is already set to aa...aafor the system.

Detailsaa...aa: on or off

ActionUse the view operation of theHDLM command (dlnkmgr) tocheck the setting for the host,storage, and LUs. For details onthe view operation, see view(Displays Information) on page6-23.

KAPL01155-W The dynamic I/O path controlfunction is already set to aa...aafor storage.

Detailsaa...aa: on or off

ActionUse the view operation of theHDLM command (dlnkmgr) tocheck the setting for storage. Fordetails on the view operation, seeview (Displays Information) onpage 6-23.

KAPL01158-E Dynamic I/O path control cannotbe applied to the specifiedstorage.

ActionUse the view operation of theHDLM command (dlnkmgr) tocheck the path ID. For details onthe view operation, see view(Displays Information) on page6-23.

KAPL01167-I All paths will be set to Online orOnline(D). Is this OK? [y/n]:

DetailsAll paths will be set to Online orOnline(D) because no path isspecified. To continue, enter y. Tocancel the operation, enter n.

ActionTo set all paths to Online orOnline(D), enter y. To cancel theoperation, enter n. Before youexecute the processing, you mustcheck the path status byexecuting the view operation ofthe HDLM command dlnkmgr.

KAPL01168-I All P-VOL paths that areconnected to the LU that has thespecified path ID will be set toOnline(D). Is this OK? [y/n]:

DetailsAll paths for each specified LU willbe set to Online or Online(D). Tocontinue, enter y. To cancel theoperation, enter n.



Note: All paths of the LU,including non-P-VOL paths, will beset to Online or Online(D).

ActionTo set to Online or Online(D) allpaths that are connected to theLU that has the specified path ID,enter y. To cancel the process,enter n.

KAPL01169-I All Online(S) or Online(D)paths will be set to Online. Isthis OK? [y/n]:

DetailsAll paths in the Online(S) orOnline(D) status will be set toOnline because no path isspecified. To continue, enter y. Tocancel the operation, enter n.

ActionTo execute online processing,enter y. To cancel the operation,enter n. Before you execute theprocessing, you must check thepath status by executing the viewoperation of the HDLM commanddlnkmgr.

KAPL01170-I All Online(S) or Online(D)paths that are connected to theLU that has the specified path IDwill be set to Online. Is this OK?[y/n]:

DetailsAll paths in the Online(S) orOnline(D) status for eachspecified LU will be set to Online.To continue, enter y. To cancelthe operation, enter n.

ActionTo set to online the all Online(S)or Online(D) paths that areconnected to the specified LU withpath ID, enter y. To cancel theoperation, enter n.

KAPL01171-I The target paths are alreadyaa...aa or bb...bb.

DetailsThe specified paths are already inthe Online, Online(S), orOnline(D) status as a result of anonline operation.aa...aa: Online or Online(S)bb...bb: Online(D) or Online(S)/Online(D)

ActionCheck path status by using theview operation. For Online(S) orOnline(D) paths: To change thestatus of a path from Online(S)or Online(D) to Online, re-



execute the HDLM command withthe -hapath parameter specified.

KAPL01172-I There are no Online(S)/Online(D) paths among thetarget paths.

DetailsAn online operation was executedusing the -hapath parameter, butthere are no paths with theOnline(S)/Online(D) statusamong the specified paths.

ActionUse the view operation of theHDLM command (dlnkmgr) tocheck the status of the path.

KAPL01173-W The target CHA port wasconstructed from multiplephysical CHA ports. Operationname = aa...aa. Specify aphysical CHA port by using the"-cha -pathid" parameter.

DetailsIn an environment where storagesystems are virtualized, when youspecify a CHA port by using the -chaid parameter of the offline oronline operation, the CHA portmight be constructed frommultiple CHA ports of the physicalstorage system. In such a case,you cannot execute the offline oronline operation with the -chaidparameter specified.aa...aa: offline or Online

ActionSpecify a physical CHA port byusing the -cha -pathidparameter, and then re-executethe offline or online operation.

KAPL01174-W If the Physical Storage View isdisabled, the parameter valueaa...aa cannot be specified forthe -item parameter.

DetailsIf the Physical Storage View isdisabled, the parameter valueshown cannot be specified.aa...aa: virt

ActionWhen specifying virtual storageinformation as a display item,enable the Physical Storage View.

KAPL01175-W If the Physical Storage View isenabled, the parameter valueaa...aa cannot be specified forthe -item parameter.

DetailsIf the Physical Storage View isenabled, the parameter valueshown cannot be specified.aa...aa: phys, vid, ha, or hastat

ActionWhen specifying physical storageinformation as a display item,disable the Physical Storage View.



KAPL01176-I Some of the target paths are inthe offline status. Storagesystem settings are notrefreshed for offline paths.

DetailsHDLM cannot refresh storagesystem settings for offline paths,because HDLM cannot acquire thesettings.

ActionPlace online the paths for whichHDLM will refresh storage systemsettings, and execute the refreshoperation.

KAPL01177-W HDLM failed to acquire storagesystem settings for some paths.

DetailsHDLM failed to acquire storagesystem settings for some paths.

ActionIf this message is output whenpath errors occur during a refreshoperation, recover from the patherrors, place the paths online, andthen re-execute the refreshoperation. If this message isoutput when there are no offlinepaths, execute the DLMgetrasutility to collect error information,and then contact your vendor ormaintenance company.

KAPL01178-E HDLM failed to refresh thestorage system settings. Details= aa...aa, bb...bb

Detailsaa...aa: Detailed information 1bb...bb: Detailed information 2

ActionExecute the DLMgetras utility tocollect error information, and thencontact your vendor ormaintenance company.


KAPL03001-I HDLM API information - aa...aa DetailsThis information is required forresolving problems.aa...aa: Trace information

ActionNone.

KAPL03002-W HDLM API Warning - aa...aa DetailsThis information is required forresolving problems.



aa...aa: API trace informationAction

Refer to the contents of thewarning.

KAPL03003-E HDLM API Error information -aa...aa

DetailsThis information is required forresolving problems.aa...aa: API trace errorinformation


KAPL03999-E An unexpected error occurred. DetailsConflicting versions of HDLMmodules are being used.



KAPL04001-I HDLM manager started. ActionNone.

KAPL04002-E Could not start the HDLMmanager.

DetailsThe HDLM manager failed to startbecause the current environmentis unsuitable for the HDLMmanager to run in.

Action



Execute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenancecompany if there is a maintenancecontract for HDLM. For details onthe DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL04003-E The startup parameter is invalid. DetailsThe HDLM manager internalparameter is invalid.


KAPL04004-I HDLM manager will nowterminate.

ActionNone.

KAPL04005-E Cannot connect the servicecontrol manager.

DetailsHDLM manager could not startnormally because it was unable toconnect the service controlmanager.

ActionThe HDLM manager starts as aservice and as such, to start HDLMfrom the command line, use thenet start DLMManagerVMcommand.

KAPL04006-E Cannot register the servicecontrol handler function. Returnvalue = aa...aa

DetailsHDLM manager could not startnormally because it was unable toregister the service controlhandler function.aa...aa: OS error code


KAPL04007-E Cannot register the servicestatus. Return value = aa...aa

Details



HDLM manager could not startnormally because it was unable toregister the service status.aa...aa: OS error code


KAPL04008-E Cannot open the optiondefinition file (aa...aa).

DetailsHDLM manager could not startnormally because it was unable toopen the option definition file.aa...aa: Option definition filename

ActionCheck whether another program iscurrently using this file (forexample, the file is being openedin a text editor), or whether thefile has been inadvertentlydeleted.

KAPL04009-E The option definition is invalid. DetailsHDLM manager could not startnormally because some of thedefinitions in the option definitionfile were invalid.

ActionIf the KAPL04033-W message isoutput after this message,execute the dlnkmgr view -sys-sfunc command, and then checkthe option settings.Use the dlnkmgr set operation toreturn options settings back towhere you had them.If the KAPL04033-W message isnot output, restart HDLMmanager.If the same error occurs, re-installHDLM. For details on the viewoperation, see view (DisplaysInformation) on page 6-23. Fordetails on the set operation, seeset (Sets Up the OperatingEnvironment) on page 6-15.

KAPL04010-E Could not open the error log file. DetailsHDLM manager could not startnormally because it was unable toopen the error log file.

Action



Check whether another program iscurrently using the error log file(for example, the file is beingopened in a text editor), orwhether the error log file has beeninadvertently deleted.

KAPL04011-E Could not output the error logfile.

DetailsThe log information could not beoutput to the error log file.

ActionMake sure that the disk hasenough unused capacity.

KAPL04012-E Could not create acommunication pipe. RC =aa...aa

DetailsHDLM manager could not startnormally because it was unable tocreate a pipe file, which is used incommunication with HDLMcommands.aa...aa: OS error code (decimalnumber)


KAPL04013-E Input is impossible via thecommunication pipe. RC =aa...aa

DetailsData could not be read from thepipe file while communicating withan HDLM command.aa...aa: OS error code (decimalnumber)




KAPL04014-E Output is impossible via thecommunication pipe. RC =aa...aa

DetailsData could not be written to thepipe file while communicating withan HDLM command.aa...aa: OS error code (decimalnumber)


KAPL04021-I HDLM manager information -aa...aa

DetailsThis information is required forresolving problems.aa...aa: HDLM manager traceinformation

ActionNone.

KAPL04022-W HDLM manager warninginformation - aa...aa

DetailsThis information is required forresolving problems.aa...aa: HDLM manager tracewarning information


KAPL04023-E HDLM manager errorinformation - aa...aa

DetailsThis information is required forresolving problems.aa...aa: HDLM manager traceerror information

ActionExecute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLM



vendor or the maintenancecompany if there is a maintenancecontract for HDLM. For details onthe DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL04024-C A critical error occurred in theHDLM manager. (aa...aa)

DetailsThis information is required forresolving problems.aa...aa: HDLM manager traceerror information


KAPL04025-C A memory shortage occurred inthe HDLM manager.

DetailsThere was not enough memory torun the HDLM manager processes.

ActionTo increase the amount of freememory, terminate unnecessaryapplications or restart the host.

KAPL04033-W The option definition file was re-created.

DetailsWhen an existing option definitionfile cannot be read, a new optiondefinition file will be re-created byusing the default values. If someof the options can be read, thosevalues can be used. As for anyremaining values, the defaultvalues will be used.

ActionFor any non-default options, usethe dlnkmgr set operation to setthe options again. For details onthe set operation, see set (SetsUp the Operating Environment) onpage 6-15.

KAPL04034-E An attempt to create the optiondefinition file has failed.

DetailsAn attempt to re-create an optiondefinition file using the defaultvalues has failed.



ActionRemove unnecessary files tosecure unused capacity on the filesystem, or check the writepermissions for the folder and file.

KAPL04042-I HDLM SNMP TRAP information -aa...aa

DetailsAll the paths that path healthchecking examined are fine.aa...aa: Start or stop.

ActionNone.

KAPL04045-I HDLM SNMP TRAP was sent.Trap ID = aa...aa, IP Address =bb...bb, Port Number= cc...cc,Community = dd...dd, TrapData = ee..ee

Detailsaa...aa: Trap IDbb...bb: Destination IP address ofthe trapcc...cc: Destination port numberof the trapdd...dd: Community name givento the trapee...ee: Transmission data

ActionNone.

KAPL04053-W The option definition file wasrecovered from a work file.

DetailsExecute the dlnkmgr view -syscommand to check whether thesettings are recovered. If thesettings are not recovered,execute the dlnkmgr setoperation to recover the settings.

KAPL04057-E An attempt to connect to theVMware server failed. (VMwareserver host = aa...aa)

Detailsaa...aa: VMware server host IPaddress

ActionIf the VMware server is notstopped, check whether a networkfailure occurred.

KAPL04058-I The connection to the VMwareserver was restored. (VMwareserver host = aa...aa)


ActionNone.

KAPL04059-I Monitoring of the VMware serverstarted. (VMware server host =aa...aa)


Action



None.

KAPL04060-I Monitoring of the VMware serverwill now end. (VMware serverhost = aa...aa)


ActionNone.


KAPL08022-E A path error occurred.ErrorCode = aa...aa, PathID =bb...bb, PathName =cc...cc.dd...dd.ee...ee.ff...ff,DNum = gg...gg, HDevName =hh...hh

DetailsA physical or logical error occurredin the path.aa...aa: Error code (hexadecimalnumber)bb...bb: Path ID (same as PathIDof view -path) (decimal number)

cc...cc: Host port number (sameas PathName of view -path)(hexadecimal number)dd...dd: Bus number (same asPathName of view -path)(hexadecimal number)ee...ee: Target ID (same asPathName of view -path)(hexadecimal number)ff...ff: HLU number (same asPathName of view -path)(hexadecimal number)gg...gg: Dev number (same asDNum of view -path) (decimalnumber)hh...hh: Host device name (sameas HDevName of view -path)

ActionThe path might be damaged. Fordetails on what to do, see WhatTo Do for a Path Error on page5-2, and then switch the pathshown in the message to Online.

KAPL08026-E An error occurred on all thepaths of the LU. PathID =aa...aa

DetailsAn error occurred in the last,remaining path of an LU. (This ismost likely as a result of adisconnection.)



aa...aa: Path ID (same as PathIDof view -path) (decimal number)

ActionErrors are detected in all thepaths connected to the LUs. SeeWhat To Do for a Path Error onpage 5-2 to make the path shownin the error message or the pathsconnected to the target LU.

KAPL08027-E A path was excluded from theitems subject to automaticfailback. PathID = aa...aa

DetailsA path was excluded from beingsubject to automatic failbacksbecause the system judged thatan intermittent error wasoccurring in that path.aa...aa: Path ID (same as PathIDof view -path) (decimal number)

ActionAn intermittent error hasoccurred. Check the path for anypossible problems. For details onwhat to do, see What To Do for aPath Error on page 5-2, andswitch the path shown in themessage to Online.

KAPL08032-I A path was recovered. (PathID= aa...aa)

DetailsThe path has changed to an onlinestatus.aa...aa: Path ID (same as PathIDof view -path) (decimal number)

ActionNone


KAPL09001-E There is no system managementpermission. Login withadministrator permission andaa...aa HDLM.

DetailsThe current user does not havethe necessary administratorpermission to install or removeHDLM.aa...aa: re-install or re-remove

ActionRe-install or re-remove HDLM as auser who is a member of theAdministrators group.



KAPL09034-E An Internal error occurred in theHDLM Installer. Code = aa...aabb...bbContact your HDLM vendor orthe maintenance company ifthere is a maintenance contractof HDLM.

DetailsDuring installation of HDLM, anerror occurred that was probablynot a result of a user operation.aa...aa: Error number (decimalnumber)bb...bb: Detailed information(decimal number)

ActionContact your HDLM vendor or themaintenance company if there is amaintenance contact of HDLM.

KAPL09173-W HDLM version aa...aa isinstalled. Do you want tooverwrite it with versionbb...bb?

Detailsaa...aa: Installed version numberof HDLM (character string)bb...bb: Version number of HDLMto be installed (character string)

ActionClick the OK button to upgrade orre-install HDLM.

KAPL09181-I The aa...aa of HDLM versionbb...bb completed successfully.

DetailsThe unattended installation orremove of HDLM has completednormally.aa...aa: installation or removebb...bb: Version number of theinstalled or removed HDLM

ActionNone.

KAPL09182-W An attempt to aa...aa HDLMversion bb...bb has failed.See the previous messages toresolve the problems.

DetailsThe unattended installation orremove of HDLM failed.aa...aa: install or removebb...bb: Version number of HDLMyou attempted to install orremove

ActionSee the previous warning anderror messages to resolve theproblems.

KAPL09187-W No parameter is specified. DetailsNo installation-informationsettings file has been specified inthe installhdlm utility forinstalling HDLM.

Action



Make sure that an actualinstallation-information settingsfile for the installhdlm utility isappropriate, and then try again.

KAPL09188-W Too many parameters arespecified.

DetailsMultiple parameters were specifiedfor the installhdlm utility forinstalling HDLM.

ActionMake sure that the parameters forthe installhdlm utility isappropriate, and then try again.For details on the installhdlmutility, see The installhdlm Utilityfor Installing HDLM on page 7-8.

KAPL09189-W The parameter contains anincorrect value. (Value =aa...aa)

DetailsEither -f, -v, or -h must bespecified as the first parameter forthe installhdlm utility forinstalling HDLM.-s, or -h must be specified asparameters for the removehdlmutility for removing HDLM.aa...aa: Invalid parameter(character string)

ActionMake sure that the parameters forthe installhdlm or removehdlmutility are appropriate, and thentry again. For details on theinstallhdlm utility, see Theinstallhdlm Utility for InstallingHDLM on page 7-8. For details onthe removehdlm utility, see Theremovehdlm Utility for RemovingHDLM on page 7-11.

KAPL09191-W The installation informationsettings file does not exist.

DetailsThe installation-informationsettings file specified for thesecond parameter in theinstallhdlm utility for installingHDLM does not exist.

ActionMake sure that the path name ofthe installation-informationsettings file is appropriate, andthen try again.

KAPL09193-W A definition in the installationinformation settings file isinvalid. (aa...aa = bb...bb)

DetailsAn invalid value has beenspecified for a key.



aa...aa: The key where the invalidvalue was specifiedbb...bb: The invalid key value

ActionCorrect the definition in theinstallation-information settingsfile, and then try again.

KAPL09194-W A folder or file specified in theinstallation information settingsfile does not exist. (aa...aa =bb...bb)

DetailsThe folder or file specified for akey does not exist.aa...aa: The key name of theentry where the path name of afile or folder is specifiedbb...bb: The path name of the fileor folder that does not exist

ActionCorrect the definition in theinstallation-information settingsfile, and then try again.

KAPL09284-W HDLM is not installed. DetailsIf HDLM is not installed, theinstallhdlm utility for installingHDLM cannot be executed withthe -v parameter.

ActionNone.

KAPL09605-I There is no license key file. Filename = aa...aa

DetailsThere is no license key file in thedesignated folder.aa...aa: Windows-installation-destination-drive-name\hdlm_license or the-file-that-the-user-specified

ActionEnter a license key whenprompted by a message to do so.Alternatively, cancel theinstallation, save the correctlicense key file in the designatedfolder, and then re-execute theinstallation.

KAPL09606-E The entered license key isinvalid. The HDLM installationwill now terminate. Obtain avalid license key, and then re-install HDLM.

DetailsThe renewal of the license key willbe aborted because an invalidlicense key was entered.

ActionObtain a valid license key, andthen re-install HDLM.



KAPL09607-E Cannot install in this system.Install HDLM on a supported OS.

DetailsHDLM cannot be installed on thissystem.

ActionInstall HDLM on a supported OS.For information on which OSs aresupported, see Hosts and OSsSupported by HDLM on page 3-2.

KAPL09608-W The HDLM for Windows hasalready been installed in thissystem.

DetailsHDLM for Windows and HDLM forVMware cannot be installed on thesame host.

ActionNone.

KAPL09609-E There is no system managementpermission. Login withadministrator permission andre-install HDLM.

DetailsThe current user does not havethe administrator permission toinstall or remove HDLM.

ActionLogin with administratorpermission and re-install or re-remove HDLM.

KAPL09610-W The entered license key isinvalid.

DetailsRe-enter the license key becausean entered license key is invalid.

ActionEnter a valid license key.

KAPL09611-E The entered license key isinvalid. The HDLM installationwill now terminate. Obtain avalid license key, and then re-install HDLM.

DetailsThe entered license key is invalid.Installation is aborted.

ActionRetry installation.

KAPL09612-W There is no installable licensekey in the license key file. Filename = aa...aa

DetailsThere is no HDLM-installablelicense key in the license key file.aa...aa: Windows-installation-destination-drive-name\hdlm_license or the-file-that-the-user-specified

ActionMake sure that the license key fileis correct, and then re-execute.

KAPL09613-E License information cannot beacquired.

DetailsLicense information cannot beacquired from the alreadyinstalled HDLM environment.



ActionRemove HDLM, and then restartthe installation program.

KAPL09614-W An attempt to aa...aa HitachiCommand Suite Common Agenthas failed.

Detailsaa...aa: install or remove

ActionWait a while, and then reperformthe installation or remove. If theproblem is not solved, thencontact your HDLM vendor or themaintenance company if there is amaintenance contract for HDLM.

KAPL09615-W An attempt to aa...aa HDLMversion bb...bb has failed.

DetailsThe unattended installation orremove of HDLM failed.aa...aa: install or removebb...bb : Version number of HDLMyou attempted to install orremove

Action¢ install:

Confirm the following, andthen execute theinstallhdlm utility forinstalling HDLM again:• Confirm that the file and

folder specified for thefollowing keys in theinstallation-informationsettings file are correct:licensekeyfileinstalldir

• Confirm that valid licenseinformation is stored inthe license key filespecified forlicensekeyfile key.

If the problem persists, usesetup.exe to install HDLM. Ifan error occurs, take actionaccording to the relevanterror message.

¢ remove:Contact your HDLM vendor orthe maintenance company ifthere is a maintenancecontract for HDLM.



KAPL10001-W No parameter has beenspecified.

DetailsNo folder to which the collectedinformation will be output hasbeen specified.

ActionCheck the parameters of theDLMgetras utility for collectingHDLM error information, and thenretry. For details on theDLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL10002-W Too many parameters havebeen specified.

DetailsFour or more parameters havebeen specified.


KAPL10004-W The parameter contains anincorrect value. Value = aa...aa

DetailsThe first parameter must be afolder.aa...aa: Invalid parameter


KAPL10009-W The specified directory alreadyexists. Do you want to overwriteit? [y/n]:

DetailsThe specified folder already exists.Enter y to overwrite it, or n tocancel.

ActionThe specified folder already exists.Enter y to overwrite the existingfile. Enter n or press any otherkey to terminate the DLMgetrasutility for collecting HDLM error



information, without executing it.For details on the DLMgetrasutility, see The DLMgetras Utilityfor Collecting HDLM ErrorInformation on page 7-2.

KAPL10017-W You lack privileges for executingthe utility for collecting HDLMerror information.

DetailsThe DLMgetras utility forcollecting HDLM error informationmust be executed by a user whois a member of the Administratorsgroup.

ActionRe-execute the utility as a userwho is a member of theAdministrators group. For detailson the DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL10020-I The file has been obtainedsuccessfully. File = aa...aa,Collection time =bb...bb(GMT:bb...bb)

DetailsThe file to be collected has beenobtained.aa...aa: Collected file namebb...bb: Year/month/dayhour:minute:second

ActionNone.

KAPL10022-I The utility for collecting HDLMerror information completednormally.

DetailsError information has beencollected.

ActionNone. For details on theDLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL10030-I A user terminated the utility forcollecting HDLM errorinformation.

DetailsProcessing of the DLMgetrasutility for collecting HDLM errorinformation has been terminatedbecause the user replied to theconfirmation with an n response.

ActionNone. For details on theDLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.



KAPL10031-W The entered value is invalid.Continue operation ? [y/n]:

DetailsA value other than y or n has beenentered for a [y/n] request. Entery or n.

ActionEnter y or n.

KAPL10032-W The entered value is invalid. Theutility for collecting HDLM errorinformation stops.

DetailsProcessing of the DLMgetrasutility for collecting HDLM errorinformation will terminate becausean invalid response was sent threetimes in a row to a request.

ActionRe-execute the DLMgetras utility.For details on the DLMgetrasutility, see The DLMgetras Utilityfor Collecting HDLM ErrorInformation on page 7-2.

KAPL10033-W The file does not exist. Filename= aa...aa

DetailsNo file to collect informationexists.aa...aa: Information collection file

ActionNone.

KAPL10034-E The file could not be copied.Filename = aa...aa, Details =bb...bb

DetailsExecution of the cp commandfailed.aa...aa: File name you tried tocopybb...bb: Error number of theWindows API (hexadecimalnumber)

ActionAn error occurred while theinformation collection file wasbeing copied. The error might be aresult of an unstable userenvironment. Check the systemconfiguration.

KAPL10041-I Collection of aa...aa informationwill now start.

Detailsaa...aa: Log information to becollected

ActionNone.

KAPL10042-I Collection of aa...aa informationwill now finish.

Detailsaa...aa: Collected log information



ActionNone.

KAPL10043-I Error information is beingcollected. (aa...aa%)

Detailsaa...aa: What percentage of allthe information to be collected islog information

ActionNone.

KAPL10044-W There is insufficient disk space. DetailsThe DLMgetras utility forcollecting HDLM error informationexecution will now stop becausethe available disk capacity hasdecreased to less than 50 MB.

ActionRe-execute in an environmentthat has at least 50 MB of freedisk capacity.

KAPL10045-W A parameter is invalid. DetailsThe specified parameter is invalid.

ActionMake sure that the parameters forthe DLMgetras utility for collectingHDLM error information areappropriate, and then try again.For details on the DLMgetrasutility, see The DLMgetras Utilityfor Collecting HDLM ErrorInformation on page 7-2.

KAPL10046-W A parameter value is invalid. DetailsThe specified parameter is invalid.

ActionMake sure that the parameters forthe DLMgetras utility for collectingHDLM error information areappropriate, and then try again.For details on the DLMgetrasutility, see The DLMgetras Utilityfor Collecting HDLM ErrorInformation on page 7-2.

KAPL10047-W A necessary parameter valuehas not been specified.(parameter = aa...aa)

DetailsA required parameter value hasnot been specified.aa...aa: Parameter name

ActionMake sure that the parameters forthe DLMgetras utility for collectingHDLM error information are



appropriate, and then try again.For details on the DLMgetrasutility, see The DLMgetras Utilityfor Collecting HDLM ErrorInformation on page 7-2.

KAPL10048-E An error occurred in internalprocessing of the utility forcollecting HDLM errorinformation. Details = aa...aa,bb...bb

Detailsaa...aa: Error number (characterstring)bb...bb: Error number (characterstring)


KAPL10956-W An attempt to connect to thespecified server has failed.

DetailsAn attempt to connect to thespecified host has failed.

ActionCheck the host name, user nameor password that was specified inthe DLMgetras utility for collectingHDLM error information, and thenretry. For details on theDLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL10957-W The utility for collecting HDLMerror information cannot beexecuted because the VMwarevSphere CLI is not installed.

DetailsThe DLMgetras utility forcollecting HDLM error informationwas not executed in the commandprompt of VMware vSphere CLI.

ActionExecute the DLMgetras utility inthe command prompt of theVMware vSphere CLI.


KAPL11901-I aa...aa has started. DetailsThe operation has started on thehost.aa...aa : Operation (characterstring)¢ Get Path Information


Message ID Message Text Explanation¢ Get Option Information¢ Set Option Information¢ Clear Data¢ Get HDLM Manager Status¢ Get HDLM Driver Status¢ Get HDLM Alert Driver

Status¢ Get SNMP Trap Information¢ Set SNMP Trap Information¢ Set LU Load Balance¢ Get Path Status Log

Information¢ Get Local Time¢ Get ESXi Information¢ Add Path Information¢ Delete Path Information¢ Set Storage

IdentificationInformation

ActionNone.

KAPL11902-I aa...aa has started. PathID =bb...bb

DetailsThe operation has started on thehost.aa...aa: Operation (characterstring)¢ Online¢ Offlinebb...bb: The Path ID of the targetpath (decimal number)

ActionNone.

KAPL11903-I aa...aa has completed normally. DetailsThe operation has completednormally on the host.aa...aa: Any of the followingoperations (character string)¢ Get Path Information¢ Get Option Information¢ Set Option Information¢ Clear Data¢ Get HDLM Driver Status¢ Get HDLM Manager Status


Message ID Message Text Explanation¢ Get HDLM Alert Driver

Status¢ Online¢ Offline¢ Get SNMP Trap Information¢ Set SNMP Trap Information¢ Set LU Load Balance¢ Get Path Status Log

Information¢ Get Local Time¢ Get ESXi Information¢ Add Path Information¢ Delete Path Information¢ Set Storage


ActionNone.

KAPL11904-E aa...aa has completedabnormally. Error status =bb...bb

DetailsThe operation has completedabnormally on the host.aa...aa: Operation (characterstring)¢ Get Path Information¢ Get Option Information¢ Set Option Information¢ Clear Data¢ Get HDLM Driver Status¢ Get HDLM Manager Status¢ Get HDLM Alert Driver

Status¢ Online¢ Offline¢ Get SNMP Trap Information¢ Set SNMP Trap Information¢ Set LU Load Balance¢ Get Path Status Log

Information¢ Get ESXi Information¢ Add Path Information¢ Delete Path Information¢ Set Storage




bb...bb: Error status returnedfrom API (character string)

ActionExecute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenancecompany if you have amaintenance contract for HDLM.For details on the DLMgetrasutility, see The DLMgetras Utilityfor Collecting HDLM ErrorInformation on page 7-2.

KAPL11905-E An unexpected error occurred. DetailsAn exception occurred duringprocessing on the host.

ActionExecute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenancecompany if you have amaintenance contract for HDLM.For details on the DLMgetrasutility, see The DLMgetras Utilityfor Collecting HDLM ErrorInformation on page 7-2.

KAPL11906-I GUI information - aa...aa DetailsThis information is required forresolving problems.aa...aa: Trace information(character string)

ActionNone.

KAPL11907-I XML reception - aa...aa DetailsThis information is required forresolving problems.aa...aa: XML information(character string)

ActionNone.

KAPL11908-I XML transmission - aa...aa DetailsThis information is required forresolving problems.aa...aa: XML information(character string)

ActionNone.



KAPL13604-W An error occurred duringprocessing to read the audit logconfiguration file.

DetailsAn internal error occurred duringprocessing to read the audit logconfiguration file.

ActionContact your HDLM vendor ormaintenance company if there is amaintenance contract for HDLM.


DetailsAn internal parameter erroroccurred during output of theaudit log data.



DetailsAn internal error occurred duringoutput of the audit log data.



KAPL15060-I DLMgetras was invoked.Command Line = aa...aa

Detailsaa...aa: Name of the utility thatthe user executed

KAPL15061-I DLMgetras successfullyexecuted. Command Line =aa...aa

Detailsaa...aa: Name of the utility thatthe user executed

KAPL15101-I Clear operation was completedsuccessfully. Command Line =aa...aa

Detailsaa...aa: Command that the userexecuted

KAPL15102-W Clear operation has failed.Command Line = aa...aa


KAPL15103-I aa...aa path(s) weresuccessfully placed bb...bb.

Detailsaa...aa: Number of paths whereonline/offline is successful



cc...cc path(s) were not.Command Line = bb...bb

bb...bb: Online, Online(S),Online(D) or Offline(c)cc...cc: Number of paths whereonline/offline is unsuccessful

KAPL15104-W aa...aa path(s) were failed toplace bb...bb. Command Line =cc...cc

Detailsaa...aa: Number of paths thatfailed to be placed online or offlinebb...bb: Online or Offline(c)cc...cc: Command that the userexecuted

KAPL15105-I Setting up the operatingenvironment succeeded.Command Line = aa...aa


KAPL15106-W Setting up the operatingenvironment failed. CommandLine = aa...aa


KAPL15107-I Program information wassuccessfully displayed.Command Line = aa...aa


KAPL15108-W An attempt to display programinformation has failed.Command Line = aa...aa


KAPL15109-I Information about HDLM-management targets wassuccessfully displayed.Command Line = aa...aa


KAPL15110-W An attempt to displayinformation about HDLM-management targets has failed.Command Line = aa...aa


KAPL15111-W The HDLM command wasstarted or stopped by the userwho does not have theauthority. Command Line =aa...aa


KAPL15116-I bb...bb path(s) weresuccessfully placed aa...aa.dd...dd path(s) weresuccessfully placed cc...cc.ee...ee path(s) were not.Command Line = online

Detailsaa...aa: Online or Online(S)bb...bb: The number of pathswhich changed to the Online orOnline(S) status

cc...cc: Online(S), Online(D) orOnline(S)/Online(D)dd...dd: The number of pathswhich changed to the Online(S)or Online(D) status



ee...ee: The number of pathswhich failed to change to eitherthe Online, Online(S) orOnline(D) status

KAPL15121-I The storage system settingswere successfully refreshed.Command Line = aa...aa


KAPL15122-W The refresh of the storagesystem settings failed.Command Line = aa...aa


KAPL15401-I HDLM Manager successfullystarted.

-

KAPL15402-W Could not start the HDLMmanager.

-

KAPL15403-I HDLM Manager successfullystopped.

-

KAPL15404-W The HDLM Manager wasexecuted by the user who doesnot have the authority.

-


KAPL20001-I The initialization of the plugin(HTI_SATP_HDLM) wassuccessful.

DetailsThe initialization of theHTI_SATP_HDLM plugin hassuccessful.

ActionNone.

KAPL20009-I The termination of the plugin(HTI_SATP_HDLM) wassuccessful.

DetailsThe termination of theHTI_SATP_HDLM plugin successful.

ActionNone.

KAPL20021-I The state of path (aa...aa) waschanged from bb...bb to cc...cc.

DetailsThe path state changed.aa...aa: Name of Path thatchanged statebb...bb: Path state before changecc...cc: Path state after change

ActionNone.



KAPL20022-W The state of path (aa...aa) waschanged from bb...bb to cc...cc.

DetailsThe path state changed to a statewhere I/Os cannot be issued.aa...aa: Name of Path thatchanged statebb...bb: Path state before changecc...cc: Path state after change

ActionCheck the status of the pathwhere the error was detected.

KAPL20023-E The state of path (aa...aa) waschanged from bb...bb to cc...cc.

DetailsThe path state changed to a statewhere I/Os cannot be issued.aa...aa: Name of Path thatchanged statebb...bb: Path state before changecc...cc: Path state after change

ActionCheck the status of the pathwhere the error was detected.

KAPL20024-W I/O (aa...aa) to path (bb...bb)failed. Sense key=cc...cc ASC/ASCQ=dd...dd

DetailsAn I/O error occurred.aa...aa: SCSI commandbb...bb: Name of Path that hadI/O errorcc...cc: Sense Keydd...dd: Additional Sense Codeand Additional Sense CodeQualifier

ActionAccording to the explanation ofSense Code and Additional SenseCode, check the status of the pathwhere the error was detected.

KAPL20025-W I/O (aa...aa) to path (bb...bb)failed. Plugin status=cc...cc

DetailsAn I/O error occurred.aa...aa: SCSI commandbb...bb: Name of Path that hadI/O errorcc...cc: Plugin status

ActionExecute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenancecompany if there is a maintenance



contract for HDLM. For details onthe DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL20026-W I/O (aa...aa) to path (bb...bb)failed. Host status=cc...cc

DetailsAn I/O error occurred.aa...aa: SCSI commandbb...bb: Name of Path that hadI/O errorcc...cc: Host status


KAPL20027-W I/O (aa...aa) to path (bb...bb)failed. Device status=cc...cc

DetailsAn I/O error occurred.aa...aa: SCSI commandbb...bb: Name of Path that hadI/O errorcc...cc: Device status


KAPL20028-I The owner controller of device(aa...aa) was changed to(bb...bb).

DetailsThe owner controller of the LUconnected to the path with the IDshown in the message waschanged.aa...aa: Path ID of the changedLU. (same as PathID of view -path) (Decimal number)

bb...bb: Owner controller ID afterthe change. (Hexadecimalnumber)



ActionNone.

KAPL20029-I The owner core of device(aa...aa) was changed to(bb...bb).

DetailsThe owner core of the LUconnected to the path with the IDshown in the message waschanged.aa...aa: Path ID of the changedLU. (same as PathID of view -path) (Decimal number)

bb...bb: Owner core ID after thechange. (Hexadecimal number)

ActionNone.

KAPL20031-E A primary volume of HAM pair(aa...aa) was blocked.

DetailsThe primary volume of HAM pairwas blocked.aa...aa: Name of primary volumeof HAM pair that is blocked

ActionRecover the path for the primaryvolume of the HAM pair, andresynchronize the HAM pair. Afterthat, release the blocked state ofthe primary volume.

KAPL20032-I A primary volume of HAM pair(aa...aa) was released.

DetailsThe primary volume of HAM pairwas released.aa...aa: Name of primary volumeof HAM pair that was released

ActionNone.

KAPL20033-E A parameter is invalid.Parameter = "aa...aa"

DetailsThe parameter specified in esxclicommand (nmp satp setconfig) isinvalid.aa...aa: Specified parameter

ActionCheck the parameter youspecified. Specify the correctparameter and retry the esxclicommand.

KAPL20034-E The device (aa...aa) is not HAMpair.

DetailsThe device name specified for -doption of esxcli command (nmpsatp setconfig --config pvolrel) isnot device (HAM pair).



aa...aa: Name of device (HAMpair) specified for -d option


KAPL20035-E The target HAM pair (aa...aa)has already been released.

DetailsThe device name(HAM pair)specified for -d option of esxclicommand (nmp satp setconfig --config pvolrel) was alreadyreleased.aa...aa: Name of device (HAMpair) specified for -d option


KAPL20036-E An attempt to release theprimary volume of HAM pair(aa...aa) has failed.

DetailsAn attempt to release the primaryvolume of HAM pair specified for -d option of esxcli command (nmpsatp setconfig --config pvolrel) hasfailed.aa...aa: Name of device (HAMpair) specified for -d option

ActionWait a while, and then try again.

KAPL20041-W The state of path (aa...aa) wasnot able to be updated.

Detailsaa...aa: Name of Path that wasnot able to be updated.


KAPL20042-W The state of path (aa...aa) wasnot able to be updated. Pluginstatus=bb...bb

Detailsaa...aa: Name of Path that wasnot able to be updated.bb...bb: Plugin status

Action



Execute the DLMgetras utility forcollecting HDLM error information,and then contact your HDLMvendor or the maintenancecompany if there is a maintenancecontract for HDLM. For details onthe DLMgetras utility, see TheDLMgetras Utility for CollectingHDLM Error Information on page7-2.

KAPL20043-W The state of path (aa...aa) wasnot able to be updated. Hoststatus=bb...bb

Detailsaa...aa: Name of Path that wasnot able to be updated.bb...bb: Host status


KAPL20044-W The state of path (aa...aa) wasnot able to be updated. Devicestatus=bb...bb

Detailsaa...aa: Name of Path that wasnot able to be updated.bb...bb: Device status


KAPL20045-W The state of path (aa...aa) wasnot able to be updated. Sensekey=bb...bb ASC/ASCQ=cc...cc

Detailsaa...aa: Name of Path that wasnot able to be updated.bb...bb: Sense keycc...cc: ASC/ASCQ

ActionAccording to the explanation ofSense Code, check the status ofthe storage.



KAPL20050-E An error occurred in all thepaths of the device (aa...aa).

DetailsA problem such as a disconnectioncaused an error in the last onlinepath of the device.aa...aa: Device name

ActionSee "What To Do for a Path Erroron page 5-2 Actions taken for apath error", check the status ofthe device shown in the messageand all the paths of that device,resolve the error, and then switchthe paths to online.

KAPL20051-E No path connected to the device(aa...aa) is in the Online(D)status.

DetailsDue to path failure, path deletion,or offline operation, no pathconnected to the LU (aa...aa) is inthe Online(D) status.

aa...aa: Device name (same asHDevName of "dlnkmgr view -path" command)

ActionTo return a path to the Online(D)status, resolve the path failure,and then execute the "dlnkmgronline -dfha" command.

KAPL20060-W Failed to get InquiryPage.aa...aa in path (bb...bb).

DetailsFailed to obtain the Inquiry data ofthe path to show in a message.aa...aa: Page name of the Inquirydata which failed to get it.bb...bb: Path ID (same as PathIDof view -path) (decimal(base-10) number)

ActionConfirm the state of the path.After having removed an obstacle,and then execute the "dlnkmgrrefresh" command.

KAPL20902-E A parameter is invalid.parameter = aa...aa

DetailsA parameter is invalid.aa...aa: The specified parameter

ActionSpecify the -h parameter for theutility for configuring HDLMremote management clientenvironments (dlmrmcenv),confirm the parameter that should



be specified, and then retry theoperation. For details on thedlmrmcenv utility, see Thedlmrmcenv Utility for ConfiguringHDLM Remote Management ClientEnvironments on page 7-7.

KAPL20903-E The specified Credential storefile does not exist. Value =aa...aa

DetailsThe Credential Store file that wasspecified at execution of the utilityfor configuring HDLM remotemanagement client environments(dlmrmcenv) does not exist.

aa...aa: input file nameAction

Check the input Credential Storefile, and then retry. For details onthe dlmrmcenv utility, see Thedlmrmcenv Utility for ConfiguringHDLM Remote Management ClientEnvironments on page 7-7.

KAPL20904-E The Credential store file doesnot exist. Value = aa...aa

DetailsThe Credential Store file does notexist at execution of the utility forconfiguring HDLM remotemanagement client environments(dlmrmcenv).

aa...aa: input file nameAction

Check the Credential Store file,and then retry. For details on thedlmrmcenv utility, see Thedlmrmcenv Utility for ConfiguringHDLM Remote Management ClientEnvironments on page 7-7.

KAPL20905-E The VMware vSphere CLIinformation could not beacquired.

DetailsThe VMware vSphere CLIinformation could not be acquired.

ActionMake sure that the environmentvariable of VMware vSphere CLI.Make sure that the command isexecuted by a VMware vSphereCLI.

KAPL20906-E An internal error occurred in thedlmrmcenv utility. Error Code =aa...aa

DetailsAn internal error occurred in theutility for configuring HDLMremote management clientenvironments (dlmrmcenv).

aa...aa: Error number




KAPL20907-I The dlmrmcenv utilitycompleted normally.

DetailsThe utility for configuring HDLMremote management clientenvironments (dlmrmcenv) endednormally.

ActionNone.

KAPL20908-W You lack privileges for executingthe utility for Configuring HDLMRemote Management ClientEnvironments.

DetailsThe utility for configuring HDLMremote management clientenvironments (dlmrmcenv) mustbe executed by a user who is amember of the Administratorsgroup.

ActionRe-execute the utility as a userwho is a member of theAdministrators group.


KAPL21001-I The initialization of thepspPlugin (aa...aa) wassuccessful.

DetailsThe initialization of theHTI_PSP_HDLM plugin hassuccessful.aa...aa: HTI_PSP_HDLM_EXLBK,HTI_PSP_HDLM_EXLIO, orHTI_PSP_HDLM_EXRR

ActionNone.

KAPL21009-I The termination of the pspPlugin(aa...aa) was successful.

DetailsThe termination of theHTI_PSP_HDLM plugin successful.

aa...aa: HTI_PSP_HDLM_EXLBK,HTI_PSP_HDLM_EXLIO, orHTI_PSP_HDLM_EXRR

ActionNone.


Return Codes for Hitachi Command Suite Common AgentComponent

When an operation requested of HDLM from Global Link Manager terminatesabnormally, or terminates normally with a warning, HDLM outputs one of thereturn codes described below.

ReturnCode Explanation

1002 DetailsThere is no path on which the operation can be performed.

ActionRefresh the host information, check the path status, and thenperform the operation again.

1003 DetailsNo path was detected.

ActionCheck whether a path between the host and the storage system isconnected. If a path is connected, check whether HDLM is configuredcorrectly.

1004 DetailsMemory required for HDLM internal processing could not be allocated.

ActionTerminate unnecessary applications to increase free memory, orrestart the host.

1006 DetailsAn Offline path cannot be placed Online.

ActionRemove the error in the path, and then retry.

1007 DetailsThe target path of the offline operation is the last, remaining pathconnected to the device and therefore, cannot be placed in the offlinestatus.

ActionClick Refresh to update the host information, check the path status,and then retry the offline operation.

1015 DetailsThe Offline path cannot be placed Online.

ActionRemove the error in the path, and then retry.

1016 DetailsThe target path(s) are already Online.

ActionUpdate the host information, and then check the path status.



1017 DetailsThe target path(s) are already Offline(C).

ActionUpdate the host information, and then check the path status.

1019 DetailsAcquisition of HDLM Manager information failed.

ActionExecute the DLMgetras utility for collecting HDLM error information,and then contact your HDLM vendor or the maintenance company ifyou have a maintenance contract for HDLM. For details on theDLMgetras utility, see The DLMgetras Utility for Collecting HDLM ErrorInformation on page 7-2.

1020 DetailsAn unexpected error occurred during HDLM internal processing.

ActionExecute the DLMgetras utility for collecting HDLM error information,and then contact your HDLM vendor or the maintenance company ifyou have a maintenance contract for HDLM. For details on theDLMgetras utility, see The DLMgetras Utility for Collecting HDLM ErrorInformation on page 7-2.

1022 DetailsBatch registration of Offline processing was performed.

ActionRefresh the host information, and then check the path status.

1023 DetailsBatch registration of Offline processing has already beenperformed.

ActionRefresh the host information, and then check the path status.

1025 DetailsA parameter value is invalid.

ActionRefresh the host information, and then perform the operation again.If the same error occurs again, execute the DLMgetras utility forcollecting HDLM error information, and then contact your HDLMvendor or maintenance company if you have a maintenance contractfor HDLM. For details on the DLMgetras utility, see The DLMgetrasUtility for Collecting HDLM Error Information on page 7-2.

1026 DetailsThe acquisition of path information has been aborted, because thepath configuration was changed while the system was attempting toacquire the path information.

Action



Refresh the host information, check the path status, and thenperform the operation again.

1033 DetailsAn attempt to acquire the HDLM version information failed.

ActionRe-execute the command. If the same error occurs again, executethe DLMgetras utility for collecting HDLM error information, and thencontact your HDLM vendor or maintenance company if there is amaintenance contract for HDLM. For details on the DLMgetras utility,see The DLMgetras Utility for Collecting HDLM Error Information onpage 7-2.

1034 DetailsAn attempt to acquire information about the HDLM version or SPversion has failed.






1037 DetailsA parameter is invalid.

ActionRefresh the host information, and then perform the operation again.If the same error occurs again, execute the DLMgetras utility forcollecting HDLM error information, and then contact your HDLM



vendor or maintenance company if you have a maintenance contractfor HDLM. For details on the DLMgetras utility, see The DLMgetrasUtility for Collecting HDLM Error Information on page 7-2.

1038 DetailsA storage system that cannot use the load balancing function isconnected.

ActionCheck the system configuration. One or more connected storagesystems cannot use the load balancing function. The load balancingfunction does not operate on the LUs of such storage systems.

1041 DetailsAn attempt to communicate with the HDLM manager has failed.

ActionCheck whether the HDLM manager is running on the host. If it is notrunning, start the HDLM manager.

1042 DetailsInformation about the path configuration on the specified LU does notmatch the path configuration information held by HDLM.

ActionRefresh the host information, check the path status, and thenperform the operation again.

1043 DetailsThe specified LU is part of a storage system that cannot use the loadbalancing function.

ActionCheck the storage system of the LU that is connected by the specifiedpath.


ActionRefresh the host information, and then perform the operation again.If the same error occurs even again, execute the DLMgetras utility forcollecting HDLM error information, and then contact your HDLMvendor or maintenance company if you have a maintenance contractfor HDLM. For details on the DLMgetras utility, see The DLMgetrasUtility for Collecting HDLM Error Information on page 7-2.


ActionRefresh the host information, and then perform the operation again.If the same error occurs again, execute the DLMgetras utility forcollecting HDLM error information, and then contact your HDLMvendor or maintenance company if you have a maintenance contractfor HDLM. For details on the DLMgetras utility, see The DLMgetrasUtility for Collecting HDLM Error Information on page 7-2.



1054 DetailsThe specified storage system or LU cannot use the dynamic I/O pathcontrol function.

ActionNone.

1055 DetailsName resolution from a host name to an IP address failed.

ActionVerify that name resolution can be performed from the remotemanagement client for host names, and then retry the operation. Ifthe same error occurs again, execute the DLMgetras utility forcollecting HDLM error information, and then contact your HDLMvendor or maintenance company if you have a maintenance contractfor HDLM. For details on the DLMgetras utility, see The DLMgetrasUtility for Collecting HDLM Error Information on page 7-2.

1056 DetailsOne of the following caused a problem with communication betweenthe remote management client and the host:¢ The host did not respond.¢ HDLM is not installed on the host.¢ Host authentication failed.¢ A communication error with the host occurred.

ActionCheck the following:¢ Make sure the host can be accessed from the remote

management client by using the command dlnkmgr.¢ Make sure the system environment variables perlpath and

vclipath are not specifieed.¢ If the system environment variables perlpath and vclipath are

specified, make sure the paths specified for perlpath and vclipathare added to the system environment variable Path. In addition,make sure the added paths are not enclosed in double quotationmarks (").

If the same error occurs again, execute the DLMgetras utility forcollecting HDLM error information, and then contact your HDLMvendor or maintenance company if you have a maintenance contractfor HDLM. For details on the DLMgetras utility, see The DLMgetrasUtility for Collecting HDLM Error Information on page 7-2.

1059 DetailsThe specified host is not registered in the Credential Store on theremote management client.

ActionVerify that the specified host is registered in the Credential Store onthe remote management client. If the host is registered in theCredential Store, execute the DLMgetras utility for collecting HDLM



error information, and then contact your HDLM vendor ormaintenance company if you have a maintenance contract for HDLM.For details on the DLMgetras utility, see The DLMgetras Utility forCollecting HDLM Error Information on page 7-2.

1061 DetailsA value outside the valid range is specified for the check interval ofthe dynamic I/O path control function.

ActionSpecify a value in the range from 5 through 1440 for the checkinterval of the dynamic I/O path control function, and then retry theoperation.

1063 DetailsAn attempt to update global-active device non-preferred pathoption failed.

ActionIf a path error occurs during an update operation and this message isoutput, perform recovery for the path error to return the path to theonline status, and then try the operation again. If this message isoutput when there are no offline paths, execute the DLMgetras utilityfor collecting HDLM error information, and then contact your HDLMvendor or maintenance company if you have a maintenance contractfor HDLM.


Acronyms and abbreviations

The following acronyms and abbreviations might be used in this guide.

A

ALArbitrated Loop

APIApplication Programming Interface

ASCAdditional Sense Code

ASCQAdditional Sense Code Qualifier

B

BIOSBasic Input / Output System

C

CHAChannel Adapter

CLPRCache Logical Partition

# A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Acronyms-1Hitachi Dynamic Link Manager (for VMware®) User Guide

CPUCentral Processing Unit

CUControl Unit

D

DBMSDatabase Management System

DevDevice

DNSDomain Name Server

F

FCFibre Channel

FC-SPFibre Channel Security Protocol

FOFailover

FQDNFully Qualified Domain Name

G

GMTGreenwich Mean Time

H

HBAHost Bus Adapter



HDevHost Device

HLUHost Logical Unit

HTTPHypertext Transfer Protocol

I

I/OInput/Output

IPInternet Protocol

iSCSIInternet Small Computer System Interface

L

LANLocal Area Network

LDAPLightweight Directory Access Protocol

LDEVLogical Device

LULogical Unit

LUNLogical Unit Number

N

NASNetwork Attached Storage



NICNetwork Interface Card

NMPNative Multipathing Plugin

NTPNetwork Time Protocol

O

OSOperating System

P

PPort

PSPPath Selection Plugin

R

RADIUSRemote Authentication Dial in User Service

S

SANStorage Area Network

SATPStorage Array Type Plugin

SCSISmall Computer System Interface

SLPRStorage Logical Partition



SMTPSimple Mail Transfer Protocol

SNMPSimple Network Management Protocol

SPService Pack

SSLSecure Sockets Layer

SVPService Processor

U

UIDUser Identifier

W

WWNWorld Wide Name



Glossary

This glossary explains the terms used in this manual.

A

automatic failbackA function for checking the status of paths at regular intervals, and automaticallyplacing the status of a path recovered from an error into the Online status.If a path with an Offline(E) status recovers from an error, an automatic failback willplace the path Online.Automatic failbacks check the status of paths that were placed in the Offline(E) statusbecause of an error, but do not check the status of paths that were placed in theOffline(C) status by executing an offline operation. For details on offline operations,see offline (Places Paths Offline) on page 6-7.

AutoPATH_IDAn ID that HDLM assigns to a path during the system startup. Every path has a uniqueAutoPATH_ID.(See also: path)

B

boot disk environmentAn environment in which the startup disk is in a storage system instead of in the host.

C

CHA (Channel Adapter)An adapter for controlling the channels of a storage system.


Glossary-1Hitachi Dynamic Link Manager (for VMware®) User Guide

CLPR(Cache Logical Partition)A function supported by the Universal Storage Platform V/VM series, Virtual StoragePlatform series, VSP G1000 series, Hitachi AMS2000/AMS/WMS/SMS series, HUS100series, and HUS VM for logically splitting up a cache. This function can split up a cacheinto parity groups in the storage system, so that other parity groups do not affect thecache performance.

D

Dev (Device)A target that HDLM controls and operates. A Dev is called a device in VMware vSphere.In VMware vSphere, each LU has only one Dev.Each Dev has a Dev number.(See also: Dev number)

Dev numberA Dev number (the DNum column) in the configuration list in HDLM.0 is displayed as the number indicating the entire LU.HDLM operates assuming that one LU has one Dev, so the Dev number is always fixedto 0.(See also: Dev)

E

emulation typeAn LU type that is accessible from a host. Since an HDLM host is an open-system hostsuch as a PC or a UNIX computer, the HDLM host can access only the LUs that haveopen-system emulation types.For details on emulation types supported by a storage system, see the maintenancemanual for that particular storage system.

F

failbackA function for placing the status of a path recovered from an error into the Onlinestatus, and then switching the access path to the path that was just recovered.

failoverA function for switching to another normal path if there is an error in the current accesspath, thereby enabling the system to continue to operate.



H

HAM environmentAn environment in which volume pairs that are synchronized between two storagesystems are created by HAM (High Availability Manager), and hosts are configured torecognize these volumes as one volume. An HAM environment consists of the primaryvolume (P-VOL) in the primary site and the secondary volume (S-VOL) in the secondarysite. When an error occurs on one of the volumes, the path can be switched to the othervolume by using HDLM.

HBA (Host Bus Adapter)Device that functions as an interface connecting a host with external devices.In this manual, the term HBA refers to an interface card installed in a host, inconfigurations where the host and storage units are connected via a FC connection.

HDLM driverA program that controls all the HDLM functions, manages paths, and detects errors.

HDLM managerA program that monitors the operational status of hosts by linking with Global LinkManager, when Global Link Manager is used to manage HDLM.

hostAn ESXi server that connects to storage subsystems via a SAN.

host deviceA logical area in a host LU.(See also: host LU, host device name)

host device nameA name assigned to a host device.

host LUAn LU that a host recognizes. The actual HDev entity is a Dev in the storage system.Each host LU has a host LU number.(See also: LU, host LU number, host device)

host LU numberA number assigned to a host LU. The host LU number is part of a path name.(See also: host LU, path name)

I

intermittent errorAn error that occurs irregularly due to, for example, a loose cable connection.



L

LDEV (Logical Device)A combination of the storage system's product name, serial number, and an internal LU.HDLM uses this value to identify a particular LU.

load balancingFunctionality for distributing the load across the paths that access each area within anLU. To distribute loads, load balancing uses multiple paths to perform I/O operations.Load balancing uses VMware vSphere PSPs. HDLM can use the following load balancingalgorithms:- The Extended Round Robin algorithm- The Extended Least I/Os algorithm- The Extended Least Blocks algorithm- The Most Recently Used algorithm (VMware)- The Round Robin algorithm (VMware)

LU (Logical Unit)A logical unit that is a logical volume defined in the storage system, and with which thehost can perform input or output operations.(See also: host LU)

N

non-owner controllerA controller other than an owner controller.Non-owner controllers exist only in the Hitachi AMS/WMS series.(See also: owner controller, non-owner path)

non-owner pathA path that passes through a non-owner controller.Non-owner paths exist only in the Hitachi AMS/WMS series.(See also: owner path, non-owner controller)

O

owner controllerA controller that has been set as an owner controller for an LU. Owner controllers areonly in the Hitachi AMS/WMS series. A controller other than an owner controller is calleda non-owner controller.When using the Universal Storage Platform V/VM series, Virtual Storage Platform series,VSP G1000 series, Hitachi AMS2000 series, Hitachi SMS series, HUS100 series, or HUSVM, all controllers are owner controllers.(See also: owner path, non-owner controller)



owner pathA path that passes through an owner controller for an LU in the Hitachi AMS/WMSseries. A path that passes through a controller other than an owner controller is called anon-owner path.When using the Universal Storage Platform V/VM series, Virtual Storage Platform series,VSP G1000 series, Hitachi AMS2000 series#, Hitachi SMS series#, HUS100 series#, orHUS VM, all paths are owner paths.(See also: owner controller, non-owner path)#This storage system applies when the dynamic I/O path control function is disabled.

P

pathAn access path from a host to a storage system. Access to an area within an LU in astorage system is made via a cable connecting the HBA on the host and the CHA on thestorage system. This cable is a path. Each path has an AutoPATH_ID.(See also: AutoPATH_ID)

path health checkingA function for checking the status of paths at regular intervals.When an error occurs on a path that was in the Online status, path health checkingchanges the status of the path to the Offline(E) status.Path health checking checks only those paths that have the Online status.

path nameThe path name consisting of the following four elements, separated by periods:- Host port number (hexadecimal number)- Bus number (hexadecimal number)- Target ID (hexadecimal number)- Host LU number (hexadecimal number)A path name is used to identify a path.(See also: host LU number)

R

remote management clientA machine that connects to a host via a LAN, and uses commands and utilities to controlit.

reservationThe reservation function enables a host to declare that it has exclusive rights to use aparticular LU, and prevents other hosts from accessing that LU. Access permission foran LU that has been reserved is given only to the host that issued the reservation, so



the LU cannot be accessed from multiple paths (coming from multiple hosts)simultaneously. However, because of this, load balancing is not possible.(See also: persistent reservation)

S

SAN (Storage Area Network)A high-speed network connecting hosts to storage systems. This network is independentof a LAN and is dedicated to data transfers. A SAN provides faster access to storagesystems, and prevents the transfer of high-volumes of data from deteriorating LANperformance.

SCSI deviceA SCSI disk device.

SLPR (Storage Logical Partition)A function supported by Universal Storage Platform V/VM series, Virtual StoragePlatform series and VSP G1000 series for logically splitting up a storage system. Thisfunction splits up the resources, such as ports, CLPR, and volumes, in the storagesystem, so that the user can manage each resource independently.



Index

A

applying storage system settings to HDLM 6-57audit log

categories and audit events that HDLM canoutput 2-28collecting data 2-26data format 2-31

automatic failback 2-15, Glossary-1automatic failover 2-14automatic path switching 2-13AutoPATH_ID 2-2, 2-4, Glossary-1

B

boot disk environment Glossary-1buffer size 3-21bus number 6-44

C

CHA 2-3, 2-5CHA (Channel Adapter) Glossary-1Changing the Status of Paths 4-3channel adapter 2-2, 2-4checking

message error information 5-2clear 6-3CLPR(Cache Logical Partition) Glossary-2collecting error information 2-26command

format 6-2overview 6-2

command device 2-2

command of HDLM (dlnkmgr)clear 6-3help 6-5offline 6-7online 6-10set 6-15view 6-23

configuration of HDLM systemconfiguration of HDLM system using FC-SAN 2-2

Critical 8-2

D

default and recommended values 6-16Dev 2-2, 2-4, 2-5, Glossary-2Dev number Glossary-2Disk Requirements 3-4displaying

information 6-23path information (by abbreviating the list items)

6-24path information (by selecting a display item)6-24path information (without selecting items to bedisplayed) 6-24

displaying program informationhost 6-24remote management client 6-24

Distributing a Load Using Load Balancing 2-8DLMgetras 5-5, 5-6, 7-2dlmrmcenv 7-7dlnkmgr 6-1dynamic I/O path control 3-18

Index-1Hitachi Dynamic Link Manager (for VMware®) User Guide

E

Elements of a path name 6-44emulation type Glossary-2Error 8-2error information 2-24

checking in messages 5-2collecting with DLMgetras 7-2list of error info. collected by the DLMgetrasutility for collecting error info. 7-4

error levelsCritical 8-2Error 8-2Information 8-2Warning 8-2

error log 2-25error path

identifying 5-3errors

management 2-23event log 2-25examining

message 5-3, 5-5

F

failback 1-3, 2-13, Glossary-2failover 1-3, 2-13, Glossary-2FC-SAN 2-2, 2-3features of HDLM 1-2firewall

exceptions list 3-14firewall setting

deregistering exceptions 3-23folder to which collected information is output 7-3function

HDLM program 2-7functions of HDLM 2-1

G

Global Link Manager 2-33glossary Glossary-1

H

HAM environment Glossary-3handling

path error 5-2HBA 2-3HBA (Host Bus Adapter) Glossary-3HDev 2-6HDLM

features 1-2functions 2-1installing 3-7new installation 3-7overview 1-1re-installation 3-12removing 3-23setup 3-16upgrade installation 3-11

HDLM command 2-7HDLM driver 2-7, 2-8, Glossary-3HDLM environment

creating 3-1HDLM installation

types 3-5HDLM installation type

new installation of HDLM 3-5re-installation of HDLM 3-5upgrade installation of HDLM 3-5

HDLM management-target devices 2-2HDLM manager 2-7, Glossary-3

starting 4-9stopping 4-9

HDLM programfunction 2-7

HDLM program informationhost 6-26remote management client 6-29

HDLM resident processes 4-10HDLM utility 2-7help 6-5HLU 2-6host 3-2, Glossary-3host bus adapter 2-2host device Glossary-3host device name Glossary-3host LU Glossary-3host LU number 6-44, Glossary-3host port number 6-44

I

I/O


count 6-3errors 6-3

identifyingerror part 5-4error path 5-3

Information 8-2installation 3-7

new installation of HDLM 3-7re-installation of HDLM 3-12upgrade installation of HDLM 3-11

installation-information settings file[INSTALLATION_SETTINGS] section 7-9

installhdlm 7-8integrated HDLM management 2-33integrated trace file 2-25integrated trace information file 3-20integrated traces

setup 3-20intermittent error Glossary-3

definition 2-16Intermittent Error Monitoring 3-18IP-SAN 2-3, 2-5iSCSI 2-5iSCSI host bus adapter 2-3iSCSI software 2-3

J

JRE 3-3Global Link Manager 3-3

L

LDEV (Logical Device) Glossary-4Load Balancing 3-17load balancing 1-3, 2-8, 6-16, Glossary-4load balancing algorithms 2-12logical unit 2-2, 2-4LU 2-3, 2-5

configuration 2-6LU (Logical Unit) Glossary-4LU configuration recognized by the host 2-6

M

manual path switching 2-16Memory Requirements 3-4message

examining 5-3, 5-5terms that appear 8-2terms used for explanation 8-2

message IDformat and meaning 8-2

Message level 8-2Messages 8-1, 8-2messages

checking error information 5-2monitoring cycle 3-22

N

narrowing downhardware causing error 5-4

network interface card 2-3NMP 2-8non-owner controller 2-10, Glossary-4non-owner path 2-10, Glossary-4Number of LUs That Are Supported by HDLM 3-4Number of Paths That Are Supported by HDLM 3-4

O

obtainingpath information 5-3program information 5-5

offline 2-13, 6-7offline(C) status 2-17offline(E) status 2-17online 2-13, 6-10online status 2-17online(D) status 2-17online(S) status 2-17operating environment 6-15

setting 6-15viewing [view operation] 6-28, 6-30

Operation name 8-2operations 6-2, 6-3

displaying format 6-5of the HDLM command 6-2

OS 3-2overview

command 6-2HDLM 1-1

owner controller 2-10, Glossary-4owner path 2-10, Glossary-5


P

P 2-3, 2-5path 2-2, 2-4, Glossary-5

checking the configuration 3-15path error

handling 5-2Path Health Checking 2-22path health checking 1-3, 2-22, Glossary-5path information

obtaining 5-3path name Glossary-5path status transition 2-17path status transitions 2-18path switching

automatically 2-13manually 2-16

paths to which load balancing is applied 2-10Performing Failovers and Failbacks Using PathSwitching 2-13placing a path or paths offline 6-7placing a path or paths online 6-10placing online

path 5-4port 2-2, 2-4product ID 6-39, 6-42, 6-43Product ID displayed by the view -path operation

6-44program

configuration 2-6program error

what to do for 5-4, 5-5program information

host 6-26obtaining 5-5remote management client 6-29

R

refresh (HDLM command operation) 6-57remote management client 1-2, Glossary-5removal

HDLM 3-23removehdlm 7-11reservation Glossary-5

S

SAN (Storage Area Network) Glossary-6SCSI device Glossary-6serial number 6-42set 6-15settings when managing HDLM by using GlobalLink Manager 3-12setup

HDLM 3-16integrated traces 3-20

SLPR(Storage Logical Partition) Glossary-6starting

HDLM manager 4-9statistics 6-3

clearing to the initial value 6-3status transitions (P-VOL in HAM environment)2-19stopping

HDLM manager 4-9storage system 1-2Storage Systems 3-3syslog 2-25system configuration 2-2, 2-3

T

taking actions forhardware error 5-4

target ID 6-44trace file 2-25types of collected logs 2-24types of ESXi host error information 2-25

U

utilitiesfor collecting HDLM error information 7-2for removing HDLM 7-11installing HDLM 7-8overview 7-2utility for configuring HDLM remotemanagement client environments 7-7

utility for configuring HDLM remote managementclient environments 7-7utility for removing HDLM 7-11


V

vendor ID 6-39, 6-42, 6-43view 6-23Viewing and Setting Up the Operating Environment

4-5Viewing Path Information 4-2

W

Warning 8-2what is HDLM? 1-2what to do for

program error 5-4, 5-5


Hitachi Dynamic Link Manager (for VMware®) User Guide

Hitachi Data Systems

Corporate Headquarters2845 Lafayette StreetSanta Clara, California 95050-2639U.S.A.www.hds.com

Regional Contact Information

Americas+1 408 970 [email protected]

Europe, Middle East, and Africa+44 (0)1753 [email protected]

Asia Pacific+852 3189 [email protected]

MK-92DLM130-09