Volume management templates using CM REST API

Document created by Takeshi Arisaka on Sep 14, 2016Last modified by Takeshi Arisaka on Sep 14, 2016
Version 3Show Document
  • View in full screen mode

Overview

These service templates cover a volume management life cycle which current HAD does not cover yet. Current HAD mostly focuses on provisioning use cases with highly automated paths / pairs settings, which save huge operational cost for current customers. On the other hand, HAD does not support monitoring, optimization and delete use cases as a volume life cycle after volume created. Also, provisioning with flexible path setting is not covered by current HAD yet. The service templates focus on the use cases which the current HAD doesn't cover yet for volume management.

 

pastedImage_0.png

 

Service TemplateDescription
Allocate volumes with flexible paths Creates new volumes and sets LU paths by using CM REST API
Expand volumesExpands the specified DP volumes by using CM REST API
Monitor and expand volumesPeriodically monitors usage rate of the specified volumes by Tuning manager API. When the usage rate of the volumes exceeds the threshold specified by user, the service automatically expands the volumes by CM REST API.
Delete volumesDeletes the specified volumes with corresponding local copy pairs and lu paths by using CM REST API.

Download

VersionFileDescriptionTemplate IDVendor ID
00.01.00Download hereCreates new volumes and sets LU paths by using CM REST API.allocate.volumes.with.flexible.pathscom.hitachi.software
00.01.00Download hereExpands the specified DP volumes by using CM REST API.volume.expansioncom.hitachi.software
00.01.00Download herePeriodically monitors usage rate of the specified volumes by Tuning manager API. When the usage rate of the volumes exceeds the threshold specified by user, the service automatically expands the volumes by CM REST API.monitor.and.expand.volumescom.hitachi.software
00.01.00Download hereDeletes the specified volumes with corresponding local copy pairs and LU paths by using CM REST API.delete.volumescom.hitachi.software

How to use

Set up CM REST

 

1. Prepare management server to install CM REST.

2. Install CCI

3. Install HCS (Device Manager), then CM REST is also installed

4. Register storage admin users by Storage Navigator

5. Register storage system by CM REST API

See the attached document for setup CM API.

Set up HTnM

If you use "Monitor and expand volumes" service template, set up HTnM.

See HTnM manual to setup the HTnM REST API.

Input / output properties

See the document for the input / output parameters.

 

Detail Information

Allocate volume with flexible paths

 

The "Allocate volume with flexible paths" service allows volume creation and path allocation with flexible path setting. You can create up to 32 volumes at the same time. If Host Group is not created yet, the service creates and you can also add WWNs to it. If Host Group exists, the service skips it.

 

allocate-1.PNG

 

Required HCS REST APIs are listed in the following:

Common API to call the REST API.

 

API Description
Generating sessions The request generates sessions and manages the sessions on the REST server. A maximum of 16 sessions can be generated for each disk controller.
Discarding sessions The request discards the sessions that are no longer required. If a session is discarded, the lock obtained in that session is unlocked at the same time. For the Authorization header of the request, specify the token for a session to be discarded.

 

Specific API for this "Allocate volume with flexible paths" template.

 

API Description

Getting volume infomation

The request obtains information about multiple LDEVs. You can get information about consecutive LDEVs by specifying the number of the first LDEV and the number of LDEVs. You can also get information filtered by LDEV conditions (attributes) or resource group.
Creating a volumeThe request creates a volume by using the specified parity groups or pools. Specify a parity group for creating a basic volume, an external parity group (external volume group) for creating the external volume, and a pool for creating a virtual volume (a DP volume or a virtual volume for Thin Image).
Getting information about host groups or iSCSI targetsThe request gets information about host groups or iSCSI targets of the port.
Creating a host group or an iSCSI targetThe request creates a host group for the port. For an iSCSI port, this request creates the iSCSI target and the iSCSI name. The host mode and the host mode option can also be specified at the same time when the host group and the iSCSI target are created.
Getting WWN informationSpecifying a port and host group, the request below gets the information about the WWN registered for the host group.
Registering a WWN for the host groupThe request registers the host bus adapter WWN for the host group of the specified port.
Getting iSCSI namesSpecifying a port and host group, the request below gets the information

about the WWN registered for the host group.

Registering the iSCSI name for the iSCSI target For the iSCSI target of the specified port, the request below registers the iSCSI name of the host on the initiator side.
Getting information about an LU pathThe request gets information about an LU path defined for the iSCSI target or the host group for the port.
Setting the LU pathThe request sets the LU path by mapping the LDEV with the LUN in the host group or in the iSCSI target of the specified port.

 

Expand volumes

The "Expand volumes" servive simply expands specified DP-vols capacity. Specify capacity to add.

 

