Get-DbaPfDataCollectorSet

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

Synopsis

Retrieves Windows Performance Monitor Data Collector Sets and their configuration details.

Description

Retrieves detailed information about Windows Performance Monitor Data Collector Sets, which are used to collect performance counters for SQL Server monitoring and troubleshooting. Data Collector Sets define what performance counters to collect, when to collect them, and where to store the collected data. This function helps DBAs inventory existing collector sets, check their status (running, stopped, scheduled), and review their configuration including output locations and schedules. Particularly useful when inheriting a SQL Server environment or auditing existing performance monitoring setup.

Syntax

Get-DbaPfDataCollectorSet
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [[-CollectorSet] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaPfDataCollectorSet

Gets all Collector Sets on localhost.

Example: 2

PS C:\> Get-DbaPfDataCollectorSet -ComputerName sql2017

Gets all Collector Sets on sql2017.

Example: 3

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

Gets the 'System Correlation' CollectorSet on sql2017 using alternative credentials.

Example: 4

PS C:\> Get-DbaPfDataCollectorSet | Select-Object *

Displays extra columns and also exposes the original COM object in DataCollectorSetObject.

Optional Parameters

-ComputerName

Specifies the Windows server(s) where you want to inventory Performance Monitor Data Collector Sets.
Use this when checking collector sets across multiple SQL Server hosts or when managing performance monitoring from a central location.
Accepts multiple computer names and defaults to the local computer.

-Credential

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

-CollectorSet

Specifies the name(s) of specific Data Collector Sets to retrieve instead of returning all collector sets.
Use this when you need to check the status or configuration of specific performance monitoring setups like 'SQL Server Default' or custom collector sets.
Accepts wildcards and multiple collector set names for targeted monitoring inventory.

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