Skip to end of metadata
Go to start of metadata

On this page:

This page provides a condensed version of the SBC SWe software installation process. For complete software installation details, please go to the appropriate page listed below:

Installing VMware ESXi

Before creating a Virtual Machine and installing SBC SWe images, install VMware ESXi on the host or hosts allocated for SWe. Please refer to VMware documentation for installing and configuring VMware ESXi.

VMware ESXi version 5.0 or above is recommended.

References:

The SBC SWe software only runs on platforms using Intel processors. Platforms using AMD processors are NOT supported.

Downloading SBC SWe From SalesForce

The SBC SWe application is available as a software package downloadable from the SalesForce customer portal.

  1. Login to Salesforce customer portal using your Sonus provided login, and click SOFTWARE DOWNLOADS.
  2. Click software bundle "SBCSWe_4.1" to view its contents, and then click Request Download.
  3. Fill in the Software Download Form, accept the license agreement and click Submit.
  4. When the "Request Status" on the SOFTWARE REQUESTS page displays "Download Available", click the links in the "SBCSWe_4.1" software bundle to download the files.

Detailed instructions on downloading the SBC SWe software are located at: Downloading SBC SWe Software Package From SalesForce.

After downloading the software, verify the SBC SWe file using the steps listed here: Verifying the Downloaded SBC SWe Package using Checksum.

Creating and Configuring Virtual Machines for SBC SWe

SBC SWe is deployed either as a standalone or redundant High Availability (HA) configuration. In the HA configuration, a standby virtual machine (VM) protects the active VM.

Prior to installing SBC SWe on a Virtual Machine (VM), you must accomplish the following activities:

  1. Create a VM and allocate its resources (e.g. CPU, memory, NICs, etc.). For HA configuration, a VM must be created for each SWe instance (active, standby).
  2. Configure a datastore to contain the SBC SWe Operating System (OS) and Application software.

For each VM, four network interfaces are required.

  • A management interface
  • Two interfaces for media and SIP signaling
  • An HA interface for HA communication.

Sonus recommends assigning each interface to a separate subnet.

The HA interface is required for a standalone SBC SWe, but is not actually used by this configuration.

Before a VM is created, VMWare Networking must be configured using one of two methods:

The network Interfaces used for HA interfaces can be interconnected using a cross-over cable, or connected through a switch.

After VMWare networking is configured, perform the steps listed in Creating a New SBC SWe VM Instance with VMXNET3 or Creating a New SBC SWe VM Instance with Direct I/O Passthru to create and configure VMs for SBC SWe.

Once the VMs are created and configured, follow the steps in Uploading SBC SWe Software to Datastore to upload the SBC SWe software to the VMs.

Installing SBC SWe

Before installing the SWe SBC OS and Application, ensure the ports used by the SBC SWe are not blocked in your network. See SBC SWe Network Listener Ports.

SBC SWe may be deployed in either a standalone or redundant High Availability (HA) configuration as described in this section.

Installing SBC SWe in Standalone Configuration

The SBC SWe standalone deployment consists of a single SBC SWe Virtual Machine. Gather the following information before starting the installation process:

Input Parameter

Description

Example/Recommendation

SBC SWe management IP address

IP address used to access SBC

10.11.13.10

SBC SWe management IP address prefix

Netmask of the network in which the management IP is configured

255.255.255.0

SBC SWe management IP address default router

The switch or router that the management interface is connected to

10.11.13.1

System Name

A unique name of the overall SBC system, limited to alphanumeric characters: A-Z (uppercase), 0-9. The first character must be an uppercase letter (A-Z)

System Name is used for billing, external PSX queries (if applicable), and system logs

WFDSBC01

  • The first three letters represent the physical location of the system, e.g. Westford = WFD
  • The second three letters identify the system type (SBC)
  • The last two digits identify the SBC instance

Local Hostname

The hostname of the local SBC SWe host in the network

Typical naming convention is "<system name>a"

WFDSBC01a

Peer Hostname

The hostname name of the peer SBC SWe host in the network

Typical naming convention is "<system name>b"

For standalone configuration, Peer Hostname is "none".

If you plan to upgrade to an HA configuration in the future, you can save a step by configuring the Peer Hostname now (e.g. WFDSBC01b). Then at a later date, you can simply install the standby peer and connect the HA cable.

Server Role

The role of the SBC SWe (Active or Standby)

In a standalone configuration, the server role is 'Active'.

Active CE IP

IP address assigned to the HA interface of the configured Active SBC, used in an HA configuration for e.g. synchronization

Not used for standalone configuration, use default value (169.254.99.1).

Standby CE IP

IP address assigned to the HA interface of the configured Standby SBC, used in an HA configuration for e.g. synchronization

Not used for standalone configuration, use default value (169.254.88.1).

HA Interface Mask (Inter CE Prefix)

Netmask of the network in which the Active/Standby IPs are configured

Not used for standalone configuration, use default value (255.255.0.0).

TIPC NETID

The SBC SWe uses the unique Transparent Inter-process Communication (TIPC) protocol ID to communicate between active and standby VMs. Use the same TIPC network ID (between 1000 and 9999) for both active and standby systems.

Not used for standalone configuration, use 1500 (default).

Default value can also be used If you plan to upgrade to an HA configuration in the future.

NTP Server IP

The IP address (supports both v4 and v6) of the NTP server. A NTP source is necessary for correct system operation.

E.g. 10.35.66.34

NTP Server Time Zone

The time zone of the NTP server location

E.g. (GMT – 5:00) Eastern-US

The SBC SWe is packaged in an .iso file which contains both the OS and the SBC Application. The OS is first installed, and then the SBC Application.

To install the OS, follow the steps in Installing SBC SWe Operating System . During this procedure, the SBC SWe management IP address is needed.

To install the SBC Application, follow the steps in Installing SBC SWe Application Software Using Platform Manager.

Installing SBC SWe in HA Configuration

The SBC SWe can also be deployed in a redundant High Availability (HA) configuration with one standby SBC SWe Virtual Machine protecting the active SBC SWe Virtual Machine. The HA configuration shares the data between the systems and protects each other in a 1-1 redundancy model.

Gather the following information before starting the installation process:

Input Parameter

Description

Example/Recommendation

Active SBC SWe management IP address.

IP address used to access Active SBC.

10.11.13.10

Active SBC SWe management IP address prefix

Netmask of the network in which the Active management IP is configured.

255.255.255.0

Active SBC SWe management IP address default router

The switch or router that the Active management interface is connected to.

10.11.13.1

Standby SBC SWe management IP address.

IP address used to access Standby SBC.

10.11.13.11

Standby SBC SWe management IP address prefix

Netmask of the network in which the Standby management IP is configured.

255.255.255.0

Standby SBC SWe management IP address default router

The switch or router that the Standby management interface is connected to.

10.11.13.1

System Name

System Name is used for billing, external PSX queries (if applicable), and system logs and must be a unique name throughout the SBC system.

SBC naming is limited to alphanumeric characters: A-Z (uppercase), 0-9. The first character must be an uppercase letter (A-Z).

WFDSBC01

  • The first three letters represent the physical location of the system, e.g. Westford = WFD.
  • The second three letters identify the system type (SBC).
  • The last two digits identify the SBC instance.

Local Hostname

The hostname of the local SBC SWe host in the network.

Typical naming convention is "<system name>a".

WFDSBC01a

Peer Hostname

The hostname name of the peer SBC SWe host in the network.

Typical naming convention is "<system name>b".

WFDSBC01b

Server Role

The role of the SBC SWe (Active or Standby).

'Active' or 'Standby'.

Active Primary CE IP

IP address assigned to the HA interface of the configured Active SBC, used in an HA configuration for e.g. synchronization.

169.254.99.1

Active and Standby CE IP addresses must be in the same subnet.

Standby Primary CE IP

IP address assigned to the HA interface of the configured Standby SBC, used in an HA configuration for e.g. synchronization.

169.254.88.1

Active and Standby CE IP addresses must be in the same subnet.

