Getting NVM subsystem 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 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-subsystems

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

nvmSubsystemInfo

string

(Optional) Type of information to be obtained

The specifiable values are as follows:

  • basic

    Gets basic information about the NVM subsystem.

  • nqn

    Gets information about the subsystem NQN of the NVM subsystem.

  • namespace

    Gets information about the namespace created in the NVM subsystem.

  • port

    Gets information about the port registered in the NVM subsystem.

Gets only information about the implemented NVM subsystem.

If this parameter is omitted, the value basic is assumed.

You cannot specify this parameter at the same time as the nvmSubsystemOption parameter.

nvmSubsystemOption

string

(Optional) Condition of the NVM subsystem for which information is to be obtained

The following value can be input as a condition.

  • undefined

    Gets the NVM subsystem IDs of unimplemented NVM subsystems.

You cannot specify this parameter at the same time as the nvmSubsystemInfo parameter.

Body
None.

Response message

Body

The following is an example of output when basic information is obtained by specifying basic in the query parameter nvmSubsystemInfo, or if the query parameter is not specified.

{
   "data": [
       {
          "nvmSubsystemId":1,
          "nvmSubsystemName":"rest_subsystem",
          "resourceGroupId":0,
          "namespaceSecuritySetting":"Enable",
          "t10piMode":"Disable",
          "hostMode":"LINUX/IRIX",
          "hostModeOptions":[132,133]
       },
       ...
   ]
}

Attribute

Type

Description

nvmSubsystemId

int

NVM subsystem ID

nvmSubsystemName

string

NVM subsystem name

resourceGroupId

int

Resource group ID of the resource group to which the NVM subsystem belongs

namespaceSecuritySetting

string

Namespace security settings

  • Enable: Enabled
  • Disable: Disabled
  • Unknown: Status unknown (unsupported)

t10piMode

string

Status of the T10 PI mode of the port

  • Enable: Enabled
  • Disable: Disabled
  • Unknown: Status unknown (unsupported)

hostMode

string

Host mode of the NVM subsystem

This is not output if a host mode is not set.

hostModeOptions

int[]

Number of the host mode option set for the NVM subsystem

This is not output if a host mode option is not set.

For details on the number to be obtained, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

The following is an example of output when subsystem NQN information is obtained by specifying nqn in the query parameter nvmSubsystemInfo.

{
   "data": [
       {
          "nvmSubsystemId":1,
          "nvmSubsystemName":"rest_subsystem",
          "nvmSubsystemNqn":"nqn.2015-04.com.example:nvme:storage-subsystem-sn.5-10088-nvmssid.00001"
       },
       ...
   ]
}

Attribute

Type

Description

nvmSubsystemId

int

NVM subsystem ID

nvmSubsystemName

string

NVM subsystem name

nvmSubsystemNqn

string

subsystem NQN

The following is an example of output when namespace information is obtained by specifying namespace in the query parameter nvmSubsystemInfo.

{
   "data": [
       {
           "nvmSubsystemId":1,
           "nvmSubsystemName":"rest_subsystem",
           "namespaces":[
               {
                "namespaceId":1,
                "ldevId:2000
               },
               {
                "namespaceId":2,
                "ldevId:2001
               },
               {
                "namespaceId":3,
                "ldevId:2002
               }
            ]
       },
       ...
   ]
}

Attribute

Type

Description

nvmSubsystemId

int

NVM subsystem ID

nvmSubsystemName

string

NVM subsystem name

namespaces

object[]

Outputs the following attributes related to a namespace created in the NVM subsystem.

  • namespaceId (int)

    Namespace ID

  • ldevId (int)

    LDEV number

The following is an example of output when port information is obtained by specifying port in the query parameter nvmSubsystemInfo.

{
   "data": [
       {
         "nvmSubsystemId":1,
         "nvmSubsystemName":"rest_subsystem",
         "portIds":["CL1-A","CL1-B"]
       },
       ...
   ]
}

Attribute

Type

Description

nvmSubsystemId

int

NVM subsystem ID

nvmSubsystemName

string

NVM subsystem name

portIds

string[]

Port number

The following is an example of output when the NVM subsystem IDs of unimplemented NVM subsystems by specifying undefined in the query parameter nvmSubsystemOption.

{
   "data": [
       {
         "nvmSubsystemId":3
       },
       {
         "nvmSubsystemId":4
       },
       ...
   ]
}

Attribute

Type

Description

nvmSubsystemId

int

NVM subsystem ID

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-subsystems?nvmSubsystemInfo=basic