Inventory

BareMetal2Chassis inventory

Name Description Optional Valid Value Starting Version
uuid The UUID of the bare metal chassis. 4.0.0
name The name of the bare metal chassis. 4.0.0
description The detailed description of the bare metal chassis. 4.0.0
zoneUuid The zone UUID. 4.0.0
clusterUuid The cluster UUID. 4.0.0
chassisOfferingUuid The chassis offering UUID. 4.0.0
type The type of the chassis. 4.0.0
state The state of the chassis. 4.0.0
status The distribution state of the chassis. 4.0.0
groupBy 4.0.0
createDate The time when the chassis was created. 4.0.0
lastOpDate The time when the chassis was last modified. 4.0.0
chassisNics 4.0.0
chassisDisks 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
Sample
{
    "inventories": [
        {
            "chassisDisks": [
                {
                    "chassisUuid": "8c946b89af8349b4bdadebb4ebb717c1",
                    "createDate": "Dec 3, 2020 2:32:17 PM",
                    "diskSize": 2000398934016,
                    "lastOpDate": "Dec 3, 2020 2:32:17 PM",
                    "type": "HDD",
                    "uuid": "a7013135c6b84f6097773a08a04f8180"
                },
                {
                    "chassisUuid": "8c946b89af8349b4bdadebb4ebb717c1",
                    "createDate": "Dec 3, 2020 2:32:17 PM",
                    "diskSize": 250059350016,
                    "lastOpDate": "Dec 3, 2020 2:32:17 PM",
                    "type": "SSD",
                    "uuid": "cdc8f86613c247719c1ed4118b5bfb7f"
                }
            ],
            "chassisNics": [
                {
                    "chassisUuid": "8c946b89af8349b4bdadebb4ebb717c1",
                    "createDate": "Dec 3, 2020 2:32:17 PM",
                    "isProvisionNic": true,
                    "lastOpDate": "Dec 3, 2020 2:32:17 PM",
                    "mac": "ac:1f:6b:e4:65:58",
                    "speed": "1000Mb/s",
                    "uuid": "dee0fbca929f4c749b54e0c78c98d858"
                },
                {
                    "chassisUuid": "8c946b89af8349b4bdadebb4ebb717c1",
                    "createDate": "Dec 3, 2020 2:32:17 PM",
                    "isProvisionNic": false,
                    "lastOpDate": "Dec 3, 2020 2:32:17 PM",
                    "mac": "ac:1f:6b:e4:65:59",
                    "speed": "1000Mb/s",
                    "uuid": "e00ac88d4e2846738311a3211a771e68"
                }
            ],
            "chassisOffering": {
                "architecture": "x86_64",
                "cpuModelName": "Intel(R) Xeon(R) Silver 4208 CPU @ 2.10GHz",
                "cpuNum": 16,
                "createDate": "Dec 1, 2020 8:46:17 PM",
                "lastOpDate": "Dec 1, 2020 8:46:17 PM",
                "memorySize": 67132342272,
                "name": "Intel(R) Xeon(R) Silver 4208 CPU @ 2.10GHz",
                "state": "Enabled",
                "uuid": "9d83b93efc564a4193a7917f35956b59"
            },
            "chassisOfferingUuid": "9d83b93efc564a4193a7917f35956b59",
            "clusterUuid": "d746f7256a734a34b9c85cc83b02e2a2",
            "createDate": "Dec 1, 2020 8:35:23 PM",
            "ipmiAddress": "172.19.40.11",
            "ipmiPort": 623,
            "ipmiUsername": "admin",
            "lastOpDate": "Dec 7, 2020 7:50:37 AM",
            "name": "BM",
            "powerStatus": "POWER_ON",
            "state": "Enabled",
            "status": "Allocated",
            "type": "IPMI",
            "uuid": "8c946b89af8349b4bdadebb4ebb717c1",
            "zoneUuid": "9ebbda92b5264a38b3d992a45fa14818"
        }
    ],
    "success": true
}

BareMetal2ChassisOffering inventory

