LEGACY - Upgrading Workspace ONE Access On-Premises Service Virtual…

Legacy This is legacy documentation for historical purposes only and has been deprecated with newer releases of Omnissa Access On-Premises deployments. See Omnissa documentation for the latest information.

Updated for 20.10! This document is to assist with upgrading on-premises VMware Identity Manager appliances, commonly known as the Service Virtual Appliance (SVA). It should be used with the official Workspace ONE Access upgrade documentation (NOTE: Select the version of the appliance you are upgrading to from the drop down menu).

This document does not cover upgrading the Windows version of Workspace ONE Access SVA nor the Workspace ONE Access Windows Connector. These are covered within the VMware documentation.

Please note there are links embedded throughout the document below in reference to the documented procedures or other information.

NOTE: Document updated for VMware Identity Manager 3.x, 19.03, 20.01, and 20.10. Most previous version notes have been removed.

Prerequisites: Prerequisites for an online upgrade Documentation:

Prerequisites for an offline upgrade Documentation: - NOTE: Older docs have been decommissioned

- <a href="https://docs.vmware.com/en/VMware-Identity-Manager/3.3/identitymanager-upgrade.doc/GUID-9A60AF97-787F-4234-BFC4-08C43BA440D7.html" class="link" ><u>3.3 Upgrade Docs</u></a>

- <a href="https://docs.vmware.com/en/VMware-Identity-Manager/19.03/identitymanager-upgrade.doc/GUID-9A60AF97-787F-4234-BFC4-08C43BA440D7.html" class="link" ><u>19.03 Upgrade Docs</u></a>





- <a href="https://docs.vmware.com/en/VMware-Workspace-ONE-Access/20.01/ws1_access_upgade.doc/GUID-9A60AF97-787F-4234-BFC4-08C43BA440D7.html" class="link" ><u>20.01 Upgrade Docs</u></a>





- <a href="https://docs.vmware.com/en/VMware-Workspace-ONE-Access/20.10/ws1_access_upgade.doc/GUID-9A60AF97-787F-4234-BFC4-08C43BA440D7.html" class="link" ><u>20.10 Upgrade Docs</u></a>

Post-requisites: Documentation: - NOTE: Older docs have been decommissioned

- <a href="https://docs.vmware.com/en/VMware-Identity-Manager/3.3/identitymanager-upgrade.doc/GUID-8D0DE628-031C-412D-9BBC-EF795F37A069.html" class="link" ><u>3.3 Upgrade Docs</u></a>

- <a href="https://docs.vmware.com/en/VMware-Identity-Manager/19.03/identitymanager-upgrade.doc/GUID-BA7A1C10-35AC-41E1-B942-6D8CDD0866D9.html" class="link" ><u>19.03 Upgrade Docs</u></a>





- <a href="https://docs.vmware.com/en/VMware-Workspace-ONE-Access/20.01/ws1_access_upgade.doc/GUID-BA7A1C10-35AC-41E1-B942-6D8CDD0866D9.html" class="link" ><u>20.01 Upgrade Docs</u></a>





- <a href="https://docs.vmware.com/en/VMware-Workspace-ONE-Access/20.10/ws1_access_upgade.doc/GUID-BA7A1C10-35AC-41E1-B942-6D8CDD0866D9.html" class="link" ><u>20.10 Upgrade Docs</u></a>

The following are settings to configure after the upgrade completes successfully. If you have set up a VMware Identity Manager cluster for failover, updating it to three nodes is recommended. This is because of a limitation of Elasticsearch, a search and analytics engine embedded in the VMware Identity Manager appliance. You may continue to use two nodes but you should be aware of a few limitations related to Elasticsearch. See "Configuring Failure and Redundancy" in Installing and Configuring VMware Identity Manager for more information.

Tips and Best Practices: Backup of IFCFG-ETH0Make a copy of the IFCFG-ETH0 file before upgrading.

  1. Login to the appliance console or remote in as SSHUSER and then SU to root.

  2. Run the following command to make a backup of IFCFG-ETH0. cp /etc/sysconfig/networking/devices/ifcfg-eth0 /etc/sysconfig/networking/devices/ifcfg-eth0.bak

  3. Exit the console or SSH session. exit

undefined

VM Snapshot Backup Make a VM snapshot before upgrading (no memory state needed unless you want one).

  1. Login to vSphere or vCenter.

  2. Browse to the VM in question.

  3. Right click on the VM and select options to create a new snapshot.

undefined

Database Backups or Snapshots When upgrading the full VMware Identity Manager on-premises single virtual appliance (SVA), when taking a VM snapshot of appliance(s), it is also good practice to take a backup of the database or VM snapshot of the database server.

