If your VMware Identity Manager virtual appliance has Internet connectivity, you can upgrade the appliance online.

Prerequisites

Procedure

  1. Log in to the VMware Identity Manager virtual appliance as the root user.
  2. Run the following updatemgr.hzn command.
    /usr/local/horizon/update/updatemgr.hzn updateinstaller
  3. Run the following command to check that on online upgrade exists.
    /usr/local/horizon/update/updatemgr.hzn check
  4. Run the following command to update the appliance.
    /usr/local/horizon/update/updatemgr.hzn update

    Messages that occur during the upgrade are saved to the update.log file at /opt/vmware/var/log/update.log.

    A message appears about migrating the embedded connector configuration.

  5. Press the Enter key.
    The system searches for the migration package ( cluster-support.tgz) under the /root directory.

    Downloading the package is a prerequisite step required to migrate the embedded connector configuration. This step is required if your current deployment uses the embedded connector or not. Starting with VMware Identity Manager 19.03.0.0, the connector is no longer embedded with the VMware Identity Manager, but available for external-Windows systems only.

    A message appears about the cluster-support.tgz migration package.
    • If the system cannot find the cluster-support.tgz package, the message states this fact. In this case, save the package under the /root location and run the update command again.
    • If the system finds the cluster-support.tgz package, it uncompresses the package, lists the files in the package, runs the generateClusterFile.sh file, and prompts you to create a configuration-package file password.
  6. Create a configuration-package file password and respond to the additional prompts to save the embedded-connector configuration to the file.
    Keep in mind that the embedded connector is on a Linux system. If you re migrating the embedded-connector configuration information, you must migrate the information to an external connector on a Windows system. The following settings might not apply to Linux and Windows systems equally, depending on the specifics of your deployment. Therefore, decide if you want to include the following configuration information or not.
    Prompt Description
    Would you like to include syslog settings? If you want to copy the syslog-sever settings for the embedded Linux-based connector to the external Windows system, accept the default Y, for yes.

    Otherwise, enter N, for no.

    Would you like to include proxy settings? If you want to copy the Proxy settings for the embedded Linux-based connector to the external Windows system, accept the default Y, for yes.

    Otherwise, enter N, for no.

    The system starts the upgrade of the VMware Identity Manager service and creates the .enc configuration-package file under the /root directory that starts with the name cluster, such as cluster-host-domain-conn-timestamp.enc. See the command output for the exact filename. This cluster...enc file contains the embedded-connector migration information. If you are migrating the embedded connector to an external connector, you must copy this file to the external Windows system. If you are not migrating the embedded connector, the best practice is to keep the cluster...enc file as a backup of the embedded-connector configuration in case the information is needed in the future.

    After the upgrade finishes, the upgraded version of the VMware Identity Manager service no longer includes a functional embedded connector.

  7. Run the updatemgr.hzn check command again to verify that a newer update does not exist.
    /usr/local/horizon/update/updatemgr.hzn check
  8. Check the version of the upgraded appliance.
    vamicli version --appliance
    The new version is displayed.
  9. Restart the virtual appliance.
    reboot

Results

The upgrade is complete.

See Post-Upgrade Configuration.