SAN Storage
Overview
ZStack Cloud can connect to the SAN storage, including the iSCSI server and the FC storage.
iSCSI Server
ZStack Cloud allows you to add iSCSI servers. You can automatically log in to iSCSI servers without making any configuration on each host. In addition, ZStack Cloud can automatically detect online and discover disks, and initiate automatic configuration for the iSCSI servers in a convenient way. The iSCSI disks that are correctly detected can be used as follows:
- iSCSI disks can be passed through directly to VM instances.
- iSCSI disks can be added as Shared Block primary storages by means of shared blocks.
FC Storage
ZStack Cloud supports the FC storage pass-through, automatically detects online and discovers the preconfigured FC storages, and directly displays the details of FC storages. The FC storages that are correctly detected can be used as follows:
- The block devices of FC storages can be passed through directly to VM instances.
- The block devices of FC storages can be added as Shared Block primary storages by means of shared blocks.
Inventory
iSCSI Server Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property | 3.0.0 | ||
| name | The name. For more information, see Resource Property. | 3.0.0 | ||
| ip | The IP address. | Yes | 3.0.0 | |
| port | The port. | 3.0.0 | ||
| chapUserName | The CHAP user name. | 3.0.0 | ||
| chapUserPassword | The CHAP password. | 3.0.0 | ||
| state | The state. | 3.0.0 | ||
| iscsiTargets | 3.0.0 | |||
| iscsiClusterRefs | The cluster to which the iSCSI server belongs. | 3.0.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.0.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.0.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 |
Sample
{
"inventories": [
{
"createDate": "Sep 7, 2018 10:57:05 AM",
"ip": "192.168.1.2",
"iscsiClusterRefs": [],
"iscsiTargets": [],
"lastOpDate": "Sep 7, 2018 2:16:26 PM",
"name": "iscsi-11",
"port": 3260,
"state": "Enabled",
"uuid": "28ffe53fca5b4af9bcf0e53a02a739e8"
},
{
"createDate": "Sep 7, 2018 2:26:27 PM",
"ip": "172.20.196.239",
"iscsiClusterRefs": [],
"iscsiTargets": [
{
"createDate": "Sep 7, 2018 2:28:20 PM",
"iqn": "iqn.2018-06.org.disk1",
"iscsiLuns": [
{
"createDate": "Sep 7, 2018 2:28:20 PM",
"hctl": "3:0:0:0",
"iscsiTargetUuid": "14a6100d78d942bd8929cc268975f102",
"lastOpDate": "Sep 7, 2018 2:28:20 PM",
"model": "blkvdb",
"path": "ip-172.20.196.239:3260-iscsi-iqn.2018-06.org.disk1-lun-0",
"serial": "6001405f169fb0109a946489a5cbb813",
"size": 322122547200,
"type": "disk",
"uuid": "f423330a423649d9b07fe4d86a65d582",
"vendor": "LIO-ORG",
"wwid": "lvm-pv-uuid-FkDvRu-meu7-RH2K-69zA-C8kU-tEnW-uWPDnv",
"wwn": "0x6001405f169fb010"
}
],
"lastOpDate": "Sep 7, 2018 2:28:20 PM",
"uuid": "14a6100d78d942bd8929cc268975f102"
}
],
"lastOpDate": "Sep 7, 2018 2:26:27 PM",
"name": "iscsi-0",
"port": 3260,
"state": "Enabled",
"uuid": "ca5819d1c31341e7b61d08a94f769503"
}
],
"success": true
}
iSCSI LUN Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.0.0 | ||
| iscsiTargetUuid | The iSCSI target UUID. | 3.0.0 | ||
| wwid | The device WWID. | Yes | 3.0.0 | |
| vendor | The device vendor. | 3.0.0 | ||
| model | The device model. | 3.0.0 | ||
| wwn | The device WWN. | 3.0.0 | ||
| serial | The device serial No. | 3.0.0 | ||
| hctl | The SCSI device HCTL. | 3.0.0 | ||
| type | The device type. | 3.0.0 | ||
| path | The device path. | 3.0.0 | ||
| size | The device size. | 3.0.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.0.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.0.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 |
Sample
{
"inventories": [
{
"createDate": "Sep 7, 2018 2:28:20 PM",
"hctl": "3:0:0:0",
"iscsiTargetUuid": "14a6100d78d942bd8929cc268975f102",
"lastOpDate": "Sep 7, 2018 2:28:20 PM",
"model": "blkvdb",
"path": "ip-172.20.196.239:3260-iscsi-iqn.2018-06.org.disk1-lun-0",
"serial": "6001405f169fb0109a946489a5cbb813",
"size": 322122547200,
"type": "disk",
"uuid": "f423330a423649d9b07fe4d86a65d582",
"vendor": "LIO-ORG",
"wwid": "lvm-pv-uuid-FkDvRu-meu7-RH2K-69zA-C8kU-tEnW-uWPDnv",
"wwn": "0x6001405f169fb010"
}
],
"success": true
}
Fiber Channel Storage Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| wwnn | The device WWNN. | 3.1.0 | ||
| fiberChannelLuns | 3.1.0 | |||
| name | The name. For more information, see Resource Property. | 3.1.0 | ||
| state | The state. | 3.1.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.1.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"inventories": [
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelLuns": [
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"model": "MD32xx",
"name": "fc-lun-36b083fe000daf018000094d05bd78d4f",
"path": "pci-0000:05:00.0-fc-0x2022b083fedaf018-lun-6",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 1:41:46 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 1:41:46 PM",
"scsiLunUuid": "994ddaad4fe34f14b7bd4153b931fac5"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"hostUuid": "d03ea736cc534c7b8605d864ea24deae",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"scsiLunUuid": "994ddaad4fe34f14b7bd4153b931fac5"
}
],
"scsiLunVmInstanceRefs": [
{
"attachMultipath": true,
"createDate": "Oct 30, 2018 4:33:44 PM",
"deviceId": 1,
"lastOpDate": "Oct 30, 2018 4:33:44 PM",
"scsiLunUuid": "994ddaad4fe34f14b7bd4153b931fac5",
"vmInstanceUuid": "00905b289c3c464294d006810270c658"
}
],
"serial": "6b083fe000daf018000094d05bd78d4f",
"size": 107374182400,
"type": "mpath",
"uuid": "994ddaad4fe34f14b7bd4153b931fac5",
"vendor": "DELL",
"wwid": "36b083fe000daf018000094d05bd78d4f",
"wwn": "0x6b083fe000daf018"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"model": "MD32xx",
"name": "fc-lun-36f01faf000d5c3e700008c655bd792a8",
"path": "pci-0000:05:00.0-fc-0x2022b083fedaf018-lun-5",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"hostUuid": "d03ea736cc534c7b8605d864ea24deae",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"scsiLunUuid": "4e75b3a57cc44c27bd27be9bbe3378d8"
},
{
"createDate": "Oct 30, 2018 1:41:46 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 1:41:46 PM",
"scsiLunUuid": "4e75b3a57cc44c27bd27be9bbe3378d8"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6f01faf000d5c3e700008c655bd792a8",
"size": 107374182400,
"type": "mpath",
"uuid": "4e75b3a57cc44c27bd27be9bbe3378d8",
"vendor": "DELL",
"wwid": "36f01faf000d5c3e700008c655bd792a8",
"wwn": "0x6f01faf000d5c3e7"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"model": "MD32xx",
"name": "fc-lun-36b083fe000daf018000094ca5bd78cb2",
"path": "pci-0000:05:00.0-fc-0x2022b083fedaf018-lun-0",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"hostUuid": "d03ea736cc534c7b8605d864ea24deae",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"scsiLunUuid": "efcd656ffcaf4ad18fc21f9b310b79a7"
},
{
"createDate": "Oct 30, 2018 1:41:46 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 1:41:46 PM",
"scsiLunUuid": "efcd656ffcaf4ad18fc21f9b310b79a7"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6b083fe000daf018000094ca5bd78cb2",
"size": 536870912000,
"type": "mpath",
"uuid": "efcd656ffcaf4ad18fc21f9b310b79a7",
"vendor": "DELL",
"wwid": "36b083fe000daf018000094ca5bd78cb2",
"wwn": "0x6b083fe000daf018"
},
{
"createDate": "Oct 30, 2018 5:14:37 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 5:14:37 PM",
"model": "MD32xx",
"name": "fc-lun-36f01faf000d5c3e700008c5f5bd78864",
"path": "pci-0000:05:00.1-fc-0x2033b083fedaf018-lun-71",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 5:14:37 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 5:14:37 PM",
"scsiLunUuid": "ddf2215d9d5747b891cfee71cab09e71"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6f01faf000d5c3e700008c5f5bd78864",
"size": 10995116277760,
"type": "mpath",
"uuid": "ddf2215d9d5747b891cfee71cab09e71",
"vendor": "DELL",
"wwid": "36f01faf000d5c3e700008c5f5bd78864",
"wwn": "0x6f01faf000d5c3e7"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"model": "MD32xx",
"name": "fc-lun-36b083fe000daf018000094ce5bd78d1f",
"path": "pci-0000:05:00.0-fc-0x2022b083fedaf018-lun-4",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 1:41:46 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 1:41:46 PM",
"scsiLunUuid": "137b5e7d6af34930bd5cea31abff71fe"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"hostUuid": "d03ea736cc534c7b8605d864ea24deae",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"scsiLunUuid": "137b5e7d6af34930bd5cea31abff71fe"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6b083fe000daf018000094ce5bd78d1f",
"size": 107374182400,
"type": "mpath",
"uuid": "137b5e7d6af34930bd5cea31abff71fe",
"vendor": "DELL",
"wwid": "36b083fe000daf018000094ce5bd78d1f",
"wwn": "0x6b083fe000daf018"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"model": "MD32xx",
"name": "fc-lun-36b083fe000daf018000094cc5bd78cf5",
"path": "pci-0000:05:00.0-fc-0x2022b083fedaf018-lun-2",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 1:41:46 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 1:41:46 PM",
"scsiLunUuid": "9217164a150542b9887b5df6448c42f3"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"hostUuid": "d03ea736cc534c7b8605d864ea24deae",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"scsiLunUuid": "9217164a150542b9887b5df6448c42f3"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6b083fe000daf018000094cc5bd78cf5",
"size": 107374182400,
"type": "mpath",
"uuid": "9217164a150542b9887b5df6448c42f3",
"vendor": "DELL",
"wwid": "36b083fe000daf018000094cc5bd78cf5",
"wwn": "0x6b083fe000daf018"
},
{
"createDate": "Oct 30, 2018 5:14:37 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 5:14:37 PM",
"model": "MD32xx",
"name": "fc-lun-36b083fe000daf018000093115bd0662b",
"path": "pci-0000:05:00.1-fc-0x2033b083fedaf018-lun-30",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 5:14:37 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 5:14:37 PM",
"scsiLunUuid": "8154341bea594933866d703bfed2515c"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6b083fe000daf018000093115bd0662b",
"size": 1099511627776,
"type": "mpath",
"uuid": "8154341bea594933866d703bfed2515c",
"vendor": "DELL",
"wwid": "36b083fe000daf018000093115bd0662b",
"wwn": "0x6b083fe000daf018"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"model": "MD32xx",
"name": "fc-lun-36f01faf000d5c3e700008c615bd7924a",
"path": "pci-0000:05:00.0-fc-0x2022b083fedaf018-lun-1",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 1:41:46 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 1:41:46 PM",
"scsiLunUuid": "8a28ce7536724f88a17f73ea200ad8a5"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"hostUuid": "d03ea736cc534c7b8605d864ea24deae",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"scsiLunUuid": "8a28ce7536724f88a17f73ea200ad8a5"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6f01faf000d5c3e700008c615bd7924a",
"size": 536870912000,
"type": "mpath",
"uuid": "8a28ce7536724f88a17f73ea200ad8a5",
"vendor": "DELL",
"wwid": "36f01faf000d5c3e700008c615bd7924a",
"wwn": "0x6f01faf000d5c3e7"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"fiberChannelStorageUuid": "360338582fef4454bebdc76e8974ceb7",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"model": "MD32xx",
"name": "fc-lun-36f01faf000d5c3e700008c635bd79280",
"path": "pci-0000:05:00.0-fc-0x2022b083fedaf018-lun-3",
"scsiLunHostRefs": [
{
"createDate": "Oct 30, 2018 1:41:46 PM",
"hostUuid": "349bcc9f66204e5fbc466ae42261ddf5",
"lastOpDate": "Oct 30, 2018 1:41:46 PM",
"scsiLunUuid": "68fe12895449439eab9c9e12544d571f"
},
{
"createDate": "Oct 30, 2018 1:27:38 PM",
"hostUuid": "d03ea736cc534c7b8605d864ea24deae",
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"scsiLunUuid": "68fe12895449439eab9c9e12544d571f"
}
],
"scsiLunVmInstanceRefs": [],
"serial": "6f01faf000d5c3e700008c635bd79280",
"size": 107374182400,
"type": "mpath",
"uuid": "68fe12895449439eab9c9e12544d571f",
"vendor": "DELL",
"wwid": "36f01faf000d5c3e700008c635bd79280",
"wwn": "0x6f01faf000d5c3e7"
}
],
"lastOpDate": "Oct 30, 2018 1:27:38 PM",
"name": "fc-san-0x2002b083fedaf018",
"state": "Enabled",
"uuid": "360338582fef4454bebdc76e8974ceb7",
"wwnn": "0x2002b083fedaf018"
}
],
"success": true
}
SCSI LUN Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.2.0 | ||
| name | The name. For more information, see Resource Property. | 3.2.0 | ||
| wwid | The disk WWID. | 3.2.0 | ||
| vendor | The disk vendor. | 3.2.0 | ||
| model | The disk model. | 3.2.0 | ||
| wwn | The disk WWN. | 3.2.0 | ||
| serial | The disk serial No. | 3.2.0 | ||
| type | The disk type. | 3.2.0 | ||
| path | The disk path. | 3.2.0 | ||
| state | The disk state. | 3.2.0 | ||
| size | The disk size. | 3.2.0 | ||
| scsiLunHostRefs | The hosts that have SCSI LUN. | 3.2.0 | ||
| scsiLunVmInstanceRefs | The VM instances to which the SCSI LUN is attached. | 3.2.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.2.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.2.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.2.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.2.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag | Yes | 3.2.0 |
Sample
{
"inventories": [
{
"createDate": "Sep 7, 2018 10:57:05 AM",
"ip": "192.168.1.2",
"iscsiClusterRefs": [],
"iscsiTargets": [],
"lastOpDate": "Sep 7, 2018 2:16:26 PM",
"name": "iscsi-11",
"port": 3260,
"state": "Enabled",
"uuid": "28ffe53fca5b4af9bcf0e53a02a739e8"
},
{
"createDate": "Sep 7, 2018 2:26:27 PM",
"ip": "172.20.196.239",
"iscsiClusterRefs": [],
"iscsiTargets": [
{
"createDate": "Sep 7, 2018 2:28:20 PM",
"iqn": "iqn.2018-06.org.disk1",
"iscsiLuns": [
{
"createDate": "Sep 7, 2018 2:28:20 PM",
"hctl": "3:0:0:0",
"iscsiTargetUuid": "14a6100d78d942bd8929cc268975f102",
"lastOpDate": "Sep 7, 2018 2:28:20 PM",
"model": "blkvdb",
"path": "ip-172.20.196.239:3260-iscsi-iqn.2018-06.org.disk1-lun-0",
"serial": "6001405f169fb0109a946489a5cbb813",
"size": 322122547200,
"type": "disk",
"uuid": "f423330a423649d9b07fe4d86a65d582",
"vendor": "LIO-ORG",
"wwid": "lvm-pv-uuid-FkDvRu-meu7-RH2K-69zA-C8kU-tEnW-uWPDnv",
"wwn": "0x6001405f169fb010"
}
],
"lastOpDate": "Sep 7, 2018 2:28:20 PM",
"uuid": "14a6100d78d942bd8929cc268975f102"
}
],
"lastOpDate": "Sep 7, 2018 2:26:27 PM",
"name": "iscsi-0",
"port": 3260,
"state": "Enabled",
"uuid": "ca5819d1c31341e7b61d08a94f769503"
}
],
"success": true
}
nvmeLun inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| nvmeTargetUuid | The UUID of the NVMe target which the NVMe disk belongs to. | 4.6.21 | ||
| uuid | The UUID. For more information, see Resource Property. | 4.6.21 | ||
| name | The name. For more information, see Resource Property. | 4.6.21 | ||
| wwid | The disk WWID. | 4.6.21 | ||
| vendor | The disk vendor. | 4.6.21 | ||
| model | The disk model. | 4.6.21 | ||
| wwn | The disk WWN. | 4.6.21 | ||
| serial | The disk serial No. | 4.6.21 | ||
| type | The disk type. | 4.6.21 | ||
| htcl | 4.6.21 | |||
| path | The disk path. | 4.6.21 | ||
| state | The disk state. | 4.6.21 | ||
| size | The disk size. | 4.6.21 | ||
| multipathDeviceUuid | The UUID of the multi-path device. | 4.6.21 | ||
| source | The disk source, NVMe. | 4.6.21 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | 4.6.21 | ||
| createDate | The creation date. For more information, see Resource Property. | 4.6.21 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 4.6.21 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.6.21 | |
| systemTags | The system tags. For more information, see CreateSystemTag | Yes | 4.6.21 |
Sample
{
"inventories": [
{
"createDate": "Apr 11, 2023 12:03:49 PM",
"lastOpDate": "Apr 11, 2023 12:03:49 PM",
"model": "WDC WDS250G2B0C-00PXH0",
"name": "nvme-lun-eui.e8238fa6bf530001001b448b48b4bc5b",
"nvmeLunHostRefs": [
{
"createDate": "Apr 11, 2023 12:03:49 PM",
"hostUuid": "306b48c6439548eb977bb27e9eb22b2e",
"lastOpDate": "Apr 11, 2023 12:03:49 PM",
"nvmeLunUuid": "3cb57b604dce4f76addeb29022c9225b"
}
],
"nvmeTargetUuid": "62574365d0d64778bc0c65d362c21689",
"path": "pci-0000:06:00.0-nvme-1",
"serial": "21073Q800405",
"size": 250059350016,
"source": "NVMe",
"state": "Enabled",
"type": "disk",
"uuid": "3cb57b604dce4f76addeb29022c9225b",
"vendor": "",
"wwid": "eui.e8238fa6bf530001001b448b48b4bc5b",
"wwn": "eui.e8238fa6bf530001001b448b48b4bc5b"
}
],
"success": true
}
nvmeHostRef inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| nvmeLunUuid | The UUID of the NVMe disk. | 4.6.21 | ||
| hostUuid | The host UUID. | 4.6.21 | ||
| path | The disk path. | 4.6.21 | ||
| htcl | 4.6.21 | |||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | 4.6.21 | ||
| createDate | The creation date. For more information, see Resource Property. | 4.6.21 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 4.6.21 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.6.21 | |
| systemTags | The system tags. For more information, see CreateSystemTag | Yes | 4.6.21 |
Sample
{
"createDate": "Apr 11, 2023 12:03:49 PM",
"hostUuid": "f5b560bcfc8e48aabae8c022d43812e8",
"lastOpDate": "Apr 11, 2023 12:03:49 PM",
"nvmeLunUuid": "c5ec7ac0c549416faee013acbc68a272"
}
nvmeTarget inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 4.6.21 | ||
| name | The name. For more information, see Resource Property. | 4.6.21 | ||
| nqn | The unique name of the NVMe. | 4.6.21 | ||
| state | The state. | 4.6.21 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | 4.6.21 | ||
| createDate | The creation date. For more information, see Resource Property. | 4.6.21 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 4.6.21 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.6.21 | |
| systemTags | The system tags. For more information, see CreateSystemTag | Yes | 4.6.21 |
Sample
{
"inventories": [
{
"createDate": "Apr 11, 2023 12:03:49 PM",
"lastOpDate": "Apr 11, 2023 12:03:49 PM",
"name": "nvme-of-nqn.2018-01.com.wdc:nguid:E8238FA6BF53-0001-001B448B48B4BC5B",
"nqn": "nqn.2018-01.com.wdc:nguid:E8238FA6BF53-0001-001B448B48B4BC5B",
"nvmeLuns": [
{
"createDate": "Apr 11, 2023 12:03:49 PM",
"lastOpDate": "Apr 11, 2023 12:03:49 PM",
"model": "WDC WDS250G2B0C-00PXH0",
"name": "nvme-lun-eui.e8238fa6bf530001001b448b48b4bc5b",
"nvmeLunHostRefs": [
{
"createDate": "Apr 11, 2023 12:03:49 PM",
"hostUuid": "306b48c6439548eb977bb27e9eb22b2e",
"lastOpDate": "Apr 11, 2023 12:03:49 PM",
"nvmeLunUuid": "3cb57b604dce4f76addeb29022c9225b"
}
],
"nvmeTargetUuid": "62574365d0d64778bc0c65d362c21689",
"path": "pci-0000:06:00.0-nvme-1",
"serial": "21073Q800405",
"size": 250059350016,
"source": "NVMe",
"state": "Enabled",
"type": "disk",
"uuid": "3cb57b604dce4f76addeb29022c9225b",
"vendor": "",
"wwid": "eui.e8238fa6bf530001001b448b48b4bc5b",
"wwn": "eui.e8238fa6bf530001001b448b48b4bc5b"
}
],
"state": "Enabled",
"uuid": "62574365d0d64778bc0c65d362c21689"
}
],
"success": true
}
Operations
QueryScsiLun
Queries an iSCSI LUN and an FC LUN. For example,
QueryScsiLun name=fc-lun-36b083fe000daf018000022905ba35d8f
Primitive Fields of Query
See SCSI LUN Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| scsiLunHostRefs | SCSI LUN Host Reference Inventory | The hosts that have SCSI LUN attached. | 3.2.0 |
| scsiLunVmInstanceRefs | SCSI LUN VM Instance Ref Inventory | The VM instances that have SCSI LUN attached. | 3.2.0 |
DetachScsiLunFromHost
Detaches a LUN from a host. For example,
DetachScsiLunFromHost uuid=dce542427a3a3d1fa13324c9f67352cb
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The SCSI LUN UUID. | 4.2.0 | ||
| hostUuid | The host UUID. | Yes | 4.2.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.2.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.2.0 | |
| timeout | Yes |
iSCSI Server
AddIscsiServer
Adds an iSCSI server. For example,
AddIscsiServer name=iSCSIServer ip=192.168.1.1
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 3.0.0 | ||
| ip | The IP address. | 3.0.0 | ||
| port | The port. Default port: 3260. | 3.0.0 | ||
| chapUserName | The CHAP user name, which is default to an empty string. | Yes | 3.0.0 | |
| chapUserPassword | The CHAP password, which is default to an empty string. | Yes | 3.0.0 | |
| resourceUuid | Yes | 3.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 | |
| timeout | Yes |
DeleteIscsiServer
Deletes an iSCSI server. For example,
DeleteIscsiServer uuid=632e6c9d5959443594cf2f03ed3e59f0
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The iSCSI server UUID. | 3.0.0 | ||
| deleteMode | 3.0.0 | |||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 | |
| timeout | Yes |
QueryIscsiServer
Queries an iSCSI server. For example,
QueryIscsiServer ip=192.168.1.2
Primitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| iscsiTarget | iSCSI Target Inventory | 3.0.0 | |
| iscsiCluster | iSCSI Cluster Inventory | The cluster to which the iSCSI server belongs. | 3.0.0 |
RefreshIscsiServer
Refreshes an iSCSI server. For example,
RefreshIscsiServer uuid=28ffe53fca5b4af9bcf0e53a02a739e8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 | |
| timeout | Yes |
UpdateIscsiServer
Updates the configurations of an iSCSI server. For example,
UpdateIscsiServer uuid=28ffe53fca5b4af9bcf0e53a02a739e8 name=iscsi-11
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.0.0 | ||
| name | The resource name. | Yes | 3.0.0 | |
| chapUserName | The CHAP user name. | Yes | 3.0.0 | |
| chapUserPassword | The CHAP password. | Yes | 3.0.0 | |
| state | The state. | Yes |
|
3.0.0 |
| resourceUuid | Yes | 3.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 | |
| timeout | Yes |
AttachIscsiServerToCluster
Attaches an iSCSI server to a cluster. For example,
AttachIscsiServerToCluster uuid=ca5819d1c31341e7b61d08a94f769503 clusterUuid=eac4264df1724538aa0631bf646d69d8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The iSCSI server UUID. | 3.0.0 | ||
| clusterUuid | The cluster UUID. | 3.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 | |
| timeout | Yes |
DetachIscsiServerFromCluster
Detaches an iSCSI server from a cluster. For example,
DetachIscsiServerFromCluster uuid=ca5819d1c31341e7b61d08a94f769503 clusterUuid=eac4264df1724538aa0631bf646d69d8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The iSCSI server UUID. | 3.0.0 | ||
| clusterUuid | The cluster UUID. | 3.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.0 | |
| timeout | Yes |
QueryIscsiLun
Queries an iSCSI LUN. For example,
QueryIscsiLun uuid=f423330a423649d9b07fe4d86a65d582
Primitive Fields of Query
See iSCSI LUN Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| iscsiTarget | iSCSI Target Inventory | 3.0.0 |
FC Storage
QueryFiberChannelStorage
Queries an FC SAN storage. For example,
QueryFiberChannelStorage uuid=ba3cb22ad8f14043ade6d07eb2a4bb8c
Primitive Fields of Query
See Fiber Channel Storage Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| iscsiTarget | iSCSI Target Inventory | 3.1.0 | |
| iscsiCluster | iSCSI Cluster Inventory | The cluster to which the iSCSI server belongs. | 3.1.0 |
RefreshFiberChannelStorage
Refreshes an FC SAN storage. For example,
RefreshFiberChannelStorage zoneUuid=b88a7824538142f9b9b6e012ef46029f
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The FC SAN storage UUID. | Yes | 3.1.0 | |
| zoneUuid | The zone UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
UpdateScsiLun
Updates an SCSI LUN. For example,
UpdateScsiLun uuid=137b5e7d6af34930bd5cea31abff71fe
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| name | The resource name. | Yes | 3.1.0 | |
| state | The state. | Yes |
|
3.1.0 |
| userTags | The user tags. For more information, see CreateUserTag). | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
AttachScsiLunToVmInstance
Attaches an SCSI LUN to a VM instance. For example,
AttachScsiLunToVmInstance uuid=137b5e7d6af34930bd5cea31abff71fe vmInstanceUuid=da85d8325067411cb20afa94e477e6c2
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The SCSI LUN UUID. | 3.1.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.1.0 | ||
| disableMultiPathAttach | Whether to turn off the switch for automatically attaching multi-path devices. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
DetachScsiLunFromVmInstance
Detaches an SCSI LUN from a VM instance. For example,
DetachScsiLunFromVmInstance uuid=137b5e7d6af34930bd5cea31abff71fe vmInstanceUuid=da85d8325067411cb20afa94e477e6c2
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
CheckScsiLunClusterStatus
Checks the connection status between an SCSI LUN and the attached cluster. For example,
CheckScsiLunClusterStatus clusterUuid=3d279bbb771b4adf99d1ed04afcc956e uuid=9217164a150542b9887b5df6448c42f3
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| clusterUuid | The cluster UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
GetScsiLunCandidatesForAttachingVm
Obtains an SCSI LUN that can be attached by a VM instance. For example,
GetScsiLunCandidatesForAttachingVm uuid=00905b289c3c464294d006810270c658
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vmInstanceUuid | The VM instance UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | ||
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | ||
| timeout | Yes |
NVMe Storage
QueryNvmeLun
Queries a NVMe disk. For example,
QueryNvmeLun name=nvme-lun-eui.e8238fa6bf530001001b448b48b4bc5b
Primitive Fields of Query
See nvmeLun inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| nvmeLunHostRef | See nvmeHostRef inventory. | 4.6.21 | |
| nvmeTarget | See nvmeTarget inventory. | 4.6.21 |
QueryNvmeTarget
Queries a NVMe device. For example,
QueryNvmeTarget uuid=62574365d0d64778bc0c65d362c21689
Primitive Fields of Query
See nvmeTarget inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| nvmeLun | See nvmeLun inventory. | 4.6.21 |
RefreshNvmeTarget
Refreshes a NVMe device. For example,
RefreshNvmeTarget zoneUuid=79db1bfbf7e542bb824067bcdde3799c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| zoneUuid | The zone UUID. | 4.6.21 | ||
| nvmeLunUuids | The NVMe disk UUID. | 4.6.21 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.6.21 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.6.21 | |
| timeout | Yes |
Tags
You can create a user tag on an iSCSI server by using resourceType=IscsiServerVO. For example,
CreateUserTag resourceType=IscsiServerVO tag=golden-ResourceStack
resourceUuid=ca5819d1c31341e7b61d08a94f769503
