Stop-DbaXESession


Author	Doug Meyers
Availability	Windows, Linux, macOS

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

Synopsis

Stops Extended Events sessions.

Description

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

Syntax

Stop-DbaXESession
    [-SqlInstance] <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    -Session <Object[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-DbaXESession
    [-SqlInstance] <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    -AllSessions
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-DbaXESession -InputObject <Session[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Stop-DbaXESession -SqlInstance sqlserver2012 -AllSessions

Stops all Extended Event Session on the sqlserver2014 instance.

Example: 2

PS C:\> Stop-DbaXESession -SqlInstance sqlserver2012 -Session xesession1,xesession2

Stops the xesession1 and xesession2 Extended Event sessions.

Example: 3

PS C:\> Get-DbaXESession -SqlInstance sqlserver2012 -Session xesession1 | Stop-DbaXESession

Stops 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

Specifies individual Extended Events sessions to stop.


Alias	Sessions
Required	True
Pipeline	false
Default Value

-AllSessions

If this switch is enabled, all Extended Events sessions will be stopped except the packaged sessions AlwaysOn_health, system_health, telemetry_xevents.


Alias
Required	True
Pipeline	false
Default Value	False

-InputObject

Accepts the object output by Get-DbaXESession as the list of sessions to be stopped.


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

-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