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

Start-BrokerSessionRecording

August 3, 2023
Contributed by: 
C

Starts recording the specified session(s).

Syntax


Start-BrokerSessionRecording [-Sessions] <Session[]> [-NotifyUser <Boolean>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Start-BrokerSessionRecording [-User] <User> [-NotifyUser <Boolean>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Starts recording the specified session(s).

Only active sessions using the HDX protocol can be recorded. An error appears when unqualified sessions (non-existent, inactive, or non-HDX) are specified for recording. No warning appears when you trigger an action to record sessions that are already being recorded.

Parameters

Name Description Required? Pipeline Input Default Value
Sessions Specifies the session(s) to be recorded. true true (ByValue)  
User Specifies the user whose session is to be recorded. true true (ByValue)  
NotifyUser Determines whether to notify the end user of the recording activity. false false true
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. 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

Citrix.Broker.Admin.Sdk.Session

The session(s) to be recorded.

Citrix.Broker.Admin.Sdk.User

The user whose sessions are to be recorded.

Return Values

None

Notes

Sessions can be passed using the Sessions parameter as session objects or session Uids. A user can be passed using the User parameter as a user object or a user name. This operation is non-blocking and returns before it completes. The operation, however, is unlikely to fail unless there are communication problems between the Delivery Controller and the VDA, or if bad arguments are passed to the cmdlet itself, or if the VDA cannot successfully execute the operation. The Delivery Controller can fail to invoke the operation if the VDA is not in an appropriate state or if there are problems with communicating with the VDA. When an operation is invoked, the Delivery Controller detects and reports whether the operation is initiated successfully on the VDA. However, because the operation is non-blocking, the Delivery Controller does not detect or report whether or not the operation ultimately succeeds after the operation is initiated successfully. Operation failures are reported through the Broker SDK error handling mechanism (see about_Broker_ErrorHandling). In the event of errors, the SdkErrorRecord error status code is set to SessionOperationFailed and its error data dictionary is populated with the following entries: o OperationsAttemptedCount: The number of operations attempted. o OperationsFailedCount - The number of failed operations. o OperationsSucceededCount - The number of successful operations. The SdkErrorRecord message displays the number of attempted, failed, and successful operations in the following format: “Session operation error - attempted:<OperationsAttemptedCount>, failed:<OperationsFailedCount>, succeeded:<OperationsSucceededCount>”

Examples

Example 1 


C:\PS> Start-BrokerSessionRecording -Sessions 10,11,12 -NotifyUser 0

<!--NeedCopy-->

Description

Starts recording the session Uid 10,11,12 without notifying the user.

Example 2 


C:\PS> Start-BrokerSessionRecording -User MYDOMAIN\Geffrey –NotifyUser 1

<!--NeedCopy-->

Description

Starts recording all sessions of user Geffrey in the domain named MYDOMAIN and notifies user Geffrey.

Start-BrokerSessionRecording
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.