Before you upgrade version 3.3.6 VMware Identity Manager virtual appliance to version 3.3.7 offline, perform these prerequisite tasks.

  • To capture the entire state of the virtual appliance before you update, take a snapshot of your virtual appliance.

    For information about how to take snapshots, see the vSphere Virtual Machine Administration guide.

  • Before you upgrade 3.3.6 to 3.3.7, verify the health of the Elasticsearch service in 3.3.6. Go to the System Diagnostic Dashboard in the VMware Identity Manager console and review the Integrated Components section. Confirm that the values for the Elasticsearch items are green. If the state displays as red, fix the Elasticsearch issues before upgrading. See the Troubleshooting Elasticsearch Cluster Health: VMware Workspace ONE Access Operational Tutorial guide.

    When you upgrade to VMware Identity Manager 3.3.7, Elasticsearch is migrated to OpenSearch version 1.3.5 which is embedded in the Workspace ONE appliance for auditing, reports, and directory sync logs. During the migration all closed indices, search indices (which will be rebuilt) and Elasticsearch version 5.6.15 audit indices containing multiple document types, which are not supported in OpenSearch, are deleted.

  • When you use an external Microsoft SQL database, if you revoked the db_owner role on the Microsoft SQL database, as described in the 3.3 version of the Installing and Configuring VMware Identity Manager for Linux guide, you must add it back before performing the upgrade, otherwise upgrade fails.
    1. Log in to the Microsoft SQL Server Management Studio as a user with sysadmin privileges.
    2. Connect to the database instance for VMware Identity Manager.
    3. Enter the following commands.

      If you are using Windows Authentication mode, use the following commands:

      USE <saasdb>;
      ALTER ROLE db_owner ADD MEMBER <domain\username>; GO 
      						  

      Make sure that you replace <saasdb> with your database name and <domain\username> with the relevant domain and user name.

      If you are using SQL Server Authentication mode, use the following commands:
      USE <saasdb>;
      ALTER ROLE db_owner ADD MEMBER <loginusername>; GO 
      						  

      Make sure that you replace <saasdb> with your database name and <loginusername> with the relevant user name.

  • Take the appropriate snapshots.
    • Take a snapshot of each VMware Identity Manager appliance in your deployment.
    • If you are using an external Microsoft SQL database, take a snapshot or backup of the external database.
  • Confirm that SSL certificates requirements are met.

    If you are using VMware Identity Manager with VMware vRealize Automation 8.4, configure SSL certificates following the instructions in Enable Tenant-In-Host Name Multi-Tenancy with vRealize Automation 8.x.

  • If you are upgrading using the updateoffline.hzn script and your deployment includes a proxy server, deactivate the proxy server.
    If you are upgrading from 3.3.6 to 3.3.7, perform the steps that follow.
    Deactivate the proxy server from the admin console.
    1. Log in to the VMware Identity Manager console and navigate to the Appliance Settings > VA Configuration page.
    2. Click Manage Configuration, log in with the admin user password, and click Proxy Configuration.
    3. Deactivate Proxy.
    4. Click Save.
  • Verify that at least 10 GB of free disk space (/dev/sda) are available on the virtual appliance.
  • Directory Space Requirements for Upgrading from 3.3.6 to 3.3.7 is 4 GB. Ensure that the directory space requirements for an offline upgrade are met.
  • If you are upgrading from VMware Identity Manager 3.3.2, you must first perform an offline upgrade from 3.3.2 to 3.3.5, upgrade from 3.3.5 to 3.3.6, and then from 3.3.6 to 3.3.7. For the 3.3.2 to 3.3.5 upgrade, you must download the VMware Identity Manager Service Virtual Appliance Dual Boot Update from the VMware Identity Manager 3.3.5 product download page on my.vmware.com and save the file to any directory in the VMware Identity Manager virtual appliance.

    For more information about upgrading from version 3.3.2 to 3.3.5, see Upgrading to VMware Identity Manager 3.3.5 (Linux).