ibm storage integration serverdelivery04.dhe.ibm.com/.../2/ibm_storage_integration… · ·...

IBM Storage Integration ServerVersion 1.5.0

User Guide

SC27-5999-05

��

NoteBefore using this document and the product it supports, read the information in “Notices” on page 113.

Edition notice

Publication number: SC27-5999-05. This publication applies to version 1.5.0 of the IBM Storage Integration Serverand to all subsequent releases and modifications until otherwise indicated in a newer publication.

© Copyright IBM Corporation 2013, 2014.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

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

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

About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixWho should use this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixConventions used in this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixRelated information and publications . . . . . . . . . . . . . . . . . . . . . . . . . . . ixGetting information, help, and service . . . . . . . . . . . . . . . . . . . . . . . . . . . xOrdering publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xSending your comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Included cloud interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

IBM Storage Provider for VMware VASA . . . . . . . . . . . . . . . . . . . . . . . . . 1IBM Storage Enhancements for VMware vSphere Web Client . . . . . . . . . . . . . . . . . . 2IBM Storage Plug-in for VMware vCenter Orchestrator . . . . . . . . . . . . . . . . . . . . 2IBM Storage Management Pack for VMware vCenter Operations Manager. . . . . . . . . . . . . . 3

Concept diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Compatibility and requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Download site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2. Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Upgrading an existing installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Extracting and installing the Integration Server software package . . . . . . . . . . . . . . . . . 10

Replacing the SSL certificate and key files . . . . . . . . . . . . . . . . . . . . . . . . 11Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Uninstalling the Integration Server software . . . . . . . . . . . . . . . . . . . . . . . 13Uninstalling version 1.1.0 of the IBM Storage Enhancements for VMware vSphere Web Client . . . . . . . 14

Chapter 3. Integration Server operation and management . . . . . . . . . . . . . . 17Required and optional initial tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Configuring directory user access . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Managing the Integration Server from the command-line interface (CLI) . . . . . . . . . . . . . . . 24

CLI – Switching to 'ISIS' user mode . . . . . . . . . . . . . . . . . . . . . . . . . . 24CLI – Adding and managing Integration Server users . . . . . . . . . . . . . . . . . . . . 25CLI – Adding or removing storage array credentials . . . . . . . . . . . . . . . . . . . . . 26CLI – Adding or removing storage arrays . . . . . . . . . . . . . . . . . . . . . . . . 28CLI – Setting the VASA credentials . . . . . . . . . . . . . . . . . . . . . . . . . . 30CLI – Managing integration with vSphere Web Client . . . . . . . . . . . . . . . . . . . . 31CLI – Managing integration with vCenter Orchestrator . . . . . . . . . . . . . . . . . . . . 34CLI – Managing integration with vCenter Operations Manager . . . . . . . . . . . . . . . . . 36CLI – Backing up or restoring an Integration Server configuration . . . . . . . . . . . . . . . . 40

Managing the Integration Server from the graphical user interface (GUI) . . . . . . . . . . . . . . . 42GUI – Logging in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42GUI – Managing storage arrays. . . . . . . . . . . . . . . . . . . . . . . . . . . . 43GUI – Managing Integration Server users . . . . . . . . . . . . . . . . . . . . . . . . 49GUI – Managing and monitoring VASA access . . . . . . . . . . . . . . . . . . . . . . 53GUI – Managing integration with vSphere Web Client . . . . . . . . . . . . . . . . . . . . 56GUI – Managing integration with vCenter Orchestrator. . . . . . . . . . . . . . . . . . . . 64GUI – Managing integration with vCenter Operations Manager . . . . . . . . . . . . . . . . . 68

Chapter 4. Using the IBM Storage Provider for VMware VASA . . . . . . . . . . . . 73Registering the Integration Server as a storage provider in vCenter Server . . . . . . . . . . . . . . 73

© Copyright IBM Corp. 2013, 2014 iii

Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client . . . 77Required vSphere privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Populating vCenter server information to the Integration Server . . . . . . . . . . . . . . . . . . 79Viewing the IBM storage resource information. . . . . . . . . . . . . . . . . . . . . . . . 80Creating and mapping a new storage volume (LUN) . . . . . . . . . . . . . . . . . . . . . 84Extending a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Renaming a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Setting multipath policy enforcement for a volume . . . . . . . . . . . . . . . . . . . . . . 92Moving a volume to another storage pool . . . . . . . . . . . . . . . . . . . . . . . . . 93Unmapping a volume from one or more hosts. . . . . . . . . . . . . . . . . . . . . . . . 94Deleting an unused volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Chapter 6. Using the IBM Storage Plug-in for VMware vCenter Orchestrator . . . . . . 97

Chapter 7. Using the IBM Storage Management Pack for VMware vCenter OperationsManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Chapter 8. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . 105Checking and controlling the Integration Server service . . . . . . . . . . . . . . . . . . . . 105Checking the log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Checking and modifying the configuration files . . . . . . . . . . . . . . . . . . . . . . . 107Checking the format of directory-based storage array credentials . . . . . . . . . . . . . . . . . 108

Chapter 9. Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Handling datastores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Handling ESXi hosts that use XIV volumes . . . . . . . . . . . . . . . . . . . . . . . . 111Distributing volumes evenly on DS8000 systems. . . . . . . . . . . . . . . . . . . . . . . 111Setting the multipath policy for DS8000 and Storwize Family systems . . . . . . . . . . . . . . . 111

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

iv IBM Storage Integration Server

Figures

1. Integration of IBM storage systems with a VMware environment . . . . . . . . . . . . . . . . 42. IBM Storage Integration Server version number . . . . . . . . . . . . . . . . . . . . . . 83. vSphere Web Client – Client Plug-Ins . . . . . . . . . . . . . . . . . . . . . . . . . 94. IBM Storage Extension in the vCenter Plug-in Manager . . . . . . . . . . . . . . . . . . . 95. Connection security warning in the Mozilla FireFox web browser . . . . . . . . . . . . . . . 126. VMware vSphere Web Client on the Windows services list . . . . . . . . . . . . . . . . . . 157. 'Add or Remove Programs' dialog box . . . . . . . . . . . . . . . . . . . . . . . . 168. IBM Storage Integration Server login box in a standard web browser . . . . . . . . . . . . . . 439. Arrays option on the left GUI panel . . . . . . . . . . . . . . . . . . . . . . . . . 44

10. Current storage array username (for all storage arrays) . . . . . . . . . . . . . . . . . . . 4511. Add Storage Array page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4612. List of added storage arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4713. Storage array details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4714. Storage Arrays – Edit button . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4815. Modify Array Address page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4816. Storage Arrays – Remove button . . . . . . . . . . . . . . . . . . . . . . . . . . 4917. Remove Storage Array confirmation message . . . . . . . . . . . . . . . . . . . . . . 4918. Users option on the left GUI panel . . . . . . . . . . . . . . . . . . . . . . . . . . 5019. Add User page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5120. List of added Integration Server users (user names) . . . . . . . . . . . . . . . . . . . . 5121. Integration Server Users – Edit button . . . . . . . . . . . . . . . . . . . . . . . . 5222. Update User page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5223. Integration Server Users – Remove button . . . . . . . . . . . . . . . . . . . . . . . 5324. VASA option on the left GUI panel. . . . . . . . . . . . . . . . . . . . . . . . . . 5425. Registered VASA servers (vCenter servers that employ VASA services). . . . . . . . . . . . . . 5426. Current VASA Secret username . . . . . . . . . . . . . . . . . . . . . . . . . . . 5527. VWC option on the left GUI panel . . . . . . . . . . . . . . . . . . . . . . . . . . 5628. Add vCenter Server page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5729. List of vCenter servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5830. Update vCenter Server Credentials page . . . . . . . . . . . . . . . . . . . . . . . . 5931. VWC – vCenter Servers – Remove button . . . . . . . . . . . . . . . . . . . . . . . 6032. Remove vCenter Server confirmation message . . . . . . . . . . . . . . . . . . . . . . 6033. Attach Storage Pools page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6234. List of attached storage pools per vCenter server . . . . . . . . . . . . . . . . . . . . . 6335. Detach Storage Pool confirmation message . . . . . . . . . . . . . . . . . . . . . . . 6436. vCO option on the left GUI panel . . . . . . . . . . . . . . . . . . . . . . . . . . 6537. vCO Server Pool Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . 6538. vCO Token Management box . . . . . . . . . . . . . . . . . . . . . . . . . . . 6639. Download Plug-in Package button . . . . . . . . . . . . . . . . . . . . . . . . . . 6740. Token Management box – Current vCO Token . . . . . . . . . . . . . . . . . . . . . . 6741. vCenter Orchestrator – IBM Storage Plug-in Configuration . . . . . . . . . . . . . . . . . . 6842. vCOps option on the left GUI panel . . . . . . . . . . . . . . . . . . . . . . . . . 6943. vCOps server and attached arrays . . . . . . . . . . . . . . . . . . . . . . . . . . 6944. vCOps server details and On/Off (Enable/Disable) button. . . . . . . . . . . . . . . . . . 7045. Download PAK File button . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7046. vSphere Client – Storage Providers list . . . . . . . . . . . . . . . . . . . . . . . . 7447. Add Vendor Provider dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . 7548. vCenter certificate thumbprint dialog box . . . . . . . . . . . . . . . . . . . . . . . 7549. Vendor Providers list displaying the IBM Storage Integration Server . . . . . . . . . . . . . . 7650. VMware vSphere Web Client – Create Role dialog box . . . . . . . . . . . . . . . . . . . 7851. Populate vCenter Information option . . . . . . . . . . . . . . . . . . . . . . . . . 7952. Populate vCenter confirmation message . . . . . . . . . . . . . . . . . . . . . . . . 8053. IBM Storage category in vSphere Web Client . . . . . . . . . . . . . . . . . . . . . . 8054. IBM Storage information per storage array . . . . . . . . . . . . . . . . . . . . . . . 8155. Currently available storage pools per storage array . . . . . . . . . . . . . . . . . . . . 81

© Copyright IBM Corp. 2013, 2014 v

56. IBM Storage information per vCenter server . . . . . . . . . . . . . . . . . . . . . . 8257. IBM Storage information per datacenter . . . . . . . . . . . . . . . . . . . . . . . . 8258. IBM Storage information per datastore . . . . . . . . . . . . . . . . . . . . . . . . 8259. IBM Storage information per all ESXi hosts of a vCenter server . . . . . . . . . . . . . . . . 8360. IBM Storage information per all VM templates of a vCenter server . . . . . . . . . . . . . . . 8361. IBM Storage information per all vApps of a vCenter server . . . . . . . . . . . . . . . . . 8362. IBM storage array view – Clicking Create New Volume . . . . . . . . . . . . . . . . . . . 8463. Top Level Objects view – Clicking Create New Volume . . . . . . . . . . . . . . . . . . . 8564. Right-clicking the storage array . . . . . . . . . . . . . . . . . . . . . . . . . . . 8565. Clicking the Create New Volume icon. . . . . . . . . . . . . . . . . . . . . . . . . 8666. Create New Volume wizard (XIV example) . . . . . . . . . . . . . . . . . . . . . . . 8667. Setting the volume size with the graphic space marker . . . . . . . . . . . . . . . . . . . 8768. Creating multiple volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8869. Creating multiple volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8970. Advanced Host Mapping dialog box . . . . . . . . . . . . . . . . . . . . . . . . . 9071. Clicking Extend on the pop-up menu . . . . . . . . . . . . . . . . . . . . . . . . . 9172. Rename volume option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9273. Rename Volume dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9274. Set Multipath Policy Enforcement option. . . . . . . . . . . . . . . . . . . . . . . . 9375. Change Multipath Policy Enforcement dialog box . . . . . . . . . . . . . . . . . . . . . 9376. Move volume option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9477. Unmap volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9578. Delete volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9679. vCenter Orchestrator – Create New Volume workflow – General tab . . . . . . . . . . . . . . 9780. vCenter Orchestrator – Create New Volume workflow – Inputs tab . . . . . . . . . . . . . . . 9881. vCenter Orchestrator – Create New Volume workflow – Parameter References tab . . . . . . . . . . 9882. vCenter Orchestrator – Storage Arrays panel . . . . . . . . . . . . . . . . . . . . . . 9983. vCenter Operations Manager – IBM XIV Top 10 dashboard . . . . . . . . . . . . . . . . . 10284. vCenter Operations Manager – IBM XIV Overview dashboard . . . . . . . . . . . . . . . . 10385. vCenter Operations Manager – IBM XIV Performance dashboard . . . . . . . . . . . . . . . 10486. Integration Server GUI – Collect Logs option . . . . . . . . . . . . . . . . . . . . . . 10787. Integration Server GUI – Saving the logs in a compressed TAR archive . . . . . . . . . . . . . 10788. XIV role mapping attributes for directory (LDAP) users . . . . . . . . . . . . . . . . . . 109

vi IBM Storage Integration Server

Tables

1. Required tasks in sequential order . . . . . . . . . . . . . . . . . . . . . . . . . . 172. Optional tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183. Arguments for isis_ldap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204. ldap.ini configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 235. Arguments for isis_users . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256. Arguments for isis_storage_credentials . . . . . . . . . . . . . . . . . . . . . . . 277. Arguments for isis_storage_array . . . . . . . . . . . . . . . . . . . . . . . . . 298. Arguments for vasa_admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309. Arguments for vwc_vcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

10. Arguments for vwc_pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3311. Arguments for vwc_host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3312. Arguments for vco_pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3513. Arguments for vco_token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3614. Arguments for vcops_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3715. Arguments for vcops_adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . 3916. Arguments for isis_configuration . . . . . . . . . . . . . . . . . . . . . . . . . 4117. Required vSphere privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7818. Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

© Copyright IBM Corp. 2013, 2014 vii

viii IBM Storage Integration Server

About this guide

This guide describes how to install, configure, and use the IBM® StorageIntegration Server and its solution components.

Who should use this guideThis guide is intended for system administrators who are familiar with theVMware vCenter and vSphere environments, and with the specific IBM storagesystem that is in use.

Conventions used in this guideThese notices are used in this guide to highlight key information.

Note: These notices provide important tips, guidance, or advice.

Important: These notices provide information or advice that might help you avoidinconvenient or difficult situations.

Attention: These notices indicate possible damage to programs, devices, or data.An attention notice appears before the instruction or situation in which damagecan occur.

Related information and publicationsYou can find additional information and publications related to the IBM StorageIntegration Server on the following information sources.v IBM Storage Host Software Solutions Information Center

(publib.boulder.ibm.com/infocenter/strhosts/ic)v IBM DS8000® Information Center (publib.boulder.ibm.com/infocenter/dsichelp/

ds8000ic)v IBM SAN Volume Controller Information Center (publib.boulder.ibm.com/

infocenter/svc/ic)v IBM Storwize® V3500 Information Center (publib.boulder.ibm.com/infocenter/

storwize/v3500_ic)v IBM Storwize V3700 Information Center (publib.boulder.ibm.com/infocenter/



storwize/ic)v IBM Storwize V7000 Unified Information Center (publib.boulder.ibm.com/

infocenter/storwize/unified_ic)v IBM XIV® Storage System Information Center (publib.boulder.ibm.com/

infocenter/ibmxiv/r2)v VMware Documentation (vmware.com/support/pubs)v VMware Product Support (vmware.com/support)

© Copyright IBM Corp. 2013, 2014 ix

http://publib.boulder.ibm.com/infocenter/strhosts/ic

http://publib.boulder.ibm.com/infocenter/dsichelp/ds8000ic

http://publib.boulder.ibm.com/infocenter/svc/ic

http://publib.boulder.ibm.com/infocenter/storwize/v3500_ic



http://publib.boulder.ibm.com/infocenter/storwize/ic

http://publib.boulder.ibm.com/infocenter/storwize/unified_ic

http://publib.boulder.ibm.com/infocenter/ibmxiv/r2

http://www.vmware.com/support/pubs

http://www.vmware.com/support

v VMware Knowledge Base (kb.vmware.com)

Getting information, help, and serviceIf you need help, service, technical assistance, or want more information about IBMproducts, you can find various sources to assist you. You can view the followingwebsites to get information about IBM products and services and to find the latesttechnical information and support.v IBM website (ibm.com®)v IBM Support Portal website (www.ibm.com/storage/support)v IBM Directory of Worldwide Contacts website (www.ibm.com/planetwide)

Ordering publicationsThe IBM Publications Center is a worldwide central repository for IBM productpublications and marketing material.

The IBM Publications Center website (www.ibm.com/shop/publications/order/)offers customized search functions to help you find the publications that you need.Some publications are available for you to view or download at no charge. You canalso order publications. The publications center displays prices in your localcurrency.

Sending your commentsYour feedback is important in helping to provide the most accurate and highestquality information.

Procedure

To submit any comments about this guide or any other IBM Storage Host SoftwareSolutions documentation:v Go to the online feedback form (http://pic.dhe.ibm.com/infocenter/strhosts/ic/

topic/com.ibm.help.strghosts.doc/icfeedback.htm). You can use this form toenter and submit comments.

