OAM over MQTT Bridge ver0 4

OAM over MQTT Bridge ver0 4

Tektelic Linux GW OAM - MQTT Bridge

Name: Tektelic Linux GW OAM – MQTT Bridge

Revision: 0.4

Issue Date: 27/03/2019

Status: Draft




Document Revision

Revision

Issue Date

Author

Comments

0.1

June 13, 2018

KC

Initial release

0.2

June 14, 2018

KC

Document format

0.3

July 27, 2018

TD

1st external release

0.4

March 27, 2019

TD

Update based on 2.0.1 production NS OAM (& beta OAM server) release


Table of Contents



  1. SNMP (OA&M) Features via MQTT Bridge:

You have to login to Network Server as a customer administrator or provider administrator to use MQTT features.  This document applies to both the TEKTELIC network server based OAM interface as well as the TEKTELIC OAM server interface.  Differences will be highlighted in the relevant sections. 

2.1 Gateway Info:

This tab provides Gateway ID, Module Name, Revision and Serial number. 


2.2 Radio Statistics:

This tab provides number of transmitted and received packets, number of packets with and with out timestamps, number of packets with CRC passed and failed and number of packets with RX packet error rate and no match. By default the poll Interval is 5 sec.



 


2.3 Spectrum Analyzer:

This feature is not yet supported on Micro platform. Spectrum Analyzer on Macro platform is supported on Antenna 0.

This tab plot the graph between frequency and power with live data. The user should set the start and stop frequency, bin spacing, sample period and Antenna before start the Spectrum Analyzer.







2.4 Spectral Scan:

This feature is not yet supported on Micro platform. Spectrum Analyzer on Macro platform is supported on Antenna 0.

Spectral scan will scan the channels on the Gateway and plot and display the graph between frequency and power, and Count and Power bins. It will take a minute to provide results. The channels, antenna, step size and sample period have to be configured properly before start the Spectral Scan. 










2.5 Events:

This tab displays different event types. Alarms and Faults which are generated by the gateway. Online and offline status are provided by the Network Server. With the current implementation events from the event types won’t provide anything.






2.6 Configuration:

This tab provides last sync time with config.json file from the gateway.



To view a configuration file on the gateway, click on the pencil for the type of configuration.  Then click on “Remote Configuration”  For example, the config.json file on the gateway can be accessed by clicking on the pencil of the “General” configuration, then selecting “Remote Configuration”.



To make a change to the file, select the whole file and copy it.  On the “Configuration” tab, deselect “Use group configuration” and paste the file into the content section.  For this .json file example, choose “Json” under the “Content type” pull-down menu.   Note: C-style comments (/* */) are not allowed in .json files.  The default config.json file has comments (/* */) indicating the fields that can be adjusted – adjust the settings as desired then remove the comment lines.  The “Save” option won’t be available until the comment lines are removed.  Once the file is saved, the “Remote Configuration” on the gateway will be synced to the updated “Configuration” file.   This can be seen by looking at the Sync Status column on the “Configurations” screen as shown below.

 


Important: Before performing a BSP software upgrade for the first time on a particular gateway, the “Upgrade Servers” configuration needs to be updated.  

From the “Configuration” tab,  select the pencil icon on the “Upgrade Servers” row.  If a software upgrade has never been performed on a gateway, the “Remote Configuration” will be blank. In this case, in the “Edit Configuration” window, de-select the “Use group configuration” box, and select “Json” as Content type.


Choose from the following text options depending on the type of gateway being upgraded, copy the text and paste  into the content section of the “Edit configuration” window:


For micro gateway copy the following info into the Content section (everything within and including the square brackets:

[{

   "type": "src/gz",

   "name": "bsp",

   "address": "file:///lib/firmware/bsp/"

}, {

   "type": "src/gz",

   "name": "gpio-fpga",

   "address": "file:///lib/firmware/gpio-fpga/"

}]


For macro (no-geolocation) and mega gateways, copy the following info into the Content section (everything within and including the square brackets:


[{

  "type": "src/gz",

   "name": "bsp",

   "address": "file:///lib/firmware/bsp/"

}, {

  "type": "src/gz",

   "name": "fe-fpga",

   "address": "file:///lib/firmware/fe-fpga/"


}, {

  "type": "src/gz",

   "name": "gpio-fpga",

   "address": "file:///lib/firmware/gpio-fpga/"


}]


For geo-location enabled macro gateways copy the following info into the Content section (everything within and including the square brackets:

[{

  "type": "src/gz",

   "name": "bsp",

   "address": "file:///lib/firmware/bsp/"

}, {

  "type": "src/gz",

   "name": "fe-fpga-geo",

   "address": "file:///lib/firmware/fe-fpga-geo/"


}, {

  "type": "src/gz",

   "name": "gpio-fpga",

   "address": "file:///lib/firmware/gpio-fpga/"

}]



2.7 Commands:

By using this tab, user can reboot the gateway and check the ping from the gateway. 




To execute Reboot command, select reboot from the list of available commands and select execute button. This will reboot the gateway. After execute this command, NS will not display any confirmation message. 




To execute ping command, select ping command from the list, then set the number of packets to sent from the gateway and the destination address.




2.8 Backup and Restore:

Backup:

When you select update table under the backup tab, this will list the available backups. If there are no available backups then status says n/a.



Create Backup:

Select create backup icon. Then enter the description for backup. Then select Create button.


Then status will display backup-in-progress message. And also, you can see the backup that is in-progress in the table. Wait at least for a minute then select update table, the status will display ok message if the backup is completed.





Restore:

Go to Backups tab in NS. Then select Update Table to view the available Backups.


Then decide the backup that you want to restore then select the restore icon from the backup list to restore. In this example, I want to restore to Backup 1 from the list.



Once you select restore backup icon, you will see restore:in-progress message.


Wait for at least a minute, then select Update Table button, the status message will display ok message. This means restore is successful. Then reboot the gateway to restore to take effect.

Note: reboot is mandatory after the restore.



2.9 Firewall:

This tab will help user to read and write firewall configuration on the gateway.


Read Firewall Configuration:

Select Read Firewall Configuration button to view the firewall settings from your gateway.




2.10 SW Management:

This tab allows users to read the installed software versions from the gateway, upgrade to new software version and install new software packages. 

Important:  Before performing a software upgrade for the first time on a particular gateway, the “Upgrade Servers” configuration file needs to be updated.  Please refer to section 2.6. 


Read Version:

Short List:

It will display major version of packages installed from the gateway.



Full List:

It will display all the versions of packages and tools installed from the gateway.







2.11 Wireless Modem:

This tab will provide information about cellular connection. The device information tab will provide the IP addresses of the Gateway from available interfaces.



Device Information:




Home Network:




RF Information:



Active profile parameters:



Call Statistics:







2.12 WAN

On this page, the preferred ping address, preferred backhaul link and fallback backhaul link can be specified.  First, use the Preferred and Fallback pull down menus.   Next use the “Set Preferred and Fallback” button to set the preferred and fallback links.  




2.13 File Transfer

The functionality on the File Transfer page is identical to that of the File Transfer function within KonaFT.  Select the “Decompress” check box when uploading BSP software releases in .zip format.  Click “Browse” to select a file to upload from the computer you are accessing the OAM server webpage from.  Click “Upload File” once you have selected the file to upload.  Zip files are uploaded to /dev/shm/ then extracted to /lib/firmware/.  Non-zipped files are uploaded to /dev/shm/.