Edit

Share via

sp_add_maintenance_plan (Transact-SQL)

  • Article

Applies to: SQL Server

Adds a maintenance plan and returns the plan ID.

Note

This stored procedure is used with database maintenance plans. This feature has been replaced with maintenance plans which don't use this stored procedure. Use this procedure to maintain database maintenance plans on installations that were upgraded from a previous version of SQL Server.

This feature will be removed in a future version of SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

Transact-SQL syntax conventions

Syntax

sp_add_maintenance_plan
    [ @plan_name = ] 'plan_name'
    , [ @plan_id = ] 'plan_id' OUTPUT
[ ; ]

Arguments

[ @plan_name = ] N'plan_name'

Specifies the name of the maintenance plan to be added. @plan_name is varchar(128).

[ @plan_id = ] N'plan_id' OUTPUT

Specifies the ID of the maintenance plan. @plan_id is uniqueidentifier.

Return code values

0 (success) or 1 (failure).

Remarks

sp_add_maintenance_plan must be run from the msdb database and creates a new, but empty, maintenance plan. To add one or more databases and associate them with a job or jobs, execute sp_add_maintenance_plan_db and sp_add_maintenance_plan_job.

Permissions

You can grant EXECUTE permissions on this procedure, but these permissions might be overridden during a SQL Server upgrade.

Examples

Create a maintenance plan called MyPlan.

DECLARE @myplan_id UNIQUEIDENTIFIER;

EXECUTE sp_add_maintenance_plan
    @plan_name = N'MyPlan',
    @plan_id = @myplan_id OUTPUT

PRINT 'The ID for the maintenance plan "MyPlan" is:' + convert(VARCHAR(256), @myplan_id);
GO

Success in creating the maintenance plan returns the plan ID.

The ID for the maintenance plan "MyPlan" is: FAD6F2AB-3571-11D3-9D4A-00C04FB925FC

Related content