commands

^

Get-DbaXEObject

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

 

Synopsis

Gets a list of extended events objects exposed by event packages from specified SQL Server instance(s).

Description

This function returns a list of extended events objects exposed by event packages from specified SQL Server instance(s).

Syntax

Get-DbaXEObject
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Type] <String[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaXEObject -SqlInstance sql2016

Lists all the XE Objects on the sql2016 SQL Server.

Example: 2
PS C:\> Get-DbaXEObject -SqlInstance sql2017 -Type Action, Event

Lists all the XE Objects of type Action and Event on the sql2017 SQL Server.

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

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
-Type

Used to specify the type. Valid types include: Action Event Map Message PredicateComparator PredicateSource Target Type

Alias
Required False
Pipeline false
Default Value
Accepted Values Type,Event,Target,Action,Map,Message,PredicateComparator,PredicateSource
-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-DbaXEObject on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaXEObject.