[Import-DbaXESessionTemplate] TargetFile and TargetFileMetadataPath parameters ignored

[kirzas]

Verified issue does not already exist?

Yes

What error did you receive?

No errors. TargetFile and TargetFileMetadataPath parameters are ignored unless the template imported has specific properties defined.

Steps to Reproduce

Import-DbaXESessionTemplate -SqlInstance barfoo -Template 'Connection Detail Tracking' -EnableException -Name foobar -TargetFilePath foobar

It works successfully and the session with name foobar is created. Parameter TargetFilePath is ignored, as there is no event_file target at all. This is at least misleading. As neither help for the paramater, nor any logging says anything about it.

Are you running the latest release?

Yes

Other details or mentions

It is quite clear why from those lines:
https://github.com/sqlcollaborative/dbatools/blob/development/functions/Import-DbaXESessionTemplate.ps1#L161-L168

I would propose to create target file if it is not in the template.

Xml is imported on line 172. Replacing strings in the xml could be improved by properly modifying xml.

What PowerShell host was used when producing this error

Windows PowerShell (powershell.exe)

PowerShell Host Version

Name Value

---

PSVersion 5.1.18362.1593
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.18362.1593
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1

SQL Server Edition and Build number

Microsoft SQL Server 2016 (SP2-CU10) (KB4524334) - 13.0.5492.2 (X64) Oct 4 2019 19:14:08 Copyright (c) Microsoft Corporation Enterprise Edition (64-bit) on Windows Server 2016 Standard 10.0 (Build 14393: ) (Hypervisor)

[andreasjordan]

@kirzas Are you able to provide a pull request with the proposed changes?
@potatoqualitee Can you as the author of the command have a look at this issue?

[potatoqualitee]

yeah! i remember that this was on my todo list, but it was kinda challenging, so I put it off (xml or text parsing) :/ would be happy to review a PR.

[andreasjordan]

Hi @kirzas - are you still around? Would you like to work on that?

Will change this from a bug to a feature request...

[andreasjordan]

@claude please have a look at this issue.

[claude]

Claude finished @andreasjordan's task in 5m 39s —— View job • claude/issue-7727-20260315-1830 • Create PR ➔

---

Changes Implemented

• Gather context
• Understand the issue and read relevant code
• Implement fix
• Commit and push changes

Summary

Fixed Import-DbaXESessionTemplate in public/Import-DbaXESessionTemplate.ps1 to honor TargetFilePath and TargetFileMetadataPath even when the template has no event_file target.

Changes made:

1. Main fix: When TargetFilePath is specified but the template XML contains no event_file target (e.g. templates that use ring_buffer like Connection Detail Tracking), a new event_file target is now injected into the XML with the specified path before creating the session.

2. Linux path bug fix: The original code had $TargetFilePath = "$TargetFilePath/".$file.TrimEnd("\").TrimEnd("/") — the .$file part attempted a property access on the string (which resolves to $null), making the Linux path empty. Fixed to $TargetFilePath = "$TargetFilePath/".

3. Conditional TargetFileMetadataPath handling: The separator and verbose message for TargetFileMetadataPath are now only applied when that parameter is actually bound, preventing unintended path corruption when it's not specified.

Example behavior after fix:

# Template 'Connection Detail Tracking' uses ring_buffer, not event_file
# Before: TargetFilePath was silently ignored, no event_file target created
# After: An event_file target is added pointing to C:\XELogs\
Import-DbaXESessionTemplate -SqlInstance sql01 -Template 'Connection Detail Tracking' -Name foobar -TargetFilePath 'C:\XELogs'

|