sp_refresh_log_shipping_monitor (Transact-SQL)

Applies to: SQL Server

This stored procedure refreshes the remote monitor tables with the latest information from a given primary or secondary server for the specified log shipping agent. The procedure is invoked on the primary or secondary server.

Transact-SQL syntax conventions


[ @agent_id = ] 'agent_id',  
[ @agent_type = ] 'agent_type'  
[ @database = ] 'database'  
[ @mode ] n  


[ @agent_id = ] 'agent_id' The primary ID for backup or the secondary ID for copy or restore. agent_id is uniqueidentifier and cannot be NULL.

[ @agent_type = ] 'agent_type' The type of log shipping job.

0 = Backup.

1 = Copy.

2 = Restore.

agent_type is tinyint and cannot be NULL.

[ @database = ] 'database' The primary or secondary database used by logging by backup or restore agents.

[ @mode ] n Specifies whether to refresh the monitor data or clean it. The data type of m is tinyint, and the supported values are:

1 = refresh (This is the default value.)

2 = delete

Return Code Values

0 (success) or 1 (failure)

Result Sets



sp_refresh_log_shipping_monitor refreshes the log_shipping_monitor_primary, log_shipping_monitor_secondary, log_shipping_monitor_history_detail, and log_shipping_monitor_error_detail tables with any session information that has not already been transferred. This allows you to synchronize the monitor server with primary or a secondary server when the monitor has been out of sync for awhile. Additionally, it allows you to clean up the monitor information on monitor server if necessary.

sp_refresh_log_shipping_monitor must be run from the master database on the primary or secondary server.


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

See Also

About Log Shipping (SQL Server)
System Stored Procedures (Transact-SQL)