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)] [-DatastoreIDs (string[])] [-DatastoreSource {Template | Selection}] [-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}] [-ProvisioningType {Template | Standalone}] [-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}] [-Template (Template)] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [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? falseSiteId (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? falseDescription (string)
A description of the specified host pool.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseProvisioningType
(ProvisioningType) The Host Pool Provisioning type
Possible values: Template, Standalone
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAutoscale (bool)
Enable Autoscaling.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? falseTemplate (Template)
The RD RAS Template object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRASTemplate (Template)
Deprecated: The RD RAS Template object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTemplateId (uint)
The RDSH Template ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRASTemplateId (uint)
Deprecated: The RDSH Template ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTemplateVersionId (uint)
The RDSH Template Version ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRASTemplateVersionId (uint)
Deprecated: The RDSH Template Version ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTemplateTagId (uint)
The RDSH Template Tag ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMinServersFromTemplate (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? falseMaxServersFromTemplate (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? falseHostName (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? falseDefaultPowerState
(DefaultPowerState) The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
Required? false
Position? named
Default value PoweredOn
Accept pipeline input? false
Accept wildcard characters? falseHostsToCreate (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? falseWorkLoadThreshold (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? falseServersToAddPerRequest (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? falseWorkLoadToDrain (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? falseDrainRemainsBelowSec (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? falseRemoveServersAfterDrainAndPowerOff (bool)
Remove servers from host pool after drain and power off.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRDSObject (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? falseRDSIds (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? falseInheritDefaultAgentSettings (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? falseInheritDefaultPrinterSettings (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? falseInheritDefaultUserProfileSettings (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? falseInheritDefaultDesktopAccessSettings (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? falseInheritDefaultAppPackageSettings (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? falseInheritDefaultAutoUpgradeSettings (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? falsePort (uint)
Specifies the port number for the RD Session Host agent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMaxSessions (uint)
Specifies the 'Maximum Sessions' property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDisconnectActiveSessionAfter (uint)
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseLogoffDisconnectedSessionAfter (uint)
Logoff disconnected session after (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? falseAllowURLAndMailRedirection
(AllowURLAndMailRedirection) Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration).
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSupportShellURLNamespaceObjects (bool)
Enable or disable the 'Support Shell URL Namespace Objects' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePreferredBrokerObj (Broker)
The preferred Connection Broker.
To obtain an object of type Broker representing the preferred Connection Broker, use the Get-RASBroker cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePreferredBrokerId (uint)
The preferred Connection Broker.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAllowRemoteExec (bool)
Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableAppMonitoring (bool)
Enable or disable the 'Application Monitoring' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUseRemoteApps (bool)
Enable or disable the 'Use RemoteApps if available' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFileTransferMode
(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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFileTransferLocation (string)
Location where the File Transfer takes place, if and where it is allowed.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFileTransferLockLocation (bool)
Lock Location where the File Transfer takes place, if and where it is allowed.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDragAndDropMode
(DragAndDropModeValue) Specifies the mode the client server drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseManageRDPTransportProtocol
(ManageRDPTransportProtocol) Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePrinterNameFormat
(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
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRemoveClientNameFromPrinterName (bool)
Enable or disable the 'Remove client name from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRemoveSessionNumberFromPrinterName (bool)
Enable or disable the 'Remove session number from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTechnology (UserProfileTech)
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUPDMode (UPDMode)
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled.
Possible values: DoNotChange, Enabled, Disabled
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUPDRoamingMode (UPDRoamingMode)
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include.
Possible values: Exclude, Include
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUPDiskPath (string)
Specifies the User Profile Disk path.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMaxUserProfileDiskSizeGB (uint)
Specifies the max user profile disk size (in GB).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseIncludeFolderPath (string[])
Specifies the UPD 'Include' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseIncludeFilePath (string[])
Specifies the UPD 'Include' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseExcludeFolderPath (string[])
Specifies the UPD 'Exclude' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseExcludeFilePath (string[])
Specifies the UPD 'Exclude' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRestrictDesktopAccess (bool)
Enable or disable the 'Restrict direct desktop access to the following users' option.
Use the RestrictedUsers parameter to specify the list of users.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRestrictedUsers (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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDatastoreSource
(DatastoreSourceType) Datastore Source.
Possible values: Template, Selection
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDatastoreIDs (string[])
Datastore IDs.
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 documentation. INPUTS
-none-
OUTPUTS
EXAMPLES
**---------- EXAMPLE 1 ----------
New-RASRDSHostPool "My RDS Host Pool"
Creates a new RD Session Host Pool with the specified name.
RELATED LINKS
Last updated