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

Properties

The resources in the /FailoverPlans collection have properties that represent failover plan settings. Properties can be used in POST requests as well as for query parameter values in GET requests.

Property

Type

Description

name

string

Name of a failover plan.

id

string

System ID assigned to a failover plan in VAO RESTful API.

contactName

string

Contact name of a person responsible for monitoring VAO performance.

contactEmail

string

Contact email of a person responsible for monitoring VAO performance.

contactTel

string

Telephone number of a person responsible for monitoring VAO performance.

description

string

Description of a failover plan.

planState

string

Current state of a failover plan.

planStateDetails

string

Provides additional details on processing a failover plan and shows the number of errors and warnings occurred.

planInUse

boolean

Defines whether a failover plan is in one of active states or halted.

scheduleEnabled

boolean

Defines whether a failover plan has a configured schedule.

scheduleType

string

Defines whether a failover plan will run at a specific time (OnTime) or right after another plan (AfterPlan).

scheduleAfter

string

System ID of the preceding plan.

scheduleAfterPlanName

string

Name of the preceding plan.

scheduleTime

string

Date and time when a failover plan will run.

siteScopeId

string

System ID of a VAO scope for which a failover plan was created.

targetPRO

integer

Target Recovery Point Objective for a failover plan (in minutes).

targetRTO

integer

Target Recovery Time Objective for a failover plan (in minutes).

_links

dictionary of string [key] and object [value]

Links to related resources (navigation property).

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference