BMC Atrium Orchestrator Application Adapter for …€¦ · BMC Atrium Orchestrator Application Adapter for IBM DS6000, ... decommission-server ... BMC Atrium Orchestrator Application

User Documentation October 2012

BMC Atrium OrchestratorApplication Adapter for IBMDS6000, DS8000 Series

Version 1.0.01

Table of Contents 2

Version 1.0.01

BMC Atrium Orchestrator Application Adapter for IBM DS6000, DS8000 Series

Table of Contents...........................................................................................................................4Customer Support

...........................................................................................................................5Release Notes for v.1.0.01

...........................................................................................................................5Overview

...........................................................................................................................5Actor Adapter

...........................................................................................................................6Getting Started

...........................................................................................................................6Adapter Module Life Cycle

...........................................................................................................................7Supported Versions of IBM DS6000, DS8000 Series

...........................................................................................................................7Installing the Adapter

...........................................................................................................................10Pre-requisites for the Adapter

...........................................................................................................................15Configuring the IBM Adapter

...........................................................................................................................17Support for Multiple Configuration

...........................................................................................................................18Enabling the Debug Mode

...........................................................................................................................18IBM Storage Adapter Module

...........................................................................................................................18Top-level Processes

...........................................................................................................................19SetupValidation

...........................................................................................................................19Utilities

...........................................................................................................................19Version Directory

...........................................................................................................................19Actor Adapter Requests and Responses

...........................................................................................................................20IBM Storage Actor Adapter

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

...........................................................................................................................22Volume Operations

..................................................................................................................22Operation: get-volume

..................................................................................................................25Operation: create-volume

..................................................................................................................27Operation: delete-volume

..................................................................................................................29Operation: get-volume-group

..................................................................................................................32Operation: create-volume-group

..................................................................................................................35Operation: delete-volume-group

..................................................................................................................36Operation: add-volume-to-volume-group

..................................................................................................................38Operation: remove-volume-from-volume-group

...........................................................................................................................40Storage System Operation

..................................................................................................................40Operation: get-storage-system

...........................................................................................................................43Disk Operation

Table of Contents 3

Version 1.0.01


..................................................................................................................43Operation: get-disk

...........................................................................................................................45Host Group Operations

..................................................................................................................46Operation: get-host-group

..................................................................................................................49Operation: get-port

..................................................................................................................52Operation: get-host

..................................................................................................................56Operation: get-host-platform

..................................................................................................................58Operation: create-host-group

..................................................................................................................60Operation: delete-host-group

..................................................................................................................63Operation: add-volume-to-host-group

..................................................................................................................65Operation: remove-volume-from-host-group

..................................................................................................................67Operation: add-port-to-host-group

..................................................................................................................69Operation: remove-port-from-host-group

...........................................................................................................................71Storage Pool Operations

..................................................................................................................72Operation: get-extent-pool

..................................................................................................................75Operation: get-rank

..................................................................................................................78Operation: create-extent-pool

..................................................................................................................80Operation: delete-extent-pool

..................................................................................................................82Operation: add-rank-to-extent-pool

...........................................................................................................................84Use Cases

..................................................................................................................84Operation: provision-server

..................................................................................................................87Operation: decommission-server

4Customer Support

Version 1.0.01


Customer Support

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 800 537 1813. 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

http://www.bmc.com/support_home



5Customer Support

Version 1.0.01


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"

messages from related software

Release Notes for v.1.0.01

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

Workflows are now available for all operators in the BMC Operator Control Panel.

All the adapter response elements are now documented.

Overview

Actor AdapterAn actor adapter performs specialized functions and serves as an interface to interact with externalsystems. The actor adapter for IBM DS6000, 8000 Series leverages IBM DS Storage Manager tointeract with the IBM Storage System.

Function of Actor Adapter in BMC Atrium Orchestrator

6Overview

Version 1.0.01


Getting Started

Adapter Module Life CycleAn 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

No Monitor Adapter is available for IBM DS6000, DS8000 Series.

7Getting Started

Version 1.0.01


Supported Versions of IBM DS6000, DS8000SeriesBMC Atrium Orchestrator Application Adapter for IBM DS6000, DS8000 Series supports the IBMDS6000 and DS8000 series.

Installing the Adapter

Getting the Adapter Package

The BMC Atrium Orchestrator Application Adapter for IBM DS6000, DS8000 Series can be obtainedfrom BMC EPD Web site and from Sentry Software Web site.

The package file name is: sentry-adapter-ibm-ds68-storage_1.0.01.zip. It contains the aroar packagefor the Actor Adapters, as well as the corresponding module (that will be loaded into DevelopmentStudio):

sentry-adapter-ibm-ds68-storage-actor_1.0.01.aroar

AO-AD-IBM_DS68_Storage.1.0.01.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.jsp

http://www.sentrysoftware.com

8Getting Started

Version 1.0.01


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

Adapters to be added to the Grid

9Getting Started

Version 1.0.01


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

10Getting Started

Version 1.0.01


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

Visualizing the loaded module

Pre-requisites for the Adapter

Installing the IBM DS6000/DS8000 Storage Manager(Windows)

Port Configuration

Specify Ports for the DS Storage Manager to use (or accept defaults):

11Getting Started

Version 1.0.01


SSL Configuration

Specify the location of an existing certificate, or

Enter key file and trust file passwords to generate a certificate:

SSL Configuration (Generate Certificate – Additional Information)

Enter additional information for the SSL certificate (optional):

12Getting Started

Version 1.0.01


Click Install on the next page.

The Server will need to be rebooted after installation:

Configuring the IBM DS6000/DS8000 StorageManager

This section provides an overview of the configuration steps required after you install the DS StorageManager.

13Getting Started

Version 1.0.01


The installation of the IBM created two new services:

Several new items will also be available from the Start menu:

Open the Open DS Storage Manager:

The default username is admin, and password is admin.

On the Main Storage Manager page:

14Getting Started

Version 1.0.01


Specify a new admin password on the next page.

Under Real-Time Manager > Manage Hardware, select Storage Complexes.

Select a management console (tick the highlighted box).

In the --- Select Action --- list, select Assign Storage Unit

Assign Storage Unit

Enter a Nickname

Enter the two IP addresses of the DS6000 series controller cards.

Enter the last 7 digits of the serial number listed on the storage unit.

The serial number can be found under the right hand bezel of the storage unit:

15Getting Started

Version 1.0.01


Click Next

Enter Gateway and Subnet Mask information

Click Next and then Finish

The DS6000 Storage Manager will now try to add your unit. This process can take some time. Ifyou have multiple units to add, you can click Close and View Summary

Repeat Process for Each DS6000 unit.

Once All Assign Storage Unit processes are finished (see Long Running Task Summary Page)

Configuring the IBM AdapterYou configure an adapter in the Grid Manager. The configuration provides information about how theadapter interacts with IBM DS Storage Manager. While each adapter must have a unique name, youcan create multiple adapters with the same adapter type to allow for different configurationproperties.

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 XML from 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 adapter1. 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 adapterto be 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. 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)

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

f. In the Properties text box, use XML format to enter the configuration elements and attributesnot available as fields in the form view

g. Click OK.

16Getting Started

Version 1.0.01


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 the Properties 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.

The table below describes the adapter configuration elements and attributes for the IBM DS 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 <config> 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 IBM CIM Agent for DS Open. Yes

Port port Specifies the port number of the IBM CIM Agent for DS Open. Yes

User Name user-name Specify the login name for the IBM CIM Agent for DS Open.This tag should not be used if the security file path is beingspecified using the <security-file-path> tag. In that case,username saved in the user defined security file or the defaultsecurity file is used.

Yes

Protocol protocol Transport protocol to connect to IBM CIM Agent for DS Open. Values: http, https.Usually, the IBM CIM Agent for DS Open responds in http onport 5988 and in https on port 5989.

Yes

Password password Specifies the password for the IBM CIM Agent for DS Open.You can encrypt the password by specifying the encryptiontype attribute.For example: <password encryption-type ="Base64">cGFzc3dvcmQ=</password>.This tag should not be used if the security file path is beingspecified using the <security-file-path> tag. In that case,password saved in the user defined security file or the defaultsecurity file is used.

Yes

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

No

17Getting Started

Version 1.0.01


Sample XML template for configuring the actor adapter - plainpassword<configs> <config name="ds-68"> <target>ds-68</target> <username>admin</username> <password>password</password> <protocol>https</protocol> <port>5989</port> <timeout-secs>300</timeout-secs> </config></configs>

Sample XML template for configuring the actor adapter - encryptedBase64 password<configs> <config name="ds-68"> <target>ds-68</target> <username>admin</username> <password encryption-type="Base64">cGFzc7cdcmQ=</password> <protocol>https</protocol> <port>5989</port> <timeout-secs>300</timeout-secs> </config></configs>

Support for Multiple ConfigurationIBM Storage adapter is capable of connecting to multiple IBM DS Storage Managers. Each <config>is used to designate the connection criteria for a specific IBM DS Storage Manager. Each <config>element has a "name" attribute. This configuration name is used as a value for the <target> tag inadapter 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(IBM Storage Systems) can be defined for IBM Storage adapter

<config> <target>hostname</target> <username>username</username> <password>password</password> <protocol>http</protocol> <port>5989</port> <timeout-secs>200</timeout-secs></config>

The <configs> element is optional, but mandatory when more than one <config> node is defined.

18Getting Started

Version 1.0.01


Enabling the Debug ModeIf 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

<appender class="org.apache.log4j.RollingFileAppender" name="sentryDS68"> <param name="File" value="${catalina.home}/logs/sen_ibm_ds68.log"/> <param name="Append" value="true"/> <param name="MaxFileSize" value="10240KB"/> <param name="MaxBackupIndex" value="5"/> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n"/> </layout> </appender> <logger additivity="false" name="net.sentrysoftware.ibm.ds68"> <level value="info"/> <appender-ref ref="sentryDS68"/> </logger>

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_ibm_ds68.log located at"${catalina.home}\logs (as per the example: c: \AO\cdp\tomcat\logs).

IBM Storage Adapter Module

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.

Top-level ProcessesThe top-level processes in the Project Explorer window execute the following version-specific IBMStorage processes:

Create Items

Delete Items

Add Items

Remove Items

19IBM Storage Adapter Module

Version 1.0.01


SetupValidationThe 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 IBM DS Storage Manager.

UtilitiesThe 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.

Version DirectoryThe v5.0 directory contains processes that require at least the IBM System Storage CIM Agent for DSOpen API 5.4.

