> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rasrdshostpool.md).

# Set-RASRDSHostPool

## SYNOPSIS

Modifies an RD Session Host Pool.

## SYNTAX

```powershell
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>]
```

```powershell
Set-RASRDSHostPool [-InputObject] <RDSHostPool> [-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>]
```

```powershell
Set-RASRDSHostPool [-Name] <string> [[-SiteId] <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

```powershell
Set-RASRDSHostPool "My RD Session Host Pool" -Enabled $False
```

Disables the RD Session Host Pool specified by name.

### Example 2

```powershell
Set-RASRDSHostPool -Id 11 -Enabled $False
```

Disables the RD Session Host Pool specified by ID.

### Example 3

```powershell
Set-RASRDSHostPool $RDSHostPool -Enabled $False
```

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

```powershell
Get-RASRDSHostPool -Id 11 | Set-RASRDSHostPool -Enabled $False
```

Disables the RD Session Host Pool obtained from the pipeline output.

## PARAMETERS

### -Name

The name of the host pool to modify.

```yaml
Type: string
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: uint
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id

The ID of a RD Session Host Pool to modify.

```yaml
Type: uint
Required: True
Position: 0
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -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](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rdshostpool.md)

```yaml
Type: RDSHostPool
Required: True
Position: 0
Default value: None
Accept pipeline input: true (ByValue)
Accept wildcard characters: False
```

### -Enabled

Enable or disable the specified host pool(s) in a site.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -NewName

A new name to assign to the specified host pool.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Description

A description of the specified host pool.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Autoscale

Enable or disable Autoscaling.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Template

The RDSH Template object.

Type reference: [Template](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/template.md)

```yaml
Type: Template
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -TemplateId

The RDSH Template ID.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -TemplateVersionId

The RDSH Template Version ID.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -TemplateTagId

The RDSH Template Tag ID.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MinServersFromTemplate

Min number of servers to be added to the host pool from the RAS Template.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaxServersFromTemplate

Max number of servers to be added to the host pool from the RAS Template.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -HostName

The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DefaultPowerState

The Default Power State

Possible values: PoweredOn, PoweredOff, Suspended

Type reference: [DefaultPowerState](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/defaultpowerstate.md)

```yaml
Type: DefaultPowerState
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WorkLoadThreshold

Send a request to the RAS template when the workload threshold is above the specified value.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ServersToAddPerRequest

Number of servers to be added to the host pool per request.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WorkLoadToDrain

Drain and unassign servers from host pool when workload is below the specified value.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DrainRemainsBelowSec

Drain and unassign servers from host pool when workload remains below the specified level for the below specified time (in seconds).

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -RemoveServersAfterDrainAndPowerOff

Remove servers from host pool after drain and power off.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Port

Specifies the port number for the RD Session Host agent.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaxSessions

Specifies the 'Maximum Sessions' property.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DisconnectActiveSessionAfter

Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LogoffDisconnectedSessionAfter

Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/allowurlandmailredirection.md)

```yaml
Type: AllowURLAndMailRedirection
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SupportShellURLNamespaceObjects

Enable or disable the 'Support Shell URL Namespace Objects' option.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AutoPreferredConnectionBroker

Set the 'Preferred Connection Broker' option to 'Automatically".

```yaml
Type: SwitchParameter
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -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](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/connectionbroker.md)

```yaml
Type: ConnectionBroker
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PreferredConnectionBrokerId

The preferred Connection Broker.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableDriveRedirectionCache

Enable or disable the 'Enable Drive Redirection Cache' option.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DriveRedirectionFileCache

Specifies the 'File Cache' mode to be used with drive redirection.

Possible values: None, ReadAhead, ReadAheadWriteBehind

Type reference: [DriveRedirectionFileCacheMode](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/driveredirectionfilecachemode.md)

```yaml
Type: DriveRedirectionFileCacheMode
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableZOrder

Enable or disable the 'Enable Z-Order' option. (Experimental)

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AllowRemoteExec

Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableAppMonitoring

Enable or disable the 'Application Monitoring' option.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -UseRemoteApps

Enable or disable the 'Use RemoteApps if available' option.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/filetransfercontrolmode.md)

```yaml
Type: FileTransferControlMode
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -FileTransferLocation

Location where the File Transfer takes place, if and where it is allowed.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -FileTransferLockLocation

