Set-RDS

NAME

Set-RDS

SYNOPSIS

Modifies RD Session Host server settings.

SYNTAX

Set-RDS [-Server] <string> [[-SiteId] <uint>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection <AllowURLAndMailRedirection> {Disabled | Enabled | EnabledWithAppRegistration}] [-Description <string>] [-DirectAddress <string>] [-Enable <bool>] [-EnableAppMonitoring <bool>] [-EnablePrinting <bool>] [-EnableTWAIN <bool>] [-EnableWIA <bool>] [-InheritDefaultAgentSettings <bool>] [-MaxSessions <uint>] [-NewServer <string>] [-Port <uint>] [-SessionLogoffTimeout <uint>] [-SessionTimeout <uint>] [-UseRemoteApps <bool>] [<CommonParameters>]

Set-RDS [-Id] <uint> [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection <AllowURLAndMailRedirection> {Disabled | Enabled | EnabledWithAppRegistration}] [-Description <string>] [-DirectAddress <string>] [-Enable <bool>] [-EnableAppMonitoring <bool>] [-EnablePrinting <bool>] [-EnableTWAIN <bool>] [-EnableWIA <bool>] [-InheritDefaultAgentSettings <bool>] [-MaxSessions <uint>] [-NewServer <string>] [-Port <uint>] [-SessionLogoffTimeout <uint>] [-SessionTimeout <uint>] [-UseRemoteApps <bool>] [<CommonParameters>]

Set-RDS [-InputObject] <RDS> [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection <AllowURLAndMailRedirection> {Disabled | Enabled | EnabledWithAppRegistration}] [-Description <string>] [-DirectAddress <string>] [-Enable <bool>] [-EnableAppMonitoring <bool>] [-EnablePrinting <bool>] [-EnableTWAIN <bool>] [-EnableWIA <bool>] [-InheritDefaultAgentSettings <bool>] [-MaxSessions <uint>] [-NewServer <string>] [-Port <uint>] [-SessionLogoffTimeout <uint>] [-SessionTimeout <uint>] [-UseRemoteApps <bool>] [<CommonParameters>]

DESCRIPTION

The Set-RDS cmdlet is used to modify 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?  false

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

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <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?  false

-InputObject <RDS>
The RD Session Host servers to modify.

To obtain an object of type RDS representing an RD Session Host server, use the Get-RDS cmdlet.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-Enable <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?  false

-NewServer <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?  false

-Description <string>
A user-defined RD Session Host server description.

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

-DirectAddress <string>
Specifies the RD Session Host server direct address.

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

-InheritDefaultAgentSettings <bool>
Enables the 'Inherit default 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?  false

-Port <uint>
Specifies the port number for the RD Session Host agent.

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

-MaxSessions <uint>
Specifies the 'Maximum Sessions' property.

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

-SessionTimeout <uint>
Specifies the 'Publishing Sessions 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 Client URL/Mail Redirection' option. Accepted values: 0 (Disabled), 1 (Enabled), 2 (Enable with app registration).

Possible values: Disabled, Enabled, EnabledWithAppRegistration

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

-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

<CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 

INPUTS

PSAdmin.RDS

        The RD Session Host servers to modify.

        To obtain an object of type RDS representing an RD Session Host server, use the Get-RDS cmdlet.

OUTPUTS



EXAMPLES


---------- EXAMPLE 1 ----------

Set-RDS -Server "server.company.dom" -Enable $False

Disables the specified RD Session Host server in the Licensing Server site.

---------- EXAMPLE 2 ----------

Set-RDS -Id 3 -Enable $False

Disables the RD Session Host server specified by ID.

---------- EXAMPLE 3 ----------

Set-RDS $RDS -Enable $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-RDS cmdlet.

---------- EXAMPLE 4 ----------

Get-RDS -Id 3 | Set-RDS -Enable $True

Enables the RD Session Host server represented by an RDS object obtained from the pipeline output.

RELATED LINKS

Parallels RAS v16.0