commands

^

Export-DbaXESessionTemplate

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows only

 

Synopsis

Exports an XESession XML Template using XE Session(s) output by Get-DbaXESession

Description

Exports an XESession XML Template either from the Target SQL Server or XE Session(s) output by Get-DbaXESession. Exports to "$home\Documents\SQL Server Management Studio\Templates\XEventTemplates" by default

Syntax

Export-DbaXESessionTemplate
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Session] <Object[]>]
    [[-Path] <String>]
    [[-FilePath] <String>]
    [[-InputObject] <Session[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Export-DbaXESessionTemplate -SqlInstance sql2017 -Path C:\temp\xe

Exports an XESession XML Template for all Extended Event Sessions on sql2017 to the C:\temp\xe folder.

Example: 2
PS C:\> Get-DbaXESession -SqlInstance sql2017 -Session system_health | Export-DbaXESessionTemplate -Path C:\temp\xe

Gets the system_health Extended Events Session from sql2017 and then exports as an XESession XML Template to C:\temp\xe

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2008 or higher.

Alias
Required False
Pipeline false
Default Value
-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

Alias
Required False
Pipeline false
Default Value
-Session

The Name of the session(s) to export.

Alias
Required False
Pipeline false
Default Value
-Path

Specifies the directory where the file or files will be exported.

Alias
Required False
Pipeline false
Default Value "$home\Documents\SQL Server Management Studio\Templates\XEventTemplates"
-FilePath

Specifies the full file path of the output file.

Alias OutFile,FileName
Required False
Pipeline false
Default Value
-InputObject

Specifies an XE Session output by Get-DbaXESession.

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Export-DbaXESessionTemplate on GitHub.
Want to see the Bill Of Health for this command? Check out Export-DbaXESessionTemplate.