vcenter vm hardware: get
Request:
HTTP request
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
vm | string | Virtual machine identifier. |
Response:
HTTP Status Code: 200
Representation:
"value": {
"upgrade_error": {},
"upgrade_policy": "NEVER",
"upgrade_status": "NONE",
"upgrade_version": "VMX_03",
"version": "VMX_03"
}
}
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | info | Virtual hardware settings of the virtual machine. |
value.version | string | Virtual hardware version. Defines the valid virtual hardware versions for a virtual machine. Value is one of: |
value.upgrade_policy | string | Scheduled upgrade policy. Defines the valid virtual hardware upgrade policies for a virtual machine. Value is one of: |
value.upgrade_version | string | Target hardware version to be used on the next scheduled virtual hardware upgrade. Defines the valid virtual hardware versions for a virtual machine. Value is one of: |
value.upgrade_status | string | Scheduled upgrade status. Defines the valid virtual hardware upgrade statuses for a virtual machine. Value is one of: |
value.upgrade_error | exception | Reason for the scheduled upgrade failure. Optional. It is only relevant when upgrade_status has value FAILED. This field is optional and it is only relevant when the value of |
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. |
400 | 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. |