Skip to content

About

Mikrotik Plugin for Cacti

Topics

Resources

Stars

67 stars

Watchers

16 watching

Forks

Latest commit

 

History

639 Commits

Folders and files

Repository files navigation

MikroTik

This plugin provides support for the MikroTik RouterOS available from MikroTik and other router and switch hardware suppliers. It is not a replacement for MikroTik's GUI interface, but provides nice Cacti Graphs for multiple MikroTik features including, but not limited to:

  • Automatic Discovery of Cacti Devices that are MikroTik's

  • Enhanced Traffic Graphs

  • Graphs of Wireless and PPPoE Users

  • Table views of Wireless and PPPoE User utilization

  • Graphs of MikroTik environmental data such as temperature and voltage

  • Viewing of Devices and summary statistics, Users, Queue Trees, Access Points, HotSpots, Interfaces, Wireless Station, and Health (sensor) information

Versions and compatibility

This README describes the develop source branch.

Code Plugin version Minimum Cacti declared in INFO
Source branch 3.4 1.2.29
Published v3.1 3.1 1.2.24

Use the published release’s assets and tagged documentation when installing that package. Branch code can include later changes, even when its version number matches the release. Cacti’s own PHP and database requirements also apply.

Install this plugin in <cacti-root>/plugins/mikrotik, using the directory name mikrotik rather than plugin_mikrotik.

See CHANGELOG.md for the version history.

Cacti compatibility

If you are running a version of Cacti below 1.2.31, please add the function below to the applySkin() function in include/layout.js to enable the Cancel buttons on forms to work:

$(document).off('click.cactiReturnTo', '.cactiReturnTo')
    .on('click.cactiReturnTo', '.cactiReturnTo', function(event) {
        event.preventDefault();
        cactiReturnTo($(this).attr('data-url'));
    });

Installation

Just like any other Cacti plugin, untar the package to the Cacti plugins directory, rename the directory to 'mikrotik', and then from Cacti's Plugin Management interface, Install and Enable the plugin.

With this version of MikroTik, we are also including a Device Template Cacti Package that includes everything you need to create all the included Cacti Graphs for this device type. To import that package, you must use the Cacti 'import_package.php' CLI script. The MikroTik package is included in the 'templates' sub-directory of the MikroTik plugin.

Once this is done, you have to configure the mikrotik plugin under Cacti's Console Settings option, and then select the 'Mikrotik' tab. From there, you can enable the MikroTik data collection, set the level of parallelization, and the various collection frequencies for all of the items that the MikroTik will poll over time.

MikroTik's 'auto-discovery' feature will look for Cacti devices that are MikroTiks and recognize them as such. If you are using a different Cacti Device Template for these Devices, you may want to change them to user the new Cacti Device Template made exclusively for the MikroTik devices.

Device credentials

Each MikroTik device has a 'MikroTik Credentials' section on its Cacti Device edit page. Provide a read only RouterOS user ('Read Only User') and its password. The 'SSL' option connects to the RouterOS API over api-ssl (port 8729) instead of the plain API port. It is only selectable when the api-ssl service is enabled on the device (IP > Services).

Retention settings

Under Console > Settings > MikroTik, the 'DHCP/DNS/List Settings' section sets how long 'DHCP Retention', 'DNS Retention', and 'Address List Retention' history is kept.

Permissions

The plugin registers two realms that can be assigned to users or groups:

  • MikroTik Viewer - access to the MikroTik viewing pages.

  • MikroTik Admin - access to the MikroTik user management pages.

Bugs and Feature Enhancements

Bug and feature enhancements for the MikroTik plugin are handled in GitHub. If you find a first search the Cacti forums for a solution before creating an issue in GitHub.


Copyright (c) 2004-2026 - The Cacti Group, Inc.

About

Mikrotik Plugin for Cacti

Topics

Resources

Stars

67 stars

Watchers

16 watching

Forks

Releases

Packages

Used by

Contributors

Languages