For the complete documentation index, see llms.txt. This page is also available as Markdown.

New-RASProvider

SYNOPSIS

Adds a Provider server to a site.

SYNTAX

New-RASProvider -AVD <SwitchParameter> -AVDVersion {AVD} -Name <string>
 -ProviderPassword <SecureString> -ProviderUsername <string> -SubscriptionID <string>
 -TenantID <string> [-AuthenticationURL <string>] [-ManagementURL <string>]
 [-NoFireWallRules <SwitchParameter>] [-NoInstall <SwitchParameter>] [-NoRestart <SwitchParameter>]
 [-Password <SecureString>] [-Port <uint>] [-PreferredConnectionBrokerId <uint>]
 [-PreferredConnectionBrokerObj <ConnectionBroker>] [-ResourceURI <string>] [-SiteId <uint>]
 [-UseAllGuests <bool>] [-Username <string>] [<CommonParameters>]
New-RASProvider -AccessKeyID <string> -AWSEC2 <SwitchParameter> -AWSEC2Version {AWSEC2}
 -Name <string> -SecretAccessKey <SecureString> [-NoFireWallRules <SwitchParameter>]
 [-NoRestart <SwitchParameter>] [-Password <SecureString>] [-PreferredConnectionBrokerId <uint>]
 [-PreferredConnectionBrokerObj <ConnectionBroker>] [-SiteId <uint>] [-UseAllGuests <bool>]
 [-Username <string>] [<CommonParameters>]
New-RASProvider -Azure <SwitchParameter> -AzureVersion {Azure} -Name <string>
 -ProviderPassword <SecureString> -ProviderUsername <string> -SubscriptionID <string>
 -TenantID <string> [-AuthenticationURL <string>] [-ManagementURL <string>]
 [-NoFireWallRules <SwitchParameter>] [-NoInstall <SwitchParameter>] [-NoRestart <SwitchParameter>]
 [-Password <SecureString>] [-PreferredConnectionBrokerId <uint>]
 [-PreferredConnectionBrokerObj <ConnectionBroker>] [-ResourceURI <string>] [-SiteId <uint>]
 [-UseAllGuests <bool>] [-Username <string>] [-VDIAgent <string>] [<CommonParameters>]

DESCRIPTION

Adds a Provider server to a site.

The RAS VDI Agent will be installed on the server by default when passing the username and password. You can optionally skip the agent installation by including the -NoInstall parameter without passing the username and password.

EXAMPLES

Example 1

Adds VCenter server as a Provider to the Licensing Server site (default).

The RAS VDI Agent will be installed on the server using your RAS admin credentials (default).

You may want to skip the agent installation if a proper version of it is already installed on the server.

Example 2

Adds VCenter server as a Provider server to the specified site.

The -Username and -Password parameters specify credentials which will be used to push install the RAS VDI Agent on the server.

You may want to skip the agent installation if a proper version of it is already installed on the server.

Example 3

Adds Scale server as a Provider server to the specified site.

The -Username and -Password parameters specify credentials which will be used to push install the RAS VDI Agent on the server.

You may want to skip the agent installation if a proper version of it is already installed on the server.

Example 4

Adds Azure to the Licensing Server site (default).

Resources of the subscription "4986048b-a420-43d3-8cab-344ff6580b3f" in the tenant "58dabf97-3bf6-4f8c-bd95-8c883bf37d3d" will be managed by RAS.

Access rights to the resources will be limited by permissions given to the Azure application "16731946-e0aa-4816-8cd9-12763670d257".

You may want to skip the agent installation if a proper version of it is already installed on the server.

PARAMETERS

-Name

The name of the Provider.

-Server

A Provider server FQDN or IP addresses.

-SiteId

The site ID to which to add the specified server.

If the parameter is omitted, the Licensing Server site ID will be used.

-NoInstall

Specifies not to install the RAS 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.

-NoRestart

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.

-NoFireWallRules

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.

-Username

An administrator account for push installing the RAS VDI Agent on the server.

If this parameter is omitted, your RAS admin username (and password) will be used.

If this parameter is specified, the password parameter will also be required to be specified.

-Password

The password of the account specified in the Username parameter.

If this parameter is specified, the username parameter will also be required to be specified.

-VDIAgent

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

-ProviderUsername

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

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.

-Port

The port to communicate with the Provider specified in Server parameter.

In case of Azure, it is not required.

-PreferredConnectionBrokerObj

The preferred Connection Broker server.

To obtain an object of type Broker representing the preferred Connection Broker, use the Get-RASConnectionBroker cmdlet.

Type reference: ConnectionBroker

-PreferredConnectionBrokerId

The preferred Connection Broker ID.

-UseAllGuests

Use all guests.

-SubscriptionID

Azure Subscription ID.

-TenantID

Azure Tenant ID.

-AuthenticationURL

Azure Authentication URL.

-ManagementURL

Azure Management URL.

-ResourceURI

Azure Resource URI.

-Azure

Azure SwitchParameter

-AzureVersion

Specifies the Azure Version.

Possible values: Azure

Type reference: AzureVersion

-AVD

AVD SwitchParameter

-AVDVersion

Specifies the AVD Version.

Possible values: AVD

Type reference: AVDVersion

-AWSEC2

AWSEC2 SwitchParameter

-AWSEC2Version

Specifies the AWSEC2 Version.

Possible values: AWSEC2

Type reference: AWSEC2Version

-AccessKeyID

The access key ID of the Amazon Web Service account.

-SecretAccessKey

The secret access key of the Amazon Web Service account.

-CustomProvider

Custom Provider SwitchParameter

-CustomProviderVersion

Specifies the Custom Provider Version.

Possible values: CustomProvider

Type reference: CustomProviderVersion

-Arguments

Specifies the arguments to launch the script.

-Command

Specifies the command to launch the script.

-Workdir

Specifies the script working directory.

-HyperV

Hyper V SwitchParameter

-HyperVVersion

Specifies the HyperV Version.

Possible values: HyperV, Win2012R2Std, Win2012R2Dtc, Win2012R2Srv, Win2016Std, Win2016Dtc, Win2016Srv, Win2019Std, Win2019Dtc, Win2019Srv, Win2022Std, Win2022Dtc, Win2022DtcAzure, Win2025Std, Win2025Dtc, Win2025DtcAzure

Type reference: HyperVVersion

-HyperVFailover

MS Cluster SwitchParameter

-HyperVFailoverVersion

Specifies the HyperVFailover Version.

Possible values: HyperVFailoverCluster, Ent, Dtc, Win2012, Win2012R2, Win2016, Win2019, Win2022, Win2025

Type reference: HyperVFailoverClusterVersion

-Nutanix

Nutanix SwitchParameter

-NutanixVersion

Specifies the Nutanix Version.

Possible values: Nutanix, v5_15, v5_20, v6_5, v6_10, v7_3

Type reference: NutanixVersion

-NutanixPC

Nutanix Prism Central SwitchParameter

-NutanixPCVersion

Specifies the Nutanix Prism Central Version.

Possible values: NutanixPC, v7_3, v7_5

Type reference: NutanixPCVersion

-RemotePCDynamic

Remote PC Dynamic SwitchParameter

-RemotePCDynamicVersion

Specifies the Remote PC Dynamic Version.

Possible values: RemotePCDynamic

Type reference: RemotePCDynamicVersion

-RemotePCStatic

Remote PC Static SwitchParameter

-RemotePCStaticVersion

Specifies the Remote PC Static Version.

Possible values: RemotePCStatic

Type reference: RemotePCStaticVersion

-Scale

Scale SwitchParameter

-ScaleVersion

Specifies the Scale Version.

Possible values: Scale, v9_4, v9_6

Type reference: ScaleVersion

-VCenter

VCenter SwitchParameter

-VCenterVersion

Specifies the VCenter Version.

Possible values: VmwareVCenter, v6_5, v6_7, v7_0, v8_0, v9_0, v9_1

Type reference: VmwareVCenterVersion

-VMwareESXi

VMware ESXi SwitchParameter

-VmwareESXiVersion

Specifies the VMware ESXi Version.

Possible values: VmwareESXi, v6_5, v6_7, v7_0, v8_0, v9_0, v9_1

Type reference: VmwareESXiVersion

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

AVDProvider AWSEC2Provider AzureProvider CustomProvider HyperVClusterProvider HyperVProvider NutanixPCProvider NutanixProvider RemotePCDynamicProvider RemotePCStaticProvider ScaleComputingProvider VCenterProvider VMwareESXiProvider

Last updated