Set-RDSDefaultSettings

NAME

Set-RDSDefaultSettings

SYNOPSIS

Modifies default settings used to configure an RD Session Host server.

SYNTAX

Set-RDSDefaultSettings [-AllowFileTransfer <bool>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection <AllowURLAndMailRedirection> {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredPA <SwitchParameter>] [-DragAndDropMode <DragAndDropModeValues> {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-EnableAppMonitoring <bool>] [-EnablePrinting <bool>] [-EnableTWAIN <bool>] [-EnableWIA <bool>] [-ExcludeFilePath <string[]>] [-ExcludeFolderPath <string[]>] [-IncludeFilePath <string[]>] [-IncludeFolderPath <string[]>] [-MaxSessions <uint>] [-MaxUserProfileDiskSizeGB <uint>] [-Port <uint>] [-PreferredPAObj <PA>] [-PrinterNameFormat <PrnNameFormat> {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-RestrictDesktopAccess <bool>] [-RestrictedUsers <string[]>] [-SessionLogoffTimeout <uint>] [-SessionTimeout <uint>] [-SiteId <uint>] [-UPDiskPath <string>] [-UPDMode <UPDMode> {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode <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-RDSDefaultSettings 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

-SessionTimeout <uint>
Specifies the 'Publishing Settings Disconnect Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SessionLogoffTimeout <uint>
Specifies the 'Publishing Settings Reset Timeout' option (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

-AutoPreferredPA <SwitchParameter>
Sets the 'Preferred Publishing Agent' option to 'Automatically".

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PreferredPAObj <PA>
The preferred Publishing Agent server.

To obtain an object of type PA representing the preferred Publishing Agent, use the Get-PA cmdlet.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AllowRemoteExec <bool>
Enables or disables 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>
Enables or disables the 'Enable application monitoring' option.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UseRemoteApps <bool>
Enables or disables the 'Use RemoteApps if available' option.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AllowFileTransfer <bool>
Enables or disables the 'Allow file transfer' option.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DragAndDropMode <DragAndDropModeValues>
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

-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.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableTWAIN <bool>
Enables or disables 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?  false

-EnableWIA <bool>
Enables or disables 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?  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>
Enables or disables the 'Remove client name from printer name' option.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-RemoveSessionNumberFromPrinterName <bool>
Enables or disables the 'Remove session number from printer name' option.

        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>
Enables or disables 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-RDSDefaultSettings -SiteId 2 -MaxSessions 100

Modifies the default value of the MaxSessions property for the specified site.

RELATED LINKS