Create an iSCSI logical unit
Creates an iSCSI logical unit.
HTTP request syntax (URI)
POST <base_URI>/v8/storage/iscsi-logical-units
Parameters
Name | Type | Required | Values | Description |
path | BODY | Y | string | Absolute path to the iSCSI logical unit file, in UNIX format. |
comment | BODY | Y | string | Comment at the iSCSI logical unit creation. |
sizeInBytes | BODY | Y | number | Size of the iSCSI logical unit in bytes. |
filesystemId | BODY | Y | string | Either the file system object ID or HNAS file system ID. |
virtualServerId | BODY | Y | number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
iscsiLogicalUnitId | BODY | Y | string | iSCSI logical unit identifier name. |
Return codes
Code | Data | Description |
201 | iscsiLogicalUnit | iSCSI logical unit object created successfully |
400 | Error Message | Missing or invalid request contents. |
403 | Error Message | Operation forbidden by access level. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 201 indicates that the API did not complete successfully.
Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.58.117:8444/v8/storage/iscsilogical-units -d '{"comment": "xyz-curl-test", "filesystemId":"AACF4FA49143751B0000000000000000", "iSCSILogicalUnitId": "xyz-iscsi-lutest0", "path": "/folder/xyz-lu.iscsi", "sizeInBytes": 2000,"virtualServerId": 8}' -X POST
Response example
HTTP/1.1 201 Created { "iSCSILogicalUnit": { "comment": "xyz-curl-test", "filesystemId": "AACF4FA49143751B0000000000000000", "iSCSILogicalUnitId": "xyz-iscsi-lu-test0", "iSCSITargetIds": [], "objectId": "383a3a3a767361746973682d69736373692d6c752d7465737430", "isBoundToTarget": false, "isMounted": false, "path": "/folder/xyz-lu.iscsi", "percentageCreatedx100": 0, "sizeInBytes": 2000, "virtualServerId": 8 }, "uri": "https://172.17.58.117:8444/v8/storage/iscsi-logical-units/383a3a3a767361746973682d69736373692d6c752d7465737430" }