Hypervfailover

Create

post

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.

Query parameters

noInstallbooleanOptional

Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.

usernamestringOptional

An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.

passwordstringOptional

The password of the account specified in the Username parameter.

noRestartbooleanOptional

Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.

noFireWallRulesbooleanOptional

Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.

Body

Create provider of type HyperVFailover

namestring | nullableOptional

The name of the Provider.

serverstring | nullableOptional

A Provider server FQDN or IP addresses.

siteIdinteger · int32Optional

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

vdiAgentstring | nullableOptional

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

providerUsernamestring | nullableRequired

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.

providerPasswordstring | nullableRequired

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.

portinteger · int32 | nullableOptional

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

preferredBrokerIdinteger · int32 | nullableOptional

The preferred Connection Broker ID.

useAllGuestsboolean | nullableOptional

Use all guests.

hyperVFailoverVersionstring · enumRequired

HyperV Failover Cluster Version

Possible values:

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

HTTPcURLJavaScriptPython

POST /api/Provider/hypervfailover HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 517

{
  "name": "text",
  "server": "text",
  "siteId": 1,
  "vdiAgent": "text",
  "providerUsername": "text",
  "providerPassword": "text",
  "port": 1,
  "preferredBrokerId": 1,
  "useAllGuests": true,
  "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"
  ]
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-23T11:17:28.121Z",
  "timeLastMod": "2025-05-23T11:17:28.121Z",
  "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
}