Contents

Dell EMC VMAX 100K V9.0 Storage REST API Change Log PDF

1 of 110
1 of 110

Summary of Content for Dell EMC VMAX 100K V9.0 Storage REST API Change Log PDF

Dell EMC Unisphere for PowerMax 9.0

REST API Change Log

Page 2 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Copyright 2014-2018 Dell Inc. or its subsidiaries. All rights reserved. Published May, 2018 Dell believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS-IS. DELL MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. USE, COPYING, AND DISTRIBUTION OF ANY DELL SOFTWARE DESCRIBED IN THIS PUBLICATION REQUIRES AN APPLICABLE SOFTWARE LICENSE. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property of their respective owners. Published in the USA. Dell EMC Hopkinton, Massachusetts 01748-9103 1-508-435-1000 In North America 1-866-464-7381 www.DellEMC.com

Page 3 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Table of Contents

1  Design ......................................................................................................................................................... 6 

2  Design Overview ......................................................................................................................................... 6 

2.1  Overall ................................................................................................................................................. 6 

2.2  Performance ........................................................................................................................................ 6 

2.3  SLO Provisioning ................................................................................................................................. 6 

2.4  Provisioning ......................................................................................................................................... 6 

2.5  Replication ........................................................................................................................................... 6 

2.6  Migration .............................................................................................................................................. 6 

2.7  VVOL ................................................................................................................................................... 6 

2.8  WLP ..................................................................................................................................................... 6 

2.9  System ................................................................................................................................................. 7 

2.10  DSA ..................................................................................................................................................... 7 

2.11  Management ........................................................................................................................................ 7 

2.12  Common .............................................................................................................................................. 7 

3  Design Details ............................................................................................................................................. 7 

3.1  Overall ................................................................................................................................................. 7 

3.2  Performance ........................................................................................................................................ 7 

3.2.1  IPInterface 9.0 Additional metrics ................................................................................................. 7 

3.2.2  ISCSITarget 9.0 Additional metrics .............................................................................................. 9 

3.2.3  Storage Group 9.0 Additional metrics ........................................................................................ 12 

3.2.4  Array 9.0 Additional metrics ....................................................................................................... 14 

3.3  SLO Provisioning ............................................................................................................................... 18 

3.3.1  Symmetrix .................................................................................................................................. 18 

3.3.2  Storagegroup .............................................................................................................................. 22 

3.3.3  PowerPathHost .......................................................................................................................... 29 

3.3.4  Host ............................................................................................................................................ 34 

3.3.5  Initiators ...................................................................................................................................... 36 

Page 4 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.3.6  Volume ....................................................................................................................................... 38 

3.3.7  SRP ............................................................................................................................................ 43 

3.3.8  Director ....................................................................................................................................... 54 

3.3.9  Port ............................................................................................................................................. 54 

3.4  Provisioning ....................................................................................................................................... 55 

3.4.1  Symmetrix .................................................................................................................................. 55 

3.4.2  Storagegroup .............................................................................................................................. 58 

3.4.3  Volume ....................................................................................................................................... 61 

3.5  Replication ......................................................................................................................................... 65 

3.5.1  SRDF Group ............................................................................................................................... 65 

3.5.2  SRDF Port .................................................................................................................................. 67 

3.6  Migration ............................................................................................................................................ 67 

3.7  VVol ................................................................................................................................................... 67 

3.8  WLP ................................................................................................................................................... 67 

3.9  System ............................................................................................................................................... 68 

3.9.1  IpRoute ....................................................................................................................................... 68 

3.9.2  Director ....................................................................................................................................... 73 

3.9.3  iSCSI Target (Port) ..................................................................................................................... 75 

3.9.4  Ip Interface ................................................................................................................................. 87 

3.10  DSA ................................................................................................................................................... 95 

3.11  Management ...................................................................................................................................... 95 

3.12  Common ............................................................................................................................................ 95 

4  Appendix ................................................................................................................................................... 95 

4.1  Basic Authentication .......................................................................................................................... 95 

4.2  Request Types .................................................................................................................................. 96 

4.2.1  GET (OBJECT) .......................................................................................................................... 96 

4.2.2  GET (LIST) ................................................................................................................................. 97 

4.2.3  POST .......................................................................................................................................... 99 

Page 5 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

4.2.4  PUT .......................................................................................................................................... 102 

4.2.5  DELETE ................................................................................................................................... 104 

4.3  Common Objects ............................................................................................................................. 105 

4.3.1  Iterator ...................................................................................................................................... 105 

4.3.2  Job ............................................................................................................................................ 107 

4.3.3  Configuration Management Type ............................................................................................. 109 

4.4  Automatic Cleanup of REST API jobs ............................................................................................. 109 

Page 6 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

1 Design

2 Design Overview

This document describes the changes in the current release of the public Unisphere for PowerMax REST (Representational State Transfer) API. This overview gives a concise description of the changes. Details for each of the changes are provided in the relevant resource sections. For common REST API behavior, see the Appendix.

2.1 Overall N/A

2.2 Performance Add new 9.0 Metrics to existing Categories

1. IP Interface 2. iSCSI Target 3. Storage Group 4. Array

2.3 SLO Provisioning Additional URLs, parameters or both Removal of Director & Director-Port implementations

2.4 Provisioning N/A

2.5 Replication Addition of filtering for GET list lookup of SRDF Groups Addition of PUT action to allow Move Pairs functionality for SRDF Groups Adding WWNs for SRDF ports Changed StorageGroupRdfg attribute names

o srcR1InvalidTracksHop1 to localR1InvalidTracksHop1 o srcR2InvalidTracksHop1 to localR2InvalidTracksHop1 o tgtR1InvalidTracksHop1 to remoteR1InvalidTracksHop1 o tgtR2InvalidTracksHop1 to remoteR2InvalidTracksHop1

2.6 Migration N/A

2.7 VVOL N/A

2.8 WLP N/A

Page 7 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

2.9 System Addition of iSCSI IP Route implementation for GET(Object), GET(List), POST and DELETE Addition of Director implementation for GET(Object), GET(List) Addition of iSCSI Target (Port) implementation for GET(Object), GET(List), POST, PUT and DELETE Addition of IP Interface implementation for GET(Object), GET(List), POST, PUT and DELETE

2.10 DSA N/A

2.11 Management N/A

2.12 Common N/A

3 Design Details

3.1 Overall N/A

3.2 Performance

3.2.1 IPInterface 9.0 Additional metrics

User Story

Resource IPInterface

Request Type: POST

Description: This POST queries a list of performance data for a specific IP Interface and metrics for a given time range

URL: /restapi/performance/IPInteface/metrics

User Roles: Admin/Storage Admin/Security Admin/Monitor/Auditor/Performance Monitor

Perquisites: symmetrixId must be a local symm that is registered for stats collection and there must be an ISCSI Director with IO activity

Path Parameters: N/A

Query Parameters: N/A

Request Parameters:

Object projectionParam

Name Type Optional Description

Page 8 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

symmetrixId String No The Id of the Symmetrix to be queried

startDate long No Starting Date in milliseconds since epoch

endDate long No End Date in milliseconds since epoch

ipInterfaceId String No ipInterfaceId from IPInterface/keys call

metrics List

Response Parameters:

Object HostKeyResultType

Name Type Optional Description

3.2.1.1 Sample JSON Request:

{

"symmetrixId": "000297000453",

"ipInterfaceId": "SE-1E:24:9:192.168.0.42",

"endDate": 1509462300000,

"dataFormat": "Average",

"metrics": ["Reads",

"Writes",

"IoRate",

"TotalReadTime",

"TotalWriteTime",

"ResponseTime"],

Page 9 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"startDate": 1509452400000

}

3.2.1.2 Sample JSON Response:

{

"resultList": {

"result": [

{

"Reads": 0,

"Writes": 0,

"IoRate": 0,

"TotalReadTime": 0,

"TotalWriteTime": 0,

"ResponseTime": 0,

"timestamp": 1509452400000

}

]

}

}

3.2.2 ISCSITarget 9.0 Additional metrics

User Story

Resource ISCSITarget

Request Type: POST

Description: This POST call queries a list of performance data for a specific ISCSI Target and metrics for a given time range

URL: /restapi/performance/ISCSITarget/metrics

User Roles: Admin/Storage Admin/Security Admin/Monitor/Auditor/Performance Monitor

Page 10 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Perquisites: symmetrixId must be a local symm that is registered for stats collection and there must be active hosts for the passed in time range

Path Parameters: N/A

Query Parameters: N/A

Request Parameters:

Object ISCSITargetParam

Name Type Optional Description

symmetrixId String No The Id of the Symmetrix to be queried

startDate long No Starting Date in milliseconds since epoch

endDate long No End Date in milliseconds since epoch

dataFormat String No Average or Maximum

iSCSITargetId String No iSCSITargetId

metrics List

No List of Metrics as defined in RESTAPI documentation

Response Parameters:

Object ISCSITargetResult

Name Type Optional Description

MBs float Yes

PacketCount float Yes

Reads float Yes

Writes float Yes

IoRate float Yes

TotalReadTime float Yes

TotalWriteTime float Yes

ResponseTime float Yes

Page 11 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

timestamp DateType Yes

3.2.2.1 Sample JSON Request:

{

"symmetrixId": "000197800128",

"endDate": 1484151300000,

"dataFormat": "Average",

"metrics": [

"Reads",

"Writes",

"IoRate",

"TotalReadTime",

"TotalWriteTime",

"ResponseTime"

],

"iSCSITargetId": "iqn.1992-04.com.emc:600009700bca30c01f86011800000000",

"startDate": 1484149500000

}

3.2.2.2 Sample JSON Response:

{

"resultList": {

"result": [

{

"Reads": 0,

"Writes": 0,

"IoRate": 0,

"TotalReadTime": 0,

"TotalWriteTime": 0,

Page 12 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"ResponseTime": 0,

"timestamp": 1484149500000

}

]

}

}

3.2.3 Storage Group 9.0 Additional metrics

User Story

Resource StrorageGroup

Request Type: POST

Description: This POST call queries a list of performance data for a specific storage group and specific metrics for a given time range

URL: /restapi/performance/StorageGroup/metrics

User Roles: Admin/Storage Admin/Security Admin/Monitor/Auditor/Performance Monitor

Perquisites: symmetrixId must be a local symm that is registered for stats collection and the symm must be set up for Storage Group

Path Parameters: N/A

Query Parameters:

N/A

Request Parameters:

Object StorageGroupParam

Name Type Optional Description

symmetrixId String No The Id of the Symmetrix to be queried

startDate long No Starting Date in milliseconds since epoch

endDate long No End Date in milliseconds since epoch

storageGroupId String No storageGroupId

Page 13 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

dataFormat String Enum: Average or maximum No Average or maximum values

Metrics List

No See RESTAPI Documents for list of Possible Values

Response Parameters:

Object IIterator

Name Type Optional Description

See RESTAPI Documents for list of Possible Values

3.2.3.1 Sample JSON Request:

{

"symmetrixId": "000197800128",

"endDate": 1484151300000,

"dataFormat": "Average",

"storageGroupId": "irco2sd1",

"metrics": [

"PPAvgResponseTime",

"PPObservedDeltaRT",

"PPRelativeRT"

],

"startDate": 1484149500000

}

3.2.3.2 Sample JSON Response:

{

"resultList": {

Page 14 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"result": [

{

"PPAvgResponseTime": 0,

"PPObservedDeltaRT": 0,

"PPRelativeRT": 0,

"timestamp": 1484149500000

}

]

}

}

3.2.4 Array 9.0 Additional metrics

User Story

Resource Array

Request Type: POST

Description: This POST call queries a list of performance data for a specific Array and metrics for a given time range

URL: /restapi/performance/Array/metrics

User Roles: Admin/Storage Admin/Security Admin/Monitor/Auditor/Performance Monitor

Perquisites: symmetrixId must be a local symm that is registered for stats collection and there must be active hosts for the passed in time range

Path Parameters: N/A

Query Parameters: N/A

Request Parameters:

Object arrayParam

Name Type Optional Description

symmetrixId String No The Id of the Symmetrix to be queried

startDate long No Starting Date in milliseconds since epoch

Page 15 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

