BMC Atrium Orchestrator Application Adapter for EMC ...€¦ · Table of Contents 2 BMC Atrium Orchestrator Application Adapter for EMC Storage Version 1.1.03 Table of Contents Actor

User Documentation October 2012

BMC Atrium OrchestratorApplication Adapter for EMCStorageVersion 1.1.03

Table of Contents 2

BMC Atrium Orchestrator Application Adapter for EMC Storage

Version 1.1.03

Table of Contents...........................................................................................................................7Actor Adapter

...........................................................................................................................9Monitor Adapter

...........................................................................................................................10Adapter Module Life Cycle

...........................................................................................................................11Supported Storage Devices

...........................................................................................................................12Installing the Adapter

...........................................................................................................................16Prerequisites for the Adapter

...........................................................................................................................24Configuring the EMC Adapter

...........................................................................................................................27Support for Multiple Configuration

...........................................................................................................................28Enabling the Debug Mode

...........................................................................................................................30Top-level Processes

...........................................................................................................................31SetupValidation

...........................................................................................................................32Utilities

...........................................................................................................................33Version Directory

...........................................................................................................................35EMC Storage Actor Adapter

...........................................................................................................................36Additional Information for Writing an Adapter request

...........................................................................................................................36Synchronous and Asynchronous Operations

...........................................................................................................................37Storage System Operations

...........................................................................................................................37Operation: get-storage-system

...........................................................................................................................39Operation: refresh-storage-system

...........................................................................................................................41Storage Pool Operations

...........................................................................................................................41Operation: create-storage-pool

...........................................................................................................................44Operation: get-storage-pool

...........................................................................................................................48Operation: delete-storage-pool

...........................................................................................................................50Operation: get-raid-level

...........................................................................................................................52Operation: expand-storage-pool

...........................................................................................................................54Disk Operations

...........................................................................................................................54Operation: get-disk

...........................................................................................................................57LUN Operations

...........................................................................................................................57Operation: create-lun

...........................................................................................................................59Operation: get-lun

...........................................................................................................................62Operation: delete-lun

...........................................................................................................................64Operation: expand-lun

Table of Contents 3


Version 1.1.03

...........................................................................................................................67Job Operations

...........................................................................................................................67Operation: get-job

...........................................................................................................................70Storage Group Operations

...........................................................................................................................70Operation: create-storage-group

...........................................................................................................................74Operation: get-storage-group

...........................................................................................................................78Operation: delete-storage-group

...........................................................................................................................81Operation: get-masking-group

...........................................................................................................................87Operation: create-masking-group

...........................................................................................................................91Operation: delete-masking-group

...........................................................................................................................96Operation: add-host-to-storage-group

...........................................................................................................................98Operation: add-lun-to-storage-group

...........................................................................................................................100Operation: add-port-to-storage-group

...........................................................................................................................103Operation: remove-host-from-storage-group

...........................................................................................................................105Operation: remove-lun-from-storage-group

...........................................................................................................................107Operation: remove-port-from-storage-group

...........................................................................................................................109Operation: get-host

...........................................................................................................................110Operation: get-port

...........................................................................................................................115Operation: provision-server

...........................................................................................................................118Operation: decommission-server

...........................................................................................................................121Polling Monitor Adapter Configuration

...........................................................................................................................122Monitor Events

4


Version 1.1.03

You can obtain technical support by using the Support page on the BMC Software Web site or bycontacting Customer Support by telephone or email. To expedite your inquiry, please see "BeforeContacting BMC Software."

Support Web Site

You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support_home. From this Web site, you can

Read overviews about support services and programs that BMC Software offers:

Find the most current information about BMC Software products

Search a database for problems similar to yours and possible solutions

Order or download product documentation

Report a problem or ask a question

Subscribe to receive email notices when new product versions are released

Find worldwide BMC Software support center locations and contact information, includingemail addresses, fax and telephone numbers

Support by Telephone or Email

In the United States and Canada, if you need technical support and do not have access to the Web,call 8005371813. Outside the United States and Canada, please contact your local support centerfor assistance. To find telephone and email contact information for the BMC Software support centerthat services your location, refer to the Contact Customer Support section of the Support page on theBMC Software Web site at http://www.bmc.com/support_home.

Before Contacting BMC Software

Before you contact BMC Software, have the following information available so that Customer Supportcan begin working on your problem immediately:

Product information

product name

Product version (release number)

Operating system and environment information, machine type, operating system type, version,and service pack or other maintenance level, such as:

PUT or PTF

system hardware configuration

serial numbers

related software (database, application, and communication) including type, version, andservice

pack or maintenance

level

Sequence of events leading to the problem

Commands and options that you used

Messages received (and the time and date that you received them)

product error messages

messages from the operating system, such as "file system full"

http://www.bmc.com/support_homehttp://www.bmc.com/support_homehttp://www.bmc.com/support_home

5


Version 1.1.03

messages from related software

6


Version 1.1.03

What's NewWorkflows are now available for all operators in the BMC Operator Control Panel.

Three new operations are available for the Symmetrix arrays running Enginuity 5874 or above: get-masking-group, create-masking-group, and delete-masking-group.

New request elements are available for the Symmetrix arrays running Enginuity 5874 or above:

the device-group-name, initiator-group-name, and port-group-name, elements whichare available in the get-storage-group operation.

the initiator-group-to-cascade and fast-policy-name elements, which are available inthe create-storage-group operation.

the delete-device-group, delete-initiator-group, and delete-port-group elements,which are available in the delete-storage-group operation.

An initiator group can now be cascaded to an existing masking view on Symmetrix arraysrunning Enginuity 5874 or above.

A FAST policy can now be associated to storage groups on Symmetrix arrays running Enginuity5874 or above.

Changes and ImprovementsFor a better readability, the formatting of the error messages has been improved.

Existing port and initiator groups can now be specified when creating a new storage group.

All the adapter response elements are now documented.

Fixed IssuesOperation: get-storage-group: In some cases, the value of the element wasdisplayed twice.

Operation: get-storage-pool: The value of the element wasnot calculated properly.

7Actor Adapter


Version 1.1.03

Actor Adapter

The actor adapter for EMC Storage executes operations on an EMC storage system through the EMCSMI-S Provider (also known as ECOM) and the WBEM protocol.

