VMware vCenter Orchestrator EMC ViPR Plug-in for EMC ViPR File System Deletes the ViPR file system, if there are no hosts associated with the file system, and if no snapshots are associated

EMC® ViPR™ Plug-in forVMware® vCenter OrchestratorVersion 1.1.0

Installation and Configuration Guide302-000-488

01

Copyright © 2013-2014 EMC Corporation. All rights reserved. Published in USA.

Published February, 2014

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind withrespect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for aparticular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicablesoftware license.

EMC², EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and othercountries. All other trademarks used herein are the property of their respective owners.

For the most up-to-date regulatory document for your product line, go to EMC Online Support (https://support.emc.com). Fordocumentation on EMC Data Domain products, go to the EMC Data Domain Support Portal (https://my.datadomain.com).

EMC CorporationHopkinton, Massachusetts 01748-91031-508-435-1000 In North America 1-866-464-7381www.EMC.com

2 EMC ViPR Plug-in for VMware vCenter Orchestrator 1.1.0 Installation and Configuration Guide

5

EMC ViPR Plug-in for vCenter Orchestrator Overview 7

EMC ViPR for vCenter Orchestrator...................................................................8ViPR plug-in for vCO workflows...........................................................8

Multi-client integration..................................................................................10

EMC ViPR and vCenter Orchestrator Configuration Requirements 11

EMC ViPR configuration requirements............................................................12vCenter Orchestrator configuration requirements.......................................... 12

EMC ViPR Plug-in Installation and Configuration 15

Installing the EMC ViPR plug-in for vCenter Orchestrator................................ 16Configuring EMC ViPR and system settings.................................................... 16Verifying the EMC ViPR plug-in installation.................................................... 17Generating EMC ViPR workflow documentation..............................................17

EMC ViPR Plug-in Integration with Additional VMware Applications 19

EMC ViPR workflow multi-client integration....................................................20VMware vCenter Orchestrator REST API integration........................................ 20VMware vSphere, vCenter Server integration................................................. 20VMware vCloud Automation Center............................................................... 21Workflow CPU and memory utilization........................................................... 21

Tables

Chapter 1

Chapter 2

Chapter 3

Chapter 4

CONTENTS

EMC ViPR Plug-in for VMware vCenter Orchestrator 1.1.0 Installation and Configuration Guide 3

CONTENTS


Common workflows......................................................................................................... 8Building block workflows.................................................................................................9Basic EMC ViPR workflow...............................................................................................21Complex EMC ViPR workflow..........................................................................................22

1234

TABLES

EMC ViPR Plug-in for VMware vCenter Orchestrator 1.1.0 Installation and Configuration Guide 5

TABLES


CHAPTER 1

EMC ViPR Plug-in for vCenter OrchestratorOverview

This chapter contains the following topics:

u EMC ViPR for vCenter Orchestrator...........................................................................8u Multi-client integration.......................................................................................... 10

EMC ViPR Plug-in for vCenter Orchestrator Overview 7

EMC ViPR for vCenter OrchestratorThe EMC ViPR plug-in for vCenter™ Orchestrator™ (ViPR plug-in for vCO) provides anorchestration interface to the EMC ViPR software platform. The EMC ViPR plug-in has pre-packaged workflows used through the Orchestrator Client as well as other clients thatsupport vCenter Orchestrator integration.

ViPR plug-in for vCO workflowsThere are two types of workflows pre-packaged with ViPR. One set of workflows is usedfor common ViPR operations, while the other set are the "building block" workflows usedfor more granular ViPR operations.

Note

You can access the ViPR worklfows from the VMware vCenter Orchestrator client or webclient, Workflows > Library tree.

Workflows for common ViPR operationsThe workflows used to automate common ViPR operations such as provisioning storagefor an entire cluster.

Table 1 Common workflows

Workflow Used to- -In Workflow, Library > EMC ViPR > vSphere > Datastore

Create EMC ViPR VolumeSnapshot for VMFS Datastore

Creates a snapshot of a ViPR block volume.

Delete Datastore and EMC ViPRStorage

Deletes the ViPR storage, if there are no hosts associated, orsnapshots associated with the storage.

l If the storage is associated with hosts, there is an optionto delete the storage and the host associations.

l If the storage has snapshots there is an option to deletethe storage and the associated snapshots.

Expand a Datastore with EMCViPR Storage

Expands the ViPR storage and then the datastore.

Share VMFS Datastore withCluster

Shares the VMFS datstore and the ViPR storage with the hostsin a cluster.

Share VMFS Datastore withMultiple Clusters

Shares a VMFS datastore with more than one cluster.

In Workflow, Library > EMC ViPR > vSphere > Hosts/cluster

Delete Raw Disk (RDM) and EMCViPR Storage

Deletes the Raw Disk, removes the storage from the hosts,then deletes the storage.

Provision NFS Datastore forCluster with EMC ViPR Storage

Creates a ViPR file system, and datastore, and associate themwith the cluster.

EMC ViPR Plug-in for vCenter Orchestrator Overview


Table 1 Common workflows (continued)

Workflow Used to- -Provision Raw Disk (RDM) withEMC ViPR Storage

Creates a ViPR block storage volume, associates the volumewith the hosts in a cluster, and creates a corresponding RawDisk (RDM) for a virtual machine (VM).

Provision VMFS Datastore forCluster with EMC ViPR Storage

Creates a ViPR volume, and datastore, and associate themwith the cluster.

Building block workflowsBuilding block workflows are individual operations used to construct the commonworkflows. The building block workflows can also be used individually, to performgranular ViPR operations such as creating a ViPR volume.

Table 2 Building block workflows

Workflow Used to- -In Workflow, Library > EMC ViPR > General

Create EMC ViPR File System Creates a file system with ViPR storage.

Create EMC ViPR Volume Creates a block volume with ViPR storage.

Create EMC ViPR VolumeSnapshot

Creates a snapshot of the VMFS datastore.

Create Raw Disk (RDM) Creates a SCSI controller and Raw Device Mapping (RDM) onthe virtual machine (VM).

Delete EMC ViPR File System Deletes the ViPR file system, if there are no hosts associatedwith the file system, and if no snapshots are associated withthe file system.

l If the files system is associated with hosts, there is anoption to delete the storage and the host associations.

l If the file system has snapshots there is an option todelete the storage and the associated snapshots.

Delete EMC ViPR Volume Deletes the ViPR block volume, if there are no hostsassociated with the volume, and if no snapshots areassociated with the volume.

l If the volume is associated with hosts, there is an optionto delete the storage and the host associations.

l If the volume has snapshots there is an option to deletethe storage and the associated snapshots.

Delete Raw Disk (RDM) Deletes a Raw Disk Mapping (RDM) virtual disk on a virtualmachine.

Expand EMC ViPR File System Expands an ViPR file system.

Expand EMC ViPR Volume Expands the ViPR block volume to the defined size.


ViPR plug-in for vCO workflows 9

Table 2 Building block workflows (continued)

Workflow Used to- -Export EMC ViPR File System Exports an ViPR file system to a host or host cluster.

Export EMC ViPR Volume Presents a ViPR volume to a host or host cluster.

Get EMC ViPR File System MountPath for Datastore

Gets the ViPR file system mount path for a given datastore.

Get EMC ViPR Volume WWN forDatastore

Gets the ViPR block volume World Wide Name (WWN) for agiven datastore.

Provision for EMC ViPR Volumefor Hosts

Creates a volume from ViPR storage and presents it to thehosts.

Provision Raw Disk for VM nameand UUID

This workflow is a non-interactive workflow designedspecifically to work with the EMC ViPR Enablement Kit forvCenter Automation Center. Refer to the EMC ViPR EnablementKit for vCenter Automation Center White Paper for completedetails.

Multi-client integrationThe EMC ViPR plug-in for vCenter Orchestrator builds upon the vCenter Orchestratorintegration functionality to provide EMC ViPR workflow and resource management.

The multi-client support allows access either interactively or programmatically, withmaximum flexibility to assemble any solution appropriate to your environment.

When used interactively, some workflow values are populated with values correspondingto the context from which they were launched. For example, if the workflow is executedfrom a vSphere Web Client within the context of a cluster, the host cluster values areentered into the workflow.

When used programmatically, the EMC ViPR plug-in provides the capability to pass newworkflow parameters, through an external application, as required.

The functionality provided with the EMC ViPR plug-in for vCenter Orchestrator issupported by the following clients when vCenter Orchestrator is integrated with theapplication.

u vCenter Orchestrator REST API

u VMware vSphere, vCenter Server

u VMware vCloud Automation Center

Refer to EMC ViPR Plug-in Integration with Additional VMware Applications on page 20for client integration details.



CHAPTER 2

EMC ViPR and vCenter Orchestrator ConfigurationRequirements


u EMC ViPR configuration requirements....................................................................12u vCenter Orchestrator configuration requirements.................................................. 12

EMC ViPR and vCenter Orchestrator Configuration Requirements 11

EMC ViPR configuration requirementsThe EMC ViPR environment must meet specific configuration requirements to support theViPR plug-in for vCenter Orchestrator.

u Only a ViPR Tenant Administrator or Project Administrator for the Project beingconfigured, can run the workflows.

Note

ViPR roles are configured by ViPR Security Administrators from the ViPRAdministration and Self-service UI (ViPR UI).

u A ViPR System Administrator must configure the following, using the ViPR UI, ViPRAPI, or ViPR CLI prior to running any of the workflows:

l ViPR virtual assets, such as virtual storage arrays (virtual arrays), and virtualstorage pools (virtual pools) must have been created.

Note

Multi-volume consistency groups are not supported by the EMC ViPR Plug-in forvCenter Orchestrator. The ViPR plug-in does not allow users to select virtual poolsin which multi-volume consistency is enabled. However, if invoking the workflowsprogrammatically, or through an external application, provisioning fails if a virtualpool with multi-volume consistency enabled is selected.

l Hosts must have been to the virtual array, networks.

l The vCenter server must be added to ViPR.

u Each instance of the ViPR plug-in can be used to manage one instance of ViPR . Youcannot manage multiple instances of ViPR with a single instance of the ViPR plug-infor vCenter Orchestrator.

vCenter Orchestrator configuration requirementsvCenter Orchestrator must meet specific configuration requirements to support the EMCViPR plug-in for vCenter Orchestrator.

u vCenter Orchestrator version 5.1.x.

u The EMC ViPR plug-in requires that the VMware vCenter Server plug-in for vCenterOrchestrator version 5.1.x is installed on the same vCenter Orchestrator running theEMC ViPR plug-in.

u The vCenter server on which ViPR storage will be provisioned must be added to theOrchestrator Configuration interface Plug-ins menu.

u Enable the Share a unique session mode for the vCenter Server plug-in for vCenterOrchestrator before invoking the EMC ViPR workflows. Enable the Share a uniquesession mode through the vCenter Orchestrator Configuration interface, vCenterServer, New vCenter Server Host tab.

Note

vCenter Orchestrator users must be part of the Orchestrator administrator group to installand configure plug-ins.

EMC ViPR and vCenter Orchestrator Configuration Requirements


Refer to VMware vCenter Orchestrator documentation for specific configuration steps.

EMC ViPR and vCenter Orchestrator Configuration Requirements

vCenter Orchestrator configuration requirements 13

CHAPTER 3

EMC ViPR Plug-in Installation and Configuration


u Installing the EMC ViPR plug-in for vCenter Orchestrator........................................ 16u Configuring EMC ViPR and system settings............................................................ 16u Verifying the EMC ViPR plug-in installation............................................................ 17u Generating EMC ViPR workflow documentation......................................................17

EMC ViPR Plug-in Installation and Configuration 15

Installing the EMC ViPR plug-in for vCenter OrchestratorThe EMC ViPR plug-in, EMC-ViPR-vCo-Plugin.dar, is available from EMC SupportZone. Once downloaded, the plug-in is installed from the Orchestrator Configurationinterface.

Procedure

1. Download the EMC-ViPR-vCo-Plugin.dar file from EMC Support Zone.

2. Enter the VMware vCenter Orchestrator server host name in a supported browser toaccess the vCenter Orchestrator Web view.

See VMware vCenter Orchestrator documentation for a list of supported Webbrowsers.

3. Click thevCenter Orchestrator Orchestrator Configuration link.

4. Click Plug-ins, and continue to follow the vCenter Orchestrator steps for installingplug-ins.

5. When prompted, point to the EMC-ViPR-vCo-Plugin.dar file on your localmachine.

6. Once the plug-in is installed, restart the vCenter Orchestrator server host.

7. Restart both the vCenter Orchestrator and the Orchestrator Configuration server.

Note

The vCenter Orchestrator server host must be restarted before restarting the services.

Configuring EMC ViPR and system settingsSet the EMC ViPR settings and workflow timeout period from the vCenter OrchestratorConfiguration interface EMC ViPR Configuration page.

Before you begin

u vCenter Orchestrator requires users to be part of the vCenter Orchestratoradministrator group to use the Orchestrator Configuration interface.

u The ViPR user entered in the vCenter Orchestrator Configuration settings must havebeen assigned a ViPR Tenant Administrator role or a Project Administrator role for theProject being configured. ViPR roles are configured by ViPR Security Administratorsfrom the ViPR Administration and Self-service UI (ViPR UI).

u While working with EMC ViPR workflows interactively, through vCenter Orchestrator orvSphere, ViPR configuration settings behave as follows:

l The EMC ViPR hostname/IP address, username, password, port, and project arenot presented in the ViPR workflows, and can only be changed through thevCenter Orchestrator Configuration interface.

l The ViPR virtual array is a default setting, which may be automatically or manuallyset. While executing the workflow, the target virtual array is computed whenpossible. For example, if the workflow is executed within the context of a vSpherecluster, the correct virtual array for the cluster is computed by the plug-in, and setin the drop-down menu. If the virtual array cannot be computed, the virtual array,defined as the default in the vCenter Orchestrator Configuration interface is set asthe first option in the drop-down menu, followed by a list of the other available



ViPR virtual arrays. You can change the computed or default virtual array settingwhen configuring the workflow.

u When ViPR workflows are invoked programmatically from external applications, theconfigured settings act as defaults and can be overridden through the externalprogram.

Procedure

1. Launch and login to vCenter Orchestrator Configuration .

2. Click EMC ViPR Plug-in (1.0.0).

3. Enter the virtual IP address of the EMC ViPR host, and port number 4443.

Note

The port number must be 4443.

4. Enter the user credentials and resources to manage with the EMC ViPR plug-in forvCenter Orchestrator.

5. Click Verify Connection to ensure the connection is valid.

6. Select an EMC ViPR project in which to run the worklfows.

7. Select the default virtual array to use when the virtual array cannot be automaticallycomputed.

8. Select the amount of time in minutes that each ViPR operation within a workflow canrun before timing out.

9. Click Apply Changes.

Verifying the EMC ViPR plug-in installationTo verify that the EMC ViPR plug-in was correctly installed, locate the EMC ViPR foldervCenter Orchestrator > Workflows > vCenter Administrator > Library and review the list ofworkflows.

Procedure

1. Launch vCenter Orchestrator.

2. Log into the vCenter Orchestrator Clientor Web Operator.

3. Go to Workflows, and expand the vCenter Administrator > Library.

4. Expand the EMC ViPR folder to ensure the EMC ViPR workflow library is installed.

The expanded EMC ViPR folder is demonstrated in the EMC ViPR Workflow tree.

Generating EMC ViPR workflow documentationvCenter Orchestrator provides a feature for generating workflow documentation thatdescribes the workflow inputs in detail.

Before you begin

u Adobe Reader is required to generate and view the workflow documentation.

u The generate documentation feature is only available from the vCenter Orchestratorinstallable client. Documentation cannot be generated from the vCenter OrchestratorWeb Operator.


Verifying the EMC ViPR plug-in installation 17

Procedure

1. From the vCenter Orchestrator Client Workflows tab, expand the vCenterAdministrator > Library.

2. Right-click the EMC ViPR folder, and select Generate Documentation to generate anAdobe PDF document of all the EMC ViPR workflows and their parameter descriptions.

3. Optionally, expand the EMC ViPR folder, right-click on a specific EMC ViPR workflow,and click Generate Documentation to generate an Adobe PDF document of theselected workflow.



CHAPTER 4

EMC ViPR Plug-in Integration with AdditionalVMware Applications


u EMC ViPR workflow multi-client integration............................................................20u VMware vCenter Orchestrator REST API integration................................................ 20u VMware vSphere, vCenter Server integration......................................................... 20u VMware vCloud Automation Center....................................................................... 21u Workflow CPU and memory utilization................................................................... 21

EMC ViPR Plug-in Integration with Additional VMware Applications 19

EMC ViPR workflow multi-client integrationThe EMC ViPR plug-in for vCenter Orchestrator integration functionality provides EMC ViPRworkflows and resource management through additional VMware clients.

VMware integration requirements and recommendationsThe VMware environment must meet the criteria described in the following sections tosupport the EMC ViPR plug-in for vCenter Orchestrator. Refer to VMware documentationfor integration procedures and additional details.

VMware vCenter Orchestrator REST API integrationAccess and run the EMC ViPR plug-in for vCO workflows from the vCenter OrchestratorREST API.

vCenter Orchestrator REST API integration requirements

u vCenter Orchestrator REST API version 5.1 or higher.

u The default EMC ViPR host, user, project, virtual array, and virtual pool were definedwhile configuring EMC ViPR from the vCenter Orchestrator Configuration interface.

VMware vSphere, vCenter Server integrationIntegrate the workflows installed with EMC ViPR plug-in for vCenter Orchestrator with thevCenter Server. Once integrated, invoke and use the workflows through the vSphere WebClient.

VMware vSphere integration recommendations and requirements

u VMware vSphere 5.1 (or higher) – VMware vCenter Server

u vSphere requires that a Single sign-on (SSO) is configured between vSphere andvCenter Orchestrator.

u Both the EMC ViPR plug-in for vCenter Orchestrator and the vCenter Server plug-in forvCenter Orchestrator are installed on the same vCenter Orchestrator instance.

u Enable the Share a unique session mode for the vCenter Server plug-in for vCenterOrchestrator through the vCenter Orchestrator interface, before invoking the ViPRworkflows through the vCenter Server.

u One instance of the vSphere vCenter Server can be used for one ViPR instance. Asingle vCenter Server instance cannot be used to manage multiple instances of ViPR.

u EMC ViPR workflows can only be invoked from the vSphere Web Client. The workflowscannot be accessed from the locally installed vSphere Client.

EMC ViPR workflow settings

u The EMC ViPR Hostname, Username, Password, and Project are brought in with theworkflows and cannot be reconfigured when the workflows are invoked through thevSphere Web Client.

u The EMC ViPR virtual array may be set automatically or manually. While executing theworkflow, the target virtual array is computed based on the context of the workflowwhen it is invoked. If not computed, the virtual array is automatically set to the virtualarray configured for the workflows in vCenter Orchestrator. The virtual array however,can always be manually overridden when executing the workflows.

EMC ViPR Plug-in Integration with Additional VMware Applications


u If manually entering the virtual array, and the virtual pool, the virtual array and virtualpool names are not rendered in vSphere. The virtual array and virtual pool namesmust be manually typed into the fields.

VMware vCloud Automation CenterInvoke and use the ViPR plug-in workflows from vCloud Automation Center

vCloud Automation Center integration requirements and recommendations

u VMware vCloud Automation Center version 5.1.x.

u A single instance of vCloud Automation Center can be used to manage multipleinstances of ViPR for example, the ViPR username and password can be passed inprogrammatically, allowing vCloud Automation Center to have multiple usermappings. This might be done in a multi-tenant environment or an enterprise, withself-service portals that may have different configurations for different departments.

EMC ViPR workflow settings

u All the EMC ViPR workflow parameters can be passed programmatically throughvCloud Automation Center.

u The ViPR hostname, username, password, project, and virtual array that areconfigured for the workflows through the vCenter Orchestrator Configuration interfaceare set as defaults, but can be overridden by the parameters passed when invokedthrough vCloud Automation Center .

Workflow CPU and memory utilizationEMC testing has demonstrated the following resource utilization for vCenter Orchestratorwhen the ViPR plug-in is running. Results may vary in other environments.

EMC testing environmentThe setup for the EMC testing environment was configured as follows:

vCenter Orchestrator

u VMware vCenter Orchestrator version 5.1.0.0

u Guest OS — Novell SUSE Linux Enterprise 11 (64-bit)

u vCPU — 2 vCPU, processor type Intel(R) Xeon(R) E7-2860 @ 2.27 GHz

u Memory — 3072MB

Resource utilization characteristicsThe statistics measure the utilization of the vCenter Orchestrator Configuration serverprocess while executing a ViPR workflow. The two datasets below represent a basicworkflow and a complex workflow. The peak CPU utilization occurs at the end of theworkflow and is short lived. The memory utilization includes the overhead of renderingthe vCenter Orchestrator Configuration client.

Table 3 Basic EMC ViPR workflow

Resource Type Average % Peak %

CPU 1.48% 2.94%

Memory 2781.82 MB 2912 MB


VMware vCloud Automation Center 21

Table 4 Complex EMC ViPR workflow

Resource Type Average Peak

CPU 1.74% 16.58%

Memory 2940.29 MB 3064 MB



Documents

VMware vCenter Orchestrator EMC ViPR Plug-in for EMC ViPR File System Deletes the ViPR file system, if there are no hosts associated with the file system, and if no snapshots are associated