Remove-DbaXESession

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

Synopsis

Removes Extended Events sessions from SQL Server instances.

Description

Removes Extended Events sessions from SQL Server instances, giving you the option to target specific sessions by name or remove all user-created sessions at once. This function preserves critical system sessions (system_health, telemetry_xevents, and AlwaysOn_health) when using the AllSessions parameter, so you can safely clean up monitoring sessions without breaking SQL Server's built-in diagnostics. Useful for removing outdated monitoring configurations or cleaning up test sessions that are no longer needed.

Syntax

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

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

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

Examples

Example: 1

PS C:\> Remove-DbaXESession -SqlInstance sql2012 -AllSessions

Removes all Extended Event Session on the sqlserver2014 instance.

Example: 2

PS C:\> Remove-DbaXESession -SqlInstance sql2012 -Session xesession1,xesession2

Removes the xesession1 and xesession2 Extended Event sessions.

Example: 3

PS C:\> Get-DbaXESession -SqlInstance sql2017 | Remove-DbaXESession -Confirm:$false

Removes all sessions from sql2017, bypassing prompts.

Example: 4

PS C:\> Get-DbaXESession -SqlInstance sql2012 -Session xesession1 | Remove-DbaXESession

Removes 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.

-Session

Specifies one or more Extended Events session names to remove from the target instance.
Use this when you want to selectively remove specific monitoring sessions rather than all user sessions.
Accepts session names as strings, with support for arrays to remove multiple sessions in one command.

-AllSessions

Removes all user-created Extended Events sessions while preserving critical system sessions.
Use this for cleanup operations when you want to clear all monitoring sessions without breaking SQL Server's built-in diagnostics.
Automatically excludes system_health, telemetry_xevents, and AlwaysOn_health sessions to maintain server functionality.

-InputObject

Accepts Extended Events session objects directly from Get-DbaXESession for pipeline operations.
Use this when you need to filter sessions with Get-DbaXESession first, then remove the filtered results.
Enables complex filtering scenarios and integration with other dbatools XE functions.

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.

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

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

-Confirm

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