Actor Adapter Function in BMC Atrium Orchestrator (EMC Clariion)

Function of Actor Adapter in BMC Atrium Orchestrator (EMC Clariion)

8Actor Adapter


Version 1.1.03

Actor Adapter Function in BMC Atrium Orchestrator (EMC Symmetrix)

Function of Actor Adapter in BMC Atrium Orchestrator (EMC Symmetrix)

9Monitor Adapter


Version 1.1.03

Monitor Adapter

A monitor adapter obtains data from an external system and generates an event message.Depending on the monitor adapter, it can obtain data by

pulling data from an external system by polling the system

receiving data that is pushed from an external system

The event is evaluated by rules and can trigger specific workflow processes when the rule criteria aremet.

Monitor Adapter Function in BMC Atrium Orchestrator

10Adapter Module Life Cycle


Version 1.1.03

Adapter Module Life Cycle

An adapter module contains a set of processes, schedules, rules, and configurations. You can createschedules and rules to trigger process execution. Each operation supported by the applicationadapter has a corresponding process in the adapter module. The figure below outlines the stepsrequired to work with an adapter module.

Adapter Module Life Cycle

11Supported Storage Devices


Version 1.1.03

Supported Storage Devices

BMC Atrium Orchestrator Application Adapter for EMC Storage leverages the EMC SMI-S Provider tointeract with the EMC storage systems. The adapter supports versions of the EMC SMI-S Providerstarting from version 4.1.

In turn, the EMC SMI-S Provider supports a wide range of EMC storage systems to interact with,including Symmetrix and CLARiiON disk arrays.

Supported Symmetrix arrays

Symmetrix DMXSeries (DMX-4, DMX-3, DMX-2)

Symmetrix V-Max Series

Supported CLARiiON arrays

CX4 Series, CX3 Series, CX Series

Supported EMC VNX

EMC VNX series

EMC VNXe series

EMC Symmetrix disk arrays embed an SMI-S Provider on the management console so there is no need to install adedicated separate system.

12Installing the Adapter


Version 1.1.03

Installing the Adapter

Getting the Adapter Package

The BMC Atrium Orchestrator Application Adapter for EMC Storage can be obtained from BMC EPDWeb site and from Sentry Software Web site.

The package file name is: sentry-adapter-emc-storage-1.1.03.zip. It contains the aroar packages forboth the Actor and Monitor Adapters, as well as the corresponding module (that will be loaded intoDevelopment Studio):

sentry-adapter-emc-storage-actor_1.1.03.aroar

sentry-adapter-emc-storage-monitor_1.1.03.aroar

AO-AD-EMC_Storage.1.1.03.roar

Uploading the Package (aroar) file in the BMC AtriumOrchestrator Repository1. Use your Web browser to connect to the BMC Atrium Orchestrator Grid Manager with

administrative credentials.

2. In the Manage tab click the Upload Adapter button.

3. On the next page, select the Actor Adapter .aroar file to be uploaded and click OK.

Selecting the Actor Adapter to be uploaded

https://webapps.bmc.com/signon/content/logon.jsphttps://webapps.bmc.com/signon/content/logon.jsphttp://www.sentrysoftware.com



Version 1.1.03

4. Repeat the same operation for the Monitor Adapter.

5. The adapters are then listed in the BAO Grid Manager repository and ready to be added to theGrid and configured.

List of adapters to be added to the Grid



Version 1.1.03

Loading the module (roar) in BMC Atrium OrchestratorDevelopment Studio1. In the BMC Atrium Orchestrator Development Studio, switch to the Library Manager view

2. Open the tab Import Modules and click the From Disk button

3. Select the .roar file to be imported.

4. Click the checkbox Import and Unbundle and then click the Import button.

Loading the module



Version 1.1.03

5. Switch to Designer view, to visualize the loaded module.

Visualizing the loaded module

16Prerequisites for the Adapter


Version 1.1.03

Prerequisites for the Adapter

The solution leverages the EMC SMI-S Provider that needs to be installed on a Windows or Linuxsystem. The following procedure explains in details how to get, install and configure the EMC SMI-SProvider to enable BMC Atrium Orchestration Application Adapter for EMC Storage to efficientlyinteract with it.

EMC Symmetrix disk arrays have a pre-installed SMI-S Provider on the management console.Therefore, there is no need to install a separate SMI-S Provider to interact with an EMCSymmetrix disk array. The adapter can be configured to directly connect to the managementconsole.



Version 1.1.03

1. Install the SMI-S Provider1. Access the EMCs Powerlink website: https://powerlink.emc.com/

2. Log in with the User ID and Password provided by EMCs Powerlink. If you do not have anaccount, you can register directly on EMCs Powerlink website.

3. Click the Support tab, and then click Software Downloads and Licensing > Downloads S> SMI-S Provider

4. Select SMI-S Provider 4.1.1.1 for SMI-S 1.4 and download se7114-WINDOWS-x86-SMI.exe

EMC's Pow erlink W ebsite

https://powerlink.emc.com/



Version 1.1.03

5. Launch the se7114-WINDOWS-x86-SMI.exe.The EMC Solutions Enabler with SMI X86 welcome page appears prompting you to installSolutions Enabler with SMI version 3.3.3.

6. Click Next.

EMC Solutions Enable w ith SMI X86 W elcome Page



Version 1.1.03

7. Click Next to begin the installation.

8. The Destination Folder dialog box opens and prompts you to select an install directory forSolutions Enabler and the EMC SMI-S Provider. It is recommended that you choose the defaultdirectory.

EMC Solutions Enable w ith SMI X86 Installation Directory



Version 1.1.03

9. Click Next to continue.The Provider list dialog box opens.

10. Select both Array Provider and Host Provider.

EMC Solutions Enable w ith SMI X86 SMI Providers List

11. Click Next to continue.The Ready to Install Program dialog box opens.

EMC Solutions Enable w ith SMI X86 Start Installation



Version 1.1.03

12. Click Install to begin installing files to your selected folder.This may take several minutes.

13. When the Installation Wizard Completed dialog box opens, click Finish to complete the setup.

When the installation procedure is completed, update your environment variable for the path toinclude the Solutions Enabler installation directory, which by default is C:\ProgramFiles\EMC\SYMCLI\bin, in order to run the command line utilities from any directory.

