RAMP support only

Beginning with SBC Core release 12.0, the SBC interoperates with the Ribbon Application Management Platform (RAMP), replacing the Insight 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 apply to the RAMP platform.

In this section:

Related articles:

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 ParameterUserdata ParameterRibbon VNFM Field Names and Naming Conventions
actualSystemNameSystemName

SYSTEMNAME

The default value for this field in VNFM is "SystemName."
You can specify a different default value when you generate your CSAR file. Refer to Creating a CSAR Package File for SBC SWe on OpenStack for information.

actualCeNameCEName

VNF Name
By default, VNFM appends a suffix to the name you enter in the field based on the type of node, such as “-oam1” or "-ssbc1."
For example, if you enter the value "SSBC-East," as the VNF Name for a 4:1 HA S-SBC deployment (which includes OAM nodes), the actualCeName values given to the deployed nodes are:
SSBC-East-ssbc1, SSBC-East-ssbc2, SSBC-East-ssbc3, SSBC-East-ssbc4, SSBC-East-ssbc5
SSBC-East-oam1, SSBC-East-oam2

You can modify the contents of the suffix added to the VNF Name to construct the actualCeName using custom naming options when you generate your CSAR file. Refer to Creating a CSAR Package File for SBC SWe on OpenStack for more information.

For more information on different instantiation methods used for these types of deployments, refer to:


How the Names Are Used

The following table lists some of the ways the actualSystemName and actualCeName are used.

How SBC Names Are Used

UsageParameter(s) Used
"Gateway Name" in CDRsactualSystemName
EMS registration request

The request to EMS includes the following values derived from the userdata values:

name = <actualCeName>-<ha0 network address>
rg_name = <actualSystemName>
vnfc_id = <actualCeName>-<cluster_id>-1
where: <cluster_id> is configured both in the EMS and within the EmsPrivateNodeParameters userdata parameter. Refer to Metadata and Userdata Format on OpenStack for more information.

"Gateway" name in PSXactualSystemName

System Name Requirements

The following tables lists requirements for the actual system name specified during instantiation:

SBC System Name Requirements


Convention/Character


System Name		Use as Leading
Character		Use as Trailing
Character
Maximum number of characters63
Letters  [ a-z ] | [ A-Z ](tick)(tick)(tick)
Digits [ 0-9 ](tick)(error)(tick)
Hyphen [ - ](tick)(error)(error)
Period [ . ](error)(error)(error)
Underscore [ _ ](error)(error)(error)
Other special characters(error)(error)(error)
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


Convention/Character


Instance Name		Use as Leading
Character		Use as Trailing Character
Maximum number of characters64
Letters  [ a-z ] | [ A-Z ](tick)(tick)(tick)
Digits [ 0-9 ](tick)(error)(tick)
Hyphen [ - ](tick)(error)(error)
Period [ . ]1(tick)(error)(error)
Underscore [ _ ]2(error)(error)(error)
Other special characters(error)(error)(error)

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;