Getting information about a specific host NQN

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 host NQN.

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/host-nqns/object-ID

Request message

Object ID

Specify the hostNqnId value obtained by getting host NQN information. You can also specify the following attributes and connect them with commas:

nvmSubsystemId,hostNqn

Attribute

Type

Description

nvmSubsystemId

int

(Required) NVM subsystem ID

hostNqn

string

(Required) Host NQN

Query parameters
None.
Body
None.

Response message

Body
{
      "hostNqnId":
"1,nqn.2014-08.org.example:uuid:ff533865-1d0b-4043-8345-a90afbb80d8b",
      "hostNqn":
"nqn.2014-08.org.example:uuid:ff533865-1d0b-4043-8345-a90afbb80d8b",
      "nvmSubsystemId":1,
      "hostNqnNickname":"myhost1"
}

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/1,nqn.2014-08.org.example:uuid:ff533865-1d0b-4043-8345-a90afbb80d8b