endDate long No End Date in milliseconds since epoch

dataFormat String No Average or Maximum

metrics List < ArrayMetric>

No List of Metrics as defined in RESTAPI documentation

Response Parameters:

Object ArrayResultType

Name Type Optional Description

See RESTAPI Documents for list of Possible Values

3.2.4.1 Sample JSON Request:

{

"symmetrixId": "000197800128",

"endDate": 1484151300000,

"dataFormat": "Average",

"metrics": [

"HWConfigHS",

"CapacityHS",

"SubscribedCapacityTB",

"UsableCapacityTB",

"AllocatedCapacityTB",

"PercentMetaBEUsed",

"PercentMetaFEUsed",

"SnapModifiedCapGB",

"SnapModifiedCapTB",

Page 16 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"SnapCapGB",

"SnapCapTB",

"UsedUsableCapGB",

"UsedUsableCapTB",

"SubscribedAllocatedCapGB", 

"SubscribedAllocatedCapTB"

],

"startDate": 1484149500000

}

3.2.4.2 Sample JSON Response:

{

"resultList": {

"result": [

{

"HWConfigHS": 0,

"CapacityHS": 100,

"SubscribedCapacityTB": 36.74133,

"UsableCapacityTB": 19.507324,

"AllocatedCapacityTB": 1.8861599,

"PercentMetaBEUsed": 0,

"PercentMetaFEUsed": 0,

"SnapModifiedCapGB": 0,

"SnapModifiedCapTB": 0,

"SnapCapGB": 0,

"SnapCapTB": 0,

"UsedUsableCapGB": 1931,

"UsedUsableCapTB": 1.8857422,

Page 17 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"SubscribedAllocatedCapGB": 3568, 

"SubscribedAllocatedCapTB": 3.484375,

"timestamp": 1484149500000

}

]

}

}

Page 18 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.3 SLO Provisioning

3.3.1 Symmetrix

3.3.1.1 GET (Object)

User Story

(for Internal use only)

Resource symmetrix

Request Type:

GET

Description: Adding the following entities to the Symmetrix object

system_capacity

o subscribed_allocated_tb

o subscribed_total_tb

o usable_used_tb

o usable_total_tb

o snapshot_modified_tb

o snapshot_total_tb

o subscribed_usable_capacity_percent

system_efficiency

o overall_efficiency_ratio_to_one

o data_reduction_ratio_to_one

o data_reduction_enabled_percent

o virtual_provisioning_savings_ratio_to_one

o snapshot_savings_ratio_to_one

Removing the following attributes to the Symmetrix object:

overall_efficiency_ratio_to_one

VP_overall_efficiency_ratio_to_one

VP_saved_percent

VP_shared_ratio_to_one

snapshot_overall_efficiency_ratio_to_one

snapshot_saved_percent

snapshot_shared_ratio_to_one

compression_overall_ratio_to_one

compression_VP_ratio_to_one

Page 19 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

compression_snapshot_ratio_to_one

compression_enabled

system_meta_data_used_percent

replication_cache_used_percent

total_subscribed_cap_gb

total_allocated_cap_gb

total_usable_cap_gb

effective_used_capacity_percent

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/

User Roles: No change

Prerequisite :

Not applicable

Path Parameters:

No change

Query Parameters:

No change

Request Parameters:

Not applicable

Response Parameters:

Object SymmetrixType

Attribute Name Type Optiona l

Descriptio n

system_capacity

SystemCapacityType

Yes Contains the System level capacity informatio n

system_efficiency SystemEfficiencyTyp e

Yes Contains the System level Efficiency informatio n

overall_efficiency_ratio_to_one double Yes

VP_overall_efficiency_ratio_to_one double Yes

VP_saved_percent double Yes

Page 20 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

VP_shared_ratio_to_one double Yes

snapshot_overall_efficiency_ratio_to_on e

double Yes

snapshot_saved_percent double Yes

snapshot_shared_ratio_to_one double Yes

compression_overall_ratio_to_one double Yes

compression_VP_ratio_to_one double Yes

compression_enabled double Yes

system_meta_data_used_percent double Yes

replication_cache_used_percent double Yes

total_subscribed_cap_gb double Yes

total_allocated_cap_gb double Yes

total_usable_cap_gb double Yes

effective_used_capacity_percent double Yes

Object SystemCapacityType

Attribute Name Type Optional Description

subscribed_allocated_tb double

Yes Host allocated plus eNas allocated capacity in TBs

subscribed_total_tb

double

Yes Host subscribed capacity plus eNas subscribed capacity in TBs

usable_used_tb

double

Yes Total Capacity in TBs used by Host, eNas and System after Data reduction is applied

usable_total_tb

double

Yes Total system usable capacity in TBs

snapshot_modified_tb

double

Yes Host snapshot modified capacity plus

Page 21 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

eNas snapshot modified capacity in TBs

snapshot_total_tb

double

Yes Host snapshot capacity plus eNas snapshot capacity in TBs

subscribed_usable_capacity_percent

double

Yes ercentage of Usable Capacity that is currently Subscribed. Can be over 100% due to Virtual Provisioning.

Object SystemEfficiencyType

Attribute Name Type Optional Description

overall_efficiency_ratio_to_one

double

Yes Overall Efficiency Ratio is the ratio between the sum of subscribed and snapshot capacity for user devices and the user used capacity. Format: "1.0:1" will be returned as 1.0.

data_reduction_ratio_to_one

double

Yes Data Reduction Ratio is the ratio between the sum of owned and RDP logical (128K track size) capacity for all compression enabled devices and the user used capacity for all compression enabled devices. Format: "1.0:1"

Page 22 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

will be returned as 1.0.

data_reduction_enabled_percent

double

Yes Data Reduction Enabled Percent represents the combined effect of compression and deduplication.

virtual_provisioning_savings_ratio_to_one

double

Yes Virtual Provisioning Savings Ratio is the ratio between the subscribed capacity for user devices and the difference between allocated and shared capacity for user devices. Format: "1.0:1" will be returned as 1.0.

snapshot_savings_ratio_to_one

double

Yes Snapshot Savings Ratio is the ratio between snapshot capacity and the difference between modified snapshot capacity and non shared snapshot capacity. Format: "1.0:1" will be returned as 1.0.

3.3.2 Storagegroup

3.3.2.1 PUT

User Story

Page 23 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

(for Internal use only)

Resource storagegroup

Request Type:

PUT

Description: Adds new functionality to an existing storage group

Move Volume To Storage Group: Moves specified volumes from the specified storage group to another storage group

Split Child Storage Group: Splits a child Storage Group from its parent storage group and creates a new masking view for the child storage group.

Split Storage Group Volumes: Splits volumes from a standalone storage group and adds them to a new storage group and new masking view.

Merge Storage Group: Merge a defined standalone storage group into the chosen parent or standalone storage group.

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/storagegroup/{storageGroupId}

User Roles: Administrator/Storage Administrator

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

Not applicable

Page 24 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Request Parameters:

Object MoveVolumeToStorageGroupParamType

Attribute Name Type Optional Description

volumeId

Array No A list of Volumes to be moved

storageGroupId

StorageGroupIdTypeVer2

No Storage group to which the volumes will be moved to.

force

boolean Yes Force move True or False

Object SplitChildStorageGroupParamType

Attribute Name Type Optional Description

storageGroupId StorageGroupIdTypeVer2 No The Child storage group Name to split from selected parent Storage Group.

maskingViewId MaskingViewIdTypeVer2 Yes The New Masking View Name

Object SplitStorageGroupVolumesParamType

Attribute Name Type Optional Description

volumeId Array No Volume(s) to be split

storageGroupId

StorageGroupIdTypeVer2

No The New Storage group to which the volumes will be added.

maskingViewId MaskingViewIdTypeVer2 Yes The New Masking View Name

Object MergeStorageGroupParamType

Attribute Name Type Optional Description

Page 25 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

storageGroupId

StorageGroupIdTypeVer2

No The Standalone Storage Group that will be merged into the selected Standalone or Parent Storage Group

Response Parameters: SYNCHRONOUS:

Object storagegroup

Attribute Name Type Optional Description

No change

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

No change

3.3.2.1.1 Sample Move Volumes JSON Request

{

"editStorageGroupActionParam": {

"moveVolumeToStorageGroupParam":{

"volumeId": [00001,0002],

"storageGroupId": SG_NAME,

}

Page 26 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

}

}

3.3.2.1.2 Sample Split Child Storage Group and Create MV JSON Request

{

"editStorageGroupActionParam": {

"splitChildStorageGroupParam": {

"storageGroupId": SG_NAME

"maskingViewId": MV_NAME,

}

}

}

3.3.2.1.3 Sample Split Storage Group Volumes into new Stoage Group and Create MV JSON Request

{

"editStorageGroupActionParam": {

"splitStorageGroupVolumesParam": {

"volumeId": [00001,0002],

"storageGroupId": SG_NAME

"maskingViewId": MV_NAME,

}

}

}

3.3.2.1.4 Sample Merge Standalone Sg into Sg JSON Request

{

"editStorageGroupActionParam": {

"mergeStorageGroupParam": {

"storageGroupId": SG_NAME

}

}

}

Page 27 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.3.2.2 GET (List)

User Story

(for Internal use only)

US21393

Resource storagegroup

Request Type: GET

Description: Adds the following filter options to storage Group list:

powerPathHostId

URL: /84/sloprovisioning/symmetrix/{symmetrixId}/storagegroup

User Roles: No change

Prerequisite: Not applicable

Path Parameters: No change

Query Parameters: Attribute Name Type Description

powerPathHostId String Optional value that filters returned list to display Storage Group Names that are assocated with Power Path Host Names equal to or specified powerPathHostId e.g. powerPathHostId=< like>pp_

Existing attributes

Request Parameters: Not applicable

Response Parameters:

No change

3.3.2.3 PUT (Expand volumes).

User Story

(for Internal use only)

US24707

Resource volumes

Request Type:

PUT

Description: Adds new functionality to an existing volumes

Expands volumes size when in rdf (expanding the remote and the local volumes).

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/volume/{volumeId}

Page 28 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

User Roles: Administrator/Manager

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

Not applicable

Request Parameters:

Object ExpandVolumeParamType

Attribute Name Type Optional Description

rdfGroupNumber

long Yes The rdf group number

Response Parameters: SYNCHRONOUS:

Object volume

Attribute Name Type Optional Description

No change

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

No change

Page 29 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.3.2.3.1 Sample Expand Volumes JSON Request

{

"editVolumeActionParam":

{

"expandVolumeParam" :

{

"volumeAttribute":

{

"capacityUnit": "GB",

"volume_size": 7

},

"rdfGroupNumber" : 2

}

}

}

3.3.3 PowerPathHost

3.3.3.1 GET (Object)

User Story

(for Internal use only)

US21393

Resource powerpathhost

Request Type: GET

Description: Returns a PowerPath Host Object

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/powerpathhost/{powerPathHostId}

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

powerPathHostId String No The PowerPath Host Name

Query Parameters: Not applicable

Request Parameters:

Not applicable

Response Parameters:

Page 30 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Object powerpathHost

Attribute Name Type Optional Description

powerPathHostId String No The PowerPath Host Name

version String Yes The PowerPath Host Version

patch_level String Yes The PowerPath Host Patch Level

os_version String Yes The PowerPath Host Opeating System Version

os_revision String Yes The PowerPath Host Opeating System Revision

os_patch_level String Yes The PowerPath Host Opeating System Patch Level

vendor String Yes The PowerPath Host Hardware Vendor

license_info String Yes The PowerPath Host License Info

registration_date String Yes The PowerPath Host Registration Date on the VMAX

registration_date_milliseconds long Yes The PowerPath Host Registration Date in milliseconds since EPOCH on the VMAX

connectivity_type String Yes The PowerPath Host Connectivity Type (iSCSI or Fibre)

cluster_name String Yes The PowerPath Host Cluster Name

cluster_node_name String Yes The PowerPath Host Clsuter Node Name

Page 31 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

num_of_wwns long Yes Number of wwns associated with the PowerPath Host

wwns Array Yes A list of associated wwns

num_of_hosts long Yes Number of hosts associated with the PowerPath Host

hosts Array Yes A list of associated Host Ids

