MK-92ADPTR108-04 Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide v01.3.1 Platform Support Hardware and Software Requirements Getting Help F AST F IND L INKS
MK-92ADPTR108-04
Hitachi Storage Connector for VMware vRealize Orchestrator
User’s Guide v01.3.1
Platform Support
Hardware and Software Requirements
Getting Help
FASTFIND LINKS
© 2016 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 retrieval system 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 and assumes no responsibility for its use. This document contains the most current information available at the time of publication. When new or revised information becomes available, this entire document 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 most recent product announcement for information about feature and product availability, or contact Hitachi Data Systems Corporation at https://portal.hds.com.
Notice: Hitachi, Ltd., products and services can be ordered only under the terms and conditions of the applicable Hitachi Data Systems Corporation agreements. The use of Hitachi, Ltd., products is governed 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. Hitachi Data Systems is a registered trademark and service mark of Hitachi, Ltd., in the United States and other countries.
Archivas, Essential NAS Platform, HiCommand, Hi-Track, ShadowImage, Tagmaserve, Tagmasoft, Tagmasolve, Tagmastore, TrueCopy, Universal Star Network, and Universal Storage Platform are registered trademarks of Hitachi Data Systems Corporation.
AIX, AS/400, DB2, Domino, DS6000, DS8000, Enterprise Storage Server, ESCON, FICON, FlashCopy, IBM, Lotus, MVS, OS/390, RS6000, 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 International Business Machines Corporation.
All other trademarks, service marks, and company names in this document or website are properties of their respective owners.
Microsoft product screen shots are reprinted with permission from Microsoft Corporation.
Contents 3
Hitachi Storage Connector for VMware vRealize Orchestrator User's Guide
Contents
Contents .......................................................................... 3
Preface .......................................................................... 10
1 Introduction ................................................................... 17
2 System Requirements ...................................................... 21
Supported Operating Systems ..............................................24
Supported Interfaces ..........................................................24
3 Installation and Configuration ........................................... 27
Preliminary steps (all devices) ..............................................28
Hitachi vRO Connector web service configuration ....................28
Modular arrays ...................................................................28
Enterprise arrays ...............................................................28
Hitachi NAS (HNAS) devices ................................................29
Run Hitachi-vROStorageConnector-setup(01.3.1)-(x64)-01.exe 29
Add the plug-in component to vRealize Orchestrator ...............29
Configuring Windows Service Access .....................................30
Using HTTPS (Optional) .......................................................31
Implementing the certificate ................................................33
Modular Arrays ..................................................................33
4 Contents
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Enterprise Arrays ............................................................... 33
Java Runtime Environment .................................................. 33
Hitachi Command Control Interface (CCI) .............................. 33
Hitachi NAS (HNAS) devices .................................................. 35
Uninstalling the Hitachi Storage Connector from the Orchestrator Server ............................................................................ 35
Upgrading Hitachi Storage connector for vRealize Orchestrator .. 36
Supported Configurations .................................................... 37
Hitachi Storage Workflows ................................................ 41
Hitachi vRO Connector Web Service Configuration .................... 41
Add Hitachi Storage Web service host ................................... 41
Modify Hitachi Storage Web service host ............................... 42
Delete Hitachi Storage Web service host ............................... 42
Storage Subsystem Profile .................................................... 42
Add Enterprise Subsystem Profile ......................................... 42
Add HNAS Profile ............................................................... 44
Add Modular Array Profile .................................................... 44
Add V2I Server Profile ........................................................ 45
Delete Subsystem Profile .................................................... 46
Block – Storage Configuration ............................................... 46
Add Modular Array ............................................................. 46
Add Enterprise Array .......................................................... 47
Add Enterprise Subsystem using credential ........................... 47
Add Modular Array using Credential ...................................... 48
Close all Storage Array Connections ..................................... 48
Add Virtual Storage Array ................................................... 48
Get Virtual Storage Arrays .................................................. 49
Get Registered Storage Arrays ............................................. 49
Block – Provisioning ............................................................. 49
Create LU in Parity Group ................................................... 49
Introduction 5
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Create LU in Dynamic Pool...................................................50
Create LU in RAID Group .....................................................51
Delete LU ..........................................................................52
Present LU ........................................................................52
Unpresent LU .....................................................................53
Get LUs ............................................................................54
Get Hostgroups ..................................................................54
Get Hostgroups associated with an LU ...................................55
Get Hostgroups associated with a WWN ................................55
Get WWNs associated with a target port ................................55
Create Hostgroup ...............................................................56
Delete HostGroup ...............................................................57
Add WWN(s) to Hostgroup ...................................................58
Remove WWN(s) from Hostgroup .........................................58
Expand LU Size ..................................................................59
Create Dynamic Pool on Enterprise Array ...............................60
Delete Dynamic Pool Using Pool ID .......................................60
Delete Dynamic Pool Using Pool name ...................................61
Expand Pool Using Pool ID ...................................................61
Expand Pool Using Pool Name ..............................................62
Shrink Pool Using Pool ID ....................................................62
Shrink Pool Using Pool Name ...............................................63
Get Storage Pools ..............................................................64
Create V-VOL ....................................................................64
Create V-VOL (automatic V-VOL ID) .....................................64
Get Hostgroups for Port ......................................................65
Block – ShadowImage ..........................................................66
Create ShadowImage Pair ...................................................66
Delete ShadowImage Pair ...................................................67
Resync ShadowImage Pair ...................................................68
Split ShadowImage Pair ......................................................68
6 Contents
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Restore ShadowImage Pair ................................................. 69
Get ShadowImage Pairs ...................................................... 69
Create ShadowImage Pair with Consistency Group ................. 70
Split ShadowImage Group ................................................... 71
Block – Snapshot Backup ...................................................... 72
Create Modular Array Snapshot Pair ..................................... 72
Create Enterprise Snapshot Pair ........................................... 72
Restore Snapshot Pair ........................................................ 73
Delete Snapshot Pair .......................................................... 74
Resync Snapshot Pair ......................................................... 74
Split Snapshot Pair ............................................................. 75
Create Modular Snapshot Pair: named .................................. 75
Delete Snapshot Pair: named .............................................. 76
Split Snapshot Pair: named ................................................. 77
Restore Snapshot Pair: named ............................................. 77
Resync Snapshot Pair: named ............................................. 78
Get Snapshot Pairs ............................................................ 78
Get Snapshot Pairs: named ................................................. 79
Create Enterprise Snapshot Pair with Group Name .................. 79
Create Enterprise Snapshot Pair without VVOL ....................... 80
Create Modular Snapshot Pair with Consistency Group ............ 81
Split Snapshot Group ......................................................... 82
Delete Snapshot Group using Group name ............................ 83
Resync Snapshot Group using Group name ........................... 83
Restore Snapshot Group using Group name ........................... 84
Split Snapshot Group using Group Name ............................... 84
Map HTI Floating Snapshot Volume ...................................... 85
Unmap HTI Snapshot Volume .............................................. 85
Block – TrueCopy ................................................................. 86
Create TrueCopy Pair ......................................................... 86
Delete TrueCopy Pair .......................................................... 86
Introduction 7
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Resync TrueCopy Pair .........................................................87
Split TrueCopy Pair .............................................................88
Get TrueCopy Pairs .............................................................88
Create Global Active Device Pair ...........................................89
Create Universal Replication Pair ..........................................90
Block - iSCSI Targets ............................................................91
Create iSCSI Target ............................................................91
Add an Initiator to iSCSI Target ...........................................92
Remove an Initiator from an iSCSI Target .............................92
Present LU: iSCSI ...............................................................93
Unpresent LU: iSCSI ...........................................................93
Get iSCSI Targets ..............................................................94
HNAS Workflows – File/Storage Configuration ..........................94
Add HNAS .........................................................................94
Add HNAS using credential ..................................................95
Get registered HNAS Fileserver ............................................95
HNAS Workflows – File/Provisioning ........................................95
Create File Clone ................................................................95
Create Filesystem ...............................................................96
Delete File System .............................................................96
Create NFS Export ..............................................................97
Delete NFS Export ..............................................................98
Add Root Hosts to NFS Export ..............................................99
Add RW hosts to NFS Export .............................................. 100
Remove Root Hosts from NFS Export .................................. 100
Remove RW Hosts from NFS Export .................................... 101
Set Filesystem Size .......................................................... 102
Set NFS Export Size ......................................................... 102
Set Filesystem Syslock ...................................................... 103
Get Filesystems ............................................................... 103
Get NFS Exports .............................................................. 104
8 Contents
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Get NFS Exports: by Export Name ..................................... 104
Get NFS Exports: by NFS Client(s) .................................... 105
Mount Filesystem ............................................................. 105
Unmount an HNAS Filesystem ........................................... 105
Create Filesystem snapshot ............................................... 106
Delete Filesystem Snapshot ............................................... 106
Get Filesystem Snapshots ................................................. 107
High-level workflows .......................................................... 108
Backup ESXi Datastore ..................................................... 108
Mount the most recent VM backups .................................... 108
Provision ESXi Datastore using HNAS NFS export ................. 109
Smart Provision a LUN/Datastore to a host/cluster ............... 109
Self service VM recovery ................................................... 109
Supporting Workflows ........................................................ 110
Convert Datastore to a PVOL number ................................. 110
Get ESXi Host WWN ......................................................... 110
Provision an NFS export to an ESXi host .............................. 111
Hitachi Virtual Infrastructure Integrator ............................ 111
V2I Configuration .............................................................. 112
Add V2I Server ................................................................ 112
Connect VIServer using credential ...................................... 112
Snapshot Backup ............................................................... 113
Clone VM ........................................................................ 113
Restore VM to Alternate Location ....................................... 114
Backup VM ...................................................................... 114
Backup All V2I managed VMs ............................................ 115
Mount VM ....................................................................... 116
UnMount VM ................................................................... 117
Get list of Backups ........................................................... 118
V2I Backup Group .............................................................. 118
Introduction 9
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Create Backup Group ........................................................ 118
Add Backup group member ............................................... 119
Get Backup group members ............................................... 119
Delete Backup Group member............................................ 120
Get Backup groups ........................................................... 120
4 Troubleshooting ............................................................ 123
Hitachi Storage Connector Logs .......................................... 125
Hitachi Storage Web Service Log ........................................ 125
Modifying the Log Level ..................................................... 126
Hitachi Log Message Format .............................................. 126
Error Codes ....................................................................... 126
Abbreviations, Terms, and Acronyms ............................... 143
Preface 10
Hitachi Storage Connector for VMware vRealize Orchestrator User's Guide
Preface
Intended Audience Software Version Release Notes Reference Documents Document Conventions Convention for Storage Capacity Values Getting Help Comments
Note The use of Hitachi Storage Connector for VMware vRealize
Orchestrator and all other Hitachi Data Systems products is governed by the terms of your agreement(s) with Hitachi Data Systems.
Introduction 11
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Intended Audience
This document is intended for VMware Administrators and Hitachi Storage Administrators familiar with the supported Hitachi subsystems and VMware software, including:
VMware vRealize Orchestrator (formerly VMware vCenter Orchestrator)
VMware vSphere VMware ESXi
Release Notes
Release notes are on the documentation CD. Release notes contain requirements and more recent product information that may not be fully described in this manual. Be sure to review the release notes before installation.
Reference Documents
Hitachi Command Control Interface Installation and Configuration Guide, MK-91DF8306-XX
Hitachi Command Control Interface Command Reference, MK-90RD7009-XX
Hitachi Command Control Interface User and Reference Guide, MK-90RD7010-XX
Hitachi Virtual Storage Platform G1000/Hitachi Universal Volume Manager User’s Guide, MK-92RD8024-XX
Hitachi Virtual Infrastructure Integrator Quick Start Guide, MK-92HNAS002-06
12 Preface
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Document Conventions
This document uses the following typographic conventions:
Convention Description
Bold Indicates text on a window, other than the window title, including menus, menu options, buttons, fields, and labels. Example: Click OK.
Italic Indicates a variable, which is a placeholder for actual text provided by you or the system. Example: copy source-file target-file
screen/code Indicates text on screen or that you enter Example: # pairdisplay -g oradb
< > angled brackets
Indicates a variable, which is a placeholder for actual text provided by you or the system. Example: # pairdisplay -g <group>
[ ] square brackets
Indicates optional values. Example: [ a | b ] indicates that you can choose a, b, or nothing.
{ } braces Indicates required or expected values. Example: { a | b } indicates that you must choose either a or b.
| vertical bar Indicates that you have a choice between two or more options or arguments. Examples: [ a | b ] indicates that you can choose a, b, or nothing. { a | b } indicates that you must choose either a or b.
This document uses the following icons to draw attention to information:
Icon Label Description
Note Calls attention to important and/or additional information.
Tip Provides helpful information, guidelines, or suggestions for performing tasks more effectively.
Caution Warns you about adverse conditions and/or consequences (for example, disruptive operations).
Introduction 13
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Icon Label Description
WARNING Warns about severe conditions and/or consequences (for example, destructive operations).
Convention for Storage Capacity Values
We calculate physical storage capacity values (for example, disk drive capacity) based on the following values:
1 KB 1,000 bytes 1 MB 1,0002 bytes 1 GB 1,0003 bytes 1 TB 1,0004 bytes 1 PB 1,0005 bytes 1 EB 1,0006 bytes
We calculate logical storage capacity values (logical device capacity) based on the following values:
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 1 BLOCK 512 bytes
Physical Capacity Unit Value
Logical Capacity Unit Value
14 Preface
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Getting Help
The Hitachi Data Systems Support Center staff is available 24 hours a day, seven days a week. Provisions for patches and fixes are restricted to normal business hours, 8 a.m. to 5 p.m. PST.
To reach us, please visit the support web site for current telephone numbers and other contact information: http://www.hds.com/services/support/. If you purchased this product from an authorized HDS reseller, contact that reseller for support.
Before calling the Hitachi Data Systems Support Center, please provide as much information about the problem as possible, including:
The circumstances surrounding the error or failure. The exact content of any error message(s) displayed on the host
system(s).
Comments
Please send us your comments on this document: [email protected]. Include the document title, number, and revision, and refer to specific section(s) and paragraph(s) whenever possible.
Thank you! (All comments become the property of Hitachi Data Systems Corporation.)
Introduction 15
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Introduction 17
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Introduction
Overview
Conceptual Diagram
High-Level Network Diagram
18 Introduction
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Overview
Hitachi Storage Connector for VMware vRealize Orchestrator adds workflows to vRealize Orchestrator that automate configuration and provisioning operations on Hitachi storage devices.
By combining the workflows provided by this product with those provided by VMware, it is possible to automate provisioning ESXi datastore, end-to-end VM deployments and other operations that include Hitachi storage devices.
For example, a Clone VM workflow allows you to clone a virtual machine that is backed up on Hitachi storage.
Main Components
Hitachi Storage Connector – This software installs as an addition to vRealize Orchestrator and adds Hitachi workflows to the Orchestrator library. It sends storage operations triggered by workflows to the web service component to be carried out. This component is represented by a file named o11nplugin-HSC.dar.
Hitachi Storage Web Service – This is a Windows service named Hitachi Storage Connector Service for vRealize Orchestrator. It communicates with the plug-in using HTTP or HTTPS, and performs storage operations requested by the connector.
Introduction 19
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Conceptual Diagram
20 Introduction
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
High-Level Network Diagram
System Requirements 21
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
System Requirements
Hardware Requirements Software Requirements Required Pre-operation Distribution Package
22 System Requirements
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Hardware Requirements
The table below shows the hardware for the adapter.
Note You must use Storage Navigator in Modify mode to perform
Universal Volume Manager operations. In View mode, only Universal Volume Manager information is visible.
Item Minimum Requirements
Virtual Storage Platform 70-06-33-00/00 or newer Hitachi Unified Storage 0980/P-S or newer Hitachi Unified Storage VM 73-03-38-00/00 or newer Hitachi NAS Platform Two-Node System
Version 12.2.3719.02or newer
Virtual Storage Platform G1000 80-03-01-00/00 or newer Virtual Storage Platform Gx00 83-01-21-40/00 or newer
Memory and CPU Utilization
There are no additional requirements for memory than what is specified in the Hardware requirements for VMware vRealize Orchestrator Installation and Configuration guide.
CPU Utilization has been tested and there are no additional requirements.
Port Requirements
Port Protocol Application / Storage
80 HTTP HNAS
443 HTTPS HNAS
1099 RMI Enterprise Storage Array
51099 RMI Enterprise Storage Array
51100 RMI Enterprise Storage Array
2000 TCP Modular Storage Array
22 TCP SSH
System Requirements 23
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Port Protocol Application / Storage
2022 HTTP vRO Web Service
2023 HTTPS vRO Web Service 9000 TCP HNAS V2I Server
8443 TCP HNAS V2I Server / HNAS
860 TCP iSCSI 3260 TCP iSCSI
Software Requirements The following table provides the support matrix for the storage adapter for the vSphere software suite.
VMware vSphere
5.5 and 6.0
VMware vRealize Orchestrator
6.0.x and 7.0
VMware vRealize Automation
6.2.x and 7.0
Java Virtual Machine (JVM)
JRE 7 x64 or higher
Microsoft Visual C++
Microsoft Visual C++ 2008 SP1 Redistributable Package
Hitachi Virtual Infrastructure Integrator
3.0
24 System Requirements
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Configure Hitachi Virtual Infrastructure Integrator software to support VM management workflows placed under vRO workflow Hitachi -> Storage -> File -> Snapshot Backup and V2I Backup Group using HNAS.
Supported Operating Systems Windows Server 2008 R2 SP1 x64 Windows Server 2012 Windows Server 2012 R2
Note Hitachi recommends you update Windows with the latest patches for Hitachi Storage Connector for VMware vRealize Orchestrator.
Supported Interfaces
Hitachi Command Control Interface Version
01-36-03/04 Note Configure the Hitachi CCI to use enterprise array workflows. For
more detail on CCI configuration, refer to Hitachi Command Control Interface (CCI) section
Required Pre-operation
Perform the following storage configuration for the related workflows before using Hitachi Storage Connector for VMware vRealize Orchestrator.
Item Configuration License P.P. The licenses of required P.P.s
LUN Manager Account Authentication (optional) Dynamic Provisioning (optional)
Controller IP address is assigned for HUS controllers and VSP SVP Account Authentication License
You must install and enable the Account Authentication license in the subsystems to use the Account Authentication feature.
Dynamic Provisioning License
Install and enable the Dynamic Provisioning license (D_PROVISIONING) in the subsystems to use the HDP feature.
Hitachi Storage Web
Install and run the Hitachi Storage Web service on a Windows host in order to access the Hitachi storage.
System Requirements 25
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Item Configuration service Hitachi Virtual Infrastructure Integrator
Install and configure on VMware vSphere web client to run V2I workflows
Distribution Package
The distribution package for Hitachi Storage Connector for VMware vRealize Orchestrator contains:
The installer: Hitachi-vROStorageConnector-setup(01.3.1)-(x64)-01.exe
User’s Guide and Release Notes
26 System Requirements
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Installation and Configuration 27
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Installation and Configuration
Installing the Connector for VMware vRealize
Preliminary Steps
Uninstalling the Connector for VMware vRealize Orchestrator
Reinstalling the Connector for VMware vRealize Orchestrator
Upgrading Hitachi Storage Connector for vRealize Orchestrator
Configuring Hitachi UVM with VSP G1000
Supported Storage Functions
New Workflows
Workflows (Block Storage)
Workflows (HNAS)
High-level Workflows
28 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Installing the Connector for VMware vRealize Orchestrator
The steps required to install and configure Hitachi Storage Connector for VMware vRealize Orchestrator vary depending on the Hitachi storage device family being used: Modular arrays, Enterprise arrays, or Hitachi NAS (HNAS) devices.
Preliminary steps (all devices)
These preliminary steps are shared across all device families:
Run this product’s installer (Hitachi-vROStorageConnector-setup(01.3.1)-(x64)-01.exe) on a supported Windows host
Use VMware vRealize Configuration UI to import the plug-in provided by this product’s installer <Install dir>\dist\o11nplugin-HSC.darin to vRealize Orchestrator and restart vRealize Orchestrator server to get the plugin installed.
Use vRealize Orchestrator workflows provided by the plug-in to configure access between the plug-in and a Hitachi Windows service (also provided by this product’s installer)
Hitachi vRO Connector web service configuration
To run Hitachi Storage connector workflows, run Add Hitachi storage webservice host and provide the Hitachi storage connector web service installed IP or DNS name and the V2I installed IP address or DNS name as arguments.
Modular arrays
Modular family storage arrays are ready for use immediately following the preliminary steps.
Enterprise arrays
To use Enterprise family storage arrays, perform these additional steps on the same Windows host used to run Hitachi-vROStorageConnector-setup(01.3.1)-(x64)-01.exe:
Install Java Runtime Environment version 7, x64 edition
Install and configure Hitachi Command Control Interface (CCI) for in-band array management using an LDEV configured as a command device
Installation and Configuration 29
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Hitachi NAS (HNAS) devices
Most of the HNAS workflows work without requiring additional configuration. To allow all HNAS workflows to be used—including those listed in the “Snapshot Backup and V2I Backup Group” folder:
Install and configure Hitachi Virtual Infrastructure Integrator (V2I) on a Windows host supported by V2I
Use the Connect VIServer workflow provided under Hitachi -> Storage -> File -> Storage Configuration to use Snapshot group and V2I Backup Group workflows
Preliminary Steps
Run Hitachi-vROStorageConnector-setup(01.3.1)-(x64)-01.exe
On a supported Windows host, install Hitachi Storage Connector for VMware vRealize Orchestrator by running Hitachi-vROStorageConnector-setup(01.3.1)-(x64)-01.exe.
The installer adds two main components: the plug-in and a Windows service. The plug-in is a file located in C:\Program Files\Hitachi\vROStorageConnector\dist. The Windows service is named Hitachi Storage Connector Service for vRealize Orchestrator.
Add the plug-in component to vRealize Orchestrator
The plug-in component is represented by a file, and added to vRealize Orchestrator using VMware vRealize configuration UI. By default, the plug-in file is named o11nplugin-HSC.dar, and located in C:\Program Files\Hitachi\vROStorageConnector\dist.
VMware vRealize Orchestrator is distributed in several different forms, including a Windows application and a Virtual Appliance. These instructions correspond to the Windows application. To install the plug-in to the Virtual Applicance, refer to VMware’s documentation.
1. Copy the o11nplugin-HSC.dar plug-in file to the Windows host running vRealize Orchestrator, if necessary.
2. Start the VMware vSphere Orchestrator Configuration service.
3. Open the vCenter Orchestrator Home Page start menu item.
4. You will see a “Getting Started with vCenter Orchestrator” page. Click on the Orchestrator Configuration link.
30 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
5. You’ll be prompted to log in. The default post-install credentials are vmware/vmware.
6. From the left-hand pane, select Plug-ins.
7. Scroll to the bottom of the right-hand pane, and find a text entry box labeled Plug-in file, with a magnifying glass icon next to it. Click on the magnifying glass icon, browse to o11nplugin-HSC.dar, and click Upload and install.
8. Once the plug-in has been installed, re-start the VMware vCenter Orchestrator Server service.
9. If an older version of the plug-in was already installed prior to these steps, you may see a message similar to this:
Configuring Windows Service Access Warning The plug-in and Windows service components of this product
support a communication mode that uses unencrypted HTTP. When this mode is used, secret information—such as storage array credentials—passes between the two software components in plain-text. If the two components reside on separate hosts, this plain-text traffic flows over the network, and could be intercepted. To mitigate this risk, configure the two components to communicate using HTTPS instead of HTTP. (Support for HTTPS is new in version v01.1.0.)
After the plug-in is installed into vRealize Orchestrator, it is necessary to configure it to access the Windows service component (Hitachi Storage Connector Service for vRealize Orchestrator).
Prior to version v01.1.0 of this product, this configuration was done using the VMware vCenter Orchestrator Web-based configuration interface.
Beginning with v01.1.0, this configuration is done using vRealize Orchestrator workflows provided by the plug-in.
Installation and Configuration 31
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
1. Open the vCenter Orchestrator Client application from the start menu.
2. You will be prompted to log in. The default post-install credentials are vcoadmin/vcoadmin.
3. In the left-hand pane, select the blue Workflows tab.
4. Browse to Library -> Hitachi -> Storage -> Web service configuration.
5. Run the Add Hitachi Storage Web service host workflow.
Notes on this workflow:
This workflow only needs to be used one time after installing Hitachi Storage Connector for VMware vRealize Orchestrator. It is a one-time operation.
It is only necessary to populate the HNAS V2I IP Address field if this product will be used to manage HNAS devices, and the specific workflows requiring V2I are desired (including those found in the Snapshot Backup and V2I Backup Group folder).
To populate the Log Level field, choose Not set, then search for NORMAL to yield a value for the field. Other options are VERBOSE and MINIMAL.
If HTTPS communication between the plug-in and Windows service is desired, choose Yes from the SSL radio-button.
Note Additional steps are required before HTTPS communication will
function. It is necessary to create an SSL certificate and configure vRealize Orchestrator to use it. Please see the Using HTTPS section for more information.
Using HTTPS (Optional)
Version v01.1.0 or later of this product added support for HTTPS communication between the plug-in and Windows service components.
To use HTTPS support:
10. Choose SSL support while using the Add Hitachi Storage Web service host workflow (see the Configuring Windows service access section, above, for more information).
11. Obtain an SSL certificate. If the use of a self-signed certificate is desired, here is one way to generate one, using IIS:
32 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Generating an SSL certificate
1. Start Internet Information Services (IIS) Manager.
2. Select the left-hand pane object representing the computer.
3. Open Server Certificates.
4. From the right-hand pane, select Create Self-Signed Certificate.
5. Provide an arbitrary friendly name and click OK.
6. Expand the left-hand pane object representing the computer, then select sites> Default Web Site.
7. Choose Bindings from the right-hand pane.
8. Click on Add, select https from the Type select-box and enter port 2023 (or any non-default HTTPS port number supplied to the Add Hitachi Storage Web service host workflow).
9. Select the self-signed certificate from the SSL certificate select-box and click OK.
10. Close the Site Bindings dialog box.
11. Enter mmc in the Run menu to open an initial MMC window.
12. Choose File > Add/Remove Snap-in.
13. Choose Certificates and click Add >.
14. Choose Computer Account, then Local Computer, and click OK.
Exporting a certificate
1. Browse to Console Root > Certificates (Local Computer) > Personal > Certificates. The newly created certificate should appear in the right-hand pane.
2. Right-click on the newly created certificate and choose All Tasks> Export.
3. When prompted, choose No, do not export the private key, then choose to export a DER-encoded binary X.509 (.CER).
4. Click Finish to export the certificate.
Installation and Configuration 33
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Implementing the certificate
1. If necessary, copy the certificate to the computer where vRealize Orchestrator resides.
2. Log in to the vRealize Orchestrator Web-based configuration interface (the same interface used to add this product’s plug-in component to vRealize Orchestrator).
3. Choose Network from the left-hand pane.
4. Select SSL Trust Manager from the right-hand pane.
5. Click on the magnifying glass icon next to Select a file to import, browse to the certificate file, and choose Import.
6. Re-start both the VMware vCenter Orchestrator Server and the Hitachi Storage Connector Service for vRealize Orchestrator services, to ensure that the SSL configuration takes full effect.
Modular Arrays
No additional steps are necessary to use this product with Modular storage arrays.
Enterprise Arrays
Before using this product with Enterprise storage arrays, it is necessary to install a specific Java Runtime Environment, and to install Hitachi CCI.
Java Runtime Environment
Java Runtime Environment version 7, x64 edition should be installed on the same Windows host running the Hitachi Windows service (Hitachi Storage Connector Service for vRealize Orchestrator).
Note
The x64 JRE edition is specifically required. The more common 32-bit JRE edition will not work.
Hitachi Command Control Interface (CCI)
Prior to using this product with Enterprise storage arrays, Hitachi Command Control Interface (CCI) must be installed, configured and running. CCI is used to perform in-band array management on behalf of this product’s workflows.
CCI should exist on the same Windows host running the Hitachi Windows service (Hitachi Storage Connector Service for vRealize Orchestrator).
34 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
CCI supports several scenarios and its configuration can become complex. These notes may help you to get started quickly, and should yield a configuration sufficient for many of this product’s workflows. For in-depth CCI configuration information, please refer to CCI’s documentation.
1. Install CCI on the Windows host running this product’s Windows service.
2. Edit the Windows TCP/IP services file to define a CCI service associated with UDP port 1000, by adding this single line to C:\Windows\system32\drivers\etc\services.
horcm 1000/udp horcm
3. Choose (or create) an LDEV on the Enterprise storage array to act as a command device.
4. Configure the LDEV to be a command device, as shown by this screen-shot:
5. Present the LDEV to the Windows host upon which the Hitachi Windows service is running. Ask the Windows host to re-scan, and ensure that the host sees the new LDEV.
6. Create a CCI configuration file named C:\Windows\horcm0.conf, containing these four lines. Replace 10.0.0.10 with the Windows host’s IP address, and \\.\PHYSICALDRIVE1 with the drive name corresponding to the command device.
HORCM_MON
10.0.0.10 horcm 1000 3000
HORCM_CMD
\\.\PHYSICALDRIVE1
Installation and Configuration 35
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Note If it is difficult to determine which PHYSICALDRIVE device name corresponds to the command device LDEV, try this command in a Windows cmd window: C:\> wmic diskdrive list brief /format:list
7. Start a CCI process (instance). Supplying a zero to horcmstart asks CCI to create instance number zero. The CCI instance number is used as an input to some workflows provided by this product.
C:\HORCM\etc\>horcmstart 0
8. If CCI fails to start, or to determine its status in detail, look at its log files in this folder.
C:\HORCM\log0\curlog\
Hitachi NAS (HNAS) devices
Many of the HNAS workflows will function without requiring any further configuration, yet some have additional dependencies (including those in the Snapshot Backup folder).
For full use of all HNAS-related workflows, install and configure Hitachi Virtual Infrastructure Integrator (V2I) on the same Windows host configured to run the Hitachi Windows service.
Uninstalling the Hitachi Storage Connector from the Orchestrator Server
To remove the software from the Windows host:
1. Open the Windows Control Panel.
2. Choose Uninstall a program from Programs.
3. Select Hitachi Storage Connector for VMware vRealize Orchestrator and click Uninstall. This action removes the Hitachi Storage Web Service from the Windows host.
This process cannot uninstall the vRealize Orchestrator plug-in.
Uninstall the Orchestrator plug-in manually by deleting the .dar file from the Orchestrator server and restarting the Orchestrator Server. Please follow the VMware vRealize Orchestrator documentation in order to perform this operation.
36 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Reinstalling the Connector for VMware vRealize Orchestrator
To re-install the connector:
1. Copy the new .dar file to the Orchestrator server.
2. Follow the same process to install this new file.
3. The Connector file can be overwritten without uninstalling the old file.
Upgrading Hitachi Storage connector for vRealize Orchestrator
Hitachi does not support upgrades from an older version of a Hitachi Storage connector for vRealize Orchestrator to the current version. When you attempt to install a newer version this connector, Hitachi Storage connector for vRealize Orchestrator displays the following message:
To install the current version of Hitachi Storage connector for vRealize Orchestrator, perform the following steps
1. Uninstall the older version.
2. Remove the plugin from vRealize Orchestrator manually.
3. Install the latest version of the storage connector.
Configuring Hitachi UVM with VSP G1000
Hitachi Storage Connector for VMware vRealize Orchestrator supports Hitachi Universal Volume Manager, which works with the VSP-G1000 platform.
When a system consists of multiple storage subsystems, a single host must usually connect to each subsystem. As a system administrator, you typically
Installation and Configuration 37
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
connect each system to the hosts, a process that may require several different types of procedures.
With Hitachi UVM, you configure the connection from the host to the VSP G1000 storage system, then manipulate mapped volumes in an external storage system in the same way as volumes in the VSP G1000 storage system.
Orchestrator among storage systems can also involve varied procedures. However, with Universal Volume Manager, you perform them with the same
Hitachi software as when you use VSP G1000 systems.
Supported Configurations
This section outlines the Hitachi UVM configurations currently supported by the adapter. For further information, see Hitachi Virtual Storage Platform VG1000/Hitachi Universal Volume Manager User’s Guide, MK-92RD8024-XX.
38 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Installation and Configuration 39
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Supported Storage Functions
The Storage Connector supports FC for all supported storage arrays. It supports NFS for HNAS. It supports Block Device for all arrays and File Systems, File System snapshots, Virtual Volumes and NFS Exports for the HNAS device. The Storage Connector also supports orchestration of tasks such as automatic backup and restore of VMs on HNAS and vRealize environment through V2I management APIs.
40 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Installation and Configuration 41
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Hitachi Storage Workflows
Hitachi vRO Connector Web Service Configuration
To run Hitachi Storage connector workflows, run Add Hitachi storage webservice host first and provide the Hitachi storage connector web service installed IP or DNS name and the V2I installed IP address or DNS name as arguments.
Add Hitachi Storage Web service host
This workflow add the web service configuration. This workflow is required to run once after new install or upgrade of the plugin.
Name Type Description Comments
Hitachi Web service IP address
string IP or FQDN hostname of the web service machine
N/A
Hitachi Web service HTTPS port
string HTTPS port Default value is 2023
Hitachi Web service HTTP port
string HTTP port Default value is 2022
HNAS V2I IP address
string IP or FQDN of HNAS V2I service
N/A
SSL Boolean Use SSL over HTTP or not
Default is True
Log Level Workflow object
LOG_LEVEL object
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
42 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Modify Hitachi Storage Web service host
This workflow modify the web service configuration. Name Type Description Comments
Hitachi Web service IP address
string IP or FQDN hostname of the web service machine
N/A
Hitachi Web service HTTPS port
string HTTPS port Default value is 2023
Hitachi Web service HTTP port
string HTTP port Default value is 2022
SSL Boolean Use SSL over HTTP or not
Default is True
HNAS V2I IP address
string IP or FQDN of HNAS V2I service
N/A
Log Level Workflow object
LOG_LEVEL object
N/A
On Success: a message indicating success is returned.
On Failure: an exception’s thrown.
Delete Hitachi Storage Web service host
This workflow delete the web service configuration.
On Success: a message indicating success is returned.
On Failure: an exception’s thrown.
Storage Subsystem Profile Users will be given a choice of storage class profiles that tie the user to specific resources such as storage pool, array ports, etc. Such Information as subsystem Serial number, user ID, password, horcminst, port, etc. will be stored in each profile and will be loaded using the Add Subsystem credential. This will reduce entering storage information every time to run the Add Subsystem workflows
Add Enterprise Subsystem Profile
This workflow adds an Enterprise Profile object to Orchestrator’s repository, using the provided enterprise subsystem information.
Installation and Configuration 43
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Storage Subsystem Profile
Input Parameters Name Type Description Comments
Credential Name string Profile name This profile name has to be unique which will be used later on
Hitachi Subsystem Serial Number
string Serial Number of the RAID subsystem that needs to be used (E.g. 66209 for VSP)
NA
Hostname or IP address
string Hostname or IP address of the storage array
NA
Subsystem User credential
string Account on the array NA
Subsystem Password
Securestring
NA
CCI instance number
Integer Horcm instance number that is configured on the Windows web service host
NA
Dynamic Pools string A list of dynamic pools assigned to the profile by the storage admin
Optional: If this field is blank, all dynamic pools in the system will be available to the profile.
Parity Groups string A list of Parity groups assigned to this profile by the storage administrator
Optional: If this field is blank, all Parity groups in the system will be available to the profile.
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
44 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Add HNAS Profile
This workflow adds an HNAS profile object to Orchestrator’s repository using the provided modular subsystem info.
Location
Library\Hitachi\Storage\Storage Subsystem Profile
Input Parameters Name Type Description Comments
Profile Name string Profile name This credential names has to be unique, which will be used later on.
HNAS node or cluster IP Address
string HNAS node or cluster IP Address
N/A
HNAS node or cluster account
string Account on HNAS
N/A
HNAS node or cluster password
string Password N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Add Modular Array Profile
This workflow adds a modular array profile to Orchestrator’s repository, using the provided modular subsystem information.
Location
Library\Hitachi\Storage\Storage Subsystem Profile
Input Parameters Name Type Description Comments
Credential Name string Profile name The string must be unique. It will be used in future sessions.
Controller1 IP Address
string Controller 1 IP Address
N/A
Installation and Configuration 45
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Controller2 IP Address
string Controller 2 IP Address
N/A
Sunsystem user credential
string Account on HUS N/A
Subsystem password
secure string
Subsystem password N/A
Dynamic Pools string A list of dynamic pools assigned to the profile by the storage administrator
Optional. If this field is blank, all dynamic pools in the system will be available to the profile.
RAID Group string A list of RAID groups assigned to this profile by the storage administrator.
Optional. If this field is blank, all RAID groups in the system will be available to the profile.
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Add V2I Server Profile
This workflow adds a V2I Server Profile object to the Orchestrator’s repository using the provided vCenter information.
Location
Library\Hitachi\Storage\Storage Subsystem Profile
Input Parameters Name Type Description Comments
Profile Name string Profile name This credential names has to be unique which will be used later on.
vCenter Server IP address
string IP Address of vCenter Server
N/A
Account string UserID to N/A
46 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments connect to the vCenter Server
Password string Password of the vCenter Server
N/A
Port Integer Default is 443 if not specified
Optional
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Delete Subsystem Profile
This workflow deletes the saved profile object in the Orchestrator’s repository.
Location
Library\Hitachi\Storage\Storage Subsystem Profile
Input Parameters Name Type Description Comments
Select Profile Name
workflow object
Profile object N/A
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Block – Storage Configuration
Add Modular Array
Add Modular Array is the first workflow that needs to be invoked. This workflow registers the provided subsystem with Orchestrator and returns a subsystem JavaScript object. This object’s added as an inventory object in the Orchestrator client. Subsequent storage management operations can be performed using this object.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Installation and Configuration 47
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Controller 0 IP Address
string Controller 0 IP Address
Controller 1 IP Address
string Controller 1 IP Address
Array account string Account on HUS Array password SecureStrin
g Password
On Success: a message confirms that the operation was successful.
On Failure: an exception is thrown, and an error message indicates the possible cause of the problem.
Add Enterprise Array
This workflow registers an Enterprise array and returns a subsystem object for use with subsequent workflows.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Array serial number string Array serial number Array account string Array account Array password Securestrin
g Array password
IP address associated with the array
string Array IP address
CCI instance number string CCI instance number
On Success: a message confirms that the operation was successful.
On Failure: an exception is thrown, and an error message indicates the possible cause of the problem.
Add Enterprise Subsystem using credential
This workflow registers the provided subsystem with Orchestrator and returns a subsystem JavaScript object. This object is added as an inventory object in the Orchestrator client. Subsequent storage management operations can be performed using this object.
48 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Credential workflow object
Credential object N/A
On Success: The subsystem object is returned.
On Failure: An exception is thrown.
Add Modular Array using Credential
This workflow registers the provided subsystem with Orchestrator and returns a subsystem JavaScript object. This object is added as an inventory object in the Orchestrator client. Subsequent storage management operations can be performed using this object.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Name workflow object
Credential object N/A
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Close all Storage Array Connections
This workflow closes all the currently connected subsystems objects including vCenter and HNAS. This workflow does not require any parameters.
Add Virtual Storage Array
This workflow registers a virtual storage array and returns a subsystem object for use with subsequent workflows.
Installation and Configuration 49
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
SubsystemSerialNumber string Virtual Storage Array serial number
Prior to using this workflow, use Add Enterprise Array to register the physical array associated with the virtual array.
If you use this workflow register a virtual storage array, and a physical array that has the same serial number is later registered, the physical array overrides the virtual array.
Get Virtual Storage Arrays
This workflow retrieves Hitachi virtual storage array objects.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Get Registered Storage Arrays
This workflow retrieves information about registered arrays.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Block – Provisioning
Create LU in Parity Group
This workflow creates an LU in a parity group. It applies to Enterprise family storage arrays.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi Storage Array
HitachiStorageConnector:S
Hitachi storage array
This can be a virtual storage subsystem
50 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments ubsystem object in which case,
the LU is created on the virtual storage array
ParityGroup string Parity group within which to create the LU
Example: 2-4
LU size (in GB)
string LU size NA
LU stripe size HitachiStorageConnector:STRIPE_SIZE
LU stripe size Example: STRIPESIZE_64KB
Meta Resource serial number (applies to Virtual Storage Arrays)
Integer Meta Resource serial number (applies to Virtual Storage Arrays)
Applies to a virtual storage array. This parameter identifies the meta resource number on which the LU is created. If specified, the LU is created on the physical storage subsystem identified by the meta resource. If not specified, the connector throws an error for a virtual storage array
LU Name string The name to be assigned to the LDEV
Optional parameter
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create LU in Dynamic Pool
This workflow creates an LU in a DP pool.
Installation and Configuration 51
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
NA
DP pool number string DP pool number NA LU size (in GB) string LU size (in GB) NA LU stripe size HitachiStora
geConnector:STRIPE_SIZE
LU stripe size For example, STRIPESIZE_64KB
Meta Resource serial number (applies to Virtual Storage Arrays)
string Meta Resource serial number (applies to Virtual Storage Arrays)
Applies to a virtual storage subsystem. This parameter identifies the meta resource number on which the LU is created.
LU Name string The name to be assigned to the LU
Optional parameter
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create LU in RAID Group
This workflow creates an LU in a RAID group. It applies to modular family storage arrays.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters
Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
RAID string RAID group The numerical
52 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments Group representation of a
RAID group LU Size (in GB)
string LU Size (in GB)
LU stripe size
HitachiStorageConnector:STRIPE_SIZE
LU stripe size For example, STRIPESIZE_64KB
On Success: A message confirms that the operation was successful.
The newly created LU’s LUN is returned.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Delete LU
This workflow removes a Logical Unit.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
LU to delete string LU to delete Ensure that the LU is supplied using decimal
On Success: A message confirms that the LU has been deleted successfully.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Present LU
This workflow presents an LU by adding it to an existing host group.
Installation and Configuration 53
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comment
s
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
LU string LU Supply the LUN in decimal, not hex
Hostgroup string Host group Array target port
string Array target port
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Unpresent LU
This workflow unpresents an LU by removing it from a host group.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
LU string LU Specify the LUN using decimal, not hex
Hostgroup
string Host group
Array target port
string Array target port
On Success: A success message appears, indicating that the LU has been un-presented.
54 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Get LUs
This workflow retrieves LU information.
When this workflow is used with Virtual Storage Arrays, LUs from all resource groups with the same array serial number are returned.
A maximum of five hundred LUs can be returned by each invocation of this workflow. To allow all LUs on an array to be returned, this workflow supports the ability to specify a LUN range. For instance, LUNs in the range [1000-1300] can be returned by specifying 1000 and 1300 for the BeginLun and EndLun parameters.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem Hitachi storage array
LU range: lower limit (LUN >= value)
string Begin LU
LU range: upper limit (LUN <= value)
string End LU
Get Hostgroups
This workflow retrieves host group information from the specified subsystem. A host group is represented as a separated object in vCenter Orchestrator. Register the subsystem using the Add Modular | Enterprise Array workflow before running this workflow. Provide a subsystem object input parameter in the workflow using the inventory definition in the Orchestrator client.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Installation and Configuration 55
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Subsystem Workflow object Subsystem object N/A
Get Hostgroups associated with an LU
This workflow retrieves a host group with which an LU is associated from the specified subsystem. Register the subsystem using the Add Modular|Enterprise Array workflow prior to running this workflow.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi Storage Array
Workflow object Subsystem Serial N/A
LU Integer LU number N/A
Get Hostgroups associated with a WWN
This workflow retrieves the host groups with which a WWN is associated from the specified subsystem. Register the subsystem using the Add Modular | Enterprise Array workflow prior to running this workflow. This wokflow requires the subsystem object and a list of WWNs as an input parameter.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
Workflow object Subsystem Serial N/A
WWN string Subsystem’s target port WWN
N/A
Get WWNs associated with a target port
This workflow retrieves the WWNs associated with the specified target port from the specified subsystem. The subsystem needs to be registered using Add Modular | Enterprise Array prior to running this workflow. This workflow requires the Subsystem object and a target port as an input parameter.
56 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage subsystem
Workflow object Subsystem serial N/A
Target port string Subsystem’s target port
N/A
Create Hostgroup
Creates a host group on the specified array target port.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Array upon which the host group resides
HitachiStorageConnector:Subsystem
Array upon which the host group resides
NA
Hostgroup Name
string Host group name NA
One or more WWN(s)
string One or more WWN(s)
Multiple WWNs can be specified; separate them with commas
Array target port
String Array target port
Host mode (platform)
HitachiStorageConnector:HOST_MODE
Host mode (platform)
For ESX hosts, use the VMWARE host mode
Enterprise host mode option
String Displays enterprise array host mode option
Based on the storage
Installation and Configuration 57
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
selection the hmo get enabled
HUS host mode option
String Displays modular array host mode option
Based on the storage selection the hmo get enabled
On Success: A success message appears, specifying that the host group has been created in the specified subsystem.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Delete HostGroup
This workflow deletes a host group on the specified array target port
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Descripti
on Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
NA
Host Group Name
string Host group name
NA
Array target port
string Array target port
Examples: CL1-A, 0C
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
58 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Add WWN(s) to Hostgroup
This workflow adds one or more WWN(s) to a host group.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Array upon which the host group resides
HitachiStorageConnector:Subsystem
Array upon which the host group resides
NA
Hostgroup Name
string Host group name NA
One or more WWN(s)
string One or more WWN(s)
Comma-separated list of one or more WWPNs
Array target port
string Array target port
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Remove WWN(s) from Hostgroup
This workgroup removes WWN(s) from a host group
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Array upon which the host group resides
HitachiStorageConnector:Subsystem
Hitachi storage array
Hostgroup string Host group name
One or more WWN(s)
string One or more WWN(s)
Multiple WWNs can
Installation and Configuration 59
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments be specified by separating them with commas
Array target port
string Array target port
On Success: Returns a message indicating successful removal of the WWNs.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Expand LU Size
This workflow expands a logical unit in the specified subsystem. You need to register the subsystem using Add Modular|Enterprise Subsystem. Note that the Expand LU Size workflow now supports LU size expansion up to 256TB.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object
Subsystem object returned from the Add Subsystem workflow
NA
LDEV ID Integer Decimal LUN number of the LU needs to be deleted
NA
New Size (in GB) Integer Decimal number indicates LU’s size in GB to be added to the existing size.
For eg: If existing LU size is 100GB, and “New Size (in GB)” is 100, then the LU size will be 200GB post expansion.
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
60 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Create Dynamic Pool on Enterprise Array
Creates dynamic pool on the specified subsystem using the specified LDEV(s). Subsystem needs to be registered using Add Modular|Enterprise Array
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters
Name Type Description Comments
Hitachi storage subsystem
subsystem object
Subsystem object returned from the Add Subsystem workflow
N/A
Pool Name string Pool name N/A List of LDEV(s) to be used separated by commas
string List of LDEVs N/A
Type of dynamic pool
Enumeration Type of pool Predefined types are: HDP, Snapshot, HTI, and HDT_AF
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Delete Dynamic Pool Using Pool ID
Pool with specified ID from the specified subsystem can be deleted using this workflow. Subsystem needs to be registered using Add Modular|Enterprise Array.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage subsystem
workflow object
Subsystem object returned from the Add Subsystem workflow
N/A
Installation and Configuration 61
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Pool ID Integer Decimal value identifying the pool ID
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Delete Dynamic Pool Using Pool name
Pool with specified name from the specified subsystem can be deleted using this workflow. Subsystem needs to be registered using Add Modular|Enterprise Array.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi Storage Subsystem
workflow object
Subsystem object returned from the Add Subsystem workflow
N/A
Pool name string Pool name N/A
On Success: A message indicating success is returned.
On Failure: An exception’s thrown.
Expand Pool Using Pool ID This workflow expands a storage pool using a pool ID. The subsystem needs to be registered using Add Modular|Enterprise Array prior to running this workflow. This workflow requires the Subsystem object, a pool ID and a list of LDEV ids as parameters. The pool will be expanded by the size of the LDEVs and they will be component LDEVs for that pool.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters
Name Type Description Comments
Hitachi Storage subsystem
workflow object Subsystem object N/A
Pool ID string This is the ID number N/A
62 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments of the pool to be expanded
List of LDEV(s) to be used separated by commas
string This is a list of LDEV IDs separated by commands. Example: 1201,1620
LDEVs need to be at least 8GB to be added.
On Success: A message indicating success is returned.
On Failure: An exception’s thrown.
Expand Pool Using Pool Name
This workflow expands a storage pool using a pool Name. The subsystem needs to be registered using Add Modular|Enterprise Array prior to running this workflow. This workflow requires the Subsystem object, a pool name and a list of LDEV IDs as parameters. The pool will be expanded by the size of the LDEVs and they will be component LDEVs for that pool.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters
Name Type Description Comments
Hitachi Storage subsystem
workflow Object Subsystem object N/A
Pool Name string This is the name of the pool to be expanded
N/A
List of LDEV(s) to be used separated by commas
string This is a list of LDEV IDs separated by commands. Example: 1201,1620
LDEVs need to be at least 8GB to be added.
On Success: A message indicating success is returned.
On Failure: An exception’s thrown.
Shrink Pool Using Pool ID
This workflow shrinks a storage pool using a pool ID. The subsystem needs to be registered using Add Modular|Enterprise Array prior to running this workflow. This workflow requires the Subsystem object, a pool ID and a list of LDEV IDs as parameters. The pool will be shrunken by the size of the LDEVs, they will be deleted as component LDEVs for that pool and deleted from the storage system.
Installation and Configuration 63
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi Storage subsystem
workflow object Subsystem object N/A
Pool ID string This is the ID number of the pool to be expanded
N/A
List of LDEV(s) to be used separated by commas
string This is a list of LDEV IDs separated by commands. Example: 1201,1620
LDEVs need to be at least 8GB to be added.
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Shrink Pool Using Pool Name
This workflow shrinks a storage pool using a pool name. The subsystem needs to be registered using Add Modular|Enterprise Array prior to running this workflow. This workflow requires the Subsystem object, a pool name, and a list of LDEV IDs as parameters. The pool will be shrunken by the size of the LDEVs, and they will be deleted as component LDEVs for that pool and deleted from the storage system.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters
Name Type Description Comments
Hitachi Storage subsystem
workflow Object Subsystem object N/A
Pool Name string This is the name of the pool to be expanded
N/A
List of LDEV(s) to be used separated by commas
string This is a list of LDEV IDs separated by commands. Example: 1201,1620
LDEVs need to be at least 8GB to be added.
On Success: A message indicating success is returned.
64 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Failure: An exception is thrown.
Get Storage Pools
This workflow retrieves a data pool list for the specified storage subsystem. The subsystem needs to be registered using the Add Modular | Enterprise Array object.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object
Subsystem Object. NA
On Success: A list of storage pools.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create V-VOL
This workflow create a V-VOL associated with the supplied P-VOL.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object
Subsystem Object.
N/A
P-VOL Integer P-VOL ID N/A Desired V-VOL ID Integer V-VOL ID N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Create V-VOL (automatic V-VOL ID)
This workflow creates a V-VOL associated with the supplied P-VOL and chooses a V-VOL ID automatically.
Installation and Configuration 65
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object
Subsystem Object.
N/A
P-VOL Integer P-VOL ID N/A
On Success: A new V-VOL ID.
On Failure: An exception is thrown.
Get Hostgroups for Port
This workflow retrieves the Hostgroups associated with the specified port on the selected subsystem. The subsystem needs to be registered using Add Modular | Enterprise Array prior to running this workflow. This workflow requires the subsystem object and a port name as an input parameter.
Location
Library\Hitachi\Storage\Block\Provisioning
Input Parameters Name Type Description Comments
Hitachi Subsystem workflow object
Subsystem Object.
N/A
Target port String Subsystem’s target port
N/A
On Success: A message indicating success is returned and a list of Host Group objects.
On Failure: An exception is thrown.
66 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Block – ShadowImage
Create ShadowImage Pair
A ShadowImage Pair can be created using this workflow. Subsystem needs to be registered. A P-VOL and an S-VOL identified by a number needs to be provided as an input parameters along with the subsystem object.
Location
Library\Hitachi\Storage\Block\ShadowImage
Installation and Configuration 67
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object
Subsystem object returned from the Add Subsystem or Add Virtual Subsystem workflow
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
S-VOL Integer Decimal value identifying the S-VOL
Optional value. S-VOL will be created if not provided
shouldAutoSplit boolean A flag to have the pair autosplit
Default is False
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Delete ShadowImage Pair
A ShadowImage Pair from the specified subsystem can be deleted using this workflow. The subsystem must be registered using Add Modular|Enterprise Array. A S-VOL identified by a number needs to be provided as an input parameter along with the subsystem object.
Location
Library\Hitachi\Storage\Block\ShadowImage
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object
Subsystem object returned from the Add Subsystem workflow
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
68 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
S-VOL Integer Decimal value identifying the S-VOL
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Resync ShadowImage Pair
This workflow resynchronizes a ShadowImage Pair from the specified subsystem.
Location
Library\Hitachi\Storage\Block\ShadowImage
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object Subsystem object
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
S-VOL Integer Decimal value identifying the S-VOL
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Split ShadowImage Pair
This workflow splits a ShadowImage Pair from the specified subsystem. Register the subsystem using the Add Modular|Enterprise Array workflow. Provide a P-VOL and an S-VOL, identified by numbers as an input parameter with the subsystem object.
Location
Library\Hitachi\Storage\Block\ShadowImage
Input Parameters Name Type Description Comments
Hitachi storage Workflow object Subsystem N/A
Installation and Configuration 69
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments array object P-VOL Integer Decimal value
identifying the P-VOL
N/A
S-VOL Integer Decimal value identifying the S-VOL
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Restore ShadowImage Pair
This workflow restores a ShadowImage Pair from the specified subsystem. Register the subsystem using the Add Modular|Enterprise Array workflow. Provide a P-VOL and an S-VOL, identified by numbers, with the subsystem object.
Location
Library\Hitachi\Storage\Block\ShadowImage
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object Subsystem Object
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
S-VOL Integer Decimal value identifying the S-VOL
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Get ShadowImage Pairs
This workflow retrieves a list of existing ShadowImage pairs in the Storage Subsystem for a particular P-VOL.
70 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Block\ShadowImage
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object Subsystem Object
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Create ShadowImage Pair with Consistency Group
This workflow creates a ShadowImage Pair in a provided Consistency Group. You need to register the storage subsystem. The workflow creates the Consistency Group ID if not provided. If you provide an invalid ID, the parameter will be ignored and the pair will not be added to any group. If a valid ID exists, the pair is added to the same Consistency Group.
Location
Library\Hitachi\Storage\Block\ShadowImage
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object
Subsystem object returned from the Add Modular|Enterprise Array workflow
NA
P-VOL Integer Decimal value identifying the P-VOL
NA
S-VOL Integer Decimal value identifying the S-VOL
NA
ctgID Integer Decimal value identifying the Consistency Group ID.
Optional value. Value range is 0-255. Consistency Group ID will be created if leave blank or -1. If an
Installation and Configuration 71
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments invalid ID is provided the parameter will be ignore and the pair will not be added to any group. If the ID existed, the pair will be added to the same Consistency Group.
On Success: A message indicating a successful session returns. A workflow object of Replication type returns as an out parameter containing CTG and Mirror Unit ID.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Split ShadowImage Group
This workflow splits a ShadowImage Group using the consistency group ID from the specified subsystem. The subsystem needs to be registered using Add Modular|Enterprise Array.
Location
Library\Hitachi\Storage\Block\ShadowImage
Input Parameters Name Type Description Comments
Hitachi storage array
workflow object subsystem object
NA
Consistency group ID
Integer Decimal value identifying the consistency group ID
NA
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
72 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Block – Snapshot Backup
Create Modular Array Snapshot Pair
This workflow creates a COW snapshot on the specified modular array.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
P-VOL Integer P-VOL Use a decimal value, not hex
V-VOL Integer V-VOL Use decimal, not hex. Optional value. V-VOL is created by the system when this value is not specified.
Management Pool
string Management Pool
Replication Pool
string Replication Pool
Snapshot pair name
string Snapshot pair name
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create Enterprise Snapshot Pair
This workflow creates a COW/HTI snapshot on the specified enterprise array.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage
HitachiStorageConnector:Subsystem Hitachi storage
Installation and Configuration 73
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments array array P-VOL string P-VOL Use
decimal, not hex
S-VOL string S-VOL Use decimal, not hex. Optional value. S-VOL is created in the system when this value is not specified.
COW/HTI datapool associated with this snapshot
string COW/HTI datapool associated with this snapshot
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Restore Snapshot Pair
This workflow restores a COW/HTI snapshot pair in a modular or enterprise array.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
P-VOL string P-VOL Use decimal, not hex S-VOL string S-VOL Use decimal, not hex
74 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Delete Snapshot Pair
Deletes a COW/HTI snapshot pair on the specified Modular or Enterprise array.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
P-VOL string P-VOL Use decimal, not hex
S-VOL string S-VOL Use decimal, not hex
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Resync Snapshot Pair
Re-synchronizes a COW/HTI snapshot pair in a modular or enterprise array.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
P-VOL string P-VOL Use decimal, not hex
S-VOL string S-VOL Use decimal, not hex
On Success: A message confirms that the operation was successful.
Installation and Configuration 75
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Split Snapshot Pair
Splits a COW/HTI snapshot pair in a modular or enterprise array.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage array
HitachiStorageConnector:Subsystem
Hitachi storage array
P-VOL string P-VOL Use decimal, not hex
S-VOL string S-VOL Use decimal, not hex
On Success: A success message appears, indicating that the snapshot pair has been split.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create Modular Snapshot Pair: named
This workflow creates a Snapshot Pair with a pair name. Register the subsystem using the Add Subsystem workflow. Provide a P-VOL and an S-VOL, identified by numbers, with the subsystem object.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage array
Workflow object Subsystem object returned from the Add RAID Subsystem or Add Virtual Subsystem workflow
N/A
76 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
P-VOL Integer Decimal value identifying the P-VOL.
N/A
Management Pool Integer Decimal value identifying the Management Pool number
N/A
Replication Pool Integer Decimal value identifying the Replication Pool number
Replication pool can be the same as the Management Pool.
Snapshot pair name
string The name of the Snapshot pair
N/A.
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Delete Snapshot Pair: named
This workflow deletes a Snapshot Pair with a pair name from the specified subsystem. Register the subsystem using the Add Modular|Enterprise Array workflow.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Hitachi storage array
Workflow object Subsystem object returned from the Add Subsystem workflow
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
Snapshot pair name
string The snapshot pair name
N/A
Installation and Configuration 77
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Split Snapshot Pair: named
This workflow splits a Snapshot Pair with a pair name from the specified subsystem. Register the subsystem using the Add Modular|Enterprise Array workflow. Provide a P-VOL and a pair name, identified by numbers, with the subsystem object.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object Subsystem object
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
pairName string The name of the Snapshot pair
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Restore Snapshot Pair: named
This workflow restores a Snapshot Pair with a pair name from a specified subsystem. Register the subsystem using the Add Subsystem workflow. Provide a P-VOL and pair name as input parameters with the subsystem object.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
78 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
Subsystem Workflow object Subsystem object
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
pairName string The Snapshot pair name
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Resync Snapshot Pair: named
This workflow resynchronizes a Snapshot Pair with a pair name from a specified subsystem. Register the subsystem using the Add Subsystem workflow. Provide a P-VOL and pair name as input parameters with the subsystem object.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object Subsystem object
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
pairName string The Snapshot pair name
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Get Snapshot Pairs
Gets a list of COW/HTI snapshot pairs from the specified subsystem. The subsystem needs to be registered using Add Modular|Enterprise Array.
Installation and Configuration 79
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters
Name Type Description Comments
Subsystem workflow object
Subsystem Object.
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
Get Snapshot Pairs: named
This workflow retrieves a list of existing snapshot pairs with a name in the Storage Subsystem for a particular P-VOL.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object Subsystem object
N/A
P-VOL Integer Decimal value identifying the P-VOL
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Create Enterprise Snapshot Pair with Group Name
This workflow creates a Snapshot Pair in a provided Group name. You need to register the subsystem and the Consistency Group ID will be created if not provided. If an invalid ID is provided, the parameter will be ignored and the pair will not be added to any group. If the ID existed, the pair will be added to the same Consistency Group.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem object returned from the Add RAID Subsystem or Add
NA
80 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments Virtual Subsystem workflow
P-VOL string Decimal value identifying the P-VOL
NA
V-VOL string Decimal value identifying the V-VOL
Optional value. V-VOL will be created if not provided
COW/HTI Pool Integer COW/HTI Pool number
NA
Group name string Snapshot group’s name
NA
allocateCTG bool A flag indicates that a new CTG group will be created automatically
NA
On Success: A message confirms that the operation was successful. A workflow object of Replication type is returned as an out parameter that contains CTG and a Mirror Unit ID.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create Enterprise Snapshot Pair without VVOL
This workflow creates a Snapshot Pair in a provided Group name. You need to register the subsystem. The Consistency Group ID will be created if not provided. If an invalid ID is provided, the parameter will be ignored and the pair will not be added to any group. If the ID existed, the pair will be added to the same Consistency Group.
Location
Library\Hitachi\Storage\Block\ Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem object returned from the Add RAID Subsystem or Add Virtual Subsystem workflow
Installation and Configuration 81
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
P-VOL string Decimal value identifying the P-VOL
COW/HTI Pool Integer COW/HTI Pool number
Group name string Snapshot group’s name
allocateCTG bool A flag indicates that a new CTG group will be created automatically
On Success: A message confirms that the operation was successful. A workflow object of Replication type is returned as an out parameter that contains CTG and Mirror Unit ID.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create Modular Snapshot Pair with Consistency Group
This workflow creates a Snapshot Pair in a provided Consistency Group. You need to register the subsystem. The Consistency Group ID will be created if not provided. If an invalid ID is provided, the parameter will be ignored and the pair will not be added to any group. If the ID existed, the pair will be added to the same Consistency Group.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem object returned from the Add RAID Subsystem or Add Virtual Subsystem workflow
NA
P-VOL Integer Decimal value identifying the P-VOL
NA
S-VOL Integer Decimal value identifying the S-VOL
Optional value. S-VOL will be created if not provided
82 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Management Pool
Integer Management Pool number
NA
Replication Pool Integer Replication Pool number
NA
CTG ID Integer If Specified, the LUN will be created on the physical storage subsystem identified by the meta resource.
Optional value. Value range is 0-255. Consistency Group ID will be created if leave blank or -1. If an invalid ID is provided the parameter will be ignore and the pair will not be added to any group. If the ID existed, the pair will be added to the same.
On Success: A message indicating a successful session returns. A workflow object of Replication type returns as an out parameter containing CTG and Mirror Unit ID.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Split Snapshot Group
This workflow splits a Snapshot Group group using the consistency group ID from the specified subsystem. Register the subsystem using the Add Subsystem workflow.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object
Subsystem object N/A
ctgID Integer Decimal value identifying the consistency group ID
N/A
Installation and Configuration 83
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Delete Snapshot Group using Group name
This workflow deletes a Snapshot Group using the group name from the specified subsystem using this workflow. Register the subsystem using the Add Subsystem workflow.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object
Subsystem object returned from the Add Subsystem workflow
N/A
Group Name string The name of the replication pair group
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Resync Snapshot Group using Group name
This workflow resynchronizes a Snapshot Group using the group name from the specified subsystem. Register the subsystem using the Add-Subsystem workflow.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object
Subsystem object N/A
Group name string The name of the replication pair group
N/A
On Success: A message indicating success is returned.
84 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Failure: An exception is thrown.
Restore Snapshot Group using Group name
This workflow restores a Snapshot Group using the group name from the specified subsystem. Register the subsystem using the Add-Subsystem workflow.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object
Subsystem object N/A
Group name string The name of the replication pair group
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Split Snapshot Group using Group Name
This workflow splits a Snapshot Group using the group name from the specified subsystem. Register the subsystem using the Add Subsystem workflow.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object
Subsystem object N/A
Group Name string The name of the replication pair group
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Installation and Configuration 85
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Map HTI Floating Snapshot Volume
This workflow creates a VVOL and assigns it to the Snapshot data of a Hitachi Thin Image (HTI) floating pair. The subsystem needs to be registered using the Add Enterprise Subsystem workflow.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem Workflow object
Subsystem object N/A
PVOL string PVOL ID N/A Mirror ID string HTI Pair mirror ID N/A Hostgroup string Host group to
which the user presents this VVOL
If the host group is blank, the VVOL is presented to the default host group.
On Success: A new VVOL ID is returned.
On Failure: An exception is thrown.
Unmap HTI Snapshot Volume
This workflow removes the VVOL associated with the supplied PVOL’s Hitachi Thing Image (HTI) floating snapshot. The VVOL will not be deleted because you may still have critical data on the volume. You need to delete the VVOL manually. The subsystem needs to be registered using the Add Enterprise Subsystem.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem string PVOL ID N/A PVOL string PVOL ID N/A VVOL string VVOL ID N/A Hostname string Host name from
which you want to unpresent the VVOL
86 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Success: A message indicating a successful session returns.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Block – TrueCopy
Create TrueCopy Pair
This workflow creates a TrueCopy of the P-VOL with the S-VOL ID on the remote storage subsystem. The local subsystem needs to be registered, only serial number of the remote array is needed.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem Object
pVOL Integer Decimal value identifying the pVOL
Remote Serial number
Integer Remote Storage Array Serial number
Remote S-VOL Integer Management Pool number
Fence Level workflow object
Fence level Values are: NEVER, DATRA, STATUS
On Success: A message indicating a successful session returns.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Delete TrueCopy Pair
This workflow deletes a TrueCopy snapshot from the specified. Subsystem needs to be registered using the Add Modular | Enterprise Subsystem object.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Installation and Configuration 87
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem object returned from the Add Subsystem workflow
pVOL Integer Decimal value identifying the pVOL
Remote Serial number
Integer Remote Storage Array Serial number
Remove S-VOL Integer Decimal value identifying the SVOL
On Success: A message indicating a successful session returns.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Resync TrueCopy Pair
This workflow resynchronizes a TrueCopy snapshot from the specified for the specified P-VOL with the remote S-VOL. The local subsystem needs to be registered using the Add Modular | Enterprise Subsystem object.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem Object
P-VOL Integer Decimal value identifying the P-VOL
Remote Serial Number
Integer Remote Storage Array Serial Number
S-VOL Integer Decimal value identifying the S-VOL
On Success: A message indicating a successful session returns.
88 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Split TrueCopy Pair
This workflow splits a TrueCopy Snapshot from the specified subsystem for the specified P-VOL. The local subsystem needs to be registered using the Add Modular | Enterprise Array object.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem Object
P-VOL Integer Decimal value identifying the P-VOL
Remote Serial Integer
Integer Remote Storage Array Serial Number
S-VOL Integer Decimal value identifying the S-VOL
On Success: A message indicating a successful session returns.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Get TrueCopy Pairs
This workflow retrieves a list of TrueCopy snapshot pairs from the specified storage subsystem. The local subsystem needs to be registered using the Add Modular | Enterprise Array object.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem Object.
P-VOL Integer Decimal value identifying the P-VOL
Installation and Configuration 89
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Remote Serial Number
Integer Remote Storage Array Serial Number
S-VOL Integer Decimal value identifying the S-VOL
On Success: A list of Replication objects.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create Global Active Device Pair
This work flow creates a Global Active Device of the P-VOL with the S-VOL ID on the remote storage array. Local and remote Subsystems (Enterprise/HUS) need to be registered using Add Modular|Enterprise Subsystem. Before creating the device, you need to create the Quorum disk. You need to disable the Command Device Security command device property or the system generates the following error message:
A feature was requested that requires HORCM automation, but it is not enabled.
CCI version 01-34-03/04 or above is required to complete this operation.
Note
The TrueCopy operations such as Delete/Split/Resync can be used on the GAD pair.
Location
Library\Hitachi\Storage\Block\Snapshot Backup
Input Parameters Name Type Description Comments
Subsystem workflow object subsystem object
Primary VOL string A decimal value identifying the pVOL
Remote Serial Number
string Remote Storage Array Serial Number
90 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Remote Secondary VOL
string A decimal number identifying the remote S-VOL
The SVOL needs to be mapped to the virtual storage device.
Quorum disk ID Integer A decimal value identifying the Quorum disk ID
Consistency Group ID
Integer Decimal value identifying the consistency group ID
Optional
On Success: A new Replication object and a message indicating success is returned.
On Failure: An exception is thrown.
Create Universal Replication Pair
This workflow creates a Universal Replication of the P-VOL with the S-VOL ID on the remote storage system. You need to register local and remote subsystems (Enterprise/HUS 100) using the Add Modular|Enterprise Subsystem workflow.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Subsystem workflow object
Subsystem Object
Primary VOL string Decimal value identifying the pVOL
P-Vol Journal Pool
Integer Decimal value identifying the P-VOL journal pool
Remote Serial Number
string Remote Storage Array Serial Number
Installation and Configuration 91
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Remote Secondary VOL
string A decimal number identifies the remote S-VOL
S-Vol Journal Pool
Integer Decimal value identifying the S-VOL journal pool
ctgID Integer Decimal value identifying the consistency group ID
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Block - iSCSI Targets
Create iSCSI Target
Creates an iSCSI target.
Input Parameters Name Type Description Comments
Subsystem HitachiStorageConnector:Subsystem
Hitachi storage array
Port string Array target port
targetName string iSCSI target name
IqnName string iSCSI target IQN
On Success: A message confirms the newly created iSCSI target.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Create iSCSI Target
This workflow deletes an iSCSI target from the Storage Subsystem.
Input Parameters
92 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Subsystem workflow object
Subsystem Object.
N/A
Port string Port ID N/A Target Name string iSCSI Target
Name N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Add an Initiator to iSCSI Target
Adds an initiator IQN to an iSCSI target.
Input Parameters Name Type Description Comments
Subsystem HitachiStorageConnector:Subsystem Hitachi storage array
port string Array target port
targetName string iSCSI target name
initiator string iSCSI initiator IQN
On Success: A message confirms that the initiator has been added.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Remove an Initiator from an iSCSI Target
Removes an initiator IQN from an iSCSI target.
Input Parameters Name Type Description Comments
Subsystem HitachiStorageConnector:Subsystem
Hitachi storage array
port string Array target port
targetNam string iSCSI target
Installation and Configuration 93
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments e name initiator string iSCSI initiator
IQN
On Success: A message confirms the removal.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Present LU: iSCSI
Presents an LU by adding it to an iSCSI target.
Input Parameters Name Type Description
Subsystem HitachiStorageConnector:Subsystem Hitachi storage array Port string Array target port targetName string iSCSI target name LU string LU
On Success: A message indicating success is returned.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Unpresent LU: iSCSI
Unpresents an LU by removing it from an iSCSI target.
Input Parameters Name Type Description Comments
Subsystem HitachiStorageConnector:Subsystem
Subsystem Object
port string Array target port
targetName
string iSCSI target name
LU string LU
On Success: A message indicating success is returned.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
94 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Get iSCSI Targets
Gets a list of existing iSCSI targets.
Input Parameters Name Type Description Comments
Subsystem HitachiStorageConnector:Subsystem Hitachi storage array
port String Array target port
On Success: A list of iSCSI targets appears.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
HNAS Workflows – File/Storage Configuration
Add HNAS
This workflow creates an object representing an HNAS node or cluster. This object can be passed to subsequent workflows to reference the HNAS.
Location
Library\Hitachi\Storage\File\Storage Configuration
Input Parameters Name Type Description Comments
HNASFileServerIP string HN6.02 HNAS node or cluster IP address
UserID string HNAS node or cluster account
Password SecureString HNAS node or cluster password
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Installation and Configuration 95
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Add HNAS using credential
This workflow registers the provided HNAS with Orchestrator and returns a subsystem JavaScript object. This object is added as an invtory object in the Orchestrator client. Subsequent HNAS operations can be performed using this object.
Input Parameters Name Type Description Comments
Credential workflow object Credential object
N/A
On Success: The subsystem object is returned.
On Failure: An exception is thrown.
Get registered HNAS Fileserver
This workflow returns the HNAS File server objects currently connected in Orchestrator. This workflow does not require any parameter.
On Success: All the registered HNAS objects returned.
On Failure: An exception is thrown.
HNAS Workflows – File/Provisioning
Create File Clone Use this workflow to clone one file. The Source file path and Destination file path must be within same filesystem. And they must be both in format of absolute path instead of relative path. Source file path must exist and Destination file path must not exist. The operation should finish almost instantly regardless of the size of file. Metadata such as file times, security, and so on are not copied. The filesystem must be mounted.
Input Parameters
Name Type Description Comments
HNAS file server Workflow object returned from Add HNAS File Server
IP Address of HNAS File Server
N/A
File system String File system N/A
96 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
name Source file path String Absolute path
of source file path
N/A
Destination file path
String Absolute path of destination file path
N/A
On Success: a message indicating success is returned.
On Failure: an exception’s thrown.
Create Filesystem
Creates a filesystem on the specified HNAS node or cluster.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description
HNASFileServer HitachiStorageConnector:HNASFileServer HNAS node or cluster
EVSIPAddress String EVS IP address
FileSystemLabel String Filesystem StoragePoolName String Storage
Pool
On Success: A message confirms that the file system has been created.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Delete File System
Use this workflow to delete a file system on an HNAS device.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
Installation and Configuration 97
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
HNAS File Server workflow object returned from Add HNAS File Server
FileSystem label String File System Name
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Create NFS Export
Creates an NFS export.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
HNASFileServer HitachiStorageConnector:HNASFileServer
HNAS node or cluster
EVSIPAddress string EVS IP address
FileSystemLabel string Filesystem NFSExportName
string NFS export name
FileSystemPath string Path to export
AccessConfig string Access Config
Comma-separated list of IP Addresses to be set under Access Config of the NFS Export
Snapshot Option
Enum Snapshot option to be set for the NFS Export
Options are: SSOPTION_HIDE_AND_DISABLE_ACCESS SSOPTION_HIDE_AND_ALLOW_ACCESS SSOPTION_SHOW_AND_ALLOW_ACCESS
98 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
LocalReadCache Option
HitachiStorageConnector:LOCAL_READ_CACHE_OPTION
Local Read Cache Option
LOCALRCOPT_DISABLED LOCALRCOPT_ENABLEDFORALLFILES LOCALRCOPT_ENABLEDFORTAGGEDFILES LOCALRCOPT_ENABLEDFORCVLS
TransferToReplicationTargetSetting
HitachiStorageConnector:TRANSFER_TO_REPLICATION_TARGET_SETTING
Transfer to replication target setting
TRANSREPSETTING_DONOTTRANSFER TRANSREPSETTING_TRANSFER TRANSREPSETTING_USEFSDEFAULT TRANSREPSETTING_INVALID
On Success: A message confirms that the operation has succeeded.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Delete NFS Export
Deletes an NFS export.
Location
Library\Hitachi\Storage\File\Provisioning
Installation and Configuration 99
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
HNASFileServer
HitachiStorageConnector:HNASFileServer
HNAS node or cluster
Workflow object returned from Add HNAS File Server
EVSIP string EVS IP address
NFSExportName
string NFS export
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Add Root Hosts to NFS Export
Adds hosts to an NFS export with root-squash disabled.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
HNASFileServer
HitachiStorageConnector:HNASFileServer
HNAS node or cluster
Workflow object returned from Add HNAS File Server
EVSIPAddress String EVS IP address NFSExportName
String NFS export
FileSystemLabel
String Filesystem
Roothosts String NFS client IP address(es)
Comma-separated
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
100 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Add RW hosts to NFS Export
Adds hosts to an NFS export with read/write permission.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
HNASFileServer
HitachiStorageConnector:HNASFileServer
HNAS node or cluster
Workflow object returned from Add HNAS File Server
EVSIPAddress
string EVS IP address
NFSExportName
string NFS export
FileSystemLabel
string Filesystem
RWhosts string NFS client IP address(es)
Comma-separated
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Remove Root Hosts from NFS Export
Removes hosts from an NFS export which have root-squash disabled.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
HNASFileServer
HitachiStorageConnector:HNASFileServer
HNAS node or cluster
Workflow object returned from Add HNAS File Server
EVSIPAddress string EVS IP
Installation and Configuration 101
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
address NFSExportName
string NFS export
FileSystemLabel
string Filesystem
Roothosts string NFS client IP address(es)
Comma-separated
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Remove RW Hosts from NFS Export
Removes hosts from an NFS export that has read/write permission.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Descriptio
n Comment
s
HNASFileServer
HitachiStorageConnector:HNASFileServer
HNAS node or cluster
Workflow object returned from Add HNAS File Server
EVSIPAddress string EVS IP address
NFSExportName
string NFS export
FileSystemLabel
string Filesystem
RWhosts string NFS client IP address(es)
Comma-separated
On Success: A message confirms that the operation was successful.
102 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Set Filesystem Size
Sets an HNAS filesystem's size (expansion limit)
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Descriptio
n Comment
s
HNASFileServer
HitachiStorageConnector:HNASFileServer
HNAS node or cluster
Workflow object returned from Add HNAS File Server
FileSystemLabel
string Filesystem
FileSystemSize
string Filesystem size (in GB)
Expansion limit
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Set NFS Export Size
Sets an NFS export's size
This workflow sets the quota on the virtual volume associated with this NFS export.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
HNASFileServer HitachiStorageConnector:HNASFileSer
HNAS node or cluster
Workflow object returned from Add HNAS File
Installation and Configuration 103
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments ver Server
FileSystemLabel string Filesystem EVSIPAddress string EVS IP address NFSExportName string NFS export NFSExportSize string NFS export size (in
GB) Quota adjustment
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Set Filesystem Syslock
Enables or disables syslock on an HNAS filesystem
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
string Workflow object returned from Add HNAS File Server
Name of the File System
String File System Name
Enable Syslock
Boolean When set to true, enables the syslock on the file system. When set to false, disables the syslock
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Get Filesystems
Gets a list of HNAS filesystems.
Location
Library\Hitachi\Storage\File\Provisioning
104 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
String IP Address of HNAS File Server
Get NFS Exports
Gets a list of NFS exports.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
String IP Address of HNAS File Server
EVS IP Address
String IP Address of EVS Server
Get NFS Exports: by Export Name
Use this workflow to perform a search based on the NFS Export name pattern and retrieve the list of NFS Exports that match the specified export name pattern. Use wild cards to provide the name pattern, for example, NFS*.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
String IP Address of HNAS File Server
EVS IP Address
String IP Address of EVS Server
NFS Export name
String NFS export name pattern
Installation and Configuration 105
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Get NFS Exports: by NFS Client(s)
Use this workflow to perform a search based on the host name pattern in the access config of NFS Exports and retrieve the list of NFS exports that match the pattern. Use wild cards to provide the host pattern (for example, 172*).
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
string IP Address of HNAS File Server
EVS IP Address
string IP Address of EVS Server
Mount Filesystem
Use this workflow to mount an HNAS filesystem
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
string IP Address of HNAS File Server
N/A
Filesystem string Filesystem name
N/A
On Success: A message indicating success is returned.
On Failure: A exception is thrown.
Unmount an HNAS Filesystem
Use this workflow to unmount an HNAS filesystem
Location
Library\Hitachi\Storage\File\Provisioning
106 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
string IP Address of HNAS File Server
N/A
FilesystemLabel string Filesystem name
N/A
On Success: A message indicating success is returned.
On Failure: An exception’s thrown.
Create Filesystem snapshot
Use this workflow to create an HNAS filesystem snapshot
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
IP Address of HNAS File Server
Workflow object returned from Add HNAS File Server
IP Address of HNAS File Server
N/A
Filesystem string Filesystem name
N/A
Snapshot name string Snapshot name
N/A
On Success: A message indicating success is returned.
On Failure: An exception’s thrown.
Delete Filesystem Snapshot
This workflow deletes an HNAS file system snapshot identified by the file system and snapshot names.
Location
Library\Hitachi\Storage\File\Provisioning
Installation and Configuration 107
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
HNASFileServer Worflow object returned from Add HNAS File Server
IP Address of HNAS File Server
N/A
FileSystemLabel string File system name
N/A
Snapshot Name string Snapshot name
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Get Filesystem Snapshots
This workflow retrieves a list of snapshots for an HNAS file system.
Location
Library\Hitachi\Storage\File\Provisioning
Input Parameters Name Type Description Comments
HNASFileServer Worflow object returned from Add HNAS File Server
IP Address of HNAS File Server
N/A
FileSystemLabel string File system name
N/A
Snapshot Name string Snapshot name
N/A
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Output Parameters Name Type Description Comments
HNASFileServer Worflow object returned from Add HNAS File Server
IP Address of HNAS File Server
N/A
FileSystemLabel string File system N/A
108 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments name
Snapshot Name string Snapshot name
N/A
CreationTime string The time when the snapshot was created
N/A
SnapshotStatus string The current administrative state of the snapshot
N/A
SnapshotType string The type of snapshot
N/A
High-level workflows To demonstrate how to utilize the above basic workflows, Hitachi also provides a number of high-level workflows that encompass the basic building blocks into a complete end-to-end task.
Backup ESXi Datastore
The workflow backups a datastore that resides on an Enterprise system LU. The workflow adds the enterprise array at the beginning of the process and closes it after the task completes.
Input Parameters Name Type Description Comments
ESX Host IP string The ESX host IP
On Success: A new Replication object contains the Datastore and a message indicating success is returned.
On Failure: An exception is thrown.
Mount the most recent VM backups
This workflow mounts the second most recent backup VMDK to the Virtual Machine on an HNAS backed datastore. You need to fill out the workflow attributes before running this workflow.
Input Parameters Name Type Description Comments
Source VM name string The VM name
Installation and Configuration 109
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Provision ESXi Datastore using HNAS NFS export
This workflow provisions a Datastore using an exported HNAS NFS.
Input Parameters Name Type Description Comments
Filesystem label string Name of the filesystem
NFSExportname string Name of the NFS export
Host workflow object vCenter host object
Datastore name string Datastore name
On Success: A message indicating success is returned and a new Datastore is available for the host.
On Failure: An exception is thrown.
Smart Provision a LUN/Datastore to a host/cluster
This workflow provisions a LUN and creates a Datastore on the specified VM.
Input Parameters Name Type Description Comments
vCenter workflow object subsystem object
ESX Host IP string ESX host Size string Datastore size
On Success: A message indicating success is returned and a new Datastore is available.
On Failure: An exception is thrown.
Self service VM recovery
This workflow recovers a snapshot back up in HNAS and mounts it to a user specified VM. You need to register the vCenter to the Add vCenter workflow.
110 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
vCenter workflow object subsystem object
ESX Host IP string ESX host VM Name string VM name Backup Name string Backup name
On Success: A message indicating success is returned.
On Failure: An exception is thrown.
Supporting Workflows Supporting workflows are used for high-level tasks and are not run as individual workflows.
Convert Datastore to a PVOL number
This supported workflow that is used in the Provision a LUN to an ESXihost and Simple Provision a LUN to ESXi workflows.
Input Parameters Name Type Description Comments
Datastore name string The Datastore name
On Success: A message indicating success is returned along with the PVOL and array serial number.
On Failure: A message indicates that the Datastore is not on the Hitachi arrays.
Get ESXi Host WWN
This workflow is used in the Simple Provision a LUN to ESXi workflow.
Input Parameters Name Type Description Comments
Host name string The ESX host name
On Success: A message indicating success is returned along with a list of WWNs belonging to the ESX host.
On Failure: An empty string.
Installation and Configuration 111
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Provision an NFS export to an ESXi host
This workflow is used in the Provision ESXi Datastore using HNAS NFS export workflow.
Input Parameters Name Type Description Comments
HNAS Fileserver workflow object HNAS fileserver object
EVSIPAddress string EVS IP address Filesystem label string Name of the file
system
NFSExportname string Name of the NFS export
Filesystem path string LocalReadCacheOption
workflow enum
Transfer to Replication Target
workflow enum
Host workflow object vCenter host object
Datastore name string Datastore name
On Success: A message indicating success is returned and a new Datastore is available to the host.
On Failure: An exception is thrown.
Hitachi Virtual Infrastructure Integrator
Hitachi Virtual Infrastructure Integrator is a comprehensive data protection solution for VMware vSphere environments, accessed through the vSphere Web Client, that lets virtual machine (VM) administrators manage their VMs’ data management services effectively. Virtual Infrastructure Integrator leverages the high performance and scalability of Hitachi snapshot services. It simplifies data management with scheduled and instantaneous backup, recovery and cloning services, reducing risks, costs and administrative overhead. It helps you meet backup and recovery service level agreements (SLAs) at VM-level granularity while improving resource utilization.
Virtual Infrastructure Integrator software has two components:
112 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
• Server software
• Web client service plugin
Refer to Hitachi Virtual Infrastructure Integrator Administration guide for setup and configuration.
Note: Supported Hitachi Virtual Infrastructure Integrator must be installed and configured prior to running below the V2I workflows.
V2I Configuration
Add V2I Server
Creates a connection object for use with subsequent HNAS V2I workflows.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\V2I Configuration
Input Parameters Name Type Description Comments
IP Address string IP Address of the vCenter Server
vCenter webclient must have V2I configured
UserID string UserID to connect to the vCenter Server
NA
Password string Password of the vCenter Server
NA
Port Integer Default is 443 if not specified
Optional
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Connect VIServer using credential
This workflow registers the vCenter with Orchestrator and returns a subsystem JavaScript object. This object is added as an inventory object in the Orchestrator client. Subsequent V2I operations can be performed using this object.
Installation and Configuration 113
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\V2I Configuration
Input Parameters Name Type Description Comments
Credential workflow object Credential object
N/A
Snapshot Backup
Clone VM
This workflow allows cloning a VM on the backed data store, using V2I technology.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\Snapshot Backup
Input Parameters Name Type Description Comments
vRealize Server Connection Object
Hitachi StorageConnector:HNASV2I
Workflow object returned from Connect VI Server workflow
Source VM Name
string
ESX host IP Address
string
Name of the clone to be created
string VM Clone name
Number of clones to be created
string Optional. One clone is created if not specified.
Source backup Name
string Name of the Source backup from which to create the clone
Optional. To use the source backup, specify the name here.
114 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Restore VM to Alternate Location
This workflow supports restoring a VM to a provided alternate location from the clone on the backed data store, using V2I technology.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\Snapshot Backup
Input Parameters Name Type Description Comments
vCenter Server Connection Object
Hitachi StorageConnector:HNASV2I
vCenter Server Connection Object
Source VM Name
string Name of the Source VM
ESX host IP Address
string IP Address of the ESX host
Backup Name
string Name of the backup from which the VM needs to be restored
Alternate name of the VM
string Alternate Name of the VM
Backup VM
This workflow allows backup of a VM on the backed data store, using V2I technology.
Note This workflow does not support special characters.
Installation and Configuration 115
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\Snapshot Backup
Input Parameters Name Type Description Comments
vRealize Server Connection Object
Hitachi StorageConnector:HNASV2I
Workflow object returned from Connect VI Server workflow
Source VM Name
string Name of the VM to be unmounted
Backup Name
string Name of the backup
Is Quiescent Backup
Boolean Set to true if backup must be quiescent
Number of days to retain the backup
Integer
Description of the backup
string
ESX Host IP Address
string IP Address of the ESX host
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Backup All V2I managed VMs
This workflow supports backup of all VMs managed under V2I.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\Snapshot Backup
116 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Input Parameters Name Type Description Comments
vRealize Server Connection Object
Hitachi StorageConnector:HNASV2I
Workflow object returned from Connect VI Server workflow
Datastore Name
string Name of the HNAS datastore
Backup Name
string Name of the backup
Is Quiescent Backup
Boolean Set to true if backup needs to be quiescent
Number of days to retain the backup
Integer
Description of the backup
string
ESX Host IP Address
string IP Address of the ESX host
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Mount VM
This workflow supports mounting of a VM on the backed data store using V2I technology.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\Snapshot Backup
Input Parameters Name Type Description Comments
vRealize Server Connection Object
Hitachi StorageConnector:HNASV2I
Workflow object returned from Connect VIServer workflow
NA
Installation and Configuration 117
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments
Source VM Name
string Name of the Source VM
NA
ESX host IP Address
string IP Address of the ESX host
NA
Backup Name
string Name of the backup from which to mount the VM
NA
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
UnMount VM
This workflow lets you unmount a VM on an backed data store using V2I technology.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\Snapshot Backup
Input Parameters Name Type Description Comments
vRealize Server Connection Object
Hitachi StorageConnector:HNASV2I
Workflow object returned from Connect VIServer workflow
NA
Source VM Name
string Name of the VM to be unmounted
NA
ESX host IP Address
string IP Address of the ESX host
NA
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
118 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Get list of Backups
This workflow allows backup of a VM on the backed data store, using V2I technology.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\Snapshot Backup
Input Parameters Name Type Description Comments
VIServer Hitachi StorageConnector:HNASV2I
Workflow object returned from Connect VI Server workflow
NA
ESXHostIP String Backup managed ESX host IP
NA
Source VM Name
String Name of the VM Backup
NA
On Success: Action result lists all backup.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
V2I Backup Group
Create Backup Group
This workflow creates a V2I backup group on the V2I server. You need to register the vCenter with the V2I server before using this workflow.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\V2I Backup Group
Input Parameters Name Type Description Comments
Group name string A string identifies the group name
Description string Description of the
Installation and Configuration 119
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Name Type Description Comments backup group
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Add Backup group member
This workflow adds a new member to a backup group in the V2I server. You need to register the vCenter with the V2I server before using this workflow.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\V2I Backup Group
Input Parameters Name Type Description Comments
Group name string A string identifies the group name
Member name string A string identifies the member name
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Get Backup group members
This workflow retrieves the member list of a backup group from the V2I server. You need to register the vCenter with the V2I server before using this workflow.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\V2I Backup Group
Input Parameters Name Type Description Comments
Group name string A string identifies the group name
120 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Delete Backup Group member
This workflow deletes a member from a backup group in the V2I server. You need to register the vCenter with the V2I server before using this workflow.
Location
Library\Hitachi\Storage\Block\Storage Configuration
Input Parameters Name Type Description Comments
Group name string A string identify the group name
Description string Description of the backup group
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Get Backup groups
This workflow retrieves list of a backup groups from the V2I server. You need to register the vCenter with the V2I server before using this workflow.
Location
Library\Hitachi\Storage\Hitachi Virtual Infrastructure Integrator\V2I Backup Group
Input Parameters Name Type Description Comments
VIServer Hitachi StorageConnector:HNASV2I
Select VI server
On Success: A message confirms that the operation was successful.
On Failure: An exception is thrown, and an error message indicates the possible cause of the problem.
Installation and Configuration 121
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
122 Installation and Configuration
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Troubleshooting 123
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Troubleshooting
This chapter provides troubleshooting information for Hitachi Storage Connector for VMware vRealize Orchestrator.
Troubleshooting Table Logs Log Levels Error Codes
124 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Troubleshooting Table The following table provides general troubleshooting information for operations. If you need technical assistance, see Getting Help.
The workflows and actions are not visible under the Library folder in the Orchestrator Client.
Make sure that you have copied the .dar file to the Orchestrator server from the windows host where it was installed. Ensure that the file has been uploaded to the Orchestrator server and Orchestrator server is restarted.
Workflows/actions fail to run.
Each workflow has exception handling and error codes set in the workflow script. Check the exception and error code under the Variables pane in the Orchestrator client after the workflow runs. Refer to server.log for the detailed information as specified below.
USP-V/VM, VSP, or HUS-VM subsystems cannot be registered through the workflow.
Make sure that HDvM is accessible from the Windows machine where Hitachi Storage Web Service is configured and running. You can verify this by navigating to Error! Hyperlink reference not valid. IP address>:2001/service/StorageManager
Storage functions fail while running the workflows; for example Create Lun and Create HostGroup fail
Make sure that the Hitachi Storage Web Service is configured and running on a Windows host. Check the details log on this machine as specified below to understand the issue further.
Add Enterprise Array workflow fails with “API cannot connect to the storage array.”
Make sure that CCI and CMD Device are configured as is described here. Also, make sure that the Horcm instances are running on the host where Hitachi vCO web service is running. Ensure that the username and password are correct.
Add Modular Array workflow fails to connect to the Array
If authentication is enabled, make sure that the credentials supplied are correct.
After the Hitachi Web service restarts (as in the Restart Web Service workflow), the system responds
The Web Service does not communicate its status to the Device Manager. The workaround is to run the Close All Storage Array Connections workflow before you restart the web service.
Symptom Recommended Action
Troubleshooting 125
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
with an error message for the next operation. Error received is API call failed for the operation.
Check the HiStorAPI.log (see Hitachi Storage Web Service Log) for the cause of the error. You can also change the log level to VERBOSE and retry the operation.
Logs
Hitachi Storage Connector Logs
Orchestrator server provides a logging mechanism for the Hitachi Storage Connector for VMware vRealize Orchestrator. The log file resides at the following location on the Orchestrator server.
<Orchestrator Installed path>Orchestrator\app-server\server\vmo\log\HiStorageWebService.log
Hitachi Storage Web Service Log
The log file originates at the location by default:
C:\Program Files\Hitachi\vROStorageConnector\log
on the Windows host where Hitachi Storage Web Service is installed.
Refer to the following log files for troubleshooting:
HivCenter.log—Hitachi vRO service log file.
HiStorAPI.log—Storage API log file
Log Levels
The Hitachi Storage Web Service supports these log levels: NORMAL VERBOSE MINIMAL
The default log level is NORMAL.
126 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Modifying the Log Level
To change the log level, follow these steps:
1. Open the HiStorWebService.config file from the installation folder of the Web service in the notepad.
2. Modify the DebugLevel parameter.
3. Restart the Hitachi Storage Web Service for this to take effect.
Hitachi Log Message Format
While the log messages can be verbose, it may be useful while troubleshooting to pay attention to these messages. All messages are subject to change.
All Storage Provider error messages have the following format: E320AXXX E denotes that the message is an error visually. 32 is the product code. 0 is always set to 0. XXX is 3 hexadecimal digits that describe the actual error.
Error Codes E3200A000
Error Message ID
0xE320A000
Error Message Text
INVALID_USER_ID_PASSWORD
Explanation Invalid username or password Recommended
Action Please check username, password or protocol.
E3200A001 Error Message
ID 0xE320A001
Error Message Text
USER_ID_PASSWORD_REQUIRED
Explanation Required username and password for logging into the storage subsystem.
Recommended Action
Provide valid user name and password
Troubleshooting 127
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A002 Error Message
ID 0xE320A002
Error Message Text
AUTHENTICATION_NOT_REQUIRED
Explanation HUS system does not need authentication when logging in
Recommended Action
HUS system does not need authentication when logging in
E3200A003 Error Message
ID 0xE320A003
Error Message Text
ERR_AddSNM2StorageDevice
Explanation Error occurred while registering HUS Subsystem Recommended
Action Check credential and connectivity to the subsystem
E3200A004 Error Message
ID 0xE320A004
Error Message Text
ERR_AddRAIDStorageDevice
Explanation Error occurred while registering RAID Subsystem Recommended
Action Check credential,Horcm instance and connectivity to the subsystem.
E3200A005 Error Message
ID 0xE320A005
Error Message Text
ERR_Createlu
Explanation Error occurred while creating the logical unit Recommended
Action Check the parameters and examine the error message to pin point the root cause.
128 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A006 Error Message
ID 0xE320A006
Error Message Text
ERR_Presentlu
Explanation Error occurred while presenting the logical unit Recommended
Action Check the parameters and examine the error message to pin-point the root cause. Check whether the LU is already presented or the LU existed.
E3200A007 Error Message
ID 0xE320A007
Error Message Text
ERR_UnPresentlu
Explanation Error occurred while UnPresenting the logical unit Recommended
Action Check the parameters and examine the error message to pin-point the root cause. Check whether the LU is not part of the host group or the LU existed.
E3200A008 Error Message
ID 0xE320A008
Error Message Text
ERR_CreateHG
Explanation Error occurred while creating a host group Recommended
Action Check the parameters and examine the error message to pin point the root cause. Check whether the host group already existed.
E3200A009 Error Message
ID 0xE320A009
Error Message Text
ERR_getHG
Explanation Error occurred while retrieving host group information Recommended Check the parameters and examine the error message
Troubleshooting 129
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Action to pin point the root cause.
E3200A000A Error Message
ID 0xE320A000A
Error Message Text
ERR_getLu
Explanation Error occurred while retrieving LUN information Recommended
Action Check the parameters and examine the error message to pin point the root cause.
E3200A00B Error Message
ID 0xE320A00B
Error Message Text
ERR_DeleteLu
Explanation Error occurred while deleting the logical unit Recommended
Action Check the parameters and examine the error message to pin-point the root cause. Checks if the LU existed or the LU is still present to a host group
E3200A00C Error Message
ID 0xE320A00C
Error Message Text
ERR_DeleteHg
Explanation Error occurred while deleting the host group Recommended
Action Check the parameters and examine the error message to pin-point the root cause. Checks if the host group existed
E3200A00D Error Message
ID 0xE320A00D
Error Message Text
ERR_CreateSnapshot
Explanation Error occurred while creating a snapshot
130 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A00E Error Message
ID 0xE320A00E
Error Message Text
ERR_DeleteSnapshot
Explanation Error occurred while deleting the snapshot Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A00F Error Message
ID 0xE320A00F
Error Message Text
ERR_GetSnapshot
Explanation Error occurred while retrieving snapshot information Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A010 Error Message
ID 0xE320A010
Error Message Text
ERR_SplitSnapshot
Explanation Error occurred while splitting the snapshot pair Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A011 Error Message
ID 0xE320A011
Error Message Text
ERR_ResyncSnapshot
Explanation Error occurred while resynchronizing the snapshot pair Recommended Check the parameters and examine the error message
Troubleshooting 131
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Action to pin-point the root cause.
E3200A012 Error Message
ID 0xE320A012
Error Message Text
ERR_RestoreSnapshot
Explanation Error occurred while restoring the snapshot pair Recommended
Action Checks the parameters and examine the error message to pin-point the root cause.
E3200A013 Error Message
ID 0xE320A013
Error Message Text
ERR_GetStorageDevice
Explanation Error occurred while retrieving the Storage subsystems information
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A0014 Error Message
ID 0xE320A014
Error Message Text
ERR_AddWWNToHg
Explanation Error occurred while adding WWN's to the host group Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A015 Error Message
ID 0xE320A015
Error Message Text
ERR_CreateFS
Explanation Error occurred while creating the FileSystem Recommended Check the parameters and examine the error message
132 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Action to pin-point the root cause.
E3200A016 Error Message
ID 0xE320A016
Error Message Text
ERR_UpdateFS
Explanation Error occurred while updating the FileSystem Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A017 Error Message
ID 0xE320A017
Error Message Text
ERR_SetFSSysLock
Explanation Error occurred while setting the SysLock on the FileSystem
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A018 Error Message
ID 0xE320A018
Error Message Text
ERR_GetFS
Explanation Error occurred while retrieving FileSystem objects Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A019 Error Message
ID 0xE320A019
Error Message Text
ERR_CreateFSSnapshot
Explanation Error occurred while creating the FileSystem snapshot Recommended Check the parameters and examine the error message
Troubleshooting 133
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Action to pin-point the root cause.
E3200A01A Error Message
ID 0xE320A01A
Error Message Text
ERR_CreateNFSExport
Explanation Error occurred while creating the NFS export Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A01B Error Message
ID 0xE320A01B
Error Message Text
ERR_IncreaseNFSSize
Explanation Error occurred while increasing the NFS export size Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A01C Error Message
ID 0xE320A01C
Error Message Text
ERR_SetNFSAccessConfig
Explanation Error occurred while setting the access config of the NFS export
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A01D Error Message
ID 0xE320A01D
Error Message Text
ERR_GetNFS
Explanation Error occurred while retrieving the NFS exports Recommended Check the parameters and examine the error message
134 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Action to pin-point the root cause.
E3200A001E Error Message
ID 0xE320A01E
Error Message Text
ERR_DeleteNFS
Explanation Error occurred while deleting the NFS export Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A01F Error Message
ID 0xE320A01F
Error Message Text
ERR_RGNOTVALID
Explanation Missing parameter RAID Group value Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A020 Error Message
ID 0xE320A020
Error Message Text
ERR_LuSizeZero
Explanation The LU size may not be zero Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A021 Error Message
ID 0xE320A021
Error Message Text
ERR_LunRangeInvalid
Explanation Invalid Range Of LUN Numbers Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
Troubleshooting 135
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A022 Error Message
ID 0xE320A022
Error Message Text
ERR_CreateVVol
Explanation Error occurred while creating a virtual volume Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A023 Error Message
ID 0xE320A023
Error Message Text
ERR_DeleteInactiveInstances
Explanation Error occurred while removing inactive Storage Manager sessions
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A024 Error Message
ID 0xE320A024
Error Message Text
ERR_GetShadowImagePairList
Explanation Error occurred while retrieving ShadowImage pairs Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A025 Error Message
ID 0xE320A025
Error Message Text
ERR_CreateShadowImagePair
Explanation Error occurred while creating ShadowImage pair Recommended
Action Check the parameters and examine the error message to pin point the root cause.
136 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A026 Error Message
ID 0xE320A026
Error Message Text
ERR_DeleteShadowImagePair
Explanation Error occurred while deleting the ShadowImage pair Recommended
Action Check the parameters and examine the error message to pin point the root cause.
E3200A027 Error Message
ID 0xE320A027
Error Message Text
ERR_SplitShadowImagePair
Explanation Error occurred while splitting the ShaowImage pair Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A0028 Error Message
ID 0xE320A0028
Error Message Text
ERR_ResyncShadowImagePair
Explanation Error occurred while resynchronizing the ShadowImage pair
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A029 Error Message
ID 0xE320A029
Error Message Text
ERR_RestoreShadowImagePair
Explanation Error occurred while restoring the ShadowImage pair Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
Troubleshooting 137
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A02A Error Message
ID 0xE320A02A
Error Message Text
ERR_SplitShadowImagePair
Explanation Error occurred while splitting the ShaowImage pair Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A02B Error Message
ID 0xE320A02B
Error Message Text
ERR_RemoveWWNFromHg
Explanation Error occurred while removing WWNs from the Host group
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A02B Error Message
ID 0xE320A02B
Error Message Text
ERR_GetIsciTargetList
Explanation Error occurred while retrieving the iSCSI targets Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A02C Error Message
ID 0xE320A02C
Error Message Text
ERR_GetIsciTarget
Explanation Error occurred while retrieving the iSCSI target Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
138 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A02D Error Message
ID 0xE320A02D
Error Message Text
ERR_CreateIsciTarget
Explanation Error occurred while adding the iSCSI target Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A02E Error Message
ID 0xE320A02E
Error Message Text
ERR_RemoveIsciTarget
Explanation Error occurred while removing the iSCSI target Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A02F Error Message
ID 0xE320A02F
Error Message Text
ERR_AddInitiatorToIsciTarget
Explanation Error occurred while adding the initiator to iSCSI target
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A030 Error Message
ID 0xE320A030
Error Message Text
ERR_RemoveInitiatorFromISCSITarget
Explanation Error occurred while removing the initiator from the iSCSI target
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
Troubleshooting 139
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A0031 Error Message
ID 0xE320A0031
Error Message Text
ERR_AddLogicalUnitToISCSITarget
Explanation Error occurred while adding the logical unit to iSCSI target
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A032 Error Message
ID 0xE320A032
Error Message Text
ERR_RemoveLogicalUnitFromISCSITarget
Explanation Error occurred while removing the logical unit from the iSCSI target
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A033 Error Message
ID 0xE320A033
Error Message Text
ERR_HasHUVMSupport
Explanation Error occurred while checking the HUVM support Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A034 Error Message
ID 0xE320A034
Error Message Text
ERR_CreateHTISnapshot
Explanation Error occurred while creating HTI snapshot pair Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
140 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A035 Error Message
ID 0xE320A035
Error Message Text
ERR_GetHTISnapshot
Explanation Error occurred while getting HTI snapshot pairs Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A036 Error Message
ID 0xE320A036
Error Message Text
ERR_GetSnapshotPairName
Explanation Error occurred while getting ShadowImage pairs Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A037 Error Message
ID 0xE320A037
Error Message Text
ERR_CreateSnapshotPair
Explanation Error occurred while creating ShadowImage pair Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A038 Error Message
ID 0xE320A038
Error Message Text
ERR_SplitSnapshotName
Explanation Error occurred while splitting the ShadowImage pair Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
Troubleshooting 141
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A039 Error Message
ID 0xE320A039
Error Message Text
ERR_ResyncSnapshotPairName
Explanation Error occurred while resynchronizing the ShadowImage pair object
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A03A Error Message
ID 0xE320A03A
Error Message Text
ERR_RestoreSnapshotPairName
Explanation Error occurred while restore the ShadowImage pair object
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
E3200A03B Error Message
ID 0xE320A03B
Error Message Text
ERR_DeleteSnapshotPairName
Explanation Error occurred while deleting the ShadowImage pair object
Recommended Action
Check the parameters and examine the error message to pin point the root cause.
E3200A03C Error Message
ID 0xE320A03C
Error Message Text
ERR_CreateVVolAutoLunID
Explanation Error occurred while creating a virtual volume (auto generated ID)
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
142 Troubleshooting
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
E3200A03D Error Message
ID 0xE320A03D
Error Message Text
ERR_InvalidWWN
Explanation The WWN does not exist in the host group Recommended
Action Check the parameters and examine the error message to pin-point the root cause.
E3200A03E Error Message
ID 0xE320A03E
Error Message Text
ERR_MaxLunSize
Explanation The LU size exceeds the maximum value allowed on the system
Recommended Action
Check the parameters and examine the error message to pin-point the root cause.
Abbreviations, Terms, and Acronyms 143
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Abbreviations, Terms, and Acronyms
This glossary defines the special terms, acronyms, and abbreviations used in this document. Click the desired letter below to display the glossary entries that start with that letter.
# 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
A
C
CLI Command-line interface
Controller The component in a storage system that manages all storage functions. It is analogous to a computer and contains a processors, I/O devices, RAM, power supplies, cooling fans, and other sub-components as needed to support the operation of the storage system.
Copy-on-write
Point-in-time snapshot copy of any data volume within a storage system. Copy-on-write snapshots only store changed data blocks, therefore the amount of storage capacity required for each copy is substantially smaller than the source volume.
D
Device Manager By providing a single console for managing complex storage environments, Hitachi Device Manager Software unifies and simplifies storage
144 Abbreviations, Terms, and Acronyms
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
management and gives you full control of your storage. Featuring both an intuitive graphical user interface (GUI) and a complete command line interface (CLI), Device Manager allows you to centrally manage single or multiple Hitachi storage systems.
DP-VOLs Dynamic Pool volumes
D-Provisioning Dynamic Provisioning
E
ESXi VMware vSphere Hypervisor
F
H
Hitachi Dynamic Provisioning (HDP) Advanced thin-provisioning software product that provides virtual storage capacity to simplify administration and addition of storage, eliminate application service interruptions, and reduce costs.
HDP Hitachi Dynamic Provisioning
HDvM Hitachi HiCommand Device Manager
HORCM Hitachi Open Remote Copy Manager (also known as CCI)
Host-Group
HTTP HyperText Transfer Protocol
HUS
Hitachi Unified Storage
HUS-VM
Hitachi Unified Storage VM
I
IBM International Business Machines Corporation
IP Internet Protocol
IP Address An Internet Protocol (IP) address is a unique numerical label assigned to a device.
IQN iSCSI qualified name
iSCSI Internet Small Computer System Interface
J
L
LDEV Logical device
Logical Volume (LV)
LU Logical Unit (LU): a logical volume that is configured for use by open-systems hosts (for example, OPEN-V).
LUN Logical Unit Number
M
Management
146 Abbreviations, Terms, and Acronyms
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
Management includes discovery, initialization, configuration, provisioning, health and performance monitoring, alarms and alerts, and other system management functions.
O
OS Operating System
P
Connector A connector is a software application that acts and an interface between two or more other applications.
PS PowerShell
P-Vol Primary Volume
Q
R
RAID Redundant Array of Inexpensive Disks
RAID Group A Redundant Array of Inexpensive Disks (RAID) that have the same capacity and are treated as one group for data storage and recovery. A RAID group contains both user data and parity information, which allows the user data to be accessed in the event that one or more of the drives within the RAID group are not available. The RAID level of a RAID group determines the number of data drives and parity drives and how the data is “striped” across the drives. For RAID1, user data is duplicated within the RAID group, so there is no parity data for RAID1 RAID groups. A RAID group can also be called an array group or a parity group.
RAM
Random Access Memory
Raw Capacity The total space available in a RAID group, without subtracting the overhead of the system itself.
RCU Remote Control Unit
RG RAID Group
RMI Remote method invocation
S
SAN Storage Area Network
SNMP Simple Network Management Protocol
SN Serial number
SNM2 Storage Navigator Modular 2 (for HUS arrays only)
Storage Storage array or device Storage includes both block and file storage and a form factor that scales from a single node appliance to large scalable multi-node configurations.
S-VOL Secondary Volume
SVP Service Program (OS that resides on RAID array)
T
148 Abbreviations, Terms, and Acronyms
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
U
UID User ID
URL Uniform resource locator
USP Universal Storage Platform
User Account Uniquely identify a user for authentication and authorization to the subsystem. A user uses his user account to authenticate to the subsystem. The subsystem uses the user account to determine the access rights for the login user.
W
WWN World Wide Name. An 8-byte, unique number that identifies a particular fibre channel, Advanced Technology Attachment (ATA), or Serial Attached SCSI (SAS) target.
WWPN World-Wide Port Name V
VM Virtual Machine
VSP Virtual Storage Platform
Abbreviations, Terms, and Acronyms 149
Hitachi Storage Connector for VMware vRealize Orchestrator User’s Guide
MK-92ADPTR108-04
Hitachi Data Systems
Corporate Headquarters 2845 Lafayette Street Santa Clara, California 95050-2639 U.S.A. www.hds.com
Regional Contact Information
Americas +1 408 970 1000 [email protected]
Europe, Middle East, and Africa +44 (0) 1753 618000 [email protected]
Asia Pacific +852 3189 7900 [email protected]