Set-RASRDSHostPool

NAME

Set-RASRDSHostPool

SYNOPSIS

Modifies an RD Session Host Pool.

SYNTAX

Set-RASRDSHostPool [-Id] <uint> [-AllowDragAndDrop <bool>] [-AllowFileTransfer <bool>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredBroker <SwitchParameter>] [-Autoscale <bool>] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-DrainRemainsBelowSec <uint>] [-EnableAppMonitoring <bool>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-ExcludeFilePath <string[]>] [-ExcludeFolderPath <string[]>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-HostName <string>] [-IncludeFilePath <string[]>] [-IncludeFolderPath <string[]>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>] [-InheritDefaultAutoUpgradeSettings <bool>] [-InheritDefaultDesktopAccessSettings <bool>] [-InheritDefaultPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>] [-LogoffDisconnectedSessionAfter <uint>] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxServersFromTemplate <uint>] [-MaxSessions <uint>] [-MaxUserProfileDiskSizeGB <uint>] [-MinServersFromTemplate <uint>] [-NewName <string>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RASTemplate <Template>] [-RASTemplateId <uint>] [-RASTemplateVersionId <uint>] [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-RestrictDesktopAccess <bool>] [-RestrictedUsers <string[]>] [-ServersToAddPerRequest <uint>] [-SupportShellURLNamespaceObjects <bool>] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-UPDiskPath <string>] [-UPDMode {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode {Exclude | Include}] [-UseRemoteApps <bool>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>] [<CommonParameters>]

Set-RASRDSHostPool [-InputObject] <RDSHostPool> [-AllowDragAndDrop <bool>] [-AllowFileTransfer <bool>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredBroker <SwitchParameter>] [-Autoscale <bool>] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-DrainRemainsBelowSec <uint>] [-EnableAppMonitoring <bool>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-ExcludeFilePath <string[]>] [-ExcludeFolderPath <string[]>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-HostName <string>] [-IncludeFilePath <string[]>] [-IncludeFolderPath <string[]>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>] [-InheritDefaultAutoUpgradeSettings <bool>] [-InheritDefaultDesktopAccessSettings <bool>] [-InheritDefaultPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>] [-LogoffDisconnectedSessionAfter <uint>] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxServersFromTemplate <uint>] [-MaxSessions <uint>] [-MaxUserProfileDiskSizeGB <uint>] [-MinServersFromTemplate <uint>] [-NewName <string>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RASTemplate <Template>] [-RASTemplateId <uint>] [-RASTemplateVersionId <uint>] [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-RestrictDesktopAccess <bool>] [-RestrictedUsers <string[]>] [-ServersToAddPerRequest <uint>] [-SupportShellURLNamespaceObjects <bool>] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-UPDiskPath <string>] [-UPDMode {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode {Exclude | Include}] [-UseRemoteApps <bool>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>] [<CommonParameters>]

Set-RASRDSHostPool [-Name] <string> [[-SiteId] <uint>] [-AllowDragAndDrop <bool>] [-AllowFileTransfer <bool>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredBroker <SwitchParameter>] [-Autoscale <bool>] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-DrainRemainsBelowSec <uint>] [-EnableAppMonitoring <bool>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-ExcludeFilePath <string[]>] [-ExcludeFolderPath <string[]>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-HostName <string>] [-IncludeFilePath <string[]>] [-IncludeFolderPath <string[]>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>] [-InheritDefaultAutoUpgradeSettings <bool>] [-InheritDefaultDesktopAccessSettings <bool>] [-InheritDefaultPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>] [-LogoffDisconnectedSessionAfter <uint>] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxServersFromTemplate <uint>] [-MaxSessions <uint>] [-MaxUserProfileDiskSizeGB <uint>] [-MinServersFromTemplate <uint>] [-NewName <string>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RASTemplate <Template>] [-RASTemplateId <uint>] [-RASTemplateVersionId <uint>] [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-RestrictDesktopAccess <bool>] [-RestrictedUsers <string[]>] [-ServersToAddPerRequest <uint>] [-SupportShellURLNamespaceObjects <bool>] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-UPDiskPath <string>] [-UPDMode {DoNotChange | Enabled | Disabled}] [-UPDRoamingMode {Exclude | Include}] [-UseRemoteApps <bool>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>] [<CommonParameters>]

DESCRIPTION

Modifies properties of an RD Session Host Pool.

PARAMETERS

-Name <string> The name of the host pool to modify.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID where the target host pool is located.

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 a RD Session Host Pool to modify.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RDSHostPool> A RD Session Host Pool object (an object of type RDSHostPool) to modify.

A RDSHostPool object representing a group is obtained using the Get-RASRDSHostPool cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Enabled <bool> Enable or disable the specified host pool(s) in a site.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NewName <string> A new name to assign to the specified host pool.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> A description of the specified host pool.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Autoscale <bool> Enable or disable Autoscaling.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RASTemplate <Template> The RDSH RAS Template object.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RASTemplateId <uint> The RDSH RAS Template ID.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RASTemplateVersionId <uint> The RDSH RAS Template Version ID.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MinServersFromTemplate <uint> Min number of servers to be added to the host pool from the RAS Template.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaxServersFromTemplate <uint> Max number of servers to be added to the host pool from the RAS Template.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HostName <string> The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefaultPowerState <DefaultPowerState> The Default Power State

Possible values: PoweredOn, PoweredOff, Suspended

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkLoadThreshold <uint> Send a request to the RAS template when the workload threshold is above the specified value.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ServersToAddPerRequest <uint> Number of servers to be added to the host pool per request.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkLoadToDrain <uint> Drain and unassign servers from host pool when workload is below the specified value.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DrainRemainsBelowSec <uint> Drain and unassign servers from host pool when workload remains below the specified level for the below specified time (in seconds).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RemoveServersAfterDrainAndPowerOff <bool> Remove servers from host pool after drain and power off.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InheritDefaultAgentSettings <bool> Enable or disable the 'Inherit default agent settings' option. This will inherit Global 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

-InheritDefaultPrinterSettings <bool> Enable or disable the 'Inherit default printer settings' option. This will inherit Global 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?  false

-InheritDefaultUserProfileSettings <bool> Enable or disable the 'Inherit default user profile settings' option. This will inherit Global 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?  false

-InheritDefaultDesktopAccessSettings <bool> Enable or disable the 'Inherit default desktop access settings' option. This will inherit Global 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?  false

-InheritDefaultAppPackageSettings <bool> Enable or disable the 'Inherit default app package settings' option. This will inherit Global App Package 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

-InheritDefaultAutoUpgradeSettings <bool> Enable or disable the 'Inherit Auto-upgrade settings' option. This will inherit Global Auto-upgrade 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

-DisconnectActiveSessionAfter <uint> Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

        Required?                    false