OrionReadMe_(2)

8/3/2019 OrionReadMe_(2)

1/25

Orion RESTful API

Orion RESTful API ReadMe


2/25

EMC Corporation CONFIDENTIAL AND PROPRIETARY DATE: 11/08/11

Copyright 2010 EMC Corporation. All rights reserved.

Printed 11/8/2011

EMC believes the information in this publication is accurate as of its publication date. The information is

subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO

REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN

THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OFMERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an

applicable software license.

Document Revision History

Version Date Comments

Related Documents

Author Documents

ESI SPM Configuration ii


3/25


Table of Contents

1 Overview ........................................................................................................................1

2 Deployment ...................................................................................................................1

3 Administration .............................................................................................................1

4 Management ..................................................................................................................2

4.1 Create a HostGroup for VMAX.........................................................................................................2

4.2 Map or Unmap VNX LUN.................................................................................................................2

4.3 Map or Unmap VNXe LUN ...............................................................................................................3

4.4 ISILON Support..................................................................................................................................3

4.5 VPLEX Support....................................................................................................................................3

5 Appendix: Setting up SPM with Orion....................................................................3

5.1 Storage Pool Management.................................................................................................................4

5.2 Concepts................................................................................................................................................4

5.3 Storage Type.........................................................................................................................................4

5.4 Virtualization Domain.......................................................................................................................5

5.5 SMC Server...........................................................................................................................................5

5.6 SMC GUI..............................................................................................................................................5

5.7 Prerequisites.........................................................................................................................................5

5.8 Supported Operations........................................................................................................................5

5.9 Symmetrix Management Console.....................................................................................................6

5.10 Adding User Roles.............................................................................................................................6

5.11 Register the API Server with SMC.................................................................................................8

5.12 Create Thin Pools..............................................................................................................................9

5.13 Creating a Masking View...............................................................................................................10

5.14 Add StorageAdmin Virtualization Domain Role...................................................................13

5.15 Create Storage Types......................................................................................................................15

ESI SPM Configuration iii


4/25


5.16 Create Virtualization Domains....................................................................................................16

5.17 Adding Storage to Virtualization Domains................................................................................18

5.18 Add Storage System........................................................................................................................20

ESI SPM Configuration iv


5/25


1 Overview

This document describes how to deploy Orion and how to use Orion RESTful API Server to

provision storage for ESX Clusters, Microsoft Failover Clusters, or standalone hosts. Orion

supports VMAX (and VMAXe), VNX, VNXe, and ISILON.

2 Deployment

Deploy the Orion Virtual Appliance in ESX/vCenter. When the appliance has been deployed

login to the host as Administrator with password Password1, configure the network settings, andjoin the virtual machine to a domain

When the host has successfully been added to a domain, deploy the Orion application using thefollowing steps:

1. Go to Server Manager, Roles, Web Server (IIS), Internet Information Services (IIS)

Manager.

2. Select the host in the IIS Manager pane and go to Application Pools.

3. Create a new application pool for Orion with .NET Framework v4.0.30319 as the .NET

Framework version and Integrated for the Managed pipeline mode.

4. When the new application pool has been created select the pool and go to Advanced

Settings for the pool and modify the following two options in Process Model. Set

Identity to LocalSystem and set Load User Profile to True.

5. Next select the host in the IIS Manager window and go to Sites, Default Web Site.

6. Right click on Default Web Site and select Deploy, Import Application.

7. Browse to C:\Program Files\EMC\EMC Storage Integrator and select orion_poc.zip and

accept all defaults in the Import Application Package wizard to finish the Orion

installation.

8. When the Orion application has been successfully installed select the Orion application

and in basic settings set the application pool to the new application pool created above.

3 Administration

The administration interface for VMAX (and VMAXe), VNX, and VNXe can be accessed from the

following URI:

http:///EMCRestfulService/Array/Administration

You can add an array or remove an array using this API.

