Adds a maintenance plan and returns the plan ID.
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
|Applies to: SQL Server (SQL Server 2008 through current version).|
sp_add_maintenance_plan [ @plan_name = ] 'plan_name' , @plan_id = 'plan_id' OUTPUT
[ @plan_name =] 'plan_name'
Specifies the name of the maintenance plan to be added. plan_name is varchar(128).
@plan_id = ' plan_id '
Specifies the ID of the maintenance plan. plan_id is uniqueidentifier.
0 (success) or 1 (failure)
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.
Only members of the sysadmin fixed server role can execute sp_add_maintenance_plan.
Create a maintenance plan called Myplan.
DECLARE @myplan_id UNIQUEIDENTIFIER; EXECUTE sp_add_maintenance_plan 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 will return the plan ID.
'The id for the maintenance plan "Myplan" is:' FAD6F2AB-3571-11D3-9D4A-00C04FB925FC