< Back
Get-DbaPfDataCollectorCounterSample
Post
NAME Get-DbaPfDataCollectorCounterSample
SYNOPSIS
Gets Performance Counter Samples.
SYNTAX
Get-DbaPfDataCollectorCounterSample [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [[-CollectorSet] <System.String[]>] [[-Collector] <System.String[]>] [[-Counter]
<System.String[]>] [-Continuous <Switch>] [[-ListSet] <System.Management.Automation.SwitchParameter[]>]
[[-MaxSamples] <Int>] [[-SampleInterval] <Int>] [[-InputObject] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Gets Performance Counter Samples.
PARAMETERS
-Collector [<System.String[]>]
The Collector name.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CollectorSet [<System.String[]>]
The Collector Set name.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ComputerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target computer. Defaults to localhost.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Continuous [<Switch>]
If this switch is enabled, samples will be retrieved continuously until you press CTRL+C. By default, this
command gets only one counter sample. You can use the SampleInterval parameter to set the interval for
continuous sampling.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Counter [<System.String[]>]
The Counter name. This must be in the form of '\\Processor(_Total)\\% Processor Time'.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Credential [<Pscredential>]
Allows you to login to servers using alternative credentials. To use:
$scred = Get-Credential, then pass $scred object to the -Credential parameter.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Accepts the object output by Get-DbaPfDataCollectorCounter via the pipeline.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ListSet [<System.Management.Automation.SwitchParameter[]>]
Gets the specified performance counter sets on the computers. Enter the names of the counter sets. Wildcards
are permitted.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MaxSamples [<Int>]
Specifies the number of samples to get from each counter. The default is 1 sample. To get samples continuously
(no maximum sample size), use the Continuous parameter.
To collect a very large data set, consider running a Get-DbaPfDataCollectorCounterSample command as a Windows
PowerShell background job.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SampleInterval [<Int>]
Specifies the time between samples in seconds. The minimum value and the default value are 1 second.
Required? false
Position? named
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Performance, DataCollector, PerfCounter
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample
Gets a single sample for all counters for all Collector Sets on localhost.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -Counter '\\Processor(_Total)\\% Processor Time'
Gets a single sample for all counters for all Collector Sets on localhost.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounter -ComputerName sql2017, sql2016 | Out-GridView -PassThru |
Get-DbaPfDataCollectorCounterSample -MaxSamples 10
Gets 10 samples for all counters for all Collector Sets for servers sql2016 and sql2017.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -ComputerName sql2017
Gets a single sample for all counters for all Collector Sets on sql2017.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -ComputerName sql2017, sql2016 -Credential ad\\sqldba -CollectorSet
'System Correlation'
Gets a single sample for all counters for the 'System Correlation' CollectorSet on sql2017 and sql2016 using
alternative credentials.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -CollectorSet 'System Correlation'
Gets a single sample for all counters for the 'System Correlation' CollectorSet.
RELATED LINKS
https://dbatools.io/Get-DbaPfDataCollectorCounterSample
SYNOPSIS
Gets Performance Counter Samples.
SYNTAX
Get-DbaPfDataCollectorCounterSample [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [[-CollectorSet] <System.String[]>] [[-Collector] <System.String[]>] [[-Counter]
<System.String[]>] [-Continuous <Switch>] [[-ListSet] <System.Management.Automation.SwitchParameter[]>]
[[-MaxSamples] <Int>] [[-SampleInterval] <Int>] [[-InputObject] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Gets Performance Counter Samples.
PARAMETERS
-Collector [<System.String[]>]
The Collector name.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CollectorSet [<System.String[]>]
The Collector Set name.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ComputerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target computer. Defaults to localhost.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Continuous [<Switch>]
If this switch is enabled, samples will be retrieved continuously until you press CTRL+C. By default, this
command gets only one counter sample. You can use the SampleInterval parameter to set the interval for
continuous sampling.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Counter [<System.String[]>]
The Counter name. This must be in the form of '\\Processor(_Total)\\% Processor Time'.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Credential [<Pscredential>]
Allows you to login to servers using alternative credentials. To use:
$scred = Get-Credential, then pass $scred object to the -Credential parameter.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Accepts the object output by Get-DbaPfDataCollectorCounter via the pipeline.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ListSet [<System.Management.Automation.SwitchParameter[]>]
Gets the specified performance counter sets on the computers. Enter the names of the counter sets. Wildcards
are permitted.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MaxSamples [<Int>]
Specifies the number of samples to get from each counter. The default is 1 sample. To get samples continuously
(no maximum sample size), use the Continuous parameter.
To collect a very large data set, consider running a Get-DbaPfDataCollectorCounterSample command as a Windows
PowerShell background job.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SampleInterval [<Int>]
Specifies the time between samples in seconds. The minimum value and the default value are 1 second.
Required? false
Position? named
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Performance, DataCollector, PerfCounter
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample
Gets a single sample for all counters for all Collector Sets on localhost.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -Counter '\\Processor(_Total)\\% Processor Time'
Gets a single sample for all counters for all Collector Sets on localhost.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounter -ComputerName sql2017, sql2016 | Out-GridView -PassThru |
Get-DbaPfDataCollectorCounterSample -MaxSamples 10
Gets 10 samples for all counters for all Collector Sets for servers sql2016 and sql2017.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -ComputerName sql2017
Gets a single sample for all counters for all Collector Sets on sql2017.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -ComputerName sql2017, sql2016 -Credential ad\\sqldba -CollectorSet
'System Correlation'
Gets a single sample for all counters for the 'System Correlation' CollectorSet on sql2017 and sql2016 using
alternative credentials.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-DbaPfDataCollectorCounterSample -CollectorSet 'System Correlation'
Gets a single sample for all counters for the 'System Correlation' CollectorSet.
RELATED LINKS
https://dbatools.io/Get-DbaPfDataCollectorCounterSample