v You can send your comments by email to [email protected]. Be sure toinclude the following information:– Exact publication title and version– Publication form number (for example: GC00-1111-22)– Page, table, or illustration numbers that you are commenting on– A detailed description of any information that should be changed

Note: When you send information to IBM, you grant IBM a nonexclusive rightto use or distribute the information in any way it believes appropriate withoutincurring any obligation to you.

x IBM Storage Integration Server

http://kb.vmware.com

http://www.ibm.com

http://www.ibm.com/storage/support

http://www.ibm.com/planetwide

http://www.ibm.com/shop/publications/order/

http://pic.dhe.ibm.com/infocenter/strhosts/ic/topic/com.ibm.help.strghosts.doc/icfeedback.htm

mailto:[email protected]?subject=IBM Storage Host Software Solutions publications

Chapter 1. Introduction

The IBM Storage Integration Server is a centralized server system that consolidatesa range of IBM storage provisioning, virtualization, cloud, automation, andmonitoring solutions through a unified server platform.

The IBM Storage Integration Server provides a single server backend location andenables centralized management of IBM storage resources for differentvirtualization and cloud platforms, including:v VMware vCenter Serverv VMware vSphere Web Clientv VMware vSphere APIs for Storage Awareness (VASA)v VMware vCenter Operations Manager (vCOps)v VMware vCenter Orchestrator (vCO)

Through its user credential, storage array, and storage pool management options,the IBM Storage Integration Server facilitates the integration of IBM storage systemresources with the supported virtualization and cloud platforms, while providingthe foundation for integration with future IBM systems and Independent SoftwareVendor (ISV) solutions.

The IBM Storage Integration Server can be managed through a standard webbrowser and a graphical user interface (GUI), or through terminal and acommand-line interface (CLI).

Included cloud interfacesThe following solution components, referred to as cloud interfaces, are included inthe IBM Storage Integration Server software package:v IBM Storage Provider for VMware VASAv IBM Storage Enhancements for VMware vSphere Web Clientv IBM Storage Plug-in for VMware vCenter Orchestratorv IBM Storage Management Pack for VMware vCenter Operations Manager

IBM Storage Provider for VMware VASAThe IBM Storage Provider for VMware VASA improves the ability to monitor andautomate storage-related operations on VMware platforms.

From its IBM Storage Integration Server host, the IBM Storage Provider forVMware VASA provides a standard interface for any connected VMware vCenterServer using the VMware vSphere APIs for Storage Awareness (VASA). It deliversinformation about IBM storage topology, capabilities, and state, together withstorage events and alerts to vCenter Server in real time.

To visualize how this cloud interface is integrated in a virtualized environment, see“Concept diagram” on page 3.

© Copyright IBM Corp. 2013, 2014 1

IBM Storage Enhancements for VMware vSphere Web ClientThe IBM Storage Enhancements for VMware vSphere Web Client integrate into theVMware vSphere Web Client platform and enable VMware administrators toindependently and centrally manage their storage resources on IBM storagesystems.

Depending on the IBM storage system in use, VMware administrators canself-provision volumes (LUNs) in selected storage pools that were predefined bythe storage administrators. The volumes are mapped to ESXi hosts, clusters, ordatacenters as logical drives that can be used for storing VMware datastores(virtual machine data containers).

As opposed to the IBM Storage Management Console for VMware vCenter, whichis individually installed on each vCenter server, the IBM Storage Enhancements forvSphere Web Client are installed only on the vSphere Web Client Server, allowingmultiple vCenter servers to utilize IBM storage resources. In addition, storage poolattachment and detachment operations are performed on the IBM StorageIntegration Server side, rather than on the vSphere Client side.

The IBM Storage Enhancements for VMware vSphere Web Client are automaticallydeployed and enabled for each and every vCenter server that is registered forvSphere Web Client services on the connected IBM Storage Integration Server.


IBM Storage Plug-in for VMware vCenter OrchestratorThe IBM Storage Plug-in for VMware vCenter Orchestrator allows VMwareadministrators to include IBM storage discovery and provisioning in their vCenterOrchestrator (vCO) automation workflows.

Note: In version 1.5.0, the IBM Storage Plug-in for VMware vCenter Orchestratorsupports only XIV storage systems.

The plug-in package can be downloaded from the IBM Storage Integration Serverand can then be deployed on the vCenter Orchestrator server. The deploymentincludes the matching of a unique token key that is set on both servers.

Through vCenter Orchestrator Client, dedicated IBM Storage control elementsbecome available, allowing the issuing of workflows with storage pools that areattached to the vCenter Orchestrator server.

Rather than issuing volume operations manually and being limited to one manualoperation at a time, VMware administrators can preplan and automate storageoperations in their virtualized cloud environments, either directly from vCenterOrchestrator or through the VMware vCloud Automation Center (vCAC) platform.


2 IBM Storage Integration Server

IBM Storage Management Pack for VMware vCenterOperations Manager

The IBM Storage Management Pack for VMware vCenter Operations Managerallows Operations Manager users to obtain comprehensive monitoring informationabout the IBM storage resources that are utilized in their virtualized environment.

Note: In version 1.5.0, the IBM Storage Management Pack for VMware vCenterOperations Manager supports only XIV storage systems.

The management pack can be downloaded from the IBM Storage IntegrationServer and can then be deployed on the vCenter Operations Manager server.

After a VMware vCenter Operations Manager server is registered on an IBMStorage Integration Server that is configured with storage arrays, storage pools,and vCenter servers, storage-related data is pushed to the Operations Managerserver at fixed time intervals.

The dedicated IBM storage system adapter on the vCenter Operations Managerserver gathers datastore-related data at fixed time intervals as well, for matching itwith the received storage-related data.

The storage-related data includes monitoring data of all logical and physicalelements, covering storage arrays, storage domains, storage pools, volumes,volumes, hosts, modules, target ports, disks, health status, events, thresholds, andperformance.

This comprehensive monitoring information is displayed in vCenter OperationsManager through dedicated IBM Storage dashboards, displaying tables withdetailed status, statistics, metrics, and analytics data alongside hierarchicalflowcharts with graphic representation of storage elements.

Relationships between the IBM Storage elements (storage arrays, ports, storagepools, volumes) and datastores, virtual machines, and hosts are displayedgraphically in a drill-down style, providing VMware administrators a completeand up-to-date picture of their utilized storage resources.

To visualize how this cloud interface is integrated in a virtualized environment, see“Concept diagram.”

Concept diagramThe following concept diagram illustrates how IBM storage systems are accessedand utilized from the VMware environment through the IBM Storage IntegrationServer.

The storage administrator uses the IBM Storage Integration Server to control whichIBM storage systems (arrays) and what storage pools should be available for use inthe VMware environment, and control which specific vCenter servers can utilizethe IBM storage resources. This control, as well as other administrative options, arereferred to in the diagram as 'Integration Server operation and management'.

Chapter 1. Introduction 3

The IBM Storage Integration Server allows registered VMware vCenter servers toutilize its VASA functions, which can be monitored on the vSphere Client station.

In parallel, the following operations are enabled on the VMware environment side:v Through vSphere Web Client, administrators can manually create, map, and

fully control storage volumes on the available storage systems and storage pools.v Through vCenter Orchestrator, administrators can issue workflows for

automating the same volumes operations that are available through vSphereWeb Client. The automation is run by the VMware vCloud Automation Center(vCAC) platform.

v Through vCenter Operations Manager, administrators can obtain comprehensivemonitoring information about the IBM storage resources that are utilized in theirvirtualized environment.

Note: The IBM Storage Integration Server can use only predefined storage pools.New storage pools cannot be created from the Integration Server or from theVMware environment, and must be created in advance through the dedicatedstorage system management tools.

Figure 1. Integration of IBM storage systems with a VMware environment


Compatibility and requirementsFor the complete and up-to-date information about the compatibility andrequirements of the IBM Storage Integration Server, refer to its latest release notes.

You can find the latest release notes on the IBM Storage Host Software SolutionsInformation Center (publib.boulder.ibm.com/infocenter/strhosts/ic) or on the IBMFix Central (www.ibm.com/support/fixcentral).

Note: Refer to the relevant VMware documentation for information about how toinstall the compatible versions of vSphere Web Client Server. You should also referto the latest installation and configuration instructions for ESXi and vCenterservers.

Download siteThe IBM Storage Integration Server is available as a free software solution.

You can download the latest version at any time from the IBM Fix Central(www.ibm.com/support/fixcentral).

Chapter 1. Introduction 5



http://www.ibm.com/support/fixcentral



Chapter 2. Installation

After downloading the IBM Storage Integration Server software package, you canbegin the installation as described in the following sections.v “Upgrading an existing installation”v “Extracting and installing the Integration Server software package” on page 10v “Replacing the SSL certificate and key files” on page 11

For information about uninstallation, see “Uninstallation” on page 13.

Upgrading an existing installationIf you are already using a previous version of the IBM Storage Integration Server,you can upgrade to the newer version without having to uninstall the previousversion.

Note: For the first-time installation procedure, see “Extracting and installing theIntegration Server software package” on page 10.

To upgrade to the newer Integration Server version:1. Log out of the Integration Server GUI and close the browser.2. On the vSphere Web Client Server side: if you were using version 1.1.0 of the

IBM Storage Enhancements for vSphere Web Client, perform the manualuninstallation procedure as described in “Uninstalling version 1.1.0 of the IBMStorage Enhancements for VMware vSphere Web Client” on page 14.

3. On the IBM Storage Integration Server side: download the newer installationpackage (see “Download site” on page 5).

4. Extract the downloaded package (see steps 1–2 in “Extracting and installingthe Integration Server software package” on page 10).

5. Go to the extracted directory and then use the -U *.rpm command (asopposed to rpm -vi *.rpm that is used in first-time installations).

6. Enter chmod +x ibm_storage_integration_server-1.5.0-*.bin to authorizethe installation of the product BIN file.

7. Enter ./ibm_storage_integration_server-1.5.0-*.bin to start and completethe installation.

8. If you are using a DS8000 storage array, enter./ibm_storage_integration_server_java_runtime_extension-1.5.0-*.bin toinstall the required Java™ components for DS8000.

9. Log in (see “GUI – Logging in” on page 42) and go to Help > About to verifythat the Integration Server version number has been updated.


10. To avoid issues with the VASA Provider functionality, replace the self-signedSSL certificate as described in “Replacing the SSL certificate and key files” onpage 11.

The IBM Storage Enhancements for vSphere Web Client are automatically updatedon each and every registered vCenter server (previously added to the IntegrationServer; see 'List of vCenter servers' in “GUI – Adding a vCenter server” on page57). Accordingly:1. On vSphere Web Client: log off and then log on.2. Go to Home > Administration > Client Plug-Ins and verify that the latest

version of the IBM Storage Enhancements is enabled for each relevant vCenterserver.

Figure 2. IBM Storage Integration Server version number


If you are managing a vCenter server through vSphere Client, you can verify thatthe IBM Storage Extension plug-in has been updated by checking the vCenterPlug-in Manager.

Figure 3. vSphere Web Client – Client Plug-Ins

Figure 4. IBM Storage Extension in the vCenter Plug-in Manager

Chapter 2. Installation 9

Extracting and installing the Integration Server software packageYou can install the IBM Storage Integration Server software on a compatibleversion of Red Hat Enterprise Linux (RHEL). For more information, refer to therelease notes.

Procedure

Perform the following procedure to install the IBM Storage Integration Server:1. Copy the installation package file to a local folder on the Linux host that will

be used as the IBM Storage Integration Server.2. Extract the installation package file ('* ' represents the build number) :

# tar xvf ibm_storage_integration_server-1.5.0-*.tar.gz

The following RPM files are extracted:v nginx-1.4.1-1.el6.ngx.x86_64.rpm

v postgresql92-9.2.2-1PGDG.rhel6.x86_64.rpm

v postgresql92-libs-9.2.2-1PGDG.rhel6.x86_64.rpm

v postgresql92-server-9.2.2-1PGDG.rhel6.x86_64.rpm

v uuid-1.6.1-10.el6.x86_64.rpm

v ibm_storage_integration_server-1.5.0-*.bin – product BIN file.v ibm_storage_integration_server_java_runtime_extension-1.5.0-*.bin –

Required if DS8000 is used; should be installed last.3. Go to the extracted directory and then use the rpm -vi *.rpm command to run

and install all the complementary RPM files.

Important:

v Do not install the ibm_storage_integration_server-1.5.0-*.bin file before allthe complementary RPM files have been installed (see the following steps).

v If DS8000 is to be used, installibm_storage_integration_server_java_runtime_extension-1.5.0-*.rpm last,only after ibm_storage_integration_server-1.5.0-*.bin is installed (see thefollowing steps).

The IBM Storage Provider service starts automatically after the installation (formore information, see “Checking and controlling the Integration Server service”on page 105), and a new Linux username – isis – is created so that you canuse it for Integration Server management operations.

4. Enter chmod +x ibm_storage_integration_server-1.5.0-*.bin to authorize theinstallation of the product BIN file.

5. Enter ./ibm_storage_integration_server-1.5.0-*.bin to start the installation.6. When the following prompt appears, enter 1 to accept the license agreement

and complete the installation:


Press Enter to continue viewing the license agreement, or enter "1" to acceptthe agreement, "2" to decline it, "3" to print it, "4" to read non-IBM terms,or "99" to go back.

1

Preparing for new installation...Creating system user isis...Configuring rsyslog...Setting up nginx...Generating SSL certificate...Configuring postgresql database...Creating IBM Storage Integration Server user...Configuring IBM Storage Integration Server...Adding iptables rules...Starting Celery services... [OK]Starting Django service... [OK]NOTE: An initial username ’admin’ with an initial password ’adminadmin’has been defined for the initial access (via the CLI or GUI) to theIBM Storage Integration Server.IMPORTANT: To avoid unauthorized access to the IBM Storage Integration Server,the password for this username should be changed as soon as possible.You can control IBM Storage Integration Server services using the’service ibm_storage_integration_server {start|stop|status}’ command.

Installation completed successfully.

7. If you are using a DS8000 storage array, enter./ibm_storage_integration_server_java_runtime_extension-1.5.0-*.bin toinstall the required Java components for DS8000.

8. When the following prompt appears, enter 1 to accept the license agreementand complete the installation:

Press Enter to continue viewing the license agreement, or enter "1" to acceptthe agreement, "2" to decline it, "3" to print it, "4" to read non-IBM terms,or "99" to go back.

1

Stopping Django service ... [OK]Stopping Celery services ... [OK]Starting DS8000 proxy.....[OK]Starting Celery services ... [OK]Starting Django service ... [OK]

Installation completed successfully.

Replacing the SSL certificate and key filesDuring the installation, a self-signed Secure Sockets Layer (SSL) certificate isgenerated to create a secure communication channel for servers and clients. If youalready have a trusted certificate that you want to use, you can replace theself-signed certificate with the trusted certificate.

About this task

A self-signed certificate file, vp.crt, and a certificate key file, vp.key, are stored inthe following directory:

/opt/ibm/ibm_storage_integration_server/settings/ssl_cert

Because the self-signed certificate is not automatically recognized by the webbrowser that you use to log in to the Integration Server, you might encounter aconnection security warning before you can access the Integration Server login


page (see “GUI – Logging in” on page 42).

To avoid such warning messages, you need to replace the SSL certificate and keyfiles, as described in the following procedure.

Procedure1. Place your trusted SSL certificate file and SSL certificate key file in the

/opt/ibm/ibm_storage_integration_server/settings/ssl_cert directory.The SSL certificate file is your primary certificate that is combined with theintermediate certificate (your_domain_name.crt). The SSL certificate key file isgenerated when you create the certificate signing request.

2. Edit the isis_nginx.conf file in the opt/ibm/ibm_storage_integration_server/conf.d/nginx directory by updating the file names on the following lines:

ssl_certificate ssl_cert/vp.crt

ssl_certificate_key ssl_cert/vp.key

Note: You can also override the existing certificate and key files, by using thesame file names (vp.crt and vp.key).

3. Run the service nginx restart command to restart the Nginx process.

What to do next

The format of your key file can be PK12, or a combination of CRT or PEM and KEY.v To convert the certificates bundle file from PK12 format to PEM, run the

following command:openssl pkcs12 -nokeys -in server-cert-key-bundle.p12-out server-ca-cert-bundle.pem

Figure 5. Connection security warning in the Mozilla FireFox web browser


v To convert the server key file from PK12 format to KEY, run the followingcommand:openssl pkcs12 -nocerts -nodes -in server-cert-key-bundle.p12-out server.key

UninstallationYou can uninstall the IBM Storage Integration Server software packages in twoseparate uninstallation procedures.

Attention:

v To avoid loss of user accounts, credentials, storage array configurations, storagepool attachments, and vCenter server associations – always back up the IBMStorage Integration Server configuration before any uninstallation. For moreinformation, see “CLI – Backing up or restoring an Integration Serverconfiguration” on page 40.

v Uninstalling the software on the IBM Storage Integration Server side causes thefollowing features to cease functioning:– All CLI and GUI management options on the IBM Storage Integration Server

