带有虚拟机角色描述的 XML 文件
VM roles that you can assign to verified VMs and VMs from the application group are described in XML files. These XML files are stored in the %ProgramFiles%\Veeam\Backup and Replication\Backup\SbRoles folder on the backup server.
To add a new role, you must create a new XML file and save it to the SbRoles subfolder on the backup server. Do not save the XML file on the machine where the Veeam Backup & Replication console is installed — this will not affect the list of roles in Veeam Backup & Replication.
XML files describing VM roles have the following structure:
<SbRoleOptions> <Role> <SbRole> <Id>4CDC7CC4-A906-4de2-979B-E5F74C44832F</Id> <Name>Web Server</Name> </SbRole> </Role> <Options> <SbVerificationOptions> <ActualMemoryPercent>100</ActualMemoryPercent> <MaxBootTimeoutSec>300</MaxBootTimeoutSec> <AppInitDelaySec>120</AppInitDelaySec> <TestScripts> <TestScripts> <TestScript> <Name>Web Server</Name> <Type>Predefined</Type> <TestScriptFilePath>Veeam.Backup.ConnectionTester.exe</TestScriptFilePath> <Arguments>%vm_ip% 80</Arguments> </TestScript> </TestScripts> </TestScripts> <HeartbeatEnabled>True</HeartbeatEnabled> <PingEnabled>True</PingEnabled> </SbVerificationOptions> </Options> </SbRoleOptions>
|
The XML file with the role description contains the following tags and parameters:
Tag | Required/ | Description |
---|---|---|
<SbRoleOptions> | Required | Encapsulates the VM role file. |
<Role> | Required | Parent tag for a role assigned to a VM. <SbRole>, <Id> and <Name> are children of this tag. |
<SbRole> | Required | Encapsulates basic information for a VM role: ID and name. |
<Id> | Required | Unique identifier of a VM role. |
<Name> | Required | Name of a VM role. The VM role name is displayed in the roles list on the Role tab. |
<Options> | Required | Parent tag for startup and test script options to be used for the defined role. <SbVerificationOptions>, <ActualMemoryPercent>, <MaxBootTimeoutSec>, <AppInitDelaySec>, <TestScripts>, <Name>, <Type>, <TestScriptFilePath>, <Arguments>, <HeartbeatEnabled>, <PingEnabled> are children of this tag. |
<SbVerificationOptions> | Required | Encapsulates options data for a VM role. |
<ActualMemoryPercent> | Optional | Percent of the original memory level that must be pre-allocated to a verified VM on the system boot. |
<MaxBootTimeoutSec> | Optional | Maximum allowed time to boot a VM. |
<AppInitDelaySec> | Optional | Duration of time for which Veeam Backup & Replication must wait after the VM is successfully booted in the virtual lab. After this time elapses, Veeam Backup & Replication will run test scripts. Time is specified in seconds. |
<TestScripts> | Optional | Encapsulates test script data for a VM role. |
<Name> | Optional | Name of a VM role. The VM role name is displayed on the Test Scripts tab. |
<Type> | Optional | Type of the test script: Predefined or Custom. |
<TestScriptFilePath> | Optional | Path to an executable file of the test script to be performed. The path can be absolute or relative. |
<Arguments> | Optional | Arguments to be passed to the script. You can use the following variables:
or %vm_fqdn% — a fully qualified domain name of a verified VM.
|
<HeartbeatEnabled> | Required | Must a heartbeat test be enabled for this VM role: True or False. |
<PingEnabled> | Required | Must a ping test be enabled for this VM role: True or False. |