New-RASRDSHostPool
NAME
New-RASRDSHostPool
SYNOPSIS
Creates a new RD Session Host Pool.
SYNTAX
New-RASRDSHostPool [-Name] <string> [[-SiteId] <uint>] [-AllowDragAndDrop <bool>] [-AllowFileTransfer <bool>] [-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>] [-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.
-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.
-Description <string> A description of the specified host pool.
-Autoscale <bool> Enable Autoscaling.
-RASTemplate <Template> The RD 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. Default: 1
-MaxServersFromTemplate <uint> Max number of servers to be added to the host pool from the RAS Template. Default: 2
-HostName <string> The host name format. All hosts created from the template will have this name with %ID:N:S% replaced.
-DefaultPowerState <DefaultPowerState> The Default Power State Possible values: PoweredOn, PoweredOff, Suspended
-HostsToCreate <uint> The number of hosts that will be created after template creation process has finished. These desktops are created only once.
-WorkLoadThreshold <uint> Send a request to the RAS template when the workload threshold is above the specified value. Default: 75
-ServersToAddPerRequest <uint> Number of servers to be added to the host pool per request. Default: 1
-WorkLoadToDrain <uint> Drain and power off servers within host pool when workload is below the specified value. Default: 20
-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: 0 (Immediate)
-RemoveServersAfterDrainAndPowerOff <bool> Remove servers from host pool after drain and power off.
-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.
-RDSIds <uint[]> A list of RD Session Host servers (an array of RDS Ids) to add to the host pool.
-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.
-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'.
-LogoffDisconnectedSessionAfter <uint> Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
-AllowURLAndMailRedirection <AllowURLAndMailRedirection> Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration). Possible values: Disabled, Enabled, EnabledWithAppRegistration
-SupportShellURLNamespaceObjects <bool> Enable or disable the 'Support Shell URL Namespace Objects' option.
-PreferredBrokerObj <Broker> The preferred Connection Broker. To obtain an object of type Broker representing the preferred Connection Broker, use the Get-RASBroker cmdlet.
-PreferredBrokerId <uint> The preferred Connection Broker.
-AllowRemoteExec <bool> Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.
-EnableAppMonitoring <bool> Enable or disable the 'Application Monitoring' option.
-UseRemoteApps <bool> Enable or disable the 'Use RemoteApps if available' option.
-AllowFileTransfer <bool> Deprecated: use FileTransferMode instead. Enable or disable the 'Allow file transfer' option. (deprecated)
-FileTransferMode <FileTransferControlMode> File Transfer option. Possible values are: 0 (Disabled), 1 (client to Server only), 2 {Server To Client only), 3 (Bidirectional). Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
-FileTransferLocation <string> Location where the File Transfer takes place, if and where it is allowed.
-FileTransferLockLocation <bool> Lock Location where the File Transfer takes place, if and where it is allowed.
-AllowDragAndDrop <bool> Enable or disable the 'Allow local to remote drag and drop' option. (deprecated)
-DragAndDropMode <DragAndDropModeValue> Specifies the mode the client server drag and drop feature will operate. Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
-ManageRDPTransportProtocol <ManageRDPTransportProtocol> Manage RDP transport protocol. Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
-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
-RemoveClientNameFromPrinterName <bool> Enable or disable the 'Remove client name from printer name' option.
-RemoveSessionNumberFromPrinterName <bool> Enable or disable the 'Remove session number from printer name' option.
-Technology <UserProfileTech> Specifies the 'User Profile Technology' value. Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
-UPDMode <UPDMode> Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled. Possible values: DoNotChange, Enabled, Disabled
-UPDRoamingMode <UPDRoamingMode> Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include. Possible values: Exclude, Include
-UPDiskPath <string> Specifies the User Profile Disk path.
-MaxUserProfileDiskSizeGB <uint> Specifies the max user profile disk size (in GB).
-IncludeFolderPath <string[]> Specifies the UPD 'Include' folder paths.
-IncludeFilePath <string[]> Specifies the UPD 'Include' file paths.
-ExcludeFolderPath <string[]> Specifies the UPD 'Exclude' folder paths.
-ExcludeFilePath <string[]> Specifies the UPD 'Exclude' file paths.
-RestrictDesktopAccess <bool> Enable or disable the 'Restrict direct desktop access to the following users' option. Use the RestrictedUsers parameter to specify the list of users.
-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.
<CommonParameters>
INPUTS
-none-
OUTPUTS
EXAMPLES
---------- EXAMPLE 1 ---------- New-RASRDSHostPool "My RDS Host Pool" Creates a new RD Session Host Pool with the specified name.
Last updated