This means that the agent is installed on a different computer and we are connecting to a remote Hyper-V host.
This section includes the following topics:
- Input Parameters
- Output Parameters
Input Parameters
sessionId - string, containing a GUID, obtained via a call to API Hyper-V Create Host Browsing Session
Example
{
"sessionId": "{81CF349D-999D-45C0-B6EA-22E6607479AD}"
}
Output Parameters
The following table provides the parameters and descriptions.
Parameter | Description |
identifier id | Integer. Store this value, as it is needed by the final restore as virtual machine API call. |
hostName | String. Store this value in case you want to use it as the virtual machine name part of the restore as VM API call. |
hostUnsupported | Boolean. When false, means the host is not supported, and the reason can be found via the hostUnsupportedReason parameter. When true, hostUnsupportedReason is value 0. |
hostUnsupportedReason | Integer. Showing the reason why the host is unsupported. Value is 0 when hostUnsupported = false. The following values are possible: 0 = None - this means all is ok. 1 = VhdUefiNotSupported, , this value cannot be obtained in case of Disk image standard restore. However, it is applicable for Disk Image QuickSpin rapid recovery restores, for recovery media stored in VHD format. When this value is returned, and Uefi volumes are being restored in the restore API call, a warning message can be displayed: "Cannot restore an UEFI boot volume stored in VHD format." 2 = Gen1UefiNotSupported, when this value is returned, and Efi boot volumes are being restored in the restore API, a warning message can be displayed: "Cannot restore an EFI boot volume to Hyper-V 2008, 2008 R2, or 2012." 3 = BackupMediaFormatNotSupported, this value cannot be obtained in case of Disk image standard restore. However, it is applicable for Disk Image QuickSpin rapid recovery restores, for recovery media stored in VHDX format. Explanation: "Cannot restore to host. One or more volumes are stored in VHDX format and cannot be restored to Hyper-V 2008/R2. Backups are stored in VHDX format if the storage location was 4K native or if the source volumes are over 2TB in size or were on a system running Windows 8 or later." 4 = VirtualizationScopeNotFound, if this value is returned, the following error needs to be displayed "The restore destination host needs to be Windows Server 2008 R2 or above." |
Example POST
POST /v2/accounts/test_acc/computers/0000/restore/hyperv/host/add/local
Input Parameters
{
"sessionId": "e0b73795-9c48-429f-8a29-ec43831ca157"
}
Output Parameters
Response status: 200 Accepted (for online operation).
Example Response
{
"data": {
"identifier": {
"id": 2
},
"hostName": "win-3buj2mbr3re",
"serverState": 0,
"serverStateReason": 0,
"hostUnsupportedReason": 0,
"hostUnsupported": false
}
}
}