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.
-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.
-Id <uint> The ID of a RD Session Host Pool to modify.
-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.
-Enabled <bool> Enable or disable the specified host pool(s) in a site.
-NewName <string> A new name to assign to the specified host pool.
-Description <string> A description of the specified host pool.
-Autoscale <bool> Enable or disable Autoscaling.
-RASTemplate <Template> The RDSH RAS Template object.
-RASTemplateId <uint> The RDSH RAS Template ID.
-RASTemplateVersionId <uint> The RDSH RAS Template Version ID.
-MinServersFromTemplate <uint> Min number of servers to be added to the host pool from the RAS Template.
-MaxServersFromTemplate <uint> Max number of servers to be added to the host pool from the RAS Template.
-HostName <string> The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.
-DefaultPowerState <DefaultPowerState> The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
-WorkLoadThreshold <uint> Send a request to the RAS template when the workload threshold is above the specified value.
-ServersToAddPerRequest <uint> Number of servers to be added to the host pool per request.
-WorkLoadToDrain <uint> Drain and unassign servers from host pool when workload is below the specified value.
-DrainRemainsBelowSec <uint> Drain and unassign servers from host pool when workload remains below the specified level for the below specified time (in seconds).
-RemoveServersAfterDrainAndPowerOff <bool> Remove servers from host pool after drain and power off.
-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.
-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.
-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.
-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.
-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.
-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.
-Port <uint> Specifies the port number for the RD Session Host agent.
-MaxSessions <uint> Specifies the 'Maximum Sessions' property.
-DisconnectActiveSessionAfter <uint> Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.