Page History

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>"
 }

"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 the 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" 

• Ensure the alternate IP definitions have corresponding IF names.
• IF dictionary names are any name prefixed by IF .

Example : IF-ABC, IFASD, IF_AS, and so on.

• The name for an 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.

"IFXIFx" : { 
        "Port":"<Port_Name>",
		"DHCP": "<Dhcp_flag>",
        "RNat": "<True|False>",
        "GWV4":"<IP_Address>",
        "IPV4":"<IP_Address/Subnet_Prefix>",
        "GWV6" :"<IP_Address>",
        "IPV6":"<IP_Address/Subnet_Prefix>",
        "FIPV4":"<IP_Address>",
        "VlanId":"<VLAN_ID>"
}

"AltIP3" : {

        "IFName":"IF2",
        "IP": "10.2.0.7",
		"FIPV4":"aaa.bbb.ccc.eee"
 }

ClusterIp: "<RG_IP>"

user_data_format: RAW
      user_data:
        str_replace:
          template: |
                #cloud-config
                users:
                    - name: admin
                      ssh-authorized-keys: 
- "adminSshKey"
                                 - $adminSshKey 
                      lock_passwd: false
                    - name: linuxadmin
                      ssh-authorized-keys:
- "linuxAdminSshKey"
                                 - $linuxAdminSshKey
                      lock_passwd: false
                
                runcmd:
                    - usermod -p '$adminPassword' admin
                    - usermod -p '$linuxAdminPassword' linuxadmin

                write_files:
                -   content: |
                        {
                          "CEName"                   : "$ce_name",
                          "CEMode"                   : "$ce_mode",
                          "SystemName"               : "$system_name",
                          "SbcPersonalityType"       : "$personality",
                          "SbcHaMode"                : "$ha_mode",
                          "DosSupportSecPktPorts"    : "$dos_support_sec_port",
                          "EmsUsername"              : "$ems_user_name",
                          "EmsPassword"              : "$ems_password",
                          "EmsIP"                    : [ "$ems_ip_1", "$ems_ip_2" ],
                          "EmsDownloadConfig"        : "$downloadConfig",
                          "OamIP"                    : [ "$oam_ip_1", "$oam_ip_2" ],
                          "Oam1Ip"                   : "$oam_ip1",
                          "Oam2Ip"                   : "$oam_ip2",
                          "CERole"                   : "$ce_role",
                          "TemplateName"             : "heatRgNoDhcp.yaml",
                          "TemplateVersion"          : "TEMPLATE_VERSION_UNKNOWN",
                          "EmsPrivateNodeParameters" : { "cluster_id": "$cluster_id","vnfc_id":"$vnfc_id"}
                        }
                    path: /opt/sonus/conf/userData.json


                #bootcmd:
                #-   /opt/sonus/bin/mountVolume.sh -v "$cinderVolumeIdForLogs"
                
          params:
              $ce_role:        { get_param: sbc_ceRole }
              $ce_name:        { get_param: sbc_ceName }
              $ce_mode:         { get_param: sbc_ceMode }
              $system_name:    { get_param: sbc_system_name }
              $personality:    { get_param: personality }
              $dos_support_sec_port:  { get_param: dos_support_sec_port }
              $ha_mode:        { get_param: ha_mode }
              $ems_user_name:  { get_param: ems_user_name }
              $ems_password:   { get_param: ems_password }
              $ems_ip_1:       { get_param: ems_ip_1 }
              $ems_ip_2:       { get_param: ems_ip_2 }
              $cluster_id:     { get_param: cluster_id }
              $downloadConfig: { get_param: download_config }
              $oam_ip_1:       { get_param: oam_ip_1 }
              $oam_ip_2:       { get_param: oam_ip_2 }
              $vnfc_id:        { list_join: ['-', [ { get_param: "OS::stack_name" }, { get_param: cluster_id }, '1']] }
              $adminSshKey:    { get_param:
- usermod -p '"adminPassword"' admin
- usermod -p '"linuxAdminPassword"' linuxadmin
 
write_files:
- content: |
{
 "CERole" : "CERole",
 "CEName" : "CEName",
 "SystemName" : "SystemName",
 "SbcPersonalityType" : "SbcPersonalityType",
 "SbcMgmtMode" : "Mgmt_mode",
 "EmsUsername" : "EmsUsername",
 "EmsPassword" : "EmsPassword",
 "EmsIP" : "EmsIP",
 "EmsDownloadConfig" : "EmsDownloadConfig",
"TemplateName" : "TemplateFileName",
"TemplateVersion" : "Template_Version",
 "EmsPrivateNodeParameters" : { "cluster_id": "","vnfc_id":""}
}
path: /opt/sonus/conf/userData.json
bootcmd:
- /opt/sonus/bin/mountVolume.sh -v "cinderVolumeIdForLogs"

 adminSshKey }
              $linuxAdminSshKey: { get_param: linuxAdminSshKey }
              $adminPassword:    { get_param: adminPassword }
              $linuxAdminPassword: { get_param: linuxAdminPassword }
              #$cinderVolumeIdForLogs: { get_param: cinder_volume_id_for_logs }

