Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This stored procedure cleans up history locally and on the monitor server based on retention period.
.gif "Topic link icon")
Transact-SQL Syntax Conventions
Syntax
sp_cleanup_log_shipping_history
[ @agent_id = ] 'agent_id',
[ @agent_type = ] 'agent_type'
Arguments
- [ @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.
Return Code Values
0 (success) or 1 (failure)
Result Sets
None.
Remarks
sp_cleanup_log_shipping_history must be run from the master database on any log shipping server. This stored procedure cleans up local and remote copies of log_shipping_monitor_history_detail and log_shipping_monitor_error_detail based on history retention period.
Permissions
Only members of the sysadmin fixed server role can run this procedure.
See Also
Reference
System Stored Procedures (Transact-SQL)
Other Resources
Log Shipping
Log Shipping Tables and Stored Procedures