commands

^

Get-DbaXESessionTarget

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Get a list of Extended Events Session Targets from the specified SQL Server instance(s).

Description

Retrieves a list of Extended Events Session Targets from the specified SQL Server instance(s).

Syntax

Get-DbaXESessionTarget
    [-SqlCredential <PSCredential>]
    [-Session <String[]>]
    [-Target <String[]>]
    [-EnableException]
    [<CommonParameters>]

Get-DbaXESessionTarget -SqlInstance <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    [-Session <String[]>]
    [-Target <String[]>]
    [-EnableException]
    [<CommonParameters>]

Get-DbaXESessionTarget
    [-SqlCredential <PSCredential>]
    [-Session <String[]>]
    [-Target <String[]>] -InputObject <Session[]>
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaXESessionTarget -SqlInstance ServerA\sql987 -Session system_health

Shows targets for the system_health session on ServerA\sql987.

Example: 2
PS C:\> Get-DbaXESession -SqlInstance sql2016 -Session system_health | Get-DbaXESessionTarget

Returns the targets for the system_health session on sql2016.

Example: 3
PS C:\> Get-DbaXESession -SqlInstance sql2016 -Session system_health | Get-DbaXESessionTarget -Target package0.event_file

Return only the package0.event_file target for the system_health session on sql2016.

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.

Alias
Required True
Pipeline true (ByValue)
Default Value
-InputObject

Specifies an XE session returned by Get-DbaXESession to search.

Alias
Required True
Pipeline true (ByValue)
Default Value

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.

Alias
Required False
Pipeline false
Default Value
-Session

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

Alias
Required False
Pipeline false
Default Value
-Target

Only return a specific target.

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

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