--- name: vmwaresolutions-usage_meter-upgrade title: Upgrading Usage Meter and swapping license keys description: As of 17 July 2025, new automated installations of Red Hat® OpenShift® for VMware® are no longer available for new or existing deployments of VMware Cloud Foundation for Classic - Automated instances. You can still use or delete your existing Red Hat OpenShift for VMware automated installations until 16 July 2026. The service will no longer be available from 17 July 2026. last-updated: 2026-08-12 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/vmwaresolutions?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. # Upgrading Usage Meter and swapping license keys {: #usage_meter-upgrade} As of 17 July 2025, new automated installations of Red Hat® OpenShift® for VMware® are no longer available for new or existing deployments of VMware Cloud Foundation for Classic - Automated instances. You can still use or delete your existing Red Hat OpenShift for VMware automated installations until 16 July 2026. The service will no longer be available from 17 July 2026. {: deprecated} Upgrade the existing VMware vCloud Usage Meters to version 9.x or later. The latest VMware vCloud Usage Meter available version is v9.1.0. For Usage Meter v4.8, the upgrade process involves receiving an access token for your currently registered Usage Meter through the IBM Cloud Usage Meter portal, followed by an in-place upgrade to v9.0.1 first. After the initial upgrade to v9.0.1, you don't need to provide the access token for further upgrades to v9.x or later. {: important} For Usage Meter v4.8, a direct upgrade path from Usage Meter v4.8 to v9.1 is not supported. You must upgrade from version 4.8 to version 9.0.1 first, and then to version 9.1. For more information, see [Upgrade Path - Product Interoperability Matrix](https://interopmatrix.broadcom.com/Upgrade?productId=662&isHidePatch=false&isHideLegacyReleases=false){: external}. {: restriction} Before you upgrade to version 9 or later, you must swap the VMware Cloud Foundation™ (VCF) license keys. ## Procedure to swap the license keys {: #usage_meter-vcflicense-swap} 1. Obtain the new Broadcom license keys, and then retrieve the VMware Cloud Foundation (VCF) license keys from the VMware Solutions console. For more information, see [Retrieving VCF license keys](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-licenses_vcf-licenses&format=markdown). 2. Obtain the VMware add–on keys. For more information, see [Obtaining the VMware add-on keys](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-vmware-add-ons&format=markdown#vmware-add-ons-obtain). 3. Add the new license keys to all VMware products, and then assign the licenses as required. For more information, see [Managing VMware product licenses](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-licensing_manage&format=markdown). ## Procedure to upgrade Usage Meter {: #usage_meter-upgrade-proc} To upgrade Usage Meter, complete the following steps: ### Enabling SSH login {: #usage_meter-upgrade-ssh} 1. Log in to the VMware vCloud Usage Meter appliance management console with the `usagemeter` user through `https://:5480`. 2. Click **Access** from the left navigation panel. 3. Under **Access settings**, click **Edit** on the upper right. 4. In the **Edit access settings** window, toggle the **Enable SSH login** switch on. The SSH login changes to **Enabled**. ### Mounting the upgrade ISO file {: #usage_meter-upgrade-iso} 1. Download the Usage Meter ISO file from the following link: - For upgrade from Usage Meter v4.8 (or earlier) to v9.0.1, use: `https://ibm.biz/~V0YiDk0EP`. - For upgrade from Usage Meter v9.0.1 to v9.1.0, use: `https://ibm.biz/~aBF0Bw0fU`. 2. Validate the SHA-2 checksum based on the following SHA-256 value: - For upgrade from Usage Meter v4.8 (or earlier) to v9.0.1, see: `ec5c46b4bdae915cb4a289dfbb03077cb802f404692bb3f2501b59b448102797`. - For upgrade from Usage Meter v9.0.1 to v9.1.0, see: `d1f79f1bcc711c7753c871bd95bc434e8a31bb8fc584fc7ac88b75398be445c1`. Open a command prompt on Windows® or a terminal window on Linux® and MacOS and run the following command: * For Windows: `certutil -hashfile SHA256` * For Linux: `sha256sum ` * For MacOS: `shasum -a 256 ` 3. In the VMware vSphere® Web Client, log in to your vCenter Server instance. 4. Under the **Storage** menu, select the datastore where your Usage Meter virtual machine (VM) is located. 5. In the **VMs** tab, click **Virtual machines** and verify that the Usage Meter is on your target datastore. 6. In the **Files** tab, click **Upload files**. The ISO file starts uploading. You might receive an error about the host certificates. To resolve it, open the specified URL that is shown in the error in another web browser tab and accept the certificate. If it doesn’t load, verify that the host is in your current desktop DNS and then access the URL again. {: note} 7. After the upload is complete, the ISO file will appear in the file list. 8. Under the **Hosts and clusters** menu, locate and right click the Usage Meter VM, and select **Edit settings**. 9. In the **Virtual hardware** tab, on **CD/DVD drive**, select **Datastore ISO file**, and click **OK**. If you do not see the **CD/DVD drive** option, click **Add new device**. {: tip} 10. In the **Select file** window, locate the datastore where you uploaded the ISO file. 11. Select the ISO file and click **OK**. 12. In the **Edit settings** window, under the **Virtual hardware** tab, select the **Connected** checkbox, then click **OK**. ### Running the upgrade command {: #usage_meter-upgrade-command} Before you run the upgrade commands for your Usage Meter, complete the following steps: 1. In the VMware vSphere® Web Client, log in to your vCenter Server instance. 2. Under the **Hosts and clusters** menu, locate and right click the Usage Meter VM, and select **Edit settings**. 3. In the **Virtual hardware** tab, on **CD/DVD drive**, clear the **Connected** checkbox, and click **OK**. 4. Under the **Hosts and clusters** menu, locate and right click the Usage Meter VM, and select **Snapshots > Take snapshot**. 5. Enter a name for your snapshot and click **Create**. Use SSH to log in to the Usage Meter Appliance VM and complete the following steps: 1. Open a command prompt on Windows or a terminal window on Linux and MacOS and run the following commands as the `root` user: 1. `mkdir /root/upgrade` 2. `mount -o loop /dev/cdrom /root/upgrade` 3. `bash /root/upgrade/upgrade-um.sh` You might need to run `umount /root/upgrade` to unmount any previous upgrades before you run `mount -o loop /dev/cdrom /root/upgrade` to upgrade the Usage Meter VM. {: note} 2. Enter the access token that is generated for the Usage Meter in the IBM Cloud® for VMware Solutions console. For more information, see [Registering Usage Meter with IBM](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-usage_meter-register&format=markdown). 3. Enter **y** to agree with the VCF Usage Meter appliance be part of IBM's Provider Organization. 4. Enter **y** to confirm that a snapshot is created to the Usage Meter VM. An error message about the Usage Meter hostname might appear. Enter **y** to continue the upgrade path. {: note} 5. The upgrade process starts and when it's complete, enter **y** to restart the Usage Meter VM. 6. After the restart is complete, open the Usage Meter URL in a web browser and log in to verify the upgraded version. Then, confirm the health of the Usage Meter appliance. After you migrate the Usage Meter VM, you might encounter the error `Connection control operation failed for disk` during the upgrade process. This problem might happen due to an active snapshot that retains a lock on the mounted CD/DVD device. To resolve it, complete one of the following procedures. However, you might need to complete all of them for a successful migration of the VM. 1. **Delete any existing snapshots**: 1. In the VMware vSphere Web Client, log in to your vCenter Server instance as an administrator. 2. Under the **Hosts and clusters** menu, select the Usage Meter VM. 3. In the **Snapshots** tab, select **DELETE ALL** or specify any of the snapshots that have the CD/DVD drive mounted and select **DELETE**. 5. Click **OK**. 2. **Disconnect the mounted drive**: 1. In the vSphere Web Client, log in to your vCenter Server instance as an administrator. 2. Under the **Hosts and clusters** menu, locate and right click the Usage Meter VM, and select **Edit settings**. 3. Clear the box in the CD/DVD drive where you mounted the ISO upgrade file. 4. Click **OK**. 3. **Disconnect the mounted drive from the hosted ESXi**: 1. In the vSphere Web Client, log in to your vCenter Server instance as an administrator. 2. Under the **Hosts and clusters** menu, select the Usage Meter VM. 3. In the **Summary** tab, locate **Related objects** and determine which host the VM is located. 4. Log in to the ESXi host as root or an administrator. 5. Select **Virtual machines** and right click the Usage Meter VM in the list. 7. Click **Edit settings**. 8. Under **CD/DVD drive**, clear the **Connected** checkbox. 9. Click **Save**. ### Replacing the Usage Meter certificate {: #usage_meter-upgrade-certificate} If you cannot access the Usage Meter URL or log in to the dashboard after the upgrade, complete the following steps to replace the Usage Meter certificate due to an incompatible hostname: 1. Use SSH to log in to the Usage Meter VM with the `usagemeter` username. 2. Run the command `stop.sh All` to stop all services. 3. Under a root user, run the command `hostnamectl hostname ` to update the hostname with the correct value. 4. Run the commands `export $(grep -v '^#' "/opt/vmware/cloudusagemetering/platform/conf/env.properties" | xargs)` and `mv /opt/vmware/cloudusagemetering/platform/security/keystore /opt/vmware/cloudusagemetering/platform/security/keystore.backup` to export the environment variables and backup the existing keystore. 5. If FIPS is enabled, run the command `keytool -changealias -alias "usage-meter-platform" -destalias "usage-meter-platform-backup" -keystore /opt/vmware/cloudusagemetering/platform/security/cacerts -storetype BCFKS -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider -providerpath /opt/vmware/cloudusagemetering/platform/lib/bc-fips-*.jar -storepass "${TRUST_STORE_PASSWORD}"`. If it is disabled, run the command `keytool -changealias -alias "usage-meter-platform" -destalias "usage-meter-platform-backup" -keystore /opt/vmware/cloudusagemetering/platform/security/cacerts -storepass "${TRUST_STORE_PASSWORD}"`. If you run the FIPS disabled version while FIPS is enabled, the error `keytool error: java.security.KeyStoreException: Unrecognized keystore format.` is displayed. To resolve it, load it with a specified type. {: note} 6. Create a temporary directory for the NGINX variable and run the command `export NGINX_FOLDER=$(mktemp -d)` to move it into the **cloudusagemetering** directory, then run `cd /opt/vmware/cloudusagemetering` to access the new directory. 7. Run the command `./platform/bin/create-keystore.sh` to create the new keystore. 8. Run the commands `rm -rf $NGINX_FOLDER` and `rm /opt/vmware/cloudusagemetering/platform/security/keystore.backup` to remove the temporary backup files. 9. If FIPS is enabled, run the command `keytool -delete -alias "usage-meter-platform-backup" -keystore /opt/vmware/cloudusagemetering/platform/security/cacerts -storetype BCFKS -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider -providerpath /opt/vmware/cloudusagemetering/platform/lib/bc-fips-*.jar -storepass "${TRUST_STORE_PASSWORD}"` to delete the backup keystore. If it is disabled, run the command `keytool -delete -alias "usage-meter-platform-backup" -keystore /opt/vmware/cloudusagemetering/platform/security/cacerts -storepass "${TRUST_STORE_PASSWORD}"`. 10. Run the command `chmod 0640 /opt/vmware/cloudusagemetering/platform/security/keystore` to update the new keystore permissions and restart the Usage Meter VM. Due to the hostname change, you might need to update your DNS entry to the new hostname or add it if it doesn't exist. If you are redirected to the login page with an OAuth error, clear any existing DNS entries for Usage Meter and try again. {: note} 11. After the restart is complete, open the Usage Meter URL in a web browser to verify the upgraded version. ## Related links {: #usage_meter-upgrade-related} * [Configuring Usage Meter](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-usage_meter-config&format=markdown) * [Registering Usage Meter with IBM](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-usage_meter-register&format=markdown)