In this section:
In OpenStack environment, Metadata and Userdata is populated automatically by the Heat template when SBC SWe cloud instances are launched through templates. If required, Metadata can be updated using nova APIs. The Metadata and the Userdata are provided in the JSON format.
For AWS and OpenStack, there is now a common REST API command for accessing/showing/listing instantiation data such as meta-data and user-data. For details, refer to the REST-API-Reference-Guide.
# Mgt0 interface "IF0" : { "Port":"Mgt0", "DHCP": "<Dhcp_flag>", "GWV4":"<IP_Address>", "IPV4":"<IP_Address/Subnet_Prefix>", "GWV6" :"<IP_Address>", "IPV6":"<IP_Address/Subnet_Prefix>", "FIPV4":"<IP_Address>", }, # Ha0 interface "IF1" : { "Port" : "Ha0", "DHCP": "<Dhcp_flag>", "GWV4":"<IP_Address>", "IPV4":"<IP_Address/Subnet_Prefix>", "FIPV4":"<IP_Address>", }, # IP interface Pkt0.111 "IF2": { "Port" :"Pkt0", "DHCP": "<Dhcp_flag>", "GWV4":"<IP_Address>", "IPV4":"<IP_Address/Subnet_Prefix>", "GWV6" :"<IP_Address>", "IPV6":"<IP_Address/Subnet_Prefix>", "FIPV4":"<IP_Address>", "RNat":"true", "VlanId":"111" }, }, # Secondary IP for Pkt0.111 "AltIP2" : { "IFName":"IF2", "IP": "<IP_Address>", "FIPV4":"<IP_Address>" } # Another Secondary IP for Pkt0.111 "AltIP3" : { "IFName":"IF2", "IP": "<IP_Address>", "FIPV4":"<IP_Address>" } # IP interface Pkt0.222 "IF3": { "Port":"Pkt0", "DHCP": "<Dhcp_flag>", "GWV4":"<IP_Address>", "IPV4":"<IP_Address/Subnet_Prefix>", "GWV6" :"<IP_Address>", "IPV6":"<IP_Address/Subnet_Prefix>", "FIPV4":"<IP_Address>", "RNat":"true", "VlanId":"222" }, # Secondary IP for Pkt0.222 "AltIP4" : { "IFName":"IF3", "IP": "<IP_Address>", "FIPV4":"<IP_Address>", }, # IP interface Pkt1.333 "IF4": { "Port":"Pkt1", "DHCP": "<Dhcp_flag>", "GWV4":"<IP_Address>", "IPV4":"<IP_Address/Subnet_Prefix>", "GWV6" :"<IP_Address>", "IPV6":"<IP_Address/Subnet_Prefix>", "FIPV4":"<IP_Address>", "RNat":"true", "VlanId":"333" }, # Secondary IP for Pkt1.333 "AltIP5" : { "IFName":"IF4", "IP": "<IP_Address>", "FIPV4":"<IP_Address>" }, ClusterIp: "<RG_IP>"
If a port needs to be part of multiple VLANs, the IF
definition must be repeated for corresponding VLAN IDs as:
"IF3": { "GWV4": "<IP_Address>", "DHCP": "<Dhcp_flag>", "Port": "Pkt1", "VlanId": "<VLAN_ID_1>", "IPV4": "<IP_Address/Subnet_Prefix>" }, "IF4": { "GWV4": "<IP_Address>", "DHCP": "<Dhcp_flag>", "Port": "Pkt1", "VlanId": "<VLAN_ID_2>", "IPV4": "<IP_Address/Subnet_Prefix>" }, "IF5": { "GWV4": "<IP_Address>", "DHCP": "<Dhcp_flag>", "Port": "Pkt1", "VlanId": "<VLAN_ID_3>", "IPV4": "<IP_Address/Subnet_Prefix>" }
#Interface definition for Mgt0 port. "IF0" : { "Port":"Mgt0", "DHCP": "False", "GWV4":"10.0.0.1", "IPV4":"10.0.0.24/24", "GWV6" :"fd00:10:2b50:4000::1", "IPV6":"fd00:10:2b50:4000::1/64", "FIPV4":"10.14.52.108", }, # JSON for the Ha0 interface "IF1" : { "Port" : "Ha0", "DHCP": "False", "GWV4":"192.168.100.1", "IPV4":"192.168.100.24/24", }, # JSON for the IP interface Pkt0.2007 "IF2": { "Port" :"Pkt0", "DHCP": "False", "GWV6" :"fd00:10:6b21:2007::1", "IPV6":"fd00:10:6b21:2007::1001/64", "VlanId":"2007" }, # JSON for the IP interface Pkt1.2008 "IF3": { "Port" :"Pkt1", "DHCP": "False", "GWV6" :"fd00:10:6b21:2008::1", "IPV6":"fd00:10:6b21:2008::1001/64", "VlanId":"2008" }, }, # Secondary IP for Pkt0.2007 "AltIP2" : { "IFName":"IF2", "IP": "fd00:10:6b21:2007::1002", } # Another Secondary IP for Pkt0.2007 "AltIP3" : { "IFName":"IF2", "IP": "fd00:10:6b21:2007::1003", }, ClusterIp: "192.168.100.25"
IF
dictionary name is any name prefixed by IF
.Example : IF-ABC
, IFASD, IF_AS,
and so on.
The name for alternate IP address on a port can be constructed with port/vlan information.
Example: The second alternate IP address for pkt0's first VLAN IP interface can be named as PKT0_V01_ALT_IP_02.
The maximum length of the name is 255 characters.
This section describes about the individual parameters of the metadata passed to the server:
"IF3": { "Port": "Pkt0", "DHCP": "False", "GWV4": "10.0.3.1", "IPV4": "10.0.3.187/24", "GWV6": "fd00:10:6b50:4350::6", "IPV6": "fd00:10:6b50:4350::69/64", "FIPV4": "54.32.21.12", "RNat": "true", "VlanId":"222" }
The elements which constitutes an interface definition:
Alternate IP definition contains the information of an additional IP addresses associated with the port. For each additional IP address added to the port, there has to be corresponding ALT IP definition. The maximum number of ALT IP (alternate IP address) that can be associated with a port is restricted to 14.
"AltIP3" : { "IFName":"IF2", "IP": "10.2.0.7", "FIPV4":"aaa.bbb.ccc.eee" }
The parameter ClusterIp
is used for Redundancy Group (RG) formation during startup. You must pass HA0
IP of one of the nodes of RG as ClusterIp parameter.
ClusterIp: "<RG_IP>"
{ "CERole" : "CERole", "CEName" : "CEName", "SystemName" : "SystemName", "SbcPersonalityType" : "SbcPersonalityType", "EmsUsername" : "EmsUsername", "EmsPassword" : "EmsPassword", "EmsIP" : "EmsIP", "EmsDownloadConfig" : "EmsDownloadConfig", "ConfigDownloadName" : "ConfigDownloadName", "EmsPrivateNodeParameters" : { "cluster_id": "","vnfc_id":""} }
The Userdata JSON is present under the write_file directory /opt/sonus/conf/userData.json
.
{ "CERole" : "ACTIVE", "CEName" : "vsbc1", "SystemName" : "vsbcsystem", "SbcPersonalityType" : "msbc", "EmsUsername" : "restuser", "EmsPassword" : "sonus123", "EmsIP" : [ "10.54.58.184", "10.54.58.185" ], "EmsDownloadConfig" : "True", "ConfigDownloadName" : "savedMSBCconfiguration", "EmsPrivateNodeParameters": { "cluster_id": "MSBC" , "vnfc_id": "Msbc1_N1" } }
Interface related information (contents of Interface and ALT IP definition) provided in userdata and/or metadata is flattened down into key-value pairs, which is used for CLI configuration.
A example metavariable table for the 4:1 M-SBC is shown below:
admin@vMsbcl> show table system metavariable CE NAME NAME VALUE ------------------------------------------------------ vMsbcl-10.10.20.17 IFO.GWV6 fd00:10:6b50:43AO::1 vMsbcl-10.10.20.17 IF0.IPV6 FD00:10:6B50:43AO::DO vMsbcl-10.10.20.17 IFO.Port MgtO vMsbcl-10.10.20.17 IFl.GWV4 10.10.20.1 vMsbcl-10.10.20.17 IFl.IPV4 10.10.20.17 vMsbcl-10.10.20.17 IFl.Port HaO vMsbcl-10.10.20.17 IF2.GWV6 FD00:10:6B50:4D74::1 vMsbcl-10.10.20.17 IF2.IPV6 FD00:10:6B50:4D74::DO vMsbcl-10.10.20.17 IF2.Port PktO vMsbcl-10.10.20.17 IF3.GWV6 FD00:10:6B50:4D70::1 vMsbcl-10.10.20.17 IF3.IPV6 FD00:10:6B50:4D70::9 vMsbcl-10.10.20.17 IF3.Port PktO vMsbcl-10.10.20.17 IF4.GWV4 10.54.226.129 vMsbcl-10.10.20.17 IF4.IPV4 10.54.226.138 vMsbcl-10.10.20.17 IF4.Port PktO vMsbcl-10.10.20.17 IF5.GWV4 10.54.226.193 vMsbcl-10.10.20.17 IFS.IPV4 10.54.226.202 vMsbcl-10.10.20.17 IFS.Port PktO vMsbcl-10.10.20.17 IF6.GWV4 10.10.13.1 vMsbcl-10.10.20.17 IF6.IPV4 10.10.13.17 vMsbcl-10.10.20.17 IF6.Port Pktl vMsbcl-10.10.20.17 IF2.Vlan!d 313 vMsbcl-10.10.20.17 IF3.Vlan!d 309 vMsbcl-10.10.20.17 IF4.Vlan!d 311 vMsbcl-10.10.20.17 IFS.Vlan!d 312 vMsbcl-10.10.20.17 IFO.PrefixV6 60 vMsbcl-10.10.20.17 IFl.PrefixV4 24 vMsbcl-10.10.20.17 IF2.PrefixV6 64 vMsbcl-10.10.20.17 IF3.PrefixV6 64 vMsbcl-10.10.20.17 IF4.PrefixV4 26 vMsbcl-10.10.20.17 IF5.PrefixV4 26 vMsbcl-10.10.20.17 IF6.PrefixV4 24 vMsbc2-10.10.20.18 IFO.GWV6 fd00:10:6b50:43AO::1 vMsbc2-10.10.20.18 IF0.IPV6 FD00:10:6B50:43AO::Dl vMsbc2-10.10.20.18 IFO.Port MgtO vMsbc2-10.10.20.18 IFl.GWV4 10.10.20.1 vMsbc2-10.10.20.18 IFl.IPV4 10.10.20.18 vMsbc2-10.10.20.18 IFl.Port HaO vMsbc2-10.10.20.18 IF2.GWV6 FD00:10:6B50:4D74::1 vMsbc2-10.10.20.18 IF2.IPV6 FD00:10:6B50:4D74::Dl vMsbc2-10.10.20.18 IF2.Port PktO vMsbc2-10.10.20.18 IF3.GWV6 FD00:10:6B50:4D70::1 vMsbc2-10.10.20.18 IF3.IPV6 FD00:10:6B50:4D70::A vMsbc2-10.10.20.18 IF3.Port PktO vMsbc2-10.10.20.18 IF4.GWV4 10.54.226.129 vMsbc2-10.10.20.18 IF4.IPV4 10.54.226.139 vMsbc2-10.10.20.18 IF4.Port PktO vMsbc2-10.10.20.18 IF5.GWV4 10.54.226.193 vMsbc2-10.10.20.18 IFS.IPV4 10.54.226.203 vMsbc2-10.10.20.18 IFS.Port PktO vMsbc2-10.10.20.18 IF6.GWV4 10.10.13.1 vMsbc2-10.10.20.18 IF6.IPV4 10.10.13.18 vMsbc2-10.10.20.18 IF6.Port Pktl vMsbc2-10.10.20.18 IF2.Vlan!d 313 vMsbc2-10.10.20.18 IF3.Vlan!d 309 vMsbc2-10.10.20.18 IF4.Vlan!d 311 vMsbc2-10.10.20.18 IFS.Vlan!d 312 vMsbc2-10.10.20.18 IFO.PrefixV6 60 vMsbc2-10.10.20.18 IFl.PrefixV4 24 vMsbc2-10.10.20.18 IF2.PrefixV6 64 vMsbc2-10.10.20.18 IF3.PrefixV6 64 vMsbc2-10.10.20.18 IF4.PrefixV4 26 vMsbc2-10.10.20.18 IF5.PrefixV4 26 vMsbc2-10.10.20.18 IF6.PrefixV4 24 vMsbc3-10.10.20.19 IFO.GWV6 fd00:10:6b50:43AO::1 vMsbc3-10.10.20.19 IF0.IPV6 FD00:10:6B50:43AO::D2 vMsbc3-10.10.20.19 IFO.Port MgtO vMsbc3-10.10.20.19 IFl.GWV4 10.10.20.1 vMsbc3-10.10.20.19 IFl.IPV4 10.10.20.19 vMsbc3-10.10.20.19 IFl.Port HaO vMsbc3-10.10.20.19 IF2.GWV6 FD00:10:6B50:4D74::1 vMsbc3-10.10.20.19 IF2.IPV6 FD00:10:6B50:4D74::D2 vMsbc3-10.10.20.19 IF2.Port PktO vMsbc3-10.10.20.19 IF3.GWV6 FD00:10:6B50:4D70::1 vMsbc3-10.10.20.19 IF3.IPV6 FD00:10:6B50:4D70::B vMsbc3-10.10.20.19 IF3.Port PktO vMsbc3-10.10.20.19 IF4.GWV4 10.54.226.129 vMsbc3-10.10.20.19 IF4.IPV4 10.54.226.140 vMsbc3-10.10.20.19 IF4.Port PktO vMsbc3-10.10.20.19 IF5.GWV4 10.54.226.193 vMsbc3-10.10.20.19 IFS.IPV4 10.54.226.204 vMsbc3-10.10.20.19 IFS.Port PktO vMsbc3-10.10.20.19 IF6.GWV4 10.10.13.1 vMsbc3-10.10.20.19 IF6.IPV4 10.10.13.19 vMsbc3-10.10.20.19 IF6.Port Pktl vMsbc3-10.10.20.19 IF2.Vlan!d 313 vMsbc3-10.10.20.19 IF3.Vlan!d 309 vMsbc3-10.10.20.19 IF4.Vlan!d 311 vMsbc3-10.10.20.19 IFS.Vlan!d 312 vMsbc3-10.10.20.19 IFO.PrefixV6 60 vMsbc3-10.10.20.19 IFl.PrefixV4 24 vMsbc3-10.10.20.19 IF2.PrefixV6 64 vMsbc3-10.10.20.19 IF3.PrefixV6 64 vMsbc3-10.10.20.19 IF4.PrefixV4 26 vMsbc3-10.10.20.19 IF5.PrefixV4 26 vMsbc3-10.10.20.19 IF6.PrefixV4 24 vMsbc4-10.10.20.26 IFO.GWV6 fd00:10:6b50:43AO::1 vMsbc4-10.10.20.26 IF0.IPV6 FD00:10:6B50:43AO::D9 vMsbc4-10.10.20.26 IFO.Port MgtO vMsbc4-10.10.20.26 IFl.GWV4 10.10.20.1 vMsbc4-10.10.20.26 IFl.IPV4 10.10.20.26 vMsbc4-10.10.20.26 IFl.Port HaO vMsbc4-10.10.20.26 IF2.GWV6 FD00:10:6B50:4D74::1 vMsbc4-10.10.20.26 IF2.IPV6 FD00:10:6B50:4D74::D9 vMsbc4-10.10.20.26 IF2.Port PktO vMsbc4-10.10.20.26 IF3.GWV6 FD00:10:6B50:4D70::1 vMsbc4-10.10.20.26 IF3.IPV6 FD00:10:6B50:4D70::12 vMsbc4-10.10.20.26 IF3.Port PktO vMsbc4-10.10.20.26 IF4.GWV4 10.54.226.129 vMsbc4-10.10.20.26 IF4.IPV4 10.54.226.147 vMsbc4-10.10.20.26 IF4.Port PktO vMsbc4-10.10.20.26 IF5.GWV4 10.54.226.193 vMsbc4-10.10.20.26 IFS.IPV4 10.54.226.211 vMsbc4-10.10.20.26 IFS.Port PktO vMsbc4-10.10.20.26 IF6.GWV4 10.10.13.1 vMsbc4-10.10.20.26 IF6.IPV4 10.10.13.26 vMsbc4-10.10.20.26 IF6.Port Pktl vMsbc4-10.10.20.26 IF2.Vlan!d 313 vMsbc4-10.10.20.26 IF3.Vlan!d 309 vMsbc4-10.10.20.26 IF4.Vlan!d 311 vMsbc4-10.10.20.26 IFS.Vlan!d 312 vMsbc4-10.10.20.26 IFO.PrefixV6 60 vMsbc4-10.10.20.26 IFl.PrefixV4 24 vMsbc4-10.10.20.26 IF2.PrefixV6 64 vMsbc4-10.10.20.26 IF3.PrefixV6 64 vMsbc4-10.10.20.26 IF4.PrefixV4 26 vMsbc4-10.10.20.26 IF5.PrefixV4 26 vMsbc4-10.10.20.26 IF6.PrefixV4 24 vMsbcS-10.10.20.11 IFO.GWV6 fd00:10:6b50:43AO::1 vMsbcS-10.10.20.11 IF0.IPV6 FD00:10:6B50:43AO::CA vMsbcS-10.10.20.11 IFO.Port MgtO vMsbcS-10.10.20.11 IFl.GWV4 10.10.20.1 vMsbcS-10.10.20.11 IFl.IPV4 10.10.20.11 vMsbcS-10.10.20.11 IFl.Port HaO vMsbcS-10.10.20.11 IF2.GWV6 FD00:10:6B50:4D74::1 vMsbcS-10.10.20.11 IF2.IPV6 FD00:10:6B50:4D74::CA vMsbcS-10.10.20.11 IF2.Port PktO vMsbcS-10.10.20.11 IF3.GWV6 FD00:10:6B50:4D70::1 vMsbcS-10.10.20.11 IF3.IPV6 FD00:10:6B50:4D70::3 vMsbcS-10.10.20.11 IF3.Port PktO vMsbcS-10.10.20.11 IF4.GWV4 10.54.226.129 vMsbcS-10.10.20.11 IF4.IPV4 10.54.226.132 vMsbcS-10.10.20.11 IF4.Port PktO vMsbcS-10.10.20.11 IF5.GWV4 10.54.226.193 vMsbcS-10.10.20.11 IFS.IPV4 10.54.226.196 vMsbcS-10.10.20.11 IFS.Port PktO vMsbcS-10.10.20.11 IF6.GWV4 10.10.13.1 vMsbcS-10.10.20.11 IF6.IPV4 10.10.13.11 vMsbcS-10.10.20.11 IF6.Port Pktl vMsbcS-10.10.20.11 IF2.Vlan!d 313 vMsbcS-10.10.20.11 IF3.Vlan!d 309 vMsbcS-10.10.20.11 IF4.Vlan!d 311 vMsbcS-10.10.20.11 IFS.Vlan!d 312 vMsbcS-10.10.20.11 IFO.PrefixV6 60 vMsbcS-10.10.20.11 IFl.PrefixV4 24 vMsbcS-10.10.20.11 IF2.PrefixV6 64 vMsbcS-10.10.20.11 IF3.PrefixV6 64 vMsbcS-10.10.20.11 IF4.PrefixV4 26 vMsbcS-10.10.20.11 IF5.PrefixV4 26 vMsbcS-10.10.20.11 IF6.PrefixV4 24 [ok] [2017-08-04 12:26:35]
The sample metaVariables are used for configuration:
set addressContext default ipInterfaceGroup LIG1 ipInterface LIG1_V4 ipVarV4 IF2.IPV4 prefixVarV4 IF2.PrefixV4 vlanTagVar IF5.VlanId portName pkt0 state enabled mode inService set addressContext default ipInterfaceGroup LIG2 ipInterface LIG2_V4 ipVarV4 IF3.IPV4 prefixVarV4 IF3.PrefixV4 ipPublicVarV4 IF3.FIPV4 portName pkt1 state enabled mode inService set addressContext default zone ZONE_AS sipSigPort 3 ipInterfaceGroup LIG2 ipVarV4 IF3.IPV4 ipPublicVarV4 IF3.FIPV4 state enabled set system dsbc dsbcSigPort ipInterfaceGroup SVzIMSMediaIPv6 ipVarV6 PKT0_V02_ALT_IP_01.IP mode inService state enabled commit