Update Hardware CPU
Updates the CPU-related settings of a virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/cpu
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, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmHardwareCpuUpdateRequestBody of type application/json (required){
"spec": {
"cores_per_socket": 0,
"count": 0,
"hot_add_enabled": false,
"hot_remove_enabled": false
}
}
spec
Required
Specification for updating the CPU-related settings of the virtual machine.
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"cores_per_socket":0,"count":0,"hot_add_enabled":false,"hot_remove_enabled":false}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/cpu
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 Cpu.UpdateSpec.count. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if Cpu.UpdateSpec.hot-add-enabled or Cpu.UpdateSpec.hot-remove-enabled is specified and the virtual machine is not powered off.
if Cpu.UpdateSpec.count is specified and is greater than Cpu.Info.count, Cpu.Info.hot-add-enabled is false, and the virtual machine is not powered off.
if Cpu.UpdateSpec.count is specified and is less than Cpu.Info.count, Cpu.Info.hot-remove-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.
On This Page
Hardware CPU Operations
patch
get
