This section makes frequent use of data contained in the Technical Requirements.
All relevant sections of the Technical Requirements Data collection should be completed or known before commencing with the steps in this section.
Create API User
VSM requires a user account to be created on Ribbon Edge SBC, in order to run API commands which collect the status of Edge SBC. VSM accesses the Ribbon REST API via TCP Port 443.
Ribbon Edge SBC users can be created via one of three options:
Local User Option
Browse to SBC then Navigate to Security > Users > Local User Management
Click on 
icon to create new user
Fill in the required user details as per the table below
| Field | Value | Mandatory/optional |
|---|---|---|
| User Name | Enter Username to be used by VSM | Mandatory |
| Password | Enter Password | Mandatory |
| Confirm Password | Enter Password again | Mandatory |
| Access Level | REST | Mandatory |
Active Directory User Option
This option is applicable only if Active Directory is integrated with Ribbon Edge SBC.
Create New User on Active Directory (Ask Active Directory Administrator) to create User for Ribbon SBC.
Active Directory Administrator needs to make sure the new Ribbon SBC user is in the correct Group that will have API Access.
Confirm with Active Directory Administrator AD Group Name.
Browse to SBC then Navigate to Security > Users > Remote Auth Permission > AD User Group
Click to create AD User Group to Access Level Mapping
Fill in the required fields as below
| Field | Value | Mandatory / optional |
|---|---|---|
| Group Name | Specifies the name of a valid Active Directory user group to which an SBC Edge access level is assigned | Mandatory |
| Access Level | Select REST from the drop-down | Mandatory |
Additional Details can be found here
RADIUS User Option
This option is applicable only if RADIUS Server is used to manage Ribbon Edge SBC Users
Create New User on RADIUS Server (Ask RADIUS Server Administrator) to create User for Ribbon SBC
Check with RADIUS Server Administrator User Class name for the newly created user
Browse to SBC then Navigate to Security > Users > Remote Auth Permission > RADIUS User Class
Click 'User to Access Level', then click the icon.
Fill in the required fields as below
| Field | Value | Mandatory / optional |
|---|---|---|
| Group Name | Specifies the name of RADIUS class to which an SBC Edge access level is assigned, Class Name is case sensitive and must match the RADIUS class exactly | Mandatory |
| Access Level | Select REST from the drop-down | Mandatory |
Additional Details can be found here
SNMP Configuration
SNMP configuration is required as part of Ribbon SBC Edge Monitoring. SNMP can be configured as V2 or V3 based on customer requirements.
Browse to SBC then Navigate to SNMP/Alarms > SNMP Management Address
Click the icon to add a new SNMP Manager Address
SNMP Version 2 Option
Fill in the required fields as below
| Field | Value | Mandatory / Optional |
|---|---|---|
| Manager Address | Enter IP Address of VSM Probe | Mandatory |
| SNMP Version | Select Version 2 from the drop-down | Mandatory |
| Community | Enter the Community String | Mandatory |
| Community Type | Read-Only | Mandatory |
| Trap Enabled | True | Mandatory |
SNMP Version 3 Option
Fill in the fields using the information in the table below:
| Field | Value | Mandatory / Optional |
|---|---|---|
| Manager Address | Enter IP Address of VSM Probe | Mandatory |
| SNMP Version | Select Version 3 from the drop-down | Mandatory |
| Community Type | Read-only | Mandatory |
| USM User Name | Enter SNMP Username | Mandatory |
| Auth Protocol | Select any of the options (None, MD5 or SHA 1) | Mandatory |
| Auth Password | Enter Auth Password - applicable only if selected Auth Protocol is MD5 or SHA1 | Mandatory |
| Confirm Auth Password | Repeat Auth password entered above to confirm | Mandatory |
| Priv Protocol | AES 128 must be selected if Auth Protocol is set to anything other than None, Otherwise, select 'None'. | Mandatory |
| Priv Password | Enter Privacy Password. Hidden when Priv Protocol is set to None | Mandatory |
| Confirm Priv Password | Repeat password entered above to confirm | Mandatory |
| Trap Enabled | Select True from Drop Down | Mandatory |
Additional details can be found here
CDR Configuration
Browse to SBC then Navigate to Auth and Directory Services > RADIUS > Configuration
From the drop down list change Accounting from Disable to Enabled and click Apply
Navigate to Auth and Directory Services > RADIUS > RADIUS Server
Click ( 
) to add VSM as New RADIUS Server
Fill in the fields using the information in the below table
| Field | Value | Mandatory / Optional |
|---|---|---|
| Description | Enter Description for RADIUS Server | Optional |
| RADIUS Server | Enter IP Address of VSM Probe | Mandatory |
| Port | Change it to 1813 | Mandatory |
| Send Connectivity Packet Type | Choose Request from drop down list | Mandatory |
| Shared Secret | Enter the text string for secret key , the same need to be used on VSM when adding Ribbon Edge SBC | Mandatory |
| Confirm Shared Secret | Re-Enter the the text string for secret key | Mandatory |
Syslog Configuration
Browse to SBC then Navigate to Logging Configuration > Remote Log Servers
Click the Create Remote Log ( ) icon at the top of the Remote Log Configuration page
Fill in the fields using the information in the below table
| Field | Value | Mandatory / Optional |
|---|---|---|
| Global Value | Select the log value , default is Warning , recommended value for VSM is Informational | Mandatory |
| Log Destination | Enter IP Address of VSM Probe | Mandatory |
| Port | Default is 514 | Mandatory |
| Protocol | Select the protocol , Default Is UDP | Mandatory |
| Log Facility | Select the Log Facility , Default is local0 (Local Use 0) | Mandatory |
| Enabled | Select Yes | Mandatory |
Additional details can be found here
Web Portal Configuration
Add Ribbon SBC Edge (Swe Lite,1000, 2000)
Log in to the VSM web portal using your VSM credentials and password.
For your customer, select Service Desk > Equipment Locations. Right-click on the Equipment Location that will serve this particular Ribbon Edge SBC and select ‘Manage Equipment’
At the bottom of the ‘Manage Equipment’ page click on the ‘Add Equipment’ button.
A form will open which you can populate with the equipment details as per table the table below
Select the Vendor 'Ribbon Communications' and Product 'SWe Lite, 1000, 2000 (Edge Series)'
Web Portal – Add Ribbon SBC Edge Field Description
Field | Setting |
Vendor | Ribbon Communication |
Product | 'SWe Lite, 1000, 2000 (Edge Series)' |
Equipment Name | Friendly name for this SBC |
API Username | API Username |
API Password | API Password |
IP Address / Host Name | IP Address of SBC |
Site | Free text field, this information will be included in alarm notifications from the VSM Workflow. |
RADIUS Configuration
Check the 'Receive RADIUS Call Accounting' checkbox to collect CDR information from the Ribbon SBC
RADIUS call Accounting
| Field | Settings |
|---|---|
| Shared Secret | Enter the text string for secret key , the same need to be the same configured on Ribbon SBC |
| Source IP Address | Enter SBC IP Address that will be used to send CDR information to VSM |
SNMP
Complete the Equipment tab and then click on the ‘SNMP Query’ tab.
Click on the down arrow, and select the SNMP version you wish VSM to use for querying the Ribbon SBC:
SNMP V2
Ribbon SBC SNMP V2 Field Descriptions
Fields | Setting |
Version | V2 |
SNMP Community String | Community String as administered on the Ribbon SBC |
SNMP V3
Ribbon SBC SNMP V3 Field Description
Fields | Setting |
Version | V3 |
Username | SNMP V3 Username |
Authentication Protocol | SHA (recommended) |
Authentication Password | Password |
Privacy Protocol | DES (recommended) |
Privacy Password | Password |
Test Access
Once all fields are populated Click on the Test Access button. This will test that VSM can connect to the Ribbon SBC using the settings you have entered:
SNMP should return success. If not troubleshoot the configuration.
Once testing is successful click Add.