Set-RASRDSDefaultSettings
NAME
Set-RASRDSDefaultSettings
SYNOPSIS
Modifies default settings used to configure an RD Session Host server.
SYNTAX
Set-RASRDSDefaultSettings [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [AutoPreferredBroker (SwitchParameter)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [EnableAppMonitoring (bool)] [EnableDriveRedirectionCache (bool)] [EnableZOrder (bool)] [-ExcludeFilePath (string[])] [-ExcludeFolderPath (string[])] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-IncludeFilePath (string[])] [-IncludeFolderPath (string[])] [LogoffDisconnectedSessionAfter (uint)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxSessions (uint)] [MaxUserProfileDiskSizeGB (uint)] [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[])] [SiteId (uint)] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [UPDiskPath (string)] [-UPDMode {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode {Exclude | Include}] [UseRemoteApps (bool)] [(CommonParameters)]
DESCRIPTION
Modifies default settings used to configure 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.
Default settings are defined on a site level and are applied to an RD Session Host server when it is initially added to the site.
To retrieve the current defaults settings, use the Get-RASRDSDefaultSettings cmdlet.
PARAMETERS
SiteId (uint)
Site ID for which to modify the default RD Session Host server settings.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
Port (uint)
Specifies the RD Session Host agent port number.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaxSessions (uint)
Specifies the 'Maximum Sessions' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
DisconnectActiveSessionAfter (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? false
LogoffDisconnectedSessionAfter (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? false
AllowURLAndMailRedirection
(AllowURLAndMailRedirection) Specifies the 'Allow mail and URL 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? 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
AutoPreferredBroker (SwitchParameter)
Set the 'Preferred Connection Broker' option to 'Automatically".
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
PreferredBrokerObj (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? false
PreferredBrokerId (uint)
The preferred Connection Broker.
Required? false
Position? named
Default value
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
EnableZOrder (bool)
Enable or disable the 'Enable Z-Order' option. (Experimental)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
AllowRemoteExec (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? false
EnableAppMonitoring (bool)
Enable or disable the 'Enable application monitoring' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
UseRemoteApps (bool)
Enable or disable the 'Use RemoteApps if available' 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
DragAndDropMode
(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? 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
PrinterNameFormat
(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? 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
Technology (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? false
UPDMode (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? false
UPDRoamingMode (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? false
UPDiskPath (string)
Specifies the User Profile Disk path.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaxUserProfileDiskSizeGB (uint)
Specifies the max user profile disk size (in GB).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
IncludeFolderPath (string[])
Specifies the UPD 'Include' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
IncludeFilePath (string[])
Specifies the UPD 'Include' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ExcludeFolderPath (string[])
Specifies the UPD 'Exclude' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ExcludeFilePath (string[])
Specifies the UPD 'Exclude' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
RestrictDesktopAccess (bool)
Enable or disable the 'Restrict direct desktop access to the following users' option.
To specify the list of users, use the RestrictedUsers parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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.
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
-none-
OUTPUTS
-none-
EXAMPLES
**---------- EXAMPLE 1 ----------
Set-RASRDSDefaultSettings -SiteId 2 -MaxSessions 100
Modifies the default value of the MaxSessions property for the specified site.
RELATED LINKS
Last updated