New-RASRDSHostPool

NAME

New-RASRDSHostPool

SYNOPSIS

Creates a new RD Session Host Pool.

SYNTAX

New-RASRDSHostPool [-Name] <string> [[-SiteId] <uint>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-Autoscale <bool>] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-DrainRemainsBelowSec <uint>] [-EnableAppMonitoring <bool>] [-ExcludeFilePath <string[]>] [-ExcludeFolderPath <string[]>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-HostName <string>] [-HostsToCreate <uint>] [-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>] [-Port <uint>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RASTemplate <Template>] [-RASTemplateId <uint>] [-RASTemplateVersionId <uint>] [-RDSIds <uint[]>] [-RDSObject <RDSHost[]>] [-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

Creates a new RD Session Host Pool. Individual servers can be added to the host pool using the Move-RASRDSHostPoolMember cmdlet.

PARAMETERS

-Name <string> Host pool name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in which to create the host pool.

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

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

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RASTemplate <Template> The RD 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.

Default: 1

        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.

Default: 2

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HostName <string> The host name format. All hosts 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                PoweredOn

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HostsToCreate <uint> The number of hosts that will be created after template creation process has finished. These desktops are created only once.

        Required?                    false

        Position?                    named

        Default value                0

        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.

Default: 75

        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.

Default: 1

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkLoadToDrain <uint> Drain and power off servers within host pool when workload is below the specified value.

Default: 20

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

Default: 1 (Immediate)

        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

-RDSObject <RDSHost[]> A list of RD Session Host servers (an array of objects of type RDS) to add to the host pool.

A RDS object representing a RD Session Host server is obtained using the Get-RDS cmdlet.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RDSIds <uint[]> A list of RD Session Host servers (an array of RDS Ids) to add to the host pool.

        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.