Inter CE Prefix

Netmask of the network in which the Active/Standby IPs are configured.

255.255.0.0

TIPC NETID

The SBC SWe uses the unique Transparent Inter-process Communication (TIPC) protocol ID to communicate between active and standby VMs. Use the same TIPC network ID for both active and standby systems.

1500

NTP Server IP

The IP address (supports both v4 and v6) of the NTP server. A NTP source is necessary for correct system operation.

E.g. 10.35.66.34

NTP Server Time Zone

The time zone of the NTP server location.

E.g. (GMT – 5:00) Eastern-US

The SBC SWe is packaged in an .iso file which contains both the OS and the SBC Application. The OS is installed first, and then the SBC Application.

The OS and SBC Application must be installed on both active and standby SBC SWe in the following order:

  1. Install OS and SBC Application on the Active
  2. Install OS and SBC Application on the Standby.

To install the Operating System, follow the steps in Installing SBC SWe Operating System . The SBC SWe management IP address is needed for this step.

To install the SBC Application, follow the steps in Installing SBC SWe Application Software Using Platform Manager.

Accessing and Configuring SBC SWe

The two methods for accessing and configuring SBC SWe are listed below, and are valid for both standalone and HA configurations:

Command Line Interface (CLI)

To access and configure SBC SWe using the CLI, perform the following steps (see CLI Basics for guidance):

  1. SSH as admin to the standalone unit, active unit or logical management IP address.
    Example:
    ssh admin@server1
  2. Enter the password. The default password is "admin".
  3. At the CLI prompt, configure the access mode.
    Example:
    admin@server1> configure <access_mode>
    where <access_mode> specifies the type of configuration access for the session.

    Possible values are:
    exclusive - Only one exclusive session is possible at a time.
    private - Multiple private sessions can occur simultaneously.

Embedded Management Application (EMA)

To access and configure SBC SWe using EMA (configures most of SBC SWe platform), accomplish following steps:

  1. Launch your web browser and enter the SBC SWe standalone unit , active unit or logical management IP address in the address bar.
    The Login window appears.
  2. Enter Username and Password. The default Username and password are "admin" / "admin".
  3. Click Log On.

Obtaining and Installing License File

SBC SWe licensing requires customers to use SBC features through software license keys purchased from Sonus. Once purchased, customers install and manage SBC licenses using the Embedded Management Application (EMA) License Management application.

Obtaining License File from Sonus

License files contain up to two SBC SWe VM UUIDs depending upon your SBC SWe redundancy configuration. The stand-alone SBC SWe VM UUID must be contained in the license file to be valid. Likewise, for a SBC SWe HA pair the UUIDs of both virtual machines must be contained in the license file to be valid. Accomplish the steps below to obtain the license file.

  1. Identify UUID(s). The UUID (serial number) is located n the "Install Info" section located at the lower right corner of the GUI. UUIDs are also viewable by navigating to the Troubleshooting > System Status screen.

    For a standalone system, record the VM UUID of the stand-alone VM:

    For an HA system, record the VM UUIDs of the Active and Standby VMs:


  2. Send the following details via e-mail to order@sonusnet.com.
    1. VMWare UUID of each node
    2. Your Account Name and Sales Order number
    3. Name and e-mail address of the person to receive the license file

  3. The license file is generated by Sonus and e-mailed to the designated person in step 2.c.

Installing License File

  1. After the license file has been provided by Sonus, login to EMA and navigate to Maintenance > Licenses.


  2. Open the license file using Notepad (no HTML formatting). Scroll down to "Install License Bundle", give the license a name and copy the contents of the license file into the string filed, and click Save (floppy disk icon).

SecureLink is a third-party remote access management tool used extensively by Sonus Support team to allow dedicated remote connectivity into Sonus equipment while providing customers with the latest in security and audit capabilities. SecureLink can be installed on a separate Virtual Machine running Windows or Linux.

To install SecureLink follow the steps in Installing SecureLink on Virtual Machine.

Reference Documents

VMware Documentation:

Sonus Documentation: