REST API - get
  1. Operations
  2. vcenter
  3. vm
  4. hardware
  5. cpu

vcenter vm hardware cpu: get

Returns the CPU-related settings of a virtual machine.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/hardware/cpu

Path Parameters

Name Type Description
Required
vm string Virtual machine identifier.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "hot_remove_enabled" : true,
        "count" : 1,
        "hot_add_enabled" : true,
        "cores_per_socket" : 1
    }
}

Response Type:

Name Type Description
bold = required
value info CPU-related settings of the virtual machine.
value.count long Number of CPU cores.
value.cores_per_socket long Number of CPU cores per socket.
value.hot_add_enabled boolean Flag indicating whether adding CPUs while the virtual machine is running is enabled.
value.hot_remove_enabled boolean Flag indicating whether removing CPUs while the virtual machine is running is enabled.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if the virtual machine is not found.
500 resource_inaccessible if the virtual machine's configuration state cannot be accessed.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.