Hypervfailover

Last updated 10 months ago

Was this helpful?

Create

Create a new HyperV Failover Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.

POST/api/Provider/hypervfailover

Query parameters

Body

Provider settings

namenullable string

The name of the Provider.

servernullable string

A Provider server FQDN or IP addresses.

siteIdinteger (int32)

The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.

vdiAgentnullable string

FQDN or IP address of the server where the RAS VDI Agent is running.

providerUsername*nullable string

A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.

providerPassword*nullable string

The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.

portnullable integer (int32)

The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.

preferredBrokerIdnullable integer (int32)

The preferred Connection Broker ID.

useAllGuestsnullable boolean

Use all guests.

hyperVFailoverVersion*enum

HyperV Failover Cluster Version

0 = HyperVFailoverCluster,1 = Ent,2 = Dtc,3 = Win2012,4 = Win2012R2,5 = Win2016,6 = Win2019,7 = Win2022,1048576 = HyperVFailoverCluster_Depr,1048577 = Ent_Depr,1048578 = Dtc_Depr,1048579 = Win2012_Depr,1048580 = Win2012R2_Depr,1048581 = Win2016_Depr,1048582 = Win2019_Depr,1048583 = Win2022_Depr

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

inheritDefaultAgentSettingsboolean

Whether the default Agent settings are inherited or not.

vdiAgentnullable string

FQDN or IP address of the server where the RAS VDI Agent is running.

preferredBrokerIdinteger (int32)

ID of the preferred Connection Broker.

servernullable string

Server name.

namenullable string

Name of the Provider.

typeenum

Provider Major Type

9 = HyperV,10 = VMwareESXi,15 = VMwarevCenter,16 = HyperVFailover,18 = Nutanix,20 = ScaleComputing,21 = Azure,22 = AVD,23 = RemotePCStatic,24 = RemotePCDynamic,25 = AWSEC2

providerUsernamenullable string

A user account to log in to the hypervisor management tool (e.g. VMware vCenter).

hostPortinteger (int32)

Specifies the port number for the Provider.

vdiPortinteger (int32)

The port to communicate with the dedicated provider.

directAddressnullable string

Specifies the Provider server direct address.

sessionTimeoutinteger (int32)

Specifies the 'Disconnect Timeout'. 0 - No timeout.

sessionLogoffTimeoutinteger (int32)

Specifies the 'Reset Timeout'. 0 - No timeout.

allowURLAndMailRedirectionenum

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsboolean

Whether the 'Support Shell URL Namespace Objects' option is enabled or disabled.

allowDragAndDropboolean

Whether drag and drop is allowed or not.

allowRemoteExecboolean

Whether remote execution is allowed or not.

enableAppMonitoringboolean

Whether application monitoring is enabled or not.

useRemoteAppsboolean

Whether remote applications are used or not.

allowFileTransferboolean

Whether the 'Allow file transfer' option is enabled or disabled (deprecated).

fileTransferModeenum

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

fileTransferLocationnullable string

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean

Lock Location where the File Transfer takes place, if and where it is allowed.

enablePrintingboolean

Whether printing is enabled or not.

enableTWAINboolean

Whether TWAIN (Universal Scanning) is enabled or not.

enableWIAboolean

Whether WIA (Universal Scanning) is enabled or not.

useDefaultPrinterSettingsboolean

Whether the default printer settings are used or not.

removeClientNameFromPrinterNameboolean

Specifies if 'Remove client name from printer name' option is enabled or disabled.

removeSessionNumberFromPrinterNameboolean

Specifies if 'Remove session number from printer name' option is enabled or disabled.

printerNameFormatenum

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

enableDriveRedirectionCacheboolean

Whether the Drive Redirection Cache is enabled or not.

manageRDPTransportProtocolenum

Manage RDP transport protocol.

0 = Disabled,1 = BothUDPTCP,2 = OnlyTCP,3 = EitherUDPTCP

useAllGuestsboolean

Specifies whether all Guests are used or not.

