VMware
 

Knowledge Base

Search the Knowledge Base:
Products:
Search In:
 

Tips for Editing a .vmx File

Details

I need to edit the configuration file (.vmx) for a virtual machine. Is there anything I need to know before I begin?

Solution

Some workaround procedures include steps that require you to edit the .vmx file.

Note the following important characteristics of this file:

  • The .vmx file is typically located in the directory where you created the virtual machine. For example, on Windows 2000, the default location for the file is usually C:\Documents and Settings\\My Documents\My Virtual Machines\\.vmx. On Linux, vmware-cmd -l lists the full path to all registered .vmx files.
  • The virtual machine actively writes to its .vmx file. Never edit this file while its virtual machine is running.
  • Changes to the file are usually version-specific. If you upgrade, the workaround you implemented may no longer work.

Before you edit the .vmx file:

  • Always power off the virtual machine.
  • Make sure you are logged on as a user with the correct permission level to edit the file.
  • Make a backup copy of the .vmx file. If your edits break the virtual machine, you can roll back to the original version of the file.
Also, make a backup copy of the edited file. If future administrative changes to the virtual machine overwrite your edited version, you can cut and paste the specific section you want from the backup copy into the current file. Do not replace an entire .vmx file with an older backup.
 
Important for ESX Server with VirtualCenter: Any manual additions to the .vmx file from ESX Server 3.x are overwritten by the entries stored in the VirtualCenter database.

If you need to edit a virtual machine's .vmx file, first remove it from VirtualCenter's inventory (right-click it and choose Remove from Inventory). After you edit it, register the virtual machine again from the ESX Server command line using:
 
vmware-cmd -s register /<path>/<to>/<.vmx>

A return code =1 signals success.

Keywords

1714

Feedback

Rating: 1 - Lowest 2 3 4 5 - Highest (5 Ratings)   

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.
What can we do to improve this information? (2000 or fewer characters)
Submit
Rating: 1 - Lowest 2 3 4 5 - Highest (5 Ratings)   
Actions
  • KB Article: 1714
  • Updated: Aug 14, 2009
  • Products:
    VMware ESX
    VMware GSX Server
    VMware Workstation