> 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-rasavdhostpool.md).

# Set-RASAVDHostPool

## SYNOPSIS

Modifies a Azure Virtual Desktop Host Pool.

## SYNTAX

```powershell
Set-RASAVDHostPool [-Id] <uint> [-AllowRemoteExec <bool>]
 [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}]
 [-AutoScaleEnabled <bool>] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}]
 [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>]
 [-DisconnectActiveSessionAfter <uint>] [-DomainOrgUnit <string>]
 [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
 [-DrainRemains <uint>] [-DriveRedirectionFileCache {None | ReadAhead | ReadAheadWriteBehind}]
 [-Duration <uint>] [-EnableAppMonitoring <bool>] [-Enabled <bool>]
 [-EnableDriveRedirectionCache <bool>] [-EnableSchedule2 <bool>] [-EnableZOrder <bool>]
 [-FileTransferAutoCloseWindow <bool>]
 [-FileTransferExistingFileMode {CreateNewFile | OverwriteExistingFile}]
 [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>]
 [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
 [-FileTransferSuppressPromptForUploadFiles <bool>] [-FriendlyName <string>] [-HostName <string>]
 [-HybridHostPoolId <uint>] [-InheritDefaultActionsSettings <bool>]
 [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>]
 [-InheritDefaultAutoUpgradeSettings <bool>] [-InheritDefaultOptimizationSettings <bool>]
 [-InheritDefaultRDPPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>]
 [-LimitHosts <uint>] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}]
 [-LocalSessionTimeZone <bool>] [-LogoffDisconnectedSessionAfter <uint>]
 [-ManageRDPShortpath <bool>]
 [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxHosts <uint>]
 [-MaxRDPShortpathPort <uint>] [-MaxServersFromTemplate <uint>] [-MinRDPShortpathPort <uint>]
 [-MinServersFromTemplate <uint>] [-OverrideDomainOrgUnit <bool>] [-OverrideSize <bool>]
 [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}]
 [-PerformActionAfterSec <uint>] [-PowerOnHost <bool>] [-PreCreatedHosts <uint>]
 [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}]
 [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>]
 [-RemoveSessionNumberFromPrinterName <bool>] [-ScheduleAgentUpdates <bool>]
 [-ScheduleDay1 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
 [-ScheduleDay2 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
 [-ScheduleTime1 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}]
 [-ScheduleTime2 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}]
 [-ServersToAddPerRequest <uint>] [-SessionAction {Disconnect | Logoff}]
 [-SessionReadinessTimeout <uint>] [-SupportShellURLNamespaceObjects <bool>]
 [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-TemplateId <uint>]
 [-TemplateTagId <uint>] [-TemplateVersionId <uint>] [-TimeZoneId <string>]
 [-UseRDPShortpath <bool>] [-UseSmallerPortRange <bool>] [-ValidationEnvironment <bool>]
 [-VMSize <string>] [-WorkLoadDrain <uint>] [-WorkloadThreshold <uint>] [<CommonParameters>]
```

