< Back
Export-DbaXESessionTemplate
Post
NAME Export-DbaXESessionTemplate
SYNOPSIS
Exports an XESession XML Template using XE Session(s) output by Get-DbaXESession
SYNTAX
Export-DbaXESessionTemplate [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Session] <System.Object[]>] [[-Path] <String>] [[-FilePath] <String>]
[[-InputObject] <Microsoft.SqlServer.Management.XEvent.Session[]>] [-EnableException <Switch>] [<CommonParameters>]
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
PARAMETERS
-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
-FilePath [<String>]
Specifies the full file path of the output file.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.XEvent.Session[]>]
Specifies an XE Session output by Get-DbaXESession.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Specifies the directory where the file or files will be exported.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Session [<System.Object[]>]
The Name of the session(s) to export.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2008 or higher.
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:\\>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
RELATED LINKS
https://dbatools.io/Export-DbaXESessionTemplate
SYNOPSIS
Exports an XESession XML Template using XE Session(s) output by Get-DbaXESession
SYNTAX
Export-DbaXESessionTemplate [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Session] <System.Object[]>] [[-Path] <String>] [[-FilePath] <String>]
[[-InputObject] <Microsoft.SqlServer.Management.XEvent.Session[]>] [-EnableException <Switch>] [<CommonParameters>]
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
PARAMETERS
-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
-FilePath [<String>]
Specifies the full file path of the output file.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.XEvent.Session[]>]
Specifies an XE Session output by Get-DbaXESession.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Specifies the directory where the file or files will be exported.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Session [<System.Object[]>]
The Name of the session(s) to export.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2008 or higher.
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:\\>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
RELATED LINKS
https://dbatools.io/Export-DbaXESessionTemplate