2. Add Clariion Disk Array to the Installed SMI-SProvider1. Navigate to the C:\Program Files\EMC\SYMCLI\storbin and run TestSmiProvider.exe

2. For connection type, type ssl

3. For Host, type enter

4. Repeat the operation for Port, Username, Password, Log output to console and Log output tofile:

type addsystype y (yes)type 1 (Default for CLARiiON)type xxx.xxx.xxx.xxx (SPA IP Address of the Clariion array)type xxx.xxx.xxx.xxx (SPB IP Address of the Clariion Array)

type entertype 2 type 2 type the username (type a user that has at least a read access on the Clariion Array) type the password (password of the above user)

then type enter



Version 1.1.03

5. A message meaning that the Clariion Array has been added is displayed as shown on the picturebelow



Version 1.1.03

3. Add a User to SMI-S provider 1. Access https://:5989/ecomconfig, where is either the IP address of the

name of the SMI-S Provider host

2. Log in using the username admin and #1Password as password.

3. Click Add User and create a user with the role of Administrator. This newly created usernamecan now be used to obtain access to the Array Provider.

4. Add authorization information1. Shut down the EMC CIM Server: (The service name is ECOM.exe and it displays as ECOM in the

Services control panel.)

2. Use the SYMCLI symcfg command, as shown in the following syntax example, to add theusername and password for each CLARiiON storage processor: >symcfg authorization add -hostHostName -username UserName -password PassWord

3. Add authorization for CLARiiON storage processor A with IP address , username clariionand password clarpass, using the following command: symcfg auth add -host 172.23.193.86 -username clariion -password clarpass

4. Then, repeat the operation with CLARiiON storage processor B

You must list the information for storage processor A first, then storage processor B. Any time alocally-attached CLARiiON is added to the EMC SMI-S Provider, the EMC CIM Server must first beshut down. Once shut down, the authorization information can be added as described previouslyand the EMC CIM Server must be restarted.

5. Start EMC CIM Server

https://:5989/ecomconfig

24Configuring the EMC Adapter


Version 1.1.03

Configuring the EMC Adapter

You configure an adapter in the Grid Manager. The configuration provides information about how theadapter connects to the EMC SMI-S Provider. While each adapter must have a unique name, you cancreate multiple adapters with the same adapter type to allow for different configuration properties.

The form view provides an easy-to-use interface for configuring adapters. The form view preventshuman errors that might occur as a result of copying the configuration XML from the adapter userguide into the UI when configuring an adapter. You can switch to the XML view to configure thoseelements and attributes that are not available as fields or to configure all the elements and attributesusing XML only. However, after you switch to the XML view, and save the configuration in the XMLfrom that view, you cannot thereafter use the form view for modifying that configuration.

Before adding an adapter configuration, ensure that you have completed all the prerequisite tasks.

To configure the actor adapter, monitor adapter, or both1. Log on to the BMC Atrium Orchestrator Grid Manager.

2. Access the adapters page, by clicking the Manage tab; then click the Adapters tab.

3. In the Adapters in Repository list, select the check box corresponding to the type of adapter tobe added.

4. Click Add to Grid to include the adapter in the Adapters on Grid list.

5. Click Configure corresponding to the newly added adapter.

6. On the Add an Adapter Configuration page, perform the following sub-steps to configure theadapter using the form view or jump to step 7 on page 18 to configure the adapter using theXML view:

a. A Enter a name for the adapter

b. Enter a description of the adapter

c. Under Properties, enter or select values for the configuration elements. Include all requiredelements indicated with an asterisk (*)

d. Click Switch to XML View and use the following steps to specify elements and attributesthat are not in the form view (Optional)

On the Warning message that appears, click Switch ViewIn the Properties text box, use XML format to enter the configuration elements and attributesnot available as fields in the form viewClick OK.

7. Configure the adapter in the XML view using the following sub-steps:

a. Enter a name and a description of the adapter

b. Click Switch to XML View

c. On the Warning message that appears, click Switch View

d. Copy the configuration elements and attributes form the adapter user guide into theProperties text box, and then click OK.

e. On the Warning message that appears click Save. This saves the adapter configuration withsettings in the XML view permanently. The newly configured adapter is now listed in theAdapters on Grid list.



Version 1.1.03

The table below describes the adapter configuration elements and attributes for the EMC Storageactor adapter that you can specify using the form view, XML view, or both. You cannot use the formview to configure elements and attributes that do not have an entry in the UI label column.

UI Label Element Definition Required

Config This is the parent tag wherein we specify the connectiondetails. Each element has a "name" attribute. Thevalue of attribute "name" is used to refer to a specificconfiguration when using multiple configuration.The first configuration is also the default configuration.

Yes

Target target The IP address of hostname of the system where the EMCSMI-S Provider is running, or the EMC Symmetrix Console IPaddress in the case of Symmetrix disk arrays because theEMC SMI-S Provider is pre-installed on these systems.

Yes

Port port Specifies the port number fro the EMC SMI-S Provider. Bydefault, the port is 5988 for unencrypted connections (http)and 5989 for encrypted connections (https).

Yes

Protocol Protocol Transport protocol to be used to connect to the EMC SMI-SProvider. Valid values: http, https. Usually, the EMC SMI-SProvider responds in http on port 5988 and in https on port5989.

Yes

User Name user-name Specify the login name for the EMC SMI-S Provider.This tag should not be used if the security file path is beingspecified using the tag. In that case,username saved in the user defined security file or the defaultsecurity file is used.

Yes

Password password Specifies the password for the EMC SMI-S Provider. You canencrypt the password by specifying the encryption typeattribute. For example: cGFzc3dvcmQ=. This tag should notbe used if the security file path is being specified using the tag. In that case, password saved in theuser defined security file or the default security file is used.

Yes

Timeout Secs timeout-secs Specifies the duration in seconds, after which timeout occurs.Default value: 300 seconds

No

Sample XML template for configuring the actor adapter - plainpassword

emc-01 system password https 5989 300

Sample XML template for configuring the actor adapter - encryptedBase64 password

emc-01



Version 1.1.03

system cGFzc7cdcmQ= https 5989 300

27Support for Multiple Configuration


Version 1.1.03

Support for Multiple Configuration

