CreateRecoveryPlan
The createRecoveryPlan method creates a recovery plan. You call the method by passing the name and folder of the plan, and the protection group that must be included in the plan.
Synopsis
CreateRecoveryPlanTask createRecoveryPlan( String name, drextapi.Folder folder, ProtectionGroup[] groups, @optional String description, @optional TestNetworkMapping[] mapping)
| Parameter | Description |
|---|---|
| name | Specifies the name of the plan. Must be unique in the parent folder. |
| folder | Specifies the folder where the plan is created. |
| groups | Specifies the protection groups that are added to the recovery plan. |
| description | Optional parameter. Specifies the recovery plan description. |
| mapping | Optional parameter. Specifies the test network mappings. |
CreateRecoveryPlanTask is a Task object that contains information about the status of the operation. Site Recovery Manager Server retains the object for 30 minutes after the task finishes.
IsCreateRecoveryPlanComplete returns true if the task for creating a recovery plan is complete.
GetCreateRecoveryPlanFailure returns the failure during the operation for creating a recovery plan. If you pass a name of a plan that exists, the failure is DuplicateNames.
If the operation is successful, the GetNewRecoveryPlan returns the created recovery plan.
Faults
- DirectionError
- InvalidArgument
- ProtectionGroupNotFound
- RemoteSiteNotEnabled
- StringArgumentTooLong
- RuntimeFault
For information about the faults that Site Recovery Manager throws, see Faults in Site Recovery Manager API.