Developer Documentation
Update Hardware CPU
Updates the CPU-related settings of a virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/cpu
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. |
Request Body
Request Body
Contains
UpdateRequestBody
of type application/json
(required)
{
"spec": {
"cores_per_socket": 0,
"count": 0,
"hot_add_enabled": false,
"hot_remove_enabled": false
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | CpuUpdateSpec |
Specification for updating the CPU-related settings of the virtual machine. |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | Error | 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. |
| 401 | Error | 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 | Error | 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 | Error | 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. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
On This Page
Hardware CPU Operations
get
patch
