Get-DbaXEStore

Chrissy LeMaire (@cl), netnerds.net

Windows, Linux, macOS

Synopsis

Retrieves the Extended Events store object for managing XEvent sessions and configurations

Retrieves the Extended Events store object from SQL Server instances, which serves as the foundation for working with Extended Events sessions, packages, and configurations. The store object provides access to session management, event package information, and running session counts. This is typically the first step when building Extended Events monitoring solutions or auditing XEvent configurations across your environment.

Syntax

Get-DbaXEStore
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaXEStore -SqlInstance ServerA\sql987

Returns an XEvent Store.

Required 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.

Property	Value
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.

Property	Value
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.

Property	Value
Alias
Required	False
Pipeline	false
Default Value	False

Outputs

Microsoft.SqlServer.Management.XEvent.XEStore

Returns one XEStore object per SQL Server instance specified, providing access to Extended Events sessions, packages, and configuration management.

Default display properties (via Select-DefaultView):

ComputerName: The computer name of the SQL Server instance
InstanceName: The SQL Server instance name
SqlInstance: The full SQL Server instance name (computer\instance format)
ServerName: The name of the SQL Server instance from the XEStore object
Sessions: Collection of Extended Events sessions on the instance
Packages: Collection of XEvent packages available on the instance
RunningSessionCount: The number of currently active/running XEvent sessions All properties from the base SMO XEStore object are accessible using Select-Object *.