Getting information about a specific storage system

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request gets information about the storage system for which an operation is to be performed.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/storages/instance

Request message

Object ID
Specify a value for instance. For objects that have only one instance, the value of instance is a fixed value (the object ID).
Query parameters

Attribute

Type

Filter Condition

detailInfoType

string

(Optional) Type of detailed information to be obtained

The following values can be specified. To specify multiple values, separate the values by using commas.

  • version

    Additional detailed information about the microcode of the storage system, controller 1, and controller 2 is obtained.

  • compressionAcceleration

    Additional information indicating whether the compression accelerator of the capacity saving function (dedupe and compression) can be used is obtained.

Body

None.

Response message

Body
{
  "storageDeviceId" : "886000123456",
  "model" : "VSP G700",
  "serialNumber" : 123456,
  "ctl1Ip": "192.0.10.10",
  "ctl2Ip": "192.0.10.11",
  "dkcMicroVersion" : "88-01-01/00",
  "communicationModes": [
    {
      "communicationMode": "lanConnectionMode"
    }
  ],
  "isSecure": true
}

Attribute

Type

Description

storageDeviceId

string

Storage device ID

model

string

Model name of the storage system

serialNumber

int

Serial number of the storage system

svpIp

string

IP address of the SVP

This attribute is displayed for storage systems VSP 5000 series

ctl1Ip

string

IP address of controller 1 of the storage system

This attribute is displayed for storage systems VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900

ctl2Ip

string

IP address of controller 2 of the storage system

This attribute is displayed for storage systems VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900

dkcMicroVersion

string

Microcode version of the storage system

communicationModes

object[]

Array of communication modes

The following attributes are output for the communication modes between the REST API server and the storage system:

  • communicationMode (string)

    Communication mode

    lanConnectionMode is displayed.

isSecure

boolean

Whether the communication between the REST API server and the storage system is secure.

The default value is true.

You can obtain detailed information about the microcode of the storage system by executing the request with version specified for the detailInfoType query parameter.

{
  "storageDeviceId": "886000123456",
  "model": "VSP G900",
  "serialNumber": 123456,
  "ctl1Ip" : "192.0.10.10",
  "ctl2Ip" : "192.0.10.11",
  "dkcMicroVersion": "88-01-01/82",
  "detailDkcMicroVersion": "88-01-01-60/82",
  "ctl1MicroVersion" : "88-01-01/81",
  "ctl2MicroVersion" : "88-01-01/81",
  "communicationModes": [
    {
      "communicationMode": "lanConnectionMode"
    }
  ],
  "isSecure": true
}

Attribute

Type

Description

detailDkcMicroVersion

string

Microcode version of the storage system

Model identification information is included.

ctl1MicroVersion

string

GUM version of the controller 1

This attribute is displayed for storage systems VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

If a failure has occurred in the GUM of controller 1, this information is not obtained.

ctl2MicroVersion

string

GUM version of the controller 2

This attribute is displayed for storage systems VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

If a failure has occurred in the GUM of controller 2, this information is not obtained.

When you specify compressionAcceleration for the detailInfoType parameter, information indicating whether the compression accelerator can be used is obtained.

{
  "storageDeviceId": "900000012345",
  "model": "VSP 5600H",
  "serialNumber": 12345,
  "svpIp": "192.0.2.100",
  "rmiPort" : 1099,
  "dkcMicroVersion": "90-08-01/00",
  "isCompressionAccelerationAvailable": true,
  "communicationModes": [
     {
       "communicationMode": "lanConnectionMode"
     }
  ],
    "isSecure": true
}

Attribute

Type

Description

isCompressionAccelerationAvailable

boolean

Whether the capacity saving function (dedupe and compression) that uses a compression accelerator can be used

  • true: Can be used
  • false: Cannot be used
If both of the following conditions are met, the value of the attribute will be true:
  • The microcode version is a version for which the compression accelerator can be used or a later version.
  • ACLF (hardware that executes the compression accelerator function) is installed in the storage system.

For details on the capacity saving function that uses a compression accelerator, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/storages/instance