Remove-DbaReplSubscription

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

Synopsis

Removes a subscription for the target SQL instances.

Description

Removes a subscription for the target SQL instances.

https://learn.microsoft.com/en-us/sql/relational-databases/replication/delete-a-push-subscription?view=sql-server-ver16
https://learn.microsoft.com/en-us/sql/relational-databases/replication/delete-a-pull-subscription?view=sql-server-ver16

Syntax

Remove-DbaReplSubscription
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-Database] <String>
    [-PublicationName] <String>
    [-SubscriberSqlInstance] <DbaInstanceParameter>
    [[-SubscriberSqlCredential] <PSCredential>]
    [-SubscriptionDatabase] <String>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> $sub = @{
>> SqlInstance           = 'mssql1'
>> Database              = 'pubs'
>> PublicationName       = 'testPub'
>> SubscriberSqlInstance = 'mssql2'
>> SubscriptionDatabase  = 'pubs'
>> }
PS C:\> Remove-DbaReplSubscription @sub

Removes a subscription for the testPub publication on mssql2.pubs.

Required Parameters

-SqlInstance

The target publisher SQL Server instance or instances.

-Database

Specifies the publisher database that contains the replication publication.
This is the source database where the published data originates from.

-PublicationName

Specifies the exact name of the replication publication to remove the subscription from.
Must match an existing publication name on the publisher database.

-SubscriberSqlInstance

Specifies the SQL Server instance that receives replicated data from the publisher.
Use this to identify which subscriber instance should have its subscription removed.

-SubscriptionDatabase

Specifies the database on the subscriber instance that receives the replicated data.
This is the target database where the subscription will be removed from.

Optional Parameters

-SqlCredential

Login to the target publisher 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.

-SubscriberSqlCredential

Login to the subscriber instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Required when the subscriber instance uses different authentication than the publisher.
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

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

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.