Update an iSCSI target

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

Updates an iSCSI target.

HTTP request syntax (URI)

PATCH <base_URI>/v7/storage/iscsi-targets/{iscsiObjectId}

Parameters

Name Type Required Values Description
iscsiObjectId URI_PARAM Y string iSCSI object ID.
secret BODY Y string iSCSI secret.
comment BODY Y string Comment at iSCSI creation.
accessConfig BODY Y string Access configuration.
enableAuthentication BODY Y boolean Enable authentication flag.
newAlias BODY Y string New iSCSI alias name.

Return codes

Code Data Description
303 iscsi iSCSI target updated successfully
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 303 indicates that the operation did not complete successfully.

Request example

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.58.117:8444/v7/storage/iscsi-targets/ 383a3a3a767361746973682d69736373692d746573742d32 -X PATCH -d'{"secret":"hellohere","comment":"user1-testing","newAlias":"vinh-iscsi- 255","accessConfig":"","enableAuthentication":true}'

Response example

HTTP/1.1 303 See Other
{
   "iSCSITarget" : {
      "accessConfig" : "",
      "comment" : "user1-testing",
      "globalUniqueName" : "iqn.2016-10.vsatish-iscsi-domain-1:satish.vinh-iscsi-testing",
      "iSCSIId" : "vinh-iscsi-255",
      "iSCSILogicalUnits" : [],
      "isAuthenticationEnabled" : true,
      "isRegenerateGUN" : false,
      "objectId" : "383a3a3a76696e682d69736373692d323535",
      "secret" : "hellohere",
      "virtualServerId" : 8
   },
   "uri" : "https://172.17.239.120:8444/v7/storage/iscsi-targets/383a3a3a76696e682d69736373692d323535"
}