-
Name <string>
The name of the Provider.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-
Id <uint>
The ID of the Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-
InputObject <Provider>
An object representing the Provider server to modify.
To obtain the object, use the Get-RASProvider cmdlet.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-
Enabled <bool>
Enables or disables the specified Provider server in a site.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
NewName <string>
A new name for the Provider.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
NewServer <string>
The name of the target Provider server.
This must be the actual server name used in the RAS farm.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
Description <string>
A user-defined Provider server description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
DirectAddress <string>
Specifies the Provider server direct address.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
Port <uint>
Specifies the port number for the RAS VDI Agent.
Required? false
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.
You only need to specify this parameter if the RAS VDI Agent is dedicated.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
SupportShellURLNamespaceObjects <bool>
Enable or disable the 'Support Shell URL Namespace Objects' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AllowDragAndDrop <bool>
Set the Drag and Drop option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AllowFileTransfer <bool>
Deprecated: use FileTransferMode instead.
Enable or disable the 'Allow file transfer' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
FileTransferLocation <string>
Location where the File Transfer takes place, if and where it is allowed.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
FileTransferLockLocation <bool>
Lock Location where the File Transfer takes place, if and where it is allowed.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveClientNameFromPrinterName <bool>
Enable or disable the 'Remove client name from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveSessionNumberFromPrinterName <bool>
Enable or disable the 'Remove session number from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
PrinterNameFormat <PrnNameFormat>
Specifies the 'RDP Printer Name Format' option.
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-
EnableDriveRedirectionCache <bool>
Enable or disable the 'Enable Drive Redirection Cache' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ManageRDPTransportProtocol <ManageRDPTransportProtocol>
Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
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? false
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? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
VDIPort <uint>
The port to communicate with the dedicated VDIAgent specified in the VDIAgent parameter.
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
-
CostOptimizeTimeout <uint>
Cost Optimize Timeout in seconds. Applicable to: AVD (Experimental) and Azure.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
EnableCostOptimize <bool>
Enable Cost Optimize. Applicable to: AVD (Experimental) and Azure.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
FeedURL <string>
The Feed URL. Applicable to: AVD (Experimental).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
WebAccessURL <string>
The Web Access URL. Applicable to: AVD (Experimental).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ADType <ADType>
The ADType. Applicable to: AVD (Experimental).
Possible values: WindowsServerADDS, AzureADDS
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AccessKeyID <string>
The access key ID of the Amazon Web Service account. Applicable to: AWSEC2.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
SecretAccessKey <SecureString>
The secret access key of the Amazon Web Service account. Applicable to: AWSEC2.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
LocationType <EC2LocationType>
The location type of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
Possible values: Default, OptedIn, EndpointUrl
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RegionName <string>
The region name of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RegionCode <string>
The region code of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
EndpointUrl <string>
The endpoint URL of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
Example: https://ec2.us-east01.amazonaws.com.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
StartMacAddress <string>
Starting MAC Address. Applicable to: HyperV Failover.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
EndMacAddress <string>
Ending MAC Address. Applicable to: HyperV Failover.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
EnableMacManagement <bool>
Specifies if the MAC Management is enabled or not. Applicable to: HyperV Failover.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
DomainTargetOU <string>
Domain Target OU. Applicable to: Remote PC Dynamic.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemotePCDynamicSubnet <string>
The subnet of the remote PC dynamic. Applicable to: Remote PC Dynamic.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ScaleVersion <ScaleVersion>
Specifies the Scale Version. Applicable to: Scale.
Possible values: Scale, v8_9, v9_1, Scale_Depr, v8_9_Depr, v9_1_Depr
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ResourcePool <string>
Resource Pool. Applicable to: VCenter
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<
CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation.