This API has a deprecated equivalent from v7.0U1.
Update Hardware Memory
Updates 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"
Request Body
Request Body
VmHardwareMemoryUpdateSpec of mimetype application/json
Required
Specification for updating the memory-related settings of the virtual machine.
{
"hot_add_enabled": false,
"size_MiB": 0
}
boolean
hot_add_enabled
Optional
Flag indicating whether adding memory while the virtual machine is running should be 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.
This field may only be modified if the virtual machine is not powered on.
If unset, the value is unchanged.
integer
size_MiB
Optional
New memory size in mebibytes. The supported range of memory sizes is constrained by the configured guest operating system and virtual hardware version of the virtual machine.
If the virtual machine is running, this value may only be changed if Memory.Info.hot-add-enabled is true, and the new memory size must satisfy the constraints specified by Memory.Info.hot-add-increment-size-mib and Memory.Info.hot-add-limit-mib.
If unset, the value is unchanged.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if one of the provided settings is not permitted; for example, specifying a negative value for Memory.UpdateSpec.size-mib. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if Memory.UpdateSpec.hot-add-enabled is specified and the virtual machine is not powered off. if Memory.UpdateSpec.size-mib is specified, Memory.Info.hot-add-enabled is false, and the virtual machine is not powered off.
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_busy : if the virtual machine is busy performing another operation. | 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
$VmHardwareMemoryUpdateSpec = Initialize-VmHardwareMemoryUpdateSpec -SizeMiB 0 -HotAddEnabled $false
Invoke-UpdateVmHardwareMemory -Vm "MyVm" -VmHardwareMemoryUpdateSpec $VmHardwareMemoryUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"hot_add_enabled":false,"size_MiB":0}' 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: patch
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/memory
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Hardware Memory Operations
patch