side.– IBM Storage Enhancements on the vSphere Web Client side.– VASA-related operations on the vCenter server side.

However, existing volumes are not affected and continue to function and bemanageable from the standard storage system management tools.

The following sections describe how to uninstall each individual software package.v “Uninstalling version 1.1.0 of the IBM Storage Enhancements for VMware

vSphere Web Client” on page 14v “Uninstalling the Integration Server software”

Uninstalling the Integration Server softwareIf you want to completely remove the IBM Storage Integration Server softwarefrom the Linux host upon which it is installed, follow the steps in the followingprocedure.

Before you begin

To avoid loss of user accounts, credentials, storage array configurations, storagepool attachments, and vCenter server associations – always back up the IBMStorage Integration Server configuration before any uninstallation. For moreinformation, see “CLI – Backing up or restoring an Integration Serverconfiguration” on page 40.

Important: Before removing the IBM Storage Integration Server software, removeall vCenter servers that were registered for vSphere Web Client, as explained in“GUI – Removing a vCenter server” on page 59. If any vCenter server is notremoved prior to the uninstallation, the IBM Storage Enhancements will remainvisible but not functional for that vCenter server.


Procedure

To uninstall the Integration Server software from the Linux host:1. Log on to the Linux command prompt environment as a root user.2. Stop the Integration Server service, as explained in “Checking and controlling

the Integration Server service” on page 105.3. Run the standard Linux uninstallation command for each installed package (as

detailed in “Extracting and installing the Integration Server software package”on page 10).

Uninstalling version 1.1.0 of the IBM Storage Enhancementsfor VMware vSphere Web Client

If you have been using version 1.1.0 of the IBM Storage Integration Server, youmust manually uninstall the previous version of the IBM Storage Enhancements forVMware vSphere Web Client.

Before you begin

If there are IBM storage volumes that are currently in use by VMware datastores, itis recommended that these volumes remain monitored by the storage administratoron the IBM storage system side. All volume management functions will bedisabled on the vSphere Web Client side until the IBM Storage Enhancements arereinstalled.

Procedure1. Stop the VMware vSphere Web Client Server service.


2. From the Windows Control Panel, go to Programs > Programs and Features >Change or Remove Programs, select IBM Storage Enhancements for VMwarevSphere Client on the list of installed programs, and then click Remove.

Figure 6. VMware vSphere Web Client on the Windows services list


The uninstallation wizard guides you through the remaining uninstallationsteps.

3. Resume the VMware vSphere Web Client Server service.

Figure 7. 'Add or Remove Programs' dialog box


Chapter 3. Integration Server operation and management

This chapter describes the initial operation tasks, as well as the full range ofmanagement options that are available on the IBM Storage Integration Server.v “Required and optional initial tasks”v “Configuring directory user access” on page 18v “Managing the Integration Server from the command-line interface (CLI)” on

page 24v “Managing the Integration Server from the graphical user interface (GUI)” on

page 42

Required and optional initial tasksAfter the IBM Storage Integration Server is installed, different tasks are requiredbefore the server can become fully operational.

Refer to the following tables for information about the required and optional andmanagement tasks.

Note: Unless specified otherwise in the 'Interface' column, you can perform tasksfrom either the command-line interface (CLI) or graphical user interface (GUI).

Table 1. Required tasks in sequential order

Step Required task Interface Refer to

1. Set a password for the 'isis' user ifnecessary (a Linux root user action), andthen switch to the 'isis' user.

CLI v “CLI – Switching to 'ISIS' user mode” on page 24

2. Log in to the GUI and then change thepassword of the initial admin user.

GUI v “GUI – Logging in” on page 42

v “GUI – Changing the password of an IntegrationServer user” on page 51

3. Add the storage array (storage system)access credentials

CLI orGUI

v “CLI – Adding or removing storage arraycredentials” on page 26

v “GUI – Entering the storage array credentials” onpage 44

4. Add the storage arrays to be used CLI orGUI

v “CLI – Adding or removing storage arrays” onpage 28

v “GUI – Adding a storage array” on page 46

5. Set the VASA access credentials ("VASASecret") to allow connection of vCenterservers that require VASA functions.Note: Not applicable to DS8000 systems.

CLI orGUI

v “CLI – Setting the VASA credentials” on page 30

v “GUI – Setting the VASA credentials” on page 55

6. Add vCenter servers for which you want toutilize the IBM Storage Enhancements forVMware vSphere Web Client.

CLI orGUI

v “CLI – Managing integration with vSphere WebClient” on page 31

v “GUI – Adding a vCenter server” on page 57

7. For DS8000 systems only: specify the ESXhost details.

CLI v “CLI – Managing integration with vSphere WebClient” on page 31


Table 1. Required tasks in sequential order (continued)

Step Required task Interface Refer to

8. Attach storage pools to any specific vCenterserver that was added.

CLI orGUI

v “CLI – Managing integration with vSphere WebClient” on page 31

v “GUI – Attaching storage pools to a vCenterserver” on page 60

9. Establish integration with vCenterOrchestrator (vCO).Note: Applicable only to XIV systems.

CLI orGUI

v “Downloading and installing the plug-in packagefor vCO” on page 66

v “CLI – Managing integration with vCenterOrchestrator” on page 34

v “GUI – Managing integration with vCenterOrchestrator” on page 64

10. Establish integration with vCenterOperations Manager (vCOps).Note: Applicable only to XIV systems.

CLI orGUI

v “Downloading and installing the PAK file forvCOps” on page 70

v “CLI – Managing integration with vCenterOperations Manager” on page 36

v “GUI – Managing integration with vCenterOperations Manager” on page 68

Table 2. Optional tasks

Optional task Interface Refer to

Configure LDAP-based directory user access tothe Integration Server

CLI v “Configuring directory user access”

Manage the Integration Server users CLI orGUI

v “CLI – Adding and managing Integration Serverusers” on page 25

v “GUI – Managing Integration Server users” onpage 49

Back up or restore an Integration Serverconfiguration, including the data of all existinguser accounts, credentials, storage arrays, andstorage pools.

CLI v “CLI – Backing up or restoring an IntegrationServer configuration” on page 40

Configuring directory user accessYou can allow external directory users to connect to the IBM Storage IntegrationServer and manage it without having a locally-defined user account.

The connection to the directory server is established through Lightweight DirectoryAccess Protocol (LDAP) authentication. When directory server access is enabled,any login attempt (attempt to log in to the Integration Server) is authenticatedagainst both the local database of Integration Server users, and against the defineddirectory server.

Use the isis_ldap CLI command to configure LDAP-based directory user access toIBM Storage Integration Server. Use the required argument after the command, asspecified in the following table.


Note:

v When directory user access is enabled and configured through isis_ldap, thedirectory users can access and manage only the Integration Server. A separateand unrelated authentication system may be used on the storage system side fordirectory-based management of the storage system. For more information, referto “CLI – Adding or removing storage array credentials” on page 26 and to yourstorage system documentation.

v Once the connection is established, all users that are defined on the directoryserver can access and manage the IBM Storage Information Server.

Chapter 3. Integration Server operation and management 19

Table 3. Arguments for isis_ldap

Argument Use after isis_ldap to:

configure -e -a

-s <server URI>

-t <directory server type>

-r <user search DN>

-k <user search key>

-g <user group DN>

-o <user group object class

-n <user group authentication DN>

or

configure --enable --anonymous

--server_uri <server URI>

--server_type <directory server type>

--user_search_dn <user search DN>

--user_search_key <user search key>

--group_search_dn <user group DN>

--group_object_class <user group objectclass>

--authentication_group_dn <user groupauthentication DN>

Enable directory access and establish a connection to a directoryserver as an anonymous user with the following parametersspecified after the -a argument on the command line:

v Server URI (-s; --server_uri) – Uniform resource identifier(URI) of the directory server. This parameter determineswhich directory server should be accessed and used fordirectory user management of the Integration Server.

v Server type (-t; --server_type) – Type of the directory server.One of the following types can be specified:

– Active Directory (active_directory)

– Open LDAP (open_ldap)

– Custom (custom)

v User search DN (-r; --user_search_dn) – Distinguished name(DN) to be used for the user search.

v User search key (-k; --user_search_key) – Search key of thedirectory user. Valid only if the specified server type (-t;--server_type) is 'custom'.

v Group search DN (-g; --group_search_dn) – Distinguishedname (DN) of the user group for search purposes.

v Group object class (-o; --group_object_class) – Object classof the user group. Valid only if the specified server type (-t;--server_type) is 'custom'.

v Authentication group DN (-n; --authentication_group_dn) –Distinguished name (DN) used for the user groupauthentication.

For example:

isis_ldap configure -e -a -s http://domain -t open_ldap-r john1 -g users1 -n groupauth

When prompted to enter a password, press Enter withoutentering any password:

Please enter the BIND_DN password (password not shown):The following changes were applied to the LDAP configuration:ENABLEDPlease restart the IBM Storage Integration Server to applythe new configuration.

After enabling the directory access, you can test the directoryconnection by using the test option (see below). Then, restartthe IBM Storage Integration Server service as explained in“Checking and controlling the Integration Server service” onpage 105.


Table 3. Arguments for isis_ldap (continued)


configure -e -u <Bind DN username>

-p <Bind DN password>

-s <server URI>

-t <directory server type>

-r <user search DN>

-k <user search key>

-g <user group DN>

-o <user group object class>

-n <user group authentication DN>

or

configure --enable

--bind_dn <Bind DN username>

--bind_passowrd <Bind DN password>

--server_uri <server URI>

--server_type <directory server type>

--user_search_dn <user search DN>

--user_search_key <user search key>

--group_search_dn <user group DN>

--group_object_class <user group objectclass>

--authentication_group_dn <user groupauthentication DN>

Enable directory access and establish a connection to a directoryserver by using the Bind DN user account that was predefinedon the directory server (predefined by the directory serveradministrator). For this command, specify the followingparameters on the command line:

v Bind DN username (-u; --bind_dn) – Username of the BindDN user through which access to the directory server isestablished. The IBM Storage Integration Server uses thisusername to log in to the directory server and establish theconnection with it.

v Bind DN password (-p; --bind_password) – Password of theBind DN username.

v Server URI (-s; --server_uri) – Uniform resource identifier(URI) of the directory server. This parameter determineswhich directory server should be accessed and used fordirectory user management of the Integration Server.

v Server type (-t; --server_type) – Type of the directory server.One of the following types can be specified:

– Active Directory (active_directory)

– Open LDAP (open_ldap)

– Custom (custom)

v User search DN (-r; --user_search_dn) – Distinguished name(DN) to be used for the user search.

v User search key (-k; --user_search_key) – Search key of thedirectory user. Valid only if the specified server type (-t;--server_type) is 'custom'.

v Group search DN (-g; --group_search_dn) – Distinguishedname (DN) of the user group for search purposes.

v Group object class (-o; --group_object_class) – Object classof the user group. Valid only if the specified server type (-t;--server_type) is 'custom'.

v Authentication group DN (-n; --authentication_group_dn) –Distinguished name (DN) used for the user groupauthentication.

For example:

isis_ldap configure -e -u john123x -p ********-s http://domain -t active_directory -r john1-g users1 -n groupauth

When prompted to enter a password, enter the directory server'sBind DN user password:

Please enter the BIND_DN password (password not shown): ******The following changes were applied to the LDAP configuration:ENABLEDPlease restart the IBM Storage Integration Server to applythe new configuration.

After enabling the directory access, you can test the directoryconnection by using the test option (see below). Then, restartthe IBM Storage Integration Server service as explained in“Checking and controlling the Integration Server service” onpage 105.


Table 3. Arguments for isis_ldap (continued)


configure -d

or

configure --disable

Disable directory user access.

After disabling the directory access, restart the IBM StorageIntegration Server service as explained in “Checking andcontrolling the Integration Server service” on page 105.

list Display the current directory server configuration status (on theIBM Storage Integration Server) and Bind DN username.

test -u <directory username> -p <password> Test a directory user account by specifying the username andpassword of that account. You can test any user account that isdefined on the directory server (the test is not for the Bind DNuser account, but for an actual directory account).

For example:

isis_ldap test -u john221 -p ********

-h

or --help

Display help information that is relevant to isis_ldap.

You can also display help for the configure, list, or testargument if it is typed on the command line as well.

Adding a directory server certificate

If the directory server uses Transport Layer Security (TLS), you must edit theldap.conf file and specify the trusted certificate directory location and filename onthe IBM Storage Integration Server. Complete the following steps to update theIBM Storage Integration Server:1. Log in to the directory server and issue the following command: certutil

-ca.cert client.crt. This command generates the server certificate.2. Go to the /etc/openldap/ directory and edit the ldap.conf file by setting the

value for the TLS_CACERT parameter. The following example shows the contentsof the ldap.conf file:#LDAP Defaults##BASE dc=example,dc=com#URI ldap://ldap.example.com ldap://ldap-master.example.com:port##SIZELIMIT 12#TIMELIMIT 15#DEREF neverTLS_CACERT /etc/openldap/certs/trusted_ldap.pem

Make sure that the TLS_CACERT parameter has the directory and file name of thenew certificate that you generated. After editing the ldap.conf file, theldap.ini file is automatically updated.

Editing the ldap.ini configuration file

In addition to using the isis_ldap CLI command (see Table 3 on page 20), you canedit the ldap.ini configuration file to manually change the directory user accesssettings.

Attention: Do not edit the ldap.ini file if you are not familiar with directorysetting conventions.


The following example shows the editable parameters and their values specifiedafter the '=' sign:enable_ldap = Trueserver_uri = ldap://servername.domainname:389server_type = OPEN_LDAPuser_search_dn = ou=users,dc=dcname,dc=comuser_search_key =group_search_dn = dc=dcname,dc=comgroup_object_class =authentication_group_dn = cn=authenticating-group,dc=dcname,dc=combind_dn =bind_password = <enctypted password>=bind_pwd_verification = <encrypted key>=

The following table summarizes the parameters and their indication. Refer toTable 3 on page 20 for more detailed information.

Table 4. ldap.ini configuration parameters

Parameter Indication

enable_ldap True or False.

When True and enabled, the login attempt isauthenticated against the directory server.

server_uri Uniform resource identifier (URI) of the directoryserver.

server_type Type of the directory server:

v Active Directory

v Open LDAP

v Custom

user_search_dn Distinguished name (DN) to be used for usersearch.

user_search_key Search tag for obtaining a unique relativedistinguished name (RDN).

Commonly used values: uid, preferredId

group_search_dn Distinguished name (DN) to be used for usergroup search.

group_object_class Type of the user group.

Commonly used values: GroupOfNames,NestedGroupOfNames, GroupOfUniqueNames,NestedGroupOfUniqueNames, ActiveDirectoryGroup,NestedActiveDirectoryGroup

authentication_group_dn Distinguished name (DN) of the authenticationuser group.

bind_dn Username of the Bind DN user through whichaccess to the directory server is established.

bind_password Password of the Bind DN username. Thepassword is displayed in its encrypted form.

bind_pwd_verification Verification string for the Bind DN password. Thestring is displayed in its encrypted form.


Note:

v user_search_key and user_search_dn return unique results. For example:user_search_key=uiduser_search_dn=ou=users,dc=dcname,dc=com

In this case, if the user name is "John", the resulting DN for matching the userover LDAP would be: uid=John,ou=users,dc=dcname,dc=com

v If authentication_group_dn is set, only users that belong to that group areauthenticated. You can remove this parameter from the ldap.ini file to disablegroup authentication.

v When server_type type is Active Directory, the following parameters are usedby default:user search key = sAMAccountNameuser group object class = ActiveDirectoryGroup

v When server_type type is Open LDAP, the following parameters are used bydefault:user search key = uiduser group object class = GroupOfUniqueNames

Managing the Integration Server from the command-line interface (CLI)You can access and control the Integration Server by using its command-lineinterface (CLI) functions locally from the Linux command prompt environment, orfrom a remote terminal connection.

The following sections describe all the CLI configuration and managementfunctions:v “CLI – Switching to 'ISIS' user mode”v “CLI – Adding and managing Integration Server users” on page 25v “CLI – Adding or removing storage array credentials” on page 26v “CLI – Adding or removing storage arrays” on page 28v “CLI – Setting the VASA credentials” on page 30v “CLI – Managing integration with vSphere Web Client” on page 31v “CLI – Managing integration with vCenter Orchestrator” on page 34v “CLI – Managing integration with vCenter Operations Manager” on page 36v “CLI – Backing up or restoring an Integration Server configuration” on page 40

CLI – Switching to 'ISIS' user modeTo start configuring the IBM Storage Integration Server, you must be logged in asthe isis user in the Linux command prompt environment.

About this task

isis is a user account that is automatically created after the installation, allowingyou to carry out the Integration Server CLI-based configuration and managementoperations.


If needed, you can set the password for accessing the isis user account externally(for example, from a remote computer over SSH), as described in the followingprocedure.

Procedure

To set a password for the isis user:1. Log in to the Linux command prompt environment as a root user.2. Enter passwd isis and then enter the password for the user account:

[root]# passwd isisChanging password for user isis.New password: **********Retype new password: **********passwd: all authentication tokens updated successfully.[root]#

What to do next

To switch to the ISIS user, enter the su - isis command:

[root]# su - isis

CLI – Adding and managing Integration Server usersAll user accounts that can be used to access the IBM Storage Integration Servermust be individually defined.

You can either define (add) a single Integration Server user account, or definemultiple user accounts to be used separately.

Use the isis_users CLI command to add, delete, or display user accounts, andalso to change the password of any specific account. Use the required argumentafter the command, as specified in the following table.

Note:

v All CLI command arguments are case-sensitive.v The same operations are available from the GUI as well, as explained in “GUI –

Managing Integration Server users” on page 49.v The isis_users utility cannot define or affect external directory users. For more

information about how to configure directory user access, see “Configuringdirectory user access” on page 18.

Table 5. Arguments for isis_users

Argument Use after isis_users to:

add -n <username> -p <password>

or

add --user_name <username> --user_password<password>

Add the username and password of the user that may accessthe IBM Storage Integration Server. You can add more than oneuser.

For example:

isis_users add -n johnvc -p ********


Table 5. Arguments for isis_users (continued)

Argument Use after isis_users to:

change_password -n <username> -p <newpassword>

or

change_password --user_name <username>--user_password <password>

Change the password of a user account that was alreadyadded. The password that you type for the specified usernameis set as the new password.

For example:

isis_users change_password -n johnvc -p **********

delete -n <username>

or

delete --user_name <username>

Delete a user account from the server.

For example:

isis_users delete -n johnvc

list Display the names of currently defined user accounts.

For example:

isis_users listUser list:john_vczivkal_vclihit_vc

-h

or --help

Display help information that is relevant to isis_users.

You can also display help for the add_user, change_password, ordelete_user argument if it is typed on the command line aswell.

CLI – Adding or removing storage array credentialsThis section explains how to set the credentials that will be used to connect to theIBM storage system, or systems, that your VMware platforms use for storageprovisioning.

Important:

v An identical storage admin user account with identical credentials (the sameusername and password) must already be predefined on all the IBM storagearrays that you intend to use. The IBM Storage Integration Server can use only asingle array management account for accessing all the different storage arraysthat you use. For more information about how to define a storage adminaccount on your IBM storage arrays, refer to the relevant storage systemmanagement tools documentation.

v Setting the storage credentials on the IBM Storage Integration Server allows youto add the IBM storage arrays on the next step.

v If the array management account is defined on a directory server, see “Checkingthe format of directory-based storage array credentials” on page 108.

Use the isis_storage_credentials CLI command to set (add), remove, or displaythe current storage array access credentials that the Integration Server uses in orderto access all the IBM storage arrays. Use the required argument after the command,as specified in the following table.


Note:


Entering the storage array credentials” on page 44.

Table 6. Arguments for isis_storage_credentials

Argument Use after isis_storage_credentials to:

set -u <array username>

-p <array password>

-f

-a <user type>

or

set --user <array username>

--password <array password>

--force

--user_account <user type>

Set the username and password for accessing all the relevant IBMstorage systems, and specify whether the storage admin user islocally-defined on the storage system or on a directory server.

For example, if the storage admin user is locally defined on thestorage system, enter:

isis_storage_credentials set -u john21 -p ******** -a local

And if the storage admin user is defined on a directory server, enter:

isis_storage_credentials set -u john21 -p ******** -a directory

Attention: During regular operation, whenever a directory-basedstorage admin fails to log in (from the Integration Server side) to anystorage array that is in use, the Integration Server immediately locksthe storage admin user account and all storage arrays becomeinaccessible on the Integration Server side. This is to prevent repeatedlogin attempt failures after which the directory server blocks that useraccount. In such a case, use the -f or --force argument on thecommand line to unlock the storage admin account on the IntegrationServer side, with either the same credentials or with updatedcredentials. For example:

isis_storage_credentials set -u john21 -p ******** -f -a directory

The equivalent action in the Integration Server GUI is to update theaccount credentials, as described in “GUI – Entering the storage arraycredentials” on page 44.

If the storage credentials are defined on a directory server, see“Checking the format of directory-based storage array credentials” onpage 108.

remove Delete the existing storage array user account definition from theserver.

For example:

isis_storage_credentials remove

Attention: If you already added storage systems to the server,deleting the user account disconnects all these storage systems.


Table 6. Arguments for isis_storage_credentials (continued)

Argument Use after isis_storage_credentials to:

list Display the username of the existing storage array user accountdefinition.

The following example shows the command output when the storageadmin user account is defined locally on the storage system:

isis_storage_credentials list

Username Array Alias User Category Account Source---------- ---------------- --------------- ----------------admin XIV hostdev31b storageadmin localadmin XIV hostdev32a storageadmin localadmin XIV hostdev31a storageadmin local

The following example shows the command output when the storageadmin user account is defined on a directory server:

isis_storage_credentials list

Username Array Alias User Category Account Source---------- ---------------- --------------- ----------------admin XIV hostdev31b storageadmin directoryadmin XIV hostdev32a storageadmin directoryadmin XIV hostdev31a storageadmin directory

-h

or --help

Display help information that is relevant toisis_storage_credentials.

You can also display help for the set argument if it is typed on thecommand line as well.

CLI – Adding or removing storage arraysAll IBM storage systems that provide storage resources to your VMware platformsmust be defined as storage arrays on the IBM Storage Integration Server.

Use the isis_storage_array CLI command to add, remove, or list these IBMstorage systems (referred to as storage arrays). Use the required argument after thecommand, as specified in the following table.

Important:

v IBM storage arrays can be added only after the storage credentials are set, asexplained in “CLI – Adding or removing storage array credentials” on page 26.

v If you want to remove existing storage arrays:– A removed storage array, along with its storage pools and volumes, can no

longer be managed by the included solution components (see “Included cloudinterfaces” on page 1).

– If the removed storage array contains working storage pools and volumes, theinformation of these storage pools and volumes is no longer displayed invSphere Web Client. However, vSphere data access and service level forthese storage pools and volumes is not affected. In addition, the removedarray and its storage pools and volumes can be managed from the standardIBM storage system management tools.

– After the removal, you can add the storage array back again to fully restoreits management.


Note:


Managing storage arrays” on page 43.

Table 7. Arguments for isis_storage_array

Argument Use after isis_storage_array to:

add -i <management IP address> -t <array type>

or

add --mgmt_ip <management IP address> --type<array type>

Add a storage array (IBM storage system) specified by an IPaddress or DNS, and the type of the array.

For the -t (array type) argument, specify xiv for XIV, svc forSAN Volume Controller, Storwize, and Flex System, or ds8k forDS8000.

For example:

isis_storage_array add -i 10.100.155.200 -t xiv

Optional: you can define an alias name for the added XIVsystem, by adding -a <alias name> or --alias <alias name> tothe command.

For example:

isis_storage_array add -i 10.100.155.200 -t xiv -a mystorage1

Note: If you choose not to define an alias, the alias name thatis already defined (if one was defined) on the IBM storagesystem side is automatically assigned as the alias name.

remove -a <system alias name>

or

remove --alias <system alias name>

Remove a storage array specified by its alias name (alias thatwas given by you or was automatically assigned).

For example:

isis_storage_array remove -a mystorage1

list List the names and details of all the IBM storage arrays that arecurrently added (and were not removed). The displayedinformation includes:

v Array alias

v Array identifier

v Management IP address

v Elapsed time since last update

v Connected

v Notes

See the example after this table.

-h

or --help

Display help information that is relevant toisis_storage_array.

You can also display help for the add or remove argument if it istyped on the command line as well.


The following example shows the displayed information and format of theisis_storage_array list command output.

isis_storage_array list

Array Array Management Elapsed timeAlias Identifier IP Addresses since last update Connected Notes---------- ---------------- ------------- ------------------ ---------- ---------------------------------array1000 2810-114-MN65026 9.100.150.155 16 minutes False Failed to log in to array 2810

with the provided credentials.

array2000 2810-114-MN65027 9.200.155.155 27 minutes True

CLI – Setting the VASA credentialsThe VASA credentials comprise a user name and a password that VMware vCenterservers can use to connect to the IBM Storage Integration Server and employVMware vSphere APIs for Storage Awareness (VASA) functions.

Use the vasa_admin CLI command to set or display the VASA credentials. vCenterservers can then use these credentials to connect to the Integration Server andutilize VASA functions, as explained in “Registering the Integration Server as astorage provider in vCenter Server” on page 73. Use the required argument afterthe command, as specified in the following table.

Note:

v Only one set of a username and a password can be used for the VASAcredentials, which applies to all vCenter servers that require VASA functions.


Setting the VASA credentials” on page 55.

Table 8. Arguments for vasa_admin

Argument Use after vasa_admin to:

set_secret -n <username> -p <password>

or

set_secret --user_name <username>--user_password <password>

Set the username and password that the VASA credentialsshould comprise.

For example:

vasa_admin set_secret -n johnvasa -p ********The secret key for the VASA Provider has been setsuccessfully.

list_secret Display the username of the currently defined VASAcredentials.

For example:

vasa_admin list_secretSecret key username for the VASA Provider:johnvasa

-h

or --help

Display help information that is relevant to vasa_admin.

You can also display help for the set_secret argument if it istyped on the command line as well.


CLI – Managing integration with vSphere Web ClientBefore you can use the IBM Storage Enhancements for VMware vSphere WebClient on the web client side, you must define on the IBM Storage IntegrationServer side the vCenter servers for which you want to provide storage resources.Then, you can the attach storage pools that you want to make available to eachvCenter server.

The storage pools that you attach on the Integration Server side become visible onvSphere Web Client, and can be used for volume creation by using the IBMStorage Enhancements for vSphere Web Client (for more information, seeChapter 5, “Using the IBM Storage Enhancements for VMware vSphere WebClient,” on page 77).

Use the vwc_vcenter CLI command to add, modify, remove, or list vCenter servers,and use the vwc_pool command to attach or detach storage pools that werepredefined on the IBM storage systems. The vwc_host command is required forESXi host definition on DS8000 arrays.

Use the required argument after each command, as specified in the followingtables.

Important:

v Storage pools can be attached to vCenter servers only after the relevant storagearrays have been added, as explained in “CLI – Adding or removing storagearrays” on page 28.

v If you want to detach storage pools or remove vCenter servers:– A detached storage pool, along with its volumes, can no longer be managed

on vSphere Web Client.– If the detached storage pool contains working volumes, the information of

these volumes is no longer displayed in vSphere Web Client. However,vSphere data access and service level for these volumes is not affected. Inaddition, the removed storage pool (and its volumes) can still be managedfrom the standard IBM storage system management tools.

– After the detachment, you can reattach the storage pool to fully restore itsmanagement through vSphere Web Client.

– A removed vCenter server can no longer be managed through the IntegrationServer, but it continues to be managed from the vSphere environment. Youcan add it back to restore management through the Integration Server.

Note:

v All CLI command arguments are case-sensitive.v Apart from DS8000 host definition (see Table 11 on page 33), the same operations

are available from the GUI as well, as explained in “GUI – Managing integrationwith vSphere Web Client” on page 56.


Table 9. Arguments for vwc_vcenter

Argument Use after vwc_vcenter to:

add -i <IP or hostname> -u <username> -p<password>

or

add --host_name <hostname> --user_name<username> --user_password <password>

Add a vCenter server connection by specifying the followingparameters on the command line:

v Hostname or IP address of the vCenter server.

v Username for accessing the vCenter server.

v Password for accessing the vCenter server.

For example:

vwc_vcenter add -i myvcenter -u john1 -p ********

Note: After a vCenter connection is added, you can attachstorage pools to that vCenter server using the vwc_poolcommand (see Table 10 on page 33).

modify -i <IP or hostname> -u <username> -p<password> -g <vCenter GUID>

or

modify --host_name <IP or hostname>--user_name <username> --user_password<password> --guid <vCenter GUID>

Modify the credentials (username and password) of a vCenterserver connection by specifying the following parameters onthe command line:

v Hostname or IP address of the vCenter server that wasalready defined.

v Updated username for accessing the vCenter server.

v Updated password for accessing the vCenter server.

v GUID of the vCenter server. You can use the list commandargument (see below) to obtain the GUID.

For example:

vwc_vcenter modify -i myvcenter -u john1 -p ********-g 11EC2020

list List all vCenter server connections and GUID of each vCenterserver.

For example:

vwc_vcenter list

vCenter host vCenter user vCenter GUID Last updated------------------------------------------------------------10.200.250.11 john11 11EC2020 01-OCT-2013

remove -g <vCenter GUID>

or

remove --guid <vCenter GUID>

Remove a vCenter server connection by specifying its GUID.

For example:

vwc_vcenter remove -g 11EC2020

-h

or --help

Display help information that is relevant to vwc_vcenter.

You can also display help for the add, modify, or removeargument if it is typed on the command line as well.


Table 10. Arguments for vwc_pool

Argument Use after vwc_pool to:

attach -g <vCenter GUID> -a <array alias> -n<storage pool name>

or

attach --guid <vCenter GUID> --array_alias<array alias> --pool_name <storage pool name>

Attach a storage pool to a vCenter server by specifying thefollowing parameters on the command line:

v GUID of the vCenter server. You can use the vwc_vcenterlist command (see Table 9 on page 32) to obtain the GUID.

v Alias name of the storage array on which the storage poolresides.

v Name of the storage pool to be attached.

For example:

vwc_pool attach -g 11EC2020 -a myarray -n mypool

detach -g <vCenter GUID> -a <array alias> -n<storage pool name>

or

detach --guid <vCenter GUID> --array_alias<array alias> --pool_name <storage pool name>

Detach a storage pool from a vCenter server by specifying thefollowing parameters on the command line:


v Alias name of the storage array on which the storage poolresides.

v Name of the storage pool to be detached.

For example:

vwc_pool detach -g 11EC2020 -a myarray -n mypool

list -g <vCenter GUID>

or

list --guid <vCenter GUID>

List the storage pools that are attached to a vCenter server, byspecifying the vCenter GUID.

For example:

vwc_pool list -g 11EC2020

-h

or --help

Display help information that is relevant to vwc_pool.

You can also display help for the attach or detach argument ifit is typed on the command line as well.

Table 11. Arguments for vwc_host

Argument Use after vwc_host to:

list -g <vCenter GUID> -e <ESXi host name>

or

list --guid <vCenter GUID> --esx_host <ESXihost name>

List all known ESXi host ports and their storage host names byspecifying the following parameters on the command line:


v Name of the ESXi host.

For example:

vwc_host list -g 11EC2020 -e myvmhost


Table 11. Arguments for vwc_host (continued)

Argument Use after vwc_host to:

define -a <DS8000 array alias> -n <storagehost name> -e <ESX host name> -pt <port type>

or

define --array_alias <DS8000 array alias>--storage_host_name <storage host name>--esx_host <ESXi host name> --port_type <porttype>

Define an ESXi host on a DS8000 storage array (not applicableto other storage arrays) by specifying the following parameterson the command line:

v Alias name of the DS8000 storage array.

v Name of the ESXi host to be defined on the DS8000 side.

v Name of the ESX host.

v Connectivity type between the ESXi host and the DS8000array: fc for Fibre Channel (FC) or iscsi for iSCSI. If notspecified, the default is FC.

For example:

vwc_host define -a myds8k -n hostname -e myhost -pt iscsi

-h

or --help

Display help information that is relevant to vwc_host.

You can also display help for the define argument if it is typedon the command line as well.

CLI – Managing integration with vCenter OrchestratorBefore you can use the IBM Storage Plug-in for VMware vCenter Orchestrator onthe vCenter Orchestrator (vCO) server side, you must attach the storage pools thatyou want to make available for vCenter Orchestrator.

The storage pools that you attach on the IBM Storage Integration Server can beused for issuing volume workflows through vCenter Orchestrator (for moreinformation, see Chapter 6, “Using the IBM Storage Plug-in for VMware vCenterOrchestrator,” on page 97). Use the vco_pool CLI command to attach or detachstorage pools, or to list the currently attached storage pools.

You can use the vco_token command to obtain or regenerate the unique token keythat enables authentication between the IBM Storage Integration Server and thevCenter Orchestrator server.



Important:

v Storage pools can be attached to the vCO server only after the relevant storagearrays have been added to the IBM Storage Integration Server, as explained in“CLI – Adding or removing storage arrays” on page 28.

v If the IBM Storage plug-in package was not deployed on the vCO server, theattachment of storage pools has no operational effect, even if the storage poolsare listed as attached. For information about how to deploy the IBM Storageplug-in, see “Downloading and installing the plug-in package for vCO” on page66.

v If you want to detach storage pools:– A detached storage pool can no longer be used for issuing workflows on

vCenter Orchestrator.– If the detached storage pool already contains working volumes, these

volumes can no longer be controlled by the vCenter Orchestrator workflows.However, data access and service level for these volumes is not affected. Inaddition, the removed storage pool (and its volumes) can still be managedfrom the standard IBM storage system management tools.

– After the detachment, you can reattach the storage pool to fully restore itsmanagement through vCenter Orchestrator.

