Unisphere for VMAX REST Client

This app provides both a front end GUI for the REST API documents(described below)
and a Unisphere for VMAX specific REST client based on the WADL file received from the
Unisphere for VMAX Host.

REST API Documentation

The Unisphere for VMAX REST API documentation is available here : https://
UNIVMAX_IP:UNIVMAX_PORT/univmax/restapi/docs , Where, UNIVMAX_IP is the
IP address and UNIVMAX_PORT is the port, of the host running Unisphere for
VMAX. Once the Zip file has been downloaded, extract the zip file contents and
open index.html. All URLs, Required parameters and returned results for each
resource are detailed in full within these navigable REST API documents. The
subsequent WADL file is also available from this location.

How this app works

Installing RESTclient.jar
Copy the attached RESTclient.jar file to any environment that has java JRE installed

Running:
RESTclient.jar is a runnable JAR file so it can be run by double clicking on the JAR
file or executing the following the command java jar RESTclient.jar from the
specified directory

User Inputs
Run the JAR file.
In the Server Info panel select the edit icon
Enter the IP Address, Username, Password, Protocol and Port of the Unisphere Server.

Generated by Jive on 2016-08-31-07:00

1

Unisphere for VMAX REST Client

The App makes a number of calls to the Server to get the latest Server info and WADL file.

An expandable tree view of all resources available on the Unisphere Host specified is
populated in the left panel to which the user can navigate through to select the desired
REST call.
Available Rest calls include:
LIST : This is a GET call that lists all items for a selected object e.g. https://
UNIVMAX_IP:UNIVMAX_PORT/univmax/restapi/sloprovisioning/symmetrix/{symmetrixId}/storagegroup
GET: This returns a single object e.g. https://UNIVMAX_IP:UNIVMAX_PORT/univmax/restapi/
sloprovisioning/symmetrix/{symmetrixId}/storagegroup/{storageGroupId}
POST(Create): This call is used to create an object e.g. https://UNIVMAX_IP:UNIVMAX_PORT/univmax/
restapi/sloprovisioning/symmetrix/{symmetrixId}/storagegroup
PUT(Edit): This call is used to edit an existing object e.g. https://UNIVMAX_IP:UNIVMAX_PORT/univmax/
restapi/sloprovisioning/symmetrix/{symmetrixId}/storagegroup
DELETE: this call is used to delete an object e.g. https://UNIVMAX_IP:UNIVMAX_PORT/univmax/restapi/
sloprovisioning/symmetrix/{symmetrixId}/storagegroup

Once a call is selected the URL description is loaded in the URL info panel and all relevant
information for that call is loaded in the right panels:
Resource Info panel
The URL of the call is displayed with an option to enter the required URL objects.
The required URL objects can be looked up using REST calls(if available) when
lookup Objects is selected. If this is not selected the user must manually supply
the required object ids e.g. restapi/sloprovisioning/symmetrix/00012345689/
storagegroup
The actually URL that will be sent is loaded in the URL text field, this can be manually edited.
The REST method that is used for this call is displayed e.g. GET
Once all required URL objects are supplied the Send button will be available.
Return Panel
Displays all information returned by the host
Response Info Panel
Displays info the REST call including the time taken to return from the host and the response
code.
LIST:
Query Parameters Panel
Optional Parameters that are available on some resources
These editable form attributes allow the user to filter the returned list of object Ids from
Unisphere for VMAX.
Tool tip information is available when the user hoovers over the ? icon
POST / PUT:
Request Parameters Panel
Editable form attributes that the user edits to generate the required input JSON for the
POST call.
* indicates a mandatory fields
Request Generated JSON Panels
Auto populated panel based on the information supplied in the Request Parameters
Panel.
INVALID indicates that one or more items are completed incorrectly

Generated by Jive on 2016-08-31-07:00

2

Unisphere for VMAX REST Client

Pre-requisites
-JAVA JRE installed

*** Updated Client added on 3rd June 2016 to support TLSv1.2 in Unisphere 8.2 and above
***

Generated by Jive on 2016-08-31-07:00

3