System and Instance Naming Conventions

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 instances as described in Instance Naming Convention section. 

The default system name is vsbcSystem. 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

Changing Default System Name

To change the default system name, provide the customization script in the Post-Creation tab of the Launch Instance. For more details on the Post-Creation tab, refer to Installing SBC SWe on Virtual Platforms.

{
  "SystemName" :<custom system name>"
}

Hostname/Instance Naming Convention

The default name of instance are "vsbc1" and "vsbc2". You can only modify instance names while instantiating.

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. Instance name is specific to an instance.

The following table lists hostname/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

¹The period is typically used to specify a fully qualified domain name.

²The underscore character ‘_’ is not allowed in either the local hostname or peer hostname because it is not valid for SIP URI and TCP/IP host naming.

 

Changing Default Instance Name

To change the default instance name, provide the customization script in the Post-Creation tab of the Launch Instance. For more details on the Post-Creation tab, refer to Installing SBC SWe on Virtual Platforms.

{
 "CEName" :<custom instance name>
}

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

¹The period is typically used to specify a fully qualified domain name.

²The underscore character ‘_’ is not allowed in either the local hostname or peer hostname because it is not valid for SIP URI and TCP/IP host naming.

 

Checking Server Name using CLI

To know the server name, execute show table system serverAdmin. In the below example, vsbc1 is the server name.

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 System Name using CLI

To know the system name, execute show table system serverAdmin. In the below example, vsbcSystem1 is the system name.

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-configurator  Unknown   Unknown  true            false           enabled  5         4         enabled  preserveRedundancy  8        1          1