Skip to main content
  • EN

UPDATE--  As of Veeam 12.3… The MorefID Tool is no longer available as its now apart of 12.3 feature set.

 

12.3 What’s New - https://www.veeam.com/veeam_backup_12_3_whats_new_wn.pdf

HelpCenter - https://helpcenter.veeam.com/docs/backup/powershell/veeam_vm_migrator.html?ver=120

 

 

Hey Everyone,

 

What is a Moref ID?

 

In VMware, a Moref ID (Managed Object Reference ID) is a unique identifier assigned to different objects or resources within the vSphere environment, like virtual machines, hosts, or data stores. It helps VMware keep track of and manage these objects.

Think of it like a name tag that VMware uses to identify and reference each specific object in its system.

 

The MoRef ID naming starts with a prefix stating the object type followed by a hyphen and a number, for example, vm-197, host-29, domain-c26. Every object has its own MoRef address: https://<VCENTER>/mob/?moid=<OBJECTID>.

 

 

So why is it Important?

 

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.

This is definitely a great tool offered by Veeam even though not supported.  It works well and I have used it several times for migrations.

Can’t wait to check it out. Thanks 😊 

Thank you @andy.sturniolo for sharing and the explanation on this great tool.

Is this tool only for migrating all VMs from an existing VC to an empty one? Or can it operate on VM base? We are currently consolidating our 2 VC into one. There are VMs in both VC, some host and cluster with their VMs will now be migrated to VC A. Can I used this tool  to map all VMs from VC B? 

Is this tool only for migrating all VMs from an existing VC to an empty one? Or can it operate on VM base? We are currently consolidating our 2 VC into one. There are VMs in both VC, some host and cluster with their VMs will now be migrated to VC A. Can I used this tool  to map all VMs from VC B? 

Yes you should be able to do this as well. I cannot see why not and what would require a new VC.

The KB KB2136: Veeam VM Migrator Tool is not that clear to be but I didn’t try it out yet

The KB KB2136: Veeam VM Migrator Tool is not that clear to be but I didn’t try it out yet

I would try it out and see. I cannot see it not working .

I’m looking now at the PDF in the download that is a bit more detailed. What will the first (optional) step do? Is there just information gathered (where?) or will this already write to vCenter/VBR database? And in general, where do I run the tool? On VBR server, on any other host that has a console installed. Also, an example output for the Migration Task File would be nice. With the limitations and considerations at the beginning and the warnings, I’m not really sure I want to trial and error this. But it sounds cool ;)

 

Step 1. Update Existing VMs BIOS_UUID

This is an optional step that can be performed before migrating to the new vCenter in order to improve the accuracy of future VMs matching. If old vCenter is no longer operating, you can skip this step.

To update existing VMs BIOS_UUD, run the utility with the following syntax: Veeam.Backup.VmMigrator.exe prepareformigration <old_vCenter_Name>

Unsure as I have not used the utility much lately but I would suggest creating a test VM and run through the process.  Only way you are going to know for sure.

The tool I run it on VBR server itself.

yep, must run on VBR. I tried the premigration step but it fails with “Error: Access to the registry key 'HKEY_LOCAL_MACHINE\SOFTWARE\Veeam\Veeam Backup and Replication\DatabaseConfigurations' is denied.”. I started the tool in a powershell session and if I start regedit there I can access the regkey. Nothing useful in the tools log.

We are migrating our entire VM environment (150+ VMs) to a new cluster. This will take place over the course of a few weeks using the cross vCenter migration tool in VMWare. Veeam is configured with the old and new clusters. Can this tool be used to update just the VM’s that have been migrated to the new cluster? And run after each successful migration of a VM/subset of VMs?

yep, must run on VBR. I tried the premigration step but it fails with “Error: Access to the registry key 'HKEY_LOCAL_MACHINE\SOFTWARE\Veeam\Veeam Backup and Replication\DatabaseConfigurations' is denied.”. I started the tool in a powershell session and if I start regedit there I can access the regkey. Nothing useful in the tools log.

So it is possibly permissions.  Maybe run as administrator?

We are migrating our entire VM environment (150+ VMs) to a new cluster. This will take place over the course of a few weeks using the cross vCenter migration tool in VMWare. Veeam is configured with the old and new clusters. Can this tool be used to update just the VM’s that have been migrated to the new cluster? And run after each successful migration of a VM/subset of VMs?

As long as you run it prior to migration to capture the current information and then again after.

Thanks chris for the response to my previous question regarding running the tool multiple times throughout a staged migration from old to new vCenter. I’m just about to test it and noticed the following line mentioned in the documentation for the tool.


“Old vCenter must not be used by Veeam Backup & Replication after migration.”

My concern is the old vCenter will still be used for VM’s yet to be migrated.

I have only ever used this tool after a full VM migration from old to new vCenter servers in the past so this will be the first time using it over the course of a few days with 10 to 20 VM’s migrated per day.

Based on what you said previously my plan would be to run the migration tool prior to VM cross vCenter migration, pause any jobs targeting those VM’s, migrate VM’s, rerun the migration tool to update the MoRefs then un-pause jobs.

Then rise and repeat over each day until all VM’s have been migrated.

Does this sound feasible and have you done anything similar?

 

Thanks chris for the response to my previous question regarding running the tool multiple times throughout a staged migration from old to new vCenter. I’m just about to test it and noticed the following line mentioned in the documentation for the tool.


