Setting the nickname for an iSCSI name

Execution permission

Storage Administrator (Provisioning)

Request line

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

Request message

Object ID

Specify the value of hostIscsiId that was obtained by the processing to get information about the iSCSI name. You can also specify the attributes and connect them with commas as follows:

portId,hostGroupNumber,iscsiName

Attribute	Type	Description
portId	string	(Required) Port number
hostGroupNumber	int	(Required) Target ID of the iSCSI target
iscsiName	string	(Required) iSCSI name of the host bus adapter (iSCSI initiator) registered for the iSCSI target

Query parameters

None.

Body

When setting the nickname for the iSCSI name

{
  "iscsiNickname": "REST_API_Testing"
}

When deleting the nickname from the iSCSI name:

{
  "iscsiNickname": ""
}

Attribute	Type	Description
iscsiNickname	string	(Required) Specify a nickname consisting of 1 to 32 characters for the iSCSI name of the host bus adapter. You can use the following characters. Alphanumeric characters The following symbols: . @ _ - The label cannot start with a hyphen (-). To delete the nickname from the iSCSI name, 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 iSCSI name 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-iscsis/CL1-B,0,iqn.20150907