This API can be used for manual validation purposes when a user wishes to choose a Hyper-V host for restoring the selected volumes on specific host.
Alternately, one can use the Host Capabilities Validation API.
The volumes selected for restore belong to a specified OS firmware type. The selected host must be compatible with the original backed up host.
The role of this API is to allow a user to find out if the selected revisions and host are compatible, before actually performing the restore operation.
Note: the selected volume's hardware configuration can be obtained via the "Obtaining a revision's hardware configuration" call.
This section includes the following topics:
- Input Parameters
- Output Parameters
Input Parameters
The following table provides the parameters and descriptions.
Parameter | Description |
id | Integer. Numeric host id, id of the host, either obtained when it was registered the first time, or via the Get registered hosts API call. |
sessionId | String. Containing a GUID, obtained via a call to API Hyper-V Create Host Browsing Session. |
Example
{
"id": 2,
"sessionId": "5d05495f-39e5-4e4e-ad0c-e351cc2c78f3"
}
Output Parameters
The following table provides the parameters and descriptions.
Parameter | Description | ||||||||||||||
supportsVmGenerations | Boolean.
| ||||||||||||||
supportsVmDynamicMemory | Boolean. Denotes whether dynamic memory allocation is supported. Parameter is not currently used. | ||||||||||||||
supportsVhdxFormat | Boolean. Use this result during the restore to restrict usage of VHD format in case the host doesn't support VHDX. Also, use in conjunction with supportsVmGenerations. |
Error Codes
ErrorCode.HostNotInCatalog - if the provided id integer from Input section does not point to a valid Hyper-V server (the correct ids can be obtained via get list of hosts).
Example POST
POST /v2/accounts/test_acc/computers/0000/restore/hyperv/host/capabilities
Input Parameters
{
"id": 1,
"sessionId": "string"
}
Output parameters
Response status: 200 Accepted (for online operation)
Response body:
{
"data": {
"supportsVmGenerations":true,
"supportsVmDynamicMemory":true,
"supportsVhdxFormat":true
}
}
Output Parameters
Response status: 200 Accepted (for online operation).
Example Response
{
"data": {
"supportsVmGenerations":true,
"supportsVmDynamicMemory":true,
"supportsVhdxFormat":true
}
}