Host System Query Memory Overhead

Host System Query Memory Overhead

Deprecated as of VI API 2.5, use QueryMemoryOverheadEx.

Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics.

Required privileges: System.Read

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/QueryMemoryOverhead
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 HostSystem/{moId}.

string
release
Required

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

Request Body
QueryMemoryOverheadRequestType of type(s) application/json
Required 
{
    "memorySize": 0,
    "videoRamSize": 0,
    "numVcpus": 0
}
integer As int64 As int64
memorySize
Required

The amount of virtual system RAM, in bytes. For an existing virtual machine, this value can be found (in megabytes) as the memoryMB property of the VirtualHardware.

integer As int32 As int32
videoRamSize
Optional

The amount of virtual video RAM, in bytes. For an existing virtual machine on a host that supports advertising this property, this value can be found (in kilobytes) as the videoRamSizeInKB property of the VirtualMachineVideoCard. If this parameter is left unset, the default video RAM size for virtual machines on this host is assumed.

integer As int32 As int32
numVcpus
Required

The number of virtual CPUs. For an existing virtual machine, this value can be found as the numCPU property of the VirtualHardware.

Authentication
This operation uses the following authentication methods.
Responses
200

The amount of overhead memory required to power on such a virtual machine, in bytes.

Returns integer of type(s) application/json
Operation doesn't return any data structure

On This Page
Host System Operations
POST
Host System Acquire Cim Services Ticket
POST
Host System Configure Crypto Key
POST
Host System Destroy Task
POST
Host System Disconnect Host Task
POST
Host System Enable Crypto
POST
Host System Enter Lockdown Mode
POST
Host System Enter Maintenance Mode Task
POST
Host System Exit Lockdown Mode
POST
Host System Exit Maintenance Mode Task
GET
Host System Get Alarm Actions Enabled
GET
Host System Get Answer File Validation Result
GET
Host System Get Answer File Validation State
GET
Host System Get Available Field
GET
Host System Get Capability
GET
Host System Get Compliance Check Result
GET
Host System Get Compliance Check State
GET
Host System Get Config
GET
Host System Get Config Issue
GET
Host System Get Config Manager
GET
Host System Get Config Status
GET
Host System Get Custom Value
GET
Host System Get Datastore
GET
Host System Get Datastore Browser
GET
Host System Get Declared Alarm State
GET
Host System Get Disabled Method
GET
Host System Get Effective Role
GET
Host System Get Hardware
GET
Host System Get Licensable Resource
GET
Host System Get Name
GET
Host System Get Network
GET
Host System Get Overall Status
GET
Host System Get Parent
GET
Host System Get Permission
GET
Host System Get Precheck Remediation Result
GET
Host System Get Recent Task
GET
Host System Get Remediation Result
GET
Host System Get Remediation State
GET
Host System Get Runtime
GET
Host System Get Summary
GET
Host System Get System Resources
GET
Host System Get Tag
GET
Host System Get Triggered Alarm State
GET
Host System Get Value
GET
Host System Get Vm
POST
Host System Power Down Host To Stand By Task
POST
Host System Power Up Host From Stand By Task
POST
Host System Prepare Crypto
POST
Host System Query Host Connection Info
POST
Host System Query Memory Overhead
POST
Host System Query Memory Overhead Ex
POST
Host System Query Product Locker Location
POST
Host System Query Tpm Attestation Report
POST
Host System Reboot Host Task
POST
Host System Reconfigure Host For DAS Task
POST
Host System Reconnect Host Task
POST
Host System Reload
POST
Host System Rename Task
POST
Host System Retrieve Free Epc Memory
POST
Host System Retrieve Hardware Uptime
POST
Host System Set Custom Value
POST
Host System Shutdown Host Task
POST
Host System Update Flags
POST
Host System Update Ipmi
POST
Host System Update Product Locker Location Task
POST
Host System Update System Resources
POST
Host System Update System Swap Configuration