useDedicatedVDIAgentboolean

Whether a dedicated VDI Agent server is used or not.

adminCredentialsnullable array of object

Admin credentials.

versionenum

HyperV Failover Cluster Version

macManagementInfoobject

MAC Address Management

enableMacManagementboolean

Enable MAC Management.

Request

const response = await fetch('/api/Provider/hypervfailover', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "providerUsername": "text",
      "providerPassword": "text",
      "hyperVFailoverVersion": [
        "0 = HyperVFailoverCluster",
        "1 = Ent",
        "2 = Dtc",
        "3 = Win2012",
        "4 = Win2012R2",
        "5 = Win2016",
        "6 = Win2019",
        "7 = Win2022",
        "1048576 = HyperVFailoverCluster_Depr",
        "1048577 = Ent_Depr",
        "1048578 = Dtc_Depr",
        "1048579 = Win2012_Depr",
        "1048580 = Win2012R2_Depr",
        "1048581 = Win2016_Depr",
        "1048582 = Win2019_Depr",
        "1048583 = Win2022_Depr"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T04:11:13.950Z",
  "timeLastMod": "2025-02-05T04:11:13.950Z",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "inheritDefaultAgentSettings": true,
  "vdiAgent": "text",
  "preferredBrokerId": 1,
  "server": "text",
  "name": "text",
  "type": [
    "9 = HyperV",
    "10 = VMwareESXi",
    "15 = VMwarevCenter",
    "16 = HyperVFailover",
    "18 = Nutanix",
    "20 = ScaleComputing",
    "21 = Azure",
    "22 = AVD",
    "23 = RemotePCStatic",
    "24 = RemotePCDynamic",
    "25 = AWSEC2"
  ],
  "providerUsername": "text",
  "hostPort": 1,
  "vdiPort": 1,
  "directAddress": "text",
  "sessionTimeout": 1,
  "sessionLogoffTimeout": 1,
  "allowURLAndMailRedirection": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = EnabledWithAppRegistration"
  ],
  "supportShellURLNamespaceObjects": true,
  "allowDragAndDrop": true,
  "allowRemoteExec": true,
  "enableAppMonitoring": true,
  "useRemoteApps": true,
  "allowFileTransfer": true,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferLocation": "text",
  "fileTransferLockLocation": true,
  "enablePrinting": true,
  "enableTWAIN": true,
  "enableWIA": true,
  "useDefaultPrinterSettings": true,
  "removeClientNameFromPrinterName": true,
  "removeSessionNumberFromPrinterName": true,
  "printerNameFormat": [
    "0 = PrnFormat_PRN_CMP_SES",
    "1 = PrnFormat_SES_CMP_PRN",
    "2 = PrnFormat_PRN_REDSES"
  ],
  "enableDriveRedirectionCache": true,
  "manageRDPTransportProtocol": [
    "0 = Disabled",
    "1 = BothUDPTCP",
    "2 = OnlyTCP",
    "3 = EitherUDPTCP"
  ],
  "useAllGuests": true,
  "useDedicatedVDIAgent": true,
  "adminCredentials": [
    {
      "enabled": true,
      "priority": 1,
      "username": "text"
    }
  ],
  "version": [
    "0 = HyperVFailoverCluster",
    "1 = Ent",
    "2 = Dtc",
    "3 = Win2012",
    "4 = Win2012R2",
    "5 = Win2016",
    "6 = Win2019",
    "7 = Win2022",
    "1048576 = HyperVFailoverCluster_Depr",
    "1048577 = Ent_Depr",
    "1048578 = Dtc_Depr",
    "1048579 = Win2012_Depr",
    "1048580 = Win2012R2_Depr",
    "1048581 = Win2016_Depr",
    "1048582 = Win2019_Depr",
    "1048583 = Win2022_Depr"
  ],
  "macManagementInfo": {
    "startMacAddress": "text",
    "endMacAddress": "text"
  },
  "enableMacManagement": true
}