Product Documentation

Upgrade web services using the graphical interface or command line

Jun 05, 2015
Updated: 2014-08-29
Use this task to upgrade Services Manager web services from Services Manager 11.0.1 to Services Manager 11.5. Perform this task on the servers hosting the following components:
  • Citrix
  • Hosted Exchange
  • Lync Enterprise 2010 and 2013
  • Lync Hosted 2010 and 2013
  • MySQL
  • SharePoint 2010 and 2013
  • Virtual Machine
  • Windows Web Hosting
The upgrade process involves the following tasks:
  • Upgrade the web services installed on each server in your deployment
  • Reconfigure the web services to finalize the upgrade

To upgrade web services using the graphical interface

  1. From the installation media, double-click setup.exe and click Get Started.
  2. On the Select Deployment Task page, select Upgrade Existing Deployment.
  3. On the Upgrade Existing Deployment page, select Upgrade Roles and Services. The Setup Tool verifies the database version. If the correct database version is not detected, the Setup Tool prompts you to manually verify that the system databases have been upgraded and click Next.
  4. When prompted, accept the End User Licensing Agreement and then click Next.
  5. On the Select Components page, the Configuration Tool automatically selects the web services that are installed on the server. Click Next.
  6. On the Review Prerequisites page, the Configuration Tool displays the required software that will be installed to support the upgraded web service. Click Next.
  7. On the Ready to upgrade page, click Upgrade. The Configuration Tool upgrades the selected services and displays progress.
  8. On the Upgrade Complete page, click Finish.
  9. From the Upgrade Existing Deployment page, select Re-configure Upgraded Roles and Services. The Configuration Tool attempts to retrieve the Encryption Service key.
  10. On the Re-configure Upgraded Components page, click Finish Upgrade for the web service you want to upgrade. The Configuration Tool attempts to contact the Encryption Service to retrieve the service's encrypted key. If the Encryption Service cannot be contacted, the Configuration Tool prompts you to import the encrypted key manually using a key file. To generate the key file, see Generate and export keyfiles for the Encryption Service.
  11. If required, import the Encryption Service key file:
    1. In Key File Path, click Browse and locate the key file you generated from the Encryption Service web site.
    2. In Password, enter the password that was created when the key file was generated and then click Next.
  12. On the Enter Service Credentials page, enter the User Name and Password for the web service's service account and then click Next. By default, the Configuration Tool displays the default user name of the web service you are upgrading.
  13. On the Summary page, review the settings that will be reconfigured and click Next. The Configuration Tool restores and upgrades the IIS site for the web service, imports the Encryption Service key, and displays progress.
  14. When the reconfiguration is complete, click Finish and then click Exit.

To upgrade web services using the command line

When running the Setup and Configuration Tools, use the following information to specify the web service you want to upgrade and the location of its configuration console:
Web service name Configuration console location
Citrix install-locationServicesCitrixWSConfigurationCitrixServiceConfigConsole.exe
Exchange install-locationServicesExchangeWSConfigurationExchangeConfigConsole.exe
LyncEnterprise install-locationServicesLyncWSConfigurationLyncConfigConsole.exe
LyncEnterprise2013 install-locationServicesLyncWSConfigurationLyncConfigConsole.exe
LyncHosted install-locationServicesLyncHostedWSConfigurationLyncHostedConfigConsole.exe
LyncHosted2013 install-locationServicesLyncWSConfigurationLyncConfigConsole.exe
MySQL install-locationServicesMySQLWSConfigurationMySQLConfigConsole.exe
SharePoint2010 install-locationServicesSharePoint2010WSConfigurationSharePointConfigConsole.exe
SharePoint2013 install-locationServicesSharePoint2013ConfigurationSharePointConfigConsole.exe
VirtualMachine install-locationServicesCitrixWSConfigurationVMConfigConsole.exe
WinWebHosting install-locationServicesCitrixWSConfigurationIISConfigConsole.exe

Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files (x86)CitrixCortex.

  1. On the server hosting the web service, log on as an administrator.
  2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
  3. At the command prompt, enter CortexSetupConsole.exe /upgrade:web-service-name. The Setup Tool upgrades the service and returns the command prompt.
  4. At the command prompt, enter path-to-service-configuration-console /Upgrade. The Configuration Tool reconfigures the web service and returns the command prompt.


The following command upgrades the Citrix web service.
CortexSetupConsole.exe /Upgrade:Citrix 
The following command reconfigures the Citrix web service.
install-locationServicesCitrixWSConfigurationCitrixServiceConfigConsole.exe /Upgrade 

After upgrading all web services, continue the upgrade process by upgrading the Reporting service and data warehouse. For more information, refer to the topic Upgrade the Reporting service.