Software Orchestration Tool Manual

Release 1.0 - April 2018

8AL90559USAA Ed. 01
Legal notice
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.
© 2018 ALE International. All rights reserved. http://www.al-enterprise.com

Disclaimer
While efforts were made to verify the completeness and accuracy of the information contained in this
documentation, this document is provided “as is”. To get more accurate content concerning Cross
Compatibilities, Product Limits, Software Policy and Feature Lists, please refer to the accurate
documents published on the Business Partner Web Site.
In the interest of continued product development, ALE International reserves the right to make
improvements to this documentation and the products it describes at any time, without notice or
obligation.

The CE mark indicates that this product conforms to the following Council Directives:
• 2014/53/EU for radio equipment
• 2014/35/EU and 2014/30/EU for non radio equipment (including wired Telecom Terminal
Equipment)
• 2014/34/EU for ATEX equipment
• 2011/65/EU (RoHS)
 Table of
contents Software Orchestration Tool
Manual

Chapter 1
Overview

1.1 Architecture.......................................................................................................................................5
1.2 Types of deployment................................................................................................................ 5
1.2.1 Live installation.......................................................................................................................................5
1.2.2 OVF deployment....................................................................................................................................5

Chapter 2
Installation and first start

Chapter 3
Easy mode

3.1 Introduction.......................................................................................................................................7
3.2 Deploying a project with the wizard.......................................................................... 8

Chapter 4
Expert mode

4.1 Managing S.O.T. network settings............................................................................ 11

4.2 Configuring the DHCP server........................................................................................ 11
4.3 Declaring NFS servers.......................................................................................................... 11
4.4 Declaring media.......................................................................................................................... 11
4.5 Managing product deployment projects.............................................................12

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 3/14

 Table of
contents Software Orchestration Tool
Manual

4.5.1 Updating a project...............................................................................................................................12

4.6 Deploying phone sets (SIP firmware).................................................................... 13
4.7 Backup/restore.............................................................................................................................14
4.7.1 Backup......................................................................................................................................................14
4.7.2 Restore.....................................................................................................................................................14
4.8 Upgrading S.O.T......................................................................................................................... 14

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 4/14

 Chapter

1 Introduction

This document is the user manual for the Software Orchestration Tool (S.O.T.).
The S.O.T. tool is an application using a web based management, allowing to:
• Guide and assist the installer through data collection
• Automatically deploy software suites and licences on ALE International products
• Monitor the deployment process
Note:
Always check the Business Portal for latest releases and release notes.

1.1 Architecture
The S.O.T. tool can be used in two modes:
• A standalone mode, where the S.O.T. is installed on the BP’s own Windows PC.
Compatible software for the standalone mode are:
• VirtualBox
• VMware workstation player
• A hosted mode, where the S.O.T. is installed in the data center used by the BP to provide multi-
company deployments.
The compatible software for a hosted mode is VMware vSphere.
In both modes, the S.O.T. core application is rendered through a Virtual Machine containing all
necessary layers, services and application to deploy ALE International products.

1.2 Types of deployment

ALE InternationalALE products can be deployed with a live installation or with OVFs.

1.2.1 Live installation

Products are installed in an automated and non-interactive way starting from the legacy packaged
artifacts (ISO files).
Live installation can be performed on different supports:
• Bare Metal not virtualized: standalone mode
• Bare Metal virtualized (ESXi): standalone or hosted mode
• Private data centers (VMware): hosted mode

1.2.2 OVF deployment

OVF deployment is used in virtualized environments (VM target). At the end of data collection, a
template OVF file is provided according to the sizing desired. Once this OVF file is deployed, the
hypervisor retrieves the vmdk file from the S.O.T.
When deploying OVF files, the S.O.T. must be accessible. If it is not the case, export the S.O.T. virtual
machine and redeploy it on the new environment (targeted product(s) environment).

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 5/14

 Chapter

2 Installing and starting the S.O.T.

Minimum disk size for S.O.T.: 20 Go

The S.O.T. can be deployed on one of the following virtualization software:
• Standalone mode: Windows PC as of Windows 7 with:
VirtualBox (validated since 5.2.4)
For minimum characteristics of the PC, refer to:https://www.virtualbox.org/manual/

VMware workstation player (validated since 12)

For minimum characteristics of the PC, refer to:https://www.vmware.com/prod-
ucts/workstation-player.html
• Hosted mode:

VMware vSphere (validated since 6.0)

To install and start the S.O.T.:

1. Deploy the S.O.T. virtual machine using the ovf file provided by ALE International
The S.O.T. virtual machine is created with a RAM of 1.5 Go, and disk size of 20 Go, of which 16 Go
are available for media local storage (product sofware, hotfix, license)
2. Optionally, if more space for local storage is needed, increase the disk size of the virtual machine
This must be done before the first initialization of the S.O.T.
3. Start the S.O.T. virtual machine
4. When prompted, press a key and enter the IP address of the S.O.T. virtual machine

5. Enter the network mask

6. Enter the gateway IP address
7. Check network settings and press Y to confirm

The S.O.T. is now operational and accessible via the URL: https://[S.O.T. IP address]
If you need to modify IP settings later, perform any of the following operations:
• Enter the setIP command in the VM console
• Modify IP settings via the web interface: see Managing S.O.T. network settings on page 11

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 6/14

 Chapter

3 Easy mode

3.1 Introduction
When connecting to the S.O.T. web interface, two buttons (Easy and Expert) are available.

The Easy button starts the wizard, allowing you to go through the deployment of a project from the
beginning to the end. A project consists in deploying one or several products located in the same LAN.
The products can be:
• OmniPCX Enterprise (standalone or duplicated, or PCS)
• OpenTouch Multimedia Services/OpenTouch Message Center (standalone or duplicated)
• OpenTouch Fax Center
• OXE Media Services
• OST64
• OmniVista 8770

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 7/14

Chapter 3 Easy mode

3.2 Deploying a project with the wizard

Before you begin, ensure that the binaries and licenses to install are available:
• Either on an NFS server accessible from the S.O.T.
• Or locally for upload to the S.O.T local storage using FTP
For an OmniPCX Enterprise, the software can be an iso file containing the software version and
patches in the dhs3mgr directory. The dhs3mgr can also be uploaded to the S.O.T as it is.
To create and deploy a project with the wizard:
1. Open the URL https://[S.O.T. IP address]
For example: https://192.168.201.125
Chrome and Firefox browsers are recommended. Other browsers are not supported and display an
error message when connecting to the S.O.T. URL.
2. Click the Easy button
3. Select the product(s) you wish to install and click Next
The Media page opens.
4. At this stage, ensure that binary and license files are available to the S.O.T. Binary files are
mandatory whereas license files are optional and can be installed later.
• If the binary files are available on an NFS server, and you have already declared the NFS path
for another project, select it in the drop-down list
• If the binary files are available on an NFS server, and you have not already declared the NFS
path, declare the NFS server: [NFS URL]:/[NFS folder(s)]
• If you have no NFS server, select S.O.T. Local storage and use an FTP client to upload
medias to the S.O.T. local storage. Use the S.O.T. IP address and the following credentials: login
= upload, password = sot

5. Click Refresh medias list

6. For each product of the project, select the appropriate software and license
7. When the necessary information has been provided, click Next
The Project configuration page displays, allowing to configure parameters applying to all
products of the project
8. Enter a Project name
9. Review/modify other parameters as needed
10.If deployment is on virtual machines, select OVF Generation
11.Click Next
12.Enter parameters for each product (enter the MAC address for an installation on a physical
machine, select the size for a deployment on virtual machine) and click Next
Use the Ctrl key to select two files (for example to select two license files in a duplicated
configuration)
13.Check parameters in the Summary page and click Deploy
You can also click Save to create the project, and deploy it later from the project listing,
using the button.
14.According to the type of deployment, perform one of the following

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 8/14

Chapter 3 Easy mode

• Deployment on physical machine: start PXE boot on the machines on which the products must
be installed (for example on OmniPCX Enterprise, enter the command grubboot ETHER as
root user)
• Deployment on virtual machines: copy the URL of the OVF, replace https by http (to prevent
transfer failure due to lack of certificate), and use the resulting URL to install VMs
You can monitor the progress of deployment of products on the S.O.T. web page. At the end of
deployment, the project switches automatically to Unloaded. If for some reason, the project does
not switch automatically to Unloaded, or if you wish to stop the deployment before the end, you
can click the unload button at any time.

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 9/14

 Chapter

