Citrix Virtual Apps and Desktops SDK

New-BrokerExtendedTraceCapture

January 13, 2026

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2511

Start a new extended trace capture session.

Syntax

New-BrokerExtendedTraceCapture
   [-DurationMins] <Int32>
   -UserName <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The New-BrokerExtendedTraceCapture cmdlet starts a period

of time during which more verbose logging is collected. When the time expires

the BrokerExtendedTraceCapture object is deleted automatically.

Examples

EXAMPLE 1

Starts a new extended trace capture session for the next 10 minutes associated with the user “user1”.

New-BrokerExtendedTraceCapture -DurationMins 10 -UserName "user1"
<!--NeedCopy-->

Parameters

-DurationMins

Length of time in minutes to capture the logs.

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

-UserName

User name associated with the capture session.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	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.

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, -SkipCertificateValidation, -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

None

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.ExtendedTraceCapture

Returns the newly created capture session

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-BrokerExtendedTraceCapture

January 13, 2026

Contributed by:

January 13, 2026

Contributed by:

New-BrokerExtendedTraceCapture

Syntax

Description

Examples

EXAMPLE 1

Parameters

-DurationMins

-UserName

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.ExtendedTraceCapture

Related Links

In this article