commands

^

New-DbaReplSubscription

Author Jess Pomfret (@jpomfret), jesspomfret.com
Availability Windows, Linux, macOS

 

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

Synopsis

Creates a subscription for the database on the target SQL instances.

Description

Creates a subscription for the database on the target SQL instances.

Syntax

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

 

Examples

 

Example: 1
PS C:\> New-DbaReplSubscription -SqlInstance sql2017 -Database pubs -SubscriberSqlInstance sql2019 -SubscriptionDatabase pubs -PublicationName testPub -Type Push

Creates a push subscription from sql2017 to sql2019 for the pubs database.

Example: 2
PS C:\> New-DbaReplSubscription -SqlInstance sql2017 -Database pubs -SubscriberSqlInstance sql2019 -SubscriptionDatabase pubs -PublicationName testPub -Type Pull

Creates a pull subscription from sql2017 to sql2019 for the pubs database.

Required Parameters

-SqlInstance

The target publishing SQL Server instance or instances.

Alias
Required True
Pipeline true (ByValue)
Default Value
-SubscriberSqlInstance

The subscriber SQL instance.

Alias
Required True
Pipeline false
Default Value
-PublicationName

The name of the replication publication

Alias
Required True
Pipeline false
Default Value
-Type

The flavour of the subscription. Push or Pull.

Alias
Required True
Pipeline false
Default Value
Accepted Values Push,Pull

Optional Parameters

-SqlCredential

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

Alias
Required False
Pipeline false
Default Value
-Database

The database on the publisher that will be replicated.

Alias
Required False
Pipeline false
Default Value
-SubscriberSqlCredential

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

Alias
Required False
Pipeline false
Default Value
-SubscriptionDatabase

The database on the subscriber that will be the target of the replicated data.

Alias
Required False
Pipeline false
Default Value
-SubscriptionSqlCredential

Credential object that will be saved as the 'subscriber credential' in the subscription properties.

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False
-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.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

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

Alias cf
Required False
Pipeline false
Default Value