ispapp / ispapp-routeros-client

The Official ISPApp Client for RouterOS
MIT License
8 stars 4 forks source link

ISPApp Logo

Learn more at https://ispapp.co

Watch a YouTube Video about how ISPApp can help you - https://www.youtube.com/watch?v=BQN8FdMqApo

about

This is an ISPApp client which is designed to monitor Mikrotik hosts running RouterOS.

ISPApp allows you to monitor thousands of hosts or IoT devices quickly and easily with high resolution charts and realtime data.

It will automatically monitor a host when this script is ran on that host and send ISPApp data to generate realtime, daily, weekly, monthly and annual charts for:

ISPApp also provides outage notifications and maintenance/degradation analysis for each of the monitored data types.

We have ISPApp Instances running with tens of thousands of charts and are ready for you to be a customer.

ISPApp Instances are private, once we are out of Beta we will not have access to your Data like Google and Facebook do.

installation

  1. Download the ispapp.rsc file
  2. Modify the topDomain and topKey declarations at the top of the script for your ISPApp instance
  3. Copy the contents of the file and paste it into the RouterOS command line or upload the file to the RouterOS device and run /import ispapp.rsc

That's all, you will now see the host in ISPApp.

Setting changes on the routers

The ISPApp RouterOS client script modifies the following settings on the routers:

modification

Modify the script in winbox, and once you have made the changes you need to ssh to the device and run:

/system script export terse

Copy the exported data and paste it to a text editor between where /system script and /system schedule exists in the current version of the script.

You will need to modify part of the globalScript before commiting new changes because that is where the topN global variables are persistently stored.

RouterOS does not store environment variables or files with reboot or upgrade persistence.

Change the section that looks like this:

    \n:set \$topKey (\"ghsfhfgsjhnadfgasdjflashgjkladfhjkgasdgsdfgsdfgsdfgsdfg\");\r\
    \n:set \$topDomain (\"dev.ispapp.co\");\r\
    \n:set \$topClientInfo (\"RouterOS-v0.23\");\r\
    \n:set \$topListenerPort (\"8550\");\r\
    \n:set \$topServerPort (\"443\");\r\
    \n:set \$topSmtpPort (\"465\");\r\

To:

    \n:set \$topKey (\"$topKey\");\r\
    \n:set \$topDomain (\"$topDomain\");\r\
    \n:set \$topClientInfo (\"$topClientInfo\");\r\
    \n:set \$topListenerPort (\"$topListenerPort\");\r\
    \n:set \$topServerPort (\"$topServerPort\");\r\
    \n:set \$topSmtpPort (\"$topSmtpPort\");\r\

This will allow the script to again be copied and pasted without trouble. Also make sure to remove any scripts from the /system script export that aren't part of ispapp-routeros-client.

license

The project ispapp-routeros-client is licensed per the MIT License

A copy is in the project directory, as a file named LICENSE