ESI SPM Configuration 1


6/25


4 Management

The Orion API Server allows the user to manage the arrays added through the administration

interface. It provides APIs to create or delete a LUN and map or unmap a LUN to/from a

HostGroup. A HostGroup can be an ESX Cluster, a Microsoft Failover Cluster, or a standalone

host. The management APIs can be accessed from the following URI:

http:///EMCRestfulService/Array/ArrayTypes

The Orion API Specification is available at the following URI:

http:///Orion%20API%20Spec/Project%20Orion.htm

Theres also a demo available at the following URI:

http:///Orion%20Demo%20flash/Orion%20Demo

%20flash.html

4.1 Create a HostGroup for VMAX

Follow the steps to create a HostGroup for VMAX:

1. Copy wwns.xml from C:\Program Files\EMC\EMC Storage

Integrator\ConfigFileSamples to C:\.

2. Edit the content of the file based your configuration. The ClusterName could be an ESX

Cluster name, a Failover Cluster name, or a standalone host name. The Node WWN andPort WWN must be listed for each host HBA port on each server.

3. The CreateHostGroup API can be accessed by the following URI:

http:///EMCRestfulService/VMAX//HostGroup/CreateHostGroup

4. The HostGroup name has to be exactly the same as the ClusterName in the XML config

file.

4.2 Map or Unmap VNX LUN

Follow the steps to map or unmap a VNX LUN to/from a HostGroup:

1. Copy wwns.xml from C:\Program Files\EMC\EMC StorageIntegrator\ConfigFileSamples to C:\.

2. Edit the content of the file based your configuration. The ClusterName could be an ESX

Cluster name, a Failover Cluster name, or a standalone host name.

3. The MapToHostGroup API can be accessed by the following URI:



7/25


http:///EMCRestfulService/VNX//Pool//LUN//MapToHostGroup

4. The UnmapFromHostGroup API can be accessed by the following URI:

http:///EMCRestfulService/VNX//Pool//LUN//UnmapFromHostGroup

5. The HostGroup name has to be exactly the same as the ClusterName in the config file.

4.3 Map or Unmap VNXe LUN

Follow the steps to map or unmap a VNXe LUN to/from a HostGroup:

1. Copy iqns.xml from C:\Program Files\EMC\EMC Storage

Integrator\ConfigFileSamples to C:\.

2. Edit the content of the file based your configuration. The ClusterName could be the ESX

Cluster name, the Failover Cluster name, or a standalone host name.

3. The MapToHostGroup API can be accessed by the following URI:

http:///EMCRestfulService/VNXe//Pool//LUN//MapToHostGroup

4. The UnmapFromHostGroup API can be accessed by the following URI:

http:///EMCRestfulService/VNXe//Pool//LUN//UnmapFromHostGroup

5. The HostGroup name has to be exactly the same as the ClusterName in the config file.

4.4 ISILON Support

For Isilon support, create a folder C:\devel\Orion and copy the 3 Isilon XML files from

C:\Program Files\EMC\EMC Storage Integrator\ConfigFileSamples to the newly created

C:\devel\Orion folder, and modify the files based on your configuration.

4.5 VPLEX Support

VPLEX support is not available at this time.

5 Appendix: Setting up SPM with Orion



8/25


Orion uses Storage Pool Management (SPM) to provision storage on VMAX and VMAXe. In this

appendix, how to setup SPM to work with Orion will be described.

5.1 Storage Pool Management

SPM is integrated with Symmetrix Management Console (SMC). Using SMCs SPM feature, a

storage administrator creates a Virtualization Domain that corresponds to an Orion API Serverwith physical pooled storage. This pooled storage resource enables the Orion user to allocate the

storage resources, similar to the way that CPU and memory resources are subdivided.

5.2 Concepts

SPM introduces two new concepts:

Storage Type

Virtualization Domain

These concepts are critical in bringing storage provisioning to the Orion users.