Online Updates and Proxy Settings When doing an online update, you may need to set an outbound proxy within the appliance in order for it to reach the Internet and download the update packages. Essentially the appliance must be able to reach vapp-updates.vmware.com on TCP port 80 (HTTP). The latest instructions for setting a proxy for online upgrade can be found in the Workspace ONE Access Documentation online. If an HTTP proxy server is required for outbound HTTP access, configure the proxy server settings for the virtual appliance. See Configure Proxy Server Settings for the Existing Service Appliance, 20.01 or 19.03 or if you would like to configure it after upgrading to 20.10, see Enabling Proxy Server Settings After Installation.

Post-Update Apply Hot Patches Apply any necessary hot patches after upgrading.

The Upgrade Process The short version of the over-the-air procedure is…

  1. Login to the appliance console and make a backup of IFCFG-ETH0.

  2. Make a backup of /etc/sysconfig/networking/devices/ifcfg-eth0.

    1. Login to the appliance console or remote in as SSHUSER and then SU to root.

    2. Run the following command if you wish to make a backup of IFCFG-ETH0.cp /etc/sysconfig/networking/devices/ifcfg-eth0 /etc/sysconfig/networking/devices/ifcfg-eth0.bak

    3. Exit the console or SSH session. exit

  3. Make a VM snapshot (no memory state needed unless you want one).

    1. Login to vSphere or vCenter.

    2. Browse to the VM in question.

    3. Right click on the VM and select options to create a new snapshot.

  4. If using a cluster then see the Upgrading a Cluster procedure in the documentation for whichever version you are upgrading to.

  5. Perform an Online Upgrade:

    1. Log in to the VMware Identity Manager virtual appliance as the root user.

    2. Run the following updatemgr.hzn commands. /usr/local/horizon/update/updatemgr.hzn updateinstaller

    3. Run the following command to check if any online upgrade exists. /usr/local/horizon/update/updatemgr.hzn check

    4. For upgrades specifically to Workspace ONE Access 20.10.x, the following must also be done in order to upgrade SLES to Photon OS.

      1. Upload the dualbootupdate.tar.gz file to the appliance and position as necessary. Documentation recommends placing within /db/ and then referencing it within the following update command.

      2. After the dualbootupdate.tar.gz file is uploaded, the following command should be executed to convert the SLES appliance to Photon OS. Enter Y to upgrade or N to cancel out. /usr/local/horizon/update/updatemgr.hzn update --file /db/dualbootupdate.tar.gz

      3. Check the following log file for messages. /opt/vmware/var/log/update.log

      4. Run the following command to check for any additional online upgrade. /usr/local/horizon/update/updatemgr.hzn check

    5. For older upgrades (i.e. Workspace ONE Access 20.01 or older), simply run the following command to update the appliance. /usr/local/horizon/update/updatemgr.hzn update

      1. Messages that occur during the upgrade are saved to the update.log file at /opt/vmware/var/log/update.log.
    6. Run the updatemgr.hzn check command again to verify that a newer update does not exist. /usr/local/horizon/update/updatemgr.hzn check

    7. Check the version of the upgraded appliance. vamicli version --appliance

      1. The new version is displayed.
    8. Check that IFCFG-ETH0 is present and properly configured.

      1. If not, copy or move the backup of the file to the original or recreate the original using VI editor with the contents of the backup. When done in VI, save the changes. mv /etc/sysconfig/networking/devices/ifcfg-eth0.bak /etc/sysconfig/networking/devices/ifcfg-eth0
    9. Restart the virtual appliance.

      1. Type reboot
  6. Validate the upgrade works properly after the reboot.

  7. If using a cluster then see the Upgrading a Cluster procedure in the documentation for whichever version you are upgrading to.

  8. Shut down each appliance within the cluster and boot each one up one at a time - waiting until the app server is fully started before booting the next. After this is done, you should see all nodes in the cluster properly sync and go green within approximately 30 minutes.

  9. Apply any post-upgrade patches if you have any to apply in accordance with their instructions.

  10. Delete the VM snapshot after a couple of days or if you are certain the upgrade process was successful.

Upgrade Issues and Troubleshooting Options: Troubleshooting Upgrade Errors UpdateInstaller Fails to Run on VMware Identity Manager On-Premises Full Appliance

Symptoms: Update, Update Check, Update Installer fail to run and/or show any outcome.

Cause: Not enough available inodes (number of allowed files).

Correction:

  1. Run df. This will give you an idea of how much space you have.

  2. Run df -i. This will tell you how much inode space you have left.

    1. Example: If /var says 100% and you see inodes has less than 200 then you may have this issue. NOTE: An upgrade from VMware Identity Manager 2.6 to 2.7 typically requires around 209 inodes.
  3. The solution is to clear off enough files to free up enough inode space. NOTE: This can be done in any folder where there are enough files to make a difference.

    1. The recommendation is to use the /var/log folder as this is commonly the offender for inode consumption.
  4. To clear off bz2 log files more than 90 days old, do the following:

    1. Login to the appliance console directly (via vCenter) or via SSH (and SU to root).

    2. Browse to the /var/log folder cd /var/log

    3. Find and delete bz2 files older than 90 days. The below command deletes anything ending with the extension “bz2” which is older than 90 days from current date. You may need to delete more recent files to clear up enough inodes by changing the time frame to a lower range such as 45 days instead of 90 days.

