Resource Pool Get Runtime

Resource Pool Get Runtime

Runtime information about a resource pool.

The ResourcePoolResourceUsage information within ResourcePoolRuntimeInfo can be transiently stale. Use RefreshRuntime method to update the information. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/ResourcePool/{moId}/runtime
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case ResourcePool/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ResourcePoolRuntimeInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_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"
}
memory
Required

Specifies the resource usage for either memory or CPU.

For CPU the unit is MHz, for memory the unit is bytes.

In the typical case, where a resourcepool is in a consistent state, unreservedForVm will be equal to unreservedForPool. Hence, we can simply say talk about unreserved resources.

If the reservation on the resource pool is not expandable, then the following is true:

           reservation = reservationUsed + unreserved

If the reservation on the resource pool is expandable, then the following is true:

      reservation + parent.unreserved = reservationUsed + unreserved
cpu
Required

Specifies the resource usage for either memory or CPU.

For CPU the unit is MHz, for memory the unit is bytes.

In the typical case, where a resourcepool is in a consistent state, unreservedForVm will be equal to unreservedForPool. Hence, we can simply say talk about unreserved resources.

If the reservation on the resource pool is not expandable, then the following is true:

           reservation = reservationUsed + unreserved

If the reservation on the resource pool is expandable, then the following is true:

      reservation + parent.unreserved = reservationUsed + unreserved
overallStatus
Required

The Status enumeration defines a general "health" value for a managed entity.

Possible values:

  • gray: The status is unknown.
  • green: The entity is OK.
  • yellow: The entity might have a problem.
  • red: The entity definitely has a problem.
Possible values are : gray, green, yellow, red,
string
sharesScalable
Optional

The scaling behavior of the shares of a given resource pool.

See ResourceConfigSpecScaleSharesBehaviorEnum for possible values. The system will automatically compute this property based on the ResourceConfigSpec.scaleDescendantsShares setting on every ancestor resource pool. This property does not apply to virtual machines.