EMC Storage adapter is capable of connecting to multiple EMC SMI-S Providers. This is specificallyuseful to interact with several EMC Symmetrix disk arrays as they have their own SMI-S Provider pre-installed on their management console. Each is used to designate the connection criteriafor a specific EMC SMI-S Provider. Each element has a "name" attribute. This configurationname is used as a value for the tag in adapter requests.

The first configuration is also the default configuration.

The figure below is an example of how a single adapter configuration having multiple remote hosts(EMC Storage systems) can be defined for EMC Storage adapter

hostname username password http 5989 200

The element is optional, but mandatory when more than one node is defined.

28Enabling the Debug Mode


Version 1.1.03

Enabling the Debug Mode

If you encounter an issue and wish to report it to Sentry Software, you will be asked to enable theDebug Mode and provide the debug output to the Sentry Software support team.

To enable the debug mode:

1. Browse to the home path of the peer on which the workflow will be executed (ex: c:\AO\cdp).

2. Then navigate to the path c:\AO\cdp\tomcat\webapps\baocdp\WEB-INF\classes

3. Open the file log4j.xml and set the below values

4. Once the above value is set in the log4j.xml file save and close the file.

5. Restart the appropriate peer in order to take into account the modification.

6. Now all the debug information will be stored in the file sen_emc.log located at "${catalina.home}\logs (as per the example: c:\AO\cdp\tomcat\logs).

29


Version 1.1.03

Each operation supported by the application adapter has a corresponding process in the adaptermodule. Top-level processes perform high-level functions and call specialized processes insubdirectories. Each subdirectory contains process directories corresponding to the supportedoperation types.

30Top-level Processes


Version 1.1.03

Top-level Processes

The top-level processes in the Project Explorer window execute the following version-specific EMCStorage processes:

Create Items

Delete Items

Update Items

Expand Items

31SetupValidation


Version 1.1.03

SetupValidation

The processes in the SetupValidation directory contain sample values for the request elements.These sample values can be quickly changed to reflect the values in your environment. A process isprovided to test each supported method of executing operations in EMC storage system through theSMI-S Provider.

32Utilities


Version 1.1.03

Utilities

The Utilities directory contains two types of helper processes:

General processes that perform validation and error checking

Processes that create the XML documents used in adapter requests

Processes are organized into subdirectories that correspond to the supported commands.

33Version Directory


Version 1.1.03

Version Directory

The v4.0 directory contains processes that require at least the version 4 of the EMC SMI-S Provider.

In the current version of the EMC Storage adapter, there is only one version-specific directory (v4.0).Later versions of the EMC Storage adapter may implement new processes that require a specificversion of the EMC SMI-S Provider, version 5.0 for example, in which case these processes will begrouped into a separate v5.0 directory.

The operations available in v4.0 are described in details in the next chapter.

34


Version 1.1.03

Typical Adapter Request

The typical adapter request specifies the operations to be performed with the operation-nameproperty of the emc-storage-request object. Additional information for the operation to be performedcan be optionally specified in the arguments collection.

get-disk .....

Typical Adapter Response

The typical adapter response contains a metadata object reporting the success or failure of therequest. It also contains a single output object which itself contains various objects depending of therequest.

success 12 .....

35EMC Storage Actor Adapter


Version 1.1.03

EMC Storage Actor Adapter

The adapter requests for the actor adapter uses a set of elements, operation-type and operation-name, in the adapter request node to execute an API call. The set of values used to make each APIcall is referred to as an operation.

You use the information in this chapter with Call Adapter Activity to create an adapter request. Fordetailed instructions about how to use the Call Adapter Activity, see the BMC Atrium OrchestratorDevelopment Studio User Documentation.

The following table lists the process names and corresponding operations that can be performed bythis adapter:

Processes Operations Descriptions

Storage System Operations get-storage-system Get complete information about the storagesystem

Storage Pool Operations get-storage-pool Get complete information about the storage pools

create-storage-pool Create a new storage pool

delete-storage-pool Delete a specific storage pool

expand-storage-pool Allocate additional space to specific Pool

get-raid-level List the existing raid levels

Disk Operations get-disk List the existing disks

LUN Operations get-lun List the existing LUNs in the managed disk arrays

create-lun Create a new LUN

delete-lun Delete a specific LUN

expand-lun Allocate additional space to a specific LUN

Job Operations get-job Get detailed information about the job completionstatus

Storage Group Operations get-storage-group Get detailed information about a specific storagegroup

create- storage-group Create a new storage group

delete- storage-group Delete a specific storage group

create-masking-group Create a new masking group

delete-masking-group Delete a specific masking group

add-host-to-storage-group Add a host to a storage group

add-lun-to-storage-group Add a LUN to a storage group

remove-host-from-storage-group Remove a host from a storage group

36EMC Storage Actor Adapter


Version 1.1.03

remove-lun-from-storage-group Remove a LUN from a storage group

get-host Get the list of hosts visible to a storage group

get-port Get detailed information about the available FCports

add-port-to-storage-group Add a port to a storage group

remove-port-from-storage-group Remove a port from a storage group

Storage System Operation get-storage-system Get detailed information about the storagesystem

refresh-storage-system Refresh the storage system in order tosynchronous with the actions performed viaNavisphere or SMC

Additional Information for Writing an Adapterrequest

Special characters used in a text field should be wrapped in the CDATA tag.Sample text:

When executing a sample request from this user guide you must ensure that the supporting data ispresent in the EMC Storage system.

The execution of request may take time if the number of records associated with the query arelarge.

Synchronous and Asynchronous OperationsMost of the low-level processes of the Actor adapter provide two modes of operation: synchronous orasynchronous. The user can choose in which mode to operate with the tag. The validvalues for the tag are 'yes' or 'no'. By default, the low level processes operate insynchronous mode.

In asynchronous mode (no), the process sends the request to theEMC SMI-S Provider which creates a corresponding job. The process returns immediately after thecreation of the job and does not wait for the completion of the job. In this mode, the process(create-lun for example) only returns a job ID (once the input parameters have been validated andaccepted by the EMC SMI-S Provider). It is necessary to use the get-job process to check on thecompletion of the job (which can take several minutes). It is also possible to use the Monitor adapterto be notified once the specified job is completed.