Note:


Managing integration with vCenter Orchestrator” on page 64.

Table 12. Arguments for vco_pool

Argument Use after vco_pool to:

attach -a <array alias> -n <storagepool name>

or

attach --array_alias <array alias>--name <storage pool name>

Attach a storage pool to the vCO server by specifying the followingparameters on the command line:

v Alias name of the storage array on which the storage pool resides.

v Name of the storage pool to attach.

For example:

vco_pool attach -a myarray -n pool123

detach

or

detach --array_alias <array alias>--name <storage pool name>

Detach a storage pool to the vCO server by specifying the followingparameters on the command line:

v Alias name of the storage array on which the storage pool resides.

v Name of the storage pool to detach.

For example:

vco_pool detach -a myarray -n pool123


Table 12. Arguments for vco_pool (continued)

Argument Use after vco_pool to:

list List all the storage pools that are currently attached to the vCO server.

For example:

vco_pool listStorage pools attached to the vCO server:Array:XIV myarray1, pool:pool123Array:XIV myarray1, pool:pool456Array:XIV myarray2, pool:backpool_1

-h

or --help

Display help information that is relevant to vco_pool .

You can also display help for the attach, detach, or list argument if itis typed on the command line as well.

Table 13. Arguments for vco_token

Argument Use after vco_token to:

regenerate Regenerate a new token to be used by the defined vCO server.

For example:

vco_token regenerateA new token has been generated successfully.Token: 8a2e355ae999988888bcee2222ffe7bb95bd1111

Note: If you regenerate the token key, it must be updated on thevCenter Orchestrator side. For more information, see “Downloadingand installing the plug-in package for vCO” on page 66.

get Obtain and display the current token used by the defined vCO server.

For example:

vco_token getToken: 9999ef9999fb6c6b888888f45f3f11b87fc6ecdc

-h

or --help

Display help information that is relevant to vco_token.

CLI – Managing integration with vCenter Operations ManagerBefore you can use the IBM Storage Management Pack for VMware vCenterOperations Manager, you must set a connection to at least one vCenter OperationsManager (vCOps) server, and then define which storage arrays should bemonitored in vCOps.

After a vCOps server connection is defined and storage arrays are associated withthe vCOps server, detailed monitoring information for these storage arraysbecomes available in vCOps (for more information, see Chapter 7, “Using the IBMStorage Management Pack for VMware vCenter Operations Manager,” on page101).

Use the vcops_server CLI command to add, remove, or disable connections tovCOps servers, or to list the current server connections. An HTTP POST adapter isautomatically created for each vCOps server that you add.


Use the vcops_adapter command to attach storage arrays to any created HTTPPOST adapter. A storage array that is attached to an HTTP POST adapter can bemonitored by the vCOps server for which the HTTP POST adapter was created.You can use the vcops_adapter command for additional options as describedbelow.


Important:

v Storage arrays can be attached to HTTP POST adapters only after the storagearrays have been added to the IBM Storage Integration Server, as explained in“CLI – Adding or removing storage arrays” on page 28.

v If the IBM Storage PAK file was not deployed on the vCOps server, IBM Storagemonitoring information is not displayed with dedicated dashboards, graphicicons, and user-friendly attribute names in vCOps. For information about how todeploy the IBM Storage PAK file, see “Downloading and installing the PAK filefor vCOps” on page 70.

v If you want to detach storage arrays:– A detached storage array can no longer be monitored through vCenter

Operations Manager.– After the detachment, you can reattach the storage array to fully restore its

monitoring through vCenter Operations Manager.

Note:

v All CLI command arguments are case-sensitive.v Apart from the ability to add more than one vCOps server and additional HTTP

POST adapters from the CLI, the same operations are available from the GUI aswell, as explained in “GUI – Managing integration with vCenter OperationsManager” on page 68.

Table 14. Arguments for vcops_server

Argument Use after vcops_server to:

add -n <hostname> -u <username> -p <password>

or

add --hostname <hostname> --username<username> --password <password>

Add a vCOps server connection by specifying the followingparameters on the command line:

v IP address or hostname of the vCOps server that you wantto add (connect to).

v Username for accessing the vCOps server.

v Password for accessing the vCOps server.

For example:

vcops_server add -n vcops1.domain -u john1 -p ********

Note: The local HTTP POST adapter is added automaticallyafter the vCOps server is added.


Table 14. Arguments for vcops_server (continued)

Argument Use after vcops_server to:

remove -n <hostname>

or

remove --hostname <hostname>

Remove a vCOps server connection by specifying its IP addressor hostname on the command line.

For example:

vcops_server remove -n vcops1.domain

Note: A removed vCOps server ceases to receive monitoringinformation regarding IBM storage resources that are in use.You can add a vCOps server back by using the add option (seeabove).

disable -n <hostname>

or

disable --hostname <hostname>

Disable reporting to a vCOps server (without removing itsconnection) by specifying its IP address or hostname on thecommand line.

For example:

vcops_server disable -n vcops1.domain

Note: A vCOps server for which reporting is disabled ceases toreceive monitoring information regarding IBM storageresources that are in use. You can resume reporting to a vCOpsserver by using the enable option (see below).

enable -n <hostname>

or

enable --hostname <hostname>

Resume reporting to a vCOps server by specifying its IPaddress or hostname on the command line.

For example:

vcops_server enable -n vcops1.domain

list List all the currently connected (added) vCOps servers andtheir operation status (enabled or disabled).

For example:

vcops_server list

vCOps Hostname Status--------------- -------vcops1.domain Enabledvcops2.domain Disabled

-h

or --help

Display help information that is relevant to vcops_server .

You can also display help for the add, remove, enable, ordisable argument if it is typed on the command line as well.


Table 15. Arguments for vcops_adapter

Argument Use after vcops_adapter to:

array_attach -a <alias> -n <hostname>

or

array_attach --alias <alias> --hostname<hostname>

Attach a storage array to a vCOps HTTP POST adapter (of a vCOpsserver) by specifying the following parameters on the command line:

v Alias name of the storage array that you want to attach.

v IP address or hostname of the storage array that you want to attach.

For example:

vcops_adapter array_attach -a myXIV -n 9.150.200.100

Note: The storage array must already be added to the IBM StorageIntegration Server, as explained in “CLI – Adding or removing storagearrays” on page 28.

array_detach -a <alias> -n <hostname>

or

array_detach --alias <alias> --hostname<hostname>

Detach a storage array from a vCOps HTTP POST adapter (of a vCOpsserver) by specifying the following parameters on the command line:

v Alias name of the storage array that you want to detach.

v IP address or hostname of the storage array that you want to detach.

For example:

vcops_adapter array_detach -a myXIV -n 9.150.200.100

add -s <server> -n <hostname>

or

add --server <server> --hostname<hostname>

Add an HTTP POST adapter for a vCOps server by specifying thefollowing parameters on the command line:

v IP address or hostname of a currently added (connected) vCOpsserver.

v IP address or hostname of the HTTP POST adapter that you want toadd.

For example:

vcops_adapter add -s vcops1.domain -n adapter2.domain

remove -n <hostname>

or

remove --hostname <hostname>

Remove an HTTP POST adapter by specifying its IP address orhostname on the command line.

For example:

vcops_adapter remove -n adapter2.domain

report_thresholds -n <hostname>

or

report_thresholds --hostname <hostname>

Report the thresholds to a vCOps server by specifying its IP address orhostname on the command line.

For example:

vcops_adapter report_thresholds -n vcops1.domain

report_thresholds -a

or

report_thresholds -all

Report the thresholds to all vCOps servers that are currently added(connected).

vcops_adapter report_thresholds -a


Table 15. Arguments for vcops_adapter (continued)

Argument Use after vcops_adapter to:

list List all the currently defined HTTP POST adapters and display theirassociated vCOps server, alias name of attached storage arrays, lastreport time (report to the vCOps server), and indication regardingwhether the adapter is remote or locally defined.

For example:

vcops_adapter list

vCOps Hostname HTTP POST Hostname Remote Last Reported Array alias-------------- ------------------ ------ ------------- -----------vcops1.domain adapter1.domain No 5 minutes ago myXIVvcops2.domain adapter2.domain Yes 8 minutes ago myXIV

-h

or --help

Display help information that is relevant to vcops_adapter.

You can also display help for the array_attach, array_detach, add,remove, or report_thresholds argument if it is typed on the commandline as well.

CLI – Backing up or restoring an Integration Serverconfiguration

At any point, you can back up the current IBM Storage Integration Serverconfiguration and save it to a file, or load a previously saved configuration torestore a configuration.

The configuration includes storage credentials, storage arrays, vCenter credentials,and storage pools attachment.

Use the isis_configuration CLI command to save the existing configuration, orload a saved configuration to replace the existing one. Use the required argumentafter the command, as specified in the following table.

Note:

v All CLI command arguments are case-sensitive.v The backup and restore operations are not available on the Integration Server

GUI.

Attention:

v Before using the restore option, the IBM VASA Provider service must bestopped as explained in “Checking and controlling the Integration Serverservice” on page 105. Start the service again after the configuration has beenloaded.

v restore should be used only with a freshly installed IBM Storage IntegrationServer that has not yet been configured.


Table 16. Arguments for isis_configuration

Argument Use after isis_configuration to:

backup -f <file name> -k <32characters>

or

backup --file <file name> --key <32characters>

Save the current IBM Storage Provider configuration to thespecified file using an AES-256 encryption key that comprises32 characters.

For example:

isis_configuration backup -f confbackup -k abcdefghijklmnop

Important: You will need to provide this key in any restoreoperation (see below).

restore -f <file name> -k <32 characters>

or

restore --file <file name> --key <32characters>

Load a configuration from a specified file by providing the filename and the encryption key that was used in the creation ofthe file.

Attention: See the notes above this table.

For example:

isis_configuration restore -f confgbackup -k abcdefghijklmnop

restore -f ./vasa115exported.db Restore an existing Integration Server configuration that wasmade with IBM Storage Provider for VMware VASA version1.1.5 (applicable only to XIV systems).

For this restore operation, you do not need to provide anencryption key:

isis_configuration restore -f ./vasa115exported.db

Attention: The storage capability definitions made in version1.1.5 cannot be imported because storage capabilities areautomatically created and assigned on the Integration Server.

-h

or --help

Display help information that is relevant toisis_configuration.

You can also display help for the backup or restore argument ifit is typed on the command line as well.


Managing the Integration Server from the graphical user interface(GUI)

You can log in to the Integration Server through a web browser and use theconfiguration and management options that are available from the web-basedgraphical user interface (GUI).

The following sections describe all the GUI configuration and managementfunctions:v “GUI – Logging in”v “GUI – Managing storage arrays” on page 43v “GUI – Managing Integration Server users” on page 49v “GUI – Managing and monitoring VASA access” on page 53v “GUI – Managing integration with vSphere Web Client” on page 56v “GUI – Managing integration with vCenter Orchestrator” on page 64v “GUI – Managing integration with vCenter Operations Manager” on page 68

GUI – Logging inTo log in to the Integration Server from a browser, you need to enter the webaddress (URL) of the Linux host upon which the IBM Storage Integration Server isinstalled.

The secure IP connection to the Integration Server is established through portnumber 8443. Accordingly, the web address should be entered in the web browseraddress bar in the following format:

https://[Integration Server IP address]:8443

If your web browser displays a connection security message after entering the webaddress, see “Replacing the SSL certificate and key files” on page 11.

The IBM Storage Integration Server login page is loaded and you can log in byentering your Integration Server username and password.


Attention:

v After the instillation, the initial username is admin and the initial password isadminadmin. To avoid unauthorized access to the Integration Server, it is stronglyrecommended to change this password as soon as possible, or create a new useraccount and then delete the admin account (see “GUI – Managing IntegrationServer users” on page 49).

v If the Integration Server service is stopped on the Linux host (see “Checking andcontrolling the Integration Server service” on page 105), it is not possible to login or perform any GUI operation.

GUI – Managing storage arraysAll IBM storage systems that provide storage resources to your VMware platformsmust be defined as storage arrays on the IBM Storage Integration Server.

To access the storage array management options, click Arrays on the left GUIpanel. You can then view, add, and manage the storage arrays as explained in thefollowing sections.

Figure 8. IBM Storage Integration Server login box in a standard web browser


Note: The same operations are available from the CLI as well, as explained “CLI –Adding or removing storage array credentials” on page 26 and in “CLI – Addingor removing storage arrays” on page 28.

v “GUI – Entering the storage array credentials”v “GUI – Adding a storage array” on page 46v “GUI – Modifying the IP address or hostname of a storage array” on page 47v “GUI – Removing a storage array” on page 48

GUI – Entering the storage array credentialsThe storage array credentials are used to connect to the IBM storage system orsystems, which your VMware platforms use for storage provisioning.

About this task

From the Integration Server GUI you can set or change the current storage arrayaccess credentials that are used for accessing all the IBM storage arrays.

Figure 9. Arrays option on the left GUI panel


Important:

v An identical storage admin user account with identical credentials (the sameusername and password) must already be predefined on all the IBM storagearrays that you intend to use. The IBM Storage Integration Server can use only asingle array management account for accessing all the different storage arraysthat you use. For more information about how to define a storage adminaccount on your IBM storage arrays, refer to the relevant storage systemmanagement tools documentation.

v Setting the storage credentials on the IBM Storage Integration Server allows youto add the IBM storage arrays on the next step.

v If the array management account is defined on a directory server, see “Checkingthe format of directory-based storage array credentials” on page 108.

Note: The same operations are available from the CLI as well, as explained in“CLI – Adding or removing storage array credentials” on page 26.

Procedure1. Click Arrays on the left GUI panel. The Storage Arrays table is displayed, and

the currently defined storage array username is displayed in the storagecredentials configuration box .

2. Enter the username and password of the storage admin user that was definedon all your IBM storage arrays.

3. If the storage admin user account is defined on a directory server, select theThis is a directory account check box. Otherwise, if the storage admin useraccount is locally-defined on the storage system, clear the check box.

4. Click Set.

Figure 10. Current® storage array username (for all storage arrays)


What to do next

You can now start adding storage arrays. The IBM Storage Integration Server willuse the credentials that you have set in order to connect to the storage arrays thatyou add.

Attention: During regular operation, whenever a directory-based storage adminfails to log in (from the Integration Server side) to any storage array that is in use,the Integration Server immediately locks the storage admin user account and allstorage arrays become inaccessible on the Integration Server side. This is toprevent repeated login attempt failures after which the directory server blocks thatuser account. In such a case, set the storage array credentials again to unlock thestorage admin account on the Integration Server side, with either the samecredentials or with updated credentials. The equivalent action in the IntegrationServer CLI is to use the force credentials options, as described in “CLI – Adding orremoving storage array credentials” on page 26.

GUI – Adding a storage arrayAfter the storage array credentials are set, you can start adding storage arrays tothe Integration Server.

About this task

The storage arrays that you add can be used by the solution components that areincluded in the IBM Storage Integration Server package (see “Included cloudinterfaces” on page 1). You can add each individual storage array separately, asdescribed in the following procedure.

Procedure1. Click Arrays on the left GUI panel. The Storage Arrays table is displayed and

lists the currently added storage arrays.2. Click Add.

3. Click the storage array type (XIV, Storwize Family, or DS8000) and then enterits management IP address or hostname.

Figure 11. Add Storage Array page


4. Click Add. If the credentials are correct (as previously defined; see “GUI –Entering the storage array credentials” on page 44) and the IP connection isestablished, the storage array is added to the Storage Arrays table.

You can click the row of a storage array to view its details on the Storage ArrayDetails pane.

Note: If the connection between the storage array and the Integration Server islost, a Note is also displayed under Storage Array Details to notify you about theconnection loss.

GUI – Modifying the IP address or hostname of a storage arrayAt any time, you can modify the IP address or hostname of an added storagearray.

About this task

If the management IP address or hostname of a storage array changes, you canupdate this change on the Integration Server without having to remove or re-addthe storage array.

Figure 12. List of added storage arrays

Figure 13. Storage array details



lists the currently added storage arrays.2. Click the row of the storage array that you want to update, and then click Edit.

The Modify Array Address page is displayed.

3. Enter the new management IP address or hostname of the storage array, andthen click Modify.

GUI – Removing a storage arrayIf a storage array is no longer needed, you can remove and disconnect it from theIntegration Server.

About this taskv A removed storage array, along with its storage pools and volumes, can no

longer be managed by the included solution components (see “Included cloudinterfaces” on page 1).

v If the removed storage array contains working storage pools and volumes, theinformation of these storage pools and volumes is no longer displayed invSphere Web Client. However, vSphere data access and service level for thesestorage pools and volumes is not affected. In addition, the removed array andits storage pools and volumes can be managed from the standard IBM storagesystem management tools.

v After the removal, you can add the storage array back again to fully restore itsmanagement.

Figure 14. Storage Arrays – Edit button

Figure 15. Modify Array Address page



lists the currently added storage arrays.2. Click the row of the storage array that you want to remove, and then click

Remove.A confirmation message appears.

3. Click Yes to remove the array, or No to cancel the operation.

