Attach SCSI LUN to Virtual Machine

POST/zstack/v1/vm-instances/{vmInstanceUuid}/scsi-lun/{uuid}

Request

cURL

curl --request POST \
  --url '/v1/vm-instances/{vmInstanceUuid}/scsi-lun/{uuid}' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/vm-instances/{vmInstanceUuid}/scsi-lun/{uuid}"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "disableMultiPathAttach": false
  },
  "systemTags": [],
  "userTags": []
}

In the example above, the systemTags and userTags fields can be omitted. They are listed to indicate that the body can contain these two fields.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"disableMultiPathAttach":false}}' http://localhost:8080/zstack/v1/vm-instances/e5bc51b4fdd13d35b4abe7be408435d4/scsi-lun/e4ea0f73829b3206a497c88b896613d6

Parameter List

Name	Type	Location	Description	Starting Version
uuid	String	url	SCSI LUN UUID, uniquely identifies the resource	3.1.0
vmInstanceUuid	String	url	Virtual Machine UUID	3.1.0
disableMultiPathAttach (Optional)	String	url	Disable automatic multipath device attachment	3.1.0
systemTags (Optional)	List	body		3.1.0
userTags (Optional)	List	body		3.1.0

API Response

Response Example

{
  "inventory": {
    "name": "fc-lun-36b083fe000daf018000022905ba35d8f",
    "uuid": "d20114f179003943904fee1127d16eba",
    "wwid": "36b083fe000daf018000022905ba35d8f",
    "vendor": "DELL",
    "model": "MD32xx",
    "wwn": "0x6f01faf000d5c3e7",
    "serial": "6b083fe000daf018000015505abbe00a",
    "type": "mpath",
    "path": "pci-0000:05:00.0-fc-0x2012b083fedaf018-lun-11",
    "size": 5497558138880.0,
    "scsiLunHostRefs": [
      {
        "id": 1.0,
        "scsiLunUuid": "d20114f179003943904fee1127d16eba",
        "hostUuid": "e62d261d3f293e0182f85779e105eb13",
        "createDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "scsiLunVmInstanceRefs": [
      {
        "id": 1.0,
        "scsiLunUuid": "d20114f179003943904fee1127d16eba",
        "vmInstanceUuid": "84af387a5ef034818cc8488eaddbf5f3",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "attachMultipath": false
      }
    ],
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}

Name	Type	Description	Starting Version
error	ErrorCode	Error code. If not null, the operation failed. If null, the operation succeeded. For details, see error	3.1.0
inventory	ScsiLunInventory	For details, see inventory	3.1.0

error

Name	Type	Description	Starting Version
code	String	Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001	3.1.0
description	String	Brief description of the error	3.1.0
details	String	Detailed error information	3.1.0
elaboration	String	Reserved field, defaults to null	3.1.0
opaque	LinkedHashMap	Reserved field, defaults to null	3.1.0
cause	ErrorCode	Root cause. The error that caused the current error. If there is no original error, this field is null	3.1.0

inventory

Name	Type	Description	Starting Version
name	String	Resource name	3.1.0
uuid	String	Resource UUID, uniquely identifies the resource	3.1.0
wwid	String	Disk globally unique identifier	3.1.0
vendor	String	Disk vendor	3.1.0
model	String	Disk model	3.1.0
wwn	String	Disk WWN	3.1.0
serial	String	Disk serial number	3.1.0
type	String	Disk type	3.1.0
path	String	Disk path	3.1.0
state	String	Disk enabled state	3.1.0
size	Long	Disk size	3.1.0
createDate	Timestamp	Creation time	3.1.0
lastOpDate	Timestamp	Last modification time	3.1.0
scsiLunHostRefs	List	For details, see scsiLunHostRefs	3.1.0
scsiLunVmInstanceRefs	List	For details, see scsiLunVmInstanceRefs	3.1.0

scsiLunHostRefs

Name	Type	Description	Starting Version
scsiLunUuid	String	SCSI LUN UUID	3.1.0
hostUuid	String	Host UUID	3.1.0
createDate	Timestamp	Creation time	3.1.0
lastOpDate	Timestamp	Last modification time	3.1.0

scsiLunVmInstanceRefs

Name	Type	Description	Starting Version
scsiLunUuid	String	SCSI LUN UUID	3.1.0
vmInstanceUuid	String	Virtual Machine UUID	3.1.0
createDate	Timestamp	Creation time	3.1.0
lastOpDate	Timestamp	Last modification time	3.1.0

SDK Examples

Java SDK

AttachScsiLunToVmInstanceAction action = new AttachScsiLunToVmInstanceAction();
action.uuid = "e4ea0f73829b3206a497c88b896613d6";
action.vmInstanceUuid = "e5bc51b4fdd13d35b4abe7be408435d4";
action.disableMultiPathAttach = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachScsiLunToVmInstanceAction.Result res = action.call();

Python SDK

AttachScsiLunToVmInstanceAction action = AttachScsiLunToVmInstanceAction()
action.uuid = "e4ea0f73829b3206a497c88b896613d6"
action.vmInstanceUuid = "e5bc51b4fdd13d35b4abe7be408435d4"
action.disableMultiPathAttach = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachScsiLunToVmInstanceAction.Result res = action.call()