SBC Core RAMP support only
Beginning with release 12.0, the SBC Core supports the Ribbon Application Management Platform (RAMP), which replaces the EMS.
However, the EMA, CLI and API will continue to include EMS-labeled parameters and screens to facilitate SBC migrations from older releases. Accordingly, any references to "EMS" in this documentation pertain to the RAMP platform.
In this section:
By design, some types of virtualized SBC SWe deployments set certain system and instance names by default. For SBC SWe N:1 HA systems and SBC SWe cloud-based systems, the system name is automatically set to "'vsbcSystem." For SWe N:1 HA systems, the host name for each individual node is automatically set to "vsbc1." The host names for the two individual instances in a cloud-based SWe 1:1 HA system are automatically set to "vsbc1" and "vsbc2" (active and standby nodes, respectively).These default names are used in the internal operation of the SBC in virtualized environments and they cannot be changed.
However you can still assign unique name values for the system and individual node instances. During instantiation, the userdata values you provide populate parameters called actualSystemName and actualCeName that are specific to your deployment. If you deploy using Heat, you populate the userdata naming parameters directly in your template file or, if you use the Horizon user interface (UI), you can enter values in the Horizon UI when you orchestrate the system. If you use the Ribbon Virtual Network Function Manager (VNFM), you enter userdata in the VNFM UI during orchestration. Prior to orchestration, you have the option to modify the default naming conventions VNFM applies using options you specify when you generate your CSAR package file.
The following table summarizes how you set the parameters based on your instantiation method.
SBC Name Parameters Populated from Userdata
| SBC Name Parameter | Userdata Parameter | Ribbon VNFM Field Names and Naming Conventions |
|---|---|---|
actualSystemName | SystemName | SYSTEMNAME The default value for this field in VNFM is "SystemName." |
actualCeName | CEName | VNF Name You can modify the contents of the suffix added to the VNF Name to construct the |
How the Names Are Used
The following table lists some of the ways the actualSystemName and actualCeName are used.
How SBC Names Are Used
| Usage | Parameter(s) Used |
|---|---|
| "Gateway Name" in CDRs | actualSystemName |
| EMS registration request | The request to EMS includes the following values derived from the userdata values: name = < |
| "Gateway" name in PSX | actualSystemName |
System Name Requirements
The following tables lists requirements for the actual system name specified during instantiation:
SBC System Name Requirements
| System Name | Use as Leading Character | Use as Trailing Character |
|---|---|---|---|
| Maximum number of characters | 63 | ||
| Letters [ a-z ] | [ A-Z ] |  | | |
| Digits [ 0-9 ] | |  | |
| Hyphen [ - ] | | | |
| Period [ . ] | | | |
| Underscore [ _ ] | | | |
| Other special characters | | | |
Note
Due to a PSX dependency, when there are multiple redundancy groups within an S-SBC cluster, each redundancy group must have the same system name.
Instance Name Requirements
The following tables lists requirements for the actual CE name (instance name) specified during instantiation:
SBC Instance Name Requirements
| Instance Name | Use as Leading Character | Use as Trailing Character |
|---|---|---|---|
| Maximum number of characters | 64 | ||
| Letters [ a-z ] | [ A-Z ] | | | |
| Digits [ 0-9 ] | | | |
| Hyphen [ - ] | | | |
| Period [ . ]1 | | | |
| Underscore [ _ ]2 | | | |
| Other special characters | | | |
Checking the Actual System Name using CLI
To identify the actual system name, execute show table system admin vsbcSystem actualSystemName. In the following example, "Canada" was the system name given in the userdata.
admin@SSBC-ssbc1-192.168.10.10> show table system admin vsbcSystem actualSystemName actualSystemName Canada;
Checking the Actual Instance Name using CLI
To identify the instance names, execute show table system serverAdmin vsbc1 actualCeName. In this example the system was deployed using VNFM and its default naming behavior, and "East" was entered in the VNF Name field in the VNFM user interface.
admin@SSBC-ssbc1-192.168.10.10> show table system serverAdmin vsbc1 actualCeName actualCeName East-ssbc1;
Overview
Content Tools