“Old vCenter must not be used by Veeam Backup & Replication after migration.”

My concern is the old vCenter will still be used for VM’s yet to be migrated.

I have only ever used this tool after a full VM migration from old to new vCenter servers in the past so this will be the first time using it over the course of a few days with 10 to 20 VM’s migrated per day.

Based on what you said previously my plan would be to run the migration tool prior to VM cross vCenter migration, pause any jobs targeting those VM’s, migrate VM’s, rerun the migration tool to update the MoRefs then un-pause jobs.

Then rise and repeat over each day until all VM’s have been migrated.

Does this sound feasible and have you done anything similar?

 

That sounds like how you will need to do it.  Since you are taking a few days you will need both vCenters up and running so you target the VMs you are moving and jobs associated as mentioned.

Hello there!

Quick doubt, as far as I know this was a Veeam Developer tool which had no support from Veeam Technical Support (As it mentions on the disclaimer)

However, at the starts mention that is supported on 12.2 and it also appears in official documentation.

So it is a bit unclear to me, is supported by Veeam Technical Support?

Appreciate the answers like always!

 

Hello there!

Quick doubt, as far as I know this was a Veeam Developer tool which had no support from Veeam Technical Support (As it mentions on the disclaimer)

However, at the starts mention that is supported on 12.2 and it also appears in official documentation.

So it is a bit unclear to me, is supported by Veeam Technical Support?

Appreciate the answers like always!

 

It should be supported since there is a help page on it - Veeam VM Migrator - Veeam Backup PowerShell Reference

 
 
 

Hello, 

We need to use this tool, but we can’t find it.

Also we can’t find kb: 2136

We’re on version: 12.2.0.334 and when we’re running 

Get-Command -Module Veeam.Backup.PowerShell in powershell there are no cmdlets like the ones in helpcenter.veeam.com/docs/backup/powershell/veeam_vm_migrator.html?ver=120

How can we use this? Do we need to upgrade to 12.3? 

Hey Everyone,

 

Last week, we reintroduced our vCenter migration tool (Veeam VM Migrator Tool). The tool is supported starting in version 12.2 and is compatible with configurations using both MSSQL and PostgreSQL databases.  Let's dive a little into Moref IDs…

 

What is a Moref ID?

 

In VMware, a Moref ID (Managed Object Reference ID) is a unique identifier assigned to different objects or resources within the vSphere environment, like virtual machines, hosts, or data stores. It helps VMware keep track of and manage these objects.

Think of it like a name tag that VMware uses to identify and reference each specific object in its system.

 

The MoRef ID naming starts with a prefix stating the object type followed by a hyphen and a number, for example, vm-197, host-29, domain-c26. Every object has its own MoRef address: https://<VCENTER>/mob/?moid=<OBJECTID>.

 

 

So why is it Important?

 

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.

 

Enter the VM Migrator Tool

 

The Veeam VM Migrator Tool (Veeam.Backup.VmMigrator.exe) helps customers resolve MORef ID mismatches between their VMware environment and the VBR configuration database. By correcting these discrepancies, the tool ensures that jobs for VMs with updated MORef IDs can continue using incremental processing, preventing the unnecessary full treatment of those VMs as entirely new instances.

 

Please check the Knowledge Base article for more important information such as requirements, considerations and limitations: https://www.veeam.com/kb2136

 

The tool operates at a vCenter level and encompasses all Moref ID objects.  There is currently no option for per-vm.

 

Disclaimer:

 

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 revert 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.

​@andy.sturniolo Few weeks ago I was looking for some tool to migrate, now I found it on your post.
Thank you for the whole explanation.

Can someone please send me the steps for how to use this VM Migrator Tool? 

I already have MorefID. How can I update this ID in Veeam DB and rerun the backup job. 

Can someone please send me the steps for how to use this VM Migrator Tool? 

I already have MorefID. How can I update this ID in Veeam DB and rerun the backup job. 

Did you check the OP as the link to the KB is there for this.

Where’s the link ? How can I download this tool & how to run it. 

I need all steps from start to finish. Please. Thank you.

 

Where’s the link ? How can I download this tool & how to run it. 

I need all steps from start to finish. Please. Thank you.

 

This is the link from the OP - https://www.veeam.com/kb2136

This explains the backup migrator tool.  It is built in to the Veeam installation directory and gives you the commands to run it with.  Sorry but doing this yourself is the best way to learn and not many here will provide all the needed steps.  You need to do some work yourself.

Where’s the link ? How can I download this tool & how to run it. 

I need all steps from start to finish. Please. Thank you.

 

This is the link from the OP - https://www.veeam.com/kb2136

This explains the backup migrator tool.  It is built in to the Veeam installation directory and gives you the commands to run it with.  Sorry but doing this yourself is the best way to learn and not many here will provide all the needed steps.  You need to do some work yourself.

Borderline Professional Services here :) 

 

Follow the document from start to finish and you should be ok.

 

https://helpcenter.veeam.com/docs/backup/powershell/veeam_vm_migrator.html?ver=120

 

 

Hi everyone, the previous, unsupported tool is no longer available. The way to go is to use the Powershell cmdlets which have been introduced with 12.3

https://helpcenter.veeam.com/docs/backup/powershell/veeam_vm_migrator.html?ver=120

 

Comment


Terms & Conditions