Set-RASRDSHost
Modifies RD Session Host server settings.
Set-RASRDSHost [-] <uint> [- <bool>] [- <bool>] [- <bool>] [- {Disabled | Enabled | EnabledWithAppRegistration}] [- <SwitchParameter>] [- <string>] [- <string>] [- <uint>] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <string[]>] [- <string[]>] [- <string>] [- <bool>] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [- <string[]>] [- <string[]>] [- <bool>] [- <bool>] [-
Set-RASRDSHost [-] <> [- <bool>] [- <bool>] [- <bool>] [- {Disabled | Enabled | EnabledWithAppRegistration}] [- <SwitchParameter>] [- <string>] [- <string>] [- <uint>] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <string[]>] [- <string[]>] [- <string>] [- <bool>] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [- <string[]>] [- <string[]>] [- <bool>] [-
Set-RASRDSHost [-] <string> [[-] <uint>] [- <bool>] [- <bool>] [- <bool>] [- {Disabled | Enabled | EnabledWithAppRegistration}] [- <SwitchParameter>] [- <string>] [- <string>] [- <uint>] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <bool>] [- <string[]>] [- <string[]>] [- <string>] [- <bool>] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [- <string[]>] [- <string[]>] [- <bool>] [-
Modifies settings of an RD Session Host server.
For each setting, the cmdlet has a corresponding input parameter. To modify a setting, specify a matching parameter and its value.
-Server <string> The name of the target RD Session Host server.
This must be the actual server name used in the RAS farm.
-SiteId <uint> Site ID in which to modify the specified RD Session Host server.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-Id <uint> The ID of the RD Session Host server to modify. To obtain the ID, use the Get-RDS cmdlet.
-InputObject <> The RD Session Host servers to modify.
To obtain an object of type RDS representing a RD Session Host server, use the Get-RDS cmdlet.
-Enabled <bool> Enable or disable the specified RD Session Host server in a site.
-NewServer <string> A new server name. This must be either the server's FQDN or IP address.
-Description <string> A user-defined RD Session Host server description.
-DirectAddress <string> Specifies the RD Session Host server direct address.
-InheritDefaultAgentSettings <bool> Enable or disable the 'Inherit default agent settings' option. This will inherit RD Session Host agent settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
-InheritDefaultPrinterSettings <bool> Enable or disable the 'Inherit default printer settings' option. This will inherit RD Session Host printer settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
-InheritDefaultUserProfileSettings <bool> Enable or disable the 'Inherit default user profile settings' option. This will inherit RD Session Host User Profile settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
-InheritDefaultDesktopAccessSettings <bool> Enable or disable the 'Inherit default desktop access settings' option. This will inherit RD Session Host Desktop Access settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
-InheritDefaultOptimizationSettings <bool> Enable or disable the 'Inherit default Optimization Settings' option. This will inherit Image Optimization settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
-InheritDefaultAppPackageSettings <bool> Enable or disable the 'Inherit default App Package Settings' option. This will inherit Application Packages from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
-Port <uint> Specifies the port number for the RD Session Host agent.
-MaxSessions <uint> Specifies the 'Maximum Sessions' property.
-DisconnectActiveSessionAfter <uint> Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
-LogoffDisconnectedSessionAfter <uint> Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
-AllowURLAndMailRedirection <> Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration).
Possible values: Disabled, Enabled, EnabledWithAppRegistration
-SupportShellURLNamespaceObjects <bool> Enable or disable the 'Support Shell URL Namespace Objects' option.
-AllowRemoteExec <bool> Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.
-EnableAppMonitoring <bool> Enable or disable the 'Application Monitoring' option.
-UseRemoteApps <bool> Enable or disable the 'Use RemoteApps if available' option.
-AllowFileTransfer <bool> Deprecated: use FileTransferMode instead.
Enable or disable the 'Allow file transfer' option.
-FileTransferMode <> 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.
-AllowDragAndDrop <bool> Enable or disable the 'Allow local to remote drag and drop' option. (deprecated)
-DragAndDropMode <> Specifies the mode the client server drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
-ManageRDPTransportProtocol <> Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
-EnablePrinting <bool> Enables or disables Universal Printing on the RD Session Host server.
In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
-EnableTWAIN <bool> Enable or disable TWAIN (Universal Scanning) on the RD Session Host server.
In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
-EnableWIA <bool> Enable or disable WIA (Universal Scanning) on the RD Session Host server.
In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
-PrinterNameFormat <> Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES.
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
-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.
-AutoPreferredBroker <SwitchParameter> Set the 'Preferred Connection Broker' option to 'Automatically".
-PreferredBrokerObj <> The preferred Connection Broker
To obtain an object of type Broker representing the preferred Connection Broker, use the Get-RASBroker cmdlet.
-PreferredBrokerId <uint> The preferred Connection Broker ID.
-EnableDriveRedirectionCache <bool> Enable or disable the 'Enable Drive Redirection Cache' option.
-Technology <> Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
-UPDMode <> Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled.
Possible values: DoNotChange, Enabled, Disabled
-UPDRoamingMode <> Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include.
Possible values: Exclude, Include
-UPDiskPath <string> Specifies the User Profile Disk path.
-MaxUserProfileDiskSizeGB <uint> Specifies the max user profile disk size (in GB).
-IncludeFolderPath <string[]> Specifies the UPD 'Include' folder paths.
-IncludeFilePath <string[]> Specifies the UPD 'Include' file paths.
-ExcludeFolderPath <string[]> Specifies the UPD 'Exclude' folder paths.
-ExcludeFilePath <string[]> Specifies the UPD 'Exclude' file paths.
-RestrictDesktopAccess <bool> Enable or disable the 'Restrict direct desktop access to the following users' option.
Use the RestrictedUsers parameter to specify the list of users.
-RestrictedUsers <string[]> Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled).
The list can contain user account names and user SIDs.
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Set-RASRDSHost -Server "server.company.dom" -Enabled $False
Disables the specified RD Session Host server in the Licensing Server site.
---------- EXAMPLE 2 ----------
Set-RASRDSHost -Id 3 -Enabled $False
Disables the RD Session Host server specified by ID.
---------- EXAMPLE 3 ----------
Set-RASRDSHost $RDS -Enabled $True
Enables the RD Session Host server specified by the $RDS variable, which is an object of type RDS.
The object is obtained using the Get-RASRDSHost cmdlet. ---------- EXAMPLE 4 ----------
Get-RASRDSHost -Id 3 | Set-RASRDSHost -Enabled $True
Enables the RD Session Host server represented by an RDS object obtained from the pipeline output.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation.