Getting information about a specific NVM subsystem

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 a specific NVM subsystem.

Execution permission

Note:

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

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/nvm-subsystems/object-ID

Request message

Object ID

Specify the nvmSubsystemId value obtained by getting NVM subsystem information.

Attribute

Type

Description

nvmSubsystemId

int

(Required) NVM subsystem ID

Query parameters
None.
Body
None.

Response message

Body
{
      "nvmSubsystemId" : 1,
      "nvmSubsystemName" : "rest_subsystem",
      "resourceGroupId" : 0,
      "namespaceSecuritySetting" : "Enable",
      "t10piMode" : "Disable",
      "hostMode" : "LINUX/IRIX",
      "hostModeOptions":[132,133],
      "nvmSubsystemNqn" : "nqn.2015-04.com.example:nvme:storage-subsystem-sn.5-10088-nvmssid.00001",
      "namespaces" : [
            {
              "namespaceId" : 1,
              "ldevId" : 2000
            },
            {
              "namespaceId" : 2,
              "ldevId" : 2001
            },
            {
              "namespaceId" : 3,
              "ldevId" : 2002
            }
        ],
      "portIds" : [ "CL1-A", "CL1-B" ]
}

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.

nvmSubsystemNqn

string

subsystem NQN

namespaces

object[]

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

  • namespaceId (int)

    Namespace ID

  • ldevId (int)

    LDEV number

This is not output if no namespace is created.

portIds

string[]

Port number

This is not output if no port is registered.

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/1