ZStack Cloud Documentation
All
All
ZStack 3.10.0>Product Manuals>CLI Command Manual>BareMetal Management (Plus)>Inventory
Get PDF

Inventory

BareMetal Chassis Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 2.6.0
name The name. For more information, see Resource Property. 2.6.0
description The description. For more information, see Resource Property. Yes 2.6.0
zoneUuid The zone UUID. 2.6.0
clusterUuid The cluster UUID. 2.6.0
ipmiAddress The IPMI address. 2.6.0
ipmiPort The IPMI port. 2.6.0
ipmiUsername The IPMI username. 2.6.0
state 2.6.0
status 2.6.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 2.6.0
createDate The creation date. For more information, see Resource Property. 2.6.0
lastOpDate The last operation date. For more information, see Resource Property. 2.6.0
userTags The user tags. For more information, see CreateUserTag Yes 2.6.0
systemTags The system tags. For more information, see CreateSystemTag Yes 2.6.0
Sample
{     "inventories": [         {             "clusterUuid": "1e9584cd6dd64c1a96fba1bb1114948e",             "createDate": "Jul 23, 2018 1:34:21 AM",             "hardwareInfos": [                 {                     "chassisUuid": "42bd9ac18f984dd683ad22a36a5b756c",                     "content": "[{"name":"sda", "size":"278.9G"}]",                     "createDate": "Jul 23, 2018 1:48:32 AM",                     "lastOpDate": "Jul 23, 2018 1:48:32 AM",                     "type": "disk",                     "uuid": "b039556f2a23447ab584aafceaa3d070"                 }     ],             "ipmiAddress": "10.0.0.4",             "ipmiPort": "623",             "ipmiUsername": "root",             "lastOpDate": "Jul 23, 2018 10:24:55 AM",             "name": "chassis-1",             "state": "Enabled",             "status": "Allocated",             "uuid": "42bd9ac18f984dd683ad22a36a5b756c",             "zoneUuid": "c0f9490c8fa6492eba4b403f2d27958e"         }     ],     "success": true }

BareMetal Instance Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 2.6.0
name The name. For more information, see Resource Property. 2.6.0
description The description. For more information, see Resource Property. Yes 2.6.0
zoneUuid The zone UUID. 2.6.0
clusterUuid The cluster UUID. 2.6.0
chassisUuid The BareMetal chassis UUID. 2.6.0
imageUuid The image UUID. 2.6.0
platform The operating system platform. 2.6.0
state 2.6.0
status 2.6.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 2.6.0
createDate The creation date. For more information, see Resource Property. 2.6.0
lastOpDate The last operation date. For more information, see Resource Property. 2.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 2.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.6.0
Sample
{     "inventories": [         {             "bmNics": [                 {                     "baremetalInstanceUuid": "8b819bd452b54f91ba087ec7a9afc140",                     "createDate": "Jul 23, 2018 10:24:56 AM",                     "gateway": "10.0.0.99",                     "ip": "10.147.214.60",                     "lastOpDate": "Jul 23, 2018 10:24:56 AM",                     "mac": "d4:ae:52:6e:d1:0c",                     "netmask": "255.0.0.0",                     "pxe": true,                     "uuid": "dae5d0fa380c413d8c657a3a967d5811"                 }             ],             "chassisUuid": "42bd9ac18f984dd683ad22a36a5b756c",             "clusterUuid": "1e9584cd6dd64c1a96fba1bb1114948e",             "createDate": "Jul 23, 2018 10:24:55 AM",             "imageUuid": "2910e37e4f9754518817e3fd52f61112",             "lastOpDate": "Jul 25, 2018 2:54:44 PM",             "managementIp": "10.147.214.60",             "name": "bm-1",             "platform": "Linux",             "port": "22",             "state": "Running",             "status": "Provisioned",             "username": "root",             "uuid": "8b819bd452b54f91ba087ec7a9afc140",             "zoneUuid": "c0f9490c8fa6492eba4b403f2d27958e"         }     ],     "success": true }

PXE Server Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.1.0
name The name. For more information, see Resource Property. 3.1.0
description The description. For more information, see Resource Property. Yes 3.1.0
zoneUuid The zone UUID. 3.1.0
hostname The IP address of the deployment server. 3.1.0
sshUsername The SSH username of the deployment server. 3.1.0
sshPassword The SSH password of the deployment server. 3.1.0
sshPort The SSH port of the deployment server. 3.1.0
storagePath The storage path of the deployment server. 3.1.0
dhcpInterface The DHCP listen interface that can enable the DHCP feature. 3.1.0
dhcpRangeBegin The start IP address in the IP range allocated by DHCP. 3.1.0
dhcpRangeEnd The end IP address in the IP range allocated by DHCP. 3.1.0
dhcpRangeNetmask The DHCP netmask. 3.1.0
state The state of the deployment server. 3.1.0
status The status of the deployment server. 3.1.0
totalCapacity The total capacity of the storage path. 3.1.0
availableCapacity The available capacity of the storage path. 3.1.0
attachedClusterUuids The UUIDs of clusters to which the deployment server is attached. 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": [         {             "attachedClusterUuids": [                 "cf2410b964b24fc598c85ced0d186fbc"             ],             "availableCapacity": 231389765632,             "createDate": "Nov 17, 2018 11:32:42 AM",             "dhcpInterface": "br_em2",             "dhcpInterfaceAddress": "10.0.0.23",             "dhcpRangeBegin": "10.0.0.1",             "dhcpRangeEnd": "10.0.0.254",             "dhcpRangeNetmask": "255.255.255.0",             "hostname": "192.168.200.26",             "lastOpDate": "Nov 17, 2018 1:45:46 PM",             "name": "PXE-26",             "sshPassword": "password",             "sshPort": 22,             "sshUsername": "root",             "state": "Enabled",             "status": "Connected",             "storagePath": "/pxe_store",             "totalCapacity": 289760350208,             "uuid": "b56bc3496ca14410b8903b6b7c6a2c23",             "zoneUuid": "5034aa76f41f428d968b828c2518c29e"         }     ],     "success": true }

BareMetal Bonding Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.4.0
chassisUuid The BareMetal chassis UUID. 3.4.0
mode The NIC bonding mode. 3.4.0
name The name. For more information, see Resource Property. 3.4.0
opts The NIC bonding option. 3.4.0
slaves The Slaves MAC address where the NIC bonds to. 3.4.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.4.0
createDate The creation date. For more information, see Resource Property. 3.4.0
lastOpDate The last operation date. For more information, see Resource Property. 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0

Preconfiguration Template Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.4.0
content 3.4.0
description The description. For more information, see Resource Property. Yes 3.4.0
name The name. For more information, see Resource Property. 3.4.0
distribution The distribution version of the operating system. 3.4.0
isPredefined 3.4.0
md5sum The MD5 checksum value of the image. 3.4.0
state The state. 3.4.0
type 3.4.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.4.0
createDate The creation date. For more information, see Resource Property. 3.4.0
lastOpDate The last operation date. For more information, see Resource Property. 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0

Products

Solutions

Help & Support

Contact Us

© 2023, Shanghai Yunzhou Information and Technology Ltd (云轴科技). All Rights Reserved.

Back to Top

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.