```powershell
Set-RASAVDHostPool [-InputObject] <AVDHostPool> [-AllowRemoteExec <bool>]
 [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}]
 [-AutoScaleEnabled <bool>] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}]
 [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>]
 [-DisconnectActiveSessionAfter <uint>] [-DomainOrgUnit <string>]
 [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
 [-DrainRemains <uint>] [-DriveRedirectionFileCache {None | ReadAhead | ReadAheadWriteBehind}]
 [-Duration <uint>] [-EnableAppMonitoring <bool>] [-Enabled <bool>]
 [-EnableDriveRedirectionCache <bool>] [-EnableSchedule2 <bool>] [-EnableZOrder <bool>]
 [-FileTransferAutoCloseWindow <bool>]
 [-FileTransferExistingFileMode {CreateNewFile | OverwriteExistingFile}]
 [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>]
 [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
 [-FileTransferSuppressPromptForUploadFiles <bool>] [-FriendlyName <string>] [-HostName <string>]
 [-HybridHostPoolId <uint>] [-InheritDefaultActionsSettings <bool>]
 [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>]
 [-InheritDefaultAutoUpgradeSettings <bool>] [-InheritDefaultOptimizationSettings <bool>]
 [-InheritDefaultRDPPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>]
 [-LimitHosts <uint>] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}]
 [-LocalSessionTimeZone <bool>] [-LogoffDisconnectedSessionAfter <uint>]
 [-ManageRDPShortpath <bool>]
 [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxHosts <uint>]
 [-MaxRDPShortpathPort <uint>] [-MaxServersFromTemplate <uint>] [-MinRDPShortpathPort <uint>]
 [-MinServersFromTemplate <uint>] [-OverrideDomainOrgUnit <bool>] [-OverrideSize <bool>]
 [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}]
 [-PerformActionAfterSec <uint>] [-PowerOnHost <bool>] [-PreCreatedHosts <uint>]
 [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}]
 [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>]
 [-RemoveSessionNumberFromPrinterName <bool>] [-ScheduleAgentUpdates <bool>]
 [-ScheduleDay1 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
 [-ScheduleDay2 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
 [-ScheduleTime1 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}]
 [-ScheduleTime2 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}]
 [-ServersToAddPerRequest <uint>] [-SessionAction {Disconnect | Logoff}]
 [-SessionReadinessTimeout <uint>] [-SupportShellURLNamespaceObjects <bool>]
 [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-TemplateId <uint>]
 [-TemplateTagId <uint>] [-TemplateVersionId <uint>] [-TimeZoneId <string>]
 [-UseRDPShortpath <bool>] [-UseSmallerPortRange <bool>] [-ValidationEnvironment <bool>]
 [-VMSize <string>] [-WorkLoadDrain <uint>] [-WorkloadThreshold <uint>] [<CommonParameters>]
```

```powershell
Set-RASAVDHostPool [-Name] <string> [[-SiteId] <uint>] [-AllowRemoteExec <bool>]
 [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}]
 [-AutoScaleEnabled <bool>] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}]
 [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>]
 [-DisconnectActiveSessionAfter <uint>] [-DomainOrgUnit <string>]
 [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
 [-DrainRemains <uint>] [-DriveRedirectionFileCache {None | ReadAhead | ReadAheadWriteBehind}]
 [-Duration <uint>] [-EnableAppMonitoring <bool>] [-Enabled <bool>]
 [-EnableDriveRedirectionCache <bool>] [-EnableSchedule2 <bool>] [-EnableZOrder <bool>]
 [-FileTransferAutoCloseWindow <bool>]
 [-FileTransferExistingFileMode {CreateNewFile | OverwriteExistingFile}]
 [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>]
 [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}]
 [-FileTransferSuppressPromptForUploadFiles <bool>] [-FriendlyName <string>] [-HostName <string>]
 [-HybridHostPoolId <uint>] [-InheritDefaultActionsSettings <bool>]
 [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>]
 [-InheritDefaultAutoUpgradeSettings <bool>] [-InheritDefaultOptimizationSettings <bool>]
 [-InheritDefaultRDPPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>]
 [-LimitHosts <uint>] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}]
 [-LocalSessionTimeZone <bool>] [-LogoffDisconnectedSessionAfter <uint>]
 [-ManageRDPShortpath <bool>]
 [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxHosts <uint>]
 [-MaxRDPShortpathPort <uint>] [-MaxServersFromTemplate <uint>] [-MinRDPShortpathPort <uint>]
 [-MinServersFromTemplate <uint>] [-OverrideDomainOrgUnit <bool>] [-OverrideSize <bool>]
 [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}]
 [-PerformActionAfterSec <uint>] [-PowerOnHost <bool>] [-PreCreatedHosts <uint>]
 [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}]
 [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>]
 [-RemoveSessionNumberFromPrinterName <bool>] [-ScheduleAgentUpdates <bool>]
 [-ScheduleDay1 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
 [-ScheduleDay2 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
 [-ScheduleTime1 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}]
 [-ScheduleTime2 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}]
 [-ServersToAddPerRequest <uint>] [-SessionAction {Disconnect | Logoff}]
 [-SessionReadinessTimeout <uint>] [-SupportShellURLNamespaceObjects <bool>]
 [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-TemplateId <uint>]
 [-TemplateTagId <uint>] [-TemplateVersionId <uint>] [-TimeZoneId <string>]
 [-UseRDPShortpath <bool>] [-UseSmallerPortRange <bool>] [-ValidationEnvironment <bool>]
 [-VMSize <string>] [-WorkLoadDrain <uint>] [-WorkloadThreshold <uint>] [<CommonParameters>]
```

