New-RASProvider

NAME

New-RASProvider

SYNOPSIS

Adds a Provider server to a site.

SYNTAX

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

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

New-RASProvider [[-Server] <string>] [[-SiteId] <uint>] -AccessKeyID <string> -AWSEC2 <SwitchParameter> -AWSEC2Version {AWSEC2 | AWSEC2_Depr} -SecretAccessKey <SecureString> [-Name <string>] [-NoFireWallRules <SwitchParameter>] [-NoInstall <SwitchParameter>] [-NoRestart <SwitchParameter>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-UseAllGuests <bool>] [-VDIAgent <string>] [<CommonParameters>]

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

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

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

New-RASProvider [[-Server] <string>] [[-SiteId] <uint>] -HyperV <SwitchParameter> -HyperVVersion {HyperV | Win2012R2Std | Win2012R2Dtc | Win2012R2Srv | Win2016Std | Win2016Dtc | Win2016Srv | Win2019Std | Win2019Dtc | Win2019Srv | Win2022Std | Win2022Dtc | Win2022DtcAzure | 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> [-Name <string>] [-NoFireWallRules <SwitchParameter>] [-NoInstall <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-UseAllGuests <bool>] [-VDIAgent <string>] [<CommonParameters>]

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

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

New-RASProvider [[-Server] <string>] [[-SiteId] <uint>] -HyperV <SwitchParameter> -HyperVVersion {HyperV | Win2012R2Std | Win2012R2Dtc | Win2012R2Srv | Win2016Std | Win2016Dtc | Win2016Srv | Win2019Std | Win2019Dtc | Win2019Srv | Win2022Std | Win2022Dtc | Win2022DtcAzure | 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} -Password <SecureString> -ProviderPassword <SecureString> -ProviderUsername <string> -Username <string> [-Name <string>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-UseAllGuests <bool>] [-VDIAgent <string>] [<CommonParameters>]

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

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

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

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

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

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

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

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

New-RASProvider [[-Server] <string>] [[-SiteId] <uint>] -ProviderPassword <SecureString> -ProviderUsername <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} [-Name <string>] [-NoFireWallRules <SwitchParameter>] [-NoInstall <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-UseAllGuests <bool>] [-VDIAgent <string>] [<CommonParameters>]

New-RASProvider [[-Server] <string>] [[-SiteId] <uint>] -Password <SecureString> -ProviderPassword <SecureString> -ProviderUsername <string> -Username <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} [-Name <string>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-UseAllGuests <bool>] [-VDIAgent <string>] [<CommonParameters>]

New-RASProvider [[-Server] <string>] [[-SiteId] <uint>] -ProviderPassword <SecureString> -ProviderUsername <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} [-Name <string>] [-NoFireWallRules <SwitchParameter>] [-NoInstall <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-UseAllGuests <bool>] [-VDIAgent <string>] [<CommonParameters>]

New-RASProvider [[-Server] <string>] [[-SiteId] <uint>] -Password <SecureString> -ProviderPassword <SecureString> -ProviderUsername <string> -Username <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} [-Name <string>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-UseAllGuests <bool>] [-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.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Server <string> A Provider server FQDN or IP addresses.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Password <SecureString> The password of the account specified in the Username parameter.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VDIAgent <string> FQDN or IP address of the server where the RAS VDI Agent is running.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Port <uint> The port to communicate with the Provider specified in Server parameter.

In case of Azure, it is not required.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PreferredBrokerObj <Broker> The preferred Connection Broker server.

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PreferredBrokerId <uint> The preferred Connection Broker ID.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UseAllGuests <bool> Use all guests.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SubscriptionID <string> Azure Subscription ID.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TenantID <string> Azure Tenant ID.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AuthenticationURL <string> Azure Authentication URL.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ManagementURL <string> Azure Management URL.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ResourceURI <string> Azure Resource URI.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Azure <SwitchParameter> Azure SwitchParameter

        Required?                    true

        Position?                    named

        Default value                False