In synchronous mode (yes), the process sends the request to theEMC SMI-S Provider and then wait for the completion of the job returned by the EMC SMI-S Provider.The process doesn't return until job completes (successfully or with an error) or the timeout isreached.

In general, it is recommended to use the synchronous mode as it ensures that consecutive actions ina workflow are processed in the correct order.

37Storage System Operations


Version 1.1.03

Storage System Operations

The operations described in this section allow administrators to interact with the storage systemsmanaged by the EMC SMI-S Provider.

Currently, there is two operation related to the storage systems:

get-storage-system, to list the available storage systems

refresh-storage-system, to refresh the storage system in order to synchronous with the actionsperformed via Navisphere or SMC

Operation: get-storage-systemThe get-storage-system operation lets the administrators list the available disk arrays andvirtualization controllers visible through the EMC SMI-S Provider. The operation also provides usefulinformation about each storage system, including the model and serial number, as well as its overallcapacity (total, consumed and available).

The get-storage-system operation is a prerequisite operation before allocating or deleting storageas such operations require the name of the storage system where the action is supposed to takeplace.

Adapter Request Elements for 'get-storage-system' Operation

Definition Required

operation-name

Specifies the name of the operation you want to perform.

Valid value: get-storage-system.

Yes

arguments Parent element for element. Yes

argument Specifies a list of arguments that is required for this operation Yes

target Specifies the connection information for an EMC SMI-S Provider.

Valid value: The value specified for element must be same as the valuethat has been specified for the name attribute of element in the adapterconfiguration. You can skip this element. In this case the request will be executed onthe first defined adapter configuration. You can leave this element empty. In thiscase the request will be executed on the first defined adapter configuration.

Default value: The first defined adapter configuration.

No

timeout-secs Specifies the time in seconds after which the attempt to connect to the EMC SMI-SProvider times out. The "timeout-secs" specified in adapter request overrides the valuespecified in adapter configuration.

Valid value: A numeric value which specifies the time in seconds.

Default value: 180, if no "timeout-secs" is provided in adapter configuration.

No

You can specify one or more of the following elements to retrieve specific information. If none of the elements is specified,then all the details are fetched.



Version 1.1.03

Definition Required

storage-system-name

Specifies the user defined storage system name.

Valid value: Any valid string.

Default value: None.

No

Sample Adapter Request for 'get-storage-system' Operation

get-storage-system

Adapter Response Elements for 'get-storage-system' Operation

Description

storage-system-name

Name of the storage system.

model Model of the storage system.

serial-number Number identifying the storage system.

size-bytes Size of the storage system in bytes.

size-gigabytes Size of the storage system in gigabytes.

available-capacity-bytes

Number of bytes available in the storage system.

subscribed-capacity-bytes

Total host visible capacity in bytes.

subscribed-capacity-gigabytes

Total host visible capacity in gigabytes.

operational-status

Operational status of the storage system.

operational-status-description

Detailed information about the operational status of the storage system.

Sample Adapter Response for 'get-storage-system' Operation

success 1 success 1856 22 2 locke-2



Version 1.1.03

default CLARiiON+CKM00083900053 Rack Mounted CX4_120 CKM00083900053 1435374714880 1336.797 1159926210560 1080.265 54979330048 51.203 3 Degraded SYMMETRIX+000294901120 VMAX-1SE 000294901120 27686186726640 25784.771 22112158189128 20593.552 434964660224 405.092 2 OK

Operation: refresh-storage-systemThe refresh-storage-system operation is used refresh the entire disk array in order tosynchronous the EMC SMI-S provider with any operations that was performed via the Navisphereconsole or the Symmetrix Management Console (SMC). If no specify storage system name isprovided then all the storage systems attached to the SMI-S provider will be refreshed.

Adapter Request Elements for 'refresh-storage-system' Operation

Definition Required

operation-name

Specifies the name of the operation you want to perform.

Valid value: refresh-storage-system.

Yes



target Specifies the storage system name for which the information has to be refreshed.



No


storage-system-name



No



Version 1.1.03

Definition Required


Sample Adapter Request for 'refresh-storage-system' Operation refresh-storage-system

Adapter Response Elements for 'refresh-storage-system' Operation

Description

storage-system-name


refresh-output Status of the refresh operation.

Sample Adapter Response for 'refresh-storage-system' Operation

success 1 success 34179 5 locke-2 default CLARiiON+CKM00083900053 SYMMETRIX+000294901120 0 (Success)

41Storage Pool Operations


Version 1.1.03

Storage Pool Operations

Storage Pools are logical storage entities from which volumes are created. Storage Pools can be oftwo types:

RAID Group: Physical array of disks grouped in a RAID configuration

Thin Pool: Thin Provisioning Pool, same as a RAID Group with additional thin provisioningcapabilities

The following operations allow administrators to automate the management of Storage Pool (RAIDGroup or Thin Pool) in the EMC disk arrays through EMC SMI-S Provider.

The supported operations for Storage Pools are:

create-storage-pool, to create a new pool in a storage system

get-storage-pool, to list the existing pools and their characteristics

delete-storage-pool, to remove an existing pool for a storage system

get-raid-level, to list the available RAID Levels that can be configured for a new storage pool

expand-storage-pool, to expand an existing pool for a storage system

Operation: create-storage-poolThe create-storage-pool operation sends a request to the EMC SMI-S Provider to create a newstorage pool (RAID Group or Thin Pool) in a specified storage system.

The create-storage-pool operation creates a pool whose RAID type is "Unbound", which means that itcan be chosen later when the first LUN is created.

In general, it is recommended that storage pools are manually created and configured by the SANadministrators because it is not a repetitive operation.

Adapter Request Elements for 'create-storage-pool' Operation

Definition Required

operation-name Specifies the name of the operation you want to perform.

Valid value: create-storage-pool.

Yes




Valid value: The value specified for element must be same as the valuethat has been specified for the name attribute of element in the adapterconfiguration. You can skip this element. In this case the request will be executedon the first defined adapter configuration. You can leave this element empty. In thiscase the request will be executed on the first defined adapter configuration.


No



Version 1.1.03

Definition Required



Default Value: 180, if no "timeout-secs" is provided in adapter configuration.

No


storage-system-name


Valid value: Please refer to the get-storage-system operation to list the valid valuesof this field.


Yes

pool-type Specifies the type of the pool to be created.

Valid value: RG, or TP

