< Back
Test-DbaRepLatency
Post
NAME Test-DbaRepLatency
SYNOPSIS
Displays replication latency for all transactional publications for a server or database.
SYNTAX
Test-DbaRepLatency [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-Database]
<System.Object[]>] [[-SqlCredential] <Pscredential>] [[-PublicationName] <System.Object[]>] [[-TimeToLive] <Int>]
[-RetainToken <Switch>] [-DisplayTokenHistory <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates tracer tokens to determine latency between the publisher/distributor and the distributor/subscriber
for all transactional publications for a server, database, or publication.
PARAMETERS
-Database [<System.Object[]>]
The database(s) to process. If unspecified, all databases will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-DisplayTokenHistory [<Switch>]
Displays all tracer tokens in each publication. If unspecified, the current tracer token created will be only
token displayed.
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
-PublicationName [<System.Object[]>]
The publication(s) to process. If unspecified, all publications will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-RetainToken [<Switch>]
Retains the tracer tokens created for each publication. If unspecified, all tracer tokens created will be
discarded.
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 instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-TimeToLive [<Int>]
How long, in seconds, to wait for a tracer token to complete its journey from the publisher to the subscriber.
If unspecified, all tracer tokens will take as long as they need to process results.
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: Replication
Author: Colin Douglas
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Test-DbaRepLatency -SqlInstance sql2008, sqlserver2012
Return replication latency for all transactional publications for servers sql2008 and sqlserver2012.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Test-DbaRepLatency -SqlInstance sql2008 -Database TestDB
Return replication latency for all transactional publications on server sql2008 for only the TestDB database
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Test-DbaRepLatency -SqlInstance sql2008 -Database TestDB -PublicationName TestDB_Pub
Return replication latency for the TestDB_Pub publication for the TestDB database located on the server sql2008.
RELATED LINKS
https://dbatools.io/Test-DbaRepLatency
SYNOPSIS
Displays replication latency for all transactional publications for a server or database.
SYNTAX
Test-DbaRepLatency [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-Database]
<System.Object[]>] [[-SqlCredential] <Pscredential>] [[-PublicationName] <System.Object[]>] [[-TimeToLive] <Int>]
[-RetainToken <Switch>] [-DisplayTokenHistory <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates tracer tokens to determine latency between the publisher/distributor and the distributor/subscriber
for all transactional publications for a server, database, or publication.
PARAMETERS
-Database [<System.Object[]>]
The database(s) to process. If unspecified, all databases will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-DisplayTokenHistory [<Switch>]
Displays all tracer tokens in each publication. If unspecified, the current tracer token created will be only
token displayed.
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
-PublicationName [<System.Object[]>]
The publication(s) to process. If unspecified, all publications will be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-RetainToken [<Switch>]
Retains the tracer tokens created for each publication. If unspecified, all tracer tokens created will be
discarded.
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 instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-TimeToLive [<Int>]
How long, in seconds, to wait for a tracer token to complete its journey from the publisher to the subscriber.
If unspecified, all tracer tokens will take as long as they need to process results.
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: Replication
Author: Colin Douglas
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Test-DbaRepLatency -SqlInstance sql2008, sqlserver2012
Return replication latency for all transactional publications for servers sql2008 and sqlserver2012.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Test-DbaRepLatency -SqlInstance sql2008 -Database TestDB
Return replication latency for all transactional publications on server sql2008 for only the TestDB database
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Test-DbaRepLatency -SqlInstance sql2008 -Database TestDB -PublicationName TestDB_Pub
Return replication latency for the TestDB_Pub publication for the TestDB database located on the server sql2008.
RELATED LINKS
https://dbatools.io/Test-DbaRepLatency