ResourcePoolSummary

ResourcePoolSummary
ResourcePoolSummary

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
}
string
name
Required

Name of resource pool.

config
Required

This data object type is a specification for a set of resources allocated to a virtual machine or a resource pool.

runtime
Required

Current runtime resource usage and state of the resource pool

quickStats
Optional

A set of statistics that are typically updated with near real-time regularity.

These statistics are aggregates of the corresponding statistics of all virtual machines in the given resource pool, and unless otherwise noted, only make sense when at least one virtual machine in the given resource pool is powered on. This data object type does not support notification, for scalability reasons. Therefore, changes in QuickStats do not generate property collector updates. To monitor statistics values, use the statistics and alarms modules instead.

integer As int32 As int32
configuredMemoryMB
Optional

Total configured memory of all virtual machines in the resource pool, in MB.