Preinstallation Requirements Guide

Transcription

1 Preinstallation Requirements Guide Synergy June 2015 Synergy 2015

2 TOC 1: Introduction 4 Synergy platform modules 4 Synergy install procedure - your responsibilities 4 Further information about Synergy 4 2: Configuring the 5 Hardware requirements 5 Task 1: Installing the operating system 5 Task 2: Installing Web (IIS),.NET and Visual C++ 5 Task 3: Downloading install files to the server 6 3: Configuring the ComNode 7 Hardware requirements 7 Task 4: Preparing the server 7 Task 5: Downloading the ComNode (and upgrade) files 7 Task 6: Deploying the.ovf template 7 Task 7: Using the ComNode console to configure the ComNode server settings 8 Task 8: Testing the ComNode 10 Supported browsers 10 4: Configuring the Database 11 Hardware requirements 11 Task 9: Installing the Database operating system 11 Task 10: Installing Microsoft SQL on the Database 11 Task 11: Enabling Mixed-Mode authentication 11 5: Configuring the Remote Agent (optional) 13 Hardware requirements 13 Task 12: Installing Windows on the Remote Agent 13 Task 13: Configuring Windows on the Remote Agent 13 6: Configuring your network 14 Task 14: Configuring NTP, site administrator access and network communication 14 Page 2 of 20

3 7: Configuring the infrastructure components 16 Task 15: Ensuring infrastructure components are running a supported software version 16 8: Configuring the Lync (if applicable) 17 Task 16: Configuring the Lync SQL server for real-time monitoring of the Lync Front-End server(s) 17 Task 17: Configuring the Lync SQL server for CDR reporting 17 Task 18: Providing our engineer with Lync access and information 18 9: Providing our engineer with access and information 19 Task 19: Enabling remote access 19 Task 20: Configuring and providing DNS hostnames 19 Task 21: Providing SQL Database server details 19 Task 22: Providing SMTP details 19 Document revision history 20 Page 3 of 20

4 1: Introduction Synergy platform modules The Synergy platform consists of the following main modules, each residing on a dedicated server or virtual machine: ComNode Database Remote Agent (Optional) This document describes how to configure each of these servers so that they are ready for our engineer to begin the installation on the agreed install date. Synergy install procedure - your responsibilities The Synergy install procedure is complex, and most of the install steps will be carried out by one of our engineers. Before our engineer begins the installation, you must complete all the tasks described in this document as follows: 1. Configure the, ComNode, Database and Remote Agent (optional), each on a dedicated server or virtual machine as described in Tasks Configure your network for Synergy so that the modules and infrastructure components can communicate freely through the firewall as described in Task Ensure any infrastructure components you want to integrate with Synergy are running a supported software version as described in Task Optionally, configure Lync to work with Synergy as described in Tasks Provide our engineer with access, server addresses, and credentials as described in Tasks If you have any problems with any of the steps described in this document, or are unable to provide any of the essential information or access required, contact your Synergy representative well before the installation date so we can resolve the issues and ensure your installation goes smoothly. Further information about Synergy For detailed information about the Synergy platform see: Synergy Administrator Guide. Page 4 of 20

5 2: Configuring the The has multiple functions. Both the Synergy admin portal and the provisioning portal run on this server. In addition, the following services are hosted on the : Harvest service. Alert service. Processing service. All of the API services. Hardware requirements The must be a dedicated server or virtual machine with this hardware configuration as a minimum: CPU RAM Hard drive capacity 4 cores 2 Ghz 8 GB 100 GB Task 1: Installing the operating system Install one of these supported Microsoft Windows versions on the server: Windows 2008 r2 Windows 2012 Task 2: Installing Web (IIS),.NET and Visual C++ Once you have installed Windows on the : 1. In Manager, go to Add roles and features. 2. Under Roles, install Web (IIS) with: o Basic Authentication o Digest Authentication o Forms Authentication (2008 Only) 3. Under Features, install: o.net Framework 4.5 o ASP.NET Download and install Windows Powershell 4.0 using the instructions here: How to install Windows Powershell Download and install both the following on the server: o Microsoft Visual C x64 Redistributable o Microsoft Visual C x86 Redistributable Note: Do not make any changes to the default settings in IIS. Page 5 of 20

6 Task 3: Downloading install files to the server Download the Synergy installation files and save them in a folder on the desktop of the as follows: 1. In a browser window, enter: 2. Log in using these credentials: o Username: synergyftp o Password: getapps 3. Click on the 3.4.9/ folder, and download Synergy_ComNode_ U3.4.9.zip and Synergy_WinNode_U3.4.9.zip. 4. Create a folder on the desktop of the and save the files there. Page 6 of 20

7 3: Configuring the ComNode The ComNode is installed as a Linux VMWare application server package. The ComNode server hosts the following services: XMPP server LDAP server MongoDB Low level drivers Once Synergy is installed, you will carry out most maintenance tasks on the ComNode. Hardware requirements The ComNode server must be a dedicated server or virtual machine with this hardware configuration as a minimum: CPU RAM Hard drive capacity 4 cores 2 Ghz 8 GB 200 GB Task 4: Preparing the server Install VMWare ESX (vsphere) version 5.0 or later on the ComNode server. Task 5: Downloading the ComNode (and upgrade) files 1. In a browser window, enter: 2. Log in using these credentials: o Username: synergyftp o Password: getapps 3. Click on the 3.4.7/ folder, and download SynergyComNode_3.4.7_ 203.ovf.zip. 4. Go back to the /software directory, and click on each version folder for subsequent releases after 3.4.7, and download each Synergy_ Winnode_U3.4.x.build file and save it on your network. Our engineer needs these files to upgrade Synergy to the latest version during the install. Task 6: Deploying the.ovf template 1. On the ComNode server, open the VMware vsphere client. 2. Deploy the OVF template you downloaded in Step 3 above. This will automatically extract all the necessary information from the.mf and.vmdk files that were also in the same folder. Page 7 of 20

8 3. Configure the server resources to your own company's internal requirements. 4. Start the server. Task 7: Using the ComNode console to configure the ComNode server settings 1. SSH to the IP address of the ComNode to access the Command Line Interface using the following credentials: o Username: root o Password: SynergySkyWord 2. Set a host name for the server: Page 8 of 20

9 3. Configure the network settings for the server to your own company's network requirements: 4. Restart the server. Page 9 of 20

10 Task 8: Testing the ComNode Now you need to test that the ComNode setup and configuration was successful by logging into the ComNode web interface from a browser: 1. In a browser, type: IP address or FQDN]: Log in with the default admin user: o User name: admin o Password: SynergySkyWord 3. Go to Configuration > About and verify that the correct component version is listed for the Synergy ComNode component: Supported browsers Browser Google Chrome Firefox* Safari Version 32.0 or later 26.0 or later 7.0 or later Note: There are some limitations when using Firefox for generating reports in Synergy. We recommend using Google Chrome on a Windows platform. Page 10 of 20

11 4: Configuring the Database The Database runs on Microsoft SQL 2008 R2 or This database stores the following data: System configuration System data CDRs System and event logs Note: All other data is stored in the MongoDB which runs on the ComNode. Hardware requirements The Database must be a dedicated server or virtual machine with this hardware configuration as a minimum: CPU RAM Hard drive capacity 2 cores 2 Ghz 4 GB 50 GB (Size here depends on usage pattern and data retention policies) Note: You can use this database server to host other applications' databases. Task 9: Installing the Database operating system Install one of the following supported Microsoft Windows versions on the server: Windows 2008 r2 Windows 2012 Task 10: Installing Microsoft SQL on the Database Install one of the following supported Microsoft SQL versions on the server: Microsoft MSSQL 2008 R2 Standard/Enterprise Microsoft MSSQL 2012 Standard/Enterprise Task 11: Enabling Mixed-Mode authentication Enable Mixed-Mode authentication on the SQL server: 1. In SQL Management Studio, right-click on the server in the Object Explorer and select Properties. 2. In Security, change authentication to SQL and Windows Authentication mode. Page 11 of 20

12 3. Click OK. 4. Restart SQL server when prompted. Page 12 of 20