num_of_vms long Yes Number of vms associated with the PowerPath Host

vms Array Yes A list of associated vms

3.3.3.1.1 Sample JSON response

{

"powerPathHostId": pp_host_Name,

"version": 2.5.6,

"patch_level": 1.56,

"os_version": 2.6.2,

"os_revision": 194.58,

"os_patch_level": 1.2.3.4,

"vendor": Dell,

"license_info": pp_license_info,

"registration_time": Mar-05-2017 14:20:12.000,

"registration_time_milliseconds": 151131651651651,

"connectivity_type": Fibre,

"cluster_name": pp_cluster_name,

"cluster_node_name": pp_cluster_node_name,

Page 32 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"num_of_wwns": 0,

"num_of_hosts": 0,

"num_of_vms": 0,

"hosts ":[ Host1 ],

"wwns ":[ 1253689578899569,7896554464645656 ],

"vms ":[ vm_1,vm_2 ]

}

3.3.3.2 GET (List)

Resource US21393

Resource powerpathhost

Request Type: GET

Description: Lists all PowerPath Hosts On the specified Symmetrix

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/powerpathhost

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

Query Parameters: Attribute Name Type Description

powerPathHostId String Optional value that filters returned list to display PowerPath Host Names that are equal to or specified powerPathHostId e.g. powerPathHostId=< like>pp_

version String Optional value that filters returned list to display PowerPath Host Names that have a version equal to or specified version e.g. version=< like>123

patch_level String Optional value that filters returned list to display PowerPath Host Names that have a patch_level equal to or specified patch_level e.g. patch_level=< like>123

Page 33 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

os_version String Optional value that filters returned list to display PowerPath Host Names that have a os_version equal to or specified os_version e.g. os_version=< like>123

os_revision String Optional value that filters returned list to display PowerPath Host Names that have a os_revision equal to or specified os_revision e.g. os_revision=< like>123

os_patch_level String Optional value that filters returned list to display PowerPath Host Names that have a os_patch_level equal to or specified os_patch_level e.g. os_patch_level = 123

vendor String Optional value that filters returned list to display PowerPath Host Names that have a vendor equal to or specified vendor e.g. vendor =< like>123

license_info String Optional value that filters returned list to display PowerPath Host Names that have a license_info equal to or specified license_info e.g. license_info=< like>123

registration_date String Optional value that filters returned list to display PowerPath Host Names that contain greater than(">1"), Less than("<1") or equal to the specified date "MMM-dd-yyyy HH:mm:ss.SSS"

registration_date_milliseconds String Optional value that filters returned list to display PowerPath Host Names that contain greater than(">1"), Less than("<1") or equal to the specified date in milliseconds

connectivity_type String Optional value that filters returned list to display PowerPath Host Names that have a connectivity_type equal to or specified connectivity_type e.g. connectivity_type=< like>123

cluster_name String Optional value that filters returned list to display PowerPath Host Names that have a cluster_name equal to or specified cluster_name e.g. cluster_name=< like>123

Page 34 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

cluster_node_name String Optional value that filters returned list to display PowerPath Host Names that have a cluster_node_name equal to or specified cluster_node_name e.g. cluster_node_name=< like>123

num_of_wwns String Optional value that filters returned list to display PowerPath Host Names that contain greater than(">1"), Less than("<1") or equal to the num_of_wwns

num_of_hosts String Optional value that filters returned list to display PowerPath Host Names that contain greater than(">1"), Less than("<1") or equal to the num_of_hosts

num_of_vms String Optional value that filters returned list to display PowerPath Host Names that contain greater than(">1"), Less than("<1") or equal to the num_of_vms

hostId String Optional value that filters returned list to display PowerPath Host names that are associated with the specified host e.g. equal to "hostId=abc" or contains "hostId= a"

wwn String Optional value that filters returned list to display PowerPath Host names that are associated with the specified wwn e.g. equal to "wwn=abc" or contains "wwn= a"

Request Parameters: Not applicable

Response Parameters:

Object ListPowerPathHostResult

Attribute Name Type Optional Description

powerPathHostId String array No A list of PowerPath Host names

3.3.4 Host

3.3.4.1 GET (List)

User Story

(for Internal use only)

US21393

Page 35 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Resource host

Request Type: GET

Description: Adds the following filter options to Host list:

powerPathHostId

num_of_powerpath_hosts

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/host

User Roles: No change

Prerequisite: Not applicable

Path Parameters: No change

Query Parameters: Attribute Name Type Description

powerPathHostId String Optional value that filters returned list to display Host Names that are assocated with Power Path Host Names equal to or specified powerPathHostId e.g. powerPathHostId=< like>pp_

num_of_powerpath_hosts String Optional value that filters returned list to display Host names that contain greater than("num_of_powerpath_hosts =>1"), Less than("num_of_powerpath_hosts =<1") or equal to the specified num_of_powerpath_hosts

Existing attributes

Request Parameters: Not applicable

Response Parameters:

No change

3.3.4.2 GET (Object)

User Story

(for Internal use only)

US21393

Resource host

Request Type: GET

Description: Adding the following to the Host objects:

powerpathhosts

num_of_powerpath_hosts

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/host/{hostId}

Page 36 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

User Roles: Not applicable

Prerequisite: Not applicable

Path Parameters: Not applicable

Query Parameters: Not applicable

Request Parameters: Not applicable

Response Parameters:

Object Host

Attribute Name Type Optional Description

powerpathhosts Array Yes A list of associated Powerpath hosts

num_of_powerpath_hosts long Yes The number of associated Powerpath Hosts

Existing attributes

3.3.4.2.1 Sample JSON response

{

"powerpathhosts": [ Host1 ],

"num_of_powerpath_hosts": 1

}

3.3.5 Initiators

3.3.5.1 GET (List)

User Story

(for Internal use only)

US21393

Resource initiator

Request Type: GET

Description: Adds the following filter options to Host list:

powerPathHostId

num_of_powerpath_hosts

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/initiator

User Roles: No change

Page 37 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Prerequisite: Not applicable

Path Parameters: No change

Query Parameters: Attribute Name Type Description

powerPathHostId String Optional value that filters returned list to display Initiator Names that are assocated with Power Path Host Names equal to or specified powerPathHostId e.g. powerPathHostId=< like>pp_

num_of_powerpath_hosts String Optional value that filters returned list to display Initiator names that contain greater than("num_of_powerpath_hosts =>1"), Less than("num_of_powerpath_hosts =<1") or equal to the specified num_of_powerpath_hosts

Existing attributes

Request Parameters: Not applicable

Response Parameters:

No change

3.3.5.2 GET (Object)

User Story

(for Internal use only)

US21393

Resource initiator

Request Type:

GET

Description: Adding the following to the Initiator object:

powerpathhosts

num_of_powerpath_hosts

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/initiator/{initiatorId}

User Roles: Not applicable

Prerequisite: Not applicable

Path Parameters:

Not applicable

Page 38 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Response Parameters:

Object Initiator

Attribute Name Type Optional Description

powerpathhosts Array Yes A list of associated Powerpath hosts

num_of_powerpath_hosts long Yes The number of associated Powerpath Hosts

Existing attributes

3.3.5.2.1 Sample JSON response

{

"powerpathhosts": [ Host1 ],

"num_of_powerpath_hosts": 1

}

3.3.6 Volume

3.3.6.1 GET

User Story

(for Internal use only)

Resource volume

Request Type:

GET

Description: Change to existing functionality:

Reponse code for invalid volume Id has changed from 500 to 404, see sample output below.

Removed label from RdfGroupIdType

Page 39 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/volume/{volumeId}

User Roles: No Change

Prerequisite :

Not applicable

Path Parameters:

No Change

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Response Parameters:

Object RdfGroupIdType

Attribute Name Type Optional Description

rdf_group_number

long Yes The rdf group number

label

string Yes The rdf group label

3.3.6.1.1 Sample for invalid or non existing volume in 8.4

TYPE: GET

URL: 84/sloprovisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 500

Response Messages:

{

"message": "A problem occurred retrieving the volume resource: VolumeId must consist of 5 hexadecimal characters" 

}

3.3.6.1.2 NEW Sample for invalid or non existing volume in 9.0

TYPE: GET

URL: 90/sloprovisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 404

Page 40 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Response Messages:

{

"message": "Volume [888888888] on Symmetrix [{symmetrixId}] cannot be found" 

}

3.3.6.2 DELETE

User Story

(for Internal use only)

Resource volume

Request Type: GET

Description: Change to existing functionality:

Reponse code for invalid or non existing volume has changed from 400 to 404, see sample output below.

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/volume/{volumeId}

User Roles: No Change

Prerequisite: Not applicable

Path Parameters: No Change

Query Parameters: Not applicable

Request Parameters: Not applicable

Response Parameters:

3.3.6.2.1 Sample for invalid or non existing volume in 8.4

TYPE: DELETE

URL: 84/sloprovisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 400

Response Messages:

{

"message": "Invalid VolumeId 8888888 specified for Symmetrix 000197800128"

Page 41 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

}

3.3.6.2.2 NEW Sample for invalid or non existing volume in 9.0

TYPE: GET

URL: 90/sloprovisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 404

Response Messages:

{

"message": "Volume [888888888] on Symmetrix [{symmetrixId}] cannot be found" 

}

3.3.6.3 PUT

User Story

(for Internal use only)

US24707

Resource volume

Request Type:

PUT

Description: Adds new functionality to an existing volumes

Expands volumes size when in rdf (expanding the remote and the local volumes).

Change to existing functionality:

Reponse code for invalid or non existing volume has changed from 500 to 404, see sample output below.

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/volume/{volumeId}

User Roles: Administrator/Manager

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

Not applicable

Page 42 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Request Parameters:

Object ExpandVolumeParamType

Attribute Name Type Optional Description

rdfGroupNumber

long Yes The rdf group number

Response Parameters: SYNCHRONOUS:

Object volume

Attribute Name Type Optional Description

No change

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

No change

3.3.6.3.1 Sample Expand Volumes JSON Request

{

"editVolumeActionParam":

{

"expandVolumeParam" :

{

"volumeAttribute":

{

Page 43 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"capacityUnit": "GB",

"volume_size": 7

},

"rdfGroupNumber" : 2

}

}

}

3.3.6.3.2 Sample for invalid or non existing volume in 8.4

URL: 84/sloprovisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 500

Response Messages:

{

"message": "A problem occurred modifying the volume resource: Symmetrix DeviceName is invalid."

}

3.3.6.3.3 NEW Sample for invalid or non existing volume in 9.0

URL: 90/sloprovisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 404

Response Messages:

{

"message": "Volume [888888888] on Symmetrix [{symmetrixId}] cannot be found" 

}

3.3.7 SRP

3.3.7.1 GET (Object)

User Story

(for Internal use only)

Resource srp

Request Type:

GET

Description: Adding the following entities to the SRP object

Page 44 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

srp_capacity

o subscribed_allocated_tb

o subscribed_total_tb

o usable_used_tb

o usable_total_tb

o snapshot_modified_tb

o snapshot_total_tb

srp_efficiency

o overall_efficiency_ratio_to_one

o data_reduction_ratio_to_one

o data_reduction_enabled_percent

o virtual_provisioning_savings_ratio_to_one

o snapshot_savings_ratio_to_one

Removing the following attributes to the SRP object:

srpSgDemandId

srpSloDemandId

overall_efficiency

total_usable_cap_gb

total_subscribed_cap_gb

total_allocated_cap_gb

total_snapshot_allocated_cap_gb

num_of_srp_slo_demands

num_of_srp_sg_demands

fba_total_capacity

fba_free_capacity

fba_used_capacity

fba_snapshot_allocated_capacity

fba_srdf_dse_allocated_capacity

ckd_total_capacity

ckd_free_capacity

ckd_used_capacity

ckd_snapshot_allocated_capacity

ckd_srdf_dse_allocated_capacity

compression_overall_ratio_to_one

compression_vp_ratio_to_one

compression_snapshot_ratio_to_one

Page 45 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

overall_efficiency_ratio_to_one

vp_saved_percent

vp_overall_ratio_to_one

vp_shared_ratio_to_one

snapshot_saved_percent

snapshot_overall_ratio_to_one

