Skip to main content

Implementation of Mikrotik API

Project description

RouterOS

Build Status

RouterOS is a API client for Mikrotik RouterOS.

How can I install it?

$ pip install routeros 

The usage of a virtualenv is recommended.

How to use it?

In [1]: from routeros import login

In [2]: routeros = login('user', 'password', '10.1.0.1')

In [3]: routeros('/ip/pool/print')
Out[3]: 
({'.id': '*1', 'name': 'dhcp', 'ranges': '192.168.88.10-192.168.88.254'},
 {'.id': '*2', 'name': 'hs-pool-8', 'ranges': '10.5.50.2-10.5.50.254'})

In [4]: routeros.close()

In [5]: 

Also can use query

Query can consult specific attributes on routeros.

Methods:

  • query.has(*args)
  • query.hasnot(*args)
  • query.equal(**kwargs)
  • query.lower(**kwargs)
  • query.greater(**kwargs)
In [1]: from routeros import login

In [2]: routeros = login('user', 'password', '10.1.0.1')

In [3]: routeros.query('/ip/pool/print').equal(name='dhcp')
Out[3]: ({'.id': '*1', 'name': 'dhcp', 'ranges': '192.168.88.10-192.168.88.254'},)

In [4]: routeros.close()

In [5]: 

How to use non-default (8728) API port for login, such as 9999

routeros = login('user', 'password', '10.1.0.1', 9999)

How to use pre-v6.43 login method

routeros = login('user', 'password', '10.1.0.1', 8728, True)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

routeros-0.1.1.tar.gz (5.8 kB view hashes)

Uploaded source

Built Distribution

routeros-0.1.1-py2.py3-none-any.whl (6.6 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page