Product Documentation

Install the Lync Enterprise 2013 and Lync Hosted 2013 web services

Jun 05, 2015
Updated: 2014-08-29

Before you install the Lync 2013 web services, ensure you have a working deployment of Lync Server 2013 Enterprise Edition or Lync Server 2013 Multitenant Hosting Pack with a published topology.

Install the Lync Enterprise 2013 or Lync Hosted 2013 web services on the Lync Front-End servers in your environment.

You can install the Lync 2013 web services using the graphical interface of the Services Manager Setup Tool or through the command line. The Setup Tool installs the web service, any prerequisites needed, and the Configuration Tool. After installing the web service, you launch the Configuration Tool to perform the preliminary configuration. You then continue the configuration through the control panel.

To install the Lync 2013 web services through the graphical interface

The installation process includes preliminary configuration to create the web service account and IIS application pool, and define the service port.

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 Lync Enterprise 2013 Web Service or Lync Hosted 2013 Web Service. Click Next.
  6. On the Review Prerequisites page, review the required items the Setup Tool will install. Click Next.
  7. On the Ready to Install page, review your selections and then click Install. The Setup Tool installs the required files and 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 Lync web service you installed.
  11. 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 Lync web service account. For a list of the default user names for the service accounts for all Lync versions, see Plan to deploy Lync Enterprise and Lync Hosted services. This field is unavailable when you elect to auto-generate credentials.
    • Password: Enter a password for the Lync 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 Lync web service. The default port is 8095.
  12. 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 Lync web service and displays progress.
  13. Click Finish and then click Exit to close the Configuration Tool.

After you install the web service, continue the configuration using the Services Manager control panel. For more information, see To configure the Lync Enterprise 2013 service or To configure the Lync Hosted 2013 service.

To install the Lync 2013 web services through the command line

Before installing the Lync web services, ensure the following pre-requisites are met:
  • You have installed .NET Framework 4, located in the Support folder of the Services Manager installation media, on the Lync Front-End server.
  • The Lync Front-End server allows inbound connections from the Services Manager web server on the appropriate port. By default, this port is 8095.
When you install the Lync web service from the command line, you perform two actions:
  • Install the web service and create the required Services Manager directory where the web service resides.
  • Perform initial configuration of the web service using the Configuration Tool.
  1. On the Lync Front-End 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 one of the following commands:
    • CortexSetupConsole.exe /Install:LyncEnterprise2013
    • CortexSetupConsole.exe /Install:LyncHosted2013
    The Setup Tool installs the web service and returns the command prompt.
  4. At the command prompt, enter install-locationServicesLyncWSConfigurationLyncServiceConfigConsole.exe and specify the following properties:
    Property Description
    /UserName:username User name for the Lync service account. This parameter is optional if you are using /GenerateCredentials.
    /Password:password Password for the Lync service account. 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
    /AutoCreateUser:True | False Optional. Create the service account in Active Directory.
    /GenerateCredentials:True | False Optional. Generate a password for the service account.
    /SqlServer:server-address The SQL database server that hosts the Services Manager system databases.
    /UseSqlAuthentication:True | False Whether or not to use SQL authentication to access the SQL Server. Default = Integrated authentication which authenticates as the user running the configuration
    /SqlUserName:user-name If /UseSqlAuthentication:True, the username of the SQL logon to use.
    /SqlPassword:password If /UseSqlAuthentication:True, the password of the SQL logon to use.

    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 command string

The following command performs the initial configuration of the web service.
install-locationServicesLyncWSConfigurationLyncServiceConfigConsole.exe /UserName:lync_svc_acct /Password:password /ServicePort:8095

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