functions/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
function Copy-DbaXESessionTemplate {
 <#
    .SYNOPSIS
    Copies non-Microsoft templates from our template repository (\bin\xetemplates\) to $home\Documents\SQL Server Management Studio\Templates\XEventTemplates
 
    .DESCRIPTION
    Copies non-Microsoft templates from our 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 our 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
    Website: https://dbatools.io
    Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
    License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
    .LINK
    https://dbatools.io/Copy-DbaXESessionTemplate
 
    .EXAMPLE
    Copy-DbaXESessionTemplate
 
    Copies non-Microsoft templates from our template repository (\bin\xetemplates\) to $home\Documents\SQL Server Management Studio\Templates\XEventTemplates
 
    .EXAMPLE
    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 (-not (Test-Path -Path $Destination)) {
            try {
                $null = New-Item -ItemType Directory -Path $Destination -ErrorAction Stop
            }
            catch {
                Stop-Function -Message "Failure" -ErrorRecord $_ -Target $Destination
            }
        }
        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 $Destination"
                Copy-Item -Path $file -Destination $Destination -ErrorAction Stop
            }
        }
        catch {
            Stop-Function -Message "Failure" -ErrorRecord $_ -Target $path
        }
    }
}