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

Stop-BrokerSession

August 9, 2024
Contributed by: 
C

Stop or log off a session.

Syntax

Stop-BrokerSession
    [-InputObject] <Session[]>
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Stops or logs off sessions.

Examples

EXAMPLE 1

Stops all sessions for the user MyDomain\MyAccount.

Get-BrokerSession -UserName MyDomain\MyAccount | Stop-BrokerSession
<!--NeedCopy-->

EXAMPLE 2

Stops the session on MyMachine.

$desktop = Get-BrokerDesktop -DNSName MyMachine.MyDomain.com
Stop-BrokerSession $desktop.SessionUid
<!--NeedCopy-->

EXAMPLE 3

Stop sessions that have been disconnected for more than one day.

Get-BrokerSession -Filter { SessionState -eq 'Disconnected' -and SessionStateChangeTime -lt '-1' } | Stop-BrokerSession
<!--NeedCopy-->

EXAMPLE 4

Trap and display error information.

trap  [Citrix.Broker.Admin.SDK.SdkOperationException]
{
  write $("Exception name = " + $_.Exception.GetType().FullName)
  write $("SdkOperationException.Status = " + $_.Exception.Status)
  write $("SdkOperationException.ErrorData=")
  $_.Exception.ErrorData

  write $("SdkOperationException.InnerException = " + $_.Exception.InnerException)
  $_.Exception.InnerException
  continue
}

Stop-BrokerSession -InputObject 10,11,12
<!--NeedCopy-->

Parameters

-InputObject

Identifies the session(s) to terminate. This can be expressed as either a session Uid or a session object.

Type: Session[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
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

Citrix.Broker.Admin.SDK.Session

The sessions to stop can be piped into this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Notes

This operation is non-blocking and returns before it completes. The operation, however, is unlikely to fail unless there are communication problems between the controller and the machine, if bad arguments are passed to the cmdlet itself or if the machine cannot successfully execute the operation.

The transient nature of sessions means that the list of session objects or UIDs supplied to Stop-BrokerSession could consist of valid and invalid sessions. Invalid sessions are detected and disregarded and the stop session operation is invoked on the valid sessions.

The system can fail to invoke the operation if the machine is not in an appropriate state or if there are problems in communicating with the machine. When an operation is invoked the system detects if the operation was initiated successfully or not by the machine. As this operation is non-blocking the system doesn’t detect or report whether the operation ultimately succeeded or failed after its successful initialization on the machine.

Operation failures are reported through the broker SDK error handling mechanism (see about_Broker_ErrorHandling). In the event of errors the SdkErrorRecord error status is set to SessionOperationFailed and its error data dictionary is populated with the following entries:

  • OperationsAttemptedCount - The number of operations attempted.
  • OperationsFailedCount - The number of failed operations.
  • OperationsSucceededCount - The number of successfully executed operations.
  • UnresolvedSessionFailuresCount - The number of operations that failed due to invalid sessions being supplied.
  • OperationInvocationFailuresCount - The number of operations that failed because they could not be invoked on the desktop.
  • DesktopExecutionFailuresCount - The number of operations that failed because they could not be successfully executed by the desktop.

The SdkErrorRecord message will also display the number of attempted, failed and successful operations in the following format:

“Session operation error - attempted:<OperationsAttemptedCount>, failed:<OperationsFailedCount>, succeeded:<OperationsSucceededCount>”

Stop-BrokerSession
August 9, 2024
Contributed by: 
C
August 9, 2024
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.