This is an archive version of the document. To get the most up-to-date information, see the current version.Failover Plan Action Parameters
If you want to run a failover plan, then the /FailoverPlans/{id} resource must have one of the following specific parameters:
Parameter | Type | Description |
|---|---|---|
mode | string | Runs one of the following operations for the plan:
|
If you want to create a schedule for a failover plan, then the /FailoverPlans/{id} resource can have the following specific parameters:
Parameter | Type | Description |
|---|---|---|
startTime | string | Runs the failover plan at specific time. For more information on setting the DateTime value, see this Microsoft KB article. |
previousPlanId | string | Runs the failover plan in chain after another plan with the specified ID. Note: This is the top priority property. If you set the previousPlanId value, it will ignore all previously configured startTime values. |
If you want to resume a HALTED failover plan, then the /FailoverPlans/{id} resource must have the following specific parameter:
Parameter | Type | Description |
|---|---|---|
executionContinueOptions | string | Defines whether the failover plan execution will proceed from the next VM (ProceedToNextVm) or VM group included in the plan (ProceedToNextGroup), proceed from the next plan step (ProceedToNextStep), retry the failed step (RetryFailedStep), retry the failed VM (RetryFailedVm) or VM group (RetryFailedGroup). |
If you want to reset a failover plan, then the /FailoverPlans/{id} resource must have one of the following specific parameters:
Parameter | Type | Description |
|---|---|---|
resetState | boolean | Resets the failover plan state to DISABLED. For more information on states that a failover plan can acquire, see the Veeam Availability Orchestrator User Guide. |
resetChangeLog | boolean | Clears the change log history in the Plan Definition Report. For more information on the Plan Definition Report, see the Veeam Availability Orchestrator User Guide. |
resetConfiguration | boolean | Both resets the plan state, clears the change log history and returns all parameter settings to their default values. |