Name Description Optional Valid Value Starting Version
uuid The UUID of the bare metal chassis offering. 4.0.0
name The name of the bare metal chassis offering. 4.0.0
description The detailed description of the bare metal chassis offering. 4.0.0
groupBy 4.0.0
architecture The CPU architecture. 4.0.0
cpuModelName The CPU model name. 4.0.0
cpuNum The number of CPU cores. 4.0.0
memorySize The memory size. 4.0.0
bootMode The boot mode. 4.0.0
state The state of the chassis offering. 4.0.0
createDate The time when the chassis offering was created. 4.0.0
lastOpDate The time when the chassis offering was last modified. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
Sample
{
  "inventories": [
    {
      "uuid": "f64db447a42a4673a5b2a6aa6476725e",
      "name": "BM-8C-8G",
      "description": "This is bare metal instance offering.",
      "architecture": "x86_64",
      "cpuModelName": "Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz",
      "cpuNum": 8.0,
      "memorySize": 8.589934592E9,
      "bootMode": "UEFI",
      "state": "Enabled",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

BareMetal2ChassisGateway Inventory

Name Description Optional Valid Value Starting Version
attachedClusterUuids The attached cluster UUIDs. 4.0.0
username The username of the gateway. 4.0.0
sshPort The SSH port. 4.0.0
zoneUuid The zone UUID. 4.0.0
name The name of the gateway. 4.0.0
uuid The UUID of the gateway. 4.0.0
clusterUuid The cluster UUID. 4.0.0
description The detailed description of the gateway. 4.0.0
managementIp The IP address of the management node. 4.0.0
hypervisorType The virtualization type. 4.0.0
state The state of the gateway. 4.0.0
status The connection status of the gateway. 4.0.0
totalCpuCapacity The total processing capacity of CPU. 4.0.0
availableCpuCapacity The available processing capacity of CPU. 4.0.0
cpuSockets 4.0.0
totalMemoryCapacity The total memory size. 4.0.0
availableMemoryCapacity The available memory size. 4.0.0
cpuNum The number of CPU cores. 4.0.0
createDate The time when the gateway was created. 4.0.0
lastOpDate The time when the was gateway last modified. 4.0.0
provisionNic 4.0.0
userTags The user tags. For more information, see CreateUserTag Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag Yes 4.0.0
Sample
{
    "inventories": [
        {
            "attachedClusterUuids": [
                "d746f7256a734a34b9c85cc83b02e2a2"
            ],
            "availableCpuCapacity": 160,
            "availableMemoryCapacity": 66960363520,
            "clusterUuid": "d746f7256a734a34b9c85cc83b02e2a2",
            "cpuNum": 16,
            "cpuSockets": 1,
            "createDate": "Dec 1, 2020 11:27:52 AM",
            "hypervisorType": "baremetal2",
            "lastOpDate": "Dec 7, 2020 2:21:08 PM",
            "managementIp": "172.25.12.75",
            "name": "Gateway",
            "provisionNic": {
                "createDate": "Dec 3, 2020 8:02:51 PM",
                "interfaceName": "zsn0",
                "ip": "10.99.0.1",
                "lastOpDate": "Dec 3, 2020 8:02:51 PM",
                "netmask": "255.255.0.0",
                "networkUuid": "ed0549b43dd442dfaf03102cfb12ac44",
                "uuid": "fec68c7c6cb64f83880a6e775b9bfd4d"
            },
            "sshPort": 22,
            "state": "Enabled",
            "status": "Connected",
            "totalCpuCapacity": 160,
            "totalMemoryCapacity": 66960363520,
            "username": "root",
            "uuid": "fec68c7c6cb64f83880a6e775b9bfd4d",
            "zoneUuid": "9ebbda92b5264a38b3d992a45fa14818"
        }
    ],
    "success": true
}

BareMetal2Instance inventory

Name Description Optional Valid Value Starting Version
uuid The bare metal instance UUID. 4.0.0
name The bare metal instance name. 4.0.0
description The detailed description of the bare metal instance. Yes 4.0.0
zoneUuid The zone UUID. 4.0.0
clusterUuid The cluster UUID. 4.0.0
chassisUuid The bare metal chassis UUID. 4.0.0
imageUuid The image UUID. 4.0.0
platform The system platform. 4.0.0
state 4.0.0
status 4.0.0
groupBy Yes 4.0.0
createDate The time when the bare metal instance was created. 4.0.0
lastOpDate The time when the bare metal instance was last modified. 4.0.0
userTags The user tags. For more information, see CreateUserTag Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag Yes 4.0.0
Sample
{
    "inventories": [
        {
            "allVolumes": [
                {
                    "actualSize": 43037753344,
                    "createDate": "Dec 3, 2020 2:09:49 PM",
                    "description": "DataVolume-37c7740bc6964b7f88ddb6dfe437dbc1",
                    "deviceId": 1,
                    "diskOfferingUuid": "0ba949fc7cb64ea3a33450b6eeedc268",
                    "format": "qcow2",
                    "installPath": "sharedblock://b1b722a00d9740f6b262ba16a2fd63dd/b3da61e4a1774e428fabae9b64518aa5",
                    "isShareable": false,
                    "lastOpDate": "Dec 4, 2020 10:19:21 AM",
                    "name": "DATA-for-33",
                    "primaryStorageUuid": "b1b722a00d9740f6b262ba16a2fd63dd",
                    "size": 21474836480,
                    "state": "Enabled",
                    "status": "Ready",
                    "type": "Data",
                    "uuid": "2a0f008a60bf460fb6926eea764ccdbd",
                    "vmInstanceUuid": "37c7740bc6964b7f88ddb6dfe437dbc1",
                    "volumeQos": "total=10485760"
                },
                {
                    "actualSize": 252379660288,
                    "createDate": "Dec 3, 2020 2:09:49 PM",
                    "description": "Root volume for VM[uuid:37c7740bc6964b7f88ddb6dfe437dbc1]",
                    "deviceId": 0,
                    "format": "qcow2",
                    "installPath": "sharedblock://b1b722a00d9740f6b262ba16a2fd63dd/476eb00220434c6bb6e04e5f92410b8c",
                    "isShareable": false,
                    "lastOpDate": "Dec 4, 2020 2:44:11 PM",
                    "name": "ROOT-for-33",
                    "primaryStorageUuid": "b1b722a00d9740f6b262ba16a2fd63dd",
                    "rootImageUuid": "3ae080d4a88d4bf796be57c4f78ad26a",
                    "size": 250059350016,
                    "state": "Enabled",
                    "status": "Ready",
                    "type": "Root",
                    "uuid": "f2492b817c294eff829d837552337b89",
                    "vmInstanceUuid": "37c7740bc6964b7f88ddb6dfe437dbc1"
                }
            ],
            "chassisUuid": "8c946b89af8349b4bdadebb4ebb717c1",
            "clusterUuid": "d746f7256a734a34b9c85cc83b02e2a2",
            "cpuNum": 16,
            "cpuSpeed": 0,
            "createDate": "Dec 3, 2020 2:09:49 PM",
            "gatewayAllocatorStrategy": "DefaultGatewayAllocatorStrategy",
            "gatewayUuid": "fec68c7c6cb64f83880a6e775b9bfd4d",
            "hypervisorType": "baremetal2",
            "imageUuid": "3ae080d4a88d4bf796be57c4f78ad26a",
            "lastChassisUuid": "8c946b89af8349b4bdadebb4ebb717c1",
            "lastGatewayUuid": "fec68c7c6cb64f83880a6e775b9bfd4d",
            "lastOpDate": "Dec 7, 2020 2:21:51 PM",
            "memorySize": 67132342272,
            "name": "33",
            "platform": "Linux",
            "provisionNic": {
                "createDate": "Dec 3, 2020 2:11:21 PM",
                "ip": "10.99.0.2",
                "lastOpDate": "Dec 3, 2020 2:11:21 PM",
                "mac": "ac:1f:6b:e4:65:58",
                "netmask": "255.255.0.0",
                "networkUuid": "ed0549b43dd442dfaf03102cfb12ac44",
                "uuid": "37c7740bc6964b7f88ddb6dfe437dbc1"
            },
            "rootVolumeUuid": "f2492b817c294eff829d837552337b89",
            "state": "Running",
            "status": "Connected",
            "type": "baremetal2",
            "uuid": "37c7740bc6964b7f88ddb6dfe437dbc1",
            "vmCdRoms": [],
            "vmNics": [],
            "zoneUuid": "9ebbda92b5264a38b3d992a45fa14818"
        }
    ],
    "success": true
}

BareMetal2Bonding inventory

Name Description Optional Valid Value Starting Version
chassisUuid 4.4.24
name 4.4.24
slaves 4.4.24
opts 4.4.24
mode 4.4.24
createDate 4.4.24
lastOpDate 4.4.24
accountUuid 4.4.24
uuid 4.4.24

allVolumes inventory

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 4.0.0
name The resource name. 4.0.0
description The resource description. 4.0.0
primaryStorageUuid The primary storage UUID. 4.0.0
vmInstanceUuid The VM UUID. 4.0.0
diskOfferingUuid The disk offering UUID. 4.0.0
rootImageUuid The root volume image UUID. 4.0.0
installPath The installation path of the volume on the primary storage. 4.0.0
type The volume type. 4.0.0
format The volume format. 4.0.0
size The volume size. Yes 4.0.0
actualSize The actual size of the volume. 4.0.0
deviceId 4.0.0
state The state of the volume. 4.0.0
status The status of the volume. 4.0.0
createDate The creation time. 4.0.0
lastOpDate The last update time. 4.0.0
isShareable Indicates whether the volume is sharable. 4.0.0
volumeQos The volume QoS. 4.0.0

BareMetal2ProvisionNetwork inventory

Name Description Optional Valid Value Starting Version
uuid The deployment network UUID. 4.0.0
zoneUuid The zone UUID. 4.0.0
name The deployment network name. 4.0.0
description The detailed description of the deployment network. 4.0.0
dhcpRangeStartIp The starting IP address that DHCP assigns to a bare metal instance. 4.0.0
dhcpRangeEndIp The ending IP address that DHCP assigns to a bare metal instance. 4.0.0
dhcpRangeNetmask The netmask of the IP range from which the DHCP server assigns an IP address to a bare metal instance. 4.0.0
dhcpRangeGateway The gateway IP address. 4.0.0
dhcpRangeNetworkCidr The CIDR block. 4.0.0
state The state of the deployment network. 4.0.0
attachedClusterUuids 4.0.0
createDate The time when the deployment network was created. 4.0.0
lastOpDate The time when the deployment network was last modified. 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
Sample
{
    "inventories": [
        {
            "attachedClusterUuids": [
                "d746f7256a734a34b9c85cc83b02e2a2"
            ],
            "createDate": "Dec 1, 2020 11:03:45 AM",
            "dhcpInterface": "zsn0",
            "dhcpRangeEndIp": "10.99.255.254",
            "dhcpRangeNetmask": "255.255.0.0",
            "dhcpRangeNetworkCidr": "10.99.0.1/16",
            "dhcpRangeStartIp": "10.99.0.1",
            "lastOpDate": "Dec 1, 2020 11:03:45 AM",
            "name": "provision-net",
            "state": "Enabled",
            "uuid": "ed0549b43dd442dfaf03102cfb12ac44",
            "zoneUuid": "9ebbda92b5264a38b3d992a45fa14818"
        }
    ],
    "success": true
}

BareMetal2Gateway inventory

Name Description Optional Valid Value Starting Version
username The username of the gateway. 4.0.0
password The password of the gateway. 4.0.0
sshPort The SSH port of the gateway. Yes 4.0.0
name The name of the gateway. 4.0.0
description The detailed description of the gateway. Yes 4.0.0
managementIp The IP address of the management node. 4.0.0
clusterUuid The cluster UUID. 4.0.0
resourceUuid The UUID of the gateway. Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.0.0
timeout Yes
Sample
{
    "inventories": [
        {
            "attachedClusterUuids": [
                "c12275b4a10e48f8ae922eccd8c0a879"
            ],
            "availableCpuCapacity": 160,
            "availableMemoryCapacity": 66960363520,
            "clusterUuid": "c12275b4a10e48f8ae922eccd8c0a879",
            "cpuNum": 16,
            "cpuSockets": 1,
            "createDate": "Dec 31, 2020 10:45:28 AM",
            "description": "172.25.15.81",
            "hypervisorType": "baremetal2",
            "lastOpDate": "Jan 8, 2021 11:24:06 AM",
            "managementIp": "172.25.15.81",
            "name": "172.25.15.81",
            "sshPort": 22,
            "state": "Enabled",
            "status": "Connected",
            "totalCpuCapacity": 160,
            "totalMemoryCapacity": 66960363520,
            "username": "root",
            "uuid": "cd2ac02c1aa948ecbc1f0388f3db0a83",
            "zoneUuid": "8cb18c3afe5242d68dba74d5b65590cb"
        }
    ],
    "success": true
}

XskyBlockVolume

Name Description Optional Valid Value Starting Version
xskyStatus 4.7.11
xskyBlockVolumeId 4.7.11
attachedJudgers 4.7.11
lastDetachDate 4.7.11
lastVmInstanceUuid 4.7.11
vmInstanceUuid The VM instance UUID. 4.7.11
diskOfferingUuid The disk offering UUID. 4.7.11
rootImageUuid 4.7.11
installPath 4.7.11
type 4.7.11
format 4.7.11
actualSize 4.7.11
deviceId 4.7.11
state 4.7.11
status 4.7.11
isShareable 4.7.11
volumeQos 4.7.11
iscsiPath 4.7.11
vendor 4.7.11
uuid The UUID. For more information, see Resource Property. 4.7.11
name The UUID. For more information, see Resource Property. 4.7.11
description The UUID. For more information, see Resource Property. 4.7.11
size Size 4.7.11
primaryStorageUuid The primary storage UUID. 4.7.11
accessPathId The access path id. 4.7.11
accessPathIqn The access path iqn. 4.7.11
burstTotalBw The burst total bandwidth. 4.7.11
burstTotalIops The burst total IOPS. 4.7.11
maxTotalBw The maxmium total bandwidth. 4.7.11
maxTotalIops The maxmium total IOPS. 4.7.11
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.7.11
userTag The user tags. For more information, see CreateUserTag. 4.7.11
systemTag The system tags. For more information, see CreateSystemTag. 4.7.11
userTags The user tags. For more information, see CreateUserTag. 4.7.11
systemTags The system tags. For more information, see CreateSystemTag. 4.7.11
tagUuid The tag UUID. 4.7.11
createDate The creation date. For more information, see Resource Property. 4.7.11
lastOpDate The last operation date. For more information, see Resource Property. 4.7.11
CLI Command Manual | 4.8.38 | ZStack Cloud · ZCF | ZStack Resource Center