Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ProvisioningType
Possible values: Template, Standalone
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
The RD RAS Template object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Deprecated: The RD RAS Template object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
TemplateId (uint)
The RDSH Template ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
RASTemplateId (uint)
Deprecated: The RDSH Template ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
TemplateVersionId (uint)
The RDSH Template Version ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
RASTemplateVersionId (uint)
Deprecated: The RDSH Template Version ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
TemplateTagId (uint)
The RDSH Template Tag 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
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
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.
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? false
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Port (uint)
Specifies the port number for the RD Session Host agent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaxSessions (uint)
Specifies the 'Maximum Sessions' property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
DisconnectActiveSessionAfter (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? false
LogoffDisconnectedSessionAfter (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? false
AllowURLAndMailRedirection
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
SupportShellURLNamespaceObjects (bool)
Enable or disable the 'Support Shell URL Namespace Objects' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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? false
PreferredBrokerId (uint)
The preferred Connection Broker.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
AllowRemoteExec (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? false
EnableAppMonitoring (bool)
Enable or disable the 'Application Monitoring' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
UseRemoteApps (bool)
Enable or disable the 'Use RemoteApps if available' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
FileTransferMode
Possible values: Disabled, ClientToServer, ServerToClient,
Bidirectional
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
FileTransferLocation (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? false
FileTransferLockLocation (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? false
DragAndDropMode
Possible values: Disabled, ClientToServer, ServerToClient,
Bidirectional
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ManageRDPTransportProtocol
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
PrinterNameFormat
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? false
RemoveClientNameFromPrinterName (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? false
RemoveSessionNumberFromPrinterName (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? false
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? false
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? false
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? false
UPDiskPath (string)
Specifies the User Profile Disk path.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
MaxUserProfileDiskSizeGB (uint)
Specifies the max user profile disk size (in GB).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
IncludeFolderPath (string[])
Specifies the UPD 'Include' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
IncludeFilePath (string[])
Specifies the UPD 'Include' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ExcludeFolderPath (string[])
Specifies the UPD 'Exclude' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ExcludeFilePath (string[])
Specifies the UPD 'Exclude' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
DatastoreSource
Possible values: Template, Selection
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
DatastoreIDs (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
()
The Host Pool Provisioning type
Template ()
RASTemplate ()
()
The Default Power State
RDSObject ()
()
Specifies the 'Allow Client URL/Mail Redirection' option. Accepted
values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app
registration).
PreferredBrokerObj ()
()
File Transfer option. Possible values are: 0 (Disabled), 1 (client to
Server only), 2 {Server To Client only), 3 (Bidirectional).
()
Specifies the mode the client server drag and drop feature will
operate.
()
Manage RDP transport protocol.
()
Specifies the 'Printer Name Format' option. Accepted values:
PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES.