4 Expert mode

Access the expert view from the S.O.T. web interface, via the Expert button.
The expert view allows to:
• Manage S.O.T. network settings
• Configure the DHCP server (necessary to deploy phone sets in dynamic mode)
• Manage external storage (NFS) settings
• Manage medias (software, licences, hotfix)
• Manage product deployment projects: create (as you would do with the wizard), edit, duplicate,
start/stop deployment, update
• Manage phone deployment projects: create, edit, duplicate, start/stop deployment
• Back up/restore

Figure 4.1: S.O.T. Expert view

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 10/14

Chapter 4 Expert mode

4.1 Managing S.O.T. network settings

The S.O.T. network settings include:
• Settings such as keyboard type, country, time zone, which will be used as default values for product
configuration
• S.O.T. network configuration, allowing to update parameters configured at first start
To configure S.O.T. network settings:
1. In the expert view, select Settings > Network settings
2. Review/modify settings as needed.
3. Click Save
If the S.O.T. IP address has been modified, the connection is lost, and must be reestablished on the
new address.

4.2 Configuring the DHCP server

The S.O.T. internal DHCP is used for phone deployment when they initialize in dynamic mode.

To activate and configure the S.O.T. internal DHCP:

1. From the expert view, select Settings > Network settings
2. Select the box: Server DHCP activated
3. Define the pool of IP addresses for IP sets
4. Click Save and OK to validate modifications
The S.O.T. internal DHCP is now configured and is enabled each time you deploy phone sets.

4.3 Declaring NFS servers

The NFS Settings page allows to manage NFS server(s) on which medias are made available for
the S.O.T.

To declare an NFS server:

1. In the Expert view, select Settings > External storage settings
2. Enter the NFS Server path in the form [NFS Server]:/[NFS folder(s)]/ and click the
Create button
The new NFS server is displayed in the list below. You can delete any NFS server in the list using
the trashcan icon.
After declaring an NFS server, you have to declare medias which are available on this server: see
Declaring media on page 11.

4.4 Declaring media

Media are binary files, hotfixes or license files that will be deployed on products or phones by the
S.O.T.
A media can be:

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 11/14

Chapter 4 Expert mode

• An iso file
• A license file
• A zip file (containing OmniPCX Enterprise patch, phone firmware or license(s) for example)
• An OpenTouch core hotfix directory
Before you start, ensure that media are available:
• Either on an NFS server accessible from the S.O.T.
• Or locally for upload to the S.O.T. local storage using FTP
When using an external NFS, the server must be declared on the S.O.T., as well as each media you
want to be available for deployment via the S.O.T.
If not using an external NFS, upload media to the S.O.T. local storage, and then declare each media
you want to be available for deployment via the S.O.T.
To declare a media:
1. In the expert view, select Medias > Declare media(s)
2. Perform one of the following:
• If the binary files are available on an NFS server, and you have already declared the NFS path,
select NFS share, and then select it in the drop-down list
• If the binary files are available on an NFS server, and you have not already declared the NFS
path, select NFS share, and then declare the NFS server, using the format: [NFS URL]:/
[NFS folder(s)]
• To declare one file available on an NFS server, you can also select media path located on
NFS, and enter manually the full NFS path, using the format [NFS URL]:/[NFS folder(s)]/
[file name]
• If you have no NFS server, select S.O.T. Local storage and use an FTP client to upload
medias to the S.O.T. local storage. Use the S.O.T. IP address and the following credentials: login
= upload, password = sot

3. Click Refresh medias list

4. Select the media(s)
Media are now available for product or phone deployment projects. You can display the complete list of
medias using the Medias list menu, and, delete unnecessary ones using the icon.

4.5 Managing product deployment projects

In the expert view, two menus allow to manage product deployment projects:
• The Create project menu opens the project creation wizard: see Deploying a project with the
wizard on page 8.
• The Projects listing allows to edit, duplicate, update, deploy/undeploy or suppress existing
projects