GUI – Managing Integration Server usersAt any time, you can add new Integration Server user accounts, change useraccount passwords, or delete existing user accounts.

To access the storage array management options, click Users on the left GUI panel.You can then view, add, and manage the Integration Server users as explained inthe following sections.

Figure 16. Storage Arrays – Remove button

Figure 17. Remove Storage Array confirmation message


Note: The same operations are available from the CLI as well, as explained in“CLI – Adding and managing Integration Server users” on page 25.

v “GUI – Adding an Integration Server user”v “GUI – Changing the password of an Integration Server user” on page 51v “GUI – Deleting an Integration Server user” on page 52

GUI – Adding an Integration Server userYou can add a user account for any authorized user that requires access to the IBMStorage Integration Server.

About this task

Each added user is able to individually log into the IBM Storage Integration Serverand perform GUI or CLI management actions.

Note: All Integration Server users have the same permission level on theIntegration Server, and can undo any setting or action made by another user.

Procedure1. Click Users on the left GUI panel. The Integration Server Users table is

displayed and lists the currently added users.2. Click Add. The Add User page is displayed.

Figure 18. Users option on the left GUI panel


3. Enter the username and password for the account that you want to create, andthen click Add. The username of the created account is added to the Userstable.

GUI – Changing the password of an Integration Server userAt any time, you can change the password of an Integration Server user account.

About this task

You can modify a user account only by changing its password. Periodic passwordchange is recommended on a regular basis.

Note: Integration Server user names cannot be changed. Instead, you can delete auser account (see “GUI – Deleting an Integration Server user” on page 52) andthen create a new one (see “GUI – Adding an Integration Server user” on page 50).

Figure 19. Add User page

Figure 20. List of added Integration Server users (user names)



displayed and lists the currently added users.2. Click the row of the storage array that you want to update, and then click Edit.

The Update User page is displayed.

3. Enter the current password of the user account, and then the new password asrequired. Then, click Update.

GUI – Deleting an Integration Server userWhen necessary, you can delete any Integration Server user account.

About this task

After you delete an Integration Server user account from the GUI, the specific usercan no longer log in to the integration server from either the GUI or the CLI.Although the user deletion is a non-reversible operation, you can redefine the sameusername as explained in “GUI – Adding an Integration Server user” on page 50.

Figure 21. Integration Server Users – Edit button

Figure 22. Update User page


Note: Deleting an Integration Server user does not affect the storage credentials orVASA Secret credentials, which both remain defined.


displayed and lists the currently added users.2. Click the row of the user account that you want to delete, and then click

Remove.

A confirmation message appears.3. Click Yes to delete the user, or No to cancel the operation.

GUI – Managing and monitoring VASA accessYou can control and monitor the utilization of the IBM Storage Provider forVMware VASA, which is part of the IBM Storage Integration Server solution.

Note: This functionality is not applicable to DS8000 systems, which are notsupported by the IBM Storage Provider for VMware VASA.

To access the VASA management options, click VASA on the left GUI panel. Youcan then display a list (read-only) of all vCenter servers that are currentlyregistered and are utilizing VASA functions.

Figure 23. Integration Server Users – Remove button


If you want to disconnect a vCenter server, click and highlight the row of thevCenter server that you want to disconnect, and then click Remove Certificate

Before any vCenter server can be registered and start utilizing the IBM StorageProvider, you must first set the VASA credentials, as explained in the followingsection.

Figure 24. VASA option on the left GUI panel

Figure 25. Registered VASA servers (vCenter servers that employ VASA services)


GUI – Setting the VASA credentialsThe VASA credentials comprise a username and a password that is set separatelyfrom the Integration Server user accounts, and separately from the storage arraycredentials.

About this task

VMware vCenter servers can use the VASA credentials to connect to the IBMStorage Integration Server and utilize VASA functions, as explained in “Registeringthe Integration Server as a storage provider in vCenter Server” on page 73.

From the Integration Server GUI you can set, change, or display these VASAcredentials at any time.

Note:

v Only one set of a username and a password can be used for the VASAcredentials, which applies to all vCenter servers that require VASA functions andconnect to the IBM Storage Integration Server.

v The same operations are available from the CLI as well, as explained in “CLI –Setting the VASA credentials” on page 30.

Procedure1. Click VASA on the left GUI panel. The Registered VASA Servers table is

displayed, and the currently defined VASA username is displayed in the VASAcredentials configuration box.

2. Enter the required username and password of the VASA Secret that you wantto set, and then click Set.

Figure 26. Current VASA Secret username


GUI – Managing integration with vSphere Web ClientBefore you can use the IBM Storage Enhancements for VMware vSphere WebClient on the web client side, you need to define on the IBM Storage IntegrationServer side the vCenter servers for which you want to provide storage resources.Then, you can attach storage pools that you want to make available to eachvCenter server.

The storage pools that you attach on the Integration Server side become visible onvSphere Web Client, and can be used for volume creation by using the IBMStorage Enhancements for vSphere Web Client (for more information, seeChapter 5, “Using the IBM Storage Enhancements for VMware vSphere WebClient,” on page 77).

To access these options, click VWC on the left GUI panel. You can then manageservers and storage pools as explained in the following sections.

Note: The same operations can be performed from the CLI as well, as explained in“CLI – Managing integration with vSphere Web Client” on page 31.

v “GUI – Adding a vCenter server” on page 57v “GUI – Updating the credentials of a vCenter server” on page 58v “GUI – Removing a vCenter server” on page 59v “GUI – Attaching storage pools to a vCenter server” on page 60v “GUI – Detaching storage pools from a vCenter server” on page 63

Figure 27. VWC option on the left GUI panel


GUI – Adding a vCenter serverAdd the VMware vCenter servers for which you want to provide storage resourcesthrough the IBM Storage Integration Server.

About this task

You need to connect to and add the vCenter servers for which you can later attachstorage pools that would be visible and accessible on the vSphere Web Client side.You can add a single vCenter server at a time, as described in the followingprocedure.

Note: For any vCenter server that you add, the IBM Storage Enhancements forVMware vSphere Web Client (see Chapter 5, “Using the IBM StorageEnhancements for VMware vSphere Web Client,” on page 77) are automaticallydeployed and enabled on the vSphere Web Client Server side.

Procedure1. Click VWC on the left GUI panel. The vCenter Servers table is displayed and

lists the currently added vCenter servers.2. Click Add. The Add vCenter Server page is displayed.

3. Enter the IP address or hostname of the vCenter server, as well as theusername and password for logging into that vCenter server. Then, click Add.If the provided IP address and credentials are accepted by the vCenter server, itis added to the list of vCenter servers.

Figure 28. Add vCenter Server page


GUI – Updating the credentials of a vCenter serverAt any time, you can update the credentials that are used by the Integration Serverto access a vCenter server.

About this task

Whenever the credentials on the vCenter server side change, you can update thesecredentials on the Integration Server side to allow continued management ofstorage resources on the vSphere Web Client side.


lists the currently added vCenter servers.2. Click the row of the vCenter server for which you want to update the

credentials, and then click Edit. The update vCenter Server Credentials page isdisplayed.

Figure 29. List of vCenter servers


3. Enter the new username and password for accessing the vCenter server. Then,click Update.

GUI – Removing a vCenter serverWhen a vCenter server is no longer needed, you can disconnect it from theIntegration Server by removing it from the list of vCenter servers.

About this taskv A removed vCenter server, along with the storage pools attached to it, can no

longer be managed by the IBM Storage Enhancements for VMware vSphere WebClient. Following the removal, the IBM Storage Enhancements become disabledfor that vCenter on the vSphere Web Client Server side.

v If the removed vCenter server is attached to working storage pools, theinformation of these storage pools, as well as the volumes on these pools is nolonger displayed in vSphere Web Client. However, vSphere data access andservice level for these storage pools and volumes is not affected.

v After the removal, you can add the vCenter server again to fully restore itsmanagement.


lists the currently added vCenter servers.2. Click the row of the vCenter server that you want to remove, and then click

Remove.

Figure 30. Update vCenter Server Credentials page


A confirmation message is displayed.

3. Click Remove to remove the vCenter server, or Cancel to cancel the operation.

GUI – Attaching storage pools to a vCenter serverYou must attach to the vCenter server any predefined storage pool (predefined bythe storage administrator) that you want to use for volume managementoperations on the vSphere Web Client side.

Before you beginv Storage pools can be attached only with Admin, Storage Admin, System Admin, or

Security Admin storage credentials (see “GUI – Entering the storage arraycredentials” on page 44).

Figure 31. VWC – vCenter Servers – Remove button

Figure 32. Remove vCenter Server confirmation message


v When working with DS8000, storage pools can be attached only with Admin orLogical Operator storage credentials.

Any other type of storage credentials (read-only, application admin) cannotperform storage pool attachment. If your credentials are not sufficient, contact yourstorage administrator for assistance.

About this task

The storage pool attachment is done on the Integration Server side, providing morecontrol to storage administrators as opposed to the VMware administrators on thevSphere environment side. After the attachment, the storage pools become visibleand manageable on the vSphere Web Client side (by using the IBM StorageEnhancements).

You can select and attach one or more storage pools in one attachment operation,as described in the following procedure.


lists the vCenter servers to which you can attach storage pools.2. Click the row of the vCenter server to which you want to attach one or more

storage pools, and then click Attach. The Attach Storage Pools page isdisplayed.


3. From the drop-down list, select the storage array from which you want tochoose storage pools. The available predefined storage pools that reside on theselected storage array are immediately displayed.

4. Select the storage pools that you want to attach to the vCenter server, and thenclick Attach Pools. The list of attached storage pools per vCenter server isupdated accordingly.

Figure 33. Attach Storage Pools page


GUI – Detaching storage pools from a vCenter serverWhen required, you can detach a storage pool from the vCenter server to which itis attached.

About this taskv A detached storage pool, along with its volumes, can no longer be managed by

the included solution components (see “Included cloud interfaces” on page 1).v If the detached storage pool contains working volumes, the information of these

volumes is no longer displayed in vSphere Web Client. However, vSphere dataaccess and service level for these volumes is not affected. In addition, theremoved storage pool (including its volumes) can be managed from the standardIBM storage system management tools.

v After the detachment, you can attach the storage pool again to fully restore itsmanagement.

Procedure1. Click VWC on the top GUI panel. The vCenter Servers table is displayed on

the left and lists the vCenter servers to which you can attach storage pools.2. Click the row of the vCenter server from which you want to detach one or

more storage pools. The list of storage pools that are currently attached to thevCenter server is displayed on the right.

3. Select the storage pools that you want to detach (you can select multiplestorage pools by pressing CTRL or SHIFT when clicking), and then click

Figure 34. List of attached storage pools per vCenter server


Detach. A confirmation message appears.

4. Click Yes to detach the storage pool, or Cancel to cancel the operation.

GUI – Managing integration with vCenter OrchestratorBefore you can use the IBM Storage Plug-in for VMware vCenter Orchestrator onthe vCenter Orchestrator (vCO) server side, you must attach the storage pools thatyou want to make available for vCenter Orchestrator.

The storage pools that you attach on the IBM Storage Integration Server can beused for issuing volume workflows through vCenter Orchestrator (for moreinformation, see Chapter 6, “Using the IBM Storage Plug-in for VMware vCenterOrchestrator,” on page 97).

Note: This functionality is applicable only to XIV storage arrays.

To access these options, click vCO on the left GUI panel.

Figure 35. Detach Storage Pool confirmation message


The vCO integration operations can be performed from the CLI as well, asexplained in “CLI – Managing integration with vCenter Orchestrator” on page 34.

Figure 36. vCO option on the left GUI panel

Figure 37. vCO Server Pool Attachments


Downloading and installing the plug-in package for vCOTo enable the IBM Storage workflows in vCenter Orchestrator, you must firstdownload the IBM Storage plug-in package from the IBM Storage IntegrationServer and install it on the vCenter Orchestrator server.

Before you begin

To allow the IBM Storage Plug-in to securely identify the IBM Storage IntegrationServer and work properly, the SSL certificate that is automatically created on theIntegration Server upon installation must be replaced with a new one. For moreinformation about how to replace the certificate, see “Replacing the SSL certificateand key files” on page 11.

Important: After the IBM Storage Plug-in is installed on vCenter Orchestrator, theJava security APIs validate that the hostname received from the Integration Serveris identical to the common name (CN) value that is in the server certificate.

About this task

The following procedure details how to download, install, and properly configurethe IBM Storage Plug-in for VMware vCenter Orchestrator.

Procedure1. Click vCO on the left GUI panel and then attach the storage pools that should

be used by vCenter Orchestrator.2. On the bottom-right corner of the GUI, click Download Plug-in Package.

Figure 38. vCO Token Management box


Alternatively, you can download the package from the following directory onthe Integration Server:/opt/ibm/ibm_storage_integration_server/downloads/static/o11nplugin-isis-rest.dar

3. Copy the current vCO token key from the Token Management box.

4. Launch the VMware vCenter Orchestrator configuration interface.5. On the Network tab, go to SSL Trust Manager and then import the IBM

Storage Integration Server certificate. The certificate URL format should be:https://IP_address:8443

6. On the Plug-ins tab, go to Install New Plug-in, locate and choose thedownloaded plug-in file, and then click Upload and Install. The message 'IBMStorage (1.5.0 build 0) New plug-in installed.' is displayed, and a newIBM Storage tab is created under the Plug-ins tab.

7. On the IBM Storage tab, enter IBM Storage Integration Server IP address orhostname, and also the token key (REST API token) that you obtained earlier.

Figure 39. Download Plug-in Package button

Figure 40. Token Management box – Current vCO Token


8. Click Apply Changes.9. Restart both the vCO Configuration Server service and vCO Server service.

What to do next

See Chapter 6, “Using the IBM Storage Plug-in for VMware vCenter Orchestrator,”on page 97.

GUI – Managing integration with vCenter Operations ManagerBefore you can use the IBM Storage Management Pack for VMware vCenterOperations Manager, you must set a connection to at least one vCenter OperationsManager (vCOps) server, and then define which storage arrays should bemonitored in vCOps.

After a vCOps server connection is defined and storage arrays are associated withthe vCOps server, detailed monitoring information for these storage arraysbecomes available in vCOps (for more information, see Chapter 7, “Using the IBMStorage Management Pack for VMware vCenter Operations Manager,” on page101).


To access these options, click vCOps on the left GUI panel. You can then managethe integration with vCOps as explained in the following sections.

Figure 41. vCenter Orchestrator – IBM Storage Plug-in Configuration


The vCOps integration operations can be performed from the CLI as well, asexplained in “CLI – Managing integration with vCenter Operations Manager” onpage 36.

Figure 42. vCOps option on the left GUI panel

Figure 43. vCOps server and attached arrays


Downloading and installing the PAK file for vCOpsThe IBM Storage Management Pack for VMware vCenter Operations Manager isdeployed and enabled by installing a dedicated adapter on the vCenter OperationsManager (vCOps) server.

About this task

Although vCOps can display IBM Storage information even without the adapterinstallation, the IBM Storage adapter is required for displaying the dedicateddashboards, graphic icons, and user-friendly attribute names for the IBM Storageelements. The adapter is provided through a PAK file that you need to downloadand install, as described in the following procedure.

Procedure1. Click vCOps on the left GUI panel.2. On the bottom-right corner of the GUI, click Download PAK file.

Figure 44. vCOps server details and On/Off (Enable/Disable) button

Figure 45. Download PAK File button


Alternatively, you can download the package from the following directory onthe Integration Server:/opt/ibm/ibm_storage_integration_server/downloads/static/IBM_Storage_Adapter-1.5.0.pak

3. Log in to the VMware vCenter Operations Manager Administration console asan administrator.

4. On the Update tab, click Browse and point to the downloaded PAK file.5. Click Update to incorporate IBM Storage Management Pack in the vCenter

Operations Manager server.

What to do next

See Chapter 7, “Using the IBM Storage Management Pack for VMware vCenterOperations Manager,” on page 101.


Chapter 4. Using the IBM Storage Provider for VMware VASA

This chapter focuses on how to use the IBM Storage Provider for VMware VASAafter the required configuration on the IBM Storage Integration Server has beencompleted.

Note: IBM DS8000 systems are not supported by the IBM Storage Provider forVMware VASA.

After the IBM storage systems have been added to the Integration Server, and afterthe VASA access credentials were set (see “Required and optional initial tasks” onpage 17), you can start using the IBM Storage Provider for VMware VASA byregistering the Integration Server in the relevant vCenter server or servers.

Registering the Integration Server as a storage provider in vCenterServer

To use the IBM Storage Provider for VMware VASA solution component, you needto register the IBM Storage Integration Server as a storage provider in VMwarevCenter Server.

Before you beginv When the IBM Storage Provider for VMware VASA and the IBM Tivoli® Storage

