Introduction
In this blog we will show how to create a custom ESXI ISO. This process is useful for deploying ESXI and being compliant with the Baseline or commissioning the host in a VCF environment.
To meet the specific needs of your environment, you can create a custom ISO file for ESXi using VMware PowerCLI or vSphere Lifecycle Manager.
You may need to create a custom ESXi ISO image in these scenarios:
- The ESXi version listed in the VMware Cloud Foundation BOM lacks an ISO file on VMware Customer Connect, often seen with ESXi patch releases.
- An asynchronous patch version of ESXi is required.
- A vendor-specific (OEM) ISO file is necessary.
Prerequisites
- Make sure you have a Windows PC with VMware PowerCLI and Python installed.
- Download the ESXi Base offline bundle from [here].
- Obtain the required drivers or software from the VMware/Product Site to include in the custom ISO.
Before creating the custom ESXi image, understand these key terms:
DepotBaseImages: A DepotBaseImage refers to the core components and base images stored within a software depot. A software depot in VMware is a repository that contains various software packages, including image profiles and VIBs (vSphere Installation Bundles). These depots are used to manage and distribute ESXi software updates and installations.
DepotAddons: A DepotAddon refers to additional software packages or components that can be added to a base ESXi image. These addons are stored in a software depot, similar to the base images, and are used to extend the functionality or customize the ESXi installation.
Preparation
Before we can create the custom ISO we will need to download the ESXI depot from the Broadcom support portal.
1. Navigate to https://broadcom.com/
2. Click on “Support Portal” and “Go to Portal”.
3. Login with your Broadcom credentials
4. Click on the “Product Icon” and choose “VMware Cloud Foundation”.
5. Go to “My Download” and search for “vSphere”.
6. Click on “VMware vSphere”.
7. Go to “Solutions”.
8. Click on “VMware vSphere” and choose your “Product” and “Version”.
In my case this will be: VMware ESXi 7.0U3p (23307199)
9. Download the .zip file under the “Solution Downloads” tab.
The file is called: VMware-ESXi-7.0U3p-23307199-depot.zip
10. Save the file and place in a location of choice.
For me this will be “C:\Temp\VMware-ESXi-7.0U3p-23307199-depot.zip”
11. If you want you can also download driver addons.
In my case this is not necessary.
Create the custom ISO
Custom ISO creation with PowerCLI
In this part we will show you how to create a custom ESXI ISO with PowerCLI.
1. Open Powershell
2. Run the following command:
Get-DepotBaseImages "c:\temp\VMware-ESXi-7.0U3p-23307199-depot.zip"
You will get a result like this:
Version Vendor Release date
------- ------ ------------
7.0.3-0.110.23307199 VMware, Inc. 03/04/2024 23:00:00
3. You can also check the “DepotAddons” by running:
Get-DepotAddons “c:\temp\Dell-i40en-Addon-depot.zip”
4. Now we got the information we can to create the software spec .JSON file. The software spec is a JSON file that contains information about the ESXi version and vendor add-on (if applicable).
Here is a example:
{
"add_on": {
"name": "Dell-i40en-Addon",
"version": "2.5.11.0"
},
"base_image": {
"version": "7.0.3-0.110.23307199"
},
"components": null,
"hardware_support": null,
"solutions": null
}
5. Save this file as a .JSON on the same location as the “DepotBaseImage” and “DepotAddons”.
6. Now we will run the command to create the new ISO by running the following command:
New-IsoImage -SoftwareSpec “c:\temp\VMware-ESXi-7.0U3p-23307199-depot.JSON” -Depots “c:\temp\VMware-ESXi-7.0U3p-23307199-depot.zip” , “c:\temp\Dell-i40en-Addon-depot.zip” -Destination “c:\temp\VMware-ESXi-7.0U3p-23307199-custom.iso”
7. Your ISO file is saved on the location specified under “-Destination” parameter.
Custom ISO creation with vSphere Lifecycle Manager
In this part we will show you how to create a custom ESXI ISO with vSphere Lifecycle Manager.
1. Login to your vCenter.
2. Create a new cluster.
If your cluster is already using “Manage all hosts in the cluster with a single image”, you can skip to step X.
3. Give the cluster a name, check the box “Manage all hosts in the cluster with a single image” and click on “Next”.
4. Choose your ESXI version and click on “Next”.
5. Go to your newly created cluster, choose “Updates” and “Edit” the image.
6. Click on “Add Components”.
7. Make sure to select show “Independent components and Vendor Addon Components”.
8. Choose your “Addon” and choose the “Version”. After that click on “Select”
9. Save the changes.
10. Click on the “Three dots” and choose “Export”.
11. Select “ISO” and click on “Export”.
12. Your download will start in your browser.