5.3 Storage Type

A Storage Type is simply a label that the Orion user utilizes to select the storage he wants. It is

defined by a storage administrator during SPM configuration and is utilized by an Orion userwhen provisioning storage. This makes it simple for a user to provision the type of storage he

wants.

The Storage Administrator defines the types of storage available to the Orion user in one of two

ways:

Using any already defined Fully Automated Storage Tiering (FAST) tier.

Creating a custom type.

Custom types are created by selecting the properties of the physical storage:

Disk type (SATA, Fibre Channel (FC), Flash (EFD))

Disk speed (7200, 10,000, 15,000)

RAID configuration (RAID6 (14+2), RAID6 (6+2), RAID5 (7+1), RAID5 (3+1))

The Storage Administrator can use this label to describe storage. For example, RAID6 (6+2),10,000 RPM, FC storage can be called Silver and RAID6 (14+2), 15,000 RPM, FC storage can be

called Gold, etc.



9/25


5.4 Virtualization Domain

While SPM allows Orion users to provision storage, it recognizes that the Storage Administrator

still owns and controls the array, and as such must be able to set boundaries around what storage

that users can provision. These boundaries are defined by a virtualization domain.

The virtualization domain represents an Orion API Server corresponding to a Symmetrix array.It contains information about the API Server, e.g., the Machine GUID. It also contains other

information needed to provision storage, such as the masking views to use, and the physical

storage (thin pools) from which the Orion users will actually provision their storage. Finally, the

Storage Administrator can attach policies to the virtualization domain that specify the policies

that can restrict or limit how Orion users can provision the storage.

The name of a virtualization domain should be the name of the API Server without

extension, i.e., laqa2062. This also means there could be more than one virtualization

domains with the same name in the same SMC server, but each corresponding to a

different Symmetrix array.

Multiple thin pools can be added to the same virtualization domain, as long as they are

from the same array and are different storage types. Therefore, it would be possible for a

virtualization domain to have 50 GB of gold storage, 200 GB of silver storage and 400 GB

of bronze storage.

5.5 SMC Server

The SMC server is the server component of the EMC element manager for the Symmetrix array.

It allows a storage administrator to control one or more Symmetrix arrays through its browser based GUI. The SMC server stores the SPM data and performs SPM functions as requested by

the system administrator through the SMC GUI, and the Orion users through the Orion API

Server.

5.6 SMC GUI

The SMC GUI is a client front end to the SMC server. It is accessible through a web browser.

5.7 Prerequisites

SMC is required for the VMAX/VMAXe support in Orion. The minimum supported version of

SMC is 7.3. SMC can be installed on the same host where Orion is installed; or it can be installedon a different host. See the section Create Virtualization Domains on the requirements about

the storage connectivity of the SMC server when creating Virtualization Domains.

5.8 Supported Operations

In order to provision LUN for a host or a cluster, the Symmetrix array has to be locally connected

to the host or cluster member nodes first. For provisioning a cluster, this functionality is only

supported for local cluster, meaning all cluster member nodes will have to see the same storage.

The API Server itself is not required to connect to any Symmetrix array locally.



10/25


Only Fibre Channel is support for Symmetrix in Orion. iSCSI is not supported.

Only thin LUNs are supported for storage provisioning.

Symmetrix VMAX and VMAXe are supported for storage provisioning.

The following sections explain in details how to set up a Storage Pool Management environmentto work with Orion and how to use SPM to provision storage for hosts and clusters. Storage Pool

Management is integrated with Symmetrix Management Console (SMC).

5.9 Symmetrix Management Console

The first step in setting up the Storage Pool Management is to install the SMC. After installation,

you can open the following web site on the server where you installed SMC to connect to SMC:

http://localhost:7070/sem

You can use username smc and password smc to initially login to SMC.

5.10 Adding User Roles

In SMC, roles are used to determine the operations that the users can perform on the array or on

