Overview


Inventory

VCenter Inventory

Name Description Optional Valid Value Starting Version
tagUuid The tag Uuid. 3.9.0
createDate The creation time. 3.9.0
description The detailed description of the resource. 3.9.0
domainName The domain name. 3.9.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. 3.9.0
https Whether to enable HTTPS login. 3.9.0
lastOpDate The last operation time. 3.9.0
name The name. 3.9.0
port The port. 3.9.0
state The state. 3.9.0
status The status. 3.9.0
systemTags The system tags. 3.9.0
userName The user name. 3.9.0
userTags The user tags. 3.9.0
uuid The resource UUID. 3.9.0
version The version. 3.9.0
zoneUuid The zone UUID. 3.9.0

Example

{     "inventories": [         {             "createDate": "Nov 21, 2024 6:24:18 PM",             "description": "",             "domainName": "172.25.100.65",             "https": true,             "lastOpDate": "Feb 18, 2025 9:28:46 AM",             "name": "VC-8.1",             "port": 443,             "state": "Enabled",             "status": "Connected",             "userName": "administrator@vsphere.local",             "uuid": "f7e5d1a308814c4da76e1be644917e7b",             "version": "8.0.2",             "zoneUuid": "2187f079256a4ee7b75fa30f81847ff3"         }     ],     "success": true }

VCenterCluster Inventory

Name Description Optional Valid Value Starting Version
tagUuid The tag Uuid. 3.9.0
architecture The architecture. 3.9.0
createDate The creation time. 3.9.0
dataCenterUuid The data center UUID. 3.9.0
description The detailed description of the resource. 3.9.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. 3.9.0
hypervisorType The hypervisor type. 3.9.0
lastOpDate The last operation time. 3.9.0
morval The morval. 3.9.0
name The name. 3.9.0
state The state. 3.9.0
systemTags The system tags. 3.9.0
type The cluster type. 3.9.0
userTags The user tags. 3.9.0
uuid The resource UUID. 3.9.0
vCenterUuid The vCenter UUID. 3.9.0
zoneUuid The zone UUID. 3.9.0
Example
{     "inventories": [         {             "createDate": "Nov 21, 2024 6:24:21 PM",             "dataCenterUuid": "137c93d03aa244469db3c56867b30416",             "description": "from VCenter f7e5d1a308814c4da76e1be644917e7b",             "hypervisorType": "ESX",             "lastOpDate": "Nov 21, 2024 6:24:21 PM",             "morval": "domain-c14",             "name": "Cluster-1",             "state": "Enabled",             "type": "vmware",             "uuid": "ba968534e0424b078da9945e00effec7",             "vCenterUuid": "f7e5d1a308814c4da76e1be644917e7b",             "zoneUuid": "2187f079256a4ee7b75fa30f81847ff3"         }     ],     "success": true }

VCenterDatacenter Inventory

Name Description Optional Valid Value Starting Versionn
tagUuid The tag Uuid. 3.9.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. 3.9.0
morval The morval. 3.9.0
name The name. 3.9.0
systemTags The system tags. 3.9.0
userTags The user tags. 3.9.0
uuid The resource UUID. 3.9.0
vCenterUuid The vCenter UUID. 3.9.0

Example

        {             "attachedClusterUuids": [],             "availableCapacity": 119990648832,             "availablePhysicalCapacity": 118475456512,             "createDate": "Feb 18, 2025 9:28:44 AM",             "datastore": "datastore-64",             "lastOpDate": "Feb 18, 2025 9:28:46 AM",             "mountPath": "VCenter",             "name": "SSD-120G",             "state": "Enabled",             "status": "Connected",             "totalCapacity": 119990648832,             "totalPhysicalCapacity": 119990648832,             "type": "VCenter",             "url": "ds:///vmfs/volumes/6729cceb-c36f6dca-fdf6-ac1f6bedba22/",             "uuid": "50b35920b4864e52b63fa3af78e055cc",             "vCenterUuid": "f7e5d1a308814c4da76e1be644917e7b",             "zoneUuid": "2187f079256a4ee7b75fa30f81847ff3"         }

VCenterPrimaryStorage Inventory

Name Description Optional Valid Value Starting Versionn
tagUuid The tag Uuid. 3.9.0
attachedClusterUuids The UUID of the cluster that the primary storage is attached to. 3.9.0
availableCapacity The available capacity. 3.9.0
availablePhysicalCapacity The available physical capacity. 3.9.0
createDate The creation time. 3.9.0
datastore 3.9.0
description The detailed description of the resource. 3.9.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. 3.9.0
lastOpDate The last operation time. 3.9.0
mountPath The mount path. 3.9.0
name The name. 3.9.0
state The state. 3.9.0
status The status. 3.9.0
systemTags The system tags. 3.9.0
systemUsedCapacity The system-used capacity. 3.9.0
totalCapacity The total capacity. 3.9.0
totalPhysicalCapacity The total physical capacity. 3.9.0
type The type. 3.9.0
url The url. 3.9.0
userTags The user tags. 3.9.0
uuid The resource UUID. 3.9.0
vCenterUuid The vCenter UUID. 3.9.0
zoneUuid The zone UUID. 3.9.0

Example

        {             "attachedClusterUuids": [],             "availableCapacity": 119990648832,             "availablePhysicalCapacity": 118475456512,             "createDate": "Feb 18, 2025 9:28:44 AM",             "datastore": "datastore-64",             "lastOpDate": "Feb 18, 2025 9:28:46 AM",             "mountPath": "VCenter",             "name": "SSD-120G",             "state": "Enabled",             "status": "Connected",             "totalCapacity": 119990648832,             "totalPhysicalCapacity": 119990648832,             "type": "VCenter",             "url": "ds:///vmfs/volumes/6729cceb-c36f6dca-fdf6-ac1f6bedba22/",             "uuid": "50b35920b4864e52b63fa3af78e055cc",             "vCenterUuid": "f7e5d1a308814c4da76e1be644917e7b",             "zoneUuid": "2187f079256a4ee7b75fa30f81847ff3"         }

VCenterBackupStorage Inventory

Name Description Optional Valid Value Starting Version
tagUuid The tag Uuid. 3.9.0
attachedZoneUuids The UUID of the zone that the image storage is attached to. 3.9.0
availableCapacity The available capacity. 3.9.0
createDate The creation time. 3.9.0
datastore 3.9.0
description The detailed description of the resource. 3.9.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. 3.9.0
lastOpDate The last operation time. 3.9.0
name The name. 3.9.0
state The state. 3.9.0
status The status. 3.9.0
systemTags The system tags. 3.9.0
totalCapacity The total capacity. 3.9.0
type The type. 3.9.0
url The url. 3.9.0
userTags The user tags. 3.9.0
uuid The resource UUID. 3.9.0
vCenterUuid The vCenter UUID. 3.9.0

Example

 {             "attachedZoneUuids": [                 "2187f079256a4ee7b75fa30f81847ff3"             ],             "availableCapacity": 110357381120,             "createDate": "Nov 21, 2024 6:24:20 PM",             "datastore": "datastore-24",             "lastOpDate": "Feb 18, 2025 9:28:46 AM",             "name": "datastore1 (2)",             "state": "Enabled",             "status": "Connected",             "totalCapacity": 112474456064,             "type": "VCenter",             "url": "ds:///vmfs/volumes/670c89de-fd7d700e-ed94-ac1f6be46604/",             "uuid": "14ae850f45504fa18d61d74761f5ed66",             "vCenterUuid": "f7e5d1a308814c4da76e1be644917e7b"         }

VCenterResourcePool Inventory

Name Description Optional Valid Value Starting Version
tagUuid The tag Uuid. 3.9.0
CPULevel 3.9.0
CPULimit 3.9.0
CPUOverheadLimit 3.9.0
CPUReservation 3.9.0
CPUShares 3.9.0
createDate The creation time 3.9.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. 3.9.0
lastOpDate The last operation time. 3.9.0
memoryLevel 3.9.0
memoryLimit 3.9.0
memoryOverheadLimit 3.9.0
memoryReservation 3.9.0
memoryShares 3.9.0
morval The morval. 3.9.0
name The name. 3.9.0
parentUuid 3.9.0
subResources 3.9.0
systemTags The system tags. 3.9.0
userTags The user tags. 3.9.0
uuid The resource UUID. 3.9.0
vCenterClusterUuid 3.9.0










Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Cannot be empty.
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.

同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

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)

同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

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)

同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

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.