Remove-DbaPfDataCollectorSet

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

Synopsis

Removes a Performance Monitor Data Collector Set

Description

Removes a Performance Monitor Data Collector Set. When removing data collector sets from the local instance, Run As Admin is required.

Syntax

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

Examples

Example: 1

PS C:\> Remove-DbaPfDataCollectorSet

Prompts for confirmation then removes all ready Collectors on localhost.

Example: 2

PS C:\> Remove-DbaPfDataCollectorSet -ComputerName sql2017 -Confirm:$false

Attempts to remove all ready Collectors on localhost and does not prompt to confirm.

Example: 3

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

Prompts for confirmation then removes the 'System Correlation' Collector on sql2017 and sql2016 using alternative credentials.

Example: 4

PS C:\> Get-DbaPfDataCollectorSet -CollectorSet 'System Correlation' | Remove-DbaPfDataCollectorSet

Removes the 'System Correlation' Collector.

Example: 5

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

Stops and removes the 'System Correlation' Collector.

Optional Parameters

-ComputerName

The target computer. Defaults to localhost.

-Credential

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

-CollectorSet

The name of the Collector Set to remove.

-InputObject

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

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

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

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.