sp_help_log_shipping_secondary_primary (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server

This stored procedure retrieves the settings for a given primary database on the secondary server.

Syntax

  
sp_help_log_shipping_secondary_primary  
[ @primary_server = ] 'primary_server' OR  
[ @primary_database = ] 'primary_database'

Arguments

[ @primary_server = ] 'primary_server' The name of the primary instance of the Microsoft SQL Server Database Engine in the log shipping configuration. primary_server is sysname and cannot be NULL.

[ @primary_database = ] 'primary_database' Is the name of the database on the primary server. primary_database is sysname, with no default.

Return Code Values

0 (success) or 1 (failure)

Result Sets

The result set contains the columns secondary_id, primary_server, primary_database, backup_source_directory, backup_destination_directory, file_retention_period, copy_job_id, restore_job_id, monitor_server, monitor_server_security_mode from log_shipping_secondary.

Remarks

sp_help_log_shipping_secondary_primary must be run from the master database on the secondary server.

Permissions

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