© 2023 Ribbon Communications Operating Company, Inc. © 2023 ECI Telecom Ltd. All rights reserved. The compilation (meaning the collection, arrangement and assembly) of all content on this site is protected by U.S. and international copyright laws and treaty provisions and may not be used, copied, reproduced, modified, published, uploaded, posted, transmitted or distributed in any way, without prior written consent of Ribbon Communications Inc.
The trademarks, logos, service marks, trade names, and trade dress (“look and feel”) on this website, including without limitation the RIBBON and RIBBON logo marks, are protected by applicable US and foreign trademark rights and other proprietary rights and are the property of Ribbon Communications Operating Company, Inc. or its affiliates. Any third-party trademarks, logos, service marks, trade names and trade dress may be the property of their respective owners. Any uses of the trademarks, logos, service marks, trade names, and trade dress without the prior written consent of Ribbon Communications Operating Company, Inc., its affiliates, or the third parties that own the proprietary rights, are expressly prohibited.
This document provides a configuration guide for Edge 8k when connecting to Cisco Broadworks Network Server/ Application Server for Interop testing.
Ribbon’s Edge 8000 is the newest, high-performance member of our line of services gateway routers that combines security, routing, switching, and 10 Gbps WAN interfaces with next-generation voice and data services where the combination of broadband connectivity and advanced threat mitigation capabilities are required. By consolidating fast, highly available routing, security, and next-generation SBC capabilities in a single device, enterprises can remove network complexity, protect and prioritize resources, and improve user and application experience while lowering the total cost of ownership (TCO).
The Edge 8000 series is comprised of two models:
The 8100/8300 platform is based on Intel Atom 8 core processor with multiple interfaces. This platform shall meet the following high-level requirements:
Cisco BroadWorks is an enterprise-grade calling and collaboration platform delivering unmatched performance, security, and scale.
Hosted by Cisco service provider partners, it integrates with Cisco Webex to meet the full range of enterprise communications and collaboration needs.
Cisco BroadWorks offers mission-critical security, quality, and reliability, providing up to 99.999% availability with full redundancy. It supports all region/country regulations for security, data privacy, and law enforcement.
This guide contains the following configuration sections:
Section A: Installation Procedure
Provides detailed information about Edge 8k installation.
Section B: Edge 8K Configuration
Captures the Swe Edge configurations for interop with Broadworks.
It is not the goal of this guide to provide detailed configurations that will meet the requirements of every customer. Use this guide as a starting point and build the SBC configurations in consultation with network design and deployment engineers.
This is a technical document intended for telecommunications engineers with the purpose of configuring both the Ribbon SBCs and the third-party product. Steps require navigating the third-party product as well as the Ribbon SBC Command Line Interface (CLI). Understanding the basic concepts of TCP/UDP, IP/Routing, and SIP/RTP is needed to complete the configuration and any necessary troubleshooting.
This configuration guide is offered as a convenience to Ribbon customers. The specifications and information regarding the product in this guide are subject to change without notice. All statements, information, and recommendations in this guide are believed to be accurate but are presented without warranty of any kind, express or implied, and are provided “AS IS”. Users must take full responsibility for the applying the specifications and information in this guide.
The following aspects are required before proceeding with the interop:
The sample configuration in this document uses the following equipment and software:
Requirements
Product | Appliance/ Application/ Tool | Software Version |
---|---|---|
Ribbon Communications | Ribbon Edge 8K | V23.06.0 |
Cisco BroadWorks server | Cisco BroadWorks Server version | R24.0 |
Third-party Phones | Kapanga Softphone | 1.00 |
Phonerlite | 2.77 | |
Zoiper | 5.3.8 |
The following topology diagram shows connectivity between Edge 8K SBC and Broadworks.
The sections in this document follow the sequence below. The reader is advised to complete each section for successful configuration.
Broadworks Users:
Open a browser and enter the SBC Edge IP address.
Click Enter, and then login using the admin credentials.
This page describes how you can view the status of each license along with a copy of the license keys installed on your SBC.
Navigate to System > Licensing > Current Licenses
This section contains information about how to manage the way the Ribbon SBC SWe Lite interfaces with the network. The SBC SWe Lite supports five system-created logical interfaces (Administrative IP, Ethernet 1 IP, Ethernet 2 IP, Ethernet 3 IP, and Ethernet 4 IP). In addition to the system-created logical interfaces, the SBC SWe Lite supports user-created VLAN logical sub-interfaces.
Configure Ethernet 1 and Ethernet 2 IPs for SBC SWe Lite as follows:
Navigate to Networking Interfaces > Logical Interfaces.
Ethernet 1 IP
Ethernet 2 IP
Static routes are used to create communication to remote networks. In a production environment, static routes are mainly configured for routing from a specific network to another network that can only be accessed through one point or one interface (single path access or default route).
Destination IP
Specifies the destination IP address.
Mask
Specifies the network mask of the destination host or subnet. If the 'Destination IP Address' and 'Mask' field values are 0.0.0.0, the static route is called the 'default static route'.
Gateway
Specifies the IP address of the next-hop router to use for this static route.
Navigate to Protocols > IP > Static Routes.
SIP provides a registration function allowing users to upload their current locations for proxy servers.
Registration creates bindings in a location service for a particular domain that associates an address-of-record URI with one or more contact addresses.
Registration entails sending a REGISTER request to a particular type of UAS (User-Agent Server) known as a registrar. A registrar acts as the front-end to the location service for a domain, reading and writing mappings based on the contents of REGISTER requests.
In this interop, the Broadworks AS handles the registration for its users with authentication.
Registration on SBC Edge with the reg-key parameter will be supported in the upcoming release. During this interop, incoming routes were configured for each user/endpoint as a workaround.
Navigate to SIP > Local Registrars.
SIP Profiles control how the SBC Edge communicates with SIP devices. They control important characteristics, such as session timers, SIP header customization, SIP timers, MIME payloads, and option tags.
Navigate to SIP > SIP Profiles.
SIP Server Tables contain information about the SIP devices connected to the SBC Edge. The entries in the tables provide information about the IP addresses, ports, and protocols used to communicate with each server.
Three SIP devices are used in this case.
Navigate to SIP > SIP Server Tables.
UAC
UAC2
Navigate to SIP > SIP Server Tables.
Use Primary DNS
Specifies whether or not the SBC uses a DNS. Available options: Yes or No.
Primary Server IP
Specifies the IPv4 or IPv6 address of the Primary DNS server. The field is displayed when the Use Primary DNS field is set to Yes.
Navigate to System > Node-Level Settings.
The SBC Edge allows a maximum of 100 SIP Message Rule Tables and a maximum of 32 SIP Message rules per table. The maximum of 32 SIP Message rules per table includes all SIP rule types: Header, Request, Status, and Raw.
Navigate to SIP > Message Manipulation > Message Rule Tables.
Add a Request Line Rule to modify "ns1.stbroadsoft.com" to "stbroadsoft.com" in the "Request Line"
Add a Header Rule to modify "ns1.stbroadsoft.com" in the "From" header to "stbroadsoft.com"
Follow the same procedure to add Header Rules for "To" and "PAI" headers.
Signaling groups allow telephony channels to be grouped together for routing and shared configuration. They are the entity to which calls are routed, as well as the location from which Call Routes are selected.
Navigate to Signaling Groups (Add SIP SG).
INGRESS_SG
EGRESS SG
Transformation Tables facilitate the conversion of names, numbers, and other fields when routing a call. They can, for example, convert a public PSTN number into a private extension number or a SIP address (URI). Every entry in a Call Routing Table requires a Transformation Table, and they are selected from there.
Navigate to Call Routing > Transformation.
Call Routing allows calls to be carried between signaling groups, thus allowing calls between ports and protocols (like ISDN to SIP). Routes are defined by Call Routing Tables, which allow for flexible configuration of which calls are carried and how they are translated.
Navigate to Call Routing > Call Routing Table.
INGRESS
EGRESS
This section verifies the DUT’s capability to provide a surrogate registration to BroadWorks for a non-registering IP-PBX, trunking gateway, or other devices.
Surrogate registration is currently not supported with a redirect 3xx response. During this interop, SBC SWe Lite was pointed directly to the Broadworks AS.
To configure the profile for surrogate registration, navigate to the Contact Registrant table and create an entry as shown below.
Navigate to Signaling Groups > EGRESS_SG.
This section verifies the DUT’s interoperability with BroadWorks for GIN registration. With GIN registration, the access device, an IP-PBX or PBX-trunking gateway, registers a trunk as a single contact address, which implicitly registers all PBX subscribers. The single register Address of Record (AoR) is the trunk main line or a pilot number.
For GIN registration, a PBX sends a REGISTER request to the service provider’s registrar for a specially designated AoR, with a specially formatted Contact URI without a user portion and containing a bnc parameter, and with a Require header field containing the value “gin”.
The registered contact address is used in the Request-URI for calls from BroadWorks to the DUT. BroadWorks populates the user portion with the specific PBX user’s number.
Reg-key support is required for GIN registration of a Pilot number and incoming calls for PBX users. GIN registration will be supported along with reg-key implementation in the upcoming release.
Navigate to trunk groups. Create a new trunk group as shown below with trunk group type 'DTG/OTG'.
Disable FQDN in Contact header under the SIP Profile.
Make sure the SBC SWe Lite SipSg IP (configured towards Broadworks) is added to the network server to receive a 3xx Redirect response with multiple AS FQDNs in the Contact header.
Open a browser and enter the Broadworks Network Server IP.
Enter the username and password, and then click Login.
Navigate to Network > Routing NEs and click Add.
This page allows the user to add routing network elements (NEs). Once added, the routing NE appears on the Routing NEs page. A routing NE is a network element that provides connectivity to remote networks, for example, the PSTN. A routing NE is a system provider-owned device. It can either be a network gateway or a proxy server used to "front" network gateways.
Enter the Routing NE Name, select the appropriate Routing Profile, and click Save.
Navigate to Network > Routing NE Addrs, and click Add.
From this screen, add routing network element (NE) addresses. Once added, the routing NE address displays on the Routing NE Address screen.
To add, select the Routing NE Name created in the previous step from the drop-down list.
Add the Sipsg IP and port, and then click Save.
Open a browser and enter the Broadworks Application Server IP address.
Enter the user credentials, and click Login.
From the Broadworks home page, navigate to Profile > Users.
This page displays users in a group or department. You can display all users or look for specific users.
To display all users, click Search.
Or, you can search for users by User ID, Last Name, First Name, Phone Number, Extension, Department, and whether the user is in a Trunk Group. To display specific users, enter your search criteria, and click Search.
Click Assign Services to assign or unassign services and service packs to a user. If a service or service pack is unassigned, the service data filled out will be lost.
Use this page to display the service packs and individual services available for assigning to a user.
Using this page, you can also do the following:
Assign service packs to a user.
Unassign service packs from a user.
Assign services to a user.
Unassign services from a user.
Ensure the user is assigned all required services like Authentication and supplementary services like Call Forwarding, Call Transfer, Call Waiting, and so on.
Navigate to Profile > Users > Utilities. Click Authentication.
Use this page to change the user's authentication password. This password is used to authenticate an IP phone, which allows users to make calls over Internet Protocol (IP) based networks.
The authentication password and username can differ from the system password and user ID used at the initial system login. While you can use the same name and password for authentication and initial login, the credentials allow access to different services. The password restrictions may differ.
Enter the username and password. Click Apply.
As required, enable or disable the services to handle the incoming calls by navigating to Profile > Users > Incoming Calls.
This page displays menu items to handle incoming calls. You can activate or deactivate some of the services by turning them on or off on the page. To access the page for a particular service, click on the link for that service.
The following checklist depicts the set of services/features covered through the configurations defined in this Interop Guide.
Sr.no | Features/Services | Supported |
---|---|---|
1 | Basic Registration with Authentication | |
2 | Basic Registration with reg-key | |
3 | Basic calls | |
4 | CANCEL Scenario | |
5 | User Busy | |
6 | Session Audit | |
7 | Session Timers | |
8 | Music on Hold | |
9 | In-band DTMF | |
10 | RFC 2833 DTMF | |
11 | DTMF Relay | |
12 | Message Waiting Indicator: Unsolicited | |
13 | OTG parameter Support | |
14 | DTG parameter Support | |
15 | TGRP parameter Support | |
16 | Call Waiting | |
17 | SUBSCRIBE with 302 | |
18 | Remote Ringback | |
19 | Local Ringback followed by Remote Ringback | |
20 | Call Forward | |
21 | Voice Portal | |
22 | Anonymous call: Trusted and Non-trusted endpoint | |
23 | Calling Name with Unicode Characters | |
24 | Diversion Header: Single and Multiple Redirects | |
25 | History-Info | |
26 | Blind Transfer | |
27 | Attended Transfer | |
28 | Local Conference | |
29 | Network Conference | |
30 | Duplicate Registration | |
31 | Pilot Registration | |
32 | Surrogate Registration with 302 | |
33 | GIN registration | |
34 | DNS SRV Lookup |
Legend
Supported | |
Not supported |
Note the following items in relation to this Interoperability. These are limitations or test observations pertaining to this Interoperability.
The "To" header has an IP Address instead of an FQDN in SUBSCRIBE after the 302 message.
Clear-cache is not taking effect for DNS records.
For any support related queries about this guide, please contact your local Ribbon representative or use the details below:
For detailed information about Ribbon products and solutions, please visit:
https://ribboncommunications.com/products.
For details about Cisco Broadworks
https://www.cisco.com/c/en/us/products/unified-communications/broadworks/index.html
This Interoperability Guide describes successful configuration covering Cisco Broadworks interop with the Edge 8K. All the necessary features and serviceability aspects stand covered as per the details provided in this interoperability document.
Configuration guidance is provided to enable the reader to replicate the same base setup. There may be additional configuration changes required to suit the exact deployment environment.
© 2023 Ribbon Communications Operating Company, Inc. © 2023 ECI Telecom Ltd. All rights reserved.