Get Hardware CPU
Returns 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareCpuInfo of type application/json
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
Required
Number of CPU cores per socket.
integer
count
Required
Number of CPU cores.
boolean
hot_add_enabled
Required
Flag indicating whether adding CPUs while the virtual machine is running is enabled.
boolean
hot_remove_enabled
Required
Flag indicating whether removing CPUs while the virtual machine is running is enabled.
Errors
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_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
Invoke-GetVmHardwareCpu -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" 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-operation: get
On This Page
Hardware CPU Operations
get
patch
