< Back
Get-DbaXESessionTargetFile
Post
NAME Get-DbaXESessionTargetFile
SYNOPSIS
Get a file system object from the Extended Events Session Target Files.
SYNTAX
Get-DbaXESessionTargetFile [-SqlCredential <Pscredential>] [-Session <System.String[]>] [-Target
<System.String[]>] [-EnableException <Switch>] [<CommonParameters>]
Get-DbaXESessionTargetFile -SqlInstance <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[-SqlCredential <Pscredential>] [-Session <System.String[]>] [-Target <System.String[]>] [-EnableException
<Switch>] [<CommonParameters>]
Get-DbaXESessionTargetFile [-SqlCredential <Pscredential>] [-Session <System.String[]>] [-Target
<System.String[]>] -InputObject <Microsoft.SqlServer.Management.XEvent.Target[]> [-EnableException <Switch>]
[<CommonParameters>]
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.
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
-InputObject [<Microsoft.SqlServer.Management.XEvent.Target[]>]
Allows results from piping in Get-DbaXESessionTarget.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Session [<System.String[]>]
Only return files from a specific session. Options for this parameter are auto-populated from the server.
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
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Target [<System.String[]>]
Only return files from a specific target.
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:\\>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.
RELATED LINKS
https://dbatools.io/Get-DbaXESessionTargetFile
SYNOPSIS
Get a file system object from the Extended Events Session Target Files.
SYNTAX
Get-DbaXESessionTargetFile [-SqlCredential <Pscredential>] [-Session <System.String[]>] [-Target
<System.String[]>] [-EnableException <Switch>] [<CommonParameters>]
Get-DbaXESessionTargetFile -SqlInstance <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[-SqlCredential <Pscredential>] [-Session <System.String[]>] [-Target <System.String[]>] [-EnableException
<Switch>] [<CommonParameters>]
Get-DbaXESessionTargetFile [-SqlCredential <Pscredential>] [-Session <System.String[]>] [-Target
<System.String[]>] -InputObject <Microsoft.SqlServer.Management.XEvent.Target[]> [-EnableException <Switch>]
[<CommonParameters>]
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.
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
-InputObject [<Microsoft.SqlServer.Management.XEvent.Target[]>]
Allows results from piping in Get-DbaXESessionTarget.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Session [<System.String[]>]
Only return files from a specific session. Options for this parameter are auto-populated from the server.
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
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Target [<System.String[]>]
Only return files from a specific target.
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:\\>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.
RELATED LINKS
https://dbatools.io/Get-DbaXESessionTargetFile