This API has a deprecated equivalent from v7.0U1.
Update Hardware CPU
Updates the CPU-related settings of a virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/cpu
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
VmHardwareCpuUpdateSpec of mimetype application/json
Required
Specification for updating the CPU-related settings of the virtual machine.
{
"cores_per_socket": 0,
"count": 0,
"hot_add_enabled": false,
"hot_remove_enabled": false
}
integer
cores_per_socket
Optional
New number of CPU cores per socket. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket. If unset, the value is unchanged.
integer
count
Optional
New number of CPU cores. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket. The supported range of CPU counts is constrained by the configured guest operating system and virtual hardware version of the virtual machine.
If the virtual machine is running, the number of CPU cores may only be increased if Cpu.Info.hot-add-enabled is true, and may only be decreased if Cpu.Info.hot-remove-enabled is true.
If unset, the value is unchanged.
boolean
hot_add_enabled
Optional
Flag indicating whether adding CPUs while the virtual machine is running is enabled. This field may only be modified if the virtual machine is powered off.
If unset, the value is unchanged.
boolean
hot_remove_enabled
Optional
Flag indicating whether removing CPUs while the virtual machine is running is enabled. This field may only be modified if the virtual machine is powered off.
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 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.
Code Samples
PowerCLI Client SDK Example
$VmHardwareCpuUpdateSpec = Initialize-VmHardwareCpuUpdateSpec -Count 0 -CoresPerSocket 0 -HotAddEnabled $false -HotRemoveEnabled $false
Invoke-UpdateVmHardwareCpu -Vm "MyVm" -VmHardwareCpuUpdateSpec $VmHardwareCpuUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cores_per_socket":0,"count":0,"hot_add_enabled":false,"hot_remove_enabled":false}' https://{api_host}/api/vcenter/vm/{vm}/hardware/cpu
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/cpu
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Hardware CPU Operations
get
patch
