commands

^

Stop-DbaPfDataCollectorSet

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows only

 

Synopsis

Stops Performance Monitor Data Collector Set.

Description

Stops Performance Monitor Data Collector Set.

Syntax

Stop-DbaPfDataCollectorSet
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [[-CollectorSet] <String[]>]
    [[-InputObject] <Object[]>]
    [-NoWait]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Stop-DbaPfDataCollectorSet

Attempts to stop all ready Collectors on localhost.

Example: 2
PS C:\> Stop-DbaPfDataCollectorSet -ComputerName sql2017

Attempts to stop all ready Collectors on localhost.

Example: 3
PS C:\> Stop-DbaPfDataCollectorSet -ComputerName sql2017, sql2016 -Credential ad\sqldba -CollectorSet 'System Correlation'

Stops the 'System Correlation' Collector on sql2017 and sql2016 using alternative credentials.

Example: 4
PS C:\> Get-DbaPfDataCollectorSet -CollectorSet 'System Correlation' | Stop-DbaPfDataCollectorSet

Stops the 'System Correlation' Collector.

Optional Parameters

-ComputerName

The target computer. Defaults to localhost.

Alias
Required False
Pipeline false
Default Value $env:COMPUTERNAME
-Credential

Allows you to login to $ComputerName using alternative credentials. To use: $cred = Get-Credential, then pass $cred object to the -Credential parameter.

Alias
Required False
Pipeline false
Default Value
-CollectorSet

The name of the Collector Set to stop.

Alias DataCollectorSet
Required False
Pipeline false
Default Value
-InputObject

Accepts the object output by Get-DbaPfDataCollectorSet via the pipeline.

Alias
Required False
Pipeline true (ByValue)
Default Value
-NoWait

If this switch is enabled, the collector is stopped and the results are returned immediately.

Alias
Required False
Pipeline false
Default Value False
-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-DbaPfDataCollectorSet on GitHub.
Want to see the Bill Of Health for this command? Check out Stop-DbaPfDataCollectorSet.