Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Restore Plan Action Parameters

If you want to create a schedule for a restore plan, then the /RestorePlans/{id} resource can have the following specific parameters:

Parameter

Type

Description

startTime

string

Runs the restore plan at a specific time.

For more information on how to set the DateTime value, see this Microsoft KB article.

previousPlanId  

string

Runs the restore 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 halt a restore plan, then the /RestorePlans/{id} resource must have the following specific parameter:

Parameter

Type

Description

fullStop

boolean

Defines whether VAO will run other plans scheduled in chain after the halted plan.

If you want to resume a HALTED restore plan, then the /RestorePlans/{id} resource must have the following specific parameter:

Parameter

Type

Description

executionContinueOptions

string

Defines whether the restore 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 restore plan, then the /RestorePlans/{id} resource must have one of the following specific parameters:

Parameter

Type

Description

resetState

boolean

Resets the current restore plan state to DISABLED.

For more information on states that a restore plan can acquire, see the Veeam Availability Orchestrator User Guide, section Running and Scheduling Restore Plans.

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, section Generating Plan Definition Report.

resetConfiguration

boolean

Both resets the current plan state, clears the change log history and returns all parameter settings to their default values.

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference