< Back

Get-SMPerformanceCollector

Thu Apr 04, 2019 5:42 am

NAME Get-SMPerformanceCollector



SYNOPSIS

Gets the state of the performance data collector set.





SYNTAX

Get-SMPerformanceCollector [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -CollectorName <String> [<CommonParameters>]





DESCRIPTION

The Get-SMPerformanceCollector cmdlet gets the state of a data collector set in the Performance Log Analyzer (PLA). A data collector set groups

multiple data collection points, such as performance counters or events, into a single component. The result returned by this cmdlet is either

Running or Stopped.





PARAMETERS

-CimSession [<CimSession[]>]

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession

or Get-CimSession cmdlet. The default is the current session on the local computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-CollectorName <String>

Specifies a data collector set in PLA. The data collector set for Server Manager is 'Server Manager Performance Monitor'.



Required? true

Position? named

Default value none

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0

is entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running

on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS

System.Byte







Example 1: Get the Server Manager performance data collector set state



PS C:\\>Get-SMPerformanceCollector -CollectorName 'Server Manager Performance Monitor'

Running



This command gets the state of the performance data collector for Server Manager, 'Server Manager Performance Monitor'. If performance data

collection is turned on, the result returned by this command is Running. If performance data collection is turned off, the result is Stopped.







RELATED LINKS

Online Version:

Start-SMPerformanceCollector

Stop-SMPerformanceCollector