Providers

List

Retrieve a list of Provider settings.

GET/api/Provider

Query parameters

Response

Success

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.

typeProviderMajorType (enum)

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.

Request

const response = await fetch('/api/Provider', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T14:17:12.156Z",
    "timeLastMod": "2024-12-21T14:17:12.156Z",
    "enabled": false,
    "description": "text",
    "siteId": 0,
    "inheritDefaultAgentSettings": false,
    "vdiAgent": "text",
    "preferredBrokerId": 0,
    "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": 0,
    "vdiPort": 0
  }
]

Create Provider

Create a new 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. Deprecated path - To create a new provider specify the type in the url ex: api/provider/hyperv

POST/api/Provider

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.

preferredBrokerIdnullable integer (int32)

The preferred Connection Broker ID.

useAllGuestsnullable boolean

Use all guests.

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.

typeProviderMajorType (enum)

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.

Request

const response = await fetch('/api/Provider', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:17:12.156Z",
  "timeLastMod": "2024-12-21T14:17:12.156Z",
  "enabled": false,
  "description": "text",
  "siteId": 0,
  "inheritDefaultAgentSettings": false,
  "vdiAgent": "text",
  "preferredBrokerId": 0,
  "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": 0,
  "vdiPort": 0
}

Get

Retrieve a specific Provider by ID.

GET/api/Provider/{id}

Path parameters

id*integer (int32)

Provider ID

Response

Success

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.

typeProviderMajorType (enum)

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.

Request

const response = await fetch('/api/Provider/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:17:12.156Z",
  "timeLastMod": "2024-12-21T14:17:12.156Z",
  "enabled": false,
  "description": "text",
  "siteId": 0,
  "inheritDefaultAgentSettings": false,
  "vdiAgent": "text",
  "preferredBrokerId": 0,
  "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": 0,
  "vdiPort": 0
}

Update Provider

Modify Provider server settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/Provider/{id}

Path parameters

id*integer (int32)

Provider ID

Body

Provider settings

enablednullable boolean

Enables or disables the specified Provider server in a site.

namenullable string

A new name for the Provider.

newServernullable string

The name of the target Provider server. This must be the actual server name used in the RAS farm.

descriptionnullable string

A user-defined Provider server description.

directAddressnullable string

Specifies the Provider server direct address.

portnullable integer (int32)

Specifies the port number for the RAS VDI Agent.

vdiAgentnullable string

FQDN or IP address of the server where the RAS VDI Agent is running. You only need to specify this parameter if the RAS VDI Agent is dedicated.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsnullable boolean

Enable or disable the 'Support Shell URL Namespace Objects' option.

allowDragAndDropnullable boolean

Set the Drag and Drop option.

fileTransferModeFileTransferControlMode (enum)

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.

fileTransferLockLocationnullable boolean

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

removeClientNameFromPrinterNamenullable boolean

Enable or disable the 'Remove client name from printer name' option.

removeSessionNumberFromPrinterNamenullable boolean

Enable or disable the 'Remove session number from printer name' option.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

autoPreferredBrokerboolean

enableDriveRedirectionCachenullable boolean

Enable or disable the 'Enable Drive Redirection Cache' option.

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

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

providerUsernamenullable 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.

providerPasswordnullable 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.

vdiPortnullable integer (int32)

The port to communicate with the dedicated VDIAgent specified in the VDIAgent parameter.

preferredBrokerIdnullable integer (int32)

The preferred Connection Broker ID.

useAllGuestsnullable boolean

Use all guests.

costOptimizeTimeoutnullable integer (int32)

Cost Optimize Timeout in seconds. Applicable to: AVD (Experimental) and Azure.

enableCostOptimizenullable boolean

Enable Cost Optimize. Applicable to: AVD (Experimental) and Azure.

feedURLnullable string

The Feed URL. Applicable to: AVD (Experimental).

webAccessURLnullable string

The Web Access URL. Applicable to: AVD (Experimental).

adTypeADType (enum)

Active Directory Domain Service Type

1 = WindowsServerADDS,2 = AzureADDS

accessKeyIDnullable string

The access key ID of the Amazon Web Service account. Applicable to: AWSEC2.

secretAccessKeynullable string

The secret access key of the Amazon Web Service account. Applicable to: AWSEC2.

locationTypeEC2LocationType (enum)

Amazon Elastic Compute Cloud Location Type

0 = Default,1 = OptedIn,2 = EndpointUrl

regionNamenullable string

The region name of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.

regionCodenullable string

The region code of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.

endpointUrlnullable string

The endpoint URL of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2. Example: https://ec2.us-east01.amazonaws.com.

hyperVVersionHyperVVersion (enum)

HyperV Version

0 = HyperV,11 = Win2012R2Std,12 = Win2012R2Dtc,13 = Win2012R2Srv,14 = Win2016Std,15 = Win2016Dtc,16 = Win2016Srv,17 = Win2019Std,18 = Win2019Dtc,19 = Win2019Srv,20 = Win2022Std,21 = Win2022Dtc,22 = Win2022DtcAzure,589824 = HyperV_Depr,589835 = Win2012R2Std_Depr,589836 = Win2012R2Dtc_Depr,589837 = Win2012R2Srv_Depr,589838 = Win2016Std_Depr,589839 = Win2016Dtc_Depr,589840 = Win2016Srv_Depr,589841 = Win2019Std_Depr,589842 = Win2019Dtc_Depr,589843 = Win2019Srv_Depr,589844 = Win2022Std_Depr,589845 = Win2022Dtc_Depr,589846 = Win2022DtcAzure_Depr

hyperVFailoverVersionHyperVFailoverClusterVersion (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

startMacAddressnullable string

Starting MAC Address. Applicable to: HyperV Failover.

endMacAddressnullable string

Ending MAC Address. Applicable to: HyperV Failover.

enableMacManagementnullable boolean

Specifies if the MAC Management is enabled or not. Applicable to: HyperV Failover.

nutanixVersionNutanixVersion (enum)

Nutanix Version

0 = Nutanix,4 = v5_15,5 = v5_20,6 = v6_5,1179648 = Nutanix_Depr,1179652 = v5_15_Depr,1179653 = v5_20_Depr,1179654 = v6_5_Depr

domainTargetOUnullable string

Domain Target OU. Applicable to: Remote PC Dynamic.

remotePCDynamicSubnetnullable string

The subnet of the remote PC dynamic. Applicable to: Remote PC Dynamic.

scaleVersionScaleVersion (enum)

Scale Version

0 = Scale,4 = v8_9,5 = v9_1,6 = v9_2,1310720 = Scale_Depr,1310724 = v8_9_Depr,1310725 = v9_1_Depr

vCenterVersionVmwareVCenterVersion (enum)

Vmware VCenter Version

0 = VmwareVCenter,7 = v6_5,8 = v6_7,9 = v7_0,10 = v8_0,983040 = VmwareVCenter_Depr,983047 = v6_5_Depr,983048 = v6_7_Depr,983049 = v7_0_Depr,983050 = v8_0_Depr

resourcePoolnullable string

Resource Pool. Applicable to: VCenter

vmwareESXiVersionVmwareESXiVersion (enum)

Vmware ESX Version

0 = VmwareESXi,11 = v6_5,12 = v6_7,13 = v7_0,14 = v8_0,655360 = VmwareESXi_Depr,655371 = v6_5_Depr,655372 = v6_7_Depr,655373 = v7_0_Depr,655374 = v8_0_Depr

Response

No Content

Request

const response = await fetch('/api/Provider/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete

Delete a Provider server from a site. The VDI agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.

DELETE/api/Provider/{id}

Path parameters

id*integer (int32)

Provider ID

Query parameters

Response

No Content

Request

const response = await fetch('/api/Provider/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

PreviousStatus NextAvd

Last updated 9 months ago

[ { "id": 0, "adminCreate": "text", "adminLastMod": "text", "timeCreate": "2024-12-21T14:17:12.156Z", "timeLastMod": "2024-12-21T14:17:12.156Z", "enabled": false, "description": "text", "siteId": 0, "inheritDefaultAgentSettings": false, "vdiAgent": "text", "preferredBrokerId": 0, "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": 0, "vdiPort": 0 } ]

{ "id": 0, "adminCreate": "text", "adminLastMod": "text", "timeCreate": "2024-12-21T14:17:12.156Z", "timeLastMod": "2024-12-21T14:17:12.156Z", "enabled": false, "description": "text", "siteId": 0, "inheritDefaultAgentSettings": false, "vdiAgent": "text", "preferredBrokerId": 0, "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": 0, "vdiPort": 0 }

const response = await fetch('/api/Provider', { method: 'POST', headers: { "Content-Type": "application/json; api-version=1.0" }, body: JSON.stringify({}), }); const data = await response.json();

const response = await fetch('/api/Provider/{id}', { method: 'PUT', headers: { "Content-Type": "application/json; api-version=1.0" }, body: JSON.stringify({}), }); const data = await response.json();