Set-RASRDSHostPool
SYNOPSIS
Modifies an RD Session Host Pool.
SYNTAX
Set-RASRDSHostPool [-Id] <uint> [-AllowRemoteExec <bool>]
[-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}]
[-AutoPreferredConnectionBroker <SwitchParameter>] [-Autoscale <bool>] [-AWSSubnetsIds <List`1>]
[-ClusterId <string>] [-ClusterName <string>] [-DatastoreIDs <string[]>]
[-DatastoreSource {Template | Selection}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}]
[-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DomainOrgUnit <string>]
[-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
[-DrainRemainsBelowSec <uint>]
[-DriveRedirectionFileCache {None | ReadAhead | ReadAheadWriteBehind}]
[-EnableAppMonitoring <bool>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>]
[-EnableZOrder <bool>] [-ExcludeFilePath <string[]>] [-ExcludeFolderPath <string[]>]
[-FileTransferAutoCloseWindow <bool>]
[-FileTransferExistingFileMode {CreateNewFile | OverwriteExistingFile}]
[-FileTransferLocation <string>] [-FileTransferLockLocation <bool>]
[-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
[-FileTransferSuppressPromptForUploadFiles <bool>] [-HostName <string>]
[-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>] [-NewName <string>] [-OverrideCluster <bool>]
[-OverrideDomainOrgUnit <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}]
[-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>]
[-RemoveSessionNumberFromPrinterName <bool>] [-RestrictDesktopAccess <bool>]
[-RestrictedUsers <string[]>] [-ServersToAddPerRequest <uint>] [-SubnetId <string>]
[-SubnetName <string>] [-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>] [-VMSize <string>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>]
[<CommonParameters>]DESCRIPTION
Modifies properties of an RD Session Host Pool.
EXAMPLES
Example 1
Disables the RD Session Host Pool specified by name.
Example 2
Disables the RD Session Host Pool specified by ID.
Example 3
Disables the RD Session Host Pool specified by the $RDSHostPool variable (an object of type RDSHostPool).
To obtain an RDSHostPool object representing a host pool, use the Get-RASRDSHostPool cmdlet.
Example 4
Disables the RD Session Host Pool obtained from the pipeline output.
PARAMETERS
-Name
The name of the host pool to modify.
-SiteId
Site ID where the target host pool is located.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-Id
The ID of a RD Session Host Pool to modify.
-InputObject
A RD Session Host Pool object (an object of type RDSHostPool) to modify.
A RDSHostPool object representing a group is obtained using the Get-RASRDSHostPool cmdlet.
Type reference: RDSHostPool
-Enabled
Enable or disable the specified host pool(s) in a site.
-NewName
A new name to assign to the specified host pool.
-Description
A description of the specified host pool.
-Autoscale
Enable or disable Autoscaling.
-Template
The RDSH 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.
-MaxServersFromTemplate
Max number of servers to be added to the host pool from the RAS Template.
-HostName
The VM name format. All VMs 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
-WorkLoadThreshold
Send a request to the RAS template when the workload threshold is above the specified value.
-ServersToAddPerRequest
Number of servers to be added to the host pool per request.
-WorkLoadToDrain
Drain and unassign servers from host pool when workload is below the specified value.
-DrainRemainsBelowSec
Drain and unassign servers from host pool when workload remains below the specified level for the below specified time (in seconds).
-RemoveServersAfterDrainAndPowerOff
Remove servers from host pool after drain and power off.
-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.
-AutoPreferredConnectionBroker
Set the 'Preferred Connection Broker' option to 'Automatically".
-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.
-EnableDriveRedirectionCache
Enable or disable the 'Enable Drive Redirection Cache' option.
-DriveRedirectionFileCache
Specifies the 'File Cache' mode to be used with drive redirection.
Possible values: None, ReadAhead, ReadAheadWriteBehind
Type reference: DriveRedirectionFileCacheMode
-EnableZOrder
Enable or disable the 'Enable Z-Order' option. (Experimental)
-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
Whether Override Size is Enabled or not.
Available when host pool is templated from AWS or Azure.
-VMSize
VMSize which will override the size specified in template properties.
Available when host pool is templated from AWS or Azure.
Example: Standard_B2s
-OverrideDomainOrgUnit
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.
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
RDSHostPool
OUTPUTS
None
RELATED LINKS
Last updated