Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-SMPerformanceCollector

Last Updated: 4/3/2017

SYNOPSIS

Gets the state of the performance data collector set.

SYNTAX

Get-SMPerformanceCollector -CollectorName <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<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.

EXAMPLES

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.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CollectorName

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

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Byte

NOTES

Start-SMPerformanceCollector

Stop-SMPerformanceCollector

© 2017 Microsoft