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>]
[-AvailabilityOptions {NoInfrastructure | AvailabilitySet | AvailabilityZone}]
[-AvailabilityPreferredZone {Zone1 | Zone2 | Zone3}] [-AWSSubnetsIds <List`1>]
[-ClusterId <string>] [-ClusterName <string>] [-DatastoreIDs <string[]>]
[-DatastoreSource {Template | Selection}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}]
[-Description <string>] [-DeviceName <string>] [-DisconnectActiveSessionAfter <uint>]
[-DomainOrgUnit <string>]
[-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
[-DrainRemainsBelowSec <uint>] [-EnableAppMonitoring <bool>] [-ExcludeFilePath <string[]>]
[-ExcludeFolderPath <string[]>] [-FileTransferAutoCloseWindow <bool>]
[-FileTransferExistingFileMode {CreateNewFile | OverwriteExistingFile}]
[-FileTransferLocation <string>] [-FileTransferLockLocation <bool>]
[-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
[-FileTransferSuppressPromptForUploadFiles <bool>] [-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}]
[-MaximumIOPS <ulong>] [-MaxServersFromTemplate <uint>] [-MaxSessions <uint>]
[-MaxUserProfileDiskSizeGB <uint>] [-MinServersFromTemplate <uint>] [-OverrideCluster <bool>]
[-OverrideDomainOrgUnit <bool>] [-OverrideHighAvailability <bool>] [-OverrideNetwork <bool>]
[-OverrideSize <bool>] [-OverrideStorage <bool>] [-Port <uint>]
[-PreferredConnectionBrokerId <uint>] [-PreferredConnectionBrokerObj <ConnectionBroker>]
[-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}]
[-ProvisioningType {Template | Standalone}] [-RDSIds <uint[]>] [-RDSObject <RDSHost[]>]
[-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>]
[-RemoveSessionNumberFromPrinterName <bool>] [-RestrictDesktopAccess <bool>]
[-RestrictedUsers <string[]>] [-ServersToAddPerRequest <uint>] [-Size <uint>] [-SubnetId <string>]
[-SubnetName <string>] [-SupportShellURLNamespaceObjects <bool>]
[-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-Template <Template>]
[-TemplateId <uint>] [-TemplateTagId <uint>] [-TemplateVersionId <uint>] [-Throughput <ulong>]
[-UPDiskPath <string>] [-UPDMode {DoNotChange | Enabled | Disabled}]
[-UPDRoamingMode {Exclude | Include}] [-UseRemoteApps <bool>] [-VMSize <string>]
[-VolumeType {gp2 | gp3 | io1 | io2 | standard}] [-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.
EXAMPLES
Example 1
Creates a new RD Session Host Pool with the specified name.
PARAMETERS
-Name
Host pool name.
-SiteId
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
A description of the specified host pool.
-ProvisioningType
The Host Pool Provisioning type
Possible values: Template, Standalone
Type reference: ProvisioningType
-Autoscale
Enable Autoscaling.
-Template
The RD RAS Template object.
Type reference: Template
-TemplateId
The RDSH Template ID.
-TemplateVersionId
The RDSH Template Version ID.
-TemplateTagId
The RDSH Template Tag ID.
-MinServersFromTemplate
Min number of servers to be added to the host pool from the RAS Template.
Default: 1
-MaxServersFromTemplate
Max number of servers to be added to the host pool from the RAS Template.
Default: 2
-HostName
The host name format. All hosts created from the template will have this name with %ID:N:S% replaced.
-DefaultPowerState
The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
Type reference: DefaultPowerState
-HostsToCreate
The number of hosts that will be created after template creation process has finished. These desktops are created only once.
-WorkLoadThreshold
Send a request to the RAS template when the workload threshold is above the specified value.
Default: 75
-ServersToAddPerRequest
Number of servers to be added to the host pool per request.
Default: 1
-WorkLoadToDrain
Drain and power off servers within host pool when workload is below the specified value.
Default: 20
-DrainRemainsBelowSec
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)
-RemoveServersAfterDrainAndPowerOff
Remove servers from host pool after drain and power off.
-RDSObject
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-RASRDSHost cmdlet.
Type reference: RDSHost[]
-RDSIds
A list of RD Session Host servers (an array of RDS Ids) to add to the host pool.
-InheritDefaultAgentSettings
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
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
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
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
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
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
Specifies the port number for the RD Session Host agent.
-MaxSessions
Specifies the 'Maximum Sessions' property.
-DisconnectActiveSessionAfter
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
-LogoffDisconnectedSessionAfter
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
-AllowURLAndMailRedirection
Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration).
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Type reference: AllowURLAndMailRedirection
-SupportShellURLNamespaceObjects
Enable or disable the 'Support Shell URL Namespace Objects' option.
-PreferredConnectionBrokerObj
The preferred Connection Broker.
To obtain an object of type Broker representing the preferred Connection Broker, use the Get-RASConnectionBroker cmdlet.
Type reference: ConnectionBroker
-PreferredConnectionBrokerId
The preferred Connection Broker.
-AllowRemoteExec
Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.
-EnableAppMonitoring
Enable or disable the 'Application Monitoring' option.
-UseRemoteApps
Enable or disable the 'Use RemoteApps if available' option.
-FileTransferMode
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
Type reference: FileTransferControlMode
-FileTransferLocation
Location where the File Transfer takes place, if and where it is allowed.
-FileTransferLockLocation
Lock Location where the File Transfer takes place, if and where it is allowed.
-FileTransferSuppressPromptForUploadFiles
Specifies if the 'Suppress prompt for upload files' option is enabled or disabled.
-FileTransferExistingFileMode
Specifies the behavior when a file with the same name already exists in the destination folder during file transfer.
Possible values: CreateNewFile, OverwriteExistingFile
Type reference: FileTransferExistingFileMode
-FileTransferAutoCloseWindow
Specifies if the "Close transfer window when complete" option is enabled or disabled.
-DragAndDropMode
Specifies the mode the client server drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
Type reference: DragAndDropModeValue
-ManageRDPTransportProtocol
Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
Type reference: ManageRDPTransportProtocol
-PrinterNameFormat
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
Type reference: PrnNameFormat
-RemoveClientNameFromPrinterName
Enable or disable the 'Remove client name from printer name' option.
-RemoveSessionNumberFromPrinterName
Enable or disable the 'Remove session number from printer name' option.
-Technology
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
Type reference: UserProfileTech
-UPDMode
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled.
Possible values: DoNotChange, Enabled, Disabled
Type reference: UPDMode
-UPDRoamingMode
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include.
Possible values: Exclude, Include
Type reference: UPDRoamingMode
-UPDiskPath
Specifies the User Profile Disk path.
-MaxUserProfileDiskSizeGB
Specifies the max user profile disk size (in GB).
-IncludeFolderPath
Specifies the UPD 'Include' folder paths.
-IncludeFilePath
Specifies the UPD 'Include' file paths.
-ExcludeFolderPath
Specifies the UPD 'Exclude' folder paths.
-ExcludeFilePath
Specifies the UPD 'Exclude' file paths.
-RestrictDesktopAccess
Enable or disable the 'Restrict direct desktop access to the following users' option.
Use the RestrictedUsers parameter to specify the list of users.
-RestrictedUsers
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled).
The list can contain user account names and user SIDs.
-DatastoreSource
Datastore Source.
Possible values: Template, Selection
Type reference: DatastoreSourceType
-DatastoreIDs
Datastore IDs.
-OverrideStorage
Specifications: Whether Override Storage is Enabled or not. (Override Storage)
Available to Azure/AWS
-OverrideSize
Specifications: Whether Override Size is Enabled or not.
Available when host pool is templated from AWS or Azure.
-VMSize
Specifications: VMSize which will override the size specified in template properties.
Available when host pool is templated from AWS or Azure.
Example: Standard_B2s
-DeviceName
Device name. (Available for AWS Provider)
-VolumeType
Volume type. (Available for AWS Provider)
Possible values: gp2, gp3, io1, io2, standard
Type reference: VolumeType
-Size
Size (GiB). (Available for AWS Provider)
-MaximumIOPS
Maximum IOPS. (Available for AWS Provider)
-Throughput
Throughput (MB/s). (Available for AWS Provider)
-OverrideDomainOrgUnit
Specifications: Whether Override Domain Org Unit is Enabled or not. (OverrideDomainOrgUnit)
-DomainOrgUnit
Domain Organization unit
-OverrideCluster
Specifications: Whether Override Cluster is Enabled or not.
Available when host pool is templated from NutanixPC.
-ClusterName
Specifications: Cluster name where desktop VMs will be created.
Available when host pool is templated from NutanixPC.
-ClusterId
Specifications: The ID of a cluster where desktop VMs will be created.
Available when host pool is templated from NutanixPC.
-OverrideNetwork
Specifications: Whether Override Network is Enabled or not.
Available when host pool is templated from NutanixPC or AWS.
-SubnetId
Specifications: Subnet Id.
Available when host pool is templated from NutanixPC.
-SubnetName
Specifications: Subnet name.
Available when host pool is templated from NutanixPC.
-AWSSubnetsIds
Specifications: Add or remove Amazon Web Service Subnets.
Available when host pool is templated from AWS.
-OverrideHighAvailability
Whether to override high availability options.
Available to Azure
-AvailabilityOptions
Availability Options.
Available to Azure
Possible values: NoInfrastructure, AvailabilitySet, AvailabilityZone
Type reference: HighAvailability
-AvailabilityPreferredZone
Availability Preferred Zone.
Available to Azure
Possible values: Zone1, Zone2, Zone3
Type reference: PreferredZone
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None
OUTPUTS
RDSHostPool
RELATED LINKS
Last updated