System and Instance Naming Conventions - SBC SWe Cloud

System and instance names are assigned during instantiation. You can edit the userdata values that specify these names in the template file you are using during instantiation. Refer to Instantiating SBC SWe on OpenStack using Heat Templates. If you deploy using VNFM, you can set the system name during the instantiation process. The default instance names are set within the VNFD file. Refer to Instantiating SBC SWe on OpenStack using VNFM.

System Naming Convention

The system name is used in billing, external PSX queries (if applicable), and system logs. On an HA system, one system name applies to both units and each unit has its own instance name as described in the Instance Naming Convention section. 

An example system name is WFDSBC01, where:

• The first three letters represent the physical location of the system (WFD =  Westford).
• The second three letters identify the system type (SBC).
• The last two digits identify the SBC (or SBC pair) instance at this particular location.
  
  

The following table lists system naming convention to follow while setting up SBC SWe systems:

SBC System Naming Convention

Convention/Character	System Name	Use as Leading Character	Use as Trailing Character
Maximum number of characters	26
Letters  [ a-z ] | [ A-Z ]
Digits [ 0-9 ]
Hyphen [ - ]
Period [ . ]
Underscore [ _ ]
Other special characters

Instance Naming Convention

If you are providing an instance name, the instance must be configured with the same name and used for all accounting, logging, PSX and EMS communications. The instance name is specific to an instance.

The following table lists the instance naming convention to follow while setting up SBC SWe systems:

SBC Hostname/Instance Naming Convention

Convention/Character	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

VNFC and Cluster Naming Convention

The following table lists VNFC and Cluster naming convention to follow while instantiating VNFC and creating clusters:

VNFC and Cluster Naming Convention

Convention/Character	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 Instance Name using CLI

To know the instance names, execute show table system serverAdmin. In the example, vsbc1 is the ceName provided in the userdata.

admin@vsbc1> show table system serverAdmin
       ACTUAL
       CE      COREDUMP             MODULAR                PKT PORT
NAME   NAME    PROFILE   ROLE       TYPE     HW TYPE       SPEED       HW SUB TYPE
-------------------------------------------------------------------------------------
vsbc1  vsbc1   default   primary    false    ConnexIP5000  speed1Gbps  virtualCloud
vsbc2  none    default   secondary  false    ConnexIP5000  -           virtualCloud

Checking the System Name using CLI

To know the system name, execute show table system admin actualSystemName. In the below example, vsbcSystem is the system name given in the userdata.

admin@vsbc1> show table system admin actualSystemName
                                                                                                                UTIL
                                                                                                                MONITOR
                                                                                                      UTIL      STATS                                           MINIMUM    MINI
            ACTUAL                                           LOCAL           EXTERNAL                 MONITOR   NUM OF    AUDIT                                 NUMBER OF  NUMB
            SYSTEM                                           AUTHENTICATION  AUTHENTICATION           STATS     PAST      LOG      DSP MISMATCH        MINIMUM  UPPERCASE  LOWE
NAME        NAME        CLUSTER ID        LOCATION  CONTACT  ENABLED         ENABLED         STATE    INTERVAL  INTERVAL  STATE    ACTION              LENGTH   CHARS      CHAR
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------
vsbcSystem  vsbcSystem  sbc-signaling  Unknown   Unknown  true            false           enabled  5         4         enabled  preserveRedundancy  8        1          1