This is an archive version of the document. To get the most up-to-date information, see the current version.Properties
The resources in the /FailoverPlans collection have properties that represent VAO site 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 Veeam Availability Orchestrator 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. |
scheduleEnabled | boolean | Defines whether a failover plan has a configured schedule. |
scheduleType | string | Defines whether a failover plan will run at specific time (OnTime) or right after another plan (AfterPlan). |
scheduleAfter | string | System ID of a preceding failover plan. |
scheduleAfterPlanName | string | Name of a preceding failover plan. |
scheduleTime | string | Date and time when a failover plan will run. |
siteId | string | System ID of a VAO site for which a failover plan is created. |
_links | dictionary of string [key] and object [value] | Links to related resources (navigation property). |
