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 status of Edge SBC.
Ribbon Edge SBC users can be created via one of two 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 need 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 a 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 and Click icon
Fill in the required fields as below
Field | Value | Mandatory / optional |
---|---|---|
Group Name | Specifies the name of RADIUS class to which a 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
Ribbon SBC Edge 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 to add 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 as 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 None can be selected | 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