Get-DbaXESession

Want to see the source code for this command? Check out Get-DbaXESession on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaXESession.

Synopsis

Gets a list of Extended Events Sessions from the specified SQL Server instance(s).

Description

Retrieves a list of Extended Events Sessions present on the specified SQL Server instance(s).

Syntax

Get-DbaXESession
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Session] <Object[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaXESession -SqlInstance ServerA\sql987

Returns a custom object with ComputerName, SQLInstance, Session, StartTime, Status and other properties.

Example: 2

PS C:\> Get-DbaXESession -SqlInstance ServerA\sql987 | Format-Table ComputerName, SqlInstance, Session, Status -AutoSize

Returns a formatted table displaying ComputerName, SqlInstance, Session, and Status.

Example: 3

PS C:\> 'ServerA\sql987','ServerB' | Get-DbaXESession

Returns a custom object with ComputerName, SqlInstance, Session, StartTime, Status and other properties, from multiple SQL instances.

Required Parameters

-SqlInstance

The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2008 or higher.

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Session

Only return specific sessions. Options for this parameter are auto-populated from the server.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.