Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python API to RouterBoard devices produced by MikroTik.

Project description

RouterOS-api

Python API to RouterBoard devices produced by MikroTik.

Build Status Latest Version Supported Python versions Wheel Status License

Welcome to RouterOs Api

RouterOs Api

Python API to RouterBoard devices produced by MikroTik.

Usage

Connection

#!/usr/bin/python

import routeros_api

connection = routeros_api.RouterOsApiPool('IP', username='admin', password='')
api = connection.get_api()

Connect Options

routeros_api.RouterOsApiPool(
    host,
    username='admin',
    password='',
    port=8728,
    use_ssl=False,
    ssl_verify=True,
    ssl_verify_hostname=True,
    ssl_context=None,
)

Parameters:

  • host - String - Hostname or IP of device

Optional Parameters:

  • username - String - Login username - Default 'admin'
  • password - String - Login password - Default empty string
  • port - Integer - TCP Port for API - Default 8728 or 8729 when using SSL
  • plaintext_login - Boolean - Try plaintext login (for RouterOS 6.43 onwards) - Default False
  • use_ssl - Boolean - Use SSL or not? - Default False
  • ssl_verify - Boolean - Verify the SSL certificate? - Default True
  • ssl_verify_hostname - Boolean - Verify the SSL certificate hostname matches? - Default True
  • ssl_context - Object - Pass in a custom SSL context object. Overrides other options. - Default None

Using SSL

If we want to use SSL, we can simply specify use_ssl as True:

connection = routeros_api.RouterOsApiPool('<IP>', username='admin', password='', use_ssl=True)

This will automatically verify SSL certificate and hostname. The most flexible way to modify SSL parameters is to provide an SSL Context object using the ssl_context parameter, but for typical use-cases with self-signed certificates, the shorthand options of ssl_verify and ssl_verify_hostname are provided.

e.g. if using a self-signed certificate, you can (but probably shouldn't) use:

connection = routeros_api.RouterOsApiPool(
    '<IP>',
    username='admin',
    password='',
    use_ssl=True,
    ssl_verify=False,
    ssl_verify_hostname=False,
)

Login for RouterOS v6.43 onwards

RouterOS Versions v6.43 onwards now use a different login method. The disadvantage is that it passes the password in plain text. For security we only attempt the plaintext login if requested using the plaintext_login parameter. It is highly recommended only to use this option with SSL enabled.

routeros_api.RouterOsApiPool(host, username='admin', password='', plaintext_login=True)

Execute Commands

Call this with a resource and parameters as name/value pairs.

api.get_binary_resource('/').call('<resource>',{ <dict of params> })

Examples

api.get_binary_resource('/').call('tool/fetch',{ 'url': "https://dummy.url" })
api.get_binary_resource('/').call('ping', { 'address': '192.168.56.1', 'count': '4' })

Fetch List/Resource

list = api.get_resource('/command')

Example

list_queues = api.get_resource('/queue/simple')

Show all elements

list_queues.get()

Add rules

list.add(attribute="vale", attribute_n="value")

NOTE: Atributes with -, like max-limit use underscore _: max_limit

Example:

list_queues.add(name="001", max_limit="512k/4M", target="192.168.10.1/32")

Update Values

list.set(id, attributes)

Example:

list_queues.set(id="*2", name="jhon")

Get element:

list.get(attribute=value)

Example:

list_queues.get(name="jhon")

Remove element:

list.remove(id)

Example:

list_queues.remove(id="*2")

Close conection:

connection.disconnect()

Other Example:

list_address =  api.get_resource('/ip/firewall/address-list')
list_address.add(address="192.168.0.1",comment="P1",list="10M")

list_address.get(comment="P1")

list_address.remove(id="*7")

Project details


Download files

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

Files for RouterOS-api, version 0.17.0
Filename, size File type Python version Upload date Hashes
Filename, size RouterOS_api-0.17.0-py2.py3-none-any.whl (20.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size RouterOS-api-0.17.0.tar.gz (12.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page