Updating VMware Tools fails with the error: " Update Tools failed. Edit the virtual machine's vmx file"

Products

• VMware Desktop Hypervisor
• VMware vSphere ESXi

Issue/Introduction

• Unable to update VMware Tools
• Updating VMware Tools fails
• The following error may been seen:
  
  Update Tools failed. Edit the virtual machine's vmx file, add the line below and try again. Please read KB article tips for editing a vmx file.

isolation.tools.guestInitiatedUpgrade.disable = "FALSE"

Environment

• VMware ESXi 4.1.x Installable
• VMware ESXi 5.0
• VMware ESXi 5.1
• VMware ESXi 5.5
• VMware ESXi 6.0
• VMware ESXi 6.5
• VMware ESXi 6.7
• VMware ESXi 7.0
• VMware ESXi 8.0
• VMware ESXi 9.0
• VMware Fusion 3.x
• VMware Fusion 4.x
• VMware Fusion 5.x
• VMware Fusion 6.x
• VMware Fusion 7.x
• VMware Fusion 8.x
• VMware Fusion 10.x
• VMware Fusion Pro 8.x
• VMware Fusion Pro 10.x
• VMware Player 3.x (Linux & Windows)
• VMware Player 4.x (Linux & Windows)
• VMware Player 5.x (Linux & Windows)
• VMware Player 6.x (Linux & Windows)
• VMware Player 7.x (Linux & Windows)
• VMware Player Pro 7.x (Linux & Windows)
• VMware Workstation 7.x (Linux & Windows)
• VMware Workstation 8.x (Linux & Windows)
• VMware Workstation 9.x (Linux & Windows)
• VMware Workstation 10.x (Linux & Windows)
• VMware Workstation 11.x (Linux & Windows)
• VMware Workstation Player 12.x (Linux & Windows)
• VMware Workstation Player 14.x (Linux & Windows)
• VMware Workstation Player 15.x (Linux & Windows)
• VMware Workstation Pro 14.x (for Linux & Windows)
• VMware Workstation Pro 15.x (Linux & Windows)

Cause

This issue occurs because, for security purposes, updating VMware Tools from within the guest is disabled by default.

Resolution

To resolve this issue, enable VMware Tools updates from within the guest by updating the virtual machine configuration file.

In Fusion, Player, or Workstation

1. Shut down the virtual machine, if it is running.
2. Open the virtual machine configuration file (<vmname>.vmx) using a text editor. For more information, see:
   • Fusion: Editing the .vmx file for your Fusion virtual machine
   • Workstation: Editing the .vmx file of a VMware Workstation and VMware Player virtual machine
3. Add this line to the end of the file:
   
   isolation.tools.guestInitiatedUpgrade.disable = "FALSE"
    
4. Save and close the <vmname>.vmx file.
5. Power on the virtual machine.
6. Start the VMware Tools upgrade within the guest operating system.

In ESXi using the vCenter Server vSphere Client

1. Shut down the virtual machine, if it is running.
2. Open the datastore browser and navigate to the virtual machine directory.
3. Using the UI option, download the <vmname>.vmx to your local desktop.
4. Create a backup of the <vmname>.vmx on a local workstation.
5. Open the .vmx file using a text editor and add this line to the end of the file:
   
   isolation.tools.guestInitiatedUpgrade.disable = "FALSE"
   
   Note: For more information, see Tips for editing a .vmx file.
    
6. When saved, upload the file via the datastore browser UI.
7. Power on the virtual machine.
8. Verify functionality before deleting the .vmx backup on your local workstation.
9. Start the VMware Tools upgrade within the guest operating system.

In ESXi Host Web Client

1. Login to ESXi Host via Web Client.
2. Right-click on virtual machine and click to shutdown or Power off the virtual machine.
3. Right-click on virtual machine and click edit settings.
4. Click the Options tab and select General under Advanced.
5. Click Configuration Parameters and a new window opens.
6. Click Add Row and type isolation.tools.guestInitiatedUpgrade.disable and FALSE under Value
7. Click OK twice to close all the windows.

In ESXi using the Command Line

1. Shut down the virtual machine, if it is running.
2. Open an SSH session to a host. For more information, see Using ESXi Shell in ESXi
3. Navigate to the virtual machine directory.
4. Run this command to create a backup of the <vmname>.vmx file:
   
   cp <vmname>.vmx <vmname>.vmx.backup
    
5. Open the <vmname>.vmx file with a text editor and add this line to the end of the file:
   
   isolation.tools.guestInitiatedUpgrade.disable = "FALSE"
   
   Note: For more information, see Modifying host entry in /etc/hosts file for vCenter or ESXi host Editing files on an ESX host using vi editor.
    
6. Power on the virtual machine.
7. Verify the virtual machine is functional before deleting the backup file. To delete the backup file, run the command:
   
   rm <vmname>.vmx.backup
    
8. Start the VMware Tools upgrade within the guest operating system.

Additional Information

Note: To workaround this issue, connect directly to the ESXi/ESX host or the vCenter Server and upgrade VMware Tools on the virtual machine. For more information, see General VMware Tools installation instructions.