Update Hardware Memory
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Updates the memory-related settings of a virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/memory
Parameters
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, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmHardwareMemoryUpdateRequestBody of type application/json (required){
"spec": {
"hot_add_enabled": false,
"size_MiB": 0
}
}
spec
Required
Specification for updating the memory-related settings of the virtual machine.
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"hot_add_enabled":false,"size_MiB":0}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/memory
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.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
404
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed.
409
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. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
On This Page
Hardware Memory Operations
patch
