forked from dataplat/dbatools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCopy-DbaXESessionTemplate.ps1
72 lines (59 loc) · 3.12 KB
/
Copy-DbaXESessionTemplate.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#ValidationTags#Messaging,FlowControl,Pipeline,CodeStyle#
function Copy-DbaXESessionTemplate {
<#
.SYNOPSIS
Copies non-Microsoft templates from the dbatools template repository (\bin\xetemplates\) to $home\Documents\SQL Server Management Studio\Templates\XEventTemplates.
.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.
.PARAMETER Path
The path to the template directory. Defaults to the dbatools template repository (\bin\xetemplates\).
.PARAMETER Destination
Path to the Destination directory, defaults to $home\Documents\SQL Server Management Studio\Templates\XEventTemplates.
.PARAMETER EnableException
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.
.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
.LINK
https://dbatools.io/Copy-DbaXESessionTemplate
.EXAMPLE
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
PS C:\> Copy-DbaXESessionTemplate -Path C:\temp\xetemplates
Copies your templates from C:\temp\xetemplates to $home\Documents\SQL Server Management Studio\Templates\XEventTemplates.
#>
[CmdletBinding()]
param (
[string[]]$Path = "$script:PSModuleRoot\bin\xetemplates",
[string]$Destination = "$home\Documents\SQL Server Management Studio\Templates\XEventTemplates",
[switch]$EnableException
)
process {
if (Test-FunctionInterrupt) { return }
foreach ($destinstance in $Destination) {
if (-not (Test-Path -Path $destinstance)) {
try {
$null = New-Item -ItemType Directory -Path $destinstance -ErrorAction Stop
} catch {
Stop-Function -Message "Failure" -ErrorRecord $_ -Target $destinstance
}
}
try {
$files = (Get-DbaXESessionTemplate -Path $Path | Where-Object Source -ne Microsoft).Path
foreach ($file in $files) {
Write-Message -Level Output -Message "Copying $($file.Name) to $destinstance."
Copy-Item -Path $file -Destination $destinstance -ErrorAction Stop
}
} catch {
Stop-Function -Message "Failure" -ErrorRecord $_ -Target $path
}
}
}
}