expand.PNG

 

Common API to call the REST API.

 

APIDescription
Generating sessionsThe request generates sessions and manages the sessions on the REST server. A maximum of 16 sessions can be generated for each disk controller.
Discarding sessions The request discards the sessions that are no longer required. If a session is discarded, the lock obtained in that session is unlocked at the same time. For the Authorization header of the request, specify the token for a session to be discarded.

"Expand volumes" service utilizes the following HCS REST API.

 

API Description
Expanding the capacity of a volume(Action template)The request expands the capacity of a DP volume.
Expanding the capacity of a volumeThe request expands the capacity of a DP volume.

 

Monitor and expand volumes

The "Monitor and expand volumes" service periodically monitor the specified DP-vols consumed capacity. Once the consumed capacity is over threshold(%) which you specified, the service automatically expands the DP-vol capacity which is also specified percentage. HAD does support "daily" recursive operation but doesn't support "hourly". Daily interval could be too long for most users, so the contents provide 4 hours as the shortest. Unfortunately, HAD doesn't allow double loop, so we could not put loop for the purpose. Therefore, we put 6 "Expand volumes" service template to change the minimum interval (24h / 6 = 4h for minimum interval). Top left recursive part of the following image manages result of the contents (success or failed, if failed, register detailed error information.)

monitor_expand.PNG

"Expand volumes" service utilizes the following HCS REST APIs and HTnM REST API.

 

API Description
Virtual Volume Configuration(PD_VVC)The request gets a performance data of PD_VVC records.
Expanding the capacity of a volume(Action template)The request gets an action template to expand the capacity of a DP volume.
Expanding the capacity of a volumeThe request expands the capacity of a DP volume.

 

Delete volumes

The "Delete volumes" allows not only delete volumes, but also delete the other related resource e.g. local copys and paths. For your information, to delete Shadow Image pairs, it uses copy group and device group information defined in storage system. Therefore, if the information is not defined in the storage (just defined in HORCM file for example), the service is not able to delete the pairs. For thin image pairs, it uses raidcom commands internally, so you can delete thin image pairs defined by raidcom command. If the thin image pairs are defined other than raidcom commands, the service cannot delete the pairs. If the all volumes which belongs to a host group are deleted, the service also deletes the host group.

 

un-allocate.PNG

 

Common API to call the REST API.

 

APIDescription
Generating sessionsThe request generates sessions and manages the sessions on the REST server. A maximum of 16 sessions can be generated for each disk controller.
Discarding sessions The request discards the sessions that are no longer required. If a session is discarded, the lock obtained in that session is unlocked at the same time. For the Authorization header of the request, specify the token for a session to be discarded.
"Delete volumes" service utilizes the following HCS REST APIs.

 

 

API Description
Getting information about Thin Image pairs in units of snapshot groupsThe request gets information about Thin Image pairs in units of snapshot groups. Use this information to check the information that is necessary for performing pair operations (for example, the pair status).
Deleting a Thin Image pairThe request deletes the specified Thin Image pair. When the pair is deleted, the snapshot data is also deleted.
Getting a list of copy groupsThe request gets information about the copy groups containing ShadowImage pairs in the storage system.
Getting information about ShadowImage pairs in the specified copy groupThe request gets information about the specified copy group. This request also gets information about ShadowImage pairs included in the copy group. The request below can be used to check the pair status or get configuration information about the pairs.
Splitting ShadowImage pairs in units of copy groupsThe request splits the ShadowImage pairs included in the specified copy group. If the pair is split, data can be read from or written to the secondary volume.
Deleting a ShadowImage pairThe request deletes the specified ShadowImage pair. If there is no ShadowImage pair in the copy group, the copy group and the device group that makes up of the copy group are also deleted.
Getting volume informationThe request obtains information about multiple LDEVs. You can get information about consecutive LDEVs by specifying the number of the first LDEV and the number of LDEVs. You can also get information filtered by LDEV conditions (attributes) or resource group.
Deleting a LU pathThe request deletes the LU path defined for the host group or iSCSI target of the specified port.
Deleting a volumeThe request deletes an LDEV (basic volume) or a virtual volume (a DP volume or a virtual volume for Thin Image).
Getting information about an LU pathThe request gets information about an LU path defined for the iSCSI target or the host group for the port.
Deleting a host group or the iSCSI targetThe request deletes the WWN and LUN settings of a host group or of a host registered in a host group. Alternatively, the request below deletes the LUN setting and iSCSI name of an iSCSI target or of a host (iSCSI initiator) registered for the iSCSI target. If the host group number of the host group to

be deleted (target ID for the iSCSI port) is 0, the settings

 

Outcomes