Getting NVM subsystem port information

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 NVM subsystem port information.
Note:

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/nvm-subsystem-ports

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

nvmSubsystemId

int

(Optional) NVM subsystem ID

Specify a value from 0 to 2047.

You cannot specify this parameter and the portId parameter at the same time. You must specify either this parameter or the portId parameter.

portId

string

(Optional) Port number

You cannot specify this parameter and the nvmSubsystemId parameter at the same time. You must specify either this parameter or the nvmSubsystemId parameter.

Body
None.

Response message

Body
{
  "data": [
      {
          "nvmSubsystemPortId":"1,CL1-A",
          "nvmSubsystemId":1,
          "portId":"CL1-A"
      },
      {
          "nvmSubsystemPortId":"1,CL1-B",
          "nvmSubsystemId":1,
          "portId":"CL1-B"
      }
  ]
}

Attribute

Type

Description

nvmSubsystemPortId

string

Object ID of the NVM subsystem port

The following attributes are output, separated by commas:

  • nvmSubsystemId
  • portId

nvmSubsystemId

int

NVM subsystem ID

portId

string

Port number

Status codes

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

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/nvm-subsystem-ports?nvmSubsystemId=1