In the current version of the IBM DS 6000/8000 Storage adapter, there is only one version-specificdirectory (v5.0). Later versions of the IBM DS 6000/8000 Storage adapter may implement newprocesses that might require the version of IBM CIM Agent for DS Open, in which case theseprocesses will be grouped into a separate directory.

Actor Adapter Requests andResponses

Typical Adapter Request

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

<ibm-ds68-storage-request> <operation-name>get-disk</operation-name> <arguments> <argument>..... </argument> </arguments></ibm-ds68-storage-request>

20Actor Adapter Requests and Responses

Version 1.0.01


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.

<ibm-ds68-storage-request> <metadata> <status >success</status > <response-count>12</response-count> </metadata> <responses> <response> <metadata> <status /> <execution-milliseconds /> <line-count /> <target /> <config-name /> </metadata> <output> ..... </output> </response> </responses></ibm-ds68-storage-request>

IBM Storage Actor AdapterThe 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.


Version 1.0.01


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

Process name Adapter operation

Disk

Get Disk get-disk

Volume

Get Volume get-volume

Create Volume create-volume

Delete Volume delete-volume

Get Volume Group get-volume-group

Create Volume Group create-volume-group

Delete Volume Group delete-volume-group

Add Volume to Volume Group add-volume-to-volume-group

Remove Volume from Volume Group remove-volume-from-volume-group

Storage System

Get Storage System get-storage-system

Host Group

Get Host Group get-host-group

Get Port get-port

Get Host get-host

Get Host Platform get-host-platform

Create Host Group create-host-group

Delete Host Group delete-host-group

Add Volume to Host Group add-volume-to-host-group

Remove Volume From Host Group remove-volume-from-host-group

Add Port to Host Group add-port-to-host-group

Remove Port from Host Group remove-port-from-host-group

Storage Pool

Get Extent Pool get-extent-pool

Get Rank get-rank

Create Extent Pool create-extent-pool

Delete Extent Pool delete-extent-pool

Add Rank to Extent Pool add-rank-to-extent-pool


Version 1.0.01


