Registering a Remote Hyper-V Host

Parameter

Description

sessionId

String. Containing a GUID, obtained via a call to API Hyper-V Create Host Browsing Session.

hostName

Name of the remote computer where Hyper-V is running. The agent will attempt to connect to this host.

authenticationMode

String. Allowed values are Sspi or Credentials.

credentials

Allows entering a username and password when authenticationMode = Credentials.

identifier

id

Integer. Store this value as 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."