Productivity Center (TPC) storage provider are registered on the same VMwarevCenter server, while the same storage array is configured for both, vCenter usesIBM Tivoli Storage Productivity Center provider as the only source ofinformation for that array's storage views on vSphere Client.In such a case, determine whether the IBM Tivoli Storage Productivity Centercapabilities are sufficient for replacing the IBM Storage Provider for VMwareVASA. If the IBM Storage Provider for VMware VASA is still needed, IBM TPC5.2 (or later) provides a method of excluding storage arrays from a specificstorage provider, allowing you to remove the array association with the IBMTPC provider.

v The date and time that are defined on both the vCenter server and on the IBMStorage Integration Server must be identical. To accurately synchronize the dateand time between the two servers, you can connect both to a Network TimeProtocol (NTP) server.

About this task

The following procedure describes how to register the Integration Server on asingle vCenter server by using vSphere Client.

Procedure

To register the IBM Storage Integration Server in VMware vCenter Server, completethe following steps.1. In vSphere Client, go to Administration > Storage Providers.2. Click Add.


The Add Vendor Provider dialog box is displayed.3. Enter the name, URL, and pre-configured username and password (VASA

Secret) for accessing the IBM Storage Integration Server (the VASA Secret ispredefined as explained in “GUI – Setting the VASA credentials” on page 55).The URL should be entered in the ip:port format, specifying the relevant IPaddress and port number of the IBM Storage Integration Server:https://[Integration Server IP address]:8443/services/vasa1

Note: In this example, "Integration Server IP address" stands for the IP addressor domain namespace of the IBM Storage Integration Server.

Figure 46. vSphere Client – Storage Providers list


4. Click OK. A security alert dialog box is displayed.

5. Click Yes to accept the certificate. The IBM Storage Integration Server is addedto vCenter Server.

Note: The certificate provides improved security by adding server authentication.

Figure 47. Add Vendor Provider dialog box

Figure 48. vCenter certificate thumbprint dialog box

Chapter 4. Using the IBM Storage Provider for VMware VASA 75

Figure 49. Vendor Providers list displaying the IBM Storage Integration Server


Chapter 5. Using the IBM Storage Enhancements for VMwarevSphere Web Client

Together with supported IBM storage systems that are managed by the IBMStorage Integration Server, the deployed IBM Storage Enhancements enable thefollowing management features on vSphere Web Client for registered vCenterservers:v Full control over storage volumes, including volume creation, resizing,

renaming, migration to a different storage pool, mapping, unmapping, multipathpolicy enforcement, and deletion.

v Easy and integrated allocation of volumes to VMware datastores, used by virtualmachines that run on ESXi hosts, clusters, or datacenters.

Note:

v The IBM Storage Enhancements are automatically deployed and made availablefor the vCenter servers that were registered (added) on the IBM StorageIntegration Server (see “GUI – Adding a vCenter server” on page 57).

v For information about the required vSphere user privileges, see “RequiredvSphere privileges.”

See the following sections for more information:v “Populating vCenter server information to the Integration Server” on page 79v “Viewing the IBM storage resource information” on page 80v “Creating and mapping a new storage volume (LUN)” on page 84v “Extending a volume” on page 90v “Renaming a volume” on page 91v “Setting multipath policy enforcement for a volume” on page 92v “Moving a volume to another storage pool” on page 93v “Unmapping a volume from one or more hosts” on page 94v “Deleting an unused volume” on page 95

Required vSphere privilegesTo operate the IBM Storage Enhancements for VMware vSphere Web Client, youmust have the minimum required privileges defined in your vSphere user role.

Use the Role Manager extension in vSphere Web Client to define the requiredprivileges for your user role as detailed in the following table.


Table 17. Required vSphere privileges

Task Required vSphere user privilege

Adding a vCenter server to the IBM StorageIntegration Server

(see “GUI – Adding a vCenter server” on page57)

v Extension – In this category, select Register extension,Unregister extension, and Update extension.

v Global – In this category, select Log event and Cancel task.

v Tasks – In this category, select Create task and Update task.

v Sessions – In this category, select Impersonate user.

v Host – In this category, select Configuration > Storage partitionconfiguration.

Storage provisioning (volume creation andmanagement) from vSphere Web Client

(see Chapter 5, “Using the IBM StorageEnhancements for VMware vSphere WebClient,” on page 77)

Figure 50. VMware vSphere Web Client – Create Role dialog box


For more detailed information about how to set the vSphere Web Client privilegetypes, refer to the VMware vSphere 5.1 Documentation Center(pubs.vmware.com/vsphere-51/index.jsp ).

Populating vCenter server information to the Integration ServerAt any time and whenever needed, you can manually update the vCenter serverinformation on the IBM Storage Integration Server side.

About this task

By default, the vCenter server information is automatically updated on the IBMStorage Integration Server every 30 minutes (as defined in vwc_config.ini, see“Checking and modifying the configuration files” on page 107). If you want to runthe update earlier without having to wait for the next automatic update, performthe following procedure.

Important: Before you can use this option, the relevant vCenter server mustalready be added on the IBM Storage Integration Server, as explained in “GUI –Adding a vCenter server” on page 57.

Procedure1. In vSphere Web Client, focus on the relevant vCenter server.2. From the Actions menu, select All IBM Storage Enhancements for... > Refresh

Storage Integration ServerA confirmation message appears.

Figure 51. Populate vCenter Information option

Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client 79

http://pubs.vmware.com/vsphere-51/index.jsp?topic=%2Fcom.vmware.vsphere.security.doc%2FGUID-93B962A7-93FA-4E96-B68F-AE66D3D6C663.html

3. Click Yes to send the specified vCenter information to the IBM StorageIntegration Server.

Viewing the IBM storage resource informationAfter the IBM Storage Enhancements for VMware vSphere Client are properlyinstalled, the IBM Storage category is shown under the standard vSphere WebClient categories for each vCenter server, as shown in the following figure.

For each vCenter server, the IBM Storage category shows how many IBM storagearrays are available for that vCenter server. The number and type of available IBMstorage arrays is determined on the IBM Storage Integration Server side, asexplained in “GUI – Managing storage arrays” on page 43 and “GUI – Managingintegration with vSphere Web Client” on page 56.

Figure 52. Populate vCenter confirmation message

Figure 53. IBM Storage category in vSphere Web Client


You can click and open the IBM Storage category, and then click an IBM storagearray to view the currently available storage volumes on that particular storagearray, and also to check which VMware entities are currently using storageresources on that storage array.

In addition, IBM Storage information and functions are available per vCenterserver in the different category views on the Related Objects tab, as shown in thefollowing figures.

Figure 54. IBM Storage information per storage array

Figure 55. Currently available storage pools per storage array


Figure 56. IBM Storage information per vCenter server

Figure 57. IBM Storage information per datacenter

Figure 58. IBM Storage information per datastore


Figure 59. IBM Storage information per all ESXi hosts of a vCenter server

Figure 60. IBM Storage information per all VM templates of a vCenter server

Figure 61. IBM Storage information per all vApps of a vCenter server


And so on, click the other information categories that are available in vSphere toview the relevant IBM Storage information in these categories as well.

Creating and mapping a new storage volume (LUN)The IBM Storage Enhancements for VMware vSphere Web Client allow you tocreate new volumes (LUNs) directly from the vSphere Web Client interface. Thesevolumes can be used as storage devices in the vSphere environment.

About this task

Any created volume is mapped to either ESXi hosts, clusters, or datacenters, sothat the virtual machines on these hosts, clusters, or datacenters would be able tosave datastore information on that volume.

In addition to single volume creation, you can create multiple volumessimultaneously. If you choose this option, the created volumes are appended withdifferently numbered suffixes that are automatically generated by the system inconsecutive order.

Important:

v You can create volumes only on storage pools that have been attached to therelevant vCenter server on the IBM Storage Integration Server side. For moreinformation, see “GUI – Managing integration with vSphere Web Client” onpage 56

v The ESXi hosts and clusters to which you map the created volumes must bepredefined on the storage system side. For more information, refer to your IBMstorage system documentation.

Procedure1. In vSphere Web Client, navigate to the relevant vCenter server and then to the

specific IBM storage array on which you want to create the new volume. TheIBM storage array and the relevant storage pools should already be associatedwith the vCenter server (see “Viewing the IBM storage resource information”on page 80).

2. Click Actions > Create New Volume. Alternatively, from the Top LevelObjects view on the relevant vCenter server, click Actions > All IBM StorageActions > Create New Volume.

Figure 62. IBM storage array view – Clicking Create New Volume


You can also right-click the storage array or click the dedicated icon in orderto invoke the Create New Volume option.

Figure 63. Top Level Objects view – Clicking Create New Volume

Figure 64. Right-clicking the storage array


The Create New Volume dialog box is displayed.

Note: When you create a single volume, a LUN (logical unit number) is assignedto that volume, and you can later change the LUN assignment. If you createmultiple volumes, LUNs (logical unit numbers) are automatically assigned to thosevolumes and cannot be modified later.

3. In the Volume Size text box, enter the size for the new volume. Alternatively,place the mouse pointer on the graphic image of the storage pool, and thenclick and slide the space marker rightward to set the new volume size. The

Figure 65. Clicking the Create New Volume icon

Figure 66. Create New Volume wizard (XIV example)


numerical value in Volume Size is automatically updated accordingly.

Note:

v It is recommended to define the size of an XIV volume in a multiple of 17 GB.The Volume Size box appears with a yellow rectangle around it if the size valueis not a multiple of 17 GB. The XIV Recommended Volume Size (GB)information is displayed below.

v The largest available storage pool on the storage array is automatically selected.

4. In the Volume Name text box, enter the name that you want to assign to thenew volume.

5. If you want to create multiple volumes simultaneously (otherwise, go to step6 on page 88): In the Number of Volumes text box, enter the number ofvolumes that you want to create simultaneously. The text box next to theVolume Name entry displays vol_{1} by default. The {1} represents the suffixvalue, and it must be kept as part of the volume name. You edit the volumename and also move the suffix value within the name (the {1} suffix does nothave to be at the end of the volume name).

Figure 67. Setting the volume size with the graphic space marker


6. If you want to change the automatically selected storage pool (otherwise, skipto next step), select a different storage pool from the Storage Array/Pool listbox.

7. If you are creating a single volume, you can select the LUN that shouldrepresent the new volume on the storage system, or keep the automaticallyselected LUN. The LUNs are automatically selected when creating multiplevolumes.

Figure 68. Creating multiple volumes


Note: After the volume is created, the specific LUN association cannot be changed,and the same number cannot be assigned to a different volume. The specific LUNcan become available for reassignment only after its associated volume is deleted.

8. Only if you are creating the volume on an IBM Flex System®, DS8000, SANVolume Controller, or Storwize storage system (otherwise, skip to the nextstep):v Select the I/O Group to which the volume should belong. Not applicable to

DS8000.v Optional: Select Enable Thin Provisioning if you want the volume to be

defined as thin provisioned and not as a fixed hard disk allocation. Whenthis option is selected, the available capacity and total capacity aredisplayed based on the requested volume size. For DS8000, theover-provision ratio information is also displayed.

v Optional: Select Enable Data Compression if you use data compression onSAN Volume Controller or Storwize V7000, on Storwize V3500 or StorwizeV3700, or on Storwize V7000 Unified. Not applicable to DS8000.

v Optional: Select Enable Vdisk Mirroring if you want to use virtual diskmirroring for the volume or volumes that you create. Not applicable toDS8000. If selected, a list of storage pools appears and you must select thesecondary storage pool on which you want the mirrored volume orvolumes to be created.

Figure 69. Creating multiple volumes


Note:

v XIV volumes are not associated with I/O groups and are thin-provisioned ifcreated in a thin-provisioned storage pool.

v Compressed volumes of SAN Volume Controller or Storwize storage systems (ifsupported by the microcode) are always thin-provisioned.

9. From Host Mapping, select the host(s), cluster(s), or datacenter(s) to whichyou want to map the new volume. You can click Custom to specify a custommapping in the Advanced Host Mapping dialog box.

Note: Any ESXi host that is connected to the storage array can be selected. Hoststhat are not connected to the storage array are marked and a message notifies youabout any connectivity problem. If you select a datacenter, its member clusters andhosts are automatically selected under it.

Important: You must map the volume to at least one ESXi host, cluster, ordatacenter in order to enable vSphere management of the created volume.

10. Review the details of the new volume that is about to be created, and thenclick OK to confirm its creation as detailed.

Extending a volumeIf enough free space is available on the relevant storage pool, you can extend thesize of an existing volume.

Figure 70. Advanced Host Mapping dialog box


Procedure

Perform the following procedure to extend the size of a volume.1. In vSphere Web Client, navigate to the row of the volume that you want to

extend.2. Right-click the volume row and choose Extend or use the Actions menu to

select Extend.

The Extend Volume dialog box is displayed.3. In the Volume Size text box, enter the new size for the volume. Alternatively,

place the mouse pointer on the graphic image of the storage pool, and thenclick and slide the space marker rightward to set the new volume size. Thenumerical value in Volume Size is automatically updated accordingly.

4. Click Extend.

Important: Extending the size of a volume does not automatically increase thedatastore capacity.

Renaming a volumeWhenever required, you can rename any existing volume by performing thefollowing procedure.

About this task

Renaming a volume is a logical action that does not have any physical effect onthe volume or its logical connections. Renaming a volume also changes itsdisplayed name in the vSphere environment.

Procedure1. In vSphere Web Client, navigate to and then click the row of the volume that

you want to rename, and then choose the Rename option by right-clicking the

Figure 71. Clicking Extend on the pop-up menu


volume row or using the Actions menu.The Rename Volume dialog box is displayed.

2. Enter the new name that you want to assign to the volume, and then click OK.

Setting multipath policy enforcement for a volumeYou can set the multipath policy enforcement for a single volume.

About this task

By default, the Round Robin multipath policy is enforced on volumes. You candisable or change this enforcement for a specific volume if needed.

Note: If you are using ESXi version 5.1 or earlier with DS8000 or Storwize Familysystems, see “Setting the multipath policy for DS8000 and Storwize Familysystems” on page 111.

Procedure1. In vSphere Web Client, navigate to and then click the row of the volume for

which you want to change the enforcement, and then choose the Set MultipathPolicy Enforcement option by right-clicking the volume row or using theActions menu.

Figure 72. Rename volume option

Figure 73. Rename Volume dialog box


The Change Multipath Policy Enforcement dialog box is displayed.

2. Select the required option and then click OK.

Important: After the policy is set, it is enforced by overriding any existing policyfor this volume.

Moving a volume to another storage poolYou can move a volume to a different storage pool, for example, when the currentstorage pool has run out of space.

Figure 74. Set Multipath Policy Enforcement option

Figure 75. Change Multipath Policy Enforcement dialog box


About this task

Attention:

v On XIV storage systems, moving a volume to another storage pool is a logicalaction. No data is actually moved on physical disks as a result.

v On DS8000, Storwize, and SAN Volume Controller storage systems, moving avolume to another storage pool is a physical action that causes data to move toa different physical disk. This may cause some performance overhead.

v On DS8000, Storwize, and SAN Volume Controller storage systems, moving avolume to another storage pool is an asynchronous action. The capacity of thesource and target storage pools may not be updated after the task is completedin vCenter.

v When using mirrored volumes on SAN Volume Controller systems, only theprimary copy volumes can be moved. In addition, these volumes can be movedonly to the primary storage pool copy (not to the secondary copy).


you want to move, and then choose the Move option by right-clicking thevolume row or using the Actions menu.

The Move Volume dialog box is displayed.2. Select the storage pool to which you want to move the volume, and then click

OK.

Unmapping a volume from one or more hostsWhen volumes or ESXi hosts are no longer needed, or if new ones are to replacethe current ones, you can unmap volumes from the hosts.

Figure 76. Move volume option


About this task

Important: A volume (LUN) must remain mapped to at least one host. Otherwise,you cannot view the volume or perform any actions on it from vSphere WebClient.


you want to unmap, and then choose the Unmap option by right-clicking thevolume row or using the Actions menu.

The Unmap Volume dialog box is displayed.2. Select the hosts or clusters from which you want to unmap the volume, and

then click OK.

Deleting an unused volumeWhen a storage volume is unused and no longer required, you can delete it.

Before you begin

Important: You cannot delete volumes that are currently used by datastores or as araw mapped LUN.


you want to delete, and then choose the Delete option by right-clicking thevolume row or using the Actions menu.

Figure 77. Unmap volume


The Delete Volume confirmation message is displayed.2. Click OK to confirm the deletion, or Cancel to exit without deleting the

volume.

Figure 78. Delete volume


Chapter 6. Using the IBM Storage Plug-in for VMware vCenterOrchestrator

Use the IBM Storage Plug-in for VMware vCenter Orchestrator to include IBMStorage discovery and provisioning in your vCenter Orchestrator (vCO)automation workflows.


After the IBM Storage Plug-in is deployed (see “Downloading and installing theplug-in package for vCO” on page 66), you can start initiating the followingOrchestrator workflows:v Create a volumev Map a volumev Extend a volumev Unmap a volumev Delete a volume

The following figures display the IBM Storage workflows and elements in vCO.

Figure 79. vCenter Orchestrator – Create New Volume workflow – General tab


Figure 80. vCenter Orchestrator – Create New Volume workflow – Inputs tab