Lock Location where the File Transfer takes place, if and where it is allowed.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -FileTransferSuppressPromptForUploadFiles

Specifies if the 'Suppress prompt for upload files' option is enabled or disabled.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/filetransferexistingfilemode.md)

```yaml
Type: FileTransferExistingFileMode
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -FileTransferAutoCloseWindow

Specifies if the "Close transfer window when complete" option is enabled or disabled.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DragAndDropMode

Specifies the mode the client server drag and drop feature will operate.

Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional

Type reference: [DragAndDropModeValue](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/draganddropmodevalue.md)

```yaml
Type: DragAndDropModeValue
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ManageRDPTransportProtocol

Manage RDP transport protocol.

Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP

Type reference: [ManageRDPTransportProtocol](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/managerdptransportprotocol.md)

```yaml
Type: ManageRDPTransportProtocol
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/prnnameformat.md)

```yaml
Type: PrnNameFormat
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -RemoveClientNameFromPrinterName

Enable or disable the 'Remove client name from printer name' option.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -RemoveSessionNumberFromPrinterName

Enable or disable the 'Remove session number from printer name' option.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Technology

Specifies the 'User Profile Technology' value.

Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer

Type reference: [UserProfileTech](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/userprofiletech.md)

```yaml
Type: UserProfileTech
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -UPDMode

Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled.

Possible values: DoNotChange, Enabled, Disabled

Type reference: [UPDMode](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/updmode.md)

```yaml
Type: UPDMode
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -UPDRoamingMode

Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include.

Possible values: Exclude, Include

Type reference: [UPDRoamingMode](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/updroamingmode.md)

```yaml
Type: UPDRoamingMode
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -UPDiskPath

Specifies the User Profile Disk path.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaxUserProfileDiskSizeGB

Specifies the max user profile disk size (in GB).

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -IncludeFolderPath

Specifies the UPD 'Include' folder paths.

```yaml
Type: string[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -IncludeFilePath

Specifies the UPD 'Include' file paths.

```yaml
Type: string[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ExcludeFolderPath

Specifies the UPD 'Exclude' folder paths.

```yaml
Type: string[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ExcludeFilePath

Specifies the UPD 'Exclude' file paths.

```yaml
Type: string[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -RestrictDesktopAccess

Enable or disable the 'Restrict direct desktop access to the following users' option.

Use the RestrictedUsers parameter to specify the list of users.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.

```yaml
Type: string[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DatastoreSource

Datastore Source.

Possible values: Template, Selection

Type reference: [DatastoreSourceType](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/datastoresourcetype.md)

```yaml
Type: DatastoreSourceType
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DatastoreIDs

Datastore IDs.

```yaml
Type: string[]
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OverrideStorage

Specifications: Whether Override Storage is Enabled or not. (Override Storage)

Available to Azure/AWS

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OverrideSize

Whether Override Size is Enabled or not.

Available when host pool is templated from AWS or Azure.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VMSize

VMSize which will override the size specified in template properties.

Available when host pool is templated from AWS or Azure.

Example: Standard\_B2s

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OverrideDomainOrgUnit

Whether Override Domain Org Unit is enabled or not. (OverrideDomainOrgUnit)

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DomainOrgUnit

Domain Organization unit

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OverrideCluster

Specifications: Whether Override Cluster is Enabled or not.

Available when host pool is templated from NutanixPC.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClusterName

Specifications: Cluster name where desktop VMs will be created.

Available when host pool is templated from NutanixPC.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClusterId

Specifications: The ID of a cluster where desktop VMs will be created.

Available when host pool is templated from NutanixPC.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OverrideNetwork

Specifications: Whether Override Network is Enabled or not.

Available when host pool is templated from NutanixPC or AWS.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SubnetId

Specifications: Subnet Id.

Available when host pool is templated from NutanixPC.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SubnetName

Specifications: Subnet name.

Available when host pool is templated from NutanixPC.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AWSSubnetsIds

Specifications: Add or remove Amazon Web Service Subnets.

Available when host pool is templated from AWS.

```yaml
Type: List`1
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### 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](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### [RDSHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rdshostpool.md)

## OUTPUTS

### None

## RELATED LINKS

* [New-RASRDSHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-rasrdshostpool.md)
* [Get-RASRDSHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasrdshostpool.md)
* [Remove-RASRDSHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rasrdshostpool.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rasrdshostpool.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
