Set-RASRDSHost
NAME
Set-RASRDSHost
SYNOPSIS
Modifies RD Session Host server settings.
SYNTAX
Set-RASRDSHost [Id] (uint)** [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [AutoPreferredBroker (SwitchParameter)] [Description (string)] [DirectAddress (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [EnableAppMonitoring (bool)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnablePrinting (bool)] [EnableTWAIN (bool)] [EnableWIA (bool)] [EnableZOrder (bool)] [-ExcludeFilePath (string[])] [-ExcludeFolderPath (string[])] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-IncludeFilePath (string[])] [-IncludeFolderPath (string[])] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultDesktopAccessSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [LogoffDisconnectedSessionAfter (uint)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxSessions (uint)] [MaxUserProfileDiskSizeGB (uint)] [NewServer (string)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveClientNameFromPrinterName (bool)] [RemoveSessionNumberFromPrinterName (bool)] [RestrictDesktopAccess (bool)] [-RestrictedUsers (string[])] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [UPDiskPath (string)] [-UPDMode {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode {Exclude | Include}] [UseRemoteApps (bool)] [(CommonParameters)]
Set-RASRDSHost [-InputObject]** (RDSHost) [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [AutoPreferredBroker (SwitchParameter)] [Description (string)] [DirectAddress (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [EnableAppMonitoring (bool)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnablePrinting (bool)] [EnableTWAIN (bool)] [EnableWIA (bool)] [EnableZOrder (bool)] [-ExcludeFilePath (string[])] [-ExcludeFolderPath (string[])] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-IncludeFilePath (string[])] [-IncludeFolderPath (string[])] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultDesktopAccessSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [LogoffDisconnectedSessionAfter (uint)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxSessions (uint)] [MaxUserProfileDiskSizeGB (uint)] [NewServer (string)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveClientNameFromPrinterName (bool)] [RemoveSessionNumberFromPrinterName (bool)] [RestrictDesktopAccess (bool)] [-RestrictedUsers (string[])] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [UPDiskPath (string)] [-UPDMode {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode {Exclude | Include}] [UseRemoteApps (bool)] [(CommonParameters)]
Set-RASRDSHost [Server]** (string) [[-SiteId] (uint)] [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [AutoPreferredBroker (SwitchParameter)] [Description (string)] [DirectAddress (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [EnableAppMonitoring (bool)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnablePrinting (bool)] [EnableTWAIN (bool)] [EnableWIA (bool)] [EnableZOrder (bool)] [-ExcludeFilePath (string[])] [-ExcludeFolderPath (string[])] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-IncludeFilePath (string[])] [-IncludeFolderPath (string[])] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultDesktopAccessSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [LogoffDisconnectedSessionAfter (uint)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxSessions (uint)] [MaxUserProfileDiskSizeGB (uint)] [NewServer (string)] [Port (uint)] [PreferredBrokerId (uint)] [-PreferredBrokerObj (Broker)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveClientNameFromPrinterName (bool)] [RemoveSessionNumberFromPrinterName (bool)] [RestrictDesktopAccess (bool)] [-RestrictedUsers (string[])] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [UPDiskPath (string)] [-UPDMode {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode {Exclude | Include}] [UseRemoteApps (bool)] [(CommonParameters)]
DESCRIPTION
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.
PARAMETERS
Server (string)
The name of the target RD Session Host server.
This must be the actual server name used in the RAS farm.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? falseSiteId (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.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseId (uint)
The ID of the RD Session Host server to modify. To obtain the ID, use the Get-RDS cmdlet.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseInputObject (RDSHost)
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.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? falseEnabled (bool)
Enable or disable the specified RD Session Host server in a site.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseNewServer (string)
A new server name. This must be either the server's FQDN or IP address.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDescription (string)
A user-defined RD Session Host server description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDirectAddress (string)
Specifies the RD Session Host server direct address.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultAgentSettings (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultPrinterSettings (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultUserProfileSettings (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultDesktopAccessSettings (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultOptimizationSettings (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultAppPackageSettings (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePort (uint)
Specifies the port number for the RD Session Host agent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMaxSessions (uint)
Specifies the 'Maximum Sessions' property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDisconnectActiveSessionAfter (uint)
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseLogoffDisconnectedSessionAfter (uint)
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAllowURLAndMailRedirection
(AllowURLAndMailRedirection) Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration).
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSupportShellURLNamespaceObjects (bool)
Enable or disable the 'Support Shell URL Namespace Objects' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAllowRemoteExec (bool)
Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableAppMonitoring (bool)
Enable or disable the 'Application Monitoring' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUseRemoteApps (bool)
Enable or disable the 'Use RemoteApps if available' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFileTransferMode
(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? falseFileTransferLocation (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? falseFileTransferLockLocation (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? falseDragAndDropMode
(DragAndDropModeValue) Specifies the mode the client server drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseManageRDPTransportProtocol
(ManageRDPTransportProtocol) Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnablePrinting (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableTWAIN (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableWIA (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePrinterNameFormat
(PrnNameFormat) 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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRemoveClientNameFromPrinterName (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? falseRemoveSessionNumberFromPrinterName (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? falseAutoPreferredBroker (SwitchParameter)
Set the 'Preferred Connection Broker' option to 'Automatically".
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? falsePreferredBrokerObj (Broker)
The preferred Connection Broker
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? falsePreferredBrokerId (uint)
The preferred Connection Broker ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableDriveRedirectionCache (bool)
Enable or disable the 'Enable Drive Redirection Cache' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableZOrder (bool)
Enable or disable the 'Enable Z-Order' option. (Experimental)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTechnology (UserProfileTech)
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUPDMode (UPDMode)
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled.
Possible values: DoNotChange, Enabled, Disabled
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUPDRoamingMode (UPDRoamingMode)
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include.
Possible values: Exclude, Include
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUPDiskPath (string)
Specifies the User Profile Disk path.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMaxUserProfileDiskSizeGB (uint)
Specifies the max user profile disk size (in GB).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseIncludeFolderPath (string[])
Specifies the UPD 'Include' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseIncludeFilePath (string[])
Specifies the UPD 'Include' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseExcludeFolderPath (string[])
Specifies the UPD 'Exclude' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseExcludeFilePath (string[])
Specifies the UPD 'Exclude' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRestrictDesktopAccess (bool)
Enable or disable the 'Restrict direct desktop access to the following users' option.
Use the RestrictedUsers parameter to specify the list of users.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRestrictedUsers (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.
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. INPUTS
OUTPUTS
-none-
EXAMPLES
**---------- 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.
RELATED LINKS
Last updated