#1 Global Leader in Data Resilience

Veeam VM Migrator Tool

KB ID: 2136
Product: Veeam Backup & Replication | 12.2
Published: 2016-06-08
Last Modified: 2024-09-13
mailbox
Get weekly article updates
By subscribing, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.

Cheers for trusting us with the spot in your mailbox!

Now you’re less likely to miss what’s been brewing in our knowledge base with this weekly digest

error icon

Oops! Something went wrong.

Please, try again later.

Unsupported Tool

This Veeam-developed tool is provided as a courtesy and is not supported by Veeam Technical Support.

If any issues arise during the usage of this tool, customers are advised to restore from a configuration backup to rever the Veeam Backup & Replication configuration to the last known stable state.

Veeam Technical Support will not assist with the usage or troubleshooting of this tool.

Cloud Connect Jobs Unsupported

This tool cannot fix jobs targeting a Cloud Connect repository.

You must perform an Active Full backup.

Purpose

The Veeam VM Migrator Tool (Veeam.Backup.VmMigrator.exe) will assist customers in resolving the misalignment of MORef-IDs between what they are in the VMware environment and what is stored in the VBR configuration database, thereby ensuring jobs for VMs whose MORef-ID has changed can resume using incremental processing and avoid those VMs being treated as wholly new VMs.

 

Detailed Summary

When a virtual machine (VM) is added to a job in Veeam Backup & Replication (VBR), that VM's vSphere-assigned Managed Object Reference ID (MORef-ID) is recorded within the VBR configuration database. In addition to the VM's MORef-ID, the BIOS UUID of the VM is recorded in the database as a secondary reference point for identifying the machine. VBR then uses the MORef-ID to refer to the VM when interacting with the vSphere environment. This ensures that VBR always interacts with the correct VM, and tasks are unaffected should the VM's name be changed.

When a vCenter (VC or VCSA) is either rebuilt with a new database or a new VC is built and old resources are migrated, that vSphere environment will assign the VMs new MORef-IDs. This change in MORef-ID causes the entries within the VBR configuration database to become invalid. This, in turn, causes VBR to be unable to make requests to interact with and protect those VMs because the MORef-IDs it would attempt to reference when communicating with the VC have become invalid.

Resolving this misalignment of MORef-IDs between what they are in the vSphere environment and what was written in the VBR configuration database is the purpose of the Veeam VM Migrator Tool (Veeam.Backup.VmMigrator.exe). The tool will utilize three data points for each VM: name, MORef-ID, and BIOS UUID, and compare those found in the VBR configuration database with those found within the vSphere environment. The tool will then generate a migration task file that lists all potential matches for the user to review. The customer then reviews that list to verify by hand that the proposed MORef-ID changes are valid and then utilizes the VM Migrator Tool to make those MORef-ID updates within the VBR configuration database.

Due to the significant power this tool has to modify values within the VBR configuration database, customers are strongly encouraged to closely review the documentation included with the tool and ensure that they create a configuration backup before attempting to make any changes.

Requirements

Requirements Description
VMware vCenter Version 8.0 (up to 8.0 U3), 7.0 (up to 7.0 U3), 6.x.
Veeam Backup & Replication Version 12.2

To use the migration tool, you must have a VMware vCenter account with administrator rights.

Swipe to show more of the table

Considerations and Limitations

Before using this migration tool, consider the following:

  • It is necessary to make a configuration backup of Veeam Backup & Replication database.
  • Do not launch any backups for VMs from the new vCenter until you finish working with the utility. Otherwise - if there are any VMs backed up from the new vCenter - it will not be possible to migrate these VMs (due to the new VM objects already existing in the database).

    Note: If, for some reason, you have already added the new vCenter or ran any jobs which will have added new Ref-IDs to the database, you must rollback the Veeam Backup & Replication configuration database using a Configuration Restore to a config backup created before any such jobs were run.
  • Old vCenter must not be used by Veeam Backup & Replication after migration.
  • If you use the replication feature:
  • Virtual labs should be recreated manually after migration.
  • The VM containers will not be updated by the utility, you will need to manually re-add all folders, tags, datastores, clusters and resource pools in the list of VMs in backup and/or replica job settings.

Download Information

Download VM Migrator Tool

Updated: 2024-09-12

MD5: BCEC6BC80698BB4B39836ABDCC30C729
SHA1: 79CD200F08554F064ACA5E94C90360FBD3FCA6BA

Documentation
The downloaded package contains a PDF file that documents all requirements, limitations, and usage of the Veeam VM Migrator Tool.
To submit feedback regarding this article, please click this link: Send Article Feedback
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.

Spelling error in text

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply except as noted in our Privacy Policy.
Thank you!

Thank you!

Your feedback has been received and will be reviewed.

Oops! Something went wrong.

Please, try again later.

You have selected too large block!

Please try select less.

KB Feedback/Suggestion

This form is only for KB Feedback/Suggestions, if you need help with the software open a support case

By submitting, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.
This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply except as noted in our Privacy Policy.
Verify your email to continue your product download
We've sent a verification code to:
  • Incorrect verification code. Please try again.
An email with a verification code was just sent to
Didn't receive the code? Click to resend in sec
Didn't receive the code? Click to resend
Thank you!

Thank you!

Your feedback has been received and will be reviewed.

error icon

Oops! Something went wrong.

Please, try again later.