< Back
Get-DbaXESession
Post
NAME Get-DbaXESession
SYNOPSIS
Gets a list of Extended Events Sessions from the specified SQL Server instance(s).
SYNTAX
Get-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Session] <System.Object[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Retrieves a list of Extended Events Sessions present on the 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
-Session [<System.Object[]>]
Only return specific sessions. Options for this parameter are auto-populated from the server.
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
<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: Klaas Vandenberghe (@PowerDBAKlaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Get-DbaXESession
SYNOPSIS
Gets a list of Extended Events Sessions from the specified SQL Server instance(s).
SYNTAX
Get-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Session] <System.Object[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Retrieves a list of Extended Events Sessions present on the 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
-Session [<System.Object[]>]
Only return specific sessions. Options for this parameter are auto-populated from the server.
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
<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: Klaas Vandenberghe (@PowerDBAKlaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Get-DbaXESession