functions/Get-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
function Get-DbaXESessionTemplate {
 <#
    .SYNOPSIS
    Parses Extended Event XML templates. Defaults to parsing templates in our template repository (\bin\xetemplates\)
 
    .DESCRIPTION
    Parses Extended Event XML templates. Defaults to parsing templates in our template repository (\bin\xetemplates\)
 
    .PARAMETER Path
    The path to the template directory. Defaults to our template repository (\bin\xetemplates\)
 
    .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/Get-DbaXESessionTemplate
 
    .EXAMPLE
    Get-DbaXESessionTemplate
 
    Returns information about all the templates in the local dbatools repository
 
    .EXAMPLE
    Get-DbaXESessionTemplate | Out-GridView -PassThru | Import-DbaXESessionTemplate -SqlInstance sql2017 | Start-DbaXESession
 
    Allows you to select a Session template then import to an instance named
 
    .EXAMPLE
    Get-DbaXESessionTemplate -Path "$home\Documents\SQL Server Management Studio\Templates\XEventTemplates"
 
    Returns information about all the templates in your local XEventTemplates repository
 
#>

    [CmdletBinding()]
    param (
        [string[]]$Path = "$script:PSModuleRoot\bin\xetemplates",
        [switch]$EnableException
    )
    process {
        foreach ($directory in $Path) {
            $files = Get-ChildItem "$directory\*.xml"
            foreach ($file in $files) {
                try {
                    $xml = [xml](Get-Content $file)
                }
                catch {
                    Stop-Function -Message "Failure" -ErrorRecord $_ -Target $file -Continue
                }

                foreach ($session in $xml.event_sessions) {
                    [pscustomobject]@{
                        Name     = $session.event_session.name
                        File     = $file.Name
                        TemplateName = $session.event_session.TemplateName.'#text'
                        TemplateDescription = $session.event_session.TemplateDescription.'#text'
                        Path = $file
                    }
                }
            }
        }
    }
}