a component within an array. A user with Administrator role can create or delete an SMC

account and assign roles. A user must have the StorageAdmin role to setup the Storage Pool

Management environment. An Administrator user must be defined before using Virtualization

Domains.

After logging in initially with smc account, user can create a SMC account with the Administrator

role and to create an account with the StorageAdmin role.

To add a role for an SMC user, go to the Tasks view in SMC.



11/25


Go to Administration >Security >Manage Roles and open the Manage Roles dialog box as shown

below:

Click the Add button to add a user with StorageAdmin role.



12/25


5.11 Register the API Server with SMC

In this step, an API Server needs to be registered as a trusted client with the SMC server. To

perform this operation, you must be a user with the Administrator or SecurityAdmin role. See

section Adding User Roles to add a user with Administrator or SecurityAdmin role.

Users planning on launching SMC from their respective clients, must be assigned a role withinSMC that will allow them to manage the Symmetrix array from SMC. For Orion users, the

StorageAdmin Virtual Domain role must be assigned within SMC.

To register a client with the SMC Server, go to the Tasks view in SMC. Go to Administration >

Link and Launch > Manage Launch Clients to open the Manage Launch Clients Client

Registration dialog box.

Click Add to open the Manage Launch Clients Add Client dialog box. Select a Client Type as

SPM. Specify a unique Client ID to identify the API Server you are registering.



13/25


5.12 Create Thin Pools

Use SMC to create thin pools. Thin pools contain DATA devices of the same emulation and sameconfiguration.

To create a thin pool, right click the Symmetrix ID in SMC. Select Device Pool Management >

Create Device Pool to open the Device Pool Management Create Device Pool dialog box.

Specify a Pool Name and select a Pool Type of Thin. Select an Emulation type of FBA. Add one

or more devices to the thin pool. Tick Enable New Pool Member. Click OK to start creating the

thin pool.

You have to click Enable New Pool Member to enable capacities. Otherwise, you cannot add thisthin pool to the Virtualization Domain. You can always right click the thin pool after it is created

and choose Device Pool Management > Enable All Pool Members if you didnt enable them

initially.



14/25


5.13 Creating a Masking View

The next step is creating a masking view for each of the Clusters and standalone hosts managed

by the API Server to which LUNs will be provisioned. Each masking view should include the

following:

A storage group that contains at least a single device that will not be used unless adopted higher.

A port group whose ports are in the same zone as the ports in the clusters and standalone hosts.

An initiator group that contains all the WWNs for each FC port on each server in the cluster or

standalone server, regardless of whether the port is in use or zoned in the array. Note that SPM

supports cascaded initiator groups. Therefore, if the cluster server ports are in more than oneinitiator group, you can create a single initiator group.

To create a storage group, right click the Symmetrix ID in SMC. Select Device Masking and

Mapping > Storage Groups Maintenance > Create Storage Group to open the Storage GroupManagement Create dialog box.



15/25


To create a port group, right click the Symmetrix ID in SMC. Select Device Masking andMapping > Port Groups Maintenance > Create Port Group to open the Port Group Management

Create dialog box.



16/25


To create an initiator group, right click the Symmetrix ID in SMC. Select Device Masking andMapping > Initiator Groups Maintenance > Create Initiator Group to open the Initiator Group

Management Create dialog box.



17/25


To create a masking view, right click the Symmetrix ID in SMC. Select Device Masking and

Mapping > Masking Views Maintenance > Create Masking View to open the Masking View

Management Create dialog box.

5.14 Add StorageAdmin Virtualization Domain RoleAdd a StorageAdmin Virtualization Domain role to each thin pool and storage group. This will

authorize the Orion user to manage the thin pools and storage groups you will be adding to the

Virtualization Domain. This step must be performed by a user with a SecurityAdmin role.

To add the StorageAdmin Virtualization Domain role, go to the Tasks view in SMC. Go to

