< Back
Start-DbaXESession
Post
NAME Start-DbaXESession
SYNOPSIS
Starts Extended Events sessions.
SYNTAX
Start-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential
<Pscredential>] -Session <System.Object[]> [-StopAt <Datetime>] [-EnableException <Switch>] [<CommonParameters>]
Start-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential
<Pscredential>] [-StopAt <Datetime>] -AllSessions <Switch> [-EnableException <Switch>] [<CommonParameters>]
Start-DbaXESession [-StopAt <Datetime>] -InputObject <Microsoft.SqlServer.Management.XEvent.Session[]>
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
This script starts Extended Events sessions on a SQL Server instance.
PARAMETERS
-AllSessions [<Switch>]
Start all Extended Events sessions on an instance, ignoring the packaged sessions: AlwaysOn_health,
system_health, telemetry_xevents.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
-InputObject [<Microsoft.SqlServer.Management.XEvent.Session[]>]
Internal parameter to support piping from Get-DbaXESession
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Session [<System.Object[]>]
Only start specific Extended Events sessions.
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
-StopAt [<Datetime>]
Specifies a datetime at which the session will be stopped. This is done via a self-deleting schedule.
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: Doug Meyers
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Start-DbaXESession -SqlInstance sqlserver2012 -AllSessions
Starts all Extended Event Session on the sqlserver2014 instance.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Start-DbaXESession -SqlInstance sqlserver2012 -Session xesession1,xesession2
Starts the xesession1 and xesession2 Extended Event sessions.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Start-DbaXESession -SqlInstance sqlserver2012 -Session xesession1,xesession2 -StopAt
(Get-Date).AddMinutes(30)
Starts the xesession1 and xesession2 Extended Event sessions and stops them in 30 minutes.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaXESession -SqlInstance sqlserver2012 -Session xesession1 | Start-DbaXESession
Starts the sessions returned from the Get-DbaXESession function.
RELATED LINKS
https://dbatools.io/Start-DbaXESession
SYNOPSIS
Starts Extended Events sessions.
SYNTAX
Start-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential
<Pscredential>] -Session <System.Object[]> [-StopAt <Datetime>] [-EnableException <Switch>] [<CommonParameters>]
Start-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential
<Pscredential>] [-StopAt <Datetime>] -AllSessions <Switch> [-EnableException <Switch>] [<CommonParameters>]
Start-DbaXESession [-StopAt <Datetime>] -InputObject <Microsoft.SqlServer.Management.XEvent.Session[]>
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
This script starts Extended Events sessions on a SQL Server instance.
PARAMETERS
-AllSessions [<Switch>]
Start all Extended Events sessions on an instance, ignoring the packaged sessions: AlwaysOn_health,
system_health, telemetry_xevents.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
-InputObject [<Microsoft.SqlServer.Management.XEvent.Session[]>]
Internal parameter to support piping from Get-DbaXESession
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Session [<System.Object[]>]
Only start specific Extended Events sessions.
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
-StopAt [<Datetime>]
Specifies a datetime at which the session will be stopped. This is done via a self-deleting schedule.
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: Doug Meyers
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Start-DbaXESession -SqlInstance sqlserver2012 -AllSessions
Starts all Extended Event Session on the sqlserver2014 instance.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Start-DbaXESession -SqlInstance sqlserver2012 -Session xesession1,xesession2
Starts the xesession1 and xesession2 Extended Event sessions.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Start-DbaXESession -SqlInstance sqlserver2012 -Session xesession1,xesession2 -StopAt
(Get-Date).AddMinutes(30)
Starts the xesession1 and xesession2 Extended Event sessions and stops them in 30 minutes.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaXESession -SqlInstance sqlserver2012 -Session xesession1 | Start-DbaXESession
Starts the sessions returned from the Get-DbaXESession function.
RELATED LINKS
https://dbatools.io/Start-DbaXESession