Simple Configuration Manager REST API Calls

Document created by Jeff Maaks on Mar 29, 2016Last modified by Craig Chan on Mar 3, 2017
Version 9Show Document
  • View in full screen mode

This document contains a few simple examples for using the Configuration Manager REST API.  These examples use cURL but you can use any method you choose to send HTTP requests.  All examples are run locally on the Configuration Manager REST API server (stay tuned for a developer sandbox lab!).

 

Check out the Configuration Manager REST API Reference Guide for more detailed information.

 

User Authentication

 

When required, I'll be using simple basic authorization in these script examples (based on the default user ID / password after initial HCS installation).  The base64-encoded string is the user ID and password concatenated with a colon (:).

 

Get HCS REST API version number

 

The request below gets information about the version of the REST API.

 

curl http://localhost:23450/ConfigurationManager/configuration/version
  

 

Response message:

{

     "productName" : "Configuration Manager REST API",

     "apiVersion" : "1.2.0"

}

      

 

 

Get a List of Storage Systems

 

The request below gets a list of the storage systems that can be operated from the REST API.  No authentication is required for this request.

 

curl http://localhost:23450/ConfigurationManager/v1/objects/storages

 

Response message:

{

     "data" : [ {

          "storageDeviceId" : "832000400020",

          "model" : "VSP G100",

          "serialNumber" : 400020,

          "svpIp" : "172.16.152.1"

     }, {

          "storageDeviceId" : "834000400040",

          "model" : "VSP G400",

          "serialNumber" : 400040,

          "svpIp" : "172.16.154.1"

     } ]

}

      

 

 

Get Information About a Specific Storage System

 

Now let's get some information about the VSP G400 in the list above:

 

curl --header "Authorization: Basic aG9nZTpwaX1vZnVnYQ==" http://localhost:23450/ConfigurationManager/v1/objects/storages/832000400040

 

Response message:

 

{

  "storageDeviceId" : "834000400040",

  "model" : "VSP G400",

  "serialNumber" : 400040,

  "svpIp" : "172.16.154.1",

  "rmiPort" : 1099,

  "ctl1Ip" : "172.16.154.1",

  "dkcMicroVersion" : "73-03-31/00",

  "communicationModes" : [ {

    "communicationMode" : "lanConnectionMode"

  } ]

}

1 person found this helpful

Attachments

    Outcomes