Getting host NQN 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 host NQN 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/host-nqns

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

nvmSubsystemId

int

(Required) NVM subsystem ID

Specify a value from 0 to 2047.

Body
None.

Response message

Body
{
  "data": [
    {
        "hostNqnId":
"1,nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa39",
        "hostNqn":
"nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa39",
        "nvmSubsystemId":1,
        "hostNqnNickname":"myhost1"
    },
    {
        "hostNqnId":
"1,nqn.2014-08.org.example:uuid:f4d3488e-6986-4342-b693-9ecf5257e55d",
        "hostNqn":
"nqn.2014-08.org.example:uuid:f4d3488e-6986-4342-b693-9ecf5257e55d",
        "nvmSubsystemId":1,
        "hostNqnNickname":"myhost2"
    }
  ]
}

Attribute

Type

Description

hostNqnId

string

Object ID of the host NQN

The following attributes are output, separated by commas:

  • nvmSubsystemId
  • hostNqn

hostNqn

string

Host NQN

nvmSubsystemId

int

NVM subsystem ID

hostNqnNickname

string

Host NQN nickname

If the host NQN nickname is not set, a hyphen (-) is output.

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/host-nqns?nvmSubsystemId=1