This API has a deprecated equivalent from v7.0U1.
Get Hardware Memory
Returns the memory-related settings of a virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/memory
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareMemoryInfo
of type application/json
Memory-related settings of the virtual machine.
{
"hot_add_enabled": false,
"hot_add_increment_size_MiB": 0,
"hot_add_limit_MiB": 0,
"size_MiB": 0
}
boolean
hot_add_enabled
Required
Flag indicating whether adding memory while the virtual machine is running is enabled. Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.
integer
size_MiB
Required
Memory size in mebibytes.
integer
hot_add_increment_size_MiB
Optional
The granularity, in mebibytes, at which memory can be added to a running virtual machine. When adding memory to a running virtual machine, the amount of memory added must be at least Memory.Info.hot-add-increment-size-mib and the total memory size of the virtual machine must be a multiple of {@link>hotAddIncrementSize}.
Only set when Memory.Info.hot-add-enabled is true and the virtual machine is running.
integer
hot_add_limit_MiB
Optional
The maximum amount of memory, in mebibytes, that can be added to a running virtual machine. Only set when Memory.Info.hot-add-enabled is true and the virtual machine is running.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmHardwareMemory -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/memory
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/memory
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Hardware Memory Operations
patch