find ./*.bz2 -mtime +90 -exec rm {} ;

* Retest update installer, update check, and update.

/usr/local/horizon/update/updatemgr.hzn updateinstaller

* 

/usr/local/horizon/update/updatemgr.hzn check

* 

/usr/local/horizon/update/updatemgr.hzn update

Reference: Information courtesy of Wibowo Leksono

UpdateInstaller Reports No Updates on VMware Identity Manager On-Premises Connector Appliance Version 2016.11.1.0

Symptoms: Update Installer runs on VMware Identity Manager On-Premises Connector Version 2016.11.1.0 but reports no updates are available.

Cause: Known Issue with VMware Identity Manager Connector version 2016.11.1.0.

Correction:

  1. Apply VMware KB 2149179

Reference:

No Networking Detected on Reboot After Upgrade Link: Networking Error after Upgrade

Symptoms: The upgraded SUSE appliance shows NO NETWORKING DETECTED errors. Logging in and looking at /etc/sysconfig/network (ls /etc/sysconfig/network -l -a) shows source file for ifcfg-eth0 is missing in /etc/sysconfig/networking/devices/ for /etc/sysconfig/network/ifcfg-eth0 link file. undefined

undefined

Cause: Known Issue with upgrade process wiping ifcfg-eth0 information

Correction:

  1. Move the backup of ifcfg-eth0 taken during step 2.2 of The Upgrade Process back into place.

    1. Login to the appliance console or remote in as SSHUSER and then SU to root.

    2. Run the following command to move the backup of IFCFG-ETH0 into place mv /etc/sysconfig/networking/devices/ifcfg-eth0.bak /etc/sysconfig/networking/devices/ifcfg-eth0

    3. Exit the console or SSH session. exit

  2. Alternately (instead of step 1.), manually create the file.

    1. Login to the appliance console or remote in as SSHUSER and then SU to root.

    2. Open the VI editor and create the file by typing the following command. vi /etc/sysconfic/network/ifcfg-eth0

    3. Type in all of the settings as shown in the below reference image. All lines except IPADDR=, NETMASK=, and BROADCAST= will be identical to what is in the image. To find your IP address, either ping or attempt to resolve the FQDN of the appliance to get the IP address, or look within the vApp advanced options of the VM to get the exact IP address. From there you should be able to fill in the below values. IPADDR=‘’ NETMASK=‘’ BROADCAST=‘’

    4. Exit the INSERT mode by pressing the ESC key.

    5. Save the file and exit the VI editor by typing <b>:</b> (colon) then <b>x</b> (lower case "x") and then pressing the ENTER key.

  3. Reboot the appliance by typing reboot and pressing ENTER.

Reference Image: undefined

20.10 Appliance Has No Network Detected After Upgrade - Missing vApp Options Within vCenter

Symptoms: Appliance fails to communicate on the network.

Cause: vApp Options Static Property Default Vaule for vm.vmname must be properly set to "IdentityManager".

Correction: Ensure all vApp options are correctly set for 20.10.

  1. Power off the VM.

  2. Within vCenter, modify the vApp Options settings and ensure all settings are correctly set (use the reference link in this below within this section).

  3. Save all settings.

  4. Restart the VM.

image.png

References:

20.10 Appliance RabbitMQ Fails to Start

Symptoms: Appliance fails to boot properly and RabbitMQ fails to start after upgrading to 20.10 or 20.10.01.

Cause: RabbitMQs Symbolic Link for the Erlang Cookie is missing. Specifically, the "/root.erlang.cookie" is not soft linked to "/var/lib/rabbitmq/.erlang.cookie".

Validate:

  1. Login to the VM console as root.

  2. Execute the following:

    ls -l /root/.erlang.cookie

  3. Verify it is pointing to "/var/lib/rabbitmq/.erlang.cookie".

  4. If it is not present, follow the corrective steps below to recreate the symbolic link.

Correction: Recreate the Symbolic Link for the Erlang Cookie and then restart.

  1. Login to the VM console as root.

  2. Execute the following commands to recreate the symbolic link to the Erlang Cookie.

    systemctl status rabbitmq-server.service rabbitmqctl list_queues systemctl stop rabbitmq-server.service cd /root ls -lat .er* rm -f .erlang.cookie ln -s /var/lib/rabbitmq/.erlang.cookie ./ systemctl start rabbitmq-server.service rabbitmqctl list_queues

  3. Reboot the VM.

Reference:

#Access #On_Premises #Legacy