New-RASProvider

NAME

New-RASProvider

SYNOPSIS

Adds a Provider server to a site.

SYNTAX

New-RASProvider -AVD** (SwitchParameter) -AVDVersion {AVD | AVD_Depr} -Name (string) -ProviderPassword (SecureString) -ProviderUsername (string) -SubscriptionID (string) -TenantID (string) [AuthenticationURL (string)] [ManagementURL (string)] [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [ResourceURI (string)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [(CommonParameters)]

New-RASProvider -AccessKeyID** (string) -AWSEC2 (SwitchParameter) -AWSEC2Version {AWSEC2 | AWSEC2_Depr} -Name (string) -SecretAccessKey (SecureString) [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [(CommonParameters)]

New-RASProvider -Azure** (SwitchParameter) -AzureVersion {Azure | Azure_Depr} -Name (string) -ProviderPassword (SecureString) -ProviderUsername (string) -SubscriptionID (string) -TenantID (string) [AuthenticationURL (string)] [ManagementURL (string)] [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [ResourceURI (string)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -HyperV** (SwitchParameter) -HyperVVersion {HyperV | Win2012R2Std | Win2012R2Dtc | Win2012R2Srv | Win2016Std | Win2016Dtc | Win2016Srv | Win2019Std | Win2019Dtc | Win2019Srv | Win2022Std | Win2022Dtc | Win2022DtcAzure | Win2025Std | Win2025Dtc | Win2025DtcAzure | HyperV_Depr | Win2012R2Std_Depr | Win2012R2Dtc_Depr | Win2012R2Srv_Depr | Win2016Std_Depr | Win2016Dtc_Depr | Win2016Srv_Depr | Win2019Std_Depr | Win2019Dtc_Depr | Win2019Srv_Depr | Win2022Std_Depr | Win2022Dtc_Depr | Win2022DtcAzure_Depr} -ProviderPassword (SecureString) -ProviderUsername (string) -Server (string) [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -HyperVFailover (SwitchParameter) -HyperVFailoverVersion {HyperVFailoverCluster | Ent | Dtc | Win2012 | Win2012R2 | Win2016 | Win2019 | Win2022 | Win2025 | HyperVFailoverCluster_Depr | Ent_Depr | Dtc_Depr | Win2012_Depr | Win2012R2_Depr | Win2016_Depr | Win2019_Depr | Win2022_Depr} -ProviderPassword (SecureString) -ProviderUsername (string) -Server (string) [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -Nutanix** (SwitchParameter) -NutanixVersion {Nutanix | v5_15 | v5_20 | v6_5 | v6_10 | Nutanix_Depr | v5_15_Depr | v5_20_Depr | v6_5_Depr} -ProviderPassword (SecureString) -ProviderUsername (string) -Server (string) [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -ProviderPassword (SecureString) -ProviderUsername (string) -RemotePCDynamic (SwitchParameter) -RemotePCDynamicVersion {RemotePCDynamic | RemotePCDynamic_Depr} -Server (string) [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -ProviderPassword (SecureString) -ProviderUsername (string) -RemotePCStatic (SwitchParameter) -RemotePCStaticVersion {RemotePCStatic | RemotePCStatic_Depr} -Server (string) [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -ProviderPassword (SecureString) -ProviderUsername (string) -Scale (SwitchParameter) -ScaleVersion {Scale | v8_9 | v9_1 | v9_2 | v9_4 | Scale_Depr | v8_9_Depr | v9_1_Depr} -Server (string) [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -ProviderPassword (SecureString) -ProviderUsername (string) -Server (string) -VCenter (SwitchParameter) -VCenterVersion {VmwareVCenter | v6_5 | v6_7 | v7_0 | v8_0 | VmwareVCenter_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr} [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider -ProviderPassword (SecureString) -ProviderUsername (string) -Server (string) -VMwareESXi (SwitchParameter) -VmwareESXiVersion {VmwareESXi | v6_5 | v6_7 | v7_0 | v8_0 | VmwareESXi_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr} [NoFireWallRules (SwitchParameter)] [NoInstall (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [SiteId (uint)] [UseAllGuests (bool)] [Username (string)] [VDIAgent (string)] [(CommonParameters)]

New-RASProvider [NoFireWallRules (SwitchParameter)] [NoRestart (SwitchParameter)] [Password (SecureString)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [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.

PARAMETERS

Name (string)

The name of the Provider.

Server (string)

A Provider server FQDN or IP addresses.

SiteId (uint)

The site ID to which to add the specified server.

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

NoInstall (SwitchParameter)

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 (SwitchParameter)

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 (SwitchParameter)

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 (string)

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 (SecureString)

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 (string)

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

ProviderUsername (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 (SecureString)

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 (uint)

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

In case of Azure, it is not required.

PreferredBrokerObj (Broker)

The preferred Connection Broker server.

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

PreferredBrokerId (uint)

The preferred Connection Broker ID.

UseAllGuests (bool)

Use all guests.

SubscriptionID (string)

Azure Subscription ID.

TenantID (string)

Azure Tenant ID.

AuthenticationURL (string)

Azure Authentication URL.

ManagementURL (string)

Azure Management URL.

ResourceURI (string)

Azure Resource URI.

Azure (SwitchParameter)

Azure SwitchParameter

AzureVersion (AzureVersion)

Specifies the Azure Version.

Possible values: Azure, Azure_Depr

AVD (SwitchParameter)

AVD SwitchParameter

AVDVersion (AVDVersion)

Specifies the AVD Version.

Possible values: AVD, AVD_Depr

AWSEC2 (SwitchParameter)

AWSEC2 SwitchParameter

AWSEC2Version (AWSEC2Version)

Specifies the AWSEC2 Version.

Possible values: AWSEC2, AWSEC2_Depr

AccessKeyID (string)

The access key ID of the Amazon Web Service account.

SecretAccessKey (SecureString)

The secret access key of the Amazon Web Service account.

HyperV (SwitchParameter)

Hyper V SwitchParameter

HyperVVersion (HyperVVersion)

Specifies the HyperV Version.

Possible values: HyperV, Win2012R2Std, Win2012R2Dtc, Win2012R2Srv, Win2016Std, Win2016Dtc, Win2016Srv, Win2019Std, Win2019Dtc, Win2019Srv, Win2022Std, Win2022Dtc, Win2022DtcAzure, Win2025Std, Win2025Dtc, Win2025DtcAzure, HyperV_Depr, Win2012R2Std_Depr, Win2012R2Dtc_Depr, Win2012R2Srv_Depr, Win2016Std_Depr, Win2016Dtc_Depr, Win2016Srv_Depr, Win2019Std_Depr, Win2019Dtc_Depr, Win2019Srv_Depr, Win2022Std_Depr, Win2022Dtc_Depr, Win2022DtcAzure_Depr

HyperVFailover (SwitchParameter)

MS Cluster SwitchParameter

HyperVFailoverVersion

(HyperVFailoverClusterVersion) Specifies the HyperVFailover Version.

Possible values: HyperVFailoverCluster, Ent, Dtc, Win2012, Win2012R2, Win2016, Win2019, Win2022, Win2025, HyperVFailoverCluster_Depr, Ent_Depr, Dtc_Depr, Win2012_Depr, Win2012R2_Depr, Win2016_Depr, Win2019_Depr, Win2022_Depr

Nutanix (SwitchParameter)

Nutanix SwitchParameter

NutanixVersion (NutanixVersion)

Specifies the Nutanix Version.

Possible values: Nutanix, v5_15, v5_20, v6_5, v6_10, Nutanix_Depr, v5_15_Depr, v5_20_Depr, v6_5_Depr

RemotePCDynamic (SwitchParameter)

Remote PC Dynamic SwitchParameter

RemotePCDynamicVersion

(RemotePCDynamicVersion) Specifies the Remote PC Dynamic Version.

Possible values: RemotePCDynamic, RemotePCDynamic_Depr

RemotePCStatic (SwitchParameter)

Remote PC Static SwitchParameter

RemotePCStaticVersion

(RemotePCStaticVersion) Specifies the Remote PC Static Version.

Possible values: RemotePCStatic, RemotePCStatic_Depr

Scale (SwitchParameter)

Scale SwitchParameter

ScaleVersion (ScaleVersion)

Specifies the Scale Version.

Possible values: Scale, v8_9, v9_1, v9_2, v9_4, Scale_Depr, v8_9_Depr, v9_1_Depr

VCenter (SwitchParameter)

VCenter SwitchParameter

VCenterVersion

(VmwareVCenterVersion) Specifies the VCenter Version.

Possible values: VmwareVCenter, v6_5, v6_7, v7_0, v8_0, VmwareVCenter_Depr, v6_5_Depr, v6_7_Depr, v7_0_Depr, v8_0_Depr

VMwareESXi (SwitchParameter)

VMware ESXi SwitchParameter

VmwareESXiVersion

(VmwareESXiVersion) Specifies the VMware ESXi Version.

Possible values: VmwareESXi, v6_5, v6_7, v7_0, v8_0, VmwareESXi_Depr, v6_5_Depr, v6_7_Depr, v7_0_Depr, v8_0_Depr

(CommonParameters)

INPUTS

-none-

OUTPUTS

AVDProvider

AWSEC2Provider

AzureProvider

HyperVClusterProvider

HyperVProvider

NutanixProvider

RemotePCDynamicProvider

RemotePCStaticProvider

ScaleComputingProvider

VCenterProvider

VMwareESXiProvider

EXAMPLES

---------- EXAMPLE 1 ----------

New-RASProvider "server.company.dom" -VCenter -VCenterVersion V6_5 -NoInstall

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

New-RASProvider -Server "server.company.dom" -VCenter -VCenterVersion V6_5 -SiteId 2 -Username "myname" -Password $pass

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

New-RASProvider "scalenode1.com;scalenode2.com;scalenode3.com" -Scale -ScaleVersion v9_1 -Username "myname" -Password $pass

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

New-RASProvider "Azure Cloud" -Azure -Version Azure -TenantID "58dabf97-3bf6-4f8c-bd95-8c883bf37d3d" -SubscriptionID "4986048b-a420-43d3-8cab-344ff6580b3f" -ProviderUsername "16731946-e0aa-4816-8cd9-12763670d257" -ProviderPassword $pass -NoInstall

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.

Last updated