Beginning with release 7.1, you must include SSH keys or passwords in the Heat template to log into the SBC CLI or linux shell. Because they are more secure, SSH key fields are mandatory in the Heat templates.
You can use the ssh-keygen command to generate keys. This command generates two files id_rsa and id_rsa.pub in your /home/<user>/.ssh directory. The contents of the id_rsa.pub file contains the input value for the keys in the template. Optionally, keys can also be protected using a passphrase.
Use man ssh-keygen for more options.

Passwords are optional fields. The password input is not plain text, it is a hash of the password. The hash password can be generated using the command: mkpasswd --method=SHA-512 --rounds=4096
Use man mkpasswd for more options.

admin@vMsbcl> show table system metavariable
CE NAME             NAME        VALUE
------------------------------------------------------
vMsbcl-------10.10.20.17  OamIP       ['10.10.20.17','10.10.20.18'] 
vMsbcl-10.10.20.17  Oam1Ip      10.10.20.17 
vMsbcl-10.10.20.17  Oam2Ip      10.10.20.18 
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::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  IF3IF4.IPV6IPV4 	FD00:10:6B50:4D70::910.54.226.138
vMsbcl-10.10.20.17  IF3IF4.Port 	PktO
vMsbcl-10.10.20.17  IF4IF5.GWV4 	10.54.226.129193
vMsbcl-10.10.20.17  IF4IF5.IPV4 	10.54.226.138202
vMsbcl-10.10.20.17  IF4IF5.Port 	PktO
vMsbcl-10.10.20.17  IF5IF6.GWV4 	10.5410.22613.1931
vMsbcl-10.10.20.17  IFSIF6.IPV4 	10.5410.22613.20217
vMsbcl-10.10.20.17  IFSIF6.Port 	Pktl
vMsbcl-10.10.20.17  IF2.Vlanid 	PktO313
vMsbcl-10.10.20.17  IF6IF3.GWV4Vlanid 	309
vMsbcl-10.10.13.120.17  IF4.Vlanid 	311
vMsbcl-10.10.20.17  IF6IF5.IPV4Vlanid 	312
vMsbcl-10.10.1320.17  IFO.PrefixV6 60
vMsbcl-10.10.20.17  IF6IFl.PortPrefixV4 	Pktl24
vMsbcl-10.10.20.17  IF2.VlanidPrefixV6 	31364
vMsbcl-10.10.20.17  IF3.Vlanid 	309PrefixV6 64

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 SVzIMSMediaIPv6SRRIMSMediaIPv6 ipVarV6 PKT0_V02_ALT_IP_01.IP mode inService state enabled
commit