Overhead Memory Manager Lookup Vm Overhead Memory

Return static VM overhead memory value in bytes for a (vm, host) pair from the overhead memory module (OMM) in Virtual Center.

Required privileges: Global.VCServer

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/OverheadMemoryManager/{moId}/LookupVmOverheadMemory

COPY

Path Parameters

string

moId

Required

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

string

release

Required

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

Request Body

LookupVmOverheadMemoryRequestType of type(s) application/json

Required

Show optional properties

{
    "vm": {},
    "host": {}
}

{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

MoRefVirtualMachine

Required

Reference to an instance of the VirtualMachine managed object.

MoRefHostSystem

host

Required

Reference to an instance of the HostSystem managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Overhead memory value, if found in the OMM.

Returns integer of type(s) application/json

Operation doesn't return any data structure

500

NotFound: If the overhead memory value is not found in the OMM.

InvalidType: If the MoRefs do not point to appropriate type of inventory objects - VM and Host respectively.

InvalidArgument: If any of the MoRefs are NULL.

ManagedObjectNotFound: If the inventory objects cannot be found.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters