Update Citrix Workspace Environment Management (WEM) to 2106 (2106.1.0.1)

An update guide for Citrix Workspace Environment Management (WEM) to the latest version 2106.

About WEM Administration Console

On June 16, 2021 Citrix released version 2106 of Workspace Environment Management (WEM). This is an update guide.
Customer Success Services / Software Maintenance eligibility date: May 15, 2021

Download Citrix WEM 2106 (2106.1.0.1) here:
https://www.citrix.com/de-de/downloads/citrix-virtual-apps-and-desktops/components/workspace-environment-management-2106.html

What’s new:
https://docs.citrix.com/en-us/workspace-environment-management/current-release/whats-new.html

Fixed issues:
https://docs.citrix.com/en-us/workspace-environment-management/current-release/fixed-issues.html

WEM setup files
WEM setup files

Changelog

  • 17 September 2021: Update Citrix Workspace Environment Management to 2106
  • 24 February 2021: Update Citrix Workspace Environment Management to 2012
  • 08 December 2020: Update Citrix Workspace Environment Management to 2009
  • 26 February 2020: Update Citrix Workspace Environment Management to 1912
  • 4 March 2019:
    • Rearranged blog post to prevent Google duplicates
    • Redirected (301) old versions of the post to the latest version
    • Update Citrix Workspace Environment Management (WEM) to 1811 (v1811.0.1.1)
  • 3 August 2018: Update Citrix Workspace Environment Management (WEM) to 4.7 (v4.07.00.00)
  • 18 September 2017: Update Citrix Workspace Environment Management to 4.4
  • 26 Februrary 2017: Update Citrix Workspace Environment Management to 4.2

Infrastructure Service Update

  1. If you load balance your WEM Infrastructure Services Broker, consider disabling the broker you update. Otherwise it’s no big problem, the agents cache the configuration.
    WEM infrastructure load balancer
    WEM infrastructure load balancer
  2. Check your WEM Infrastructure Service Configuration and write it down. Especially the passwords. The database upgrade dropped the entire configuration in past versions. Better stay safe!
    WEM Infrastructure Service Configuration
    WEM Infrastructure Service Configuration
  3. Update your existing Broker through: Citrix Workspace Environment Management Infrastructure Services Setup.exe
    The setup is straight forward, no details from me here.
    Citrix Workspace Environment Management Infrastructure Services Setup.exe
    Citrix Workspace Environment Management Infrastructure Services Setup.exe
  4. Update your existing Administration Console: Citrix Workspace Environment Management Console Setup.exe
    The setup is straight forward, no details from me here.
    Citrix Workspace Environment Management Console Setup.exe
    Citrix Workspace Environment Management Console Setup.exe
  5. Start the WEM Database Management Utility from the Start Menu, choose Upgrade Database.
    Make sure you have a current backup of your database! There have definitively been cases where I needed a WEM database restores.
    WEM Database Management Utility
    WEM Database Management Utility
  6. Keep caution, the following Citrix Document states, that the SQL vuemUser needs temporary SQL sysadmin permissions. Otherwise the upgrade will fail. If your upgrade fails, you find the log file in -> “C:\Program Files (x86)\Norskale\Norskale Infrastructure Services\Citrix WEM Database Management Utility Debug Log.log”
    SQL vuemUser sysadmin
    SQL vuemUser sysadmin
  7. Enter all the information you wrote down during step 2, if the fields aren’t filled in -> Press Upgrade.
    Database Upgrade Wizard
    Database Upgrade Wizard
    Remember, you only have to do this once, not on all your brokers.
    Database Upgrade
    Database Upgrade
  8. After you upgrade the Infrastructure Services, you must reconfigure the Infrastructure Services using the WEM Infrastructure Service Configuration utility. Check WEM Infrastructure Service Configuration, if your connections details were dropped.
    If your settings vanished, enter them again.
    Click Save configuration to restart the Services.
    WEM Infrastructure Service Configuration
    WEM Infrastructure Service Configuration
  9. You should now be able to open the WEM Administration Console once again!
    About WEM Administration Console
    About WEM Administration Console
  10. If you have multiple WEM Broker, it’s time to switch the active Service Group Members and repeat Steps 3 & 4.
    If not, it’s time to update the agents.

