VirtualAppSummary

VirtualAppSummary
VirtualAppSummary

This data object type encapsulates a typical set of resource pool information that is useful for list views and summary pages.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "name": "string",
    "config": {
        "_typeName": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "changeVersion": "string",
        "lastModified": "string",
        "cpuAllocation": {
            "_typeName": "string",
            "reservation": 0,
            "expandableReservation": false,
            "limit": 0,
            "shares": {
                "_typeName": "string",
                "shares": 0,
                "level": "string"
            },
            "overheadLimit": 0
        },
        "memoryAllocation": {
            "_typeName": "string",
            "reservation": 0,
            "expandableReservation": false,
            "limit": 0,
            "shares": {
                "_typeName": "string",
                "shares": 0,
                "level": "string"
            },
            "overheadLimit": 0
        },
        "scaleDescendantsShares": "string"
    },
    "runtime": {
        "_typeName": "string",
        "memory": {
            "_typeName": "string",
            "reservationUsed": 0,
            "reservationUsedForVm": 0,
            "unreservedForPool": 0,
            "unreservedForVm": 0,
            "overallUsage": 0,
            "maxUsage": 0
        },
        "cpu": {
            "_typeName": "string",
            "reservationUsed": 0,
            "reservationUsedForVm": 0,
            "unreservedForPool": 0,
            "unreservedForVm": 0,
            "overallUsage": 0,
            "maxUsage": 0
        },
        "overallStatus": "string",
        "sharesScalable": "string"
    },
    "quickStats": {
        "_typeName": "string",
        "overallCpuUsage": 0,
        "overallCpuDemand": 0,
        "guestMemoryUsage": 0,
        "hostMemoryUsage": 0,
        "distributedCpuEntitlement": 0,
        "distributedMemoryEntitlement": 0,
        "staticCpuEntitlement": 0,
        "staticMemoryEntitlement": 0,
        "privateMemory": 0,
        "sharedMemory": 0,
        "swappedMemory": 0,
        "balloonedMemory": 0,
        "overheadMemory": 0,
        "consumedOverheadMemory": 0,
        "compressedMemory": 0
    },
    "configuredMemoryMB": 0,
    "product": {
        "_typeName": "string",
        "key": 0,
        "classId": "string",
        "instanceId": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "fullVersion": "string",
        "vendorUrl": "string",
        "productUrl": "string",
        "appUrl": "string"
    },
    "vAppState": "string",
    "suspended": false,
    "installBootRequired": false,
    "instanceUuid": "string"
}
product
Optional

Product information.

References to properties in the URLs are expanded.

vAppState
Optional

Whether the vApp is running

boolean
suspended
Optional

Whether a vApp is suspended, in the process of being suspended, or in the process of being resumed.

A stopped vApp is marked as suspended under the following conditions:

  • All child virtual machines are either suspended or powered-off.
  • There is at least one suspended virtual machine for which the stop action is not "suspend".

If the vAppState property is "stopped", the value is set to true if the vApp is suspended (according the the above definition).

If the vAppState property is "stopping" or "starting" and the suspend flag is set to true, then the vApp is either in the process of being suspended or resumed from a suspended state, respectively.

If the vAppState property is "started", then the suspend flag is set to false.

boolean
installBootRequired
Optional

Whether one or more VMs in this vApp require a reboot to finish installation.

string
instanceUuid
Optional

vCenter-specific UUID of the vApp