commands

^

Get-DbaXESessionTargetFile

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

 

Synopsis

Get a file system object from the Extended Events Session Target Files.

Description

Get a file system object from the Extended Events Session Target Files.

Note: this performs a Get-ChildItem on remote servers if the specified target SQL Server is remote.

Syntax

Get-DbaXESessionTargetFile
    [-SqlCredential <PSCredential>]
    [-Session <String[]>]
    [-Target <String[]>]
    [-EnableException]
    [<CommonParameters>]

Get-DbaXESessionTargetFile -SqlInstance <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    [-Session <String[]>]
    [-Target <String[]>]
    [-EnableException]
    [<CommonParameters>]

Get-DbaXESessionTargetFile
    [-SqlCredential <PSCredential>]
    [-Session <String[]>]
    [-Target <String[]>] -InputObject <Target[]>
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaXESessionTargetFile -SqlInstance sql2017 -Session 'Long Running Queries'

Shows Target Files for the 'Long Running Queries' session on sql2017.

Example: 2
PS C:\> Get-DbaXESession -SqlInstance sql2016 -Session 'Long Running Queries' | Get-DbaXESessionTarget | Get-DbaXESessionTargetFile

Returns the Target Files for the system_health session on sql2016.

Required Parameters

-SqlInstance

The target SQL Server

Alias
Required True
Pipeline true (ByValue)
Default Value
-InputObject

Allows results from piping in Get-DbaXESessionTarget.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-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

Only return files from a specific session. Options for this parameter are auto-populated from the server.

Alias
Required False
Pipeline false
Default Value
-Target

Only return files from a specific target.

Alias
Required False
Pipeline false
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 Get-DbaXESessionTargetFile on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaXESessionTargetFile.