sp_add_log_shipping_primary_secondary (Transact-SQL)

Applies to: SQL Server

This stored procedure adds an entry for a secondary database on the primary server.

Transact-SQL syntax conventions

Syntax

sp_add_log_shipping_primary_secondary
[ @primary_database = ] 'primary_database' ,
[ @secondary_server = ] 'secondary_server' ,
[ @secondary_database = ] 'secondary_database'
[ ; ]

Arguments

[ @primary_database = ] 'primary_database'

The name of the database on the primary server. @primary_database is sysname, with no default.

[ @secondary_server = ] 'secondary_server'

The name of the secondary server. @secondary_server is sysname, with no default.

[ @secondary_database = ] 'secondary_database'

The name of the secondary database. @secondary_database is sysname, with no default.

Return code values

0 (success) or 1 (failure).

Result set

None.

Remarks

sp_add_log_shipping_primary_secondary must be run from the master database on the primary server.

Permissions

Only members of the sysadmin fixed server role can run this procedure.

Examples

This example uses sp_add_log_shipping_primary_secondary to add an entry for the secondary database LogShipAdventureWorks to the secondary server FLATIRON.

EXEC master.dbo.sp_add_log_shipping_primary_secondary
    @primary_database = N'AdventureWorks',
    @secondary_server = N'flatiron',
    @secondary_database = N'LogShipAdventureWorks';
GO