npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

routeros-node

v0.1.0

Published

Routeros API for Node.js

Downloads

286

Readme

Routeros Node

Routeros Node allows users to create custom software solutions to communicate with RouterOS to gather information, adjust configuration and manage router. API closely follows syntax from command line interface (CLI). It can be used to create translated or custom configuration tools to aid ease of use running and managing routers with RouterOS.

To use API RouterOS version 3.x or newer is required. By default API uses port 8728 and service is enabled.

This library requires Routeros version v6.43 and above.

Installation

npm install routeros-node

Making Connection

const { Routeros } = require("routeros-node");

async function run() {
  const routeros = new Routeros({
    host: "127.0.0.1",
    port: 8728,
    user: "admin",
    password: "",
  });

  try {
    // connect to RouterOS
    const conn = await routeros.connect();

    // if connected successfully will return the connected instance/socket,
    console.log("conn===>", conn);

    // after that we can write the query
    const usersHotspot = conn.write(["/ip/hotspot/user/print"]);
    console.log(usersHotspot);
  } catch (error) {
    // if it fails will return an error here
    console.log("error===>", error);
  } finally {
    // dont forget to close connection
    routeros.destroy();
  }
}

run();

We can also use promises:

const { Routeros } = require("routeros-node");

const routeros = new Routeros({
  host: "127.0.0.1",
  port: 8728,
  user: "admin",
  password: "",
});

routeros
  .connect()
  .then((conn) => conn.write(["/ip/hotspot/user/print"]))
  .then((usersHotspot) => {
    console.log(usersHotspot);
  })
  .catch((error) => {
    console.log("error===>", error);
  })
  .finnaly(() => {
    routeros.destroy();
  });

Performing a query

Method write() receives an array, we can put all RouterOS query words into that array. See: https://wiki.mikrotik.com/wiki/Manual:API#Query_word

For example, create a new hotspot user with the name test: write(['/ip/hotspot/user/add', '=name=test']).