commands

^

Stop-DbaXESmartTarget

Author Chrissy LeMaire (@cl) , SmartTarget by Gianluca Sartori (@spaghettidba)
Availability Windows, Linux, macOS

 

Synopsis

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

Description

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

Syntax

Stop-DbaXESmartTarget
    [-InputObject] <Object[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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.

Required Parameters

-InputObject

The XESmartTarget job object.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-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

 

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