< Back
Copy-DbaXESessionTemplate
Post
NAME Copy-DbaXESessionTemplate
SYNOPSIS
Copies non-Microsoft templates from the dbatools template repository (\\bin\\xetemplates\\) to $home\\Documents\\SQL
Server Management Studio\\Templates\\XEventTemplates.
SYNTAX
Copy-DbaXESessionTemplate [[-Path] <System.String[]>] [[-Destination] <String>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Copies non-Microsoft templates from the dbatools template repository (\\bin\\xetemplates\\) to $home\\Documents\\SQL
Server Management Studio\\Templates\\XEventTemplates.
Useful for when you want to use the SSMS GUI.
PARAMETERS
-Destination [<String>]
Path to the Destination directory, defaults to $home\\Documents\\SQL Server Management
Studio\\Templates\\XEventTemplates.
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
-Path [<System.String[]>]
The path to the template directory. Defaults to the dbatools template repository (\\bin\\xetemplates\\).
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: ExtendedEvent, XE, XEvent
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:\\>Copy-DbaXESessionTemplate
Copies non-Microsoft templates from the dbatools template repository (\\bin\\xetemplates\\) to $home\\Documents\\SQL
Server Management Studio\\Templates\\XEventTemplates.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Copy-DbaXESessionTemplate -Path C:\\temp\\xetemplates
Copies your templates from C:\\temp\\xetemplates to $home\\Documents\\SQL Server Management
Studio\\Templates\\XEventTemplates.
RELATED LINKS
https://dbatools.io/Copy-DbaXESessionTemplate
SYNOPSIS
Copies non-Microsoft templates from the dbatools template repository (\\bin\\xetemplates\\) to $home\\Documents\\SQL
Server Management Studio\\Templates\\XEventTemplates.
SYNTAX
Copy-DbaXESessionTemplate [[-Path] <System.String[]>] [[-Destination] <String>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Copies non-Microsoft templates from the dbatools template repository (\\bin\\xetemplates\\) to $home\\Documents\\SQL
Server Management Studio\\Templates\\XEventTemplates.
Useful for when you want to use the SSMS GUI.
PARAMETERS
-Destination [<String>]
Path to the Destination directory, defaults to $home\\Documents\\SQL Server Management
Studio\\Templates\\XEventTemplates.
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
-Path [<System.String[]>]
The path to the template directory. Defaults to the dbatools template repository (\\bin\\xetemplates\\).
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: ExtendedEvent, XE, XEvent
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:\\>Copy-DbaXESessionTemplate
Copies non-Microsoft templates from the dbatools template repository (\\bin\\xetemplates\\) to $home\\Documents\\SQL
Server Management Studio\\Templates\\XEventTemplates.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Copy-DbaXESessionTemplate -Path C:\\temp\\xetemplates
Copies your templates from C:\\temp\\xetemplates to $home\\Documents\\SQL Server Management
Studio\\Templates\\XEventTemplates.
RELATED LINKS
https://dbatools.io/Copy-DbaXESessionTemplate