Schemas

The following JSON schemas and subschemas are used to represent resources in the /Plans collection in the VAO REST API. Properties included in schemas and subschemas represent VAO plan settings and can be used in POST requests as well as for query parameter values in GET requests.

SchemasRecoveryPlanInfo

 

Property

Type

Description

id

string

System ID assigned to a plan in the VAO REST API.

planType

string

Type of the plan.

recoveryLocationId

string

System ID in the VAO REST API assigned to a recovery location used by VAO to recover VMs included in the plan.

serverId

string

System ID assigned to the VAO server in the VAO REST API.

siteScopeId

string

System ID assigned to a VAO scope in the VAO REST API.

siteScopeName

string

Name of the VAO scope

name

string

Name of the plan.

state

string

Current state of the plan.

stateName

string

Current state of the plan as displayed in the VAO UI.

resultName

string

Plan execution details:readiness check result, number of errors and warnings occured.

lastStableState

string

Last stable state of the plan.

lastStableStateName

string

Last stable state of the plan as displayed in the VAO UI.

previousExecutionState

string

Previous state of the plan.

reportTemplateId

string

System ID in the VAO REST API assigned to a report template selected for the plan.

description

string

Description of the plan.

reportDocumentFormat

string

Format used by VAO to generate documents for the plan.

serverName

string

Name of the machine running the VAO server.

siteName

string

Name of the VAO server.

scheduleInfo

RecoveryScheduleInfo

Information on a plan schedule.

nearestFailoverScheduleTime

string

Next date and time scheduled to run the plan.

scheduledTestsInfo

ScheduleTestInfo

Information on a schedule created to test the plan.

nearestTestScheduleTime

string

Next date and time scheduled to test the plan.

haltedReason

string

Reason why the plan halted.

isEditingByCurrentUser

boolean

Defines whether the plan is being edited by another user.

currentEditingUser

string

User that is currently editing the plan.

progress

integer

Plan execution progress (in percent).

lastTestResult

string

Status of the most recent plan test.

lastTestTime

string

Date and time when plan testing started.

lastCheckResult

string

Status of the most recent readiness check run for the plan.

lastCheckTime

string

Date and time when the readiness check started.

lastTestResultName

string

Status of the most recent plan test as displayed in the VAO UI.

lastCheckResultName

string

Status of the most recent readiness check run for the plan as displayed in the VAO UI.

virtualLabId

string

System ID in the VAO REST API assigned to a DataLab used to test the plan.

contactName

string

Contact name of a person responsible for monitoring VAO performance.

contactEmail

string

Email of a person responsible for monitoring VAO performance.

contactTel

string

Telephone number of a person responsible for monitoring VAO performance.

currentRunResult

string

Status of the current run of the plan.

currentTestResult

string

Status of the currently running plan test.

currentCheckResult

string

Status of the currently running readiness check for the plan.

definitionReportStartTime

string

Next date and time scheduled to generate the Plan Definition Report.

readinessCheckStartTime

string

Next date and time scheduled to run a readiness check.

targetRecoveryTimeObjective

integer

Target Recovery Time Objective specified for the plan (in minutes).

currentRecoveryTimeObjective

integer

Current Recovery Time Objective achieved for the plan (in minutes).

targetRecoveryPointObjective

integer

Target Recovery Point Objective specified for the plan (in minutes).

currentRecoveryPointObjective

integer

Current Recovery Point Objective achieved for the plan (in minutes).

roles

Array[string]

Roles assigned to the currently logged in user or client.

SchemasRecoveryGroupInfo

Property

Type

Description

id

string

System ID in the VAO REST API assigned to a group added to a plan.

name

string

Name of the group.

order

integer

Group processing order.

serverId

string

System ID assigned to the VAO server in the VAO REST API.

isDefault

boolean

Defines whether the group is a VAO default group.

isParallel

boolean

[Applies to a VM group] Defines whether the parallel processing is enabled for the group.

type

string

Type of the group.

virtualType

string

[Applies to a virtual group] Virtual type of the group.

isProtected

boolean

[Applies to a VM group included in replica or restore plans] Defines whether the group is protected with a backup job.

protectVBRJobId

string

[Applies to a VM group included in replica or restore plans] System ID assigned to the backup job used to protect the group.

protectVBRJobName

string

[Applies to a VM group included in replica or restore plans] Name of the backup job used to protect the the group.

protectVBRJobServerId

string

[Applies to a VM group included in replica or restore plans] System ID of the Veeam Backup & Replication server where the backup job used to protect the group runs.

