Changing the settings of an iSCSI target

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/servers/object-ID/target-iscsi-ports/object-ID

Request message

Object ID

Combines multiple object IDs that are specified.

Specify the id value and the portId value, obtained by using the API function for getting information about the server, in the following format:

id/target-iscsi-ports/portId

Attribute	Type	Description
id	int	(Required) Server ID
portId	string	(Required) Port ID

Query parameters

None.

Body

The following is an example of changing the iSCSI name to iqn.rest.example.of.iqn.hostB for an iSCSI target of an iSCSI-connected server (server ID: 11, port ID: CL1-B):

{
  "targetIscsiName": "iqn.rest.example.of.iqn.hostB"
}

Attribute	Type	Description
targetIscsiName	string	(Required) Specifies the iSCSI name of the iSCSI target. Specify this item in iqn or eui format: iqn format Specify a value that begins with iqn.. Use no more than 223 characters. You can use alphanumeric characters (0 through 9, A through Z, a through z), and the following symbols: Hyphen (-), period (.), colon (:) Specification example: iqn.rest.example.of.iqn.form eui format After "eui.", specify a hexadecimal number. Specify a value consisting of 20 characters. You can use alphanumeric characters (0 through 9, A through F, a through f). Specification example: eui.0900ABDC32598D26

Response message

Body

Attribute	Type	Description
statusResource	string	URL used to obtain the execution results of the change the iSCSI name of the server request

Note:

Execute the API function for obtaining information about the status of the API function that performs asynchronous processing. For details, see Getting status information about an API function that performs asynchronous processing.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/11/target-iscsi-ports/CL1-B