## DESCRIPTION

Modifies properties of a Azure Virtual Desktop Host Pool.

## EXAMPLES

### Example 1

```powershell
Set-RASAVDHostPool -Id 1 -NewName NewHostPool
```

Modifies the name of the AVD Host Pool with Id 1.

### Example 2

```powershell
Set-RASAVDHostPool -Name "AVDHostPoolName" -NewName NewHostPool
```

Modifies the name of the AVD Host Pool with Name AVDHostPoolName.

## PARAMETERS

### -Id

ID for which to modify the Azure Virtual Desktop Host Pool settings.

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

### -Name

The name of the target Azure Virtual Desktop Host Pool settings.

This must be the actual Azure Virtual Desktop Host Pool name used in the RAS farm.

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

### -SiteId

Site ID in which to modify the specified Azure Virtual Desktop Host Pool settings .

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

### -InputObject

An AVD Host Pool object (an object of type AVDHostPool) to modify.

An AVDHostPool object representing a host pool is obtained using the Get-RASAVDHostPool cmdlet.

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

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

### -FriendlyName

The new Friendly Name of the Azure Virtual Desktop Host Pool settings.

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

### -Description

The new description of the Azure Virtual Desktop Host Pool settings.

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

### -Enabled

Enable or disable the specified AVD Host Pool in a site.

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

### -PowerOnHost

Whether Power On Host is Enabled or not.

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

### -ValidationEnvironment

Whether Validation Environment is Enabled or not.

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

### -LimitHosts

The Limit of session on host.

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

### -DefaultLicenseType

The license type.

Possible values: DoNotConfigure, WindowsClient, WindowsServer

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

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

### -LoadBalancerType

The Load Balancer Type of the Host Pool

Possible values: BreadthFirst, DepthFirst, Persistent

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

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

### -TemplateId

The Template ID.

Available to Templated Host Pools

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

### -TemplateVersionId

The Template Version ID.

Available to Templated Host Pools

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

### -TemplateTagId

The Template Tag ID.

Available to Templated Host Pools

```yaml
Type: uint
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
```

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

### -SessionReadinessTimeout

Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.

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

### -AllowRemoteExec

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

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

### -AllowURLAndMailRedirection

Specifies the 'Allow Client URL/Mail Redirection'.

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

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

```yaml
Type: bool
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
```

### -DragAndDropMode

