< Back
Export-DbaPfDataCollectorSetTemplate
Post
NAME Export-DbaPfDataCollectorSetTemplate
SYNOPSIS
Exports a new Data Collector Set XML Template.
SYNTAX
Export-DbaPfDataCollectorSetTemplate [[-ComputerName]
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-Credential] <Pscredential>] [[-CollectorSet]
<System.String[]>] [[-Path] <String>] [[-FilePath] <String>] [[-InputObject] <System.Object[]>] [-EnableException
<Switch>] [<CommonParameters>]
DESCRIPTION
Exports a Data Collector Set XML Template from Get-DbaPfDataCollectorSet. Exports to "$home\\Documents\\Performance
Monitor Templates" by default.
PARAMETERS
-CollectorSet [<System.String[]>]
The name of the collector set(s) to export.
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
-FilePath [<String>]
Specifies the full file path of the output file.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Accepts the object output by Get-DbaPfDataCollectorSetTemplate via the pipeline.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Specifies the directory where the file or files will be exported.
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
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:\\>Export-DbaPfDataCollectorSetTemplate -ComputerName sql2017 -Path C:\\temp\\pf
Exports all data collector sets from to the C:\\temp\\pf folder.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaPfDataCollectorSet ComputerName sql2017 -CollectorSet 'System Correlation' |
Export-DbaPfDataCollectorSetTemplate -Path C:\\temp
Exports the 'System Correlation' data collector set from sql2017 to C:\\temp.
RELATED LINKS
https://dbatools.io/Export-DbaPfDataCol ... etTemplate
SYNOPSIS
Exports a new Data Collector Set XML Template.
SYNTAX
Export-DbaPfDataCollectorSetTemplate [[-ComputerName]
<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-Credential] <Pscredential>] [[-CollectorSet]
<System.String[]>] [[-Path] <String>] [[-FilePath] <String>] [[-InputObject] <System.Object[]>] [-EnableException
<Switch>] [<CommonParameters>]
DESCRIPTION
Exports a Data Collector Set XML Template from Get-DbaPfDataCollectorSet. Exports to "$home\\Documents\\Performance
Monitor Templates" by default.
PARAMETERS
-CollectorSet [<System.String[]>]
The name of the collector set(s) to export.
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
-FilePath [<String>]
Specifies the full file path of the output file.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Accepts the object output by Get-DbaPfDataCollectorSetTemplate via the pipeline.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Specifies the directory where the file or files will be exported.
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
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:\\>Export-DbaPfDataCollectorSetTemplate -ComputerName sql2017 -Path C:\\temp\\pf
Exports all data collector sets from to the C:\\temp\\pf folder.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaPfDataCollectorSet ComputerName sql2017 -CollectorSet 'System Correlation' |
Export-DbaPfDataCollectorSetTemplate -Path C:\\temp
Exports the 'System Correlation' data collector set from sql2017 to C:\\temp.
RELATED LINKS
https://dbatools.io/Export-DbaPfDataCol ... etTemplate