functions/Stop-DbaXESession.ps1
|
function Stop-DbaXESession { <# .SYNOPSIS Stops Extended Events sessions. .DESCRIPTION This script stops Extended Events sessions on a SQL Server instance. .PARAMETER SqlInstance Target SQL Server. You must have sysadmin access and server version must be SQL Server version 2008 or higher. .PARAMETER SqlCredential Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted). To use: $scred = Get-Credential, then pass $scred object to the -SqlCredential parameter. Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials. To connect as a different Windows user, run PowerShell as that user. .PARAMETER Session Specifies individual Extended Events sessions to stop. .PARAMETER AllSessions If this switch is enabled, all Extended Events sessions will be stopped except the packaged sessions AlwaysOn_health, system_health, telemetry_xevents. .PARAMETER SessionCollection Accepts the object output by Get-DbaXESession as the list of sessions to be stopped. .PARAMETER 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. .NOTES Tags: ExtendedEvent, XE, Xevent Author: Doug Meyers Website: https://dbatools.io Copyright: (C) Chrissy LeMaire, clemaire@gmail.com License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Stop-DbaXESession .EXAMPLE Stop-DbaXESession -SqlInstance sqlserver2012 -AllSessions Stops all Extended Event Session on the sqlserver2014 instance. .EXAMPLE Stop-DbaXESession -SqlInstance sqlserver2012 -Session xesession1,xesession2 Stops the xesession1 and xesession2 Extended Event sessions. .EXAMPLE Get-DbaXESession -SqlInstance sqlserver2012 -Session xesession1 | Stop-DbaXESession Stops the sessions returned from the Get-DbaXESession function. #> [CmdletBinding(DefaultParameterSetName = 'Session')] param ( [parameter(Position = 1, Mandatory, ParameterSetName = 'Session')] [parameter(Position = 1, Mandatory, ParameterSetName = 'All')] [Alias("ServerInstance", "SqlServer")] [DbaInstanceParameter[]]$SqlInstance, [parameter(ParameterSetName = 'Session')] [parameter(ParameterSetName = 'All')] [PSCredential]$SqlCredential, [parameter(Mandatory, ParameterSetName = 'Session')] [Alias("Sessions")] [object[]]$Session, [parameter(Mandatory, ParameterSetName = 'All')] [switch]$AllSessions, [parameter(Mandatory, ValueFromPipeline, ParameterSetName = 'Object')] [Microsoft.SqlServer.Management.XEvent.Session[]]$SessionCollection, [switch]$EnableException ) begin { # Stop each XESession function Stop-XESessions { [CmdletBinding()] param ([Microsoft.SqlServer.Management.XEvent.Session[]]$xeSessions) foreach ($xe in $xeSessions) { $instance = $xe.Parent.Name $session = $xe.Name if ($xe.isRunning) { Write-Message -Level Verbose -Message "Stopping XEvent Session $session on $instance." try { $xe.Stop() } catch { Stop-Function -Message "Could not stop XEvent Session on $instance" -Target $session -ErrorRecord $_ -Continue } } else { Write-Message -Level Warning -Message "$session on $instance is already stopped" } Get-DbaXESession -SqlInstance $xe.Parent -Session $session } } } process { if ($SessionCollection) { Stop-XESessions $SessionCollection } else { foreach ($instance in $SqlInstance) { $xeSessions = Get-DbaXESession -SqlInstance $instance -SqlCredential $SqlCredential # Filter xesessions based on parameters if ($Session) { $xeSessions = $xeSessions | Where-Object { $_.Name -in $Session } } elseif ($AllSessions) { $systemSessions = @('AlwaysOn_health', 'system_health', 'telemetry_xevents') $xeSessions = $xeSessions | Where-Object { $_.Name -notin $systemSessions } } Stop-XESessions $xeSessions } } } } |