< Back

Stop-DbaXESession

Mon Jan 13, 2020 5:56 pm

NAME Stop-DbaXESession



SYNOPSIS

Stops Extended Events sessions.





SYNTAX

Stop-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential

<Pscredential>] -Session <System.Object[]> [-EnableException <Switch>] [<CommonParameters>]



Stop-DbaXESession [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential

<Pscredential>] -AllSessions <Switch> [-EnableException <Switch>] [<CommonParameters>]



Stop-DbaXESession -InputObject <Microsoft.SqlServer.Management.XEvent.Session[]> [-EnableException <Switch>]

[<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-AllSessions [<Switch>]

If this switch is enabled, all Extended Events sessions will be stopped except 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[]>]

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



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Session [<System.Object[]>]

Specifies individual Extended Events sessions to stop.



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



RELATED LINKS

https://dbatools.io/Stop-DbaXESession