README

   1 librouteros
   2 ===========
   3
   4   librouteros is a library to communicate with RouterOS, the operating system
   5 of MikroTik's RouterBoards. It uses the “API port” provided by those systems to
   6 connect and talk to the devices. librouteros is a low-level library in that it
   7 abstracts the network protocol used but has next to no knowledge about the
   8 commands and responses available. Should such an high-level interface prove
   9 useful, it will be added as the need arises.
  10
  11
  12 Dependencies
  13 ------------
  14
  15   The RouterOS API uses a simple challenge-response authentication schema using
  16 cryptographically secure MD5 hashes. The library used for MD5 computation is
  17 “gcrypt”, a cryptographic library originally written for the GnuPG project.
  18
  19
  20 Enabling API connections
  21 ------------------------
  22
  23   API connections (sometimes also called “Winbox connections”) must be
  24 explicitly enabled. To do so, issue the following command:
  25
  26   /ip service enable api
  27
  28 To allow a specific user / group to use the API, the “winbox” item must be
  29 added to the user's “policy” in “/user group”.
  30
  31
  32 Contact
  33 -------
  34
  35   There's currently no mailing list available for librouteros. In case of
  36 questions, suggestions and feedback in general, please contact the author
  37 directly (see “Author” below).
  38
  39
  40 License
  41 -------
  42
  43   librouteros is licensed under the terms of the GNU General Public License,
  44 version 2 (GPLv2).
  45
  46
  47 See also
  48 --------
  49
  50   Information about MikroTik and RouterOS can be found on MikroTik's homepage,
  51 <http://www.mikrotik.com/>. The API documentation used to write this library is
  52 available from <http://wiki.mikrotik.com/wiki/API>.
  53
  54
  55 Author
  56 ------
  57
  58   librouteros was originally written in 2009 by Florian Forster.
  59 <octo at verplant.org> and released under the terms of the General Public
  60 License, version 2 (GPLv2).
  61
  62 Additional contributors are listed in the file called `AUTHORS'.