4.5.1 Updating a project

Update is available for the following products:
• OmniPCX Enterprise
• OpenTouch Multimedia Services
• OpenTouch Message Center

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 12/14

Chapter 4 Expert mode

To update a project:
1. In the expert view, select Projects > Project listings

2. Click the button for the project to update

The Project - Update page opens.
3. For an OmniPCX Enterprise:
a) Select the software version to install in the drop-down list
b) Optionally, select the box Update on inactive partition. You can then choose to Use a
clean active partition and switch partition after update installation
c) Optionally, select a license file
d) Enter the mtcl and swinst passwords
4. For an OpenTouch (OpenTouch Multimedia Services or OpenTouch Message Center):
a) Select the OT software in the drop-down list
b) Optionally, select a Bootdvd iso file, OT Hotfix and OT licence file(s)
c) Enter the OT user login and OT user password
d) Optionally, select the box Update on inactive partition.
5. Click Update
6. When the OpenTouch has been successfully updated, unload the project manually
If updating an OmniPCX Enterprise only, the project is unloaded automatically.

4.6 Deploying phone sets (SIP firmware)

The following section describes the deployment of phone sets.
Before you begin, ensure that:
• Phone firmware is available and has been declared on the S.O.T.: see Declaring media on page 11
• If phone sets initialize in dynamic mode, the DHCP is enabled and configured: see Configuring the
DHCP server on page 11
• If phone sets initialize in static mode, the DM IP address is configured with the S.O.T. IP address
Note:
Only the deployment of ALE International phone sets in SIP mode is supported.

To deploy phone sets:

1. In the expert view, select Phones deployment > Create phones project
You can also create a new project by duplicating an existing project in the Phones project
listing.
2. Select the type of phone sets you want to deploy
3. Select the firmware in the drop-down list
When only one firmware is available, it is automatically selected.
4. Enter a project name
5. Enter the IP address or FQDN of the SIP server (this can be for example an OpenTouch or
OmniPCX Enterprise IP address)
6. Optionally, select the box Declare MAC address, and enter the MAC addresses of phone sets to
deploy. This ensures that S.O.T. will deploy only the declared sets.
7. Click Deploy
You can also click Save to create the project, and deploy it later from the Phone project
listing, using the button.

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 13/14

Chapter 4 Expert mode

8. Start the phone sets to deploy

9. When all sets have initialized and updated correctly, go to the Phone project listing and
undeploy the project using the button

4.7 Backup/restore
The S.O.T. database can be backed up and restored. The backup can be light (including only
configuration data) or full (including also media stored locally on the S.O.T. virtual machine).

4.7.1 Backup
Ensure that the directory on the NFS server where the backup file will be saved has writing permission
for everybody.

To back up the S.O.T. database:

1. In the Expert view, select Settings > Backup - Restore
2. Select one of the following:
• Light to back up configuration data only (network settings, project settings, list of NFS, list of
media) and not media located on the S.O.T. local storage
• Full to back up configuration data and media located on the S.O.T. local storage
3. If Light is selected, you can leave the Backup path empty and click the Generate button (this
option is not allowed for a Full backup).
After launching the backup, you can download the backup file directly from the S.O.T. web page
4. In both case, you can enter a Backup path on an NFS server, in the form: [NFS Server]/[NFS
Folder(s)]/[File_name].tgz and click the Generate button
After confirming the backup launch, the backup is available on the NFS server.

4.7.2 Restore

To restore the S.O.T. database:

1. In the Expert mode, select Settings > Backup - Restore
2. To restore a light backup file available locally, select Light and browse to the file to back up
3. If your backup file is available on an NFS server, select through NFS server and enter the file
path in the format: [NFS Server]/[NFS Folder(s)]/[File_name].tgz
4. Click Restore and confirm
The S.O.T. restores the database and restarts.

4.8 Upgrading S.O.T.

To upgrade the S.O.T.:

1. Back up the database of the current version: see Backup on page 14
2. Stop and suppress the virtual machine of the current version
3. Create a new virtual machine with the new version
4. Restore the database on the new version: see Restore on page 14

8AL90559USAA - Ed. 01 - April 2018 - Software Orchestration Tool Manual 14/14