Set-RASProvider
NAME
Set-RASProvider
SYNOPSIS
Modifies Provider server settings.
SYNTAX
Set-RASProvider [-Id] <uint> [-AccessKeyID <string>] [-ADType {WindowsServerADDS | AzureADDS}] [-AllowDragAndDrop <bool>] [-AllowFileTransfer <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredBroker <SwitchParameter>] [-CostOptimizeTimeout <uint>] [-Description <string>] [-DirectAddress <string>] [-DomainTargetOU <string>] [-EnableCostOptimize <bool>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-EnableMacManagement <bool>] [-EndMacAddress <string>] [-EndpointUrl <string>] [-FeedURL <string>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-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}] [-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}] [-LocationType {Default | OptedIn | EndpointUrl}] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-NewName <string>] [-NewServer <string>] [-NutanixVersion {Nutanix | v5_15 | v5_20 | v6_5 | Nutanix_Depr | v5_15_Depr | v5_20_Depr | v6_5_Depr}] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-ProviderPassword <SecureString>] [-ProviderUsername <string>] [-RegionCode <string>] [-RegionName <string>] [-RemotePCDynamicSubnet <string>] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-ResourcePool <string>] [-ScaleVersion {Scale | v8_9 | v9_1 | v9_2 | Scale_Depr | v8_9_Depr | v9_1_Depr}] [-SecretAccessKey <SecureString>] [-StartMacAddress <string>] [-SupportShellURLNamespaceObjects <bool>] [-UseAllGuests <bool>] [-VCenterVersion {VmwareVCenter | v6_5 | v6_7 | v7_0 | v8_0 | VmwareVCenter_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr}] [-VDIAgent <string>] [-VDIPort <uint>] [-VmwareESXiVersion {VmwareESXi | v6_5 | v6_7 | v7_0 | v8_0 | VmwareESXi_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr}] [-WebAccessURL <string>] [<CommonParameters>]
Set-RASProvider [-InputObject] <Provider> [-AccessKeyID <string>] [-ADType {WindowsServerADDS | AzureADDS}] [-AllowDragAndDrop <bool>] [-AllowFileTransfer <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredBroker <SwitchParameter>] [-CostOptimizeTimeout <uint>] [-Description <string>] [-DirectAddress <string>] [-DomainTargetOU <string>] [-EnableCostOptimize <bool>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-EnableMacManagement <bool>] [-EndMacAddress <string>] [-EndpointUrl <string>] [-FeedURL <string>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-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}] [-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}] [-LocationType {Default | OptedIn | EndpointUrl}] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-NewName <string>] [-NewServer <string>] [-NutanixVersion {Nutanix | v5_15 | v5_20 | v6_5 | Nutanix_Depr | v5_15_Depr | v5_20_Depr | v6_5_Depr}] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-ProviderPassword <SecureString>] [-ProviderUsername <string>] [-RegionCode <string>] [-RegionName <string>] [-RemotePCDynamicSubnet <string>] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-ResourcePool <string>] [-ScaleVersion {Scale | v8_9 | v9_1 | v9_2 | Scale_Depr | v8_9_Depr | v9_1_Depr}] [-SecretAccessKey <SecureString>] [-StartMacAddress <string>] [-SupportShellURLNamespaceObjects <bool>] [-UseAllGuests <bool>] [-VCenterVersion {VmwareVCenter | v6_5 | v6_7 | v7_0 | v8_0 | VmwareVCenter_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr}] [-VDIAgent <string>] [-VDIPort <uint>] [-VmwareESXiVersion {VmwareESXi | v6_5 | v6_7 | v7_0 | v8_0 | VmwareESXi_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr}] [-WebAccessURL <string>] [<CommonParameters>]
Set-RASProvider [-Name] <string> [[-SiteId] <uint>] [-AccessKeyID <string>] [-ADType {WindowsServerADDS | AzureADDS}] [-AllowDragAndDrop <bool>] [-AllowFileTransfer <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredBroker <SwitchParameter>] [-CostOptimizeTimeout <uint>] [-Description <string>] [-DirectAddress <string>] [-DomainTargetOU <string>] [-EnableCostOptimize <bool>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-EnableMacManagement <bool>] [-EndMacAddress <string>] [-EndpointUrl <string>] [-FeedURL <string>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-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}] [-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}] [-LocationType {Default | OptedIn | EndpointUrl}] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-NewName <string>] [-NewServer <string>] [-NutanixVersion {Nutanix | v5_15 | v5_20 | v6_5 | Nutanix_Depr | v5_15_Depr | v5_20_Depr | v6_5_Depr}] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-ProviderPassword <SecureString>] [-ProviderUsername <string>] [-RegionCode <string>] [-RegionName <string>] [-RemotePCDynamicSubnet <string>] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-ResourcePool <string>] [-ScaleVersion {Scale | v8_9 | v9_1 | v9_2 | Scale_Depr | v8_9_Depr | v9_1_Depr}] [-SecretAccessKey <SecureString>] [-StartMacAddress <string>] [-SupportShellURLNamespaceObjects <bool>] [-UseAllGuests <bool>] [-VCenterVersion {VmwareVCenter | v6_5 | v6_7 | v7_0 | v8_0 | VmwareVCenter_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr}] [-VDIAgent <string>] [-VDIPort <uint>] [-VmwareESXiVersion {VmwareESXi | v6_5 | v6_7 | v7_0 | v8_0 | VmwareESXi_Depr | v6_5_Depr | v6_7_Depr | v7_0_Depr | v8_0_Depr}] [-WebAccessURL <string>] [<CommonParameters>]
DESCRIPTION
Modifies settings of a Provider server.
For each setting, the cmdlet includes a corresponding input parameter. To modify a setting, specify a parameter and its value.
PARAMETERS
-Name <string> The name of the Provider.
-SiteId <uint> Site ID in which to modify the specified Provider server.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-Id <uint> The ID of the Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.
-InputObject <Provider> An object representing the Provider server to modify.
To obtain the object, use the Get-RASProvider cmdlet.
-Enabled <bool> Enables or disables the specified Provider server in a site.
-NewName <string> A new name for the Provider.
-NewServer <string> The name of the target Provider server.
This must be the actual server name used in the RAS farm.
-Description <string> A user-defined Provider server description.
-DirectAddress <string> Specifies the Provider server direct address.
-Port <uint> Specifies the port number for the RAS VDI Agent.
-VDIAgent <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.
-AllowURLAndMailRedirection <AllowURLAndMailRedirection> Set the URL and Mail Redirection option. Possible values: 0 = Disabled, 1 = Enabled, 2 = Enabled with application registration.
Possible values: Disabled, Enabled, EnabledWithAppRegistration
-SupportShellURLNamespaceObjects <bool> Enable or disable the 'Support Shell URL Namespace Objects' option.
-AllowDragAndDrop <bool> Set the Drag and Drop option.
-AllowFileTransfer <bool> Deprecated: use FileTransferMode instead.
Enable or disable the 'Allow file transfer' option.
-FileTransferMode <FileTransferControlMode> File Transfer option. Possible values are: 0 (Disabled), 1 (client to Server only), 2 {Server To Client only), 3 (Bidirectional).
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
-FileTransferLocation <string> Location where the File Transfer takes place, if and where it is allowed.
-FileTransferLockLocation <bool> Lock Location where the File Transfer takes place, if and where it is allowed.
-RemoveClientNameFromPrinterName <bool> Enable or disable the 'Remove client name from printer name' option.
-RemoveSessionNumberFromPrinterName <bool> Enable or disable the 'Remove session number from printer name' option.
-PrinterNameFormat <PrnNameFormat> Specifies the 'RDP Printer Name Format' option.
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
-AutoPreferredBroker <SwitchParameter> Set the 'Preferred Connection Broker' option to 'Automatically". If number of Connection Brokers is less than 3 then preferred Conection Broker is not allowed to choose automatic.
-EnableDriveRedirectionCache <bool> Enable or disable the 'Enable Drive Redirection Cache' option.
-ManageRDPTransportProtocol <ManageRDPTransportProtocol> Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
-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.
-VDIPort <uint> The port to communicate with the dedicated VDIAgent specified in the VDIAgent parameter.
-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.
-CostOptimizeTimeout <uint> Cost Optimize Timeout in seconds. Applicable to: AVD (Experimental) and Azure.
-EnableCostOptimize <bool> Enable Cost Optimize. Applicable to: AVD (Experimental) and Azure.
-FeedURL <string> The Feed URL. Applicable to: AVD (Experimental).
-WebAccessURL <string> The Web Access URL. Applicable to: AVD (Experimental).
-ADType <ADType> The ADType. Applicable to: AVD (Experimental).
Possible values: WindowsServerADDS, AzureADDS
-AccessKeyID <string> The access key ID of the Amazon Web Service account. Applicable to: AWSEC2.
-SecretAccessKey <SecureString> The secret access key of the Amazon Web Service account. Applicable to: AWSEC2.
-LocationType <EC2LocationType> The location type of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
Possible values: Default, OptedIn, EndpointUrl
-RegionName <string> The region name of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
-RegionCode <string> The region code of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
-EndpointUrl <string> The endpoint URL of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
Example: https://ec2.us-east01.amazonaws.com.
-HyperVVersion <HyperVVersion> Specifies the HyperV Version. Applicable to: HyperV.
Possible values: 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
-HyperVFailoverVersion <HyperVFailoverClusterVersion> Specifies the HyperV Failover Version. Applicable to: HyperV Failover.
Possible values: HyperVFailoverCluster, Ent, Dtc, Win2012, Win2012R2, Win2016, Win2019, Win2022, HyperVFailoverCluster_Depr, Ent_Depr, Dtc_Depr, Win2012_Depr, Win2012R2_Depr, Win2016_Depr, Win2019_Depr, Win2022_Depr
-StartMacAddress <string> Starting MAC Address. Applicable to: HyperV Failover.
-EndMacAddress <string> Ending MAC Address. Applicable to: HyperV Failover.
-EnableMacManagement <bool> Specifies if the MAC Management is enabled or not. Applicable to: HyperV Failover.
-NutanixVersion <NutanixVersion> Specifies the Nutanix Version. Applicable to: Nutanix.
Possible values: Nutanix, v5_15, v5_20, v6_5, Nutanix_Depr, v5_15_Depr, v5_20_Depr, v6_5_Depr
-DomainTargetOU <string> Domain Target OU. Applicable to: Remote PC Dynamic.
-RemotePCDynamicSubnet <string> The subnet of the remote PC dynamic. Applicable to: Remote PC Dynamic.
-ScaleVersion <ScaleVersion> Specifies the Scale Version. Applicable to: Scale.
Possible values: Scale, v8_9, v9_1, v9_2, Scale_Depr, v8_9_Depr, v9_1_Depr
-VCenterVersion <VmwareVCenterVersion> Specifies the VCenter Version. Applicable to: VCenter.
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
-ResourcePool <string> Resource Pool. Applicable to: VCenter
-VmwareESXiVersion <VmwareESXiVersion> Specifies the VMware ESXi Version. Applicable to: VMwareESXi
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
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Set-RASProvider -Server "server.company.dom" -Enabled $False
Disables the specified Provider server in the Licensing Server site.
---------- EXAMPLE 2 ----------
Set-RASProvider -Id 3 -Enabled $False
Disables the Provider server specified by ID.
---------- EXAMPLE 3 ----------
Set-RASProvider $Provider -Enabled $True
Enables the Provider server specified by the $Provider variable, which is an object of type Provider.
The object is obtained using the Get-RASProvider cmdlet. ---------- EXAMPLE 4 ----------
Set-RASProvider $Provider -VCenter -ResourcePool "ResourcePool"
Sets the ResourcePool of the VCenter Provider server specified by the $Provider variable.
The object is obtained using the Get-RASProvider cmdlet. ---------- EXAMPLE 5 ----------
Get-RASProvider -Id 3 | Set-RASProvider -Enabled $True
Enables the Provider server represented by a Provider object obtained from the pipeline output.
RELATED LINKS
Last updated