< Back
Get-DbaXEObject
Post
NAME Get-DbaXEObject
SYNOPSIS
Gets a list of extended events objects exposed by event packages from specified SQL Server instance(s).
SYNTAX
Get-DbaXEObject [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Type] <System.String[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
This function returns a list of extended events objects exposed by event packages from specified SQL Server
instance(s).
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2008 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<System.String[]>]
Used to specify the type. Valid types include:
Action
Event
Map
Message
PredicateComparator
PredicateSource
Target
Type
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: ExtendedEvent, XE, XEvent
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
SYNOPSIS
Gets a list of extended events objects exposed by event packages from specified SQL Server instance(s).
SYNTAX
Get-DbaXEObject [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Type] <System.String[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
This function returns a list of extended events objects exposed by event packages from specified SQL Server
instance(s).
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2008 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<System.String[]>]
Used to specify the type. Valid types include:
Action
Event
Map
Message
PredicateComparator
PredicateSource
Target
Type
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: ExtendedEvent, XE, XEvent
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS