Veeam Availability Orchestrator 3.0
REST API Reference
Related documents

Schemas

The following JSON schemas and subschemas are used to represent resources in the /RuntimeDetails collection in the VAO REST API. Properties included in schemas and subschemas represent runtime details for VAO entities and can be used for query parameter values in GET requests.

SchemasPlanRuntimeDetails

Property

Type

Description

state

string

Current state of a 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.

isEditingByCurrentUser

boolean

Defines whether the plan is being edited by another user.

currentEditingUser

string

User that is currently editing the plan.

lastStableState

string

Last stable state of the plan.

lastStableStateName

string

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

totalProgress

integer

Plan execution progress (in percent).

currentRunResult

boolean

Status of the current run of the plan.

currentTestResult

boolean

Status of the currently running plan test.

currentCheckResult

string

Status of the currently running readiness check for the plan.

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.

siteScopeId

string

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

siteScopeName

string

Name of the VAO scope.

recoveryToNewLocation

boolean

Defines whether to restore VMs to a new location.

roles

Array[string]

Roles assigned to the currently logged in user or client.

executionState

string

Current status of the plan execution task.

executionResult

TaskExecutionResult

Information on the task execution.

id

string

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

name

string

Name of the plan.

progress

integer

Task execution progress (in percent).

 

SchemasGroupRuntimeDetails

Property

Type

Description

groupType

string

Type of a group.

successCount

integer

Number of steps completed [applies to a virtual group] or VMs processed [applies to a VM group] successfully.

warningCount

integer

Number of steps completed [applies to a virtual group] or VMs processed [applies to a VM group] with warnings.

errorCount

integer

Number of steps completed [applies to a virtual group] or VMs processed [applies to a VM group] with errors.

totalCount

integer

Total number of items in 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.

isParallel

boolean

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

parallelProcessingVmsCount

integer

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

vmsCriticality

string

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

executionState

string

Current status of the group processing task.

executionResult

TaskExecutionResult

Information on the task execution.

id

string

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

name

string

Name of the group.

progress

integer

Task execution progress (in percent).

SchemasVmRuntimeDetails

Property

Type

Description

isCritical

boolean

Defines whether a VM is critical.

successCount

integer

Number of steps added for the VM completed successfully.

warningCount

integer

Number of steps added for the VM completed with warnings.

errorCount

integer

Number of steps added for the VM completed with errors.

totalCount

integer

Total number of steps added for the VM.

number

integer

VM ordinal number.

isWebConsoleAvailable

boolean

Defines whether the web console is available.

sourceMissing

boolean

Defines whether the source VM is deleted.

executionState

string

Current status of the VM processing task.

executionResult

TaskExecutionResult

Information on the task execution.

id

string

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

name

string

Name of the VM.

progress

integer

Task execution progress (in percent).

SchemasStepRuntimeDetails

Property

Type

Description

actionType

string

Type of an action performed by a step.

executionState

string

Current status of the step processing task.

executionResult

TaskExecutionResult

Information on the task execution.

id

string

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

name

string

Name of the step.

progress

integer

Task execution progress (in percent).

 

SchemasTaskExecutionResult

Property

Type

Description

startTime

string

Date and time when the task execution started.

finishTime

string

Date and time when the task execution completed.

result

string

Status of the current run of the task.

details

DetailedInfo

Detailed information on the run of the task.

SchemasDetailedInfoModel

Property

Type

Description

friendlyInfo

object

Information on an action performed during the task run.

level

string

Logging level.

severity

string

Severity status of the action.

timestamp

string

Exact date and time of performing the action.

This Document Help Center
User GuideGroup Management GuideREST API ReferenceVeeam Backup & Replication DocumentationVeeam ONE Documentation
I want to report a typo

There is a misspelling right here:

 

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