Unisphere for PowerMax 10.x: How to get device level metrics through RESTAPI

This article reviews how to collect device-level metrics through REST API to Unisphere for PowerMax 10.x instances.

Each RESTAPI call needs three things:

• A URL
• A call Type
• A payload

To collect volume metrics, the URL is:

• https://<IPorFQDN>:8443/univmax/restapi/performance/Volume/metrics

The Call type is: POST
The Payload is structured as follows for JSON: (For XML, see the "Additional Information" section)

{
"systemId": "000xxxxxxxxx",
"volumeStartRange": "xxxxx",
"volumeEndRange": "xxxxx",
"dataFormat": "Maximum",
"endDate":xxxxxxxxxxxxxx,
"metrics": [
"metric1",
"metric2",
"metric3",
"etc"
],
"startDate": xxxxxxxxxxxxxxx
}

Each field has requirements. This applies for any calls using these fields: 

• "systemId" requires the full 12 digits of the array serial number, and must be in quotes.
• "volumeStartRange" and "volumeEndRange" both require the 5-digit device ID, and it must be in quotes. (Yes, you can have more than one.)
• "dateFormat" can be Maximum or Average, also in quotes.
• "startDate" and "endDate" are the EPOCH timestamp in milliseconds (this covers the date and time).
• "metrics" you can list multiple metrics, but they must be in quotes and separated with a comma.

By having a valid URL, Call Type, and Payload, you have a valid call. However, for volume metrics, there are additional restrictions for the device on the backend:

• The volume must be in an SG.
• The SG must be in an MV.
• The SG must be in the "Storage group real-time" metric collection list in system registrations.
• The path to add an SG to Real-time is: Settings > Performance > System Registration > Click the clipboard

• Lastly, the time range CANNOT be more than 60 minutes.
  • When building your EPOCK times in milliseconds, ensure that the Start and End dates are not more than 60 minutes apart. 
  • It is recommended to do a smaller time window, such as five minutes, during call testing. 

Once all the restrictions are met, you can run the call and get an HTTP 200 response code with the device metrics:

 

Here is some additional information that may be needed:

XML Payload format for device-level metric call:

<volumeParam xmlns="http://www.emc.com/em/2012/07/univmax/restapi/performance">
  <startDate>...</startDate>
  <endDate>...</endDate>
  <systemId>...</systemId>
  <volumeStartRange>...</volumeStartRange>
  <volumeEndRange>...</volumeEndRange>
  <commaSeparatedStorageGroupList>...</commaSeparatedStorageGroupList>
  <dataFormat>...</dataFormat>
  <metrics>...</metrics>
</volumeParam>

To see all the major changes with 10.x, reference the following: what-s-new-in-powermax-rest-api

For RESTAPI, the documentation specific to your Unisphere version can be collected using the following steps. This documentation can help find what is needed for calls and the payload structure. 

1. Download the RESTAPI docs file by going to:
   • https://UNIVMAX_IP:UNIVMAX_PORT/univmax/restapi/docs
   • The UNIVMAX_IP is the IP address, and UNIVMAX_PORT is the port of the host running Unisphere.
2. Move the file to the location that you want to keep the documentation.
3. Extract the .zip file contents.
4. Look for the file named "index.html" in the list of extracted files.
5. Open the "index.html":
   • Remember where this file is, as this is how you access the documentation.
   • It should open a window in your web browser.

At the time of creating this KB article, the possible device-level metrics are:

EPOCH timestamps can be generated at other websites like EPOCHconverter. 
Keep in mind this is NOT a Dell site, so Dell holds no control over its functionality or support.