Additional Information for Writing an Adapter requestSpecial characters used in a text field should be wrapped in the CDATA tag.Sample text: <![CDATA[sample(&*&$#$ t̂ext]]>

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

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

Volume OperationsThe following operations allow administrators to automate the manipulation of volumes in the IBMStorage Systems through IBM DS Storage Manager.

The supported operations for Volumes are:

get-volume, to list the existing volumes and their characteristicscreate-volume, to create a new volume in a storage system

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

get-volume-group, to list the existing volume groups and their characteristics

create-volume-group, to create a new volume group in a storage system

delete-volume-group, to delete an existing volume group for a storage system

add-volume-to-volume-group, to add a volume to an existing volume group in a storage system

remove-volume-from-volume-group, to remove an existing volume from a volume group in astorage system.

Operation: get-volumeThe get-volume operation lists the available volumes (LUNs, also called LUs) in the specified storagesystem, as well as their characteristics. This operation is helpful to get the characteristics and ID of avolume 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-volume' Operation

Definition Required

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

Valid value: get-volume.

Yes

arguments Parent element for <argument> element. Yes

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

target Specifies the connection information for an IBM DS Storage Manager.

Valid value: The value specified for <target> element must be same as the valuethat has been specified for the name attribute of <config> 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.

Yes


Version 1.0.01


Definition Required

Default value: The first defined adapter configuration.

timeout-secs Specifies the time in seconds after which the attempt to connect to IBM DS StorageManager times out. The "timeout-secs" specified in adapter request overrides thevalue specified 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.

volume-name Specifies the user defined volume name.

Valid value: Any valid string.

Default value: None.

No

volume-id Specifies the unique identifier of the volume.

Valid value: Any valid string

Default value: None

No

storage-system-name

Specifies the user defined storage system name.

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


No

extent-pool-name

Specifies the user defined extent pool name.Valid value: Please refer to the get-extent-pool operation to list the valid value ofthis field.Default value: None.

No

extent-pool-id Specifies the unique identifier of the extent pool.

Valid value: Please refer to the get-extent-pool operation to list the valid value ofthis field.

Default value: None

No

volume-group Specifies the user defined volume-group.Valid value: Please refer to the get-volume-group operation to list the valid valuesof this field.Default value: None.

No

Either the volume-name or the volume-id must be specified.

Sample Adapter Request for 'get-volume' Operation<ibm-ds68-storage-request> <operation-name>get-volume</operation-name> <arguments> <argument> <storage-system-name /> <volume-id /> <volume-name /> <extent-pool-name /> <extent-pool-id /> <volume-group-name /> </argument> </arguments> </ibm-ds68-storage-request>


Version 1.0.01


Adapter Response Elements for 'get-volume' Operation

Description

volume-id Unique ID of the volume.

volume-name Name of the volume.

storage-system-name

Name of the user defined storage system.

raid-level RAID level of the volume.

extent-pool-name

Name of the extent pool from which the volume is created.

extent-pool-id Unique ID of the extent pool from which the volume is created.

volume-group-name

Name of the volume group.

lss Logical sub system of the volume.

size-bytes Total size of the volume (in bytes).

size-gigabytes Total size of the volume (in gigabytes).

consumed-capacity-bytes

Total amount of data stored in the volume (in bytes).

consumed-capacity-gigabytes

Total amount of data stored in the volume (in gigabytes).

operational-status

Operational status of the volume.

operational-status-description

Description of the operational status of the volume.

Sample Adapter Response for 'get-volume' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>172</execution-milliseconds> <line-count>28</line-count> <volume-count>2</volume-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volumes> <volume> <volume-id>IBM.1750-1332950-1100</volume-id> <volume-name>Pascal</volume-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <raid-level>RAID5</raid-level> <extent-pool-name>Pool-3E5</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P1</extent-pool-id>


Version 1.0.01


<volume-group-name>Pascal</volume-group-name> <lss>11</lss> <size-bytes>67645734912</size-bytes> <size-gigabytes>63</size-gigabytes> <consumed-capacity-bytes>67645734912</consumed-capacity-bytes> <consumed-capacity-gigabytes>63</consumed-capacity-gigabytes> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </volume> <volume> <volume-id>IBM.1750-1332950-1102</volume-id> <volume-name>[1102]</volume-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <raid-level>RAID5</raid-level> <extent-pool-name>Pool-3E5</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P1</extent-pool-id> <host-group-ids> <host-group-id>IBM.1750-1332950-21000024FF039C50-28</host-group-id> <host-group-id>IBM.1750-1332950-21000024FF039C51-29</host-group-id> </host-group-ids>

<lss>11</lss> <size-bytes>341449900032</size-bytes> <size-gigabytes>318</size-gigabytes> <consumed-capacity-bytes>341449900032</consumed-capacity-bytes> <consumed-capacity-gigabytes>318</consumed-capacity-gigabytes> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </volume> </volumes> </output> </response> </responses></ibm-ds68-storage-response>

Operation: create-volumeThe create-volume operation triggers the creation of a volume (generally called a LUN, or a LU) inthe specified storage system.

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

Adapter Request Elements for 'create-volume'Operation

Definition Required


Valid value: create-volume.

Yes






No


Version 1.0.01


Definition Required




No


storage-system-name




Yes

extent-pool Specifies the user defined extent pool.Valid value: Please refer to the get-extent-pool operation to list the valid values ofthis field.Default value: None

Yes

volume-name Specifies the nickname for the volume to be created.

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


No

size Specifies the user defined volume size in bytes.Valid value:Default value:

Yes

volume-type Specifies the volume type. block520 unprotected and block520 protected representsthe iSeries volume type while block512 represents the Standard Open System.

Valid values:

Block512

Block520Protected

Block520Unprotected

Default value: Block512

No

number-of-volume

Specifies the number of volumes to be created.Valid value: A positive integer.Default value: 1

No

Sample Adapter Request for 'create-volume' Operation <ibm-ds68-storage-request> <operation-name>create-volume</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P1</extent-pool-id> <size-bytes>104857600</size-bytes> <volume-type>block512</volume-type> <number-of-volume>2</number-of-volume>

<volume-name>Volume 1</volume-name> <volume-name>Volume 2</volume-name> </argument> </arguments> </ibm-ds68-storage-request>


Version 1.0.01


Adapter Response Elements for 'create-volume'Operation

Description

storage-system-name


volume-name Name of the newly created volume.

volume-id Unique ID of the newly created volume.

extent-pool-id Unique ID of the extent pool from which the volume is created.

create-status Creation status of the volume.

Sample Adapter Response for 'create-volume' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>8984</execution-milliseconds> <line-count>9</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volumes> <volume> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-names> <volume-name>Volume 1</volume-name> <volume-name>Volume 2</volume-name> </volume-names> <volume-ids> <volume-id>IBM.1750-1332950-0100</volume-id> <volume-id>IBM.1750-1332950-0101</volume-id> </volume-ids> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P1</extent-pool-id> <create-status>0 (Success)</create-status> </volume> </volumes> </output> </response> </responses></ibm-ds68-storage-response>

Operation: delete-volumeThe delete-volume operation sends a query to IBM DS Storage Manager to remove an existingvolume from a storage system. All the data in the specified volume are destroyed.

The delete-volume operation is typically used when decommissioning a server that was usingstorage space in a disk array.


Version 1.0.01


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-volume'Operation

Definition Required


Valid value: delete-volume.

Yes






Yes




No


storage-system-name




Yes

volume-id Specifies the identifier of the volume that must be deleted.



Yes

Sample Adapter Request for 'delete-volume' Operation <ibm-ds68-storage-request> <operation-name>delete-volume</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-id>IBM.1750-1332950-0100</volume-id> <volume-id>IBM.1750-1332950-0101</volume-id> </argument> </arguments>


Version 1.0.01


</ibm-ds68-storage-request>

Adapter Response Elements for 'delete-volume'Operation

Description

storage-system-name


volume-id Unique ID of the deleted volume.

delete-status Deletion status of the volume.

Sample Adapter Response for 'delete-volume' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>4593</execution-milliseconds> <line-count>3</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volumes> <volume> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-ids> <volume-id>IBM.1750-1332950-0100</volume-id> <volume-id>IBM.1750-1332950-0101</volume-id> </volume-ids> <delete-status>0 (Success)</delete-status> </volume> </volumes> </output> </response> </responses></ibm-ds68-storage-response>

Operation: get-volume-groupThe get-volume-group operation lists the available volume groups in the specified storage system,as well as their characteristics. This operation is helpful to get the characteristics and ID of a volumegroup that needs to be "mapped" to a new host.



Version 1.0.01


Adapter Request Elements for 'get-volume-group'Operation

Definition Required


Valid value: get-volume-group.

Yes






Yes




No


volume-name Specifies the user defined volume name.Valid value: Please refer to the get-volume operation to list the valid values of thisfield.


No

volume-id Specifies the user defined volume identifier.

Valid value: none

Default value: none

No

storage-system-name




No

volume-group-name

Specifies the name of the volume group.

Valid value: none

Default value: none

No

volume-group-id Specifies the identifier of the volume group.

Valid value: none

Default value: none

No

host-group-id Specifies the identifier of the host group.

Valid value: none

Default value: none

No


Version 1.0.01


Sample Adapter Request for 'get-volume-group' Operation<ibm-ds68-storage-request> <operation-name>get-volume-group</operation-name> <arguments> <argument> <storage-system-name /> <volume-id /> <volume-name /> <host-group-id /> <volume-group-id /> <volume-group-name /> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'get-volume-group'Operation

Description

volume-group-name


volume-group-id Unique ID of the volume group.

storage-system-name

Name of the storage system.

volume-group-type

Type of the volume group.

volume-id Unique ID of the volume.

volume-name Name of the volume.

size-bytes Total size of the volume group (in bytes).

size-gigabytes Total size of the volume group (in gigabytes).


Total amount of data stored in the volume group (in bytes).


Total amount of data stored in the volume group (in gigabytes).

Sample Adapter Response for 'get-volume-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>297</execution-milliseconds> <line-count>56</line-count> <volume-group-count>3</volume-group-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volume-groups>


Version 1.0.01


<volume-group> <volume-group-name>Pascal</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-12</volume-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-type>MAP Block512</volume-group-type> <volume-id>IBM.1750-1332950-1100</volume-id> <volume-name>Pascal</volume-name> <size-bytes>67645734912</size-bytes> <size-gigabytes>63</size-gigabytes> <consumed-capacity-bytes>67645734912</consumed-capacity-bytes> <consumed-capacity-gigabytes>63</consumed-capacity-gigabytes> </volume-group> <volume-group> <volume-group-name>Pascal</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-12</volume-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-type>MAP Block512</volume-group-type> <volume-id>IBM.1750-1332950-1100</volume-id> <volume-name>Pascal</volume-name> <size-bytes>67645734912</size-bytes> <size-gigabytes>63</size-gigabytes> <consumed-capacity-bytes>67645734912</consumed-capacity-bytes> <consumed-capacity-gigabytes>63</consumed-capacity-gigabytes> </volume-group> <volume-group> <volume-group-name>Pascal</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-12</volume-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-type>MAP Block512</volume-group-type> <volume-id>IBM.1750-1332950-1100</volume-id> <volume-name>Pascal</volume-name> <size-bytes>67645734912</size-bytes> <size-gigabytes>63</size-gigabytes> <consumed-capacity-bytes>67645734912</consumed-capacity-bytes> <consumed-capacity-gigabytes>63</consumed-capacity-gigabytes> </volume-group> <volume-group> <volume-group-name>svc</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-13</volume-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-type>MASK Block512</volume-group-type> </volume-group> </volume-groups> </output> </response> </responses></ibm-ds68-storage-response>

Operation: create-volume-groupThe create-volume-group operation triggers the creation of a volume group in the specified storagesystem.

Adapter Request Elements for 'create-volume-group'Operation

Definition Required


Valid value: create-volume-group.

Yes



target Specifies the connection information for an IBM DS Storage Manager. No


Version 1.0.01


Definition Required






No


storage-system-name




Yes

volume-group-name

Specifies the name for the volume group to be created.



No

volume-id Specifies the ID of the volume to be associated with the newly created Volume Group.

Valid value: none

Default value: none

No

volume-group-type

Specifies the type for the volume group to be created.

Valid values:

MAP Block512

MASK Block512

MAP Block520

MASK Block520

Default value: MAP Block512

No

host-platform Specifies the host-platform for the volume group to be created.

Valid value: Please refer to the get-host-platform operation to list the valid values ofthis field.

Default value: none

No

Either the volume-group-type or the host-platform must be specified.


Version 1.0.01


Sample Adapter Request for 'create-volume-group' Operation <ibm-ds68-storage-request> <operation-name>create-volume-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-name>Volume Group for HPUX</volume-group-name> <volume-id>IBM.1750-1332950-0100</volume-id> <volume-group-type>MAP Block512</volume-group-type> <host-platform>HPUX</host-platform> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'create-volume-group'Operation

Description

storage-system-name


volume-group-name

Name of the newly created volume group.

volume-group-id Unique ID of the newly created volume group.

volume-id ID of the volume that is associated to the created volume group.

create-status Status of the operation.

Sample Adapter Response for 'create-volume-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>7094</execution-milliseconds> <line-count>5</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volume-groups> <volume-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-name>Volume Group for HPUX</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-11</volume-group-id> <volume-id>IBM.1750-1332950-0100</volume-id> <create-status>0 (Success)</create-status> </volume-group> </volume-groups> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Operation: delete-volume-groupThe delete-volume-group operation sends a query to IBM DS Storage Manager to remove anexisting volume group from a storage system. All the data in the specified volume group aredestroyed.


The table below describes 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-volume-group'Operation

Definition Required


Valid value: delete-volume-group.

Yes






Yes




No


storage-system-name




Yes

volume-group-id

Specifies the identifier of the volume group that must be deleted.

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


Yes

Only one volume group can be deleted at a time.


Version 1.0.01


Sample Adapter Request for Multiple 'delete-volume-group' Operation

<ibm-ds68-storage-request> <operation-name>delete-volume-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'delete-volume-group'Operation

Description

storage-system-name


delete-status Status of the operation.

Sample Adapter Response for 'delete-volume-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3594</execution-milliseconds> <line-count>2</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volume-groups> <volume-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <delete-status>0 (Success)</delete-status> </volume-group> </volume-groups> </output> </response> </responses></ibm-ds68-storage-response>

Operation: add-volume-to-volume-groupThe add-volume-to-volume-group operation adds a volume to an existing volume group in thespecified storage system.



Version 1.0.01


Adapter Request Elements for 'add-volume-to-volume-group' Operation

Definition Required


Valid value: add-volume-to-volume-group.

Yes






Yes




No


storage-system-name




Yes

volume-group-id

Specifies the identifier of the volume group to which the volume will be added.

Valid value: none

Default value: none

Yes

volume-id Specifies the identifier of the volume to be added to the volume group.Valid value: none

Default value: none

Yes

Sample Adapter Request for 'add-volume-to-volume-group' Operation <ibm-ds68-storage-request> <operation-name>add-volume-to-volume-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> <volume-id>IBM.1750-1332950-0101</volume-id> <volume-id>IBM.1750-1332950-0100</volume-id> </argument> </arguments> </ibm-ds68-storage-request>


Version 1.0.01


Adapter Response Elements for 'add-volume-to-volume-group' Operation

Description

storage-system-name


volume-group-id Unique ID of the volume group to which the volume must be added.

volume-id Unique ID of the volume to be added to the volume group.

add-status Status of the operation.

Sample Adapter Response for 'add-volume-to-volume-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3156</execution-milliseconds> <line-count>6</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volume-groups> <volume-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> <volume-ids> <volume-id>IBM.1750-1332950-0101</volume-id> <volume-id>IBM.1750-1332950-0100</volume-id> </volume-ids> <add-status>0 (Success)</add-status> </volume-group> </volume-groups> </output> </response> </responses></ibm-ds68-storage-response>

Operation: remove-volume-from-volume-groupThe remove-volume-from-volume group operation removes a volume from an existing volumegroup in the specified storage system.



Version 1.0.01


Adapter Request Elements for 'remove-volume-from-volume-group' Operation

Definition Required


Valid value: remove-volume-from-volume-group.

Yes






Yes




No


storage-system-name




Yes

volume-group-id

Specifies the identifier of the volume group from which the volume will be removed.

Valid value: none

Default value: none

Yes

volume-id Specifies the identifier of the volume to be removed from the volume group.Valid value: none

Default value: none

Yes

Either the volume-group-name or the volume-group-id must be specified, and either the volume-name or the

volume-id must be specified.

Sample Adapter Request for 'remove-volume-from-volume-group'Operation <ibm-ds68-storage-request> <operation-name>remove-volume-from-volume-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> <volume-id>IBM.1750-1332950-0101</volume-id> <volume-id>IBM.1750-1332950-0100</volume-id> </argument>


Version 1.0.01


</arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'remove-volume-from-volume-group' Operation

Description

storage-system-name


volume-group-id Unique ID of the volume group from which the volume must be removed.

volume-id Unique ID of the volume that must be removed from the volume group.

remove-status Status of the operation.

Sample Adapter Response for 'remove-volume-from-volume-group'Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3797</execution-milliseconds> <line-count>6</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volume-groups> <volume-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> <volume-ids> <volume-id>IBM.1750-1332950-0101</volume-id> <volume-id>IBM.1750-1332950-0100</volume-id> </volume-ids> <remove-status>0 (Success)</remove-status> </volume-group> </volume-groups> </output> </response> </responses></ibm-ds68-storage-response>

Storage System Operation

Operation: get-storage-systemThe get-storage-system operation lets the administrators list the available disk arrays andvirtualization controllers visible through IBM DS Storage Manager. The operation also provides usefulinformation about each storage system, including the model and chassis type, as well as its overallcapacity (total, consumed and available).


Version 1.0.01


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


Valid value: get-storage-system.

Yes


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




No

timeout-secs Specifies the time in seconds after which the attempt to connect to the IBM DSStorage Manager times out. The "timeout-secs" specified in adapter request overridesthe value specified in adapter configuration.



No


storage-system-name




No

Sample Adapter Request for 'get-storage-system' Operation<ibm-ds68-storage-request> <operation-name>get-storage-system</operation-name> <arguments> <argument> <storage-system-name /> </argument> </arguments></ibm-ds68-storage-request>


Version 1.0.01


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

Description

storage-system-name


model Model of the storage system.

chassis-type Chassis type of the storage system.

size-bytes Total raw capacity of the storage system (in bytes).

size-gigabytes Total raw capacity of the storage system (in gigabytes).

available-capacity-bytes

Remaining usable capacity available in the storage system (in bytes).

available-capacity-gigabytes

Remaining usable capacity available in the storage system (in gigabytes).

subscribed-capacity-bytes

Total amount of capacity usable for the allocation of Pools or Volumes (LUN) (in bytes).

subscribed-capacity-gigabytes

Total amount of capacity usable for the allocation of Pools or Volumes (LUN) (in gigabytes).

operational-status

Operational status of the storage system.


Description of the operational status of the storage system.

Sample Adapter Response for 'get-storage-system' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3609</execution-milliseconds> <line-count>11</line-count> <storage-system-count>1</storage-system-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <storage-systems> <storage-system> <storage-system-name>IBM.1750-1332950</storage-system-name> <model>511</model> <chassis-type>DS6000</chassis-type> <size-bytes>1168000000000</size-bytes> <size-gigabytes>1087.785</size-gigabytes> <available-capacity-bytes>66571993088</available-capacity-bytes> <available-capacity-gigabytes>62</available-capacity-gigabytes> <subscribed-capacity-bytes>410169376768</subscribed-capacity-bytes> <subscribed-capacity-gigabytes>382</subscribed-capacity-gigabytes>


Version 1.0.01


<operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </storage-system> </storage-systems> </output> </response> </responses></ibm-ds68-storage-response>

Disk Operation

Operation: get-diskThe get-disk operation lets administrators get the list of physical disks and their characteristics in thespecified array. It is possible to specify the exact disk to be listed with the <disk-id> property or the<array-site-id> property in which the disk is a member.

If all options are left blank, the get-disk operation will list all the physical disks installed in all the disk arrays managedby IBM DS Storage Manager.

Adapter Request Elements for 'get-disk' Operation

Definition Required


Valid value: get-disk.

Yes






No




No


disk-id Specifies the unique identifier for the disk.



No

storage-system-name



No


Version 1.0.01


Definition Required


array-site-id Specifies the unique identifier for the array site.

Valid value: None.


No

Sample Adapter Request for 'get-disk' Operation<ibm-ds68-storage-request> <operation-name>get-disk</operation-name> <arguments> <argument> <storage-system-name /> <disk-id /> <array-site-id /> </argument> </arguments></ibm-ds68-storage-request>

Adapter Response Elements for 'get-disk' Operation

Description

disk-id Unique ID of the disk.

storage-system-name

Name of the storage system to which the disk belongs.

array-site-id Unique ID of the array site.

disk-speed Speed of the disk in rpm.

size-bytes Total size of the disk (in bytes).

size-gigabytes Total size of the disk (in gigabytes).

operational-status

Operational status of the disk.


Description of the operational status of the disk.

Sample Adapter Response for 'get-disk' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>343</execution-milliseconds> <line-count>128</line-count> <disk-count>4</disk-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <disks>


Version 1.0.01


<disk> <disk-id>80004S6C8C1710D</disk-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <array-site-id>IBM.1750-1332950-S1</array-site-id> <disk-speed>15000</disk-speed> <size-bytes>73000000000</size-bytes> <size-gigabytes>67.987</size-gigabytes> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </disk> <disk> <disk-id>80004S6BA3B070D</disk-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <array-site-id>IBM.1750-1332950-S4</array-site-id> <disk-speed>15000</disk-speed> <size-bytes>73000000000</size-bytes> <size-gigabytes>67.987</size-gigabytes> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </disk> <disk> <disk-id>80004S6C823920D</disk-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <array-site-id>IBM.1750-1332950-S3</array-site-id> <disk-speed>15000</disk-speed> <size-bytes>73000000000</size-bytes> <size-gigabytes>67.987</size-gigabytes> <operational-status>6</operational-status> <operational-status-description>In Service</operational-status-description> </disk> <disk> <disk-id>80004S6CB770A0D</disk-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <array-site-id>IBM.1750-1332950-S2</array-site-id> <disk-speed>15000</disk-speed> <size-bytes>73000000000</size-bytes> <size-gigabytes>67.987</size-gigabytes> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </disk> </disks> </output> </response> </responses></ibm-ds68-storage-response>

Host Group OperationsThe Host Group Operations described below help administrators assign volumes to specific hosts (orservers). By default, when a volume is created it is not visible to any host. It is necessary tospecifically define which hosts can access the new volume.

Host Groups are logical entities in IBM DS Storage Manager that describe which hosts can accesswhich volumes through which controller port. A Host Group contains hosts and volumes. Hosts in aHost Group can access all volumes that are members of the same group.

The following Host Group-related operations are supported:

get-host-group, to list the defined Host Groups and see which hosts can access which volumes.get-port, to list the controller ports of a storage systemget-host, to list the hosts of a storage systemget-host-platform, to list the host platforms of a storage systemcreate-host-group, to create a new Host Group


Version 1.0.01


delete-host-group, to delete an existing Host Group

add-volume-to-host-group, to add a volume to an existing host group

remove-volume-from-host-group, to remove a volume from an existing host group

add-port-to-host-group, to add a port to an existing host group

remove-port-from-host-group, to remove a port from an existing host group.

IBM DS6000 and DS8000 Series do not support add-host-to-host-group and remove-host-from-host-group operations.

Operation: get-host-groupThe get-host-group operation lists all of the defined Host Groups in IBM DS Storage Manager (or inthe specified storage system). The result of this operation provides a comprehensive view of whichhost can access which volume through which controller port.

This operation is a mandatory step in the scenario of decommissioning a server and its associatedstorage volumes.

Adapter Request Elements for 'get-host-group'Operation

Definition Required


Valid value: get-host-group.

Yes






No




No


storage-system-name




No


Version 1.0.01


Definition Required

host-group-id Specifies the user defined host group identifier.



No

volume-name Specifies the user defined volume name.



No

volume-id Specifies the user defined volume identifier.



No

volume-group-name

Specifies the name of the volume group.


Default value: None

No

volume-group-id Specifies the user defined volume group identifier.Please refer to the get-volume-group operation to list the valid values of this field.


No

port-name Specifies the user defined port name.

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


No

wwn Specify the user defined host name.

Valid value: Any valid string of 16 hexadecimal digits.


No

Either the volume-name or the volume-id must be specified.

Sample Adapter Request for 'get-host-group' Operation<ibm-ds68-storage-request> <operation-name>get-host-group</operation-name> <arguments> <argument> <storage-system-name /> <host-group-id /> <volume-id /> <volume-name /> <volume-group-name /> <volume-id /> <port-name /> <wwn /> <argument/> <arguments/></ibm-ds68-storage-request>


Version 1.0.01


Adapter Response Elements for 'get-host-group'Operation

Description

host-group-id Unique ID of the host group.

storage-system-name


volume-group-name


volume-group-id Unique ID of the volume group.

port-name Name of the associated port.

wwn World Wide Name of the associated host.

Sample Adapter Response for 'get-host-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>969</execution-milliseconds> <line-count>60</line-count> <host-group-count>5</host-group-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <host-group-id>IBM.1750-1332950-2100001B321E5A95-0</host-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-name>Pascal</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-12</volume-group-id> <port-names> <port-name>0000</port-name> <port-name>0001</port-name> <port-name>0002</port-name> <port-name>0003</port-name> <port-name>0100</port-name> <port-name>0101</port-name> <port-name>0102</port-name> <port-name>0103</port-name> </port-names> <wwn>2100001B321E5A95</wwn> </host-group> <host-group> <host-group-id>IBM.1750-1332950-21000024FF039A47-23</host-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-name>Vol Group - HPUX_21_22 - 1</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-35</volume-group-id> <port-name>0000</port-name> <wwn>21000024FF039A47</wwn> </host-group> <host-group> <host-group-id>IBM.1750-1332950-21000024FF039A43-6</host-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-names> <port-name>0000</port-name>


Version 1.0.01


<port-name>0001</port-name> <port-name>0002</port-name> <port-name>0102</port-name> <port-name>0103</port-name> </port-names> <wwn>21000024FF039A43</wwn> </host-group> <host-group> <host-group-id>IBM.1750-1332950-2100001B321E5A91-9</host-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-name>NOT_SET</volume-group-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-22</volume-group-id> <port-names> <port-name>0000</port-name> <port-name>0001</port-name> <port-name>0002</port-name> <port-name>0003</port-name> <port-name>0100</port-name> <port-name>0101</port-name> <port-name>0102</port-name> <port-name>0103</port-name> </port-names> <wwn>2100001B321E5A91</wwn> </host-group> <host-group> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-name>0000</port-name> <wwn>21000024FF039A48</wwn> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>

Operation: get-portThe get-port operation lists all the ports of the controllers of the specified storage system along withtheir main characteristics (speed and WWN notably). These ports are sometimes called "TargetPorts".

Host Groups define which hosts can access which volumes through which controller port. It istherefore necessary to know the ports of the storage system before assigning volumes to hosts.

Adapter Request Elements for 'get-port' Operation

Definition Required


Valid value: get-port.

Yes




Valid value: The value specified for <target> element must be same as the valuethat has been specified for the name attribute of <config> 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. Inthis case the request will be executed on the first defined adapter configuration.


No


Version 1.0.01


Definition Required

timeout-secs Specifies the time in seconds after which the attempt to connect to IBM Storage Manager times out. The "timeout-secs" specified in adapter request overrides thevalue specified in adapter configuration.



No


storage-system-name




No

port-name Specifies the user defined port name.

Valid value: Any valid value.


No

port-type Specifies the user defined port type.

Valid value: FC or Ethernet.


No

Sample Adapter Request for 'get-port' Operation<ibm-ds68-storage-request> <operation-name>get-port</operation-name> <arguments> <argument> <storage-system-name /> <port-name/> <port-type /> <argument/> <arguments/></ibm-ds68-storage-request>


Version 1.0.01


Adapter Response Elements for 'get-port' Operation

Description

port-name Name of the port.

storage-system-name


port-wwn Unique ID of the port.

port-speed Port speed in bits per second.

operational-status

Operational status of the port.


Description of the operational status of the port.

Sample Adapter Response for 'get-port' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>228</execution-milliseconds> <line-count>56</line-count> <port-count>8</port-count>

<target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <ports> <port> <port-name>0000</port-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E000627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> <port> <port-name>0001</port-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E020627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> <port> <port-name>0002</port-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E040627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> <port> <port-name>0003</port-name>


Version 1.0.01


<storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E060627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> <port> <port-name>0100</port-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E800627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> <port> <port-name>0101</port-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E820627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> <port> <port-name>0102</port-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E840627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> <port> <port-name>0103</port-name> <storage-system-name>IBM.1750-1332950</storage-system-name> <port-type>FC</port-type> <port-wwn>500507630E860627</port-wwn> <port-speed>0</port-speed> <operational-status>2</operational-status> <operational-status-description>OK</operational-status-description> </port> </ports> </output> </response> </responses></ibm-ds68-storage-response>

Operation: get-hostThe get-host operation lists all the defined hosts in the storage system.


Adapter Request Elements for 'get-host' Operation

Definition Required


Valid value: get-host.

Yes



target Specifies the connection information for an IBM DS Storage Manager. No


Version 1.0.01


Definition Required






No


storage-system-name




No

Sample Adapter Request for 'get-host' Operation<ibm-ds68-storage-request> <operation-name>get-host</operation-name> <arguments> <argument> <storage-system-name /> <argument/> <arguments/></ibm-ds68-storage-request>


Version 1.0.01


Adapter Response Elements for 'get-host' Operation

Description

host-name User friendly name of the host.

wwn World wide name of the host (16 hexadecimal digits).

host-platform Platform of the host.

Sample Adapter Response for 'get-host' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>157</execution-milliseconds> <line-count>75</line-count> <host-count>25</host-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <hosts> <host> <host-name>Pascal</host-name> <wwn>2100001B321E5A95</wwn> <host-platform>Microsoft Windows</host-platform> </host> <host> <host-name>SapClusN00</host-name> <wwn>10000000C96A8B2D</wwn> <host-platform>Linux</host-platform> </host> <host> <host-name>HPUX 1</host-name> <wwn>21000024FF039A47</wwn> <host-platform>HPUX</host-platform> </host> <host> <host-name>HPUX</host-name> <wwn>21000024FF039A46</wwn> <host-platform>HPUX</host-platform> </host> <host> <host-name>SVC</host-name> <wwn>500507680130B6B3</wwn> <host-platform>IBM SAN Volume Controller</host-platform> </host> <host> <host-name>pc-pretheve</host-name> <wwn>21000024FF039A41</wwn> <host-platform>Microsoft Windows</host-platform> </host> <host> <host-name>NOT_SET</host-name> <wwn>21000024FF039A42</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Pascal1</host-name> <wwn>2000001B321E5A95</wwn> <host-platform>Microsoft Windows</host-platform> </host> <host>


Version 1.0.01


<host-name>Aix2</host-name> <wwn>21000024FF039A43</wwn> <host-platform>Microsoft Windows</host-platform> </host> <host> <host-name>Aix3</host-name> <wwn>21000024FF039A44</wwn> <host-platform>Microsoft Windows</host-platform> </host> <host> <host-name>Pascal2</host-name> <wwn>2100001B321E5A99</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Pascal3</host-name> <wwn>2100001B321E5A91</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Pascal4</host-name> <wwn>2100001B321E5A92</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Pascal5</host-name> <wwn>2100001B321E5A93</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>NOT_SET</host-name> <wwn>2100001B321E5A83</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>NOT_SET</host-name> <wwn>2100001B321E5A84</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>NOT_SET</host-name> <wwn>2100001B321E5A85</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>NOT_SET</host-name> <wwn>2100001B321E5A86</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Windows</host-name> <wwn>2102001B321E5A95</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Windows 2000</host-name> <wwn>2103001B321E5A95</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Windows 2000 - 1</host-name> <wwn>2104001B321E5A95</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Solaris</host-name> <wwn>2105001B321E5A95</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Win</host-name> <wwn>2106001B321E5A95</wwn> <host-platform>AIX</host-platform> </host> <host> <host-name>Windows 1</host-name>


Version 1.0.01


<wwn>21000024FF039A45</wwn> <host-platform>Microsoft Windows</host-platform> </host> <host> <host-name>HPUX 2</host-name> <wwn>21000024FF039A48</wwn> <host-platform>HPUX</host-platform> </host> </hosts> </output> </response> </responses></ibm-ds68-storage-response>

Operation: get-host-platformThe get-host-platform operation lists all the defined host platforms in the storage system.


Adapter Request Elements for 'get-host-platform'Operation

Definition Required


Valid value: get-host-platform.

Yes






No




No


storage-system-name




No


Version 1.0.01


Sample Adapter Request for 'get-host-platform' Operation<ibm-ds68-storage-request> <operation-name>get-host-platform</operation-name> <arguments> <argument> <storage-system-name /> <argument/> <arguments/></ibm-ds68-storage-request>

Adapter Response Elements for 'get-host-platform'Operation

Description

storage-system-name

Name of the user-defined storage system.

host-platform Different platforms supported by the storage system.

Sample Adapter Response for 'get-host-platform' Operation <ibm-ds68-storage-request> <operation-name>get-host</operation-name> <arguments /> </ibm-ds68-storage-request><ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>109</execution-milliseconds> <line-count>26</line-count> <host-platform-count>1</host-platform-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <storage-systems> <storage-system> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-platforms> <host-platform>Solaris</host-platform> <host-platform>HPUX</host-platform> <host-platform>OpenVMS</host-platform> <host-platform>Tru64</host-platform> <host-platform>Netware</host-platform> <host-platform>AIX</host-platform> <host-platform>Irix</host-platform> <host-platform>Linux</host-platform> <host-platform>Microsoft Windows</host-platform> <host-platform>OS400</host-platform> <host-platform>AMD - Linux RHEL</host-platform> <host-platform>AMD - Linux Suse</host-platform> <host-platform>Apple - OSX</host-platform> <host-platform>Fujitsu - Solaris</host-platform> <host-platform>Intel - Linux Desktop</host-platform> <host-platform>Intel - Linux Red Flag</host-platform> <host-platform>Intel - Linux Suse</host-platform> <host-platform>IBM SAN Volume Controller</host-platform> <host-platform>IBM SAN File System AIX</host-platform> <host-platform>IBM SAN File System Linux</host-platform> <host-platform>VMWare</host-platform>


Version 1.0.01


<host-platform>Intel - Windows 2000</host-platform> <host-platform>IBM iSeries - iLinux</host-platform> <host-platform>IBM pSeries - pLinux</host-platform> <host-platform>IBM zSeries - zLinux</host-platform> </host-platforms> </storage-system> </storage-systems> </output> </response> </responses></ibm-ds68-storage-response>

Operation: create-host-groupThe create-host-group operation creates the association link between a volume, a host and acontroller port which allows the host to access the volume through the specified port. It is animportant step of the process of allocating storage to a server.

Host Groups also control through which port of the disk array a host can access a volume. In mostclassic cases, hosts will need to be able to access a given volume through all ports of the disk array.So the create-host-group operation will actually create as many Host Groups as there are ports inthe specified disk array <B>if no port is specified in the request</B> (one Host Group for each ofthese ports).

Adapter Request Elements for 'create-host-group'Operation

Definition Required


Valid value: create-host-group.

Yes






No




No


storage-system-name




Yes


Version 1.0.01


Definition Required

volume-group-idorvolume-id

Specifies the identifier of the volume group or volume to be associated.

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


Default value: None

Yes

port-name Specifies the name of the port to be associated.


Default value: If no port specified, all available ports will be considered.

No

host-name Specifies the name of the host that owns the specified WWNs.

Valid value: Any value.


No

host-platform Specifies the platform of the host that owns the specified WWNs.



No

wwn Specify the Host name to which the volume must be assigned



Yes

Either the volume-group-id or the volume id must be specified.

Sample Adapter Request for 'create-host-group' Operation <ibm-ds68-storage-request> <operation-name>create-host-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-group-id>IBMTSDS:IBM.1750-1332950-11</volume-group-id> <port-name>0102</port-name> <host-name>DS6000 Host 10</host-name> <host-platform>HPUX</host-platform> <wwn>21000024FF039B48</wwn> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'create-host-group'Operation

Description

storage-system-name


host-group-id Unique ID of the created host group.


Version 1.0.01


volume-group-id Unique ID of the associated volume group.

port-name Name of the associated port.



Sample Adapter Response for 'create-host-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>30766</execution-milliseconds> <line-count>6</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039B48-25</host-group-id> <volume-group-id>IBMTSDS:IBM.1750-1332950-11</volume-group-id> <port-name>0102</port-name> <wwn>21000024FF039B48</wwn> <create-status>0 (Success)</create-status> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>

Operation: delete-host-groupThe delete-host-group operation destroys an association between a volume, a host and a controllerport.

This operation is to be used cautiously as hosts members of the specified Host Group may no longer beable to access the associated volumes.

No data is destroyed in the process.


Version 1.0.01


Adapter Request Elements for 'delete-host-group'Operation

Definition Required


Valid value: delete-host-group.

Yes






No




No


storage-system-name




Yes

host-group-id Specifies the Host Group name to be deleted .



No

wwn Specifies the Host name to be deleted from all the Host Group.



No

- Either the wwn or host-group-id must be specified

- If the Host (wwn) is provided then the Host Group associated to this host will be completely removed

- if the host-group-id is provided then the specified Host Group will be completely removed

- If both host (wwn) and host-group-id are provided then the Host Groups associated to the specified wwn and host-

group-id will be removed completely


Version 1.0.01


Sample Adapter Request for 'delete-host-group' Operation <ibm-ds68-storage-request> <operation-name>delete-host-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039B48-25</host-group-id> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'delete-host-group'Operation

Description

storage-system-name


host-group-id Unique ID of the created host group.



Sample Adapter Response for 'delete-host-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>5281</execution-milliseconds> <line-count>4</line-count> <target>ibm-d6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039B48-25</host-group-id> <wwn>21000024FF039B48</wwn> <delete-status>0 (Success)</delete-status> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Operation: add-volume-to-host-groupThe add-volume-to-host-group operation adds a volume or a volume group to an existing hostgroup in the specified storage system.


Adapter Request Elements for 'add-volume-to-host-group' Operation

Definition Required


Valid value: add-volume-to-host-group.

Yes






Yes




No


storage-system-name




Yes

host-group-id Specifies the identifier of the Host Group to which the volume or volume group will beadded.

Valid value: Please refer to the get-host-group operation to list the valid values forthis field

Default value: None

No

volume-group-id

Specifies the identifier of the host group to which the volume will be added.


Default value: None

No

volume-id Specifies the identifier of the volume to be added to the host group.Valid value: Any valid string

No


Version 1.0.01


Definition Required

Default value: None

Either the volume-group-id or volume-id must be specified.

Sample Adapter Request for 'add-volume-to-host-group' Operation <ibm-ds68-storage-request> <operation-name>add-volume-to-host-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'add-volume-to-host-group' Operation

Description

storage-system-name



volume-group-id Unique ID of the volume group that is associated with the host group.


Sample Adapter Response for 'add-volume-to-host-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3406</execution-milliseconds> <line-count>4</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> <add-status>0 (Success)</add-status> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Operation: remove-volume-from-host-groupThe remove-volume-from-host-group operation removes a volume or a volume group from anexisting host group in the specified storage system.


Adapter Request Elements for 'remove-volume-from-host-group' Operation

Definition Required


Valid value: remove-volume-from-host-group.

Yes






Yes




No


storage-system-name




Yes

host-group-id Specifies the identifier of the Host Group from which the volume or volume group willbe removed.

Valid value: Please refer to the get-host-group operation to list the valid values forthis field

Default value: None

Yes

volume-group-id

Specifies the identifier of the volume group to be removed

Valid value: Please refer to the get-volume-group operation to list the valid valuesfor this field.

Default value: None

No

volume-id Specifies the identifier of the volume to be removed No


Version 1.0.01


Definition Required

Valid value: Please refer to the get-volume operation to list the valid values for thisfield.

Default value: None

Either the volume-group-id or the volume-id must be specified.

Sample Adapter Request for 'remove-volume-from-host-group'Operation<request-data> <ibm-ds68-storage-request> <operation-name>remove-volume-from-host-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'remove-volume-from-host-group' Operation

Description

storage-system-name



volume-group-id Unique ID of the volume group to be removed.


Sample Adapter Response for 'remove-volume-from-host-group'Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3859</execution-milliseconds> <line-count>4</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <volume-group-id>IBMTSDS:IBM.1750-1332950-36</volume-group-id>


Version 1.0.01


<remove-status>0 (Success)</remove-status> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>

Operation: add-port-to-host-groupThe add-port-to-host-group operation adds a port to an existing host group in the specifiedstorage system.


Adapter Request Elements for 'add-port-to-host-group'Operation

Definition Required


Valid value: add-port-to-host-group.

Yes






Yes




No


storage-system-name




Yes

port-name Specifies the name of the port to be added to the host group.Valid value: Please refer to the get-port operation to list the valid values of thisfield.


Yes

host-group-id Specifies the identifier of the host group to which the port will be added. Yes


Version 1.0.01


Definition Required

Valid value: Please refer to the get-host-group operation to lit the valid values ofthis field.


Sample Adapter Request for 'add-port-to-host-group' Operation <ibm-ds68-storage-request> <operation-name>add-port-to-host-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <port-name>0001</port-name> <port-name>0002</port-name> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'add-port-to-host-group' Operation

Description

storage-system-name



port-name Name of the port that is associated with the host group.


Sample Adapter Response for 'add-port-to-host-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3110</execution-milliseconds> <line-count>6</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <port-names> <port-name>0001</port-name> <port-name>0002</port-name> </port-names> <add-status>0 (Success)</add-status> </host-group> </host-groups> </output> </response>


Version 1.0.01


</responses></ibm-ds68-storage-response>

Operation: remove-port-from-host-groupThe remove-port-from-host-group operation adds a port to an existing host group in thespecified storage system.


Adapter Request Elements for 'remove-port-from-host-group' Operation

Definition Required


Valid value: remove-port-from-host-group.

Yes






Yes




No


storage-system-name




Yes

port-name Specifies the name of the port to be removed from the host group.Valid value: Please refer to the get-port operation to list the valid values of thisfield.


Yes

host-group-id Specifies the identifier of the host group from which the port will be removed.

Valid value: please refer to the get-host-group operation to list the valid values ofthis field.


Yes


Version 1.0.01


Sample Adapter Request for 'remove-port-from-host-group' Operation<ibm-ds68-storage-request> <operation-name>remove-port-from-host-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A48-24</host-group-id> <port-name>0001</port-name> <port-name>0002</port-name> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'remove-port-from-host-group' Operation

Description

storage-system-name



port-name Name of the port that is removed from the host group.


Sample Adapter Response for 'remove-port-from-host-group' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>53510</execution-milliseconds> <line-count>7</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039A41-3</host-group-id> <port-names> <port-name>0001</port-name> <port-name>0002</port-name> <port-name>0003</port-name> </port-names> <remove-status>0 (Success)</remove-status> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Storage Pool OperationsStorage Pools are logical storage entities from which volumes are created. The Logical Configurationsequence is as follows:

Logical configuration sequence


Version 1.0.01


1. Disks are grouped in an array that the user designates to be managed by the RAID technique

2. Once the array storage type is defined, the user creates a rank. A rank is a logical contiguousstorage space divided into a number of fixed-size extents. A rank can be assigned to only oneextent pool

3. Extents are then grouped together to form an extent pool.

The following Storage Pool operations are supported:

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

get-rank, to list the existing ranks and their characteristics

create-extent-pool, to create an extent pool

delete-extent-pool, to delete an extent pool

add-rank-to-extent-pool, to add a rank to an extent pool

Operation: get-extent-poolThe get-extent-pool operation lists all the existent extent pools in a storage system.


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

Definition Required


Valid value: get-extent-pool.

Yes






No




No


storage-system-name



No


Version 1.0.01


Definition Required


extent-pool-name

Specifies the user defined extent pool name.Valid value: Any valid string.


No

extent-pool-id Specifies the identifier of the extent pool.Valid value: Any valid string.


No

rank-id Specifies the identifier of the rank.Valid value: Any valid string.


No

raid-level Specifies the level of the rank.Valid value: Any valid string.


No

Sample Adapter Request for 'get-extent-pool' Operation<ibm-ds68-storage-request> <operation-name>get-extent-pool</operation-name> <arguments> <argument> <storage-system-name /> <extent-pool-name /> <extent-pool-id /> <rank-id /> <raid-level /> <argument/> <arguments/></ibm-ds68-storage-request>

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

Description

storage-system-name

Name of the storage system to which the pool belongs.

extent-pool-name

Name of the extent pool.

extent-pool-id Unique ID of the extent pool.

extent-pool-type Type of the extent pool.

rank-id Unique ID of the rank.

raid-level RAID level of the extent pool.

size-bytes Total raw capacity allocated from the physical disk (in bytes).

size-gigabytes Total raw capacity allocated from the physical disk (in gigabytes).


Total amount of capacity consumed by all the storage volumes created in the storage pool (in bytes).


Version 1.0.01



Total amount of capacity consumed by all the storage volumes created in the storage pool (in gigabytes).


Total amount of capacity usable for the allocation of storage volumes (in bytes).


Total amount of capacity usable for the allocation of storage volumes (in gigabytes).


Total amount of capacity (physical + virtual) available to be allocated (in bytes). The virtual capacitycomes into action in case of thin volumes.


Total amount of capacity (physical + virtual) available to be allocated (in gigabytes). The virtual capacitycomes into action in case of thin volumes.

Sample Adapter Response for 'get-extent-pool' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>141</execution-milliseconds> <line-count>28</line-count> <extent-pool-count>2</extent-pool-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <extent-pools> <extent-pool> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-name>Pool-3E5</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P1</extent-pool-id> <extent-pool-type>FB</extent-pool-type> <rank-id>IBMTSDS:IBM.1750-1332950-R1</rank-id> <raid-level>RAID5</raid-level> <size-bytes>410169376768</size-bytes> <size-gigabytes>382</size-gigabytes> <consumed-capacity-bytes>344671125504</consumed-capacity-bytes> <consumed-capacity-gigabytes>321</consumed-capacity-gigabytes> <available-capacity-bytes>65498251264</available-capacity-bytes> <available-capacity-gigabytes>61</available-capacity-gigabytes> <subscribed-capacity-bytes>342733357056</subscribed-capacity-bytes> <subscribed-capacity-gigabytes>319.195</subscribed-capacity-gigabytes> </extent-pool> <extent-pool> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-name>extent pool 1</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <extent-pool-type>FB</extent-pool-type> <rank-id>IBMTSDS:IBM.1750-1332950-R0</rank-id> <raid-level>RAID10</raid-level> <size-bytes>66571993088</size-bytes> <size-gigabytes>62</size-gigabytes> <consumed-capacity-bytes>0</consumed-capacity-bytes> <consumed-capacity-gigabytes>0</consumed-capacity-gigabytes> <available-capacity-bytes>66571993088</available-capacity-bytes> <available-capacity-gigabytes>62</available-capacity-gigabytes> <subscribed-capacity-bytes>0</subscribed-capacity-bytes> <subscribed-capacity-gigabytes>0</subscribed-capacity-gigabytes> </extent-pool> </extent-pools> </output>


Version 1.0.01


</response> </responses></ibm-ds68-storage-response>

Operation: get-rankThe get-rank operation lists all the existing ranks.


Adapter Request Elements for 'get-rank' Operation

Definition Required


Valid value: get-rank.

Yes






No




No


storage-system-name




No

rank-id Specifies the identifier of the rank.


Default value: None

No

extent-pool-id Specifies the identifier of the extent pool.

Valid value: Please refer to the get-extent-pool operation to list the valid values ofthis field.

Default value: None

No

extent-pool-name

Specifies the user defined extent pool name.Valid value: Please refer to the get-extent-pool operation to list the valid values ofthis field.


No


Version 1.0.01


Definition Required

raid-level Specifies the raid level.


Default value: None

No

Sample Adapter Request for 'get-rank' Operation<ibm-ds68-storage-request> <operation-name>get-rank</operation-name> <arguments> <argument> <storage-system-name /> <extent-pool-name /> <extent-pool-id /> <rank-id /> <raid-level /> <argument/> <arguments/></ibm-ds68-storage-request>

Adapter Response Elements for 'get-rank' Operation

Description

storage-system-name


rank-id Unique ID of the rank.

storage-type Type of storage.

raid-level RAID level of the rank.

extent-pool-name



size-bytes Total raw capacity allocated from the physical disk (in bytes).

size-gigabytes Total raw capacity allocated from the physical disk (in gigabytes).


Total amount of capacity consumed by all the storage volumes created in the storage pool (in bytes).


Total amount of capacity consumed by all the storage volumes created in the storage pool (in gigabytes).


Total amount of capacity usable for the allocation of storage volumes (in bytes).


Total amount of capacity usable for the allocation of storage volumes (in gigabytes).


Total amount of capacity (physical + virtual) available to be allocated (in bytes). The virtual capacitycomes into action in case of thin volumes.


Total amount of capacity (physical + virtual) available to be allocated (in gigabytes). The virtual capacitycomes into action in case of thin volumes.


Version 1.0.01


Sample Adapter Response for 'get-rank' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>78</execution-milliseconds> <line-count>28</line-count> <rank-count>2</rank-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <ranks> <rank> <storage-system-name>IBM.1750-1332950</storage-system-name> <rank-id>IBMTSDS:IBM.1750-1332950-R1</rank-id> <storage-type>FB</storage-type> <raid-level>RAID5</raid-level> <extent-pool-name>Pool-3E5</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P1</extent-pool-id> <size-bytes>410169376768</size-bytes> <size-gigabytes>382</size-gigabytes> <consumed-capacity-bytes>410169376768</consumed-capacity-bytes> <consumed-capacity-gigabytes>382</consumed-capacity-gigabytes> <available-capacity-bytes>0</available-capacity-bytes> <available-capacity-gigabytes>0</available-capacity-gigabytes> <subscribed-capacity-bytes>410169376768</subscribed-capacity-bytes> <subscribed-capacity-gigabytes>382</subscribed-capacity-gigabytes> </rank> <rank> <storage-system-name>IBM.1750-1332950</storage-system-name> <rank-id>IBMTSDS:IBM.1750-1332950-R0</rank-id> <storage-type>FB</storage-type> <raid-level>RAID10</raid-level> <extent-pool-name>extent pool 1</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <size-bytes>66571993088</size-bytes> <size-gigabytes>62</size-gigabytes> <consumed-capacity-bytes>66571993088</consumed-capacity-bytes> <consumed-capacity-gigabytes>62</consumed-capacity-gigabytes> <available-capacity-bytes>0</available-capacity-bytes> <available-capacity-gigabytes>0</available-capacity-gigabytes> <subscribed-capacity-bytes>66571993088</subscribed-capacity-bytes> <subscribed-capacity-gigabytes>62</subscribed-capacity-gigabytes> </rank> </ranks> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Operation: create-extent-poolThe create-extent-pool operation creates an extent pool in the storage system.


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

Definition Required


Valid value: create-extent-pool.

Yes






No




No


storage-system-name




Yes

extent-pool-name

Specifies the user defined extent pool name. The length of extent pool name must beless than 17 characters.


Default value: None

No

rank-id Specifies the id of the rank to use to create the extent pool.

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

Default value: None

Yes

storage-type Specifies the storage type.

Valid values: FB or CKD

Default value: FB

No


Version 1.0.01


Sample Adapter Request for 'create-extent-pool' Operation <ibm-ds68-storage-request> <operation-name>create-extent-pool</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-name>extent pool 1</extent-pool-name> <rank-id>IBMTSDS:IBM.1750-1332950-R0</rank-id> <storage-type>FB</storage-type> </argument> </arguments> </ibm-ds68-storage-request>

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

Description

storage-system-name


extent-pool-name

Name of the created extent pool.

extent-pool-id Unique ID of the created extent pool.


Sample Adapter Response for 'create-extent-pool' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>11030</execution-milliseconds> <line-count>4</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <extent-pools> <extent-pool> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-name>extent pool 1</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <create-status>0 (Success)</create-status> </extent-pool> </extent-pools> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Operation: delete-extent-poolThe delete-extent-pool operation sends a query to IBM DS Storage Manager to delete an existingextent pool. Make sure there are no volumes assigned to the extent pool that is to be deleted.Otherwise the extent pool cannot be deleted.



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

Definition Required


Valid value: delete-extent-pool.

Yes






No




No


storage-system-name




No

extent-pool-id Specifies the identifier of the extent pool.

Valid value: Please refer to the operation get-extent-pool operation to list the validvalues of this field.


Yes

Either the extent-pool-name or the extent-pool-id must be specified.


Version 1.0.01


Sample Adapter Request for 'delete-extent-pool' Operation<ibm-ds68-storage-request> <operation-name>delete-extent-pool</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> </argument> </arguments> </ibm-ds68-storage-request>

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

Description

storage-system-name


extent-pool-id Unique ID of the deleted extent pool.


Sample Adapter Response for 'delete-extent-pool' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>6688</execution-milliseconds> <line-count>3</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <extent-pools> <extent-pool> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <delete-status>0 (Success)</delete-status> </extent-pool> </extent-pools> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Operation: add-rank-to-extent-poolThe add-rank-to-extent-pool operation adds a rank to the extent pool.


Adapter Request Elements for 'add-rank-to-extent-pool'Operation

Definition Required


Valid value: add-rank-to-extent-pool.

Yes






No




No


storage-system-name




No

extent-pool-name

Specifies a new user defined extent pool name to modify the existing name.


Default value: None

Yes

extent-pool-id Specifies a new user defined extent pool name to modify the existing name.

Valid value: Please refer to the get-extent-pool operation to list the valid values ofthis field

Default value: None

Yes

rank-id Specifies the identifier of the rank to be added.

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


Yes


Version 1.0.01


Either the extent-pool-name or the extent-pool-id must be specified.

Sample Adapter Request for 'add-rank-to extent-pool' Operation <ibm-ds68-storage-request> <operation-name>add-rank-to-extent-pool</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-name>EP - R0_R2</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <rank-id>IBMTSDS:IBM.1750-1332950-R2</rank-id> </argument> </arguments> </ibm-ds68-storage-request>

Adapter Response Elements for 'add-rank-to-extent-pool' Operation

Description

storage-system-name


extent-pool-name



rank-id Unique ID of the rank to be added.


Sample Adapter Response for 'add-rank-to extent-pool' Operation<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>13265</execution-milliseconds> <line-count>5</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <extent-pools> <extent-pool> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-name>EP - R0_R2</extent-pool-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <rank-id>IBMTSDS:IBM.1750-1332950-R2</rank-id> <add-status>0 (Success)</add-status> </extent-pool> </extent-pools> </output> </response> </responses></ibm-ds68-storage-response>


Version 1.0.01


Use CasesThe workflows described in this section are examples of how to combine the low-level operations toprovision storage for a new server and decommission a server as well as remove its attachedstorage.

You can use these examples to build your own storage provisioning workflows.

Operation: provision-server

Adapter Request for 'provision-server' Operation

Definition Required

storage-system-name

Specifies the storage system name on which the lun has to be created.



Yes

size-bytes

Specifies the size (in Bytes) of the volume to be created.

Valid value: A positive integer. Example value: 1073741824


Yes

extent-pool Specifies the user defined extent pool. This information is needed if a volume has tobe created.

Valid value: Please refer to the get-extent-pool operation to list the valid values ofthis field.

Default value: None

No

volume-name Specifies the nickname for the volume to be created.


Default value: None

No

volume-type Specifies the volume type. block520 unprotected and block520 protected representsthe iSeries volume type while block512 represents the Standard Open System.

Valid values:

Block512

Block520Protected

Block520Unprotected

Default value: Block512

No

number-of-volume

Specifies the number of volumes to be created.

Valid value: A positive integer.

Default value: 1

No

host-name Specifies the name of the host that owns the specified WWN.

Valid value: Any value.


No


Version 1.0.01


Definition Required

host-platform Specifies the platform of the host that owns the specified WWN.



No

volume-group-name

Specifies the name for the volume group to be created.



No

volume-id Specifies the ID of the volume to be associated with the newly created Volume Group.


Default Value: none

No

volume-group-type

Specifies the type for the volume group to be created.

Valid values:

MAP Block512

MASK Block512

MAP Block520

MASK Block520

Default value: MAP Block512

No

wwn Specifies the name of the host(s) to which the created volume(s) must be associated.

Valid value: Any valid string of 16 hexadecimal digits


Yes

port-name Specifies the port name on which the host group must be created. When the "port-name" element is not present, the command reports on all available ports.


Default value: None

No

Sample Adapter Request for 'provision-server'Operation <ibm-ds68-storage-request> <operation-name>create-volume</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <size-bytes>104857600</size-bytes> <number-of-volume>2</number-of-volume> <volume-type>block512</volume-type> <volume-name>Test Vol 1</volume-name> <volume-name>Test Vol 2</volume-name> <port-name>0000</port-name> <port-name>0001</port-name> <host-name>HPUX Host</host-name> <host-platform>HPUX</host-platform> <wwn>21000024FF039C48</wwn> </argument> </arguments> </ibm-ds68-storage-request>


Version 1.0.01


Sample Adapter Response for 'provision-server'Operation

Response 1: create-volume<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>8453</execution-milliseconds> <line-count>9</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volumes> <volume> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-names> <volume-name>Test Vol 1</volume-name> <volume-name>Test Vol 2</volume-name> </volume-names> <volume-ids> <volume-id>IBM.1750-1332950-000f</volume-id> <volume-id>IBM.1750-1332950-0010</volume-id> </volume-ids> <extent-pool-id>IBMTSDS:IBM.1750-1332950-P0</extent-pool-id> <create-status>0 (Success)</create-status> </volume> </volumes> </output> </response> </responses></ibm-ds68-storage-response>

Response 2: create-host-group<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>40782</execution-milliseconds> <line-count>10</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039C48-26</host-group-id> <volume-ids> <volume-id>IBM.1750-1332950-000f</volume-id> <volume-id>IBM.1750-1332950-0010</volume-id> </volume-ids> <port-names> <port-name>0000</port-name> <port-name>0001</port-name> </port-names> <wwn>21000024FF039C48</wwn>


Version 1.0.01


<create-status>0 (Success)</create-status> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>

Operation: decommission-server

Adapter Request Elements for 'decommission-server'Operation

Definition Required

storage-system-name

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

Valid value: Please refer to the get-storage-system s operation to list the validvalues of this field.


Yes

wwn Specifies the host-group-id or the hot name (wwn) that must be decommissioned. Ifno other host is associated to this host group then the host group itself will be deleted.Also, if the volume is not associated to any host group then the volume will bedeleted.

Valid value: Any valid string of 16 hexadecimal digits or please refer to get-host-group to list the valid values for this field


Yes

Sample Adapter Request for 'decommission-server'Operation <ibm-ds68-storage-request> <operation-name>delete-host-group</operation-name> <arguments> <argument> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039C50-28</host-group-id> <wwn>21000024FF039C50</wwn> </argument> </arguments> </ibm-ds68-storage-request>

Sample Adapter Response for 'decommission-server'Operation

Response 1: delete-host-group<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>4922</execution-milliseconds> <line-count>4</line-count>


Version 1.0.01


<target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <host-groups> <host-group> <storage-system-name>IBM.1750-1332950</storage-system-name> <host-group-id>IBM.1750-1332950-21000024FF039C50-28</host-group-id> <wwn>21000024FF039C50</wwn> <delete-status>0 (Success)</delete-status> </host-group> </host-groups> </output> </response> </responses></ibm-ds68-storage-response>

Response 2: delete-volume<ibm-ds68-storage-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>4469</execution-milliseconds> <line-count>5</line-count> <target>ibm-ds6000</target> <config-name>default</config-name> </metadata> <output> <volumes> <volume> <storage-system-name>IBM.1750-1332950</storage-system-name> <volume-ids> <volume-id>IBM.1750-1332950-0013</volume-id> <volume-id>IBM.1750-1332950-0014</volume-id> </volume-ids> <delete-status>0 (Success)</delete-status> </volume> </volumes> </output> </response> </responses></ibm-ds68-storage-response>

Index 89

Version 1.0.01


Index

- A -Adapter

Configuration 15

Install 7

Pre-requisites 10

Upload 7Adapter Module

Life Cycle 6Adapter Operation

add-port-to-host-group 20

add-rank-to-extent-pool 20

add-volume-to-host-group 20

add-volume-to-volume-group 20

create-host-group 20

create-volume 20

create-volume-group 20

delete-extent-pool 20

delete-host-group 20

delete-volume 20

delete-volume-group 20

get-disk 20

get-extent-pool 20

get-host 20

get-host-group 20

get-host-platform 20

get-port 20

get-raid-level 20

get-rank 20

get-storage-system 20

get-volume 20

get-volume-group 20

remove-port-from-host-group 20

remove-volume-from-host-group 20

remove-volume-from-volume-group 20Adapter Request

Writing 22Add

Items 18Assign

Storage Unit 10

- B -BMC

BMC Atrium Orchestrator Grid Manager 7,15

BMC Atrium Orchestrator Repository 7

Designer View 7

Development Studio 7

- C -Configuration

Actor Adapter 15

Grid Manager 15

IBM Adapter 15

IBM DS Storage Manager 10

Multiple 17

Port 10

SSL 10Create

Items 18

- D -Debug 18

Delete

Items 18Directory

SetupValidation 19

Utilities 19

Version 19Disk Operation

get-disk 43

- E -Element

Config 15

password 15

port 15

protocol 15

target 15

timeout-secs 15

user-name 15Elements

argument 80

Index 90

Version 1.0.01


Elements

arguments 80

extent-pool-id 80

extent-pool-name 80

operation-name 80

storage-system-name 80

target 80

timeout-secs 80

- H -Host Group Operations

add-port-to-host-group 45, 67

add-volume-to-host-group 45, 63

create-host-group 45, 58

delete-host-group 45, 60

get-host 45, 52

get-host-group 45, 46

get-host-platform 45, 56

get-port 45, 49

remove-port-from-host-group 45, 69

remove-volume-from-host-group 45, 65

- I -IBM

DS Storage Manager 10

IBM Storage Actor Adapter 20

IBM Storage Adapter Module 18Installation

Adapter 7

IBM DS Storage Manager 10Items

Add 18

Create 18

Delete 18

Remove 18

- L -Life Cycle

Adapter Module 6

- O -Operation

decommission-server 87

provision-server 84

- P -Package

aroar 7

roar 7Pre-requisites

Adapter 10Process name

Add Port to Host Group 20

Add Rank to Extent Pool 20

Add Volume to Host Group 20

Add Volume to Volume Group 20

Create Extent Pool 20

Create Host Group 20

Create Volume 20

Create Volume Group 20

Delete Extent Pool 20

Delete Host Group 20

Delete Volume 20

Delete Volume Group 20

Get Disk 20

Get Extent Pool 20

Get Host 20

Get Host Group 20

Get Host Platform 20

Get Port 20

Get RAID Level 20

Get Rank 20

Get Storage System 20

Get Volume 20

Get Volume Group 20

Remove Port from Host Group 20

Remove Volume From Host Group 20

Remove Volume from Volume Group 20Processes

Add 18

Create 18

Delete 18

General 19

Remove 18

Top-level 18

XML 19

- R -Remove

Index 91

Version 1.0.01


Remove

Items 18Request Elements

argument 22, 25, 27, 29, 32, 35, 36, 38,40, 43, 46, 49, 52, 56, 58, 60, 63, 65, 67,69, 72, 75, 78, 82

arguments 22, 25, 27, 29, 32, 35, 36, 38,40, 43, 46, 49, 52, 56, 58, 60, 63, 65, 67,69, 72, 75, 78, 82

array-site-id 43

disk-id 43

disk-speed 75

extent-pool 22, 25

extent-pool-id 72, 75, 82

extent-pool-name 72, 75, 78, 82

host-group-id 29, 46, 60, 69

host-platform 32

lss 25

number-of-volume 25

operation-name 22, 25, 27, 29, 32, 35,36, 38, 40, 43, 46, 49, 52, 56, 58, 60, 63,65, 67, 69, 72, 75, 78, 82

p-id 67

port-name 46, 49, 58, 67, 69

port-type 49

raid-level 75

rank-id 72, 75, 78, 82

rank-level 72

size 25

storage-system-name 22, 25, 27, 29, 32,35, 36, 38, 40, 43, 46, 49, 52, 56, 58, 60,63, 65, 67, 69, 72, 75, 78, 82

storage-type 72, 75, 78

target 22, 25, 27, 29, 32, 35, 36, 38, 40,43, 46, 49, 52, 56, 58, 60, 63, 65, 67, 69,72, 75, 78, 82

timeout-secs 22, 25, 27, 29, 32, 35, 36,38, 40, 43, 46, 49, 52, 56, 58, 60, 63, 65,67, 69, 72, 75, 78, 82

volume-group 22

volume-group-id 29, 35, 36, 38, 46, 58,63, 65

volume-group-name 29, 32, 35, 36, 38,58, 63, 65

volume-group-type 32

volume-id 22, 27, 29, 32, 36, 38, 46, 58,63, 65

volume-name 22, 25, 29, 36, 38, 46, 58,63, 65

volume-type 25

wwn 46, 52, 58, 60Requests

Actor Adapter 19

Typical 19Response Elements

add-status 36, 63, 67, 82

array-site-id 43

available-capacity-bytes 40, 72, 75

available-capacity-gigabytes 40, 72, 75

chassis-type 40

consumed-capacity-bytes 22, 29, 72, 75

consumed-capacity-gigabytes 22, 29, 72,75

create-status 25, 32, 58, 78

delete-status 27, 35, 60

disk-id 43

disk-speed 43

extent-pool-id 22, 25, 72, 75, 78, 82

extent-pool-name 22, 72, 75, 78, 82

extent-pool-type 72

host-group-id 46, 58, 60, 63, 65, 67, 69

host-name 52

host-platform 52, 56

lss 22

model 40

operational-status 22, 40, 43, 49

operational-status-description 22, 40, 43,49

port-name 46, 49, 58, 67, 69

port-speed 49

port-wwn 49

raid-level 22, 72, 75

rank-id 72, 75, 82

remove-status 38, 65, 69

size-bytes 22, 29, 40, 43, 72, 75

size-gigabytes 22, 29, 40, 43, 72, 75

storage-system-name 22, 25, 27, 29, 32,35, 36, 38, 40, 43, 46, 49, 56, 58, 60, 63,65, 67, 69, 72, 75, 78, 82

storage-type 75

subscribed-capacity-bytes 40, 72, 75

subscribed-capacity-gigabytes 40, 72, 75

volume-group-id 29, 32, 36, 38, 46, 58,63, 65

volume-group-name 22, 29, 32, 46

volume-group-type 29

volume-id 22, 25, 27, 29, 32, 36, 38

volume-name 22, 25, 29

wwn 46, 52, 58, 60

Index 92

Version 1.0.01


Responses

Actor Adapter 19

Typical 19

- S -Samples

Actor Adapter Configuration 15

Adapter Request 22, 25, 27, 29, 32, 35,36, 38, 40, 43, 46, 49, 52, 56, 58, 60, 63,65, 67, 69, 72, 75, 78, 80, 82, 84, 87

Adapter Response 22, 25, 27, 29, 32, 35,36, 38, 40, 43, 46, 49, 52, 56, 58, 60, 63,65, 67, 69, 72, 75, 78, 80, 82, 84, 87

SetupValidation

Directory 19Storage Pool Operations

add-rank-to-extent-pool 71, 82

create-extent-pool 71, 78

delete-extent-pool 71, 80

get-extent-pool 71, 72

get-raid-level 71

get-rank 71, 75Storage System Operation

get-storage-system 40Storage Unit

Assign 10Support 4

Multiple Configuration 17Supported

Versions 7

- T -Top-level 18

- U -UI Label

Password 15

Port 15

Protocol 15

Target 15

Timeout Secs 15

User Name 15Use Cases 84

Utilities

Directory 19

- V -Version

Directory 19Versions

Supported 7View

XML 15Volume Operations

add-volume-to-volume-group 22, 36

create-volume 22, 25

create-volume-group 22, 32

delete-volume 22, 27

delete-volume-group 22, 35

get-volume 22

get-volume-group 22, 29

remove-volume-from-volume-group 22,38

- W -Writing

Adapter Request 22

- X -XML

View 15

About BMC® SoftwareBMC Software, Inc. NYSE:BMC, is a leading provider of enterprise management solutionsthat empower companies to manage their IT infrastructure from a business perspective.Delivering Business Service Management, BMC Software solutions span enterprisesystems, applications, databases, and service management. Founded in 1980, BMCSoftware has offices worldwide and fiscal 2004 revenues of more than $1.4 billion. For

more information about BMC Software, visit www.bmc.com.

About Sentry Software™Sentry Software, a strategic Technology Alliance Partner of BMC Software, provides keymonitoring solutions specifically designed to expand the capabilities of BMCPerformance Manager, thus enabling up to 100% coverage of any infrastructure. SentrySoftware specializes in single solutions for multi-platform monitoring of hardware,custom applications or any IT component, and blackout windows. Sentry Softwareproducts are deployed in 45 countries across the globe and lead the list of BMCSoftware’s third-party product sales. For more information about Sentry Software,

please visit www.sentrysoftware.net.

Documents

BMC Atrium Orchestrator Application Adapter for …€¦ · BMC Atrium Orchestrator Application Adapter for IBM DS6000, ... decommission-server ... BMC Atrium Orchestrator Application