commands

^

Start-DbaXESession

Author Doug Meyers
Availability Windows, Linux, macOS

 

Synopsis

Starts Extended Events sessions.

Description

This script starts Extended Events sessions on a SQL Server instance.

Syntax

Start-DbaXESession
    [-SqlInstance] <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>] -Session <Object[]>
    [-StartAt <DateTime>]
    [-StopAt <DateTime>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Start-DbaXESession
    [-SqlInstance] <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    [-StartAt <DateTime>]
    [-StopAt <DateTime>] -AllSessions
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Start-DbaXESession
    [-StartAt <DateTime>]
    [-StopAt <DateTime>] -InputObject <Session[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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:\> Start-DbaXESession -SqlInstance sqlserver2012 -Session AlwaysOn_health -StartAt (Get-Date).AddMinutes(1)

Starts the AlwaysOn_health Extended Event sessions in 1 minute. The command will return immediately.

Example: 5
PS C:\> Get-DbaXESession -SqlInstance sqlserver2012 -Session xesession1 | Start-DbaXESession

Starts the sessions returned from the Get-DbaXESession function.

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 false
Default Value
-Session

Only start specific Extended Events sessions.

Alias Sessions
Required True
Pipeline false
Default Value
-AllSessions

Start all Extended Events sessions on an instance, ignoring the packaged sessions: AlwaysOn_health, system_health, telemetry_xevents.

Alias
Required True
Pipeline false
Default Value False
-InputObject

Internal parameter to support piping from Get-DbaXESession

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

Specifies a datetime at which the session will be started. This is done via a self-deleting schedule. The command returns immediately and returns the affected sessions in their current state.

Alias
Required False
Pipeline false
Default Value
-StopAt

Specifies a datetime at which the session will be stopped. This is done via a self-deleting schedule.

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

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Alias cf
Required False
Pipeline false
Default Value

 

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