Retrieving data by using REST API with a web browser

Edit online

A convenient way to use the IBM Spectrum Control REST API is within the interface itself. You can quickly access resource information for your reporting capabilities by using a web browser.

To use the REST API with a web browser, use these steps:

Log on to the IBM Spectrum Control GUI. To start IBM Spectrum Control, see Starting IBM Spectrum Control.
Open a new tab in your web browser.
Enter https://<hostname>:9569/srm/REST/api/v1/.

For example, to see a list of fabrics, enter https://<hostname>:9569/srm/REST/api/v1/Fabrics in a new tab of your web browser (partial listing).

[
   {
      "Acknowledged": "No",
      "Active Zone Set": "",
      "Connected Switch Ports": "0",
      "Custom Tag 1": "",
      "Custom Tag 2": "",
      "Custom Tag 3": "",
      "Data Source Count": "1",
      "Fabric Type": "Cisco",
      "Last Successful Probe": "N\/A",
      "Links": "0",
      "Location": "",
      "NPV Switches": "0",
      "Name": "VSAN0002",
      "Parent Fabric": "san_director",
      "Principal Switch of Fabric": "tpc-70swt-csc",
      "Probe Schedule": "N\/A",
      "Probe Status": "N\/A",
      "Status": "Error",
      "Switch Ports": "0",
      "Switches": "1",
      "Virtual": "Yes",
      "WWN": "2002000DECAC5081",
      "id": "2663"
   }

To see the information for a specific fabric in your environment, append the URL with the ID:

https://<hostname>:9569/srm/REST/api/v1/Fabrics/2017

Example (partial listing)

{
   "Acknowledged": "No",
   "Active Zone Set": "",
   "Connected Switch Ports": "18",
   "Custom Tag 1": "",
   "Custom Tag 2": "",
   "Custom Tag 3": "",
   "Data Source Count": "2",
   "Fabric Type": "Cisco",
   "Last Successful Probe": "N\/A",
   "Links": "4",
   "Location": "",
   "NPV Switches": "0",
   "Name": "san_director",
   "Parent Fabric": "",
   "Principal Switch of Fabric": "",
   "Probe Schedule": "N\/A",
   "Probe Status": "N\/A",
   "Status": "Error",
   "Switch Ports": "104",
   "Switches": "2",
   "Virtual": "No",
   "WWN": "",
   "id": "2017"

To see the switches that belong to the fabric "id": "2017", enter:

https://<hostname>:9569/srm/REST/api/v1/Fabrics/2017/Switches

Example (partial listing)

[
   {
      "Acknowledged": "No",
      "Connected Fabrics": "",
      "Custom Tag 1": "",
      "Custom Tag 2": "",
      "Custom Tag 3": "",
      "Data Source Count": "1",
      "Domain ID": "10",
      "Fabric": "unstable_BRCD_1-11",
      "Firmware": "v6.4.3g",
      "IP Address": "9.11.91.241",
      "Last Successful Monitor": "None",
      "Last Successful Probe": "None",
      "Links": "",
      "Location": "",
      "Mode": "Native",
      "Model": "Brocade 4100",
      "Name": "mdm-y76-swt",
      "Parent Switch": "",
      "Performance Monitor Interval (min)": "",
      "Performance Monitor Status": "Disabled",
      "Ports": "",
      "Principal Switch of Fabric": "cjswitch4",
      "Probe Status": "Never Probed",
      "Serial Number": "1070029",
      "Status": "Normal",
      "Vendor": "IBM",
      "Virtual": "No",
      "WWN": "100000051E347790",
      "id": "60989"
   }

Note: IBM Spectrum Control can connect to Brocade switches and fabrics either directly or by using Brocade Network Advisor. For Brocade switches and fabrics that IBM Spectrum Control connects to directly, the Data Source Count value is 0.

Table 1. IBM Spectrum Control REST API URL examples
IBM Spectrum® Control REST API	Description
`https://<hostname>:9569/srm/REST/api/v1/StorageSystems`	A list of all monitored storage systems.
`https://<hostname>:9569/srm/REST/api/v1/StorageSystems/2002`	Specific information for one storage system (ID is available from this URL: `https://<hostname>:9569/srm/REST/api/v1/StorageSystems`) .
`https://<hostname>:9569/srm/REST/api/v1/StorageSystems/2002/Volumes`	A list of all volumes for one storage system.
`https://<hostname>:9569/srm/REST/api/v1/StorageSystems/2002/Volumes/2465/Performance`	The available performance metrics for a volume.
`https://<hostname>:9569/srm/REST/api/v1/StorageSystems/2002/RemoteReplication`	The remote mirror replication relationships for storage systems.
`https://<hostname>:9569/srm/REST/api/v1/StorageSystems/2002/Volumes/2465/Performance/824?granularity=sample&startTime=1455818400000&endTime=1455904800000`	Sample performance granularity information and a start and end time for the performance data.

Note: IBM® Storage is changing the capacity terminology that is used in IBM Storage products to make it more consistent. The new capacity terminology is used in IBM Spectrum Control 5.3.6 or later. The new terminology is used in the GUI, but the names used in the REST API have not changed. The output from the REST API continues to use Allocated Space instead of Used Capacity, Physical Allocation instead of Used Capacity %, and so on.