Citrix Virtual Apps and Desktops SDK

New-BrokerSessionPreLaunch

Creates a new session pre-launch setting for a desktop group.

Syntax

New-BrokerSessionPreLaunch
   -DesktopGroupUid <Int32>
   [-Enabled <Boolean>]
   [-MaxAverageLoadThreshold <Int32>]
   [-MaxLoadPerMachineThreshold <Int32>]
   [-MaxTimeBeforeDisconnect <TimeSpan>]
   [-MaxTimeBeforeTerminate <TimeSpan>]
   [-UserFilterEnabled <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-BrokerSessionPreLaunch
   [-DesktopGroupName] <String>
   [-Enabled <Boolean>]
   [-MaxAverageLoadThreshold <Int32>]
   [-MaxLoadPerMachineThreshold <Int32>]
   [-MaxTimeBeforeDisconnect <TimeSpan>]
   [-MaxTimeBeforeTerminate <TimeSpan>]
   [-UserFilterEnabled <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The New-BrokerSessionPreLaunch cmdlet is used to define a session pre-launch setting for a desktop group.

Note that each desktop group can only have a single session pre-launch setting. Session pre-launch only applies to application sessions.

Examples

EXAMPLE 1

Creates a new session pre-launch setting with a disconnect timer of 30 minutes and terminate timer of 1 hour.

New-BrokerSessionPreLaunch -DesktopGroupName test -Enabled $true -MaxTimeBeforeDisconnect 0:30 -MaxTimeBeforeTerminate 1:00
<!--NeedCopy-->

Parameters

-DesktopGroupName

The name of the desktop group that this pre-launch setting is applied to.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-DesktopGroupUid

The Uid of the desktop group that this pre-launch setting is applied to.

Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Enabled

Boolean that indicates if the new session pre-launch is enabled.

Type: Boolean
Position: Named
Default value: True
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MaxAverageLoadThreshold

Specifies the average load threshold across the desktop group. When the threshold hits, pre-launched sessions across the group be terminated to reduce load. Sessions that have been pre-launched the longest will be chosen first.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MaxLoadPerMachineThreshold

Specifies the maximum load threshold per machine in the desktop group. When the threshold hits, pre-launched sessions on each loaded machine will be terminated to reduce load. Sessions that have been pre-launched the longest will be chosen first.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MaxTimeBeforeDisconnect

Specifies the time by which a pre-launched session will be disconnected. The disconnect timer is optional, but when specified the terminate timer needs to be also set. The disconnect time cannot be greater than the terminate time. When the disconnect and terminate times are the same, the terminate timer takes precedence. The disconnect timer needs to be paired with a session termination condition like the terminate timer or one of load threshold settings.

Type: TimeSpan
Position: Named
Default value: 15 minutes
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MaxTimeBeforeTerminate

Specifies the time by which a pre-launched session will be terminated. The terminate timer is not optional when timers are configured. When the disconnect and terminate times are the same, the terminate timer takes precedence.

Type: TimeSpan
Position: Named
Default value: 8 hours
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserFilterEnabled

Specifies whether the session pre-launch’s user filter is enabled or disabled. Where the user filter is enabled, pre-launch is enabled only to users who appear in the filter (either explicitly or by virtue of group membership).

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

Depends on parameter

Parameters can be piped by property name.

Outputs

Citrix.Broker.Admin.SDK.SessionPreLaunch

New-BrokerSessionPreLaunch returns a session pre-launch object.

New-BrokerSessionPreLaunch