ESCAUX UCS Installation Guide

Preface

Confidentiality

The information contained in this document should be treated as confidential and should only be shared with Escaux N.V. customers. Under no circumstances and under no form should any part of this document be transferred to third parties.

Scope of this Document

This is meant to allow IT Managers, IT integrators and IP PBX providers to install an Escaux Unified Communication solution for their organisation or their customer's organization.

New installation

Preparation Baseline

Baseline

SOP baseline software.

USB

procedure to make a usb drive

Hardware preparation

Cards Hardware Installation

SOP key

Since SMP 4.9 customers can do the preparation of the SOP key. See "SMP configuration and menus" > "The menu "Advanced" into our UCS Administration Guide

ALERT!Changing the Account, Network ID or Cluster/SOP flag has severe consequences on the configuration. In general it should never be changed for SOPs that are in use.ALERT!

When preparing a SOPkey, if it is not already the case, please make sure the configuration is 100% clean by loading the "Empty" template as very first step, prior to going any further.

This will ensure that, if for example you have to build a SOP from scratch, you don't have any old data from previous customer when re-using an old SOPkey.

SOP installation

SOP baseline software installation and activation

  • Label the server
    • one label identifying the machine : "[SOPKEY].sop"

  • Web interface configuration
    • Log into the SMP, create/configure your SOP(s) (Cluster, Active-Active, Active-Standby, ...)
    • Select then the SOP you are going to format/setup :
      • Go into Advanced > Server Configuration : fill the fields according to the CRS file, don't forget to clear the DSA key if any (pre-existing SOP) and save.
      • If you want to use a template, go into Advanced > Load Public Template and select the one you want to use, then save

  • Verify the following BIOS settings
    • For Transtec 2U servers
      • Settings that should be ok by default :
        • Boot > Boot Device Priority > CDROM has to be the first device (default for new machines)
        • Boot > Boot Device Priority > Disable "Boot from network"
      • Settings that should be changed manually :
        • Advanced -> ACPI Configuration -> High Precision Event Timer has to be Disabled
        • ALERT! Advanced > Boot features > restore on ac power loss : power on
          • The goal is that, in case of a power failure, the server boots without a user intervention. Test this setting by rebooting the machine and once the bootloader (currently GRUB) is started, disconnect the power cable(s). Reconnect the power cable(s). The machine must now boot without additional user intervention.
    • For Transtec 4U/Tower servers
      • Settings that should be ok by default :
        • Boot > Boot Device Priority > CDROM has to be the first device (default for new machines)
        • Boot > Boot Device Priority > Disable "Boot from network"
        • Advanced > Peripherals Configuration > OnBoard 1394 has to be disabled to prevent eth/FireWire confusion (if applicable, no longer needed for new machines)
      • Settings that should be changed manually :
        • Advanced > Chipset Configuration > "High Precision Timer" has to be disabled
        • ALERT! Power > Make sure that the After Power Failure option is activated (Power ON)
          • The goal is that, in case of a power failure, the server boots without a user intervention. Test this setting by rebooting the machine and once the bootloader (currently GRUB) is started, disconnect the power cable(s). Reconnect the power cable(s). The machine must now boot without additional user intervention.
    • For HP Proliant DL120 G6 servers (1U)
      • Settings that should be changed manually :
        • Main > Boot features > Restore after AC power loss > On
    • For HP Proliant DL360 G7 servers (1U)
      • Settings that should be changed manually :
        • Server availability > Automatic power-on > Enabled
    • For HP Proliant DL360 G9 servers (1U)
      • (LOW END S1088)Settings that should be changed manually to configure the disks:
        • (F9) System Utilities > System Configuration > Embedded RAID1: Smart Array P440ar controller > 'Exit and launch HP smart storage admin' > Select Smart Array P440ar > Configure > Create Array > Select all > Create array > Leave defaults & create logical drive (Raid 1) > Finish > Exit > Reboot
      • (HIGH END S1090) Settings that should be changed manually to configure the disks:
        • (F9) System Utilities > System Configuration > Embedded RAID Smart Array P440ar controller > 'Exit and launch HP smart storage admin' > Select Smart Array P440ar > Configure > Create Array > Select all > Create array > Leave defaults & create logical drive (Raid 6) > Finish > Exit > Reboot
      • Settings that should be changed manually in case you install baseline < 3.3.0 :
        • (F9) System Utilities > System Configuration > BIOS/Platform configuration > Boot Options > Boot Mode > Legacy BIOS Mode
        • (F9) System Utilities > BIOS/Platform configuration > System options > Processor options > Processor x2APIC support > Disabled
    • For HP Proliant DL320 G8 servers (1U)
      • Settings that should be changed manually :
        • Active AHCI in the BIOS
        • After the installation, one the first reboot, Press F11 and select the disk
    • For HP Proliant DL20 G9 servers (1U)
      • Make sure there is no PCI SAS adapter installed.
      • (F9) System Utilities > System Configuration > SATA controller configuration > Make sure this is configured in SATA AHCI mode. Some servers have RAID mode selected by default.
      • Settings that should be changed manually in case you install 2.6.X:
        • (F9) System Utilities > System Configuration > BIOS/Platform configuration > Boot Options > Boot Mode > Legacy BIOS Mode
        • (F9) System Utilities > BIOS/Platform configuration > System options > Processor options > Processor x2APIC support > Disabled
        • (F9) System Options -> Sata Configuration Options -> Embedded Sata Configuration -> Enable SATA AHCI Support
      • Settings that should be changed manually in case you install 3.4.X :
        • (F9) System Utilities > BIOS/Platform configuration > System options > Processor options > Processor x2APIC support > Enabled
        • (F9) System Utilities > System Configuration > BIOS/Platform configuration > Boot Options > Boot Mode > UEFI enabled
        • (F9) System Options -> Sata Configuration Options -> Embedded Sata Configuration -> Enable SATA AHCI Support
    • Power-On Delay:
        • This will make sure that not all devices boot at the same time in case of power loss.
          • Via the ILO interface:
            • ILO 4 -> Power Management -> Server Power -> System Power Restore Settings -> Power-On Delay
          • Via BIOS settings:
            • Server Availability
              • Automatic Power-On should be ON
              • Power-On Delay (to set seconds)
    • For Dell R240 servers (1U)
    • For Dell R440 servers (High end | low end)
      • RAID configuration: The raid is normally pre-configured by Dell. Raid 1 is used for the low end. Raid X is used for the high end.
        • In case you need to change raid configuration: F2 > SETUP > Device settings > Integrated raid controller
      • Boot from USB:
        • F11 > Boot manager > One time boot > select USB
      • F2 System Setup > System BIOS > System Security > AC Power Recovery Delay > Random ILO configuration

  • Software installation
    • To enable Disk Quota => DRD_VSOP_AdminGuide#Enable_vSOPs_hard_disk_quota_on_SOP_host
    • Boot the latest SOP baseline cd-rom / USB flash drive. Go here for more information about creating a SOP baseline USB flash drive.
    • Warning ! For HP DL360 G8 and baseline 3.0.0, the USB flash drive should be put to the front of the server
      • When asked for, enter your SOP key in an 8 digits format. Example : 00000177. Activating the numlock on the keyboard might be necessary.
      • If the SOP should connect to an alternative SMP : enter the smp-boot url.
      • Press 'Enter' at each question unless otherwise instructed by ESCAUX.
    • Up to this moment, when an issue arises, the installation can simply be restarted from the beginning.
    • During the installation, the SOP will register it's authentication key towards the SMP.
    • As from this moment there's a difference between the direct customer and the reseller/SMP Owner
      • Direct Customer
        • From this moment, when an issue arises, please contact Escaux to remove the authentication keys.-->

      • Reseller / SMP Owner - as from SMP release 4.4.0
        DONE Navigate to: SMP > Advanced > Server Configuration
        • You will see the key the SOP has published. If the key is not there, republish it via the SOP Shell (see above)
        • Press "Accept"
    • ALERT! Use CTRL + ALT + DEL instead of reset when the installer ask you to press reset and remove the CD!
    • Reboot the SOP and login as 'admin'.
      • For old baselines versions (1.X +), the default password is 'admin'.
      • For the new baseline(2.X) , the default password is 'escaux'.
    • Change the admin password :
      • SOPShell > Configuration > Change Password
    • If the SOP is not using the Escaux SMP :
      • SOPShell > Configuration > Change SMP > Accept ssh host keys
    • Check the IP address in order to connect through ssh
      • SOPShell > Diagnostic > Network > Interface configuration

Connection verification after installation.

Using the SOP shell

Connect to the SOP shell and go to :
DONE Navigate to:  Diagnostics > SMP connection test
The results of this test should all indicate, "ok".

Using the SMP

On the SMP go to your sop :
DONE Navigate to:  Advanced > Module configuration > Add > test SMP connectivity > save
  • Choose the last version of the module.
  • Next indicate the module for installation and install it.
  • After the install click on view details and if everything went well you should see the message " All SMP connectivity tests passed! "

The SMP need about 5 minutes to check if connection to SOP is established. If the red indicator doesn't switch to green after the delay, contact Escaux support

Contact Escaux to finalize installation (not necessary for SMP Owners and Resellers)

  • Contact Escaux to finalize the installation.
  • Information to be given
    • Sopkey
    • Offer number

Software configuration

Template import

  • You should start by importing a template on the SMP to have a default configuration. Have a look here if you don't know how to do this

FUSION (UC Template)

For the installation of Template 3.0 see UC templates Install Guide

For more information about Template 3.0 see UC Template 3.0

For older Template you can go here

New Sop in Cluster

When you install a new sop in an existing cluster you will need to reinstall the following modules on each SOP of the cluster
  • Cluster synchronization
  • SSH peer-connectivity
+ Do an apply cluster change ALERT!

