Get-DbaPfDataCollector

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

Synopsis

Gets Performance Monitor Data Collectors.

Description

Gets Performance Monitor Data Collectors.

Syntax

Get-DbaPfDataCollector
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [[-CollectorSet] <String[]>]
    [[-Collector] <String[]>]
    [[-InputObject] <Object[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaPfDataCollector

Gets all Collectors on localhost.

Example: 2

PS C:\> Get-DbaPfDataCollector -ComputerName sql2017

Gets all Collectors on sql2017.

Example: 3

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

Gets all Collectors for the 'System Correlation' CollectorSet on sql2017 and sql2016 using alternative credentials.

Example: 4

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

Gets all Collectors for the 'System Correlation' CollectorSet.

Optional Parameters

-ComputerName

The target computer. Defaults to localhost.

-Credential

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

-CollectorSet

The Collector Set name.

-Collector

The Collector name.

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