snapshot_shared_ratio_to_one

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/srp/{srpId}

User Roles: No change

Prerequisite :

Not applicable

Path Parameters:

No change

Query Parameters:

No change

Request Parameters:

Not applicable

Response Parameters:

Object SrpType

Attribute Name Type Optional Description

srp_capacity

SrpCapacityType

Yes Contains the SRP level capacity information

srp_efficiency SrpEfficiencyType

Yes Contains the SRP level Efficiency information

srpSgDemandId

Array Yes The list of Storage Groups in the Demand

srpSloDemandId

Array Yes The list of Service Levels in the Demand

Page 46 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

total_usable_cap_gb double Yes

total_subscribed_cap_gb double Yes

total_allocated_cap_gb double Yes

total_snapshot_allocated_cap_gb double Yes

num_of_srp_slo_demands double Yes

num_of_srp_sg_demands double Yes

fba_total_capacity double Yes

fba_free_capacity double Yes

fba_used_capacity double Yes

fba_snapshot_allocated_capacity double Yes

fba_srdf_dse_allocated_capacity double Yes

ckd_total_capacity double Yes

ckd_free_capacity double Yes

ckd_used_capacity double Yes

ckd_snapshot_allocated_capacity double Yes

ckd_srdf_dse_allocated_capacity double Yes

compression_overall_ratio_to_one double Yes

compression_vp_ratio_to_one double Yes

compression_snapshot_ratio_to_one double Yes

overall_efficiency_ratio_to_one double Yes

vp_saved_percent double Yes

vp_overall_ratio_to_one double Yes

snapshot_saved_percent double Yes

snapshot_overall_ratio_to_one double Yes

snapshot_shared_ratio_to_one double Yes

Object SRPCapacityType

Attribute Name Type Optional Description

subscribed_allocated_tb double

Yes SRP Host allocated plus

Page 47 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

eNas allocated capacity in TBs

subscribed_total_tb

double

Yes SRP Host subscribed capacity plus eNas subscribed capacity in TBs

usable_used_tb

double

Yes SRP Total Capacity in TBs used by Host, eNas and System after Data reduction is applied

usable_total_tb

double

Yes SRP Total system usable capacity in TBs

snapshot_modified_tb

double

Yes SRP Host snapshot modified capacity plus eNas snapshot modified capacity in TBs

snapshot_total_tb

double

Yes SRP Host snapshot capacity plus eNas snapshot capacity in TBs

Object SRPEfficiencyType

Attribute Name Type Optional Description

overall_efficiency_ratio_to_one

double

Yes SRP Overall Efficiency Ratio is the ratio between the sum of subscribed and snapshot capacity for user devices and the user used capacity. Format: "1.0:1" will be returned as 1.0.

Page 48 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

data_reduction_ratio_to_one

double

Yes SRP Data Reduction Ratio is the ratio between the sum of owned and RDP logical (128K track size) capacity for all compression enabled devices and the user used capacity for all compression enabled devices. Format: "1.0:1" will be returned as 1.0.

data_reduction_enabled_percent

double

Yes SRP Data Reduction Enabled Percent represents the combined effect of compression and deduplication.

virtual_provisioning_savings_ratio_to_one

double

Yes SRP Virtual Provisioning Savings Ratio is the ratio between the subscribed capacity for user devices and the difference between allocated and shared capacity for user devices. Format: "1.0:1" will be returned as 1.0.

snapshot_savings_ratio_to_one

double

Yes SRP Snapshot Savings Ratio is the ratio between snapshot

Page 49 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

capacity and the difference between modified snapshot capacity and non shared snapshot capacity. Format: "1.0:1" will be returned as 1.0.

3.3.7.2 GET Service level Demand Report

User Story

(for Internal use only)

Resource service_level_demand_report

Request Type: GET

Description: Adding a new endpoint to expose the Service Level demand report

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/srp/{srpId}/service_level_demand_report

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

srpId String No The SRP Name

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Response Parameters:

Object ServiceLevelDemandReportResult

Attribute Name Type Optional Description

serviceLevelDemands

Array Yes A list of

service

Page 50 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

level demands

Object ServiceLevelDemandType

Attribute Name Type Optional Description

serviceLevelId ServiceLevelIdType

No The Service Level Name

workloadId WorkloadIdType

No The workload Name, where applicable

fba_subscribed_gb double

Yes The FBA subscribed Capacity in GBs

fba_allocated_gb double

Yes The FBA allocated Capacity in GBs

fba_allocated_percent int

Yes The FBA allocated Capacity in %

ckd_subscribed_gb double

Yes The CKD subscribed Capacity in GBs

ckd_allocated_gb double

Yes The CKD allocated Capacity in GBs

ckd_allocated_percent int

Yes The CKD allocated Capacity in %

total_subscribed_gb double

Yes The Total subscribed Capacity in GBs

total_allocated_gb double

Yes The Total allocated Capacity in GBs

total_allocated_percent int Yes The Total

allocated Capacity in %

Page 51 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.3.7.2.1 Sample JSON response

{

serviceLevelDemands: [

{

"serviceLevelId": Diamond,

"workloadTypeId:OLTP,

"fba_subscribed_gb": 100.00,

"fba_allocated_gb": 50.00,

"fba_allocated_percent": 50,

"ckd_subscribed_gb": 100.00,

"ckd_allocated_gb": 50.00,

"ckd_allocated_percent": 50,

"total_subscribed_gb": 100.00,

"total_allocated_gb": 50.00,

"total_allocated_percent": 50

}

]

}

3.3.7.3 GET Storage Group Demand Report

User Story

(for Internal use only)

Resource storage_group_demand_report

Request Type:

GET

Description: Adding a new endpoint to expose the Storage Group demand report

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/srp/{srpId}/storage_group_demand_report

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite :

Not applicable

Page 52 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Path Parameters:

Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

srpId String No The SRP Name

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Response Parameters:

Object StorageGroupDemandReportResult

Attribute Name Type Optional Description

storageGroupDemands

Array Yes A list of

storage group demands

Object StorageGroupDemandType

Attribute Name Type Optiona l

Description

storageGroupId StorageGroupIdTypeVer 2

No The Storage Group Name

emulation String Yes The Storage

Group Emulation

subscribed_gb double

Yes The subscribed Capacity in GBs

allocated_gb double

Yes The allocated Capacity in GBs

allocated_percent int Yes The

allocated

Page 53 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Capacity in %

used_gb double

Yes The used Capacity in GBs

compression_ratio_to_one double

Yes The Compressio n Ration in relation to one e.g 8.0:1 where 8.0 will be returned

snapshot_allocated_gb double

Yes The snapshot allocated Capacity in GBs

snapshot_used_gb double

Yes The used Capacity in GBs

snapshot_compression_ratio_to_on e

double

Yes The Compressio n Ration in relation to one e.g 8.0:1 where 8.0 will be returned

3.3.7.3.1 Sample JSON response

{

storageGroupDemand: [

{

"storageGroupId": SG_NAME,

"emulation": FBA,

"subscribed_gb": 100.00,

"allocated_gb": 50.00,

"allocated_percent": 50,

"compression_ratio_to_one": 8.0,

Page 54 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"used_gb": 50.00,

"snapshot_allocated_gb": 50.00,

"snapshot_used_gb": 50.00,

"snapshot_compression_ratio_to_one": 8.0

}

]

}

3.3.8 Director

3.3.8.1 GET (List/Object)

User Story

(for Internal use only)

US24687

Resource director

Request Type:

GET

Description: Remove the director functionality from SLO Provisioning and move its GET(List/Object) implementations to System

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/director

/90/sloprovisioning/symmetrix/{symmetrixId}/director/{directorId}

User Roles: No change

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

No change

Request Parameters:

Not applicable

Response Parameters:

Not applicable

3.3.9 Port

3.3.9.1 GET (List/Object)

User Story US24687

Page 55 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

(for Internal use only)

Resource port

Request Type:

GET

Description: Remove the director-port functionality from SLO Provisioning and move its GET(List/Object) implementations to System

URL: /90/sloprovisioning/symmetrix/{symmetrixId}/director/{directorId}/port

/90/sloprovisioning/symmetrix/{symmetrixId}/director/{directorId}/port/{portId}

User Roles: No change

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

No change

Request Parameters:

Not applicable

Response Parameters:

Not applicable

3.4 Provisioning

3.4.1 Symmetrix

3.4.1.1 GET (Object)

User Story

(for Internal use only)

Resource symmetrix

Request Type:

GET

Description: Adding the following entities to the Symmetrix object

system_capacity

o thin_subscribed_total_tb

o thin_subscribed_used_tb

o thin_usable_total_tb

o thin_usable_used_tb

o physical_total_tb

Page 56 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

o physical_used_tb

Removing the following attributes to the Symmetrix object:

physicalCapacity

o used_capacity_gb

o total_capacity_gb

virtualCapacity

o used_capacity_gb

o total_capacity_gb

URL: /90/provisioning/symmetrix/{symmetrixId}/

User Roles: No change

Prerequisite :

Not applicable

Path Parameters:

No change

Query Parameters:

No change

Request Parameters:

Not applicable

Response Parameters:

Object SymmetrixType

Attribute Name Type Optional Description

system_capacity

SystemCapacityType

Yes Contains the System level capacity information

physicalCapacity PhysicalCapacityType No Contains the System level physical capacity information

virtualCapacity VirtualCapacityType Yes Contains the System level physical capacity information

Object SystemCapacityType

Attribute Name Type Optional Description

Page 57 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

physical_total_tb

double

Yes Total Physical capacity in TBs

physical_used_tb

double

Yes Total Physical capacity used in TBs

thin_subscribed_total_tb

double

Yes Total Thin Subscribed capacity in TBs, (TDEVs)

thin_subscribed_used_tb

double

Yes Total Allocated Thin Subscribed capacity) in TBs, (TDEVs)

thin_usable_total_tb

double

Yes Total Usable capacity in TBs, (TDATs)

thin_usable_used_tb

double

Yes Total Used Usable capacity in TBs, (TDATs)

3.4.1.1.1 Sample JSON response

{

"symmetrix": [

{

"symmetrixId": "000111111111",

"system_capacity": {

"thin_subscribed_used_tb": 0.17,

"physical_used_tb": 14.22,

"thin_usable_total_tb": 1.15,

"physical_total_tb": 26.0,

"thin_subscribed_total_tb": 9.93,

"thin_usable_used_tb": 0.17

},

Page 58 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"model": "VMAX",

"ucode": "5876.001.001",

"device_count": 100,

"local": false

}

],

"success": true

}

3.4.2 Storagegroup

3.4.2.1 PUT

User Story

(for Internal use only)

US24707

Resource storagegroup

Request Type:

PUT

Description: Adds new functionality to an existing storage group

Split Child Storage Group: Splits a child Storage Group from its parent storage group and creates a new masking view for the child storage group.

Split Storage Group Volumes: Splits volumes from a standalone storage group and adds them to a new storage group and new masking view.

Merge Storage Group: Merge a defined standalone storage group into the chosen parent or standalone storage group.

URL: /90/provisioning/symmetrix/{symmetrixId}/storagegroup/{storageGroupId}

User Roles: Administrator/Storage Administrator

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

Not applicable

Page 59 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Request Parameters:

Object SplitChildStorageGroupParamType

Attribute Name Type Optional Description

storageGroupId StorageGroupIdTypeVer2 No The Child storage group Name to split from selected parent Storage Group.

maskingViewId MaskingViewIdTypeVer2 Yes The New Masking View Name

Object SplitStorageGroupVolumesParamType

Attribute Name Type Optional Description

volumeId Array No Volume(s) to be split

storageGroupId

StorageGroupIdTypeVer2

No The New Storage group to which the volumes will be added.

maskingViewId MaskingViewIdTypeVer2 Yes The New Masking View Name

Object MergeStorageGroupParamType

Attribute Name Type Optional Description

storageGroupId

StorageGroupIdTypeVer2

No The Standalone Storage Group that will be merged into the selected Standalone or Parent Storage Group

Response Parameters: SYNCHRONOUS:

Object storagegroup

Attribute Name Type Optional Description

No change

Page 60 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

No change

3.4.2.1.1 Sample Move Volumes JSON Request

{

"editStorageGroupActionParam": {

"moveVolumeToStorageGroupParam":{

"volumeId": [00001,0002],

"storageGroupId": SG_NAME,

}

}

}

3.4.2.1.2 Sample Split Child Storage Group and Create MV JSON Request

{

"editStorageGroupActionParam": {

"splitChildStorageGroupParam": {

"storageGroupId": SG_NAME

"maskingViewId": MV_NAME,

}

}

}

3.4.2.1.3 Sample Split Storage Group Volumes into new Stoage Group and Create MV JSON Request

{

"editStorageGroupActionParam": {

"splitStorageGroupVolumesParam": {

"volumeId": [00001,0002],

"storageGroupId": SG_NAME

"maskingViewId": MV_NAME,

Page 61 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

}

}

}

3.4.2.1.4 Sample Merge Standalone Sg into Sg JSON Request

{

"editStorageGroupActionParam": {

"mergeStorageGroupParam": {

"storageGroupId": SG_NAME

}

}

}

3.4.3 Volume

3.4.3.1 GET

User Story

(for Internal use only)

Resource volume

Request Type: GET

Description: Change to existing functionality:

Reponse code for invalid or non existing volume has changed from 400 to 404, see sample output below.

Adding PoolId to GetVolumeResultObject

URL: /90/provisioning/symmetrix/{symmetrixId}/volume/{volumeId}

User Roles: No Change

Prerequisite: Not applicable

Path Parameters: No Change

Query Parameters: Not applicable

Request Parameters: Not applicable

Page 62 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Response Parameters:

Object GetVolumeResultObject

Attribute Name Type Optional Description

poolId PoolIdType

Yes The name of the bound pool if defined

Existing attributes

3.4.3.1.1 Sample for invalid or non existing volume in 8.4

TYPE: GET

URL: 84/provisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 500

Response Messages:

{

"message": "Invalid VolumeId 888888888 specified for Symmetrix {symmetrixId}" 

}

3.4.3.1.2 NEW Sample for invalid or non existing volume in 9.0

TYPE: GET

URL: 90/provisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 404

Response Messages:

{

"message": "Volume [888888888] on Symmetrix [{symmetrixId}] cannot be found" 

}

3.4.3.1.3 Sample JSON response

{

"poolId": Pool_Name

}

Page 63 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.4.3.2 DELETE

User Story

(for Internal use only)

Resource volume

Request Type: GET

Description: Change to existing functionality:

Reponse code for invalid or non existing volume has changed from 400 to 404, see sample output below.

URL: /90/provisioning/symmetrix/{symmetrixId}/volume/{volumeId}

User Roles: No Change

Prerequisite: Not applicable

Path Parameters: No Change

Query Parameters: Not applicable

Request Parameters: Not applicable

Response Parameters:

3.4.3.2.1 Sample for invalid or non existing volume in 8.4

TYPE: DELETE

URL: 84/provisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 400

Response Messages:

{

"message": "Invalid VolumeId 8888888 specified for Symmetrix 000197800128"

}

3.4.3.2.2 NEW Sample for invalid or non existing volume in 9.0

TYPE: GET

URL: 90/provisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 404

Response Messages:

Page 64 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

{

"message": "Volume [888888888] on Symmetrix [{symmetrixId}] cannot be found" 

}

3.4.3.3 PUT

User Story

(for Internal use only)

Resource volume

Request Type:

PUT

Description: Change to existing functionality:

Reponse for invalid or non existing volume has changed, see sample output below.

URL: /90/provisioning/symmetrix/{symmetrixId}/volume/{volumeId}

User Roles: Administrator/Manager

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

Not applicable

Request Parameters:

Response Parameters:

Object volume

Attribute Name Type Optional Description

No change

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

No change

Page 65 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.4.3.3.1 Sample for invalid or non existing volume in 8.4

TYPE: PUT

URL: 84/provisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 404

Response Messages:

{

"message": "Cannot find Volume '888888888' for Symmetrix {symmetrixId}"

}

3.4.3.3.2 NEW Sample for invalid or non existing volume in 9.0

TYPE: PUT

URL: 90/provisioning/symmetrix/{symmetrixId}/volume/888888888

Response Code: 404

Response Messages:

{

"message": "Volume [888888888] on Symmetrix [{symmetrixId}] cannot be found" 

}

3.5 Replication

3.5.1 SRDF Group

3.5.1.1 GET

User Story

(for Internal use only)

Resource RdfGroup

Request Type:

GET

Description: Adds new filtering options to the SRDF Group list getter call

URL: /90/replication/symmetrix/{symmetrixId}/rdf_group

User Roles: Monitor

Prerequisite: Not applicable

Page 66 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Path Parameters:

No change

Query Parameters:

remote_symmetrix_id return groups where the remote Symmetrix ID matches this parameter

group_type return groups which are Static, Dynamic or Witness

rdf_mode return groups where the SRDF pair modes for the group contains AdaptiveCopy, Synchronous, Asynchronous, Active

volume_count return groups with the matching volume count

Response Parameters

No change

3.5.1.2 PUT

User Story

(for Internal use only)

Resource RdfGroupUpdate

Request Type:

PUT

Description: Add functionality to Move Pairs from one SRDF group to another

URL: /90/replication/symmetrix/{symmetrixId}/rdf_group/{rdfgNumId}

User Roles: Storage Admin

Prerequisite: Not applicable

Path Parameters:

symmetrixId

rdfgNum

RdfGroupUpdate

Request Parameters

Object RdfGroupUpdate

Name Type Optional Description

action RdfGroupAction No MovePairs

move RdfGroupMovePairPa ram

targetRdfGroup volumesToMove halfMove force symForce star bypass exempt keepR1 keepR2

Page 67 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Query Parameters

N/A

Response Parameters

N/A

3.5.2 SRDF Port

3.5.2.1 GET

User Story

(for Internal use only)

Resource RdfDirectorPort

Request Type:

GET

Description: Adds WWN information for the SRDF port or remote SRDF port

URL: /90/replication/symmetrix/{symmetrixId}/rdf_director/{directorId}/port/{portId}

/90/replication/symmetrix/{symmetrixId}/rdf_director/{directorId}/port/{portId}/remote_port

User Roles: Monitor

Prerequisite: Not applicable

Path Parameters:

No change

Query Parameters:

No change

Response Parameters

Added a wwn field.

3.6 Migration N/A

3.7 VVol N/A

3.8 WLP N/A

Page 68 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.9 System

3.9.1 IpRoute

3.9.1.1 GET (Object)

User Story

(for Internal use only)

US24684

Resource ipRoute

Request Type: GET

Description: Gets details about an iscsi ip route

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/iproute/{ipRouteId}

User Roles: Administrator/Storage Administrator/Security

Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

ipRouteId String No Unique identifier of the ip route

Query Parameters: Not applicable

Request Parameters:

Not applicable

Response Parameters:

Object ipRoute

Attribute Name Type Optional Description

ipRouteId String

No Unique identifier of the ip route. Combination of destinationIp, prefix and networkId delimited by -. E.g. 10.10.10.10-24-5.

destination_ip String No The IPv4 or IPv6 destination IP address of the IP Route

prefix int No The IPv4 or IPv6 network mask prefix of the IP Route

gateway_ip String No The gateway IPv4 or IPv6 address of the IP Route

Page 69 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

network_id int No The network identity of the IP Route

director String No The director with which the IP Route is associated. E.g. SE-2E.

3.9.1.1.1 Sample JSON response

{

" ipRouteId ": 10.73.28.12-24-1,

" destination_ip ": 10.73.28.12,

" prefix": 24,

" gateway_ip ": 10.0.0.0,

network_id: 1,

director: SE-2E

}

3.9.1.2 GET (List)

User Story

(for Internal use only)

US24684

Resource ipRoute

Request Type: GET

Description: Gets a list of iscsi ip routes

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/iproute

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

directorId String Unique identifier of the director

Query Parameters: Attribute Name Type Description

destination_ip

String Optional value that filters the returned list to display ip route with the given IPv4 or IPv6 destination IP address

Page 70 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

prefix int Optional value that filters the returned list to display ip route with the given IPv4 or IPv6 network mask prefix

gateway_ip String Optional value that filters the returned list to display ip route with the given gateway IP

network_id int Optional value that filters the returned list to display ip route with the given network identity

Request Parameters: Not applicable

Response Parameters:

Object listIpRouteResult

Attribute Name Type Optional Description

ipRouteId List No List of ip route ids

3.9.1.3 POST

User Story

(for Internal use only)

US24684

Resource ipRoute

Request Type:

POST

Description: Adds an IP route

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/iproute

User Roles: Administrator, Storage administrator

Prerequisite :

Not applicable

Path Parameters:

Parameter name Type Description

symmetrixId String Unique identifier of the symmetrix

directorId String Unique identifier of the director

Query Parameters:

Not applicable

Request Parameters:

Object createIpRouteParam

extends:

ConfigurationManagementParamType (See the Appendix for details.)

Attribute Name Type Optional Description

Page 71 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

destinationIp String No The IPv4 or IPv6 destination IP address of the IP Route

prefix int No The IPv4 or IPv6 network mask prefix of the IP Route

gatewayIp String No The gateway IP address of the IP Route in IPv4 or IPv6 format.

networkId int Yes The network id of the IP Route. Default value is 1.

executionOption String enum:

SYNCHRONOUS

ASYNCHRONOUS

Yes SYNCHRONOUS by default.

Response Parameters: SYNCHRONOUS:

Object ipRoute

Attribute Name Type Optional Description

ipRouteId String

No Unique identifier of the ip route

destination_ip String No The IPv4 or IPv6 destination IP address of the IP Route

prefix int No The IPv4 or IPv6 network mask prefix of the IP Route

gateway_ip String No The gateway IP address of the IP Route

network_id int No The network id of the IP Route

director String No The director with which the IP Route is associated

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

See Job details under Common Objects in the Appendix.

3.9.1.3.1 Sample JSON Request

{

" destinationIp ": 10.73.28.12,

Page 72 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

" prefix": 24,

" gatewayIp": 10.0.0.0,

networkId: 2, //(optional 1 by default)

"executionOption" : "ASYNCHRONOUS" //(optional SYNCHRONOUS by default)

}

3.9.1.3.2 Sample Synchronous Response

{

" ipRouteId ": 10.73.28.12-24-2,

" destination_ip ": 10.73.28.12,

" prefix": 24,

" gateway_ip": 10.0.0.0,

network_id: 2,

director: SE-1E

}

3.9.1.3.3 Sample Asynchronous Response

{

"jobId": "1503300709831",

"name": "Create IP Route",

"status": "UNSCHEDULED",

"username": "C:b1d90714-b493-42f8-a6b4-ce28bbd70f54\\smc",

"last_modified_date": "Aug-21-2017 13:01:49.832",

"last_modified_date_milliseconds": 1503300709832,

"completed_date_milliseconds": 0,

"task": [

{

"execution_order": 1,

"description": "Create IP Route [10.73.28.12-24-2] \n"

}

],

"resourceLink": "https://IP_ADDRESS:8443/univmax/restapi/90/system/symmetrix/{symmetrixId}/director/{directorId}/iprou te/10.73.28.12-24-2"

}

Page 73 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.9.1.4 DELETE

User Story

(for Internal use only)

US24684

Resource ipRoute

Request Type:

DELETE

Description: Removes an IP Route

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/iproute/{ipRouteId}

User Roles: Administrator, Storage administrator

Prerequisite :

Not applicable

Path Parameters:

Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

ipRouteId String No Unique identifier of the ip route

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Response Parameters:

No content

3.9.2 Director

3.9.2.1 GET (Object)

User Story

(for Internal use only)

US24687

Resource director

Request Type: GET

Description: Gets details about the symmetrix director.

NOTE: This functionality was moved as is from SLO Provisioning.

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}

Page 74 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

User Roles: Administrator/Storage Administrator/Security

Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

Query Parameters: Not applicable

Request Parameters:

Not applicable

Response Parameters:

No change

3.9.2.1.1 Sample JSON response

{

"availability": "Offline",

"director_number": 65,

"director_slot_number": 1,

"directorId": "SE-1E",

"num_of_ports": 4,

"num_of_cores": 4

}

