< Back

Copy-DbaXESession

Mon Jan 13, 2020 9:42 am

NAME Copy-DbaXESession



SYNOPSIS

Migrates SQL Extended Event Sessions except the two default sessions, AlwaysOn_health and system_health.





SYNTAX

Copy-DbaXESession [-Source] <DbaInstanceParameter> [-Destination]

<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SourceSqlCredential] <Pscredential>]

[[-DestinationSqlCredential] <Pscredential>] [[-XeSession] <System.Object[]>] [[-ExcludeXeSession]

<System.Object[]>] [-Force <Switch>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

Migrates SQL Extended Event Sessions except the two default sessions, AlwaysOn_health and system_health.



By default, all non-system Extended Events are migrated.





PARAMETERS

-Destination [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

Destination SQL Server. You must have sysadmin access and the server must be SQL Server 2000 or higher.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-DestinationSqlCredential [<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



-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



-ExcludeXeSession [<System.Object[]>]

The Extended Event Session(s) to exclude. This list is auto-populated from the server.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Force [<Switch>]

If this switch is enabled, existing Extended Events sessions on Destination with matching names from Source

will be dropped.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Source [<DbaInstanceParameter>]

Source SQL Server. You must have sysadmin access and server version must be SQL Server version 2000 or higher.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SourceSqlCredential [<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



-XeSession [<System.Object[]>]

The Extended Event Session(s) to process. This list is auto-populated from the server. If unspecified, all

Extended Event Sessions will be processed.



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: Migration, ExtendedEvent, 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



Requires: sysadmin access on SQL Servers



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Copy-DbaXESession -Source sqlserver2014a -Destination sqlcluster



Copies all Extended Event sessions from sqlserver2014a to sqlcluster using Windows credentials.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Copy-DbaXESession -Source sqlserver2014a -Destination sqlcluster -SourceSqlCredential $cred



Copies all Extended Event sessions from sqlserver2014a to sqlcluster using SQL credentials for sqlserver2014a and

Windows credentials for sqlcluster.

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Copy-DbaXESession -Source sqlserver2014a -Destination sqlcluster -WhatIf



Shows what would happen if the command were executed.

-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Copy-DbaXESession -Source sqlserver2014a -Destination sqlcluster -XeSession CheckQueries,

MonitorUserDefinedException



Copies only the Extended Events named CheckQueries and MonitorUserDefinedException from sqlserver2014a to

sqlcluster.



RELATED LINKS

https://dbatools.io/Copy-DbaXESession