Specifies the mode the 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
```

### -FileTransferMode

Specifies if File Transfer option is allowed and if yes, which directions are allowed.

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

### -EnableDriveRedirectionCache

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

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

Specifies if the 'Enable Z-Order' option is enabled or disabled. (Experimental)

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

### -SessionAction

Session Action

Possible values: Disconnect, Logoff

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

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

### -PerformAction

Perform Action

Possible values: DoNothing, Shutdown, Suspend, Delete, Restart, Unassign, Recreate

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

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

### -PerformActionAfterSec

Perform action after (in seconds)

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

### -MaxHosts

The maximum number of hosts that can be created from the template.

Available to Templated Personal Host Pools

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

### -PreCreatedHosts

The maximum number of pre-created hosts. (Keep available buffer)

Available to Templated Personal Host Pools

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

### -Duration

The duration (in seconds) before the unused hosts are deleted (0 = Never)

Available to Templated Personal Host Pools

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

### -AutoScaleEnabled

Whether AutoScale is Enabled or not.

Available to Templated Pooled Host Pools

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

### -MinServersFromTemplate

The Minimum Number of Hosts added to the template.

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

### -MaxServersFromTemplate

The Maximum Number of Hosts added to the template.

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

### -WorkloadThreshold

The Workload Threshold.

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

### -ServersToAddPerRequest

The amount of servers to add per request.

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

### -WorkLoadDrain

The Drain Workload.

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

### -DrainRemains

The Remaining Drain level.

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

### -RemoveServersAfterDrainAndPowerOff

Remove hosts 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
```

### -HostName

The Host Name Format. All Host Names must adhere to this format : '{text}-%ID:{number}%'

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

### -OverrideSize

Whether Override Size is Enabled or not.

Available to Templated Host Pools

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

Example: Standard\_B2s

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

### -OverrideDomainOrgUnit

Specifications: 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
```

### -PrinterNameFormat

Specifies the 'Printer Name Format' option.

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

### -RemoveSessionNumberFromPrinterName

Specifies if 'Remove session number from printer name' option is enabled or disabled.

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

### -RemoveClientNameFromPrinterName

Specifies if 'Remove client name from printer name' option is enabled or disabled.

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

### -EnableAppMonitoring

Specifies if 'Enable applications monitoring' option is enabled or disabled.

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

### -ManageRDPShortpath

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

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

### -UseRDPShortpath

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

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

### -UseSmallerPortRange

Specifies if 'Use Smaller Port' option is enabled or disabled.

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

### -MinRDPShortpathPort

The minimum RDP Shortpath Port.

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

### -MaxRDPShortpathPort

The maximum RDP Shortpath Port.

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

### -InheritDefaultAgentSettings

If true, default AVD Agent settings will be inherited.

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

### -InheritDefaultUserProfileSettings

If true, default User Profile settings will be inherited.

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

### -InheritDefaultAppPackageSettings

If true, default Application Package settings will be inherited.

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

### -InheritDefaultOptimizationSettings

If true, default Optimization settings will be inherited.

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

### -InheritDefaultActionsSettings

If true, default Action settings will be inherited.

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

### -InheritDefaultRDPPrinterSettings

If true, default Printing settings will be inherited.

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

### -InheritDefaultAutoUpgradeSettings

If true, default Auto-upgrade settings will be inherited.

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

### -ScheduleAgentUpdates

Whether to enable schedule agent updates.

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

### -LocalSessionTimeZone

Whether to use the local session time zone or not.

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

### -TimeZoneId

The Selected Time Zone Name

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

### -ScheduleDay1

The First Schedule Day

Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

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

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

### -ScheduleTime1

The First Schedule Time

Possible values: h00, h01, h02, h03, h04, h05, h06, h07, h08, h09, h10, h11, h12, h13, h14, h15, h16, h17, h18, h19, h20, h21, h22, h23

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

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

### -EnableSchedule2

Whether to enable a second schedule.

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

### -ScheduleDay2

The Second Schedule Day

Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

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

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

### -ScheduleTime2

The Second Schedule Time

Possible values: h00, h01, h02, h03, h04, h05, h06, h07, h08, h09, h10, h11, h12, h13, h14, h15, h16, h17, h18, h19, h20, h21, h22, h23

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

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

### -HybridHostPoolId

On-premises host pool ID to link when deploy location is Hybrid.

```yaml
Type: uint
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

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

## OUTPUTS

### None

## RELATED LINKS

* [Get-RASAVDHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasavdhostpool.md)
* [New-RASAVDHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-rasavdhostpool.md)
* [Remove-RASAVDHostPool](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rasavdhostpool.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-rasavdhostpool.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.
