Setting the nickname for a WWN

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 sets the nickname for a WWN registered in the host group. You can also delete the nickname that is already set.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/v1/objects/host-wwns/object-ID

Request message

Object ID

Specify the value of hostWwnId that was obtained by the processing to get information about the WWN. You can also specify the following attributes and connect them with commas:

portId,hostGroupNumber,hostWwn

Attribute

Type

Description

portId

string

(Required) Port number

hostGroupNumber

int

(Required) Host group number of the port

hostWwn

string

(Required) WWN of the host bus adapter registered in the host group

Query parameters
None.
Body

When setting the nickname for the WWN:

{
  "wwnNickname": "REST_API_Created"
}

When deleting the nickname from the WWN:

{
  "wwnNickname": ""
}

Attribute

Type

Description

wwnNickname

string

(Required) Specify a WWN nickname consisting of 1 to 64 characters.

You can use the following characters.

  • Alphanumeric characters
  • The following symbols:

    . @ _ : , -

    The label cannot start with a hyphen (-).

You cannot specify the nickname that is used for other WWN of the same port.

To delete the nickname from the WWN, specify a null character string.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the description on job objects.

Attribute

Description

affectedResources

URL of the WWN whose settings were changed

Action template

None.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/host-wwns/CL1-A,0,1212121212121212