Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
User Guide

Parameter Variables

Parameter variables are passed between steps during plan execution, and are available when editing and adding a step parameter.

You can define the following variables for any step parameter that allows plain text to be entered:

Parameter Variable

Content

%vm_fqdn%

FQDN of the currently processed VM

%current_vm_ip%

IP address of the currently processed VM

%current_vm_name%

Name of the currently processed VM

%current_vm_ip_list%

All IP addresses of the currently processed VM

%replica_vm_ip%

IP address of the currently processed replica VM

%replica_vm_ip_list%

All IP addresses of the currently processed replica VM

%replica_vm_name%

Name of the currently processed replica VM

%replica_vm_state%

State of the currently processed replica VM

%source_vm_ip%

IP address of the source VM

%source_vm_ip_list%

All IP addresses of the source VM

%source_vm_name%

Name of the source VM

%plan_name%

Name of the orchestration plan

%vao_server_name%

Name of the VAO server

%plan_state%

Current state of the orchestration plan

%plan_test_mode%

Boolean variable that indicates whether the plan is currently being tested (True/False)

%group_name%

Name of the currently processed VM group

%plan_summary%

Output information on the orchestration plan (error/warning/success for all steps)

%group_summary%

Output information on the currently processed VM group

%vm_summary%

Output information on the currently processed VM

%vao_ui%

URL to access HOME page of the VAO UI

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference