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

Displays all subscriptions for a publication.

Description

Displays all subscriptions for a publication

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

The database(s) to process. If unspecified, all databases will be processed.

-PublicationName

The name of the publication.

-SubscriberName

The subscriber SQL Server instance name.

-SubscriptionDatabase

The name of the subscription database.

-Type

Limit by specific type of publication. Valid choices include: Transactional, Merge, Snapshot

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