Agent Update

  1. Either you deploy them manually on each server. The setup is straight forward, no details from me here.
    Or you deploy the agent silent with your favorite software distribution tool:
    Citrix Workspace Environment Management Agent Setup.exe /quiet Cloud=0
    PDQ Deploy - WEM install
    PDQ Deploy – WEM install
  2. The following step has been removed from the WEM 2009 upgrade docs, seems like it’s no longer necessary.
    1. After the Agent upgrade, you have to execute the following commands according to the official upgrade guide:
      C:\Windows\Microsoft.NET\Framework64\v4.0.30319\ngen.exe update
      C:\Windows\Microsoft.NET\Framework64\v4.0.30319\ngen.exe eqi 3

      or for 32bit operating systems:

      C:\Windows\Microsoft.NET\Framework\v4.0.30319\ngen.exe
      PDQ Deploy - ngen.exe
      PDQ Deploy – ngen.exe
  3. When updating from a WEM version lower than 4.5, you might receive the following error:
    AgentCacheUtility.exe
    AgentCacheUtility.exe

     

    There is already a very detailed guide by Srinivasan Shanmugam at the mycugc Blogs, which describes a possible cause to this issue: WEM Agent v4.5 Upgrade Issues

    1. Example command line steps to push and automate stuff:
      net stop "Citrix WEM Agent Host Service" /y
      del "C:\Program Files (x86)\Norskale\Norskale Agent Host\Local Databases\LocalAgentCache.sdf" /F
      del "C:\Program Files (x86)\Norskale\Norskale Agent Host\Local Databases\LocalAgentDatabase.sdf" /F
      net start "Citrix WEM Agent Host Service" /y
      net start "NetLogon" /y
      "C:\Program Files (x86)\Citrix\Workspace Environment Management Agent\AgentCacheUtility.exe" -refreshcache
  4. You can verify your Agent <-> Broker connection through the following command. The Brokername has to be a FQDN:
    "C:\Program Files (x86)\Citrix\Workspace Environment Management Agent\AgentCacheUtility.exe" -refreshcache -brokername:wem.domain.local
    AgentCacheUtility.exe
    AgentCacheUtility.exe

     

     

  5. And last but not least you have to replace the ADMX definition files in your central store. If there are any older ADMX oder ADML files, delete them.
    ADMX files
    ADMX files
  6. Congratulations, your Citrix Workspace Environment Management is now on the latest version!
    WEM Agent statistics
    WEM Agent statistics

Additional Notes

If you should encounter further errors, check the Windows Eventlogs and consider enabling the WEM Agent Debug Log:
CTX219839: How to Enable Debug Logging on Workspace Environment Management Agent manually, if no connectivity to Broker exists

Source: Official Citrix Workspace Environment Management Upgrade Guide
https://docs.citrix.com/en-us/workspace-environment-management/current-release/upgrade.html

That’s it! Feel free to leave me a comment if you have any questions.

This blog article was previously published on mycugc.org:
https://www.mycugc.org/blogs/cugc-blogs/2018/07/20/how-to-update-citrix-workspace-environment-managem

Author: Marco

Marco is an IT-System administrator and IT-Consultant with 10+ years experience. He is specialized in the delivery of virtual Apps and Desktops with Citrix solutions. In 2017 he has been awarded Citrix Technology Advocate by Citrix for his community work (#CTA). His second core area is availability & performance monitoring with Zabbix, a leading open-source solution. His employer is the German IT-Company ANAXCO, which is developing a Transport Management Software (TMS) based on Microsoft Dynamics AX. More about Marco

7 thoughts on “Update Citrix Workspace Environment Management (WEM) to 2106 (2106.1.0.1)”

    1. You are exactly on the oldest version (4.7), that supports a direct upgrade to a newer version like 1912. But 1912 is already out of support. WEM 2006 is the latest version. Citrix only supports WEM versions N-1, so the latest minus one. My article hasn’t been updated, yet, as I work on other projects currently, but I will update it soon.

      1. Hi Marco – I recently updated to 1912 LTSR U2, are all wem versions compatible? I am having issues with WEM 2003

  1. Hi Dear,

    I am not able to download it as its saying “this contact restricted ” can you help me to get setup file.

    If possible can you share it via google drive on “sumitsaharan1990@gmail.com”. Thanks in advance !

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.