3.9.2.2 GET (List)

User Story

(for Internal use only)

US24687

Resource director

Request Type: GET

Description: Gets the list of symmetrix directors.

NOTE: This functionality was moved as is from SLO Provisioning.

URL: /90/system/symmetrix/{symmetrixId}/director

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Page 75 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Path Parameters: Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

Query Parameters: No change

Request Parameters: Not applicable

Response Parameters:

Object ListDirectors

Attribute Name Type Optional Description

directorId List No List of director ids

3.9.3 iSCSI Target (Port)

3.9.3.1 GET (Object)

User Story

(for Internal use only)

US24687

Resource port

Request Type: GET

Description: Gets details about a symmetrix port (as well as virtual port i.e., iSCSI target)

NOTE: This functionality was moved as is from SLO Provisioning.

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port/{portId}

User Roles: Administrator/Storage Administrator/Security

Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

portId String No Unique identifier of the port

Query Parameters: Not applicable

Request Parameters:

Not applicable

Response Parameters:

In additional to the existing properties, an additional property, iscsi_target was introduced.

Object DirectorPort

Attribute Name Type Optional Description

Page 76 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

iscsi_target Boolean

Yes Indicates whether the given port is an iSCSI target (virtual port) or not.

3.9.3.1.1 Sample JSON response

{

"symmetrixPort": {

"symmetrixPortKey": {

"directorId": "SE-1E",

"portId": "1"

},

"port_status": "ON",

"director_status": "Offline",

"type": "GigE",

"num_of_cores": 4,

"identifier": "iqn.2",

"negotiated_speed": "0",

"num_of_port_groups": 0,

"num_of_masking_views": 0,

"num_of_mapped_vols": 0,

"vcm_state": "Enabled",

"aclx": true,

"vnx_attached": false,

"avoid_reset_broadcast": true,

"environ_set": true,

"disable_q_reset_on_ua": false,

"soft_reset": true,

"scsi_3": false,

"scsi_support1": true,

"spc2_protocol_version": true,

Page 77 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"max_speed": "0",

"iscsi_target": true

}

}

3.9.3.2 GET (List)

User Story

(for Internal use only)

US24687

Resource port

Request Type: GET

Description: Gets a list of ports (which includes virtual ports i.e., iSCSI targets as well)

NOTE: This functionality was moved as is from SLO Provisioning.

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

directorId String Unique identifier of the director

Query Parameters: In addition to the existing query parameters, an additional query param, iscsi_target is introduced.

Attribute Name Type Description

iscsi_target

String (Front End Port Only) Optional value that filters returned list to display ports that are iSCSI targets (true/false)

Request Parameters: Not applicable

Response Parameters:

Object DirectorPortList

Attribute Name Type Optional Description

portId List No List of port ids

3.9.3.3 POST

User Story US24686

Page 78 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

(for Internal use only)

Resource iSCSITarget

Request Type:

POST

Description: Creates a new iSCSI Target under the specified SE director

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port

User Roles: Administrator, Storage administrator

Prerequisite :

Not applicable

Path Parameters:

Parameter name Type Description

symmetrixId String Unique identifier of the symmetrix

directorId String Unique identifier of the director

Query Parameters:

Not applicable

Request Parameters:

Object createISCSITargetParam

extends:

ConfigurationManagementParamType (See the Appendix for details.)

Attribute Name Type Optional Description

iqn String Yes Unique name of iSCSITarget on the storage system

network_id long No Network id of the iSCSITarget

Default value is 1.

tcp_port long Yes TCP Port used by the iSCSITarget. Default value is 3260.

volume_set_addressing boolean Yes Volume set addressing mode for iSCSITarget.

avoid_reset_broadcast boolean Yes SCSI bus reset to only occur to the port that received the reset (not broadcast to all channels)

environ_set boolean Yes Environmental error reporting by the storage system to the host on the specific port.

Page 79 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

disable_q_reset_on_ua boolean Yes Unit Attention (UA) that is propagated from another director does not flush the queue for this volume on this director

soft_reset boolean Yes SCSI soft reset on a Storage System port

scsi_3 boolean Yes Storage System supports SCSI-3 / SCSI-2 protocol.

scsi_support1 boolean Yes Provides a stricter compliance with SCSI standards

spc2_protocol_version boolean Yes Has to be enabled (default) in a Windows 2003 environment running Microsoft HCT test version 12.1. Port must be offline, when set.

open_vms boolean Yes Enables an Open VMS fiber connection.

isid_protected boolean Yes Protected initiator session identifier.

executionOption String enum:

SYNCHRONOUS

ASYNCHRONOUS

Yes SYNCHRONOUS by default.

Response Parameters: SYNCHRONOUS:

No Content

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

See Job details under Common Objects in the Appendix.

3.9.3.3.1 Sample JSON Request

{

"iqn":"iqn.uniquename",

"network_id":"2",

"tcp_port":"3200",

Page 80 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"volume_set_addressing":"true",

"avoid_reset_broadcast":"false",

"environ_set":"false",

"disable_q_reset_on_ua":"false",

"soft_reset":"false",

"scsi_3":"false",

"scsi_support1":"true",

"spc2_protocol_version":"true",

"open_vms":"false",

"isid_protected":"true",

"executionOption" : "ASYNCHRONOUS"

}

3.9.3.3.2 Sample Asynchronous Response

{

"jobId": "1513534662588",

"name": "IQN iqn.uniquename",

"status": "SCHEDULED",

"username": "C:b1d90714-b493-42f8-a6b4-ce28bbd70f54\\smc",

"last_modified_date": "Dec-17-2017 23:47:42.589",

"last_modified_date_milliseconds": 1513534662589,

"completed_date_milliseconds": 0,

"task": [

{

"execution_order": 1,

"description": "Create ISCSITarget in symm [symmetrixId] and director number [directorNum]"

}

]

}

3.9.3.4 PUT

User Story

(for Internal use only)

US24686

Resource iSCSITarget

Page 81 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Request Type:

PUT

Description: Modifies an existing iSCSI Target

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port/{portId}

User Roles: Administrator/Storage Administrator

Prerequisite: Not applicable

Path Parameters:

Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

portId String No Unique identifier of the iSCSI Target

Query Parameters:

Not applicable

Request Parameters:

Object editISCSITargetParam

extends:

ConfigurationManagementParamType (See the Appendix for details.)

Attribute Name Type Optional Description

editISCSITarget ActionParam

EditISCSITargetAction ParamType

No Select one of the Edit Options to modify the specified iSCSI target

Object EditISCSITargetActionParam

Attribute Name Type Optional Description

renameISCSITarg etParam

RenameISCSITarg etParamType

Yes Renames the specified iSCSI Target's IQN

modifyISCSITarge tParam

ModifyISCSITarget ParamType

Yes Modifies the specified iSCSI Target's properties

modifyPortFlagsP aram

ModifyPortFlagsPar amType

Yes Set/Reset port flags of the specified iSCSI Target

attachIPInterfaceP aram

AttachIPInterfaceP aramType

Yes Attaches one or more IP interfaces to the specified iSCSI Target

detachIPInterface Param

DetachIPInterfaceP aramType

Yes Detaches one or more IP interfaces from the specified iSCSI Target

Page 82 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

enableDisableISC SITargetParam

EnableDisableISCS ITargetParamType

Yes Enable/Disable the specified iSCSI Target

Object RenameISCSITargetParam

Attribute Name Type Optional Description

new_iqn String No The New IQN of iSCSI Target.

Object ModifyISCSITargetParam

Attribute Name Type Optional Description

network_id long No New network ID for specified iSCSi Target.

tcp_port long Yes New TCP port number for specified iSCSi Target.

Object ModifyPortFlagsParam

Attribute Name Type Optional Description

volume_set_addressing boolean Yes Volume set addressing mode for iSCSITarget.

avoid_reset_broadcast boolean Yes SCSI bus reset to only occur to the port that received the reset (not broadcast to all channels)

environ_set boolean Yes Environmental error reporting by the storage system to the host on the specific port.

disable_q_reset_on_ua boolean Yes Unit Attention (UA) that is propagated from another director does not flush the queue for this volume on this director

soft_reset boolean Yes SCSI soft reset on a Storage System port

scsi_3 boolean Yes Storage System supports SCSI-3 / SCSI-2 protocol.

scsi_support1 boolean Yes Provides a stricter compliance with SCSI standards

spc2_protocol_version boolean Yes Has to be enabled (default) in a Windows 2003 environment running Microsoft HCT test version 12.1. Port must be offline, when set.

Page 83 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

open_vms boolean Yes Enables an Open VMS fiber connection.

isid_protected boolean Yes Protected initiator session identifier.

Object AttachIPInterfaceParam

Attribute Name Type Optional Description

ipInterfaceParam IPInterfaceParamType No A list of IP Interfaces that will be used for attach.

Object DetachIPInterfaceParam

Attribute Name Type Optional Description

ipInterfaceParam IPInterfaceParamType No A list of IP Interfaces that will be used for detach.

Object IPInterfaceParam

Attribute Name Type Optional Description

ip_interface_id IpInterfaceIdType No IP Interface ID with IP Address and Network ID separated by '-'.

ip_interface_port long No Physical iSCSI Port where the IP Interface exists.

Object EnableDisableISCSITargetParam

Attribute Name Type Optional Description

port_enable Boolean No iSCSI Target's new port state(online/offline).

Response Parameters: SYNCHRONOUS:

Object iSCSITarget

Attribute Name Type Optional Description

See Response as detailed in the GET method of iSCSITarget.

ASYNCHRONOUS:

Object job

Page 84 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Attribute Name Type Optional Description

See Job details under Common Objects in the Appendix.

3.9.3.4.1 Sample JSON Requests

{

"editISCSITargetActionParam":{

"renameISCSITargetParam":{

"new_iqn":"iqn.unique.com"

}

},

"executionOption" : "ASYNCHRONOUS"

}

{

"editISCSITargetActionParam":{

"attachIPInterfaceParam":{

"ipInterfaceParam":[{

"ip_interface_id":"10.10.10.10-2",

"ip_interface_port":24

},

{

"ip_interface_id":"100.100.100.100-2",

"ip_interface_port":25

}]

}

}

}

3.9.3.4.2 Sample Asynchronous Response

{

"jobId": "1513538890970",

"name": "Modify iSCSI Target",

Page 85 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"status": "SCHEDULED",

"username": "C:b1d90714-b493-42f8-a6b4-ce28bbd70f54\\smc",

"last_modified_date": "Dec-18-2017 00:58:10.971",

"last_modified_date_milliseconds": 1513538890971,

"completed_date_milliseconds": 0,

"task": [

{

"execution_order": 1,

"description": "Rename iSCSI target"

}

]

}

3.9.3.4.3 Sample Synchronous Response

{

"symmetrixPort": {

"symmetrixPortKey": {

"directorId": "SE-1E",

"portId": "1"

},

"port_status": "OFF",

"director_status": "Offline",

"type": "GigE",

"num_of_cores": 4,

"identifier": " iqn.unique.com",

"negotiated_speed": "0",

"num_of_port_groups": 0,

"num_of_masking_views": 0,

"num_of_mapped_vols": 0,

"vcm_state": "Enabled",

"aclx": true,

"vnx_attached": false,

Page 86 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"avoid_reset_broadcast": false,

"environ_set": false,

"disable_q_reset_on_ua": false,

"soft_reset": false,

"scsi_3": false,

"scsi_support1": true,

"spc2_protocol_version": true,

"max_speed": "0",

"iscsi_target": true,

"ip_addresses": [

"10.10.10.10",

"100.100.100.100"

]

}

}

3.9.3.5 DELETE

User Story

(for Internal use only)

US24686

Resource iSCSITarget

Request Type:

DELETE

Description: Removes an existing iSCSI Target

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port/{portId}

User Roles: Administrator, Storage administrator

Prerequisite :

Not applicable

Path Parameters:

Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

Page 87 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

directorId String No Unique identifier of the director

portId String No Unique identifier of the iSCSI Target

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Response Parameters:

No content

3.9.4 Ip Interface

3.9.4.1 GET (Object)

User Story

(for Internal use only)

US24685

Resource ipinterface

Request Type:

GET

