DellEMC

REST API and DellEMC Storage Part 2 – PowerMax

This blog post is 2nd part of REST API with DellEMC Storage blog series. In the first part of this blog series, we discussed what is REST API and different usage options. I highly encourage you to go through the first part before you get started with this post.

In this post, we will discuss how you can use manage DellEMC PowerMax storage using REST API. We will be using the Postman tool during the entire blog series. So let’s get started with automating the DellEMC PowerMax storage system.

The PowerMax REST API Background

There are many different ways to manage the PowerMax storage system. You can refer to this link for more details around each. Traditionally many customers using the VMAX family systems are using the Solutions Enabler tool. This is a comprehensive tool that allows storage administrators to automate many different storage tasks using scripting (Bash, Perl, Shell scripts, etc.).

PowerMax Unisphere GUI is HTML5 based management interface, it’s beautiful and functional and provides a web-based interactive experience for users.  Unisphere has a lot of automation baked in, and it’s intuitive wizards eliminate complexity and can often provide the right amount of automation for organizations where there isn’t a lot of change. With Unisphere version 8 everything you can do in the GUI is supported using REST API.

DellEMC PowerMax Management Options

Assessing DellEMC PowerMax REST API

DellEMC PowerMax’s REST API is available via Unisphere (installed or embedded) running on the array via the following Base URL.

https://{{unisphere_management_address}}:{{8443}}/univmax/restapi/{{version}}

  • {{unisphere_management_address}} – Replace with IP Unisphere IP address or hostname
  • {{8443}} – Default port of Unisphere. Change this as per your environment
  • {{version}} – Replace this with Unisphere version. For Unisphere version 9, replace as 90

Supported DellEMC PowerMax REST API Operations

Unisphere for PowerMax’s REST API supports the following types of REST calls.

  • GET – Get information on objects. For example – list all the PowerMax serial numbers managed using Unisphere
  • POST – Create an Object. For example – Create new LUN/s
  • PUT – Making changes to an objects. For example – Change size of the existing LUN
  • DELETE – Remove an object. For example – Delete existing LUN/s

Usually the REST client (like Postman) can be used to help figure out what REST calls you want to run.

Building your REST API calls

Now let’s get started with creating REST API calls. In this example we will create sample REST API call to list all the available SRPs.

Before we get started make sure you’ve Postman installed and Unisphere is reachable.

  • Open Postman and click on New. Under new drop-down, select Request
DellEMC PowerMax REST API – Postman tool GUI – 1
  • In New Request pop-up enter Request name, Description (optional) and Name of the Collection. Then click on Save.
DellEMC PowerMax REST API – Postman tool GUI – 2
  • Click on the request type drop-down and select GET.
    • Please note that we are selecting GET because is this example we are creating sample REST API call to list all the available SRPs.
    • This option will be different based on type of REST API operation
DellEMC PowerMax REST API – Postman tool GUI – 3
  • Enter below Request URL
    • 1.1.1.1 – Replace with Unisphere IP address/hostname
    • 000123456789 – Replace with Serial number of PowerMax array

https://1.1.1.1:8443/univmax/restapi/90/sloprovisioning/symmetrix/000123456789/srp

DellEMC PowerMax REST API – Postman tool GUI – 4
  • Click on the Authorization. Enter Unisphere Username and Password. Then click Send
DellEMC PowerMax REST API – Postman tool GUI – 5
  • In the Postman Response section you’ll see REST API response. In this case you’ll see list of all the SRPs in PowerMax array.
DellEMC PowerMax REST API – Postman tool GUI – 6

Dell EMC and REST API – Way Forward

I hope this clarifies many basics for getting started with REST API and DellEMC storage. You might also have understood that creating creating valid URLs is very important aspect of using REST API. Having this in mind we have created ready Postman collection for DellEMC PowerMax storage. Here’s the GitHub link to the repository. Feel free to download and share.

Below are the additional resources available for taking REST API usage to next level.

  1. REST API client for Unisphere – This is simple GUI tool which allows you to to construct REST API calls. Best part of this tool is having a tree view of all resources on the Unisphere to which the users can navigate through to select the desired REST call.
  2. DellEMC PowerMax REST API Concepts and Programmer’s Guide – This link has REST API document for Dell EMC PowerMax array.

I hope this post will get you started with your Dell EMC PowerMax automation journey.

Follow my blog with Bloglovin

1 reply »

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s