Administration > Security > Manage Roles and open the Manage Roles dialog box. Click the

Add button.



18/25


Select the Symmetrix ID to which you want to add a role.

Specify a Virtualization Domain Name. This is the name of the API Server (without

extension).

Select the type of component (Component Type) to which the Orion user will have

access. Possible values are: Thin Pool or Storage Group.

Specify the name of the component (Component Name), or click Select to open a dialog

box from which you can select the component. Storage group and thin pool names are

case sensitive.



19/25


5.15 Create Storage Types

A SPM user needs to create a Storage Type from an existing Symmetrix tier or from a set of

physical storage properties.

A Storage Type is a label for a particular type of storage, defined by a storage administrator

during SPM configuration, and used by an Orion user when provisioning storage. For example,instead of provisioning 50 GB of RAID 5 3+1 storage on 10,000 RPM fibre channel drives, an

Orion user can simply provision 50 GB of Silver or 50 GB of Tier2 storage.

To perform this operation, you must be a user with the StorageAdmin role.

To create a Storage Type, go to the Tasks view in SMC. Go to Operations > Virtualization

Management > Manage Storage Types to open the Storage Type Manager dialog box.

Click Create to open the Create Storage Type dialog box. You can create the Storage Type using

the attributes of an existing Symmetrix Tier or create a Custom Storage Type.



20/25


To create the Storage Type using an existing Symmetrix tier, click Select to open the Select Tier

dialog box, select a Symmetrix ID, a tier, and click OK. Notice that the RAID Type and Disk Type

fields are populated with attributes of the selected tier. You cannot edit these fields.

To create a custom Storage Type, specify a Name for the Storage Type. Storage Type names must

be unique from other Storage Types and cannot exceed 64 characters. Only alphanumeric

characters and underscores (_) are allowed. Storage Type names are case insensitive. Its

optional to select a RAID Type or a Disk Type (drive technology and speed) for the Storage Type.Click OK.

5.16 Create Virtualization Domains

Now you need to create the Virtualization Domains with the masking views you created earlier.

A Virtualization Domain is a set of boundaries used to limit the physical Symmetrix storage (thin

pools) in which an Orion user can create LUNs. Each thin pool contains storage of a particular

type, defined by the Storage Types with which they are labeled. It is by these Storage Types that

Orion users will see the storage.

To perform this operation, you must be a user with the StorageAdmin role.

The Virtualization Domain must have authorizations on the storage groups in the masking views

you plan on assigning to it. To do this, you must add a StorageAdmin Virtualization Domainrole to each storage group.



21/25


An Admin user must be defined before using Virtualization Domains. You can build

Virtualization Domains without defined authorizations, however, they will not work until

authorizations have been defined AND an admin user role has been created.

To create a Virtualization Domain, expand the Symmetrix ID to reveal the Virtualization

Domains folder in the navigation tree of SMC. Right click the Virtualization Domains folder and

select Virtualization Domain Management > Create Virtualization Domain to open theVirtualization Domain Management Create Virtualization Domain dialog box.

Note: In order to create a Virtualization Domain for a Symmetrix array in the SMC server, this

Symmetrix array must be locally connected to the SMC server if SMC uses local mode to connectto Solutions Enabler, or locally connected to the Solutions Enabler server if the remote mode is

used.



22/25


Select the StorageAdmin Virtualization Domain role (Virtualization Domain Name) to

which the Virtualization Domain is to be assigned. This should be the same as the APIServer name (without extension) as described earlier.

Specify the API Server ID (vCenter GUID) to assign to the Virtualization Domain. The

API Server ID is the MachineGuid 83ac76f3 351e 4b44 89c3 6d333f99843b from the

registry Computer\HKLM\Software\Microsoft\Cryptography on the API Server.

Specify the Maximum Number of LUNs the user can provision in the Virtualization

Domain.

Specify the Minimum LUN Size the user can provision in the Virtualization Domain.

