TC2456en-Ed24 Release Note SOT
TC2456en-Ed24 Release Note SOT
TC2456en-Ed24 Release Note SOT
This document is the Release Note for the delivery of the S.O.T. tool version 3.1.009.106. It gives all necessary information
for the usage of S.O.T. & gives which products are supported.
Revision History
Edition 1: April 24, 2018 Creation of the document. S.O.T. version 1.0
Edition 2: July 24, 2018 Edition 02. S.O.T. version 1.1
Edition 3: October 16, 2018 Edition 03. S.O.T. version 1.2.004.005
Edition 4: October 24, 2018 Edition 04. Modification about warning with use in VirtualBox (Chap. 9) + removal of
some restrictions on several products managed (chapt.9)
Edition 5: November 26, 2018 Edition 05. New version 1.2.004.007: bug fixing.
Edition 6: April 3, 2019 New version 2.0.004.013 (chap. 10). Bug fixing & features. Adding also chapter 7
“delivery format”
Edition 7: June 12, 2019 New version 2.1.004.008 with feature description
Edition 8: June 12, 2019 New version 2.2.003.008 – new feature “PCS installation” etc.
Edition 9: April 14, 2020 New version 3.0.004.000 with new features description
Edition 10: May 5, 2020 Chap 4.1 - added info related to VMware Player issue (from version 15)
Edition 11: July 7, 2020 Version 3.0.004.103 - Chap 14.2.5 – update process. Chap 16 – added chapter
“Installation by images”. Chap 14.2.6 - new feature. Update on fixed & still opened issues. Chap 15 - Restriction/ remarks
on OVF generation
Edition 12: October 22, 2020 Version 3.0.004.211 – new: Management of the new OTFC on Windows server (.210) +
1 fix in .211
Edition 13: December 18, 2020 Version 3.0.004.212 – bug fixing
Edition 14: June 17, 2021 Version 3.1.009.000 – bug fixing/ new features
Legal notice:
www.al-enterprise.com The Alcatel-Lucent name and logo are trademarks of Nokia used under license by ALE. To view other
trademarks used by affiliated companies of ALE Holding, visit: www.al-enterprise.com/en/legal/trademarks-copyright. All other
trademarks are the property of their respective owners. The information presented is subject to change without notice. Neither
ALE Holding nor any of its affiliates assumes any responsibility for inaccuracies contained herein. © Copyright 2023 ALE
International, ALE USA Inc. All rights reserved in all countries.
Edition 15: October 28, 2021 Version 3.1.009.006 – bug fixing/ new features
Remarks in PCS (chap. 16.2.6)
Several products memory size/disk size updated (new dimensioning)
Updates in Restrictions (chap. 18)
Edition 16: February 11, 2022 Version 3.1.009.007 – 1 bug fixing
Remarks on Hyper-V (restrictions: chap. 18.6)
Chap. 20: anomaly reports
Edition 17: April 20, 2022 IMPORTANT UPDATE in version 3.1.009.008 – bug fixing +
Compatibility for creating OVF with VMware 7.0 – read chap. 4.1: SOT
compatibilities/OVF – fixed issue with feature “update Suse on OMS/OST” (from N1
version).
Edition 18: July 28, 2022 Version 3.1.009.100 – new features – bug fixing
Edition 19: August 22, 2022 Version 3.1.009.101 – 1 bug fixing
Edition 20: November 2, 2022 Version 3.1.009.102 – 1 bug fixing – Features: UEFI boot support, GAS Factory mode
for external integrators (internal ALE usage)
Edition 21: February 14, 2023 Version 3.1.009.103 – bug fixing – Values of disk size changed for OMS/OST/EEGW &
VAA – No added features
Edition 22: April 17, 2023 GAS installation: restriction added for the use of ethernet interfaces (chap. 18.1)
Edition 23: August 21, 2023 Version 3.1.009.104 & 105: important bug fixing – OTFC modification: 30 ports, not 48
(chap.5.10)
Edition 24: October 11, 2023 Version 3.1.009.106: bug fixing
Legal notice:
www.al-enterprise.com The Alcatel-Lucent name and logo are trademarks of Nokia used under license by ALE. To view other
trademarks used by affiliated companies of ALE Holding, visit: www.al-enterprise.com/en/legal/trademarks-copyright. All other
trademarks are the property of their respective owners. The information presented is subject to change without notice. Neither
ALE Holding nor any of its affiliates assumes any responsibility for inaccuracies contained herein. © Copyright 2023 ALE
International, ALE USA Inc. All rights reserved in all countries.
Table of contents
1 INTRODUCTION OF S.O.T. ...................................................................................................................... 7
2 MAINTENANCE/ SERVICEABILITY/ SECURITY ........................................................................................... 8
3 MANUAL, DOCUMENTS ............................................................................................................................ 8
4 S.O.T. COMPATIBILITIES ........................................................................................................................ 8
4.1 OVF (VMware 7 compatibility) ............................................................................................................ 8
4.2 S.O.T. VIRTUAL MACHINE & HOSTS .................................................................................................. 8
4.3 BROWSER COMPATIBILITY (web interface for S.O.T. use) .................................................................. 9
4.4 MEDIA PROVISIONING (case of copy of product software to internal SOT local storage) ..................... 10
4.5 WEB INTERFACE SUMMARY ............................................................................................................ 11
5 PRODUCTS SUPPORTED, DIMENSIONING .............................................................................................. 11
S.O.T. is a new tool that provides the capability of being a multi ALE product installation tool
It will replace both products PC Installer & ALEDS (see also chapter “Boards/products not supported”).
S.O.T. is a virtual machine that can run under VMware (from 6.0) or a Virtual Box and delivered under an ISO
format containing the OVF file and the VMDK file.
It is web based controlled.
This schema resumes the entries available on the S.O.T. Web interface:
The S.O.T. is a tool to deploy ALE solutions. It’s not intended to stay connected on the network.
In this case, we recommend to shutdown the tool once an installation is done.
3 MANUAL, DOCUMENTS
System documentation will be present in the OXE R12.4 system documentation.
Look for file:
- pdf reference as “SOT_3.0_im_Manual_8AL90559USAE” in system documentation
- S.O.T. feature list
4 S.O.T. COMPATIBILITIES
With the version .008 is it possible to import an OVF again BUT the memory reservation is NO MORE present.
This means that this management MUST be done manually in the VCenter after having imported the OVF
generated by SOT.
Chrome: Firefox:
from version from version
62.0.3202.94 57.0.1
External Advanced
Project Media Settings About Logout
storage Menu
Linux RAM
Create Create Ext. storage Network
for OXE
project media settings settings
servers
Backup -
Restore
Update
S.O.T.
Reports
Show/Hide
advanced
menu
5.2 EEGW
Physical servers:
- Virtual machine
S.O.T. can perform the installation of the Management server with monitoring.
The S.O.T. can perform the installation of the O2G with monitoring.
5.6 OMS
Physical servers:
- Virtual machine
5.7 OST64
Physical servers:
- Virtual machine
5.8 OTBE
Physical servers:
- Servers from white list
- Virtual Machine
The S.O.T. can perform the installation and the update of the OTBE server with monitoring.
S.O.T. can perform the installation of the OTFC server without monitoring.
S.O.T. can perform the installation of the OTFC on Windows server with monitoring.
installation since the version 9.0.0.541
5.11 OTMC
Physical servers:
- Servers from white list
- Virtual machine
S.O.T. can perform the installation of the OTMC server with monitoring and the update without monitoring.
5.12 OTMS
Physical servers:
- Servers from white list
- Virtual machine
S.O.T. can perform the installation of the OTMS server with monitoring and the update without monitoring.
5.13 OXE
Physical servers:
- ALE CPU supported: CS-2, CS-3, CPU-7 step 2 and CPU-8
- Appliance Server
- Blade server (server phased-out)
- Virtual Machine (restrictions on Hyper-V: see chap. 18)
S.O.T. can perform the installation and the update of the OXE server with monitoring.
Installation can be done:
- on unactive partition
- with reformatting
- updating a patch (static, dynamic, secured)
- remote download
Update process: see corresponding chapter in “new features on 3.0”. To update from 3.0.xx to 3.0.004.212
only the patch is needed.
8 DELIVERY FORMAT
This configuration uses a second hard disk for the template factory part.
The pre-requisites for this configuration are the following:
Here is the list of the files necessary for the deployment in this configuration:
softwareOrchestrationToolWithTemplateFactory.ova
At the starting of the solution, a verification will be launched automatically to see if the template Factory
configuration is enabled.
If all the pre-requisites are present, you will have in the console, the line “Template Factory available”.
If it’s not the case, by launching the command templateFactory on the console, the pre-requisites
missing will be displayed.
9 Update of bootDVD
To have the products using the boot DVD “up to date” concerning the security patches, it is offered the
possibility to update the O.S. of the server through a script of the boot DVD.
This functionality is offered in the menu for the update and in the wizard for existing products.
An admin account or/and the root password must be specified according to the product. For the products that
can be updated, select the option “bootDVD only”. Once the update is done, the root password is deleted from
the project.
For the product GAS, the boot DVD update implies that the VMs embedded will be halted automatically before
performing the update.
For the OMS and OST update, the SSH access must be granted previously for the S.O.T. If it’s not the
case, the update can’t be launched. For further prerequisites, please look the products documentation.
As a reminder the pure OXE method of PCS update (“easy installation” & “remote download” menus) is still
possible IF no disk reformatting is required (needed from versions older than “M1” release)
Warning:
Concerning the scenario Update PCS from an OXE L2 version to an OXE Mx version, the update consists
in re-installing the PCS with the defined version.
Process description:
The S.O.T won’t have a direct access to the PCS. It means all the requests will go through the OXE server.
Only the PCS will connect to the S.O.T on the port 443 for retrieving the version files.
- Step ❶: Through the S.O.T web interface, the user asks for the update of PCS. Once the information
provided has been verified, the update is launched.
- Step ❷: The S.O.T connects to the OXE main server and copies the installation package retrieved in
the OXE version to install. Then, the package is extracted on the OXE.
- Step ❸: The script for the PCS installation located on the OXE main server is triggered. This action will
transfer the installation script to the PCS to update and triggers the installation procedure by launching
the installation script.
- Step ❹: The PCS retrieves the version through an https connection to the S.O.T. The installation
progress is tracked and provided to the user through the monitoring displayed on the S.O.T.
This new functionality will work with the following OXE versions:
Using this function will bring some restrictions. In fact, this function is restricted to Appliance and Blade
servers. The maximum parallel downloads that will be started at a time for Appliance server and Blade server
is 10.
If the CPU used is one of those unsupported, the download will be done sequentially.
Process description:
In the same way than for the PCS update through https, the S.O.T won’t have a direct access to the PCS. It
means all the requests will go through the OXE server.
- Step ❶: Through the S.O.T web interface, the user asks for the update of PCS. Once the information
provided has been verified, the update process is launched.
- Step ❷: The S.O.T connects to the OXE main server and copies the OXE version to install on the OXE
main. Then, the version is extracted on the OXE.
- Step ❸: Once the version is extracted, the S.O.T launches the command pcxdownload with the PCS
IP address in parameter. This action will start the update.
- Step ❹: The PCS retrieves the version. The installation progress is tracked and provided to the user
through the monitoring displayed on the S.O.T.
- Step ❺: The new version is installed on the inactive partition.
A new button must be used to launch the discovery of PCS. To activate this button, the OXE credentials must
be completed (mtcl credential, swinst and root password). So, if the credential for the OXE server are not
present, the button “Discover PCS” will be deactivated.
The discovery of PCS is only available by connecting to a OXE server with the TEL running.
A click on the button “Discover PCS” will launch the PCS discovery.
According the result of the request, we will have two behaviors:
- No PCS discovered: A message will be displayed indicating that there is no PCS declared on the OXE
Server.
- PCS discovered: A table will appear with the information retrieved from the OXE
An error message will be displayed if the role of the OXE server is different from MAIN. In fact, the PCS
discovery can only be done on a OXE server with the role MAIN.
In case where PCS have been discovered, the table displayed will contain seven columns:
- The first one is for the selection of the PCS to update. If we tick, the checkbox of the header line, we
select all the PCS discovered.
- The second column provides the state of the PCS. Three states are possible: ACTIVE, INACTIVE and
UNDEF.
- The third column is about the hostname of the PCS.
- The fourth one gives the IP address.
- The fifth column will indicate the version detected on the PCS
- The two last columns are about the “mtcl” credential of PCS.
11.1 Features
OXE:
- Linux ram boot
8770:
- Updating and Installing hotfixes
OT:
- Document Converter Server (DCS)
- Updating and Installing hotfixes
- Appliance Server OTBE
- Deployment monitoring. Update
SOT:
- Wizard for existing products
In the step 1, the S.O.T. only manages the projects for the installation of new products. It was binding when
we want to update an existing product.
To remove this constraint, an improvement has been done in the wizard.
Now, the wizard proposes two entries:
▪ Greenfield project: for installation from scratch. It corresponds to the wizard of Step 1.
▪ Project for existing products: for updating an existing product. It’s the new entry.
Remarks:
Project created for existing products can’t be deployed for an installation
- Windows Share
There is a possibility to declare a Windows Share in S.O.T.
11.2 Products
11.2.1 New products
- OTBE
- DCS
- G.A.S.
12.1 Features
12.1.1 First Web connection
At the first connection to the web interface, the user will be asked to enter a password.
The default password is letacla
The password can be modified in the account settings.
The installation from scratch of the OXE servers through the S.O.T. can only be performed with an ISO file.
So, only the installation of a full version – version with patches static and dynamic – was available.
With this new functionality, S.O.T. has the possibility to define what the admin. wants to install: a full version,
a version with patch static or a version without patches.
From the screenshot printed:
the part 1 indicates the ISO file used.
the part 2 indicates the version to install.
13.1 Features
13.1.1 OXE - Linux ram boot
13.1.3 OT
- Document Converter Server (DCS)
- Updating and Installing hotfixes
- Appliance Server OTBE
- Deployment monitoring. Update
13.1.4 SOT
At first connection to S.O.T, the user will be redirected to the account settings page. Two cases are
possible:
- The user has the default password. In this case, it will be asked to provide a new complex
password and to select a passphrase with an associated answer.
- The user has already changed its password. In this case, if the password is complex,
only the passphrase with an associated answer will be requested.
- The password must contain at least 8 characters with 1 uppercase, 1 lowercase, 1 special
characters and 1 alphanumeric characters.
The S.O.T generates templates compatible with the VMware environment and the KVM environment.
The products which are concerned by this new functionality are:
• OXE: OmniPCX Enterprise
• OTMS / OTMC: OpenTouch Multimedia Server or OpenTouch Messaging Center
• OTFC: OpenTouch Fax Center
• OMS: OXE Media Server
• OST64: OXE Signaling Translator IPv6 to IPv4
• O2G: OmniPCX Open Gateway
Concerning the generation of templates OTEC, only the templates concerning the products of OTEC
solution can be generated. It means:
• OXE: OmniPCX Enterprise
• OTMS / OTMC: OpenTouch Multimedia Server or OpenTouch Messaging Center
• OMS: OXE Media Server
Remark: Templates for products OpenTouch are not generated for KVM environment
(restriction coming from OpenTouch).
This will launch a verification of the project for an installation from scratch.
The result will be displayed in the page project checking.
If the product can be updated, on this page, you will find also a button “Checking for update
operation”.
A click on this button will launched a verification with the information defined in the project.
During the configuration of the update, we can specify several options managed by swinst.
For example, we can indicate if we want a schedule switching and at which time. We have also the
possibility to define a switch back if the server resets. Concerning the OXE data, we can define if we
want a linux data copy, a database copy and setting the autostart.
Those options are only available for an installation on inactive partition, except for the autostart
option.
This functionality is offered in the menu “update” and in the wizard for existing product.
13.2 Products
13.2.1 New products
- O2G: OmniPCX Open Gateway
14.1 Products
- Eegw (External Encryption Gateway). The Encryption Gateway is one of sub-products of the OST
server. The OST server has two sub-products: OST64 and EGW.
- Only the media part can be modified. All other parameters are just for information. Those parameters
can be modified by the menu edition of the project.
15.1 Products
- none
PCS update:
The PCS update procedure developed in the S.O.T is based on the procedure defined in the
TC2338.
Only the update PCS from a L2 version to a Mx version has been considered. In this case, the
update consists in re-installing the PCS with the defined version.
This functionality is only available through the menu update.
This new functionality will work with the following OXE tested versions:
- OXE M1 since version M1.403.22
16.1 Products
EEGW (External Encryption Gateway)
VAA (Visual Automated Attendant – installation and update)
The OTFC server on Linux server has been replaced by the OTFC on Windows server.
The OTFC versions greater or equal to 9.x are compatible with Windows operating system
Remarks:
- The partition switching is not performed by the S.O.T at the end of the update.
- Only 10 PCS can be updated simultaneously
- The OXE software media used for the update must include a full version, not only a patch.
- The network speed required for the PCS update must be at least 2MB/s
The SOT update consists in offering the possibility to install patches on the solution S.O.T. This
functionality will only be offered for S.O.T solutions in the same major version. The update will be
forbidden for version not in the same major version. See explanations below.
The media will be available in the Business Portal at the same location than for the S.O.T solution. It
will be available under a zip format containing the core elements of the solution.
Once the S.O.T. is updated, its version number will evolve and will contain an extension different to
“000” for the last 3 digits to indicate that it’s an updated version (e.g. 3.0.004.008).
A major version is named A.B (e.g. 3.0.004.000): update process will not be possible in this case (like
changing from 3.0 to 3.1)
When the zip file and the ISO file are delivered together, the ISO file version is upper than the zip file
version. In this case, those two deliveries have the same level of functionalities.
Only the O.S. can be different (O.S. updated, correction on the O.S …)
The zip file can be delivered alone to correct an issue. At this moment, the zip file will be delivered with
the ISO file on which it must be installed.
Upgrade rules
updates fro A.B.xxx.000 towards A.C.xxx.000 or A.B.xxx.000 towards D.B.xxx.000 are not allowed.
On the other hand, updates from A.B.xxx.yyy towards A.B.xxx.zzz or A.B.xxx.yyy towards
A.B.zzz.yyy are possible.
The presence of an ISO delivery means important changes (major features, OS update …) that are
only possible through a complete S.O.T. reinstallation.
How to update?
Use the dedicated menu. Select the zip file through the browser & proceed to the upgrade …
Select the zip file (local or NFS) & proceed to the upgrade
Warning:
Since version 3.1, S.O.T is implemented on a Debian 10 and the VMware compatibility starts with the version
6.5.
17.1 Products
OTFC: OpenTouch Fax Center Windows
OT: OpenTouch version 18.x management
Account
Projects listing Media listing
settings
Backup -
Restore
Update
Reports
Show/Hide
advanced menu
Restart SOT
new
Shutdown SOT
new
Now the S.O.T. is operational. The user can access to the S.O.T.’s web interface by connecting through the IP
address in https, for example, https://192.168.56.15.
If the network connection is on the low level, the update will be forbidden.
To determine the network speed and the network connection level, we will use the ping command.
Two information provided by the ping command will be used to determine if the update can be launched: the
packets loss and the Round-Trip Time average.
If the percentage of the packets loss is upper than 10% the update will be forbidden.
Also, if the RTT average is upper than 60ms, the update will be forbidden as well.
The network connection test will be done during the checking of the update process.
The warning will be a popup with the following texts depending of the context:
- the network connection is low. The SOT can’t perform an update securely
- the percentage of packets loss is too high to guarantee an update securely.
For each modification, user must click on the save button at the bottom of the page.
The cancel will return the user to the homepage without saving any network parameters modification
To simplify the S.O.T management, two entries have been added in the settings: the restart and the shutdown
of the S.O.T.
Be careful, if use of dynamic IP address for the first interface, the web URL of the S.O.T could be different
after a restart or a shutdown of the S.O.T.
18.1 Deployment
- No simultaneous deployment: only one deployment can be performed at a time.
- Installing a GAS through an Ethernet interface other than eth0 does not work. Use of ETH0 ONLY is
mandatory.
o If the installation of GAS is not performed by SOT but done through the manual installation of
bootDVD + manual installation of the iso file of software server, the problem remains the
same.
- Deployment of OTFC in 9.1 and above NEED SOT version 3.1.009.005 – otherwise a driver is not
installed
18.2 Media
- The ISO files declared in the S.O.T. must have the format: ISO9660 + Joliet.
18.6 OXE
- We can’t perform an installation with an ISO containing a secured patch. The dynamic patch won’t be
installed (restriction OXE server).
Workaround: Perform the installation with the ISO file without the secured patch. Then, update the
installation with the secured patch.
- The installation of an OXE version lower or equal to L2 through OVF generation is not supported
(CRSOT-151).
- The memory reservation is set by default on OXE. This can generate a lack of available memory on
ESXi server or VirtualBox. In this case, the SOT will encounter some issues.
- Hyper-V: SOT cannot be installed n Hyper-V
- Hyper-V: create the vm, boot it & get its MAC address. Then set it as fixed in the SOT project for full
installation
- Hyper-V: after a full installation the cpu will reboot & start another installation again. So make sure to
power off the vm once it is completely installed.
- Hyper-V: there is no restriction of installation if a patch is to be deployed!
- Hyper-V: ethernet boards needs to be changed
- Hyper-V: not possible to have an OVF deployment
To upgrade SOT from the previous version 3.0.004.000 to 3.0.004.103 follow the scenario below in
screenshots.
Note: only upgrade from 3.0.004 is available
21.21 Other
CR number TS reference Title
SOT: OTMS R2.6 swap partition size too small when using SOT
template factory
➔ a correction has been done on the boot DVD. The following
versions and upper embed the fix: Boot DVD 12.3.035.000
CRSOT-406 554913 and boot DVD 12.5.008.000
For the CPU, you can modify it according to the final
configuration. To know which value to use, you can use the
capacity planning tool on myPortal with the reference
"TBE081 - OpenTouch capacity planning tool v2.5"
- END OF DOCUMENT -