< Back
Stop-DbaPfDataCollectorSet
Post
NAME Stop-DbaPfDataCollectorSet
SYNOPSIS
Stops Performance Monitor Data Collector Set.
SYNTAX
Stop-DbaPfDataCollectorSet [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [[-CollectorSet] <System.String[]>] [[-InputObject] <System.Object[]>] [-NoWait
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Stops Performance Monitor Data Collector Set.
PARAMETERS
-CollectorSet [<System.String[]>]
The name of the Collector Set to stop.
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
-Credential [<Pscredential>]
Allows you to login to $ComputerName using alternative credentials. To use:
$cred = Get-Credential, then pass $cred 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-DbaPfDataCollectorSet via the pipeline.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-NoWait [<Switch>]
If this switch is enabled, the collector is stopped and the results are returned immediately.
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: PerfMon
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:\\>Stop-DbaPfDataCollectorSet
Attempts to stop all ready Collectors on localhost.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Stop-DbaPfDataCollectorSet -ComputerName sql2017
Attempts to stop all ready Collectors on localhost.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Stop-DbaPfDataCollectorSet -ComputerName sql2017, sql2016 -Credential ad\\sqldba -CollectorSet 'System
Correlation'
Stops the 'System Correlation' Collector on sql2017 and sql2016 using alternative credentials.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaPfDataCollectorSet -CollectorSet 'System Correlation' | Stop-DbaPfDataCollectorSet
Stops the 'System Correlation' Collector.
RELATED LINKS
https://dbatools.io/Stop-DbaPfDataCollectorSet
SYNOPSIS
Stops Performance Monitor Data Collector Set.
SYNTAX
Stop-DbaPfDataCollectorSet [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [[-CollectorSet] <System.String[]>] [[-InputObject] <System.Object[]>] [-NoWait
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Stops Performance Monitor Data Collector Set.
PARAMETERS
-CollectorSet [<System.String[]>]
The name of the Collector Set to stop.
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
-Credential [<Pscredential>]
Allows you to login to $ComputerName using alternative credentials. To use:
$cred = Get-Credential, then pass $cred 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-DbaPfDataCollectorSet via the pipeline.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-NoWait [<Switch>]
If this switch is enabled, the collector is stopped and the results are returned immediately.
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: PerfMon
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:\\>Stop-DbaPfDataCollectorSet
Attempts to stop all ready Collectors on localhost.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Stop-DbaPfDataCollectorSet -ComputerName sql2017
Attempts to stop all ready Collectors on localhost.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Stop-DbaPfDataCollectorSet -ComputerName sql2017, sql2016 -Credential ad\\sqldba -CollectorSet 'System
Correlation'
Stops the 'System Correlation' Collector on sql2017 and sql2016 using alternative credentials.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaPfDataCollectorSet -CollectorSet 'System Correlation' | Stop-DbaPfDataCollectorSet
Stops the 'System Correlation' Collector.
RELATED LINKS
https://dbatools.io/Stop-DbaPfDataCollectorSet