This API has a deprecated equivalent from v7.0U1.
Get Hardware
DescriptionReturns the virtual hardware settings of a virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware
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, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareInfo of type application/json
Virtual hardware settings of the virtual machine.
{
"upgrade_policy": "enum",
"upgrade_status": "enum",
"upgrade_version": "enum",
"version": "enum"
}
upgrade_policy
Required
Scheduled upgrade policy.
Possible values are: NEVER , AFTER_CLEAN_SHUTDOWN , ALWAYS
upgrade_status
Required
Scheduled upgrade status.
Possible values are: NONE , PENDING , SUCCESS , FAILED
version
Required
Virtual hardware version.
Possible values are: VMX_03 , VMX_04 , VMX_06 , VMX_07 , VMX_08 , more...
object
upgrade_error
Optional
Reason for the scheduled upgrade failure. This field is optional and it is only relevant when the value of Hardware.Info.upgrade-status is FAILED.
upgrade_version
Optional
Target hardware version to be used on the next scheduled virtual hardware upgrade. This field is optional and it is only relevant when the value of Hardware.Info.upgrade-policy is one of AFTER_CLEAN_SHUTDOWN or ALWAYS.
Possible values are: VMX_03 , VMX_04 , VMX_06 , VMX_07 , VMX_08 , more...
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware
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.
Availability
Added in 7.0U2