Default value: On Symmetrix systems, TP will be considered as the default pooltype, while on Clariion systems, RG will be considered as the default pool type.

No

disk-type Specifies the type of the disks that must be used to create the storage pool.

Valid value: None.


No

thin-pool-name Specifies the name of the thin pool that must be created. This element is applicableonly if the 'pool-type' is TP. There is a constrain in the length of the pool name. Bydefault, only the first 12 characters will be considered.

Valid value: Any valid string


No

synchronous Wait until the job completes.

Valid value: yes | no

Default value: yes

No

job-completion-timeout-secs

Specifies the time in seconds after which the attempt to complete the job times out.


Default value: 180 seconds

No

raid-level

OR

number-of-disks

OR

disk-name

OR

lun-name

Specifies the RAID level of the storage pool to be created, or the number of disks forthe storage pool, or the disk names/LUN name(s) use to create the storage pool.

Valid value: Any value. Please refer to the get-raid-level operation to retrieve a listof available RAID levels, or the get-disk operation to retrieve a list of availabledisks, or to the get-lunoperation to retrieve the available LUN

Default value: None

If no value is specified, the storage pool is created with an "Unbound" RAID level. Thismeans that the RAID level of the storage pool will be definitely assigned upon the firstLUN creation.

Important Information

1. When the number of disks is user-specified (manually), the RAID level isautomatically selected and the disk name are automatically selected according tothe information provided in the following table:

Yes



Version 1.1.03

Definition Required

ForCLARiiONStorageSystemsOnly

Number of Disks RAID Level

2 RAID 1

3 or greater RAID 5

