Product Documentation

Install the Hosted Exchange web service

Jun 05, 2015
Updated: 2014-08-14

The Hosted Exchange web service is installed on a server in your environment that hosts the Exchange Management Console. You can install the Exchange web service using either the graphical interface of the Services Manager installer or through the command line.

To install the Exchange web service using the graphical interface

The installation process includes preliminary configuration to create the web service account and IIS application pool, define the Exchange deployment environment, and add multi-tenancy permissions to Active Directory. After installation, you can enable the service and continue configuration through the control panel.

This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.

  1. On the Select Deployment Task page, select Install CloudPortal Services Manager.
  2. On the Install CloudPortal Services Manager page, select Add Services.
  3. On the Add Services page, select Install Services.
  4. Accept the License Agreement and then click Next.
  5. On the Select Web Services page, select Exchange Web Service and then click Next.
  6. On the Review Prerequisites page, review the list of software that will be installed to support the web service. Click Next.
  7. On the Ready to Install page, click Install. The Deploying Server Roles page displays the installation progress.
  8. After the installation finishes, click Finish.
  9. On the Add Services page, select Configure Services.
  10. On the Installed Services page, click Configure next to the Exchange Web Service item. The Configuration Tool attempts to contact the Encryption Service to retrieve the encrypted key. If the service cannot be contacted, the Configuration Tool prompts you to import the encrypted key 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 specified when the key file was generated. Click Next.
  12. On the Configure IIS page, enter the following information and then click Next:
    • Auto-generate credentials: Select this check box to allow the Configuration Tool to generate service account credentials automatically.
    • User name: Enter a user name for the Exchange web service account. The default user name is csm_exchange_svc. This field is unavailable when you elect to auto-generate credentials.
    • Password: Enter a password for the Exchange web service account. This field is unavailable when you elect to auto-generate credentials.
    • Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in Active Directory.
    • Service port: Enter the port used by the Exchange web service. The default port is 8095.
  13. On the Exchange Deployment Details page, enter the following information and then click Next:
    • Exchange version: Select the version of Exchange that is deployed in your environment.
    • Mixed-mode deployment: Select this check box if your Exchange deployment includes servers running different versions of Exchange. For example, your deployment includes Exchange 2010 servers as well as Exchange 2007 servers.
    • Preferred domain controller: Enter the FQDN of the domain controller you want to use with the web service.
  14. On the Configure Exchange for Multi-Tenancy page, select Apply multi-tenancy permissions to ensure customers will be isolated appropriately when the Exchange service is provisioned to them. Click Next.
  15. On the Create Scheduled Tasks page, select Create sync scheduled tasks to synchronize Exchange data with Services Manager. This option is selected by default; however, you only need to create these tasks on one Exchange server in your deployment. If these tasks have been created already, clear this option.
  16. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration page. When the summary contains the settings you want, click Next. The Configuration Tool configures the Exchange web service, imports the Encryption Service key, and displays progress.
  17. Click Finish and then click Exit to close the Configuration Tool.

To install the Exchange web service from the command line

Before installing the Exchange web service, ensure the following pre-requisites are met:
  • The server on which you are installing the web service has the Exchange Management Console installed.
  • The Exchange servers are running supported versions of Microsoft Exchange.
  • You have installed .NET Framework 4, located in the Support folder of the Services Manager installation media, on the server hosting the Exchange web service.
  • You have created the Exchange web service account in Active Directory.
  • The Exchange server allows inbound connections from the web server on the appropriate port. The default port is 8095.
  1. On the Exchange server, 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 /Install:Exchange. The Setup Tool installs the web service and returns the command prompt.
  4. At the command prompt, enter install-locationServicesExchangeWSConfigurationExchangeConfigConsole.exe and specify the following properties:
    Property Description
    /UserName:username Impersonation account for the Exchange service. This parameter is optional if you are using /GenerateCredentials.
    /Password:password The application pool password. This parameter is optional if you are using /GenerateCredentials.
    /ServicePort=port Inbound port to be used and added to the CortexServices web site. Default = 8095
    /ExchangeOrganization:org-name Optional. The name of the Exchange organization.
    /AutoCreateUser:True | False Optional. Create the service account in Active Directory.
    /GenerateCredentials:True | False Optional. Generate password for the service account.
    /HasLegacyServers:True | False Optional. Whether or not the environment contains servers running multiple versions of Exchange. For example, servers running Exchange 2010 in the same environment as Exchange 2007 servers. Default = False
    /Lockdown:True | False Optional. Apply lockdown of Exchange permissions. Default = False
    /PreferredDc:FQDN Optional. Preferred domain controller.
    /TargetVersion:2007 | 2010 | 2013 Optional. The version of Exchange to use with Services Manager. Supported versions: 2007, 2010, or 2013

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

    The Configuration Tool performs initial configuration of the web service and returns the command prompt.

Sample installation command string

The following command performs the initial configuration of the web service.
install-locationServicesExchangeWSConfigurationExchangeConfigConsole.exe /UserName:exch_svc_acct /ExchangePassword:password /ServicePort:8095 /TargetVersion:2010

When the installation process is finished, log on to the control panel and configure the web service. For instructions, see To configure the Hosted Exchange service.