Skip to end of metadata
Go to start of metadata

 

 Running the SBC SWe Lite initial setup sequence is required for all deployment environments (KVM, VMware ESXi, Microsoft Hyper-V hypervisors and Microsoft Azure).

Note

This procedure runs the initial setup on the SBC SWe Lite. The Cloud-init function provides an alternative method to running Initial Setup on the SBC SWe Lite. For details on using Cloud-init, refer to Using Cloud-init to run the Initial Setup on SBC SWe Lite

You do not need to perform this procedure if you use the cloud-init function.

Prerequisities

The SBC SWe Lite must be installed before running initial setup. Refer to Installing SBC SWe Lite and click on the applicable platform:

Preparation

  1. If a valid IP address was generated at the end of the installation procedure:

    • Proceed to Mapping Network Interfaces to review and reconfigure network interfaces.

      Ribbon recommends that all customers review and, if necessary, optimize their Network Interface configurations before proceeding. Refer to Mapping Network Interfaces.

      Mapping Network Interfaces is required for the following configurations:

      • If a valid IP address was not generated at the end of the installation procedure.

      • If the management port is not connected to a server with DHCP enabled.

      • If the management port is connected to a server with DHCP enabled and a valid IP address was not generated.

      This step does not apply to Azure deployments.
    • Optional: Bypass the mapping process and proceed to step 2 to launch the browser. This option should be used only if your network setup has been recently reviewed, and does not meet the configurations listed above.

  2. Launch a browser.

  3. Enter the IP address (generated by SBC SWe Lite at the end of the installation procedure into your browser address bar (https://<IP address>) and press Enter to launch the SBC SWe Lite which automatically opens Initial Ribbon SBC System Setup. Note the following regarding the IP address:

    1. For an SBC SWe Lite deployment in Azure, the management IP address is the one the Azure public cloud assigned and provided in the Azure portal (refer to Deploying an SBC SWe Lite via Azure Marketplace, step 8). The management IP address is not the one that appeared in the Serial Console.
    2. For an on-premises deployment (Microsoft Hyper-V, VMware ESXi, or KVM VMM), the management IP address is displayed in the console after SBC SWe Lite starts.

  4. Configure the System Information, IP address, Local Users and Connectivity Information panes using the appropriate values for your location.

    All fields are defined below for Initial Ribbon SBC SWe Lite Setup

    For KVM Hypervisor, VMware ESXi, Microsoft Hyper-V. If a field is pre-populated, the current value is Ribbon's recommendation. Any other recommended values are indicated.

    For Azure. Where applicable, a note indicates whether a field requires any mandatory or recommended values.


Figure : Initial Ribbon SBC Setup - KVM Hypervisor, VMware ESXi, Microsoft Hyper-V



Figure : Initial Ribbon SBC Setup - Microsoft Azure

Field Definitions

System Information Pane

Network Configuration

Sets how the SBC acquires the IP address information. Valid entries: Static or Dynamic. Default entry: Static. Static enables you to enter an IP address manually. Dynamic acquires the interface's IP configuration dynamically from a reachable DHCP server. For Azure, Static is the recommended value.

Host Name

Enter the Host Name for the SBC. This is useful joining an SBC to a domain. This field is required. Refer to Hostname Conventions for hostname rules. For Azure, verify this field is valid and enter the applicable host name.

Internet Domain 

Useful if the SBC system resides on a network that uses an internet domain name (such as ribboncommunications.com). This field is displayed only when Static is selected from the Network Configuration field. For Azure, this field is required.

Time Zone

Use this field to set the local time zone of the SBC. For Azure, this field is required.

Remote Log Configuration

Configure Syslog 

The default value for this field is No, and none of the following fields are visible. If the value is set to Yes, the following fields are visible: For Azure, verify if this field is applicable to your network configuration and set the fields appropriately.

Global Log Level

Use this list box to select the desired logging level. Valid options: TraceDebugInformationalWarningError or Fatal.

Log Destination

The IP address of the destination log server or its FQDN. This field is required.

Port

The logging port on the destination log server. This field is required.

Protocol

Use this list box to select the transport protocol for the logging information. Valid selections: UDP or TCP.

Log Facility

Select a logging facility code to insert in the transmitted log such that the entries can be filtered. For more information see RFC 5424.

Use NTP

Specifies whether the NTP will be used as a time source. Valid entries: Yes (NTP is used as the time source) or No (NTP is not used as the time source). Default entry: Yes.

NTP Server
Specifies the host name or IP address of the NTP server. If the hostname is supplied, the SBC Edge uses DNS to connect to the NTP server. For Azure, the pre-populated field is the recommended value.

NTP Server Authentication

Specifies whether authentication is used for communicating with the NTP server. Valid entries: Enabled (Authentication is used with NTP Server) or Disabled (Authentication is not used with NTP Server). For Azure, verify if this field is applicable to your network configuration and set the field appropriately.

NTP Server - MD5 Key ID

Specifies the MD5 Key ID to be used in authenticating the first NTP server. This field is visible only when the NTP Server Authentication field is set to Enabled.

NTP MD5 Key

Specifies the MD5 key used when authenticating the first NTP Server.

Easy Setup

Determines whether Easy Configuration is launched upon completion of initial configuration. Valid entries: Launch on First Login (Easy Configuration is launched upon login) or Do not Launch (Easy Configuration is not launched upon login). Default entry: Launch on First Login.

For Azure, the default field of Launch on First Login is the recommended value.

If the 30 day embedded trial license has expired and the SBC SWe Lite instance does not have a production license, the Easy Setup option is not available. For Easy Configuration license guidelines, refer to: Easy Configuration - Notes.

IP Address Pane

IPv4 Address (Admin IP)

Note: This field is not applicable to Azure.

Enter the IP address through which the SBC communicates over Ethernet. The IP address in this field will be configured onto the Admin Port. This field is required.

This field is displayed when the Network Configuration field is set to Static.

Netmask (Admin IP)

Note: This field is not applicable to Azure.

The Netmask which will be applied to the Admin IP IPv4 address.  This field is required.

This field is displayed when the Network Configuration field is set to Static.

Configure IP (Ethernet 1)

Enables or disables the use of an IP address with Ethernet 1.

If you select Yes:

For KVM Hypervisor, VMware ESXi, Microsoft Hyper-V: the IPv4 Address, Netmask, and Media Next Hop fields are visible. These fields are required if set to Yes.

For Azure, the default value is recommended.


IPv4 Address (Ethernet 1)

Note: This field is not applicable to Azure.

Enter the IP address through which the SBC communicates over Ethernet. The IP address in this field will be configured onto Ethernet 1. This field is required if set to Yes.

Netmask (Ethernet 1)

Note: This field is not applicable to Azure.

The Netmask will be applied to the Ethernet 1 IPv4 address. This field is required if set to Yes.

Media Next Hop IP (Ethernet 1)

The Media Next Hop IP specifies the gateway for a particular interface subnet so that all the media traffic egress to that gateway. This field is required if set to Yes.

For KVM Hypervisor, VMware ESXi, Microsoft Hyper-V: For Ethernet 1 - 4, when the Configure IP field is set to Yes, the corresponding fields for that Ethernet port are required.

For Azure: The default of No is recommended.

Configure IP (Ethernet 2)

Note: This field is not applicable to Azure.

Enables or disables the use of an IP address with Ethernet 2. If you select Yes, the IPv4 Address, Netmask, and Media Next Hop fields are visible. This field is required if set to Yes.

Configure IP (Ethernet 3)

Note: This field is not applicable to Azure.

Enables or disables the use of an IP address with Ethernet 3. If you select Yes, the IPv4 Address, Netmask, and Media Next Hop fields are visible. This field is required if set to Yes.

Configure IP (Ethernet 4)

Note: This field is not applicable to Azure.

Enables or disables the use of an IP address with Ethernet 4. If you select Yes, the IPv4 Address, Netmask, and Media Next Hop fields are visible. These fields are required if set to Yes.

Local Users Pane

This section is used to create a local Administrative User and an optional REST User.

Admin User Name

Enter a Admin user name. For all configurations, this field is required.

Enter Password

Enter a password for the administrative user. For all configurations, this field is required.

Confirm Password

Re-enter the same password to confirm. For all configurations, this field is required.

Password Recovery for SBC SWe Lite

To recover a lost password:

  • First check with other members of your organization who have Administrator privileges and have them assist you.
  • If this is not possible, contact Ribbon TAC at Customer Support Portal.

Configure REST User

Select Yes if you wish to configure and enable a REST user. If you select Yes, you will be required to enter the REST username, enter, and confirm the REST username password. For all configurations, this field is required.

Connectivity Information Pane

Configure Default Route

If you plan to use a gateway to route IP traffic from the SBC, set this field to Yes and specify a Default Gateway IP address, which should be in the same subnet as the primary Ethernet port. This field is displayed only when Static is selected from the Network Configuration field.

For Azure, the default entry of No is recommended.

Default Gateway

The IP Address of the default gateway. This field is displayed only when Configure Default Route is set to Yes. This field is required if Config Default Route is set to Yes.

Use Primary DNS

If you plan to use host names for routing network traffic from the SBC system, select Yes and provide a Primary Server IP address.

For Azure, the default entry of Yes is recommended.

Primary Server IP

The IP address of the primary DNS server. This field is required if the Use Primary DNS field was set to Yes.

For Azure, this field is required.

Use Secondary DNS

Optionally, set the Use Secondary DNS to Yes and provide a Secondary Server IP address. For Azure, verify if this field is applicable to your network configuration and set the field appropriately.

Add Static Route Entry Pane

The Add Static Route Entry configuration enables you to create static routes/gateways for the additional Ethernet interfaces, if required. To create a static route, click the ( ) icon in the Static Subnet IP Routes section. Populate the fields using the definitions below and then click OK.

For all configurations, these fields are optional.

 

Figure : Add Static Route Entry

 

Destination IP

Enter the destination IP Address. This field is required.

Mask

Enter the network mask of the destination host or subnet. This field is required.

Gateway

Enter the IP Address of the next-hop router to use for this Static Route. This field is required.

Metric

Enter the cost of this route, which indirectly specifies the preference of the route. Lower values indicate more preferred routes. Typical value is 1 for most static routes, which indicates that static routes are preferred to dynamic routes. Valid entry: 1 - 255. This field is required.

After the fields are populated, click OK to save the Initial Ribbon SBC Setup. If you have a console, you will see the admin IP address.

 

Figure : Admin IP


To prevent time drift, you must manually set an NTP time source. Instructions are located at Configuring an NTP Time Source. Return to this section when complete.

Next Steps

Access the Web UI 

Access the SBC Edge Web UI via Admin IP address or the IP address of the Ethernet port associated to the static IP address (configured above).

Next Steps for SBC SWe Lite Trials

For SBC SWe Lite trial deployments, please return to the applicable trial page for subsequent instructions on easy configuration (after accessing the Web UI). For reference:

Execute Easy Configuration Wizard (Optional, if Available After First Login)

If the Easy Setup field was available during initial setup and configured to Launch on First Login, the Web UI presents the Easy Configuration Wizard upon login. To select the specific scenario in which to provision, refer to Easy Configuration Wizard. Once complete, the SBC SWe Lite supports calls.


Acquire and Apply Desired Feature Licenses

If the Easy Setup field was not available during initial setup or the field was not set to Launch on First Login, the Web UI opens with an abbreviated Tasks tab presentation.

Figure : Sample Abbreviated Tasks Tab Presentation, Upon First Login After Initial Setup


Ribbon recommends the application of feature licenses, which enables configuration va Easy Configuration Wizard. 

  1. Review the license viewing and application process.
  2. Identify the desired licenses to apply to the SBC SWe Lite. Refer to the following for specific deployments:
    1. Licenses for Azure deployments.
    2. Licenses for on-premises (i.e. Microsoft Hyper-V/VMware ESXi/KVM) deployments.
  3. Obtain and apply the desired licenses. Refer to  Obtaining and Installing an SBC SWe Lite Production License.

Run Easy Configuration Wizard

To select the specific scenario in which to provision, refer to Easy Configuration Wizard. Once complete, the SBC SWe Lite supports calls.