13 5: Configuring the Remote Agent (optional) The main purpose of the Remote Agent is to fetch status information and call data records from infrastructure devices deployed at remote sites. This server is not mandatory in all types of installations, but is recommended for deployments where infrastructure devices are installed remotely. This section describes configuring Windows on the server in preparation for the Synergy install. Hardware requirements The Remote Agent must be a dedicated server or virtual machine with this hardware configuration as a minimum: CPU RAM Hard drive capacity 2 cores 2 Ghz 4 GB 50 GB Task 12: Installing Windows on the Remote Agent Install one of the following supported Microsoft Windows versions on the server: Windows 2008 r2 Windows 2012 Task 13: Configuring Windows on the Remote Agent Once you have installed Windows on the Remote Agent : 1. In Manager, go to Add roles and features. 2. Under Features, install: o.net Framework In a browser window, download and install both the following on the server: o Microsoft Visual C x64 Redistributable o Microsoft Visual C x86 Redistributable Page 13 of 20

14 6: Configuring your network Task 14: Configuring NTP, site administrator access and network communication 1. Configure all servers and infrastructure components in your deployment towards the same NTP server(s), either directly or indirectly. 2. Ensure that the Synergy platform has Site Administrator access to all infrastructure components and APIs. 3. Configure your network to allow the following communication: Source Destination Protocol TCP port Description Database SQL 1433 Read/write to/from Synergy database Cisco VCS HTTP HTTPS 80 Read status and call log from VCS API Cisco Codian MCU Cisco Codian ISDN Gateway XML over RPC 80 (if HTTPS is not enabled on the gateway) Read status and call log from MCU and/or ISDN RPC API Cisco TCS HTTP HTTPS 80 (if HTTPS is not enabled on the gateway) Read status and call log from TCS API Pexip Infinity Management node Pexip Infinity Conference node HTTP SSH 22 Read status and call logs Acano MCU HTTP HTTPS 80 Read status Polycom RMX HTTP HTTPS 80 Read status Polycom DMA HTTP HTTPS SNMP Read status DMA API port Real time status Lync front-end server SQL 1433 (or whichever port you have configured, if not default) Read status Lync CDR server SQL 1433 (or whichever port you have configured, if not default) Read call logs Page 14 of 20

15 Source Destination Protocol TCP port Description ComNode(s) XMPP XMPP TLS XMPP communications ComNode(s) LDAP LDAPS LDAP directory LDAPS directory ComNode(s) HTTP 80 ComNode API SMTP server(s) HTTP HTTPS 80 Send password reset (s) Remote Agent HTTP HTTPS 80 Data exchange ComNode SMTP server(s) SMTP 25 (or any port configured for SMTP) Send alert (s) ComNode Database server SQL 1433 Create/update SQL database ComNode Any Web 80 iframe import for Provisioning Management Customization ComNode Cisco Codian MCU XML over RPC 80 (if HTTPS is not enabled on the gateway) Provision VMRs ComNode Pexip Infinity Management node HTTP HTTPS 80 Provision VMRs ComNode Acano MCU HTTP HTTPS Acano MCU ComNode LDAP LDAPS Provision CoSpaces and initiate user synchronization Synchronization of users Acano MCU HTTP 80 CDR collection (both protocol and port can be customized) Any ComNode Web 8080 Browser access to ComNode admin UI Page 15 of 20

16 7: Configuring the infrastructure components Task 15: Ensuring infrastructure components are running a supported software version The following infrastructure software versions are supported for use with Synergy. It is your responsibility to ensure that any infrastructure you want to integrate with Synergy is running a supported software version: Infrastructure Version Comments Cisco VCS All versions from X4.3 - X8.6 Polycom DMA v6.1 There are limitations with call matching H.323 calls. Provisioning is not supported for Polycom DMA. The RealPresence Platform API license is required to integrate the Polycom DMA with Synergy (at additional cost from Polycom). Lync 2013 Billing and Provisioning are not supported for Lync. Codian MCU All versions from UTC offset must be set to 0 due to the lack of support for automatic DST change. Cisco TelePresence v3.0 and v3.1 Provisioning is not supported for Cisco TelePresence Pexip Infinity MCU All versions from v1 - v10 FQDN host addresses are not supported for Pexip Infinity nodes. A cluster must be created for any Pexip management and conference node (s). The management node must be set as the conference master. Any conference nodes must be added to their intended cluster. Acano v1.0, v1.2, v1.7 Polycom RMX v8.5.1 Provisioning is not supported for Polycom RMX. There are limitations with call matching H.323 calls. Cisco Codian ISDN Gateway Cisco TelePresence Management Suite (TMS) Cisco TelePresence Content (TCS) v2.7 UTC offset must be set to 0 due to the lack of support for automatic DST change Provisioning is not supported for Cisco Codian ISDN Gateway. all versions from v v14.6 v5.0 - v6.1 Reporting and Billing are only supported if the call is routed through a Cisco VCS. CDR harvest is not supported for Cisco TCS. Provisioning is not supported for CIsco TCS. For more information on integrating infrastructure with Synergy, see: Synergy Administrator Guide. Page 16 of 20

