Getting WWN 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
Specifying a port and host group, the following request gets the information about the WWN registered for the host group.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-wwns

Request message

Object ID
None.
Query parameters

Parameter

Type

Filter Condition

portId

string

(Required) Port number

hostGroupNumber

int

(Optional) The host group number

You must specify one of the following parameters: this parameter, the hostGroupName parameter, or the hostGroupNumberList parameter.

hostGroupName

string

(Optional) The host group name

You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupNumberList parameter.

hostGroupNumberList

string

(Optional) The host group number

You can obtain information quickly by specifying this parameter.

To specify multiple IDs, delimit each ID by using a comma.

You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupName parameter.

Body

None.

Response message

Body
{
  "data": [
    {
      "hostWwnId": "CL1-A,0,000000102cceccc9",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "my@host999",
      "hostWwn": "000000102cceccc9",
      "wwnNickname": "Myhostwwnsecret"
    },
    {
      "hostWwnId": "CL1-A,0,1111111111111111",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "my@host999",
      "hostWwn": "1111111111111111",
      "wwnNickname": "formyhost"
    }
  ]
}

Attribute

Type

Description

hostWwnId

string

Object ID for the WWN

portId

string

Port number

hostGroupNumber

int

Host group number of the port

hostGroupName

string

Host group name of the port

hostWwn

string

WWN of the host bus adapter registered for the host group

wwnNickname

string

WWN nickname

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 d7b673af189048468c5af9bcf3bbbb6f" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/host-wwns?portId=CL1-A&hostGroupNumber=0"