< Back

Stop-DbaXESmartTarget

Mon Jan 13, 2020 5:57 pm

NAME Stop-DbaXESmartTarget



SYNOPSIS

Stops an XESmartTarget PowerShell job. Useful if you want to run a target, but not right now.





SYNTAX

Stop-DbaXESmartTarget [-InputObject] <System.Object[]> [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

Stops an XESmartTarget PowerShell job. Useful if you want to run a target, but not right now.





PARAMETERS

-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 [<System.Object[]>]

The XESmartTarget job object.



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: Chrissy LeMaire (@cl) | SmartTarget by Gianluca Sartori (@spaghettidba)



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-DbaXESmartTarget | Stop-DbaXESmartTarget



Stops all XESmartTarget jobs.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-DbaXESmartTarget | Where-Object Id -eq 2 | Stop-DbaXESmartTarget



Stops a specific XESmartTarget job.



RELATED LINKS

https://dbatools.io/Stop-DbaXESmartTarget

https://github.com/spaghettidba/XESmartTarget/wiki