sp_add_log_shipping_alert_job (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

This stored procedure checks to see if an alert job has been created on this server. If an alert job does not exist, this stored procedure creates the alert job and adds its job ID to the log_shipping_monitor_alert table. The alert job is enabled by default and runs on a schedule of once every two minutes.

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_add_log_shipping_alert_job  
[, [ @alert_job_id = ] alert_job_id OUTPUT ]  

Arguments

[ @alert_job_id = ] alert_job_id OUTPUT
The Microsoft SQL Server Agent job ID of the log shipping alert job.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

sp_add_log_shipping_alert_job must be run from the master database on the monitor server.

Permissions

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

Examples

This example shows the execution of sp_add_log_shipping_alert_job to create an alert job ID.

USE master  
GO  
EXEC sp_add_log_shipping_alert_job;  

See Also

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