Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-Brokersessionprelaunch

August 3, 2023
Contributed by: 
C

Gets one or more session pre-launch settings.

Syntax

Get-BrokerSessionPreLaunch [-DesktopGroupUid] <Int32> [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Get-BrokerSessionPreLaunch [[-DesktopGroupName] <String>] [-AssociatedUserFullName <String>] [-AssociatedUserName <String>] [-AssociatedUserSID <String>] [-AssociatedUserUPN <String>] [-Enabled <Boolean>] [-MaxAverageLoadThreshold <Int32>] [-MaxLoadPerMachineThreshold <Int32>] [-MaxTimeBeforeDisconnect <TimeSpan>] [-MaxTimeBeforeTerminate <TimeSpan>] [-UserFilterEnabled <Boolean>] [-UserSID <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Get-BrokerSessionPreLaunch cmdlet is used to enumerate desktop group session pre-launch settings that match all of the supplied criteria.

Without parameters, Get-BrokerSessionPreLaunch gets all the session pre-launch settings that have been created. You can also use the parameters of Get-BrokerSessionPreLaunch to filter the results to just the desktop group you’re interested in.

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

See about_Broker_Filtering for information about advanced filtering options.

Brokersessionprelaunch Object

The session pre-launch object returned represents a session pre-launch setting in a desktop group.

  • AssociatedUserFullNames (System.String[]) List of associated users (full names). Associated users is the list of users who are given access using the pre-launch/user mapping filter.

  • AssociatedUserNames (System.String[]) List of associated users (SAM names). Associated users is the list of users who are given access using the pre-launch/user mapping filter.

  • AssociatedUserSIDs (System.String[]) List of associated users (SIDs). Associated users is the list of users who are given access using the pre-launch/user mapping filter.

  • AssociatedUserUPNs (System.String[]) List of associated users (user principle names). Associated users is the list of users who are given access using the pre-launch/user mapping filter.

  • DesktopGroupName (System.String) Name of the associated desktop group.

  • DesktopGroupUid (System.Int32) Uid of the associated desktop group.

  • Enabled (System.Boolean) Specifies whether or not session pre-launch is enabled for the desktop group.

  • MaxAverageLoadThreshold (System.Int32) Specifies the average load threshold across the desktop group. After this threshold is hit pre-launched sessions will be terminated to reduce average load across the group. Sessions that have been pre-launched the longest will be chosen first.

  • MaxLoadPerMachineThreshold (System.Int32) Specifies the maximum load threshold per machine in the desktop group. After this threshold is hit pre-launched sessions on loaded machines will be terminated to reduce load. Sessions that have been pre-launched the longest will be chosen first.

  • MaxTimeBeforeDisconnect (System.TimeSpan) Specifies the maximum time by when a pre-launched session will be disconnected. The disconnect timer cannot be greater than the terminate timer. When the disconnect timer is same as the terminate timer, the session will be directly be terminated. The default value is 15 minutes. A value of 0 disables the disconnect timer.

  • MaxTimeBeforeTerminate (System.TimeSpan) Specifies the maximum time by when a pre-launched session will be terminated. When the disconnect timer is same as the terminate timer, the session will be directly be terminated. The default value is 8 hours. A value of 0 disables the terminate timer.

  • UserFilterEnabled (System.Boolean) Indicates if pre-launch-specific user filter is enabled.

Parameters

Name Description Required? Pipeline Input Default Value
DesktopGroupUid Gets session pre-launch setting that is associated with the specified desktop group Uid. true false  
DesktopGroupName Gets session pre-launch setting that is associated with the specified desktop group name. false false  
AssociatedUserFullName Gets session pre-launch settings with an associated user identified by their full name (usually ‘first-name last-name’). If the ‘UserFilterEnabled’ property is true then access to the session pre-launch is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules). false false  
AssociatedUserName Gets session pre-launch settings with an associated user identified by their user name (in the form ‘domain\user’). If the ‘UserFilterEnabled’ property is true then access to the session pre-launch is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules). false false  
AssociatedUserSID Gets session pre-launch settings with an associated user identified by their Windows SID. If the ‘UserFilterEnabled’ property is true then access to the session pre-launch is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules). false false  
AssociatedUserUPN Gets session pre-launch settings with an associated user identified by their user principle name (in the form ‘user@domain’). If the ‘UserFilterEnabled’ property is true then access to the session pre-launch is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules). false false  
Enabled Gets only the session pre-launch settings that have the specified value for whether the setting is enabled. false false  
MaxAverageLoadThreshold Gets only the session pre-launch settings that have the specified average load threshold. false false  
MaxLoadPerMachineThreshold Gets only the session pre-launch settings that have the specified maximum load threshold per machine. false false  
MaxTimeBeforeDisconnect Gets only the session pre-launch settings that have the specified idle disconnect time. false false  
MaxTimeBeforeTerminate Gets only the session pre-launch settings that have the specified idle terminate time. false false  
UserFilterEnabled Gets only session pre-launch settings whose user filter is in the specified state. false false  
UserSID Gets only session pre-launch settings with their accessibility restricted to include the specified user. false false  
ReturnTotalRecordCount When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
SortBy Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
Property Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server. false false  
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Sessionprelaunch

Get-BrokerSessionPreLaunch returns an object for each session pre-launch setting it gets.

Examples

Example 1 

C:\PS> Get-BrokerSessionPreLaunch -DesktopGroupName "test"
<!--NeedCopy-->

Description

Returns the session pre-launch settings associated with the destkop group named ‘test’.

Get-Brokersessionprelaunch
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.