Specify the Maximum LUN Size the user can provision in the Virtualization Domain.

The Enforce Pre Created LUNs is optional. Selecting this option specifies that the user

can only create LUNs of the size and type specified in the pre created LUN policy

associated with the Virtualization Domain.

Assign a masking view to the Virtualization Domain by selecting it in the Available list

and clicking Add to move it to the Target list. Repeat this step for each view you want to

assign to the domain. You can only assign one view for each Cluster or standalone server

that the storage in the Virtualization Domain will service.

o An initiator group cannot be attached to a virtualization domain multiple times.

Therefore, as you move masking views to the Target list, any masking view that

shares an initiator group with a masking view in the Target list will be removedfrom the Available list.

Click OK.

5.17 Adding Storage to Virtualization Domains

This step adds the storage resources (thin pools or Fast VP policies) you created earlier to theVirtualization Domains. By doing this, all or part of the storage resources will be made available

for provisioning by ORION users. Once you have added a thin pool or FAST policy, the capacityyou assigned to the Virtualization Domain will be visible to the ORION user.

You must be a user with the StorageAdmin role to perform this operation.

The Virtualization Domain must have authorizations on the thin pool you are adding to it. To dothis, you must add a StorageAdmin Virtualiation Domain role to the thin pool.

The thin pool or FAST policy must have available enabled capacity.

To add a thin pool or FAST policy to a Virtualization Domain, expand the Symmetrix ID in the

navigation tree of SMC, and select Virtualization Domains folder to display a list of Virtualization

Domains.



23/25


Right click the Virtualization Domain and select Virtualization Domain Management > Add

Thin Pool to open the Virtualization Domain Management Add Storage Resource dialog box.

Select the thin pool or FAST policy to add to the Virtualization Domain.

Select a matching Storage Type to describe the thin pool if Thin Pool is selected. This list

will be empty if the devices in the selected thin pool do not match any of the defined



24/25


Storage Types. In which case, you must select another pool, or create a matching Storage

Type.

Minimum Capacity to Use is the minimum amount (zero) of the thin pools available

capacity that can be added to a Virtualization Domain.

Maximum Capacity to Use is the maximum amount of the thin pools available capacity(not being used by non SPM thin devices and not assigned to other Virtualization

Domains) that can be added to a Virtualization Domain.

Specify how much of the thin pools capacity to allocate to the Virtualization Domain(Capacity to Use). Possible values must be greater than or equal to the Minimum

Capacity to Use and less than or equal to the Maximum Capacity to Use.

Click OK.

5.18 Add Storage System

After setting up the Storage Pool Management environment in SMC, the user can use Orion API

Server to register with the SMC server. For example, the user can add a VMAX array from thefollowing Administration interface URI:

http://laqa2062/EMCRestfulService/Administration/VMAX/AddArray



25/25


This web page accepts the hostname or IP address of an SMC server, the secure port for

communication to SMC, a client ID, a password, and a certificate name.

Spm Server Address is the hostname or IP address of an SMC server.

The Spm Server Port must be the secure (HTTPS) communication port configured for the

SMC server by the Storage Administrator. Values must be in the range 1 65535.

The client ID is provided by a Storage Administrator and may not contain the /character.

The password must be supplied by the Storage Administrator along with the client ID.

The Entity ID is a certificate name. The certificate name is used to select a certificate from

the Windows certificate store to ensure integrity of all messages with the SMC server.The value provided is used to retrieve a certificate from the certificate store. If no

certificate with this value exists, a self signed certificate will be generated automatically.The certificate name may not contain a slash (/).

Bypass Server Certificate Validation. If this field is true, it means the user agrees to

accept the messages sent from the SMC server. This field must be set to true for the AddStorage to be successful. If this field is false, communication with the SMC server will

fail and the storage system will not be added to the API Server.

After the VMAX Storage System is added, it can be seen from both the administration API

(http://