Get-SMCounterSample
Get-SMCounterSample
Gets performance counter samples for a particular time stamp.
Syntax
Parameter Set: InTimeRange
Get-SMCounterSample -CollectorName <String> -CounterPath <String[]> [-AsJob] [-BatchSize <UInt32> ] [-CimSession <CimSession[]> ] [-EndTime <DateTime> ] [-StartTime <DateTime> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: AtTime
Get-SMCounterSample -CollectorName <String> -CounterPath <String[]> -Timestamp <DateTime[]> [-AsJob] [-BatchSize <UInt32> ] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-SMCounterSample cmdlet gets performance counter samples for a particular time.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-BatchSize<UInt32>
Specifies the batch size that the command uses to stream results.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CollectorName<String>
Specifies the name of the data collector set in Performance Log Analyzer (PLA) to query.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CounterPath<String[]>
Specifies an array of paths to the counter data.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EndTime<DateTime>
Specifies the end time for the sample data collection.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StartTime<DateTime>
Specifies a start time for the sample data collection.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Timestamp<DateTime[]>
Specifies an array of DateTime objects. The objects specify when the sampling occurs.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_ServerPerformanceCounterSamples[]
Examples
Example 1: Get a counter sample from a data collector set
This command gets the performance sample for the collector named ContosoPerf and the counter path specified as C:\PerfLogs\Admin\ within a specified timeframe.
PS C:\> Get-SMCounterSample -CollectorName "ContosoPerf" -CounterPath "C:\PerfLogs\Admin\"-EndTime 12:00 -StartTime 11:00
Example 2: Get a counter sample at a specified time
This command gets the performance sample for the collector named ContosoPerf and the counter path named C:\PerfLogs\Admin\ at a specified time. The timestamp is an array of DateTime objects.
PS C:\> Get-SMCounterSample -CollectorName "ContosoPerf" -CounterPath "C:\PerfLogs\Admin\" -TimeStamp @(1,3,5,7)