2. When the RAID level is user-specified (manually, the number of disk and the diskname is automatically selected according to the information provided in thefollowing table.

RAID Level Number of Disks

RAID 0 3

RAID 1 2

RAID 1/0 2

RAID 3 5

RAID 5 3

RAID 6 4

3. When the disk name is user-specified (manually), the RAID level must also bemanually specified. If the RAID level is not provided, then the create-storage-pooloperation creates a pool whose RAID level type is "Unbound", which means that itcan be chosen later when the first LUN is created.

raid-level

OR

lun-name

OR

size-bytes

ForSYMMETRIXStorageSystemsOnly

Specifies the RAID level, or the LUN name(s), or the size-bytes used to create thestorage pool.Valid value: Any value. Please refer to the get-raid-level operation to retrieve the list ofavailable RAID levels, or to the get-lun operation to retrieve the available LUN(s) oftype Data Device.Default value: None

Important Information

1. When the RAID level is user-specified (manually), the element size-bytes must bespecified, in order to create a new data device with the requested raid level.

2. When the size-bytes is user-specified (manually) and the raid level is not specifiedthen the default raid level of the primordial pool is considered.

3. When the LUN name is user-specified (manually), the specified LUNs are used tocreate the pool.

Note: make sure the specified LUN(s) is(are) of type data device and created fromthe same type of disk group.

Yes

Sample Adapter Request for 'create-storage-pool' Operation

create-storage-pool CLARiiON+CKM00083900053 RG 0_0_0 0_0_1 0_0_6 yes 180



Version 1.1.03

Adapter Response Elements for 'create-storage-pool' Operation

Description

storage-system-name


raid-group Name of the RAID group.

job-id Number identifying the job.

job-status Status of the job.

job-status-description

Detailed information about the job status.

Sample Adapter Response for 'create-storage-pool' Operation

success 1 success 25422 7 pythagoras-p27p pythagoras-p27p < storage-pool> CLARiiON+CKM00083900053 0003 260920567 Completed Completed Storage pool Create

Operation: get-storage-poolThe get-storage-pool operation lists all of the available storage pools in the specified storagesystem as well as their characteristics (type, RAID level and available space notably).

This operation is almost a prerequisite to the create-lun operation to be able to specify in which poola LUN needs to be created.When no storage-system-name is specified, the operation lists all of the storage pools available inall storage systems (visible to the EMC SMI-S Provider). This can be useful to easily identify whichdisk arrays have the most space available.



Version 1.1.03

Adapter Request Elements for 'get-storage-pool' Operation

Definition Required


Valid value: get-storage-pool.

Yes






No




No


storage-system-name




No

raid-grouporthin-pool

Returns only the specified RAID group or thin pool details.

Valid value: None.


No

pool-type Returns only the specified pool type details.

Valid value: RG, or TP


No

Sample Adapter Request for 'get-storage-pool' Operation

get-storage-pool



Version 1.1.03

Adapter Response Elements for 'get-storage-pool' Operation

Description

storage-system-name


pool-type Type of pool. Possible values: RG or TP


raid-level RAID level of the storage pool.

disk-name Name of the disk.

disk-type Type of disk.

number-of-disks

Number of disks available in the storage pool.

size-bytes Size of the storage pool in bytes.

size-gigabytes Size of the storage pool in gigabytes.

capacity-bytes Total capacity of the storage pool in bytes.

capacity-gigabytes

Total capacity of the storage pool in gigabytes.

available-capacity-bytes

Number of bytes available in the storage pool.

available-capacity-gigabytes

Number of gigabytes available in the storage pool.

consumed-capacity-bytes

Total size in bytes of the space actually allocated or reserved.

consumed-capacity-gigabytes

Total size in gigabytes of the space actually allocated or reserved.

subscribed-capacity-bytes

Total host visible capacity in bytes.

subscribed-capacity-gigabytes

Total host visible capacity in gigabytes.

Sample Adapter Response for 'get-storage-pool' Operation

success 1 success 11185 736 39 locke-2



Version 1.1.03

default CLARiiON+CKM00083900053 RG 0000 RAID5 0_0_5 0_0_6 0_0_7 0_0_8 0_0_9 FC FC FC FC FC 5 717513625600 668.237 574010884096 534.589 525449887744 489.363 48560996352 45.226 48560996352 45.226 SYMMETRIX+000294901120 RG 0001 RAID1 07A:C0 08A:D0 07B:D0 08B:C0 07C:C0 08C:D0 07D:D0 08D:C0 SATA SATA SATA SATA SATA SATA SATA SATA 8 8001639077120 7452.107 7899138486944 7356.646 7724680082080 7194.169 174458404864 162.477 147600375808 137.464 SYMMETRIX+000294901120 TP ThinPool



Version 1.1.03

RAID1 0008C 000CB 1 1284243456 1.196 1284243456 1.196 1275592704 1.188 8650752 0.008 8650752 0.008

Operation: delete-storage-poolThe delete-storage-pool operation sends a request to the EMC SMI-S Provider to remove anexisting storage pool.

Use cautiously because all LUNs that belong to the storage pool and their corresponding data will be destroyed.

Adapter Request Elements for 'delete-storage-pool' Operation

Definition Required


Valid value: delete-storage-pool.

Yes






No




No


storage-system-name



No



Version 1.1.03

Definition Required



Specifies the RAID group name or thin-pool name to be deleted.

Valid value: None

Default value: None

No



Default value: yes

No




Default Value: 180 seconds

No

Sample Adapter Request for 'delete-storage-pool' Operation

delete-storage-pool CLARiiON+CKM00083900053 0003 yes 180

Adapter Response Elements for 'delete-storage-pool' Operation

Description

storage-system-name







Sample Adapter Response for 'delete-storage-pool' Operation

success 1 success 25422 7 pythagoras-p27p pythagoras-p27p



Version 1.1.03

CLARiiON+CKM00083900053 0003 260920567 Completed Completed Storage pool Delete

Operation: get-raid-levelThe get-raid-level operation lists the available RAID Levels that can be configured for a new storagepool with the create-storage-pool operation.

Adapter Request Elements for 'get-raid-level' Operation

Definition Required


Valid value: get-raid-level.

Yes






No




No


storage-system-name




No

Sample Adapter Request for 'get-raid-level' Operation

get-raid-level



Version 1.1.03

Adapter Response Elements for 'get-raid-level' Operation

Description

storage-system-name


raid-level RAID levels supported by the storage system.

Sample Adapter Response for 'get-raid-level' Operation

success 1 success 436 13 2 locke-2 default CLARiiON+CKM00083900053 RAID0 RAID1 RAID10 RAID3 RAID5 RAID6 SYMMETRIX+000294901120 RAID1 RAID5 RAID6



Version 1.1.03

Operation: expand-storage-poolThe expand-storage-pool operation enable administrators to increase the available space in anexisting pool for a storage system.

Adapter Request Elements for 'expand-storage-pool' Operation

Definition Required


Valid value: expand-storage-pool.

Yes



storage-system-name

Specifies the storage system name from which the information has to be collected.



Yes

thin-pool Specifies the thin pool name that must be expanded.


Default Value: None.

Yes

lun-name

OR

size-bytes

Specifies the LUN names of type data device or the raw size in bytes that is used toexpand the pool.

Valid value: None.

Default Value: None.

Yes


synchronous Specifies whether to wait until the job completes. Any action performed by EMC SMI-Sprovider results in creating a job. if the 'synchronous' element is set to yes, theadapter will wait until the job completes. Otherwise the job will be queued.


Default value: yes

No


Specifies the time in seconds after which the attempt to complete the job times out.Valid value: A numeric value which specifies the time in seconds. Default value: 180 seconds

No

Sample Adapter Request for 'expand-storage-pool' Operation

expand-storage-pool SYMMETRIX+000294901120

TP_Demo 209715200

yes 300



Version 1.1.03

Adapter Response Elements for 'expand-storage-pool' Operation

Description

storage-system-name






Sample Adapter Response for 'expand-storage-pool' Operation

success 1 success 154360 5 locke-2 default SYMMETRIX+000294901120

TP_Demo 208985045

Completed Completed - Pool Expand

54Disk Operations


Version 1.1.03

Disk Operations

Operation: get-diskThe get-disk operation lets administrators get the list of physical disks and their characteristics inthe specified array. It is possible to specify the exact disk to be listed with the property or theraid group the disk is a member of with the property.

The get-disk operation is necessary before creating a RAID Group or Thin Pool using the create-storage-pool operation.To see whether a disk is already a member of a RAID Group or Thin Pool, you will need to check the presence of the or tag of the adapter response.

If all options are left blank, the get-disk operation will list all the physical disks installed in all the disk arrays managedby the EMC SMI-S Provider.

Adapter Request Elements for 'get-disk' Operation

Definition Required


Valid value: get-disk.

Yes






No




No


disk-name Specifies the user defined disk name.

Valid value: Please refer to the get-disk operation to list the valid values of thisfield.


No

storage-system-name

Specifies the user defined storage system name. No

55Disk Operations


Version 1.1.03

Definition Required



raid-group orthin-pool

Return only the disk(s) that are associated with this RAID group or thin pool.

Valid value: None.


No

disk-type Returns only the disk(s) that are of specified type.

Valid value: None.


No

Sample Adapter Request for 'get-disk' Operation

get-disk

Adapter Response Elements for 'get-disk' Operation

Description

disk-name Name of the disk.

disk-type Type of disk.

storage-system-name



size-bytes Size of the disk in bytes.

size-gigabytes Size of the disk in gigabytes.

model Model of the disk.

vendor Name of the vendor.

operational-status

Operational status of the disk.

operational-status-description

Additional information about the status of the disk.

Sample Adapter Response for 'get-disk' Operation

56Disk Operations


Version 1.1.03

success 1 success 9126 2300 231 locke-2 default 0_0_0 FC CLARiiON+CKM00083900053 0001 143537471488 133.68 STT14685 CLAR146 SEAGATE 2 OK 0_0_1 FC CLARiiON+CKM00083900053 0001 143537471488 133.68 STT14685 CLAR146 SEAGATE 2 OK 07A:C0 SATA SYMMETRIX+000294901120 TP_R6_G2_FC 1000204884640 931.513 ST310003CLAR1000 SATAST 2 OK 07B:C3 FC SYMMETRIX+000294901120 joezr 439049727480 408.897 STE45085 CLAR450 SEAGATE 2 OK

57LUN Operations


Version 1.1.03

LUN Operations

The following operations allow administrators to automate the manipulation of LUNs in the EMC diskarrays through the EMC SMI-S Provider.

The supported operations for LUNs are:

create-lun, to create a new LUN in a storage system

get-lun, to list the existing LUNs and their characteristics

delete-lun, to remove an existing LUN for a storage system

expand-lun, to allocate additional space to a LUN

Operation: create-lunThe create-lun operation triggers the creation of a volume (generally called a LUN) in the specifiedRAID Group or Thin Pool in the specified storage system.

Once a LUN has been created, it usually needs to be added to a storage group so that a server (ahost) can access the newly created volume.

Adapter Request Elements for 'create-lun' Operation

Definition Required


Valid value: create-lun.

Yes






No




No


storage-system-name




No

58LUN Operations


Version 1.1.03

Definition Required

size-bytes Specifies the size of the LUN to be created.

Example value: 1073741824


No


Specifies the correct RAID group name or thin pool name on which the LUN must becreated. The RAID group or thin pool must already exist.

Valid value: None.

Default value: None

No

element-type Specifies the type of LUN (Thin or Traditional) to be created.

Valid value: 2 = Traditional, 5 = Thin

Default value: 2

No

synchronous Specifies whether to wait until the job completes. Any action performed by the EMCSMI-S Provider results in creating a job. if the 'synchronous' element is set to yes, theadapter waits until the job completes. Otherwise the job will be queued.


Default value: yes

No

number-of-luns Number of LUNs to be created

Valid value: numeric value

Default value: 1

No





No

Sample Adapter Request for 'create-lun' Operation

create-lun CLARiiON+CKM00083900053 0003 104857180

5 yes

Adapter Response Elements for 'create-lun' Operation

Description

storage-system-name



lun-name Name of the LUN.

size-bytes Size of the LUN in bytes.


59LUN Operations


Version 1.1.03



Detailed information about the status of the job.

Sample Adapter Response for 'create-lun' Operation

success 1 success 25422 7 pythagoras-p27p pythagoras-p27p CLARiiON+CKM00083900053 0003 00018 104857180 260920567 Completed Completed - Volume Create

Operation: get-lunThe get-lun operation lists the available LUNs in the specified storage system, as well as theircharacteristics. This operation is helpful to get the characteristics and ID of a LUN that needs to be"mapped" to a new host.

The table below describes the input properties for this request. If not specified, the valid value for anelement should be assumed to be any string.

Adapter Request Elements for 'get-lun' Operation

Definition Required


Valid value: get-lun.

Yes



target Specifies the connection information for an EMC SMI-S Provider. No

60LUN Operations


Version 1.1.03

Definition Required






No


lun-name Specifies the user defined lun name.

Valid value: Please refer to the get-lun operation to list the valid values of this field.


No

storage-system-name

Specifies the user defined array name.



No


Return only the LUN(s) that are associated with this RAID group or thin pool.

Valid value: None.


No

lun-type Returns only the lun(s) that are of requested type.

Valid value: Data Device, Thin Device, Regular Device (LUN), Reserved by theComputerSystem (Vault).


No

Sample Adapter Request for 'get-lun' Operation

get-lun

Adapter Response Elements for 'get-lun' Operation

Description

lun-name Name of the LUN.

61LUN Operations


Version 1.1.03

lun-element-name

User friendly name of the LUN

lun-type Type of LUN.

storage-system-name


raid-level RAID level.


size-bytes Size of the LUN in bytes.

size-gigabytes Size of the LUN in gigabytes.

consumed-capacity-bytes

Total size in bytes of the space actually allocated or reserved.

consumed-capacity-gigabytes

Total size in gigabytes of the space actually allocated or reserved.

current-controller

Current controller being used to access the LUN.

composite Indicates whether the LUN is a composite.

operational-status

Operational status of the LUN.

Sample Adapter Response for 'get-lun' Operation

success 1 success 23088 3873 321 locke-2 default 00000 LUN 0 Regular Device (LUN) CLARiiON+CKM00083900053 RAID5 0000 32212254720 30 32212254720 30 SP_B yes 2 00002 Volume 00002 Reserved by the ComputerSystem (Vault) SYMMETRIX+000294901120

62LUN Operations


Version 1.1.03

Other RAID Level 0002 5368709120 5 5368709120 5 no 2 0009D Volume 0009D Data Device SYMMETRIX+000294901120 RAID5 0001 2147745792 2 2147745792 2 no 2 0009C Volume 0009C Thin Device SYMMETRIX+000294901120 RAID1 TestThinPool 210370560 0.196 786432 0.001 no 2

Operation: delete-lunThe delete-lun operation sends a query to the EMC SMI-S Provider to remove an existing LUN froma storage system. All the data in the specified volume are destroyed.

The delete-lun operation is typically used when decommissioning a server that was using storagespace in a disk array.

Use this operation cautiously as it cannot be undone.

The table below described the input properties for this request. If not specified, the value for anelement should be assumed to be any string.

Adapter Request Elements for 'delete-lun' Operation

Definition Required


Valid value: delete-lun.

Yes

63LUN Operations


Version 1.1.03






Yes




No


lun-name Specifies the name of the LUN that must be deleted.

Valid value: Please refer to the get-lun operation to list the valid values of this field.


Yes

storage-system-name




Yes



Default value: yes

No





No

Sample Adapter Request for Multiple 'delete-lun' Operation

delete-lun CLARiiON+CKM00083900053 00018 00018

00020 yes

Adapter Response Elements for 'delete-lun' Operation

Description

64LUN Operations


Version 1.1.03

storage-system-name


lun-name Name of the deleted LUN.




Detailed information about the status of the job.

Sample Adapter Response for Multiple 'delete-lun' Operation

success 1 success 18187 5 pythagoras-p27p pythagoras-p27p CLARiiON+CKM00083900053 00018 260920594 Completed - Volume Delete Completed

Operation: expand-lunThe expand-lun operation sends a query to the EMC SMI-S Provider to increase the size of anexisting LUN. This operation requires to specify the name of the LUN to be expanded as well as thesize of the expansion.

Expanding an existing LUN consists in creating a new LUN and then a metaLUN from the existing oneand the new one. Storage groups for the initial LUN are automatically re-mapped to the metaLUNand the operation is therefore transparent to the hosts.

Adapter Request Elements for 'expand-lun' Operation

Definition Required


Valid value: expand-lun.

Yes

65LUN Operations


Version 1.1.03

Definitio

Documents

BMC Atrium Orchestrator Application Adapter for EMC ...€¦ · Table of Contents 2 BMC Atrium Orchestrator Application Adapter for EMC Storage Version 1.1.03 Table of Contents Actor