Get-DbaReplSubscription

Want to see the source code for this command? Check out Get-DbaReplSubscription on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaReplSubscription.

Synopsis

Retrieves SQL Server replication subscription details for publications across instances.

Description

Retrieves detailed information about replication subscriptions, showing which subscriber instances are receiving data from publications. This is essential for monitoring replication topology, troubleshooting subscription issues, and auditing data distribution across your SQL Server environment. You can filter results by database, publication name, subscriber instance, subscription database, or subscription type (Push/Pull) to focus on specific replication relationships.

Syntax

Get-DbaReplSubscription
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-PublicationName] <String[]>]
    [[-SubscriberName] <DbaInstanceParameter[]>]
    [[-SubscriptionDatabase] <Object[]>]
    [[-Type] <Object[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaReplSubscription -SqlInstance mssql1

Return all subscriptions for all publications on server mssql1.

Example: 2

PS C:\> Get-DbaReplSubscription -SqlInstance mssql1 -Database TestDB

Return all subscriptions for all publications on server mssql1 for only the TestDB database.

Example: 3

PS C:\> Get-DbaReplSubscription -SqlInstance mssql1 -PublicationName Mergey

Return all subscriptions for the publication Mergey on server mssql1.

Example: 4

PS C:\> Get-DbaReplSubscription -SqlInstance mssql1 -Type Push

Return all subscriptions for all transactional publications on server mssql1.

Example: 5

PS C:\> Get-DbaReplSubscription -SqlInstance mssql1 -SubscriberName mssql2

Return all subscriptions for all publications on server mssql1 where the subscriber is mssql2.

Example: 6

PS C:\> Get-DbaReplSubscription -SqlInstance mssql1 -SubscriptionDatabase TestDB

Return all subscriptions for all publications on server mssql1 where the subscription database is TestDB.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

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.

-Database

Specifies which publication databases to include when retrieving subscriptions. Accepts multiple database names and wildcards.
Use this to focus on subscriptions from specific databases instead of checking all replicated databases on the instance.

-PublicationName

Filters results to subscriptions from specific publications by name. Accepts multiple publication names.
Use this when you need to check subscription status for particular publications rather than all publications on the server.

-SubscriberName

Filters results to subscriptions where data is being delivered to specific subscriber instances. Accepts multiple instance names.
Use this to monitor subscription health and activity for particular subscriber servers in your replication topology.

-SubscriptionDatabase

Filters results to subscriptions where data is being delivered to specific databases on subscriber instances. Accepts multiple database names.
Use this to track how data flows to particular databases across your subscribers, especially when subscription databases have different names than source databases.

-Type

Filters results to subscriptions of a specific delivery method (Push or Pull). Push subscriptions are managed by the publisher, while Pull subscriptions are managed by the subscriber.
Use this to separate subscription management tasks or troubleshoot issues specific to push or pull delivery mechanisms.

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