parallelProcessingVmsCount

integer

[Applies to a VM group] Maximum number of VMs in the group that are processed simultaneously when running the plan.

vmCount

integer

[Applies to a VM group] Total number of VMs in the group.

stepCount

integer

[Applies to a virtual group] Total number of steps in the group.

vmsCriticality

string

[Applies to a VM group] VM criticality settings specified for VMs in the group.

executionType

string

Type of the plan.

restoreVmTags

boolean

[Applies to a VM group] Defines whether to assign source VM tags to recovered VMs.

sourceMissing

boolean

[Applies to a VM group] Defines whether the group includes at least one VM whose source VM is deleted.

vcenter

string

[Applies to a VM group] vCenter Server that manages VMs added to the group.

datacenter

string

[Applies to a VM group] Datacenter that contains a host running VMs added to the group.

SchemasFailoverVmModel

Property

Type

Description

planId

string

System ID assigned to a plan in the VAO REST API.

id

string

System ID assigned to a VM in the VAO REST API.

name

string

Name of the VM.

number

integer

Ordinal number of the VM in a VM group.

isCritical

boolean

Defines whether the VM is critical for the plan execution.

sourceMissing

boolean

Defines whether the source VM is deleted.

SchemasStepInfoModel

Property

Type

Description

name

string

Name of a step.

type

string

Type of the step.

state

string

Internal VAO status of the step.

id

string

System ID assigned to the step in the VAO REST API.

order

integer

Order of the step in a plan.

description

string

Description of the step.

requiredForSuccess

boolean

Defines whether the step is required to complete for successful plan execution.

enabledForCurrentUser

boolean

Defines whether the step is enabled for the currently logged in user or client.

SchemasStepParameterInfo

Property

Type

Description

id

string

System ID assigned to a step parameter in the VAO REST API.

order

integer

Order of the step parameter execution.

isEditable

boolean

Defines whether the step parameter can be edited.

isSystem

boolean

Defines whether the step parameter is a system parameter.

displayName

string

Name of the step parameter as displayed in the VAO UI.

name

string

Name of the step parameter.

description

object

Description of the step parameter.

value

string

Step parameter value.

stepId

string

System ID assigned to a step in the VAO REST API.

type

string

Type of the step parameter.

planId

string

System ID assigned to a plan in the VAO REST API.

SchemasRecoveryScheduleInfo

Property

Type

Description

id

string

System ID assigned to a plan schedule in the VAO REST API.

timeSchedule

TimeScheduleInfo

Date and time scheduled to run the plan.

runAfterItemId

string

System ID assigned to the preceding plan in the VAO REST API.

runAfterItemName

string

Name of the preceding plan.

SchemasScheduleTestInfo

Property

Type

Description

scheduleInfo

RecoveryScheduleInfo

Information on a plan schedule.

scheduleName

string

Name of a schedule created to test the plan.

scheduleDescription

string

Description of the schedule created to test the plan.

virtualLabId

string

System ID in the VAO REST API assigned to a DataLab used to test the plan.

virtualLabName

string

Name of the DataLab.

backupServerName

string

Name of the Veeam Backup & Replication server connected to the VAO server.

virtualLabWaitTimeMinutes

integer

Defines the maximum amount of time (in minutes) for the DataLab to execute a plan test.

keepPlanRunning

boolean

Defines whether to power off plan VMs as soon as the testing process is over.

keepLabRunning

boolean

Defines whether to power off the DataLab as soon as the testing process is over.

recoveryTimeObjective

integer

Target Recovery Time Objective for the plan test (in minutes).

stopWhenRTOExceeded

boolean

Defines whether to power off plan VMs and the DataLab when the specified time period expires regardless of whether the testing process is over or not.

id

string

System ID in the VAO REST API assigned to the schedule created to test the plan.

planId

string

System ID assigned to the plan in the VAO REST API.

planName

string

Name of the plan.

type

string

Type of the schedule created to test the plan.

SchemasTimeScheduleInfo

Property

Type

Description

scheduleMode

string

Recurrence settings configured for a schedule.

startTime

string

Date and time scheduled to run the plan or test of the plan.

time

Array[integer]

[Applies only if scheduleMode is set to 'Interval', 'Daily' or 'Weekly'] Time of the day when the plan or plan test will run.

exactTime

string

[Applies only if scheduleMode is set to OneTime] Exact date and time when the plan or plan test will run.

daysOfWeek

string

[Applies only if scheduleMode is set to Weekly] Week day when the plan or plan test will run.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.