Description: Gets details about an ip interface

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port/{portId}/ipinterface/{ipinterface Id}

User Roles: Administrator/Storage Administrator/Security

Administrator/Monitor/Auditor/Performance Monitor

Prerequisite :

Not applicable

Path Parameters:

Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

portId String No Unique identifier of the port

ipinterfaceId String No Unique identifier of the ip interface

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Page 88 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Response Parameters:

Object IpInterface

Attribute Name Type Optional Description

ip_interface_id String

No Unique identifier of the IP interface. Combination of IP address and network id delimited by -.

E.g. 10.100.100.110-20.

ip_address String No The IPv4 or IPv6 IP address

network_id Long No The network id of the IP interface

ip_prefix_length Integer No The prefix length for the IPv4 or IPv6 address

vlan_id Long No The VLAN ID of the IP interface

mtu Long No The MTU configured for the IP interface

iscsi_target_director String Yes If attached, the iSCSI target director with which the IP interface is associated

iscsi_target_port Integer Yes If attached, the iSCSI target virtual port with which the IP interface is associated

3.9.4.1.1 Sample JSON response

{

"ip_interface_id": "10.100.100.110-20",

"ip_address": "10.100.100.110",

"network_id": 20,

"ip_prefix_length": 8,

"vlan_id": 20,

"mtu": 1500

}

3.9.4.2 GET (List)

User Story

(for Internal use only)

US24685

Resource ipinterface

Request Type: GET

Page 89 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Description: Gets a list of ip interfaces

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port/{portId}/ipinterface

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

directorId String Unique identifier of the director

portId String Unique identifier of the port

Query Parameters: Attribute Name Type Description

ip_address

String Optional value that filters returned list to display Ip interfaces that has the ip_address associated

network_id String Optional value that filters returned list to display Ip interfaces that has the network_id associated

ip_prefix_length String Optional value that filters returned list to display Ip interfaces that has the ip_prefix_length associated

vlan_id String Optional value that filters returned list to display Ip interfaces that has the vlan_id associated

mtu String Optional value that filters returned list to display Ip interfaces that has the mtu (Maximum Transmission Unit) associated

iscsi_target_director String Optional value that filters returned list to display Ip interfaces that has the iscsi_target_director associated

iscsi_target_port String Optional value that filters returned list to display Ip interfaces that has the iscsi_target_port associated

Request Parameters:

Not applicable

Response Parameters:

Object IpInterfaceList

Attribute Name Type Optional Description

ipinterfaceId List No List of ip interface ids

Page 90 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

3.9.4.3 POST

User Story

(for Internal use only)

US24685

Resource ipinterface

Request Type:

POST

Description: Adds an IP Interface

URL: /90/system/symmetrix/{symmetrixId}/ director/{directorId}/port/{portId}/ipinterface

User Roles: Administrator, Storage administrator

Prerequisite :

Not applicable

Path Parameters:

Parameter name Type Description

symmetrixId String Unique identifier of the symmetrix

directorId String Unique identifier of the director

portId String Unique identifier of the port

Query Parameters:

Not applicable

Request Parameters:

Object createIpInterfaceParam

extends:

ConfigurationManagementParamType (See the Appendix for details.)

Attribute Name Type Optional Description

ipaddress String No The IPv4 or IPv6 address of the IP Interface

prefix int No The IPv4 or IPv6 network mask prefix for the IP Interface

vlanId int No The VLAN ID for the IP Interface

networkId int No The network id of the IP Interface.

mtu Int No MTU value for the IP Interface.

executionOption String enum:

SYNCHRONOUS

ASYNCHRONOUS

Yes SYNCHRONOUS by default.

Page 91 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Response Parameters: SYNCHRONOUS:

Object ipInterface

Attribute Name Type Optional Description

ipInterfaceId String

No Unique identifier of the ip interface

ipaddress String No The IPv4 or IPv6 address of the IP Interface

prefix int No The IPv4 or IPv6 network mask prefix for the IP Interface

vlanId int No The VLAN ID for the IP Interface

networkId int No The network id of the IP Interface.

mtu int No MTU value for the IP Interface.

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

See Job details under Common Objects in the Appendix.

3.9.4.3.1 Sample JSON Request

{

"ip_address":"11.100.12.11",

"ip_prefix_length":"3",

"vlan_id":"35",

"network_id":"55",

"mtu":"1600",

"executionOption" : "ASYNCHRONOUS" //(optional SYNCHRONOUS by default)

}

3.9.4.3.2 Sample Synchronous Response

{

Page 92 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"ip_interface_id": "11.100.12.11-55",

"ip_address": "11.100.12.11",

"network_id": 55,

"ip_prefix_length": 3,

"vlan_id": 35,

"mtu": 1600

}

3.9.4.3.3 Sample Asynchronous Response

{

"jobId": "1513580022408",

"name": "IP Address: 11.100.12.11",

"status": "SCHEDULED",

"username": "C:b1d90714-b493-42f8-a6b4-ce28bbd70f54\\smc",

"last_modified_date": "Dec-18-2017 12:23:42.409",

"last_modified_date_milliseconds": 1513580022409,

"completed_date_milliseconds": 0,

"task": [

{

"execution_order": 1,

"description": "Create IP Interface with ip [11.100.12.11], prefix [3] and network id [57]"

}

],

"resourceLink": "http://localhost:8080/univmax/restapi/90/system/symmetrix/000197900046/director/SE- 1E/port/24/ipinterface/11.100.12.11-57"

}

3.9.4.4 PUT

User Story

(for Internal use only)

US24685

Resource ipinterface

Request Type:

PUT

Description: Modifies an ipinterface

Page 93 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

URL: /90/system/symmetrix/{symmetrixId}/director/{directorId}/port/{portId}/ipinterface/{ipInterfaceId }

User Roles: Administrator/Storage Administrator

Prerequisite :

Not applicable

Path Parameters:

Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

portId String No Unique identifier of the port

ipInterfaceId String No Unique identifier of the ip interface

Query Parameters:

Not applicable

Request Parameters:

Object editIPInterfaceParam

extends:

ConfigurationManagementParamType (See the Appendix for details.)

Attribute Name Type Optional Description

editIPInterfaceActionParam

EditIPInterfaceActionParamT ype

No Select the Edit Options to modify the specified IPInterface

Object EditIPInterfaceParamType

Attribute Name Type Optional Description

editIPInterfaceOptionsP aram

EditIPInterfaceOptionsParam Type

Yes Edits the params for the specified ip interface

Object editIPInterfaceOptionsParam

Attribute Name Type Optional Description

Page 94 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

ip_address

string No The IPv4 or IPv6 address of the IP Interface

Network_id int No The network id of the IP Interface.

prefix int No The IPv4 or IPv6 network mask prefix for the IP Interface

mtu int No MTU value for the IP Interface.

Response Parameters: SYNCHRONOUS:

Object ipInterface

Attribute Name Type Optional Description

is detailed in the GET method.

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

is detailed in the Common Objects section.

3.9.4.4.1 Sample edit IP Interface JSON Request

{

"editIPInterfaceActionParam": {

"editIPInterfaceOptionsParam":{

"ip_address": "11.100.12.11",

"network_id": 53,

"ip_prefix_length": 3,

"mtu":"1800"

}

}

}

3.9.4.5 DELETE

User Story US24685

Page 95 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

(for Internal use only)

Resource ipinterface

Request Type:

DELETE

Description: Deletes an IP Interface

URL: 90/system/symmetrix/{symmetrixId}/iscsi/ipinterface/{ipinterfaceid}

User Roles: Not applicable

Prerequisite :

Not applicable

Path Parameters:

Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

directorId String No Unique identifier of the director

portId String No Unique identifier of the port

ipInterfaceId String No Unique identifier of the ip interface

Query Parameters:

Not applicable

Request Parameters:

Not applicable

Response Parameters:

Not applicable

3.10 DSA N/A

3.11 Management N/A

3.12 Common N/A

4 Appendix

4.1 Basic Authentication

Unisphere for PowerMax REST API authorization is implemented using HTTP Basic Access Authentication. Basic Access Authentication allows the user to send an unencrypted Base64-encoded string that contains a username and password to the Unisphere for PowerMax server.

Page 96 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Anonymous requests for a protected resource are rejected with a 401 (Access Denied) status code.

Known requests are validated against the existing Unisphere for PowerMax users:

o Administrator o Storage administrator o Security administrator o Monitor o Auditor o Performance monitor

4.2 Request Types

4.2.1 GET (OBJECT)

4.2.1.1 Sample

User Story

(for Internal use only)

US12345

Resource storagegroup

Request Type: GET

Description: Gets details about a storage group

URL: /84/sloprovisioning/symmetrix/{symmetrixId}/storagegroup/{storagegroupId}

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

storageGroupId String No The Storage Group Name

Query Parameters: Not applicable

Request Parameters:

Not applicable

Response Parameters:

Object storageGroup

Attribute Name Type Optional Description

storageGroupId String No Unique identifier of the storage group instance

slo String Yes SLO that is associated with the storage group

Page 97 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

srp String Yes SRP that is associated with the storage group

hostIOLimit HostIOLimitType Yes SRP that is associated with the storage group

And so on

Object HostIOLimitType

Attribute Name Type Optional Description

host_io_limit_mb_sec String No The Host MB/s limit for the storage group

host_io_limit_io_sec String Yes The Host IO/s limit for the storage group

dynamicDistribution String Yes The dynamic distribution type, which can have "never", "always", or "on_failure" values

4.2.1.2 Response Codes

Response status code Description 200 OK. The request is successful 401 Returned if an incorrect username, password, or both are specified 403 Returned if the specified username and password are correct, but the user is

not authorized to make this request 404 Returned if the storage group [storageGroupId] on the Symmetrix

[SymmetrixId] system cannot be found. 500 Returned if a problem occurred when the system was retrieving the

resource:

4.2.1.3 Error codes:

Future work

4.2.2 GET (LIST)

4.2.2.1 Sample

User Story

(for Internal use only)

US12345

Resource storagegroup

Request Type: GET

Description: Gets a list of storage group names

URL: /84/sloprovisioning/symmetrix/{symmetrixId}/storagegroup

Page 98 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

User Roles: Administrator/Storage Administrator/Security Administrator/Monitor/Auditor/Performance Monitor

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

Query Parameters: Attribute Name Type Description

storageGroupId String An optional value that filters the returned list so it displays storage group names that contain the specified volume names only, for example, equal to "storageGroupId=gold_SG" or contain "storageGroupId=< like>gold"

sym_vol_name String An optional value that filters the returned list so it displays storage group names that contain the specified volumes names only, for example, equal to "sym_vol_name=00123" or contain "sym_vol_name=< like>12"

And so on

Request Parameters: Not applicable

Response Parameters: Object ListStorageGroupResult

Attribute Name Type Optional Description

storageGroupId String array No A list of storage group names

4.2.2.2 Response Codes

Response status code Description 200 OK. The request is successful 401 Returned if an incorrect username, password, or both are specified 403 Returned if the specified username and password are correct, but the user is

not authorized to make this request 500 Returned if a problem occurred when the system was retrieving the

resource:

Exception:

If the list of objects does not include a symmetrixId in the URL, a 200 response code is returned with an array of authorized objects, for example, 84//sloprovisioning/symmetrix returns only the VMAXs that the user has permissions on.

4.2.2.3 Error codes:

Future work

Page 99 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

4.2.3 POST

4.2.3.1 Sample

User Story

(for Internal use only)

US12345

Resource storagegroup

Request Type:

POST

Description: Creates a storage group

URL: /84/sloprovisioning/symmetrix/{symmetrixId}/storagegroup

User Roles: Administrator/Storage Administrator

Prerequisite :

Not applicable

Path Parameters:

Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

Query Parameters:

Not applicable

Request Parameters:

Object createStorageGroupParam

extends:

ConfigurationManagementParamType (See the Appendix for details.)

Attribute Name Type Optiona l

Description

storageGroupId String No Unique identifier of the new storage group instance

create_empty_storage_grou p

boolean Yes An empty storage group is created if you set this parameter to true. This parameter overrides

Page 100 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

any other create setting.

sloBasedStorageGroupPara m

SloBasedStorageGroupParamTy pe

Yes This parameter is required to create a SLO- based storage group. Multiple occurrence s create multiple child storage groups.

And so on

Object SloBasedStorageGroupParamType

Attribute Name Type Optional Description

sloId

String No The SLO that is to be associated with the storage group

volumeAttribute

VolumeAttributeType No Size of each volume that is to be added to the storage group

And so on

Object VolumeAttributeType

Attribute Name Type Optional Description

volume_size String No The size of the volume

capacityUnit String enum:

CYL

MB

GB

TB

No Unit of capacity

Page 101 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Response Parameters: SYNCHRONOUS:

Object storageGroup

Attribute Name Type Optional Description

is detailed in the GET method.

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

is detailed in the Appendix.

4.2.3.2 Response Codes

Response status code Description 201 Created, returned when Resource is created using SYNCHRONOUS

execution option. 202 Accepted, returned when the request to create the resource is accepted

using the ASYNCHRONOUS execution option. 400 Returned when an error occurs with the validation of the Request payload ,

for example: must be 1-64 alphanumeric, '_', or '-' characters

401 Returned if an incorrect username, password, or both are specified 403 Returned if the specified username and password are correct, but the user is

not authorized to make this request 409 Returned if the requested resource already exists. 500 Returned if a problem occurred when the system was creating the

resource:

4.2.3.3 Error codes:

Future work

4.2.3.4 Response Header

Asynchronous

The URL of the job

Example: restapi/84/system/job/{jobId}

Synchronous:

The URL of the resource that is being created:

Example:restapi/84/sloprovisioning/symmetrix/{symmetrixId}/storagegroup/{storageGroupId}

Page 102 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

4.2.4 PUT

4.2.4.1 Sample

User Story

(for Internal use only)

US12345

Resource storagegroup

Request Type:

PUT

Description: Edits a storage group

URL: /84/sloprovisioning/symmetrix/{symmetrixId}/storagegroup/{storageGroupID}

User Roles: Administrator/Storage Administrator

Prerequisite :

Not applicable

Path Parameters:

Attribute Name Type Description

symmetrixId String Unique identifier of the symmetrix

storageGroupId String The Storage Group Name

Query Parameters:

Not applicable

Request Parameters:

Object editStorageGroupParam

extends:

ConfigurationManagementParamType (See the Appendix for details.)

Attribute Name Type Optional Description

editStorageGroupActionParam

EditStorageGroupParamType

No Select one of the Edit Options to modify the specified storage group

Object EditStorageGroupParamType

Attribute Name Type Optiona l

Descriptio n

Page 103 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

renameStorageGroupParam RenameStorageGroupParamTyp e

Yes Renames the specified storage group

editStorageGroupSLOPara m

EditStorageGroupSLOParamTyp e

Yes Edit the SG SLO Applicable to stand- alone and child storage groups only

and so on.

Object RenameStorageGroupParamType

Attribute Name Type Optional Description

new_storage_Group_name

String No The New Storage Group Name.

Object EditStorageGroupSLOParamType

Attribute Name Type Optional Description

sloId String No The New SLO Selection

Response Parameters: SYNCHRONOUS:

Object storageGroup

Attribute Name Type Optional Description

is detailed in the GET method.

ASYNCHRONOUS:

Object job

Attribute Name Type Optional Description

is detailed in the Common Objects section.

Page 104 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

4.2.4.2 Response Codes

Response status code Description 200 Ok, returned when Resource is edited using SYNCHRONOUS execution

option. 202 Accepted, returned when the request to edit the resource is accepted using

the ASYNCHRONOUS execution option. Note: In some rare circumstances, such as unmapping all volumes from a cu image, the cu image no longer exists; hence, there is no object or content to be returned. In these circumstances, a 204: No content will be returned after the job completes

400 Returned when an error occurs with the validation of the Request payload , for example: must be 1-64 alphanumeric, '_', or '-' characters

401 Returned if an incorrect username, password, or both are specified 403 Returned if the specified username and password are correct, but the user is

not authorized to make this request 409 Returned if the requested resource already exists. 500 Returned if a problem occurred when the system was editing the

resource:

4.2.4.3 Error codes:

Future work

4.2.4.4 Response Header:

Asynchronous:

The URL of the job

For example, restapi/84/system/job/{jobId}

Synchronous:

A URI Header cannot be passed back in a 200(ok) Response

4.2.5 DELETE

4.2.5.1 Sample

User Story

(for Internal use only)

US12345

Resource storagegroup

Request Type: DELETE

Description: Deletes a storage group

URL: /84/sloprovisioning/symmetrix/{symmetrixId}/storagegroup/{storagegroupId}

User Roles: Administrator/Storage Administrator

Page 105 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

Prerequisite: Not applicable

Path Parameters: Attribute Name Type Optional Description

symmetrixId String No Unique identifier of the symmetrix

storageGroupId String No The Storage Group Name

Query Parameters: Not applicable

Request Parameters:

Not applicable

Response Parameters:

No content

4.2.5.2 Response Codes:

Response status code Description 204 No Content, returned when Resource is deleted successfully 401 Returned if an incorrect username, password, or both are specified 403 Returned if the specified username and password are correct, but the user is

not authorized to make this request 404 Returned if the requested resource cannot be found 500 Returned if a problem occurred when the system was deleting the

resource:

4.2.5.3 Error codes:

Future work

4.3 Common Objects

4.3.1 Iterator

An Iterator is a paged list of objects that is cached for a set period of time. Until the expiry time has been reached, the list of objects can be queried by page from the following locations:

/restapi/common/Iterator/{iteratorId}

../restapi/common/Iterator/{iteratorId}/page?from=1050&to=1100

Object iterator

Attribute Name Type Optional Description

id String No Unique iterator identifier that is used to look up the result until the expiry time is reached

Page 106 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

count int No Total number of result objects

ExpirationTime String No Unix timestamp that shows when the result will be removed from cache and no longer queryable

maxPageSize int No Maximum number of results that is allowed per result list page

result Object Array No Array of objects that is returned

4.3.1.1 Sample Object Array:

Object Iterator that contains list of:

daysToFullResultType

Attribute Name Type Optional Description

projectionDaysToFull float Yes Number of days until the specified category will be full, - to a maximum of 180 days

ProjectionMaxProjectedData

float Yes Maximum number of days that will be projected

ProjectionCapacityTrend

float Yes Projected capacity

PercentUsedCapacity

double Yes Current percentage of used capacity

TotalPoolCapacityGB

double Yes Current total capacity

instanceId

String No The unique identifier of the returned category object

4.3.1.1.1 Sample JSON Response:

{

"resultList": {

"result": [

{

"ProjectionDaysToFull": 181,

"ProjectionMaxProjectedData": 180,

"ProjectionCapacityTrend": 0,

"PercentUsedCapacity": 35.10973774908589,

"TotalPoolCapacityGB": 45727.2,

"instanceId": "000000000001"

}

],

Page 107 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

"from": 1,

"to": 1

},

"id": "31d90275-c8d3-42d2-ab98-0343a3b3b16e_0",

"count": 1,

"expirationTime": 1474474773510,

"maxPageSize": 1000

}

4.3.2 Job

Object job

Attribute Name Type Optional Description

jobId String No Unique identifier of the job instance

name String Yes Name of the job

status JobStatus enum:

CREATED SCHEDULED RUNNING SUCCEEDED FAILED ABORTED UNKNOWN VALIDATING VALIDATED VALIDATE_FAILED INVALID RETRIEVING_PICTURE

No Current status of the job

username string No User who initiated the job

last_modified_date String Yes Date the job was last modified

last_modified_date_milliseconds String Yes Date the job was last modified in milliseconds

scheduled_date String No Date the job was last scheduled

scheduled_date_milliseconds String Yes Date the job was last scheduled in milliseconds

completed_date String Yes Date the job was completed

completed_date_milliseconds String Yes Date the job was last completed in milliseconds

task TaskType Yes Current status of the job

Page 108 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

resourceLink String Yes URL of the object that is created, when applicable

result String Yes Description of the job outcome, its failure or success

Object TaskType

Attribute Name Type Optional Description

execution_order int Yes Order of the task

description String Yes Description of the task

4.3.2.1 Sample JSON Response:

{

"jobId": "1476181321815",

"name": "Create SAMPLE_REST_PG ",

"status": " SUCCEEDED ",

"username": "smc",

"last_modified_date": "Oct-11-2016 11:22:01.817",

"last_modified_date_milliseconds": 1476181321817,

"scheduled_date": "",

"scheduled_date_milliseconds": 0,

"completed_date": " Oct-11-2016 11:22:01.817",

"completed_date_milliseconds": 1476181321817,

"task": [

{

"execution_order": 1,

"description": "Create Port Group : SAMPLE_REST_PG"

}

],

"resourceLink": https://IP_ADDRESS:8443/univmax/restapi/84/sloprovisioning/symmetrix/{symmetrixId}/portgroup/SAMPL E_REST_PG,

"result": "SUCCEEDED - Started job execution on Fri 27 Jan 2017 07:57:59 AM GMT

Finished job execution on Fri 27 Jan 2017 07:58:49 AM GMT

Successfully created volume(s): 01076",

}

Page 109 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

4.3.2.2 Response Codes:

Response status code Description 200 Ok, returned when Resource is retrieved successfully 401 Returned if an incorrect username, password, or both are specified 403 Returned if the specified username and password are correct, but the user is

not authorized to make this request 404 Returned if the requested resource cannot be found 500 Returned if a problem occurred when the system was retrieving the resource:

4.3.2.3 Error codes:

Future work

4.3.3 Configuration Management Type

Object ConfigurationManagementParamType

Attribute Name Type Optional Description

executionOption

String enum:

SYNCHRONOUS

ASYNCHRONOUS

Yes Indicates whether the requested configuration management request should run synchronously or asynchronously

4.4 Automatic Cleanup of REST API jobs

All asynchronous and synchronous configuration change requests that are made through the REST API create a Job resource. Over time, the number of completed jobs accumulates and, without a mechanism to delete those jobs via the REST API, system performance might be impacted.

Because REST API jobs can be considered temporary resources that are relevant only while jobs run and to preempt any performance degradation, an automatic REST API cleanup task could perform a valuable function by deleting completed jobs.

The following list provides the functional requirements for implementing the automatic cleanup of REST API jobs:

Only jobs that are created for REST API requests are eligible for automatic deletion. A cleanup task runs at a default of every 24 hours and deletes any eligible REST API jobs. A REST API job is eligible for deletion if it meets the following requirements:

o Its status is one of SUCCEEDED, FAILED, or ABORTED. o At least the 24-hour default has passed since the job completed.

Page 110 Dell EMC Unisphere for PowerMax 9.0 REST API Change Log

The minimum time that must pass before a job is eligible for deletion is specified in hours, with a default value of 24. The valid range of values is from 1 to 32,767. The interval is configurable, and a new configuration requires an offline change to become active.

Automatic cleanup of REST API jobs is enabled by default, but it is configurable. Cleanup can be disabled, and any new configuration requires an offline change to become active.

Manualsnet FAQs

If you want to find out how the EMC Dell works, you can view and download the Dell EMC VMAX 100K V9.0 Storage REST API Change Log on the Manualsnet website.

Yes, we have the REST API Change Log for Dell EMC as well as other Dell manuals. All you need to do is to use our search bar and find the user manual that you are looking for.

The REST API Change Log should include all the details that are needed to use a Dell EMC. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Dell EMC VMAX 100K V9.0 Storage REST API Change Log is by checking the Table of Contents at the top of the page where available. This allows you to navigate a manual by jumping to the section you are looking for.

This Dell EMC VMAX 100K V9.0 Storage REST API Change Log consists of sections like Table of Contents, to name a few. For easier navigation, use the Table of Contents in the upper left corner.

You can download Dell EMC VMAX 100K V9.0 Storage REST API Change Log free of charge simply by clicking the “download” button in the upper right corner of any manuals page. This feature allows you to download any manual in a couple of seconds and is generally in PDF format. You can also save a manual for later by adding it to your saved documents in the user profile.

To be able to print Dell EMC VMAX 100K V9.0 Storage REST API Change Log, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell EMC VMAX 100K V9.0 Storage REST API Change Log as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.