Figure 81. vCenter Orchestrator – Create New Volume workflow – Parameter References tab


For information about how to initiate workflows in vCenter Orchestrator, refer tothe relevant VMware documentation.

Figure 82. vCenter Orchestrator – Storage Arrays panel

Chapter 6. Using the IBM Storage Plug-in for VMware vCenter Orchestrator 99

Chapter 7. Using the IBM Storage Management Pack forVMware vCenter Operations Manager

Use the IBM Storage Management Pack for VMware vCenter Operations Managerto obtain comprehensive monitoring information about the IBM Storage resourcesthat are utilized in your virtualized environment.


After the IBM Storage adapter PAK is deployed (see “Downloading and installingthe PAK file for vCOps” on page 70), you can start viewing the detailed IBMStorage dashboards, together with the graphical relationships between the storageelements (storage arrays, ports, storage pools, volumes) and virtual elements(datastores, virtual machines, hosts) in a drill-down interactive style.

Three main dashboards are available for XIV storage arrays:v IBM XIV Top 10 – includes the following charts, each with 10 entries:

– Top 10 XIV volumes by IOPS (in the last hour)– Top 10 XIV volumes by IOPS (in the 24 hours)– Top 10 XIV volumes by throughput (in the last hour)– Top 10 XIV volumes by throughput (in the 24 hours)– Top 10 XIV hosts by IOPS (in the last hour)– Top 10 XIV hosts by IOPS (in the 24 hours)– Top 10 XIV hosts by throughput (in the last hour)– Top 10 XIV hosts by throughput (in the 24 hours)


v IBM XIV Overview – Provides clickable icons that represent relationshipsbetween all virtual elements and storage elements that are in use.

Figure 83. vCenter Operations Manager – IBM XIV Top 10 dashboard


v IBM XIV Performance – Provides performance information on the graphicalelements that you click upon.

Figure 84. vCenter Operations Manager – IBM XIV Overview dashboard

Chapter 7. Using the IBM Storage Management Pack for VMware vCenter Operations Manager 103

For information about how to use vCenter Operations Manager, refer to therelevant VMware documentation.

Figure 85. vCenter Operations Manager – IBM XIV Performance dashboard


Chapter 8. Troubleshooting

This chapter can help you detect and solve problems that you might encounterwhen using the IBM Storage Integration Server.

Note: For up-to-date information about known issues and possible workarounds,refer to the latest release notes.

See the following sections for more information:v “Checking and controlling the Integration Server service”v “Checking the log files” on page 106v “Checking and modifying the configuration files” on page 107v “Checking the format of directory-based storage array credentials” on page 108

Checking and controlling the Integration Server serviceAt any time, you can check whether the IBM Storage Integration Server serviceruns properly on the Linux host. You can also stop and then start the service ifneeded.

Procedure1. Log on to the Linux command prompt environment as a root user.

Important: Only root users can perform service operations.

2. Enter the following command: service ibm_storage_integration_serverstatus. The status of the Celery and Django services is displayed.

[root@isis]# service ibm_storage_integration_server statusCelery services are running...Django service is running...

What to do next

If you want to stop the IBM Storage Provider service, use the stop command:

[root@isis]# service ibm_storage_integration_server stopStopping Django service ... [ OK ]Stopping Celery services ... [ OK ]

To start the service again, use the start command:

[root@isis]# service ibm_storage_integration_server startStarting Celery services ... [ OK ]Starting Django service ... [ OK ]

If you want to stop and then start the IBM Storage Provider service in onecommand, use the restart command:


[root@isis]# service ibm_storage_integration_server restartStopping Django service ... [ OK ]Stopping Celery services ... [ OK ]Starting Celery services ... [ OK ]Starting Django service ... [ OK ]

Checking the log filesThe IBM Storage Integration Server maintains six log files that record differenttypes of events.

You can find the following log files in the /var/log/isis/ directory:v events.log – Records Integration Server events according to their type: Info,

Error, or Warning. The event logging is compatible with the Rsyslog application,an open source utility for forwarding log messages over IP networks (for moreinformation, see the Rsyslog website). The following example shows differentevents that might be recorded:

ISIS-0001, INFO, "User {user_name} has logged in."ISIS-0002, INFO, "User {user_name} has logged out."ISIS-0003, WARNING, "User {user_name} login attempt failed."ISIS-0004, INFO, "IBM Storage Integration Server local user account {user_name} was created."ISIS-0005, INFO, "IBM Storage Integration Server local user account {user_name} was deleted."ISIS-0006, INFO, "IBM Storage Integration Server local user account {user_name} password was reset."ISIS-0007, INFO, "Storage credentials were set for user {user_name}."ISIS-0008, ERROR, "Storage credentials for user {user_name} were disabled. Reason: {reason}."ISIS-0009, INFO, "Storage array identified as {identifier} with IP address {ip_address} has been added."ISIS-0010, WARNING, "Storage array {identifier} was removed."ISIS-0011, WARNING, "Storage array {identifier} was modified. Its new IP address is {ip_address}."ISIS-0014, INFO, "vCenter server with IP address {ip_address} was added by user {user_name}."ISIS-0015, WARNING, "vCenter server with IP address {ip_address} was removed."ISIS-0016, WARNING, "Credentials for vCenter server with IP address {ip_address} were updated by user {user_name}."ISIS-0017, INFO, "Storage pool {pool_name} on storage array {identifier} was attached to vCenter server with IP address {ip_address}."ISIS-0018, WARNING, "Storage pool {pool_name} on storage array {identifier} was detached from vCenter server with IP address {ip_address}."ISIS-0019, ERROR, "Failed to connect to storage array {identifier}. Reason: {reason}."ISIS-0020, INFO, "Information retrieval from storage array {identifier} was completed."ISIS-0021, ERROR, "Failed to retrieve information from storage array {identifier}. Reason: {reason}."ISIS-0022, INFO, "LDAP authentication was enabled."ISIS-0023, INFO, "LDAP authentication was disabled."ISIS-0024, INFO, "Completed the vSphere Web Client extension task {task_name} with the following parameters: {parameter_list}."ISIS-0025, ERROR, "Failed to complete the vSphere Web Client extension task {task_name} with the following parameters {parameter_list}.Reason: {reason}."

v hsgsvr.log – Records events regarding monitoring and operations on storagearrays and volumes.

v vasa1.log – Records events regarding the communication between theIntegration Server and the connected vCenter servers that utilize VASAfunctions.

v vwc.log – Records events regarding the communication between the IntegrationServer and the vSphere Web Client Server on which the IBM StorageEnhancements are installed.

v celery.log – Records events regarding the Celery services on the Linux host onwhich the Integration Server is installed.

v isis_django.log – Records events regarding the Django service on the Linuxhost on which the Integration Server is installed.

v ds8k_proxy.log – Records ESS network interface (ESSNI) proxy operations forDS8000.

v ds8k_jsvc_error.log – Records startup failures of the ESSNI proxy for DS8000.v ds8k_jsvc.log – Records Apache Jsvc operations for DS8000.

You can retrieve and save the current log files in a compressed TAR archive file byusing the Collect Logs option on the Help menu of the Integration Server GUI.


http://www.rsyslog.com/doc/

This option allows you to save different instances of the log files at different times.

Checking and modifying the configuration filesThe IBM Storage Integration Server has four configuration files that storeconfiguration settings that you can change manually if needed.

You can view and modify the contents of each file with any standard text editor,according to the purpose and contents of each file.

After modifying a configuration file, you must restart the Integration Server serviceby running the following CLI command on the Linux host:

service ibm_storage_integration_server restart

For more information about this service, see “Checking and controlling theIntegration Server service” on page 105.

Figure 86. Integration Server GUI – Collect Logs option

Figure 87. Integration Server GUI – Saving the logs in a compressed TAR archive

Chapter 8. Troubleshooting 107

Table 18. Configuration files

File name Directory location Purpose or relevant parameters

ibmsyslog.conf opt/ibm/ibm_storage_integration_server/conf.d/

Defines the logging standard per application,as well as the target of the log messages.

ibmlogs-rotate opt/ibm/ibm_storage_integration_server/conf.d/

Controls the archive and renewal timingattributes of the log files. For the list of logfiles, see “Checking the log files” on page 106.

ldap.ini opt/ibm/ibm_storage_integration_server/conf.d/

See “Configuring directory user access” onpage 18.

ldap.conf /etc/openldap/ See “Configuring directory user access” onpage 18.

vasa_config.ini opt/ibm/ibm_storage_integration_server/conf.d/vasa1/

v populate_vasa_events_and_alarms – Thetime interval in minutes between eachoperation of filtering relevant events foreach connected vCenter server. The defaultvalue is 2.

vwc_config.ini opt/ibm/ibm_storage_integration_server/conf.d/vwc/

v populate_all_vmware_objects – The timeinterval in minutes between each operationof refreshing of all vCenter serverinformation on the Integration Server. Thedefault value is 30. When using a largenumber of vCenter servers, the value mightneed to be higher.

hsgsvr_config.ini opt/ibm/ibm_storage_integration_server/conf.d/hsgsvr/

v populate_arrays_and_events – The timeinterval in minutes between each update ofinformation (changes and events) receivedfrom each monitored storage system. Thedefault value is 10. When using a largenumber of storage array, the value mightneed to be higher than 10.

essni_proxy.

properties

/opt/ibm/ibm_storage_integration_server/conf.d/ds8k_proxy

ESS network interface (ESSNI) proxyconfiguration file.

Checking the format of directory-based storage array credentialsIf you are using directory-based storage credentials for adding storage arrays tothe IBM Storage Integration Server (not for logging in to the Integration Server),you must verify that the directory user name is provided in the correct format.

Different formats are possible for a directory-based user name. For example:v User name without the domain name, for example: john21v User name with the domain name, for example: john21@domain_name

The format that should be used depends on the directory user name attributestring that is defined on the storage system. For example:v sAMAccountName – User name without the domain name (john21).v userPrincipalName – User name with the domain name (john21@domain_name).


Important: Other user name formats that are not specified above may be used.Consult with your directory server administrator about the required user nameformat, and make sure that the user name format is properly defined on thestorage system.

The following figure shows the user name attribute in the LDAP role mappingdefinitions for XIV (defined via the XIV management GUI).

Related tasks:“GUI – Entering the storage array credentials” on page 44The storage array credentials are used to connect to the IBM storage system orsystems, which your VMware platforms use for storage provisioning.

Figure 88. XIV role mapping attributes for directory (LDAP) users

Chapter 8. Troubleshooting 109

Chapter 9. Best Practices

Refer to the general guidance and best practices that are described in the followingsections.v “Handling datastores”v “Handling ESXi hosts that use XIV volumes”v “Distributing volumes evenly on DS8000 systems”v “Setting the multipath policy for DS8000 and Storwize Family systems”

Handling datastoresFor best performance of VMware datastores:v Create each datastore on a separate storage volume.v If you use snapshots/mirroring for volumes, place all Datastore Extents volumes

(the building block LUNs of a datastore) in a consistency group (defined byusing the storage system GUI or CLI).

Handling ESXi hosts that use XIV volumesFor the best performance of ESXi hosts that use XIV volumes, define all ESXi hostswithin a cluster as cluster hosts on the XIV storage system as well.

Following this practice prevents situations in which a storage volume is mapped todifferent ESXi hosts in a cluster using different LUN numbers, thus making thisLUN unusable.

Distributing volumes evenly on DS8000 systemsDS8000 storage systems have two rank groups, 0 and 1, each managed by a singleserver. In addition, each DS8000 extent pool is based on one rank group.

Accordingly, it is recommended to spread volumes evenly across the DS8000systems. Spreading the volumes equally on the extent pools of rank groups 0 and 1balances the workload across the DS8000 system.

Setting the multipath policy for DS8000 and Storwize Family systemsWhen using the IBM Storage Enhancements for VMware vSphere Web Client, therecommended multipath policy for DS8000 and Storwize Family (including SANVolume Controller) storage systems is Round Robin.

If you are using VMware ESXi servers of version 5.5 or later, the Round Robinmultipath policy is enforced by default. However, if you are using earlier ESX orESXi versions, the Fixed policy is chosen by default, and it is recommended tochange the multipath policy on those servers to Round Robin.

For information about how to change the default multipath policy enforcement forearlier ESX or ESXi versions, refer to article 1017760 on the VMware KnowledgeBase website (kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1017760).


http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1017760

http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1017760

Notices

These legal notices pertain to IBM Storage product documentation.

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,contact the IBM Intellectual Property Department in your country or sendinquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Web


sites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationAttn: Office of Legal Counsel650 Harry RoadSan Jose, CA 95120-6099U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks of theInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Copyright and trademarkinformation website (www.ibm.com/legal/us/en/copytrade.shtml).


http://www.ibm.com/legal/us/en/copytrade.shtml

http://www.ibm.com/legal/us/en/copytrade.shtml

VMware, the VMware logo, ESX, ESXi, vSphere, vCenter, and vCloud aretrademarks or registered trademarks of VMware Corporation in the United States,other countries, or both.

Microsoft, Windows Server, Windows, and the Windows logo are trademarks orregistered trademarks of Microsoft Corporation in the United States, othercountries, or both.

Linux is a trademark of Linus Torvalds in the United States, other countries, orboth.

Other product and service names might be trademarks of IBM or other companies.

Notices 115

Index

Aaccess to array 26add

storage array 28storage provider 73user 25vCenter server 31

admin commands 25admin username 42array credentials 26, 108attach arrays 36attach pools 31, 34automation 2

Bbackup 40best practices

datastores 111distributing DS8000 volumes 111ESXi hosts 111

Ccertificate

replacing 11change password 25check service 105CLI commands 24collect logs 106command-line interface

add or remove storage arraycredentials 26

add or remove storage arrays 28adding users 25backup or restore server

configuration 40configure directory server access 18manage vCenter Operations

Manager 36manage vCenter Orchestrator 34manage vSphere web client 31managing the integration server 24set VASA credentials 30switch to ISIS user mode 24tasks 17

compatibility 5concept diagram 3configuration backup 40configuration files

modify 107creating or mapping

LUN 84

Ddatastores

best practices 111debug mode 107

detach arrays 36detach pools 31, 34detect problems 106directory user 108directory users 18download plug-in 66download site 5DS8000 volumes

best practices 111

EESX server versions 111extract files 10

FFix Central 5

GGUI

add storage array 46adding server users 50adding storage array 46adding vCenter server 57attach storage pools to vCenter

server 60change user password 51deleting server users 52detach storage pools from vCenter

server 63enter storage array credentials 44logging in 42manage storage arrays 43manage the server 42manage the users 49manage VASA access 53manage vCenter Operations

Manager 68manage vCenter Orchestrator 64manage vSphere Web Client 56modify IP address or hostname 47remove storage array 48remove vCenter server 59setting VASA credentials 55storage credentials 44tasks 17update vCenter server credentials 58

Hhsgsvr_config.ini 107

Iibmsyslog.conf 107installation

Integration Server 10

installation (continued)upgrade 7

Integration Servercontrolling the service 105

interval 107isis username 10

LLDAP 18, 108ldap.conf 18ldap.ini 18, 107list

storage array 28users 25

list arrays 36list pools 31, 34log files 106LUN

create 84

Mmanagement 17management URL 42multipath policy 92, 111

OOperations Manager 3optional tasks 17Orchestrator 2Overview dashboard 101

PPAK file 70Performance dashboard 101performance data 3plug-in package 66populate vCenter

update the Integration Server 79port 8443 42

Rregister

integration server 73release notes 5remove

storage array 28storage credentials 26user 25vCenter server 31

remove VASA certificate 53required tasks 17requirements 5resolve issues 105restart service 14


restore 40Round Robin 92, 111rpm package 10

Ssave configuration 40server management 42server users 25service status 105start service 105stop service 14, 105storage array commands 28storage credentials 108

display 26remove 26set 26

storage enhancementsvSphere Web Client 77

storage monitoring 3storage pools

attach or detach 31storage resource information

viewing 80storage volume

create 84supported storage systems 5

Ttar.gz file 10tasks 17time interval 107Top 10 dashboard 101troubleshoot 105

Uuninstall

IBM Storage Integration Server 13Integration Server software 13storage enhancements for VMware

vSphere Web Client 14upgrade 7user

privileges 77roles 77

user authentication 18username 108

VVASA access 53VASA credentials 30, 55VASA Provider server 73vasa_config.ini 107vCAC 2vCenter Operations Manager 3, 101vCenter Orchestrator 2, 97vCenter Server 73vCloud automation 2vCO 2, 64, 97vCO plug-in 66vCOps 3, 101vCOps PAK file 70

vendor providers 73VMware VASA

using storage provider 73volume

deleting unused 95extending 91move to another storage pool 94multipath policy enforcement 92rename 91unmapping from host 95

vSphere Client 73vSphere privileges 77vSphere Web Client

storage enhancements 2vSphere Web Client enhancements 77VWC 56vwc_config.ini 107

Wwhat to do first 17workflows 2


��

Printed in USA

SC27-5999-05

ibm storage integration serverdelivery04.dhe.ibm.com/.../2/ibm_storage_integration… · ·...

Documents