“esxcli software vib” commands to patch an ESXi 6.x/7.x/8.x host
search cancel

“esxcli software vib” commands to patch an ESXi 6.x/7.x/8.x host

book

Article ID: 343840

calendar_today

Updated On:

Products

VMware vSphere ESXi

Issue/Introduction

This article outlines the procedure for installing patches on an ESXi 6.x/7.x/8.x host from the command line using esxcli software vib commands.

Environment

VMware vSphere ESXi 6.x
VMware vSphere ESXi 7.x
VMware vSphere ESXi 8.x

Resolution

To patch an ESXi host from the command line:

  1. Patches for VMware products can be obtained from the Home - Support Portal - Broadcom support portal . Select ESXi (Embedded and Installable) in the product dropdown and click Search.
  2. Click the Download link below the patch Release Name to download the patch to your system.
  3. Upload the patch to a datastore on your ESXi 6.x/7.x/8.x host using the Datastore Browser from vCenter Server or a direct connection to the ESXi 6.x/7.x/8.x host using the vSphere Web client.

    Note: VMware recommends creating a new directory on the datastore and uploading the patch file to this directory.
  4. Log in to the local Tech Support Mode console of the ESXi 6.x/7.x/8.x host. For more information, see Using ESXi Shell in ESXi 6.x and 7.x (2004746)
  5. Migrate or power off the virtual machines running on the host and put the host into maintenance mode. Confirm if the host is in maintenance mode by running this command:
    vim-cmd /hostsvc/hostsummary | grep inMaintenanceMode
  6. To enter maintenance mode : # vim-cmd /hostsvc/maintenance_mode_enter
  7. Navigate to the directory on the datastore where the patch file was uploaded to and verify that the file exists by running these commands:

    cd /vmfs/volumes/Datastore/DirectoryName
    ls

    Where Datastore is the datastore name where the patch file was uploaded to, and DirectoryName is the directory you created on the datastore.
     
  8. Install or update a patch on the host using these esxcli commands:

    Notes:

    • To install or update a .zip file, use the -d option. To install or update a .vib file use the -v option.

    • Using the update command is the recommended method for patch application. Using this command applies all of the newer contents in a patch, including all security fixes. Contents of the patch that are a lower revision than the existing packages on the system are not applied.

    • Using the install command overwrites the existing packages in the system with contents of the patch you are installing, including installing new packages and removing old packages. The install command may downgrade packages on the system and should be used with caution. If required, the install command can be used to downgrade a system (only for image profiles) when the --allow-downgrade flag is set.
      Using the install command overwrites the existing packages in the system with contents of the patch you are installing, including installing new packages and removing old packages. The install command may downgrade packages on the system and should be used with caution. If required, the install command can be used to downgrade a system (only for image profiles) when the --allow-downgrade flag is set.

    Caution: The install method has the possibility of overwriting existing drivers. If you are using third-party ESXi images or the ESXi host is part of a vSAN cluster, VMware recommends using the update method to prevent an unbootable state or a vSAN node that no longer contributes storage to the cluster.

     

    To Install:

    • Using local setup:

      esxcli software vib install -d "/vmfs/volumes/Datastore/DirectoryName/PatchName.zip"

      Where PatchName.zip is the name of the patch file you uploaded to the datastore.

      Note: Alternatively, you can use the datastore's UUID instead of the DirectoryName .

      For example:

      esxcli software vib install -d "/vmfs/volumes/datastore1/patch-directory/server name-201111001.zip"

      or

      esxcli software vib install -d "/vmfs/volumes/<UUID>/patch-directory/server name-201111001.zip"
       
    • Using http setup:

      esxcli software vib install -v viburl

      Where viburl is the URL to the http depot where VIB packages reside.

      For example:

      esxcli software vib install -v https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/esx/vmw/vib20/tools-light/VMware_locker_tools-light_5.0.0-0.7.515841.vib
       

    To Update:

    • Using local setup:

      esxcli software vib update -d "/vmfs/volumes/Datastore/DirectoryName/PatchName.zip"

      Where PatchName.zip is the name of the patch file you uploaded to the datastore.

      Note: Alternatively, you can use the datastore's UUID instead of the DirectoryName.

      For example:

      esxcli software vib update -d "/vmfs/volumes/datastore1/patch-directory/server name-201111001.zip"

      or

      esxcli software vib update -d "/vmfs/volumes/<UUID>patch-directory/server name-201111001.zip"
       
    • Using http setup:

      esxcli software vib update -v viburl

      Where viburl is the URL to the http depot where VIB packages reside.

      For example:

      esxcli software vib update -v https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/esx/vmw/vib20/tools-light/VMware_locker_tools-light_5.0.0-0.7.515841.vib
       
  9. Verify that the VIBs are installed on your ESXi host:

    esxcli software vib list

    For example:

    esxcli software vib list

    Name Version Vendor Acceptance Level Install Date
    ----------------- --------------------------- ------ ---------------- ------------
    ata-pata-amd 0.3.10-3vmw.500.0.0.469512 VMware VMwareCertified 2012-05-04
    ata-pata-atiixp 0.4.6-3vmw.500.0.0.469512 VMware VMwareCertified 2012-05-04
    ata-pata-cmd64x 0.2.5-3vmw.500.0.0.469512 VMware VMwareCertified 2012-05-04
    ata-pata-hpt3x2n 0.3.4-3vmw.500.0.0.469512 VMware VMwareCertified 2012-05-04
     
  10. After the patch has been installed, reboot the ESX host:

    reboot
     
  11. After the host has finished booting, exit maintenance mode and power on the virtual machines:

    vim-cmd hostsvc/maintenance_mode_exit



Additional Information

VMware Skyline Health Diagnostics for vSphere - FAQ

For more information, also see the following related VMware vSphere Blogs on patching an ESX/ESXi host using Command-line:

Powered by Wolken Software