Modules installation

  • After booting the SOP on " ALERT! SOP partition 1", it will get a temporary IP address via DHCP and try to connect to the SMP. If necessary, you can set up the network configuration in SOPShell > Configuration > Network > Manual Network Config
  • Use the SOPShell > Diagnostics tool to test connectivity to SMP (Should be run 2 times before getting the correct information).
  • Log into the SMP and select the SOP.
    • Do the Server Configuration.
    • Configure & install modules
      • Main modules have already been selected in the template. For more modules, please have a look at our Module reference guide.
      • ALERT! do not forget to install the Phone support modules witch correspond to the phone you purchased (i.e. 'Polycom Phone Support' module for Polycom IP phones, 'Snom Phone Support' module for Snom IP phones, ..)
      • ALERT! For some module (Fax server, Dialogic card support), a post-installation through the Shell on the SOP is necessary. Please look at the module reference guide for more details.
    • Click on the "Install Modules" button

ALERT! Check dependency, and pay attention to the inheritance of dependency. for instance if you install a module x to meet dependency requirement of the module you want to add, you must also check dependency of module x, and so on.

PCI Cards' configuration

Sangoma

For the old zaptel integration method, see Sangoma 1 Admin Guide and Sangoma 1 Service Assurance Guide.

And for the new called NetBorder, see Sangoma 2 Admin Guide and Sangoma 2 Service Assurance Guide.

For more informations see Sangoma Card Howto.

Old PCI Cards

For old PCI card see Old PCI Card's configuration.

Final check

ALERT! Please check all the previous guidelines carefully before contacting our support department

System check

Check if the telephony process has started.
DONE Navigate to: SOPShell > Diagnostics > Telephony > Asterisk Console

You should see a similar output on the last line :
00000362*CLI>

PRI/BRI

ALERT! SOPShell > Diagnostics > Telephony > PRI Status doesn't work with PRI who have QSIG Support (SI1060)

Try to reach an external number with each PRI/BRI port (disconnect all other ISDN ports to disable the fallback interfaces)

FXS Cards

  • Each correctly configured FXS port should have an activated LED indicator.
  • Plug an analog phone in each configured FXS port. You should hear the tone and be able to call the voicemail system (typically at extension 8500).

Backup authentication keys

Each SOP has exchanged authentication keys with the SMP upon installation. We recommend backing up these keys
  • Connect through SSH using an SSH client (Microsoft Windows based application : PuTTY (Can be found through Google))
  • Enter the SOP IP address and log as admin
  • Export the authentication keys for disaster recovery purposes and store them in a safe place : SOPShell > Configuration > Key management > Export authentication keys

Reinstallation

Replacing a SOP - as from SMP release 4.4.0

