You can install vCloud Usage Meter 4.6 as an in-place upgrade on top of vCloud Usage Meter 4.3 and later.

Prerequisites

Prerequisite Description
Source vCloud Usage Meter appliance
  • Note: Back up or take a snapshot of the source vCloud Usage Meter appliance that you want to upgrade.
  • As root, activate and start SSH on the source vCloud Usage Meter appliance by running the following commands.
    systemctl enable sshd
    systemctl start sshd
Authentication Verify that you can access the vCloud Usage Meter console as root.

Procedure

  1. Locally on you computer, download the following upgrade files.
    File Name Description
    Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.iso The ISO upgrade file containing the upgrade script and the YUM repository.
    Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.mf Contains the sha1checksum of the upgrade ISO file.
    Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.crt Contains the public certificate that signs the ISO file.
    Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.sign Contains the signature for the ISO file.
  2. (Optional) From the terminal of your computer, log in to the vCloud Usage Meter appliance and run the following commands.
    1. (Optional) Verify that the checksum of the download matches the checksum posted on the download page.
      sha1sum -c Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.mf
    2. (Optional) Verify the certificate.
      openssl x509 -in Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.crt -text
      openssl verify Usage_Meter_Agent-4.6.0.0-<UM_NEW_BUILD>_Upgrade.crt
    3. (Optional) Obtain the certificate public key and verify the signature of the ISO file.
      openssl x509 -pubkey -in Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.crt \
        > Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.key
      openssl dgst -sha1 -verify Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.key \
        -signature Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.sign \
        Usage_Meter_Agent-4.6.0.0-<BUILD_NUMBER>_Upgrade.mf
  3. Connect the CD-ROM drive of vCloud Usage Meter to the Usage_Meter_Agent-4.6.0.0-<BUILD>_Upgrade.iso file.
    For information, see Add or Modify a Virtual Machine CD or DVD Drive in the vSphere Virtual Machine Administration documentation.
  4. Log in to the source vCloud Usage Meter console as root.
  5. Create an upgrade directory.
    mkdir /root/upgrade
  6. Mount the CD drive.
    Note: If you upload the .iso file inside the vCloud Usage Meter appliance manually, replace /dev/cdrom with the full .iso path location in the command.
    mount -o loop /dev/cdrom /root/upgrade
  7. To start the in-place upgrade, run the command.
    bash /root/upgrade/upgrade-um.sh

    You are prompted to confirm if a snapshot of the source vCloud Usage Meter appliance that you want to upgrade exists.

    Has a snapshot of the vCloud Usage Meter appliance VM been created on the vCenter Server environment that it's running on? (y/n):

  8. (Optional) If vCloud Usage Meter detects an incorrectly set hostname, you receive the following message.
    Detected wrong hostname. Expected hostname: ${host}, but found: ${current_hostname}.This will most probably result in issues after upgrade with the existing vCloud Usage Meter certificates.
    Please change the hostname and then you can either generate a new self-signed
    certificate or import an internal Certification Authority (CA) - Signed Certificate
    Note: The certificate CN must match the hostname of the vCloud Usage Meter appliance.
    For information, see vCloud Usage Meter Certificate Management.
    Follow the instructions provided in the message. For more information, see vCloud Usage Meter Certificate Management.
  9. To complete the in-place upgrade, you are prompted to reboot the appliance.
    Reboot is recommended after an upgrade. Reboot now? (y/n)
    If you enter y (yes), a reboot of the appliance starts. If you enter n (no), you must manually reboot the appliance. Log in as root and run the following command.
    reboot
  10. Verify that the vCloud Usage Meter services are up and running.
    1. Log in as usagemeter.
    2. Navigate to the /opt/vmware/cloudusagemetering directory.
      cd /opt/vmware/cloudusagemetering
    3. Verify the status of the vCloud Usage Meter services.
      bash scripts/status.sh
      If the services are running, you receive a Running status. In case you receive a Running status that has errors, check the latest log files. The errors might not be related to the in-place upgrade.
  11. Stop SSH by running the commands.
    systemctl stop sshd
    systemctl disable sshd
    Note: If the vCloud Usage Meter virtual machine becomes unresponsive and the system displays an error message, such as The guest operating system has locked the CD-ROM door and is probably using the CD-ROM, which can prevent the guest from recognizing media changes., follow the instructions in the https://kb.vmware.com/s/article/2144053?lang=en_us KB.

What to do next

Verify the certificates for all metered product servers are FIPS compliant.
Note: To ensure the automatic aggregation and reporting of the monthly product consumption data, after a successful upgrade, do not revert to the snapshot of the source vCloud Usage Meter appliance.