17 8: Configuring the Lync (if applicable) Note: This section only applies if you want to integrate Microsoft Lync with Synergy. To integrate with Lync, the Synergy platform requires read access to two of the Lync databases. Task 16: Configuring the Lync SQL server for real-time monitoring of the Lync Front-End server(s) For real-time monitoring, Synergy needs access to the rtcdyn database, under the SQL instance RTCLocal. In a typical Lync deployment with multiple front-end servers configured, Synergy needs access to all the front-end servers to gather real-time monitoring information. To configure the Lync SQL server for real-time monitoring of the front-end servers: 1. Enable Mixed-Mode authentication on the SQL server: a. In SQL Management Studio, right-click on the server in the Object Explorer and select Properties. b. In Security, change authentication to SQL and Windows Authentication mode. c. Click OK. d. Restart SQL server when prompted. 2. Create an SQL user with Read-Only access to each 'rtcdyn' database. Task 17: Configuring the Lync SQL server for CDR reporting To retrieve the data for CDR reports, Synergy needs access to the Lync CDR database. The default Lync CDR database name is lcscdr, and Synergy does not currently support using any other name. You can choose where to locate this database, so the SQL instance name will vary. CDR reporting is not configured by default in a Lync deployment. To configure the Lync SQL server for CDR reporting: 1. Enable Lync CDR reporting following these instructions: Deploying monitoring in Lync Enable Mixed-Mode authentication on the SQL server: a. In SQL Management Studio, right-click on the server in the Object Explorer and select Properties. b. In Security, change authentication to SQL and Windows Authentication mode. Page 17 of 20

18 c. Click OK. d. Restart SQL server when prompted. 3. Create an SQL user with Read-Only access to the lcscdr database. Task 18: Providing our engineer with Lync access and information Provide us with: Hostname or IP address for all Lync front-end servers. Username and password for the rtcdyn database for all front-end servers. Hostname or IP address and SQL instance name for the CDR database. Username and password for the lcscdr database. The port number used to connect to all the SQL server instances described above (if not 1433). Note: Always restart the SQL server after changing to 'SQL and Windows' (Mixed-Mode) authentication. Note: If you are not using the default SQL port (1433), ensure that you have configured your firewall to allow traffic on the port you are using instead. Page 18 of 20

19 9: Providing our engineer with access and information You must configure and document everything listed below, and provide the information to the Synergy representative responsible for your installation before the installation date. Failure to do so will cause your installation to be delayed. Task 19: Enabling remote access Provide our engineer with remote access to: The ComNode. The. Remote Agent (if applicable). Task 20: Configuring and providing DNS hostnames Provide our engineer with the DNS FQDN for: The ComNode. The. Remote Agent (if applicable). Task 21: Providing SQL Database server details 1. Provide our engineer with: o SQL IP/FQDN address o SQL port 2. Do one of the following: o Provide our engineer with an SQL user with sysadmin rights to the SQL server. o Create a database and provide an SQL user with db_owner rights to that database, and the name of the database if not the default (synergysky). Task 22: Providing SMTP details Provide our engineer with the following SMTP information: address Port number SMTP Credentials (username and password) Sender name Sender address Note: If you want to integrate Lync with Synergy, see "Configuring the Lync (if applicable)" on page 17 and ensure you provide our engineer with Lync server access and information as described in that section. Page 19 of 20

20 Document revision history Date Revision Description 19 August Updated the supported browsers section adding a caveat saying some functionality is limited when generating reports in Firefox. Updated the supported infrastructure section with latest supported versions. Added Polycom call matching over H.323 limitation to the Infrastructure support section. Page 20 of 20