General Steps :

  • Resellers and SMP Owners must now clear the existing SSH Key
DONE Navigate to: SMP > Advanced > Server Configuration
  • Click on "Clear Key"
  • Continue with SOP baseline software installation and activation
  • Install all other modules
  • Post install actions for the SOP
  • ALERT! Don't forget to do an "apply changes" and press on the green arrows so the apply-changes-process clears it's buffer and regenerates all config (it is also needed for synchronizing profile parameters).
  • Don't forget to put back all the backups (sounds, prompt, voicemails) from the BMS to the newly replaced SOP (If its a cluster check below for the prompts). ALERT! Do not restore /etc ALERT!
    • Go to the BMS web interface, select your SOP ( on right top ) and then select the files you need to restore.
    • if problem, execute /escaux/bin/smp_gen_known_hosts.pl on SMP008 ( /escaux/bin/gen_backuppc.pl -v on SMP013 )
    • if manual restoration, be careful to ownership!
  • ALERT! If you replace an older BRI card by a Sangoma you need to use a split cable because of Sangoma cards architecture ( 1 BRI port ( RJ 45 ) = 2 BRI connections )
  • ALERT! If advanced rapporting is used -> synchronization will no longer work since the id's in attribute log on SMP are higher than on the new SOP. In order to solve this -> you have to put the attribute_log table from the old sop onto the new one.
    • In order to check : run predict_synccdrdb 'sopkey' and check for any negative values. No negative values = OK
    • if not ok : on SOP > mysql > cdrdb database > update attribute_log set id=id+"ID_ON_SMP_ATTRIBUTE_LOG" , t=t;

Active/Standby Steps :

ALERT! Attention if you replace a SOP which is part of an Active/Standby configuration, you have to be careful with the following points :
  • there will be an impact for the end user during the modules installation (They will be installed on both Active & Standby machines). The estimated downtime is 30min.
  • Modules installation
    • install the HA module on the web interface of the SMP
    • wait for it to install (you can see the progress (as from stable-4) : apply changes->view progress)
    • connect to the SOPshell and correct the state of the machine (probably standby) (if you forget this, the server might take the active IP address and cut all telephony!)
    • install the network module
    • wait for the connection to be established
    • install all other modules
  • Don't forget to do post installation actions on both SOPs

  • Don't forget to do an "apply changes" and press on the green arrows so the apply-changes-process clears it's buffer and regenerates all config (it is also needed for synchronizing profile parameters).
  • To be sure, restart also mserver.
  • Don't forget to put back all the backups (sounds, prompt, voicemails) from the BMS to the newly replaced SOP.

Cluster Steps :

The prompts in a cluster are mostly synced between sop 's in the cluster. There fore its important to reinstall the following modules

  • Reinstall the Cluster synchronization module on each sop in the cluster
  • Reinstall the SSH peer connectivity module on each sop in the cluster.

High Availability

Make an Active-Standby setup

  1. Install 2 SOP's.
  2. Configure 1 of them. It will be the Primary SOP (IP will be the same on the 2 SOP's).
  3. On the second SOP, Navigate to : Advanced > Server configuration.
  4. Choose the sopkey of the Primary SOP in the Clone From Field.
  5. Click Save.
  6. Add the High Availability and SSH Peer Connectivity modules .
  7. Configure the H.A module with the 2 Sopkey's and the 2 others IP.
  8. Install the Modules.
  9. Make an 'Apply Changes'.

For more informations about Active Standby see the Active-Standby redundancy Admin Guide

Make an Active-Active setup

Define a sopkey to be the cluster

  1. On the SMP, choose one available sopkey.
  2. Navigate to : Advanced > Server configuration.
  3. Choose an Account Name
  4. Choose a Network ID
  5. Select 'cluster' for the Cluster field.
  6. Click Save.

Add SOP to cluster

  1. Install a SOP.
  2. Navigate to : Advanced > Server configuration.
  3. Enter the same Account Name than for the cluster.
  4. Enter the same Network ID than for the cluster.
  5. Click Save.

Configure Cluster.

Configure the resources and the extensions

ALERT! WARNING : The migration from an Active-Standby to an Active-Active configuration is not supported. It will break your configuration. ALERT!

Copyright © Escaux SA