{ "info": { "author": "Social WiFi", "author_email": "it@socialwifi.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "RouterOS-api\n============\n\nPython API to RouterBoard devices produced by MikroTik.\n\n[![Build Status](https://travis-ci.org/socialwifi/RouterOS-api.svg?branch=master)](https://travis-ci.org/socialwifi/RouterOS-api)\n[![Latest Version](https://img.shields.io/pypi/v/RouterOS-api.svg)](https://pypi.python.org/pypi/RouterOS-api/)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/RouterOS-api.svg)](https://pypi.python.org/pypi/RouterOS-api/)\n[![Wheel Status](https://img.shields.io/pypi/wheel/RouterOS-api.svg)](https://pypi.python.org/pypi/RouterOS-api/)\n[![License](https://img.shields.io/pypi/l/RouterOS-api.svg)](https://github.com/socialwifi/RouterOS-api/blob/master/LICENSE)\n\n## Welcome to RouterOs Api\n\n![RouterOs Api](https://static.socialwifi.com/cloud/1/images/logo.svg)\n\nPython API to RouterBoard devices produced by MikroTik.\n\n## Usage\n\n### Connection\n\n```python\n#!/usr/bin/python\n\nimport routeros_api\n\nconnection = routeros_api.RouterOsApiPool('IP', username='admin', password='')\napi = connection.get_api()\n```\n\n#### Connect Options\n\n```python\nrouteros_api.RouterOsApiPool(\n host,\n username='admin',\n password='',\n port=8728,\n use_ssl=False,\n ssl_verify=True,\n ssl_verify_hostname=True,\n ssl_context=None,\n)\n```\n\nParameters:\n\n* `host` - String - Hostname or IP of device\n\nOptional Parameters:\n\n* `username` - String - Login username - Default 'admin'\n* `password` - String - Login password - Default empty string\n* `port` - Integer - TCP Port for API - Default 8728 or 8729 when using SSL\n* `plaintext_login` - Boolean - Try plaintext login (for RouterOS 6.43 onwards) - Default **False**\n* `use_ssl` - Boolean - Use SSL or not? - Default **False**\n* `ssl_verify` - Boolean - Verify the SSL certificate? - Default **True**\n* `ssl_verify_hostname` - Boolean - Verify the SSL certificate hostname matches? - Default **True**\n* `ssl_context` - Object - Pass in a custom SSL context object. Overrides other options. - Default **None**\n\n#### Using SSL\n\nIf we want to use SSL, we can simply specify `use_ssl` as `True`:\n\n```python\nconnection = routeros_api.RouterOsApiPool('', username='admin', password='', use_ssl=True)\n```\n\nThis will automatically verify SSL certificate and hostname. \nThe most flexible way to modify SSL parameters is to provide an SSL Context object using the \n`ssl_context` parameter, but for typical use-cases with self-signed certificates, the shorthand options of\n `ssl_verify` and `ssl_verify_hostname` are provided.\n\ne.g. if using a self-signed certificate, you can (but probably shouldn't) use:\n\n```python\nconnection = routeros_api.RouterOsApiPool(\n '',\n username='admin',\n password='',\n use_ssl=True,\n ssl_verify=False,\n ssl_verify_hostname=False,\n)\n```\n\n#### Login for RouterOS v6.43 onwards\n\nRouterOS Versions v6.43 onwards now use a different login method. \nThe disadvantage is that it passes the password in plain text. \nFor security we only attempt the plaintext login if requested using the `plaintext_login` parameter. \nIt is highly recommended only to use this option with SSL enabled.\n\n```python\nrouteros_api.RouterOsApiPool(host, username='admin', password='', plaintext_login=True)\n```\n\n### Execute Commands\n\nCall this with a resource and parameters as name/value pairs.\n\n```python\napi.get_binary_resource('/').call('',{ })\n```\n\n#### Examples\n\n```python\napi.get_binary_resource('/').call('tool/fetch',{ 'url': \"https://dummy.url\" })\napi.get_binary_resource('/').call('ping', { 'address': '192.168.56.1', 'count': '4' })\n```\n\n### Fetch List/Resource\n\n```python\nlist = api.get_resource('/command')\n```\n\n#### Example\n\n```python\nlist_queues = api.get_resource('/queue/simple')\n```\n\n#### Show all elements\n\n```python\nlist_queues.get()\n```\n\n### Add rules\n\n```python\nlist.add(attribute=\"vale\", attribute_n=\"value\")\n```\n\n**NOTE**: Atributes with `-`, like `max-limit` use underscore `_`: `max_limit`\n\n#### Example:\n\n```python\nlist_queues.add(name=\"001\", max_limit=\"512k/4M\", target=\"192.168.10.1/32\")\n```\n\n### Update Values\n\n```python\nlist.set(id, attributes)\n```\n\n#### Example:\n\n```python\nlist_queues.set(id=\"*2\", name=\"jhon\")\n```\n\n### Get element:\n\n```python\nlist.get(attribute=value)\n```\n\n#### Example:\n\n```python\nlist_queues.get(name=\"jhon\")\n```\n\n### Remove element:\n\n```python\nlist.remove(id)\n```\n\n#### Example:\n\n```python\nlist_queues.remove(id=\"*2\")\n```\n\n### Close conection:\n\n```python\nconnection.disconnect()\n```\n\n#### Other Example:\n\n```python\nlist_address = api.get_resource('/ip/firewall/address-list')\nlist_address.add(address=\"192.168.0.1\",comment=\"P1\",list=\"10M\")\n\nlist_address.get(comment=\"P1\")\n\nlist_address.remove(id=\"*7\")\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/socialwifi/RouterOS-api", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "RouterOS-api", "package_url": "https://pypi.org/project/RouterOS-api/", "platform": "", "project_url": "https://pypi.org/project/RouterOS-api/", "project_urls": { "Homepage": "https://github.com/socialwifi/RouterOS-api" }, "release_url": "https://pypi.org/project/RouterOS-api/0.17.0/", "requires_dist": [ "six" ], "requires_python": "", "summary": "Python API to RouterBoard devices produced by MikroTik.", "version": "0.17.0" }, "last_serial": 5880722, "releases": { "0": [ { "comment_text": "", "digests": { "md5": "09999d3e43200ab36ce08fb5206e2339", "sha256": "ae83bf1dbb7c0d3c46b564eb10835145f3751025ce6fae71c54f86770f40a8b3" }, "downloads": -1, "filename": "RouterOS-api-0.tar.gz", "has_sig": false, "md5_digest": "09999d3e43200ab36ce08fb5206e2339", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7405, "upload_time": "2014-07-07T10:19:19", "url": "https://files.pythonhosted.org/packages/9e/b4/06bffeaf0046ae12f77cdfaf6276a345278f800e20431501c21775589eac/RouterOS-api-0.tar.gz" } ], "0.1": [ { "comment_text": "", "digests": { "md5": "e437ebcd1fd52a019976d695b805e370", "sha256": "4123a2025876c3bad7c9c3bb2bcd9535b75d45a82463a6845d3629dfcdd5aa44" }, "downloads": -1, "filename": "RouterOS-api-0.1.tar.gz", "has_sig": false, "md5_digest": "e437ebcd1fd52a019976d695b805e370", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7638, "upload_time": "2014-07-11T09:18:02", "url": "https://files.pythonhosted.org/packages/71/a0/2785e77f521d4a601e85fe91e0a020460f34b05444ab2d2b3bd7fed52b39/RouterOS-api-0.1.tar.gz" } ], "0.10": [ { "comment_text": "", "digests": { "md5": "2726e997a50974230b433665082aef39", "sha256": "c4e7e5e6d4ef5d0e97cf25f3fe5a8a1623578db27e961ce01cfe3e6e01139198" }, "downloads": -1, "filename": "RouterOS-api-0.10.tar.gz", "has_sig": false, "md5_digest": "2726e997a50974230b433665082aef39", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8819, "upload_time": "2015-03-14T10:49:54", "url": "https://files.pythonhosted.org/packages/02/de/b2ebfd8f5e8ba5f16fbbf221a0d10c75272c33c8f195cea4353890a3ce2c/RouterOS-api-0.10.tar.gz" } ], "0.11": [ { "comment_text": "", "digests": { "md5": "374a368bc30b06df9e94751b9e11675f", "sha256": "354924596a49e3663590e651fd1bfbd08f7c85c44d5305f75f1d62f319ca26a2" }, "downloads": -1, "filename": "RouterOS-api-0.11.tar.gz", "has_sig": false, "md5_digest": "374a368bc30b06df9e94751b9e11675f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8784, "upload_time": "2015-04-30T10:45:03", "url": "https://files.pythonhosted.org/packages/ac/57/62ae083f23f2878c79e9e1f9ce960cc81321b3927a78b7e9c69c65379902/RouterOS-api-0.11.tar.gz" } ], "0.12": [ { "comment_text": "", "digests": { "md5": "6de2258a01e47c89aee35ec64ba7be98", "sha256": "bdd87c4a939029bfdb9528c26368819c1f3b0a75df60cf3e2b8950416ce2908e" }, "downloads": -1, "filename": "RouterOS-api-0.12.tar.gz", "has_sig": false, "md5_digest": "6de2258a01e47c89aee35ec64ba7be98", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9386, "upload_time": "2015-05-16T07:01:50", "url": "https://files.pythonhosted.org/packages/b7/b0/235b556038c7b701fbd7fd95b1184bbae4c608f9002adbb2ba08aa21ae06/RouterOS-api-0.12.tar.gz" } ], "0.13": [ { "comment_text": "", "digests": { "md5": "d85ac1319f79f4ad1a3ce0b72cb061e3", "sha256": "1f01c59270d95a199d56e08eca0d15231ce25e8e4b5029c0f2599e8f33d60128" }, "downloads": -1, "filename": "RouterOS-api-0.13.tar.gz", "has_sig": false, "md5_digest": "d85ac1319f79f4ad1a3ce0b72cb061e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9401, "upload_time": "2015-08-12T11:22:28", "url": "https://files.pythonhosted.org/packages/62/d9/0c59e81c9377b66778f6273df2b8aa4d1110be05db6fe013eaa130391117/RouterOS-api-0.13.tar.gz" } ], "0.14": [ { "comment_text": "", "digests": { "md5": "05810902d78e271cbe990418206a9497", "sha256": "19868a0c5b5475da7c1da0c351106e3548cda3214f739ae83c086bd13a2d89d1" }, "downloads": -1, "filename": "RouterOS-api-0.14.tar.gz", "has_sig": false, "md5_digest": "05810902d78e271cbe990418206a9497", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9411, "upload_time": "2016-04-15T12:16:36", "url": "https://files.pythonhosted.org/packages/4b/fc/c0da30bc63353a48c86a8baddaed14be290075b7bd287e63bb935af4a430/RouterOS-api-0.14.tar.gz" } ], "0.15.0": [ { "comment_text": "", "digests": { "md5": "7afdfcc15fab484aaa97c1484e255791", "sha256": "21db2137071c382f075d152333ffe161c451736b4b23279235c64ad32904863a" }, "downloads": -1, "filename": "RouterOS_api-0.15.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7afdfcc15fab484aaa97c1484e255791", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 17948, "upload_time": "2018-08-23T12:46:21", "url": "https://files.pythonhosted.org/packages/29/5a/78e64e4fcc9294203bb14cdc5f97d5493534e2398996c5e40feebdffe866/RouterOS_api-0.15.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "39791080e5a742b80423a78a75b11614", "sha256": "3f4d2d2cd8ed7dc8618f8483f1ee6bb99c4af48b7b557693b5ffad29774336d3" }, "downloads": -1, "filename": "RouterOS-api-0.15.0.tar.gz", "has_sig": false, "md5_digest": "39791080e5a742b80423a78a75b11614", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9207, "upload_time": "2018-08-23T12:46:19", "url": "https://files.pythonhosted.org/packages/de/da/7db7dd3aa8351e9fa421ba357d01e2a7ebda1ab6615adedc17f5e22ec9d1/RouterOS-api-0.15.0.tar.gz" } ], "0.16.0": [ { "comment_text": "", "digests": { "md5": "0dedc1019bc38ab7a2fa3300cea588eb", "sha256": "18a177819e5b0fa42c2cd549357b4f190a330a6112c3b3c9b745e6df33746274" }, "downloads": -1, "filename": "RouterOS_api-0.16.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0dedc1019bc38ab7a2fa3300cea588eb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20095, "upload_time": "2019-09-24T14:25:55", "url": "https://files.pythonhosted.org/packages/93/8d/cfe436b849641afc3dbbc57b493905ddeb77d0126f6cdacdce70493a7506/RouterOS_api-0.16.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4393ec589f94eac50f153b2e4d924448", "sha256": "27adcc48ec6006d13348b4fb1e0e56021cb62d8af49901a70811c03c702f9c32" }, "downloads": -1, "filename": "RouterOS-api-0.16.0.tar.gz", "has_sig": false, "md5_digest": "4393ec589f94eac50f153b2e4d924448", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11369, "upload_time": "2019-09-24T14:25:58", "url": "https://files.pythonhosted.org/packages/10/d9/1985f934346b16f8290e3d1151442800cfb7008138d99b8de2549de38a16/RouterOS-api-0.16.0.tar.gz" } ], "0.17.0": [ { "comment_text": "", "digests": { "md5": "fe35e82ddbb1de9e3c63f8d454aa3d93", "sha256": "bf38da94a570875eaa87ff537558f765a4697dbce1a9753070194b687f441bf0" }, "downloads": -1, "filename": "RouterOS_api-0.17.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fe35e82ddbb1de9e3c63f8d454aa3d93", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20745, "upload_time": "2019-09-24T16:12:21", "url": "https://files.pythonhosted.org/packages/80/fb/e48a4d8316fda97e4e961f5c8476b8aac443825fbacafaa100bbbc8db359/RouterOS_api-0.17.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4e85d0258d6876991969f72ed52ee1bf", "sha256": "1b9898460ecc4667b54e477d495b74c2f24ae0aac4c90dd0e62f23ec7eae8252" }, "downloads": -1, "filename": "RouterOS-api-0.17.0.tar.gz", "has_sig": false, "md5_digest": "4e85d0258d6876991969f72ed52ee1bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12126, "upload_time": "2019-09-24T16:12:23", "url": "https://files.pythonhosted.org/packages/8f/ba/82083e74a915aa5e891be14359ec03bb4e5cf30251c3ca79fb93152b87c5/RouterOS-api-0.17.0.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "690b48c39cf90c7b5a993fc9adca1e14", "sha256": "85cfff6dcb69a9da52a2bb2cca61318c08267c7eea226e70e6671ce6f24ec968" }, "downloads": -1, "filename": "RouterOS-api-0.2.tar.gz", "has_sig": false, "md5_digest": "690b48c39cf90c7b5a993fc9adca1e14", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7771, "upload_time": "2014-07-11T12:53:07", "url": "https://files.pythonhosted.org/packages/83/1f/586796509334cdf6338a73e382dbf484332ed134abf6d51e6c6994d17dd6/RouterOS-api-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "346191442c56e5d7cb5ebf4e32fe48b6", "sha256": "67245b5e5307b55bb5809ce683375c80135335e04ab448052e11ae4e44db974a" }, "downloads": -1, "filename": "RouterOS-api-0.3.tar.gz", "has_sig": false, "md5_digest": "346191442c56e5d7cb5ebf4e32fe48b6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7681, "upload_time": "2014-07-31T10:42:00", "url": "https://files.pythonhosted.org/packages/28/d7/5b43ab8b19d57045ac64295567aa225760f0197459ad0d5d25b43425a6f8/RouterOS-api-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "cc48b50ac878168c18b95132ffd3a67b", "sha256": "c4ca7bb0e345e9f8a58b440328ba5fbf686caf2ba772b178c61038e255b4e523" }, "downloads": -1, "filename": "RouterOS-api-0.4.tar.gz", "has_sig": false, "md5_digest": "cc48b50ac878168c18b95132ffd3a67b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7956, "upload_time": "2014-08-01T07:55:25", "url": "https://files.pythonhosted.org/packages/2e/09/8841ef669cb07090ff56f62be868253a46c5057dfb8323e3b723d2acefc6/RouterOS-api-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "3ec93f69aabb31360fac05ad1a4c4409", "sha256": "ec568001a4bc453c7d18ba1c639ebef127a0c5a5300346a10a5fe64f72f97ae9" }, "downloads": -1, "filename": "RouterOS-api-0.5.tar.gz", "has_sig": false, "md5_digest": "3ec93f69aabb31360fac05ad1a4c4409", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8659, "upload_time": "2014-09-01T10:22:31", "url": "https://files.pythonhosted.org/packages/3b/01/eca6d159fbe072d9b013e3ceb230caf01785196775802fedf6482e3ed0dd/RouterOS-api-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "8ea212cae96faf73f0ff21d57fa9a773", "sha256": "683ae5012cde546ef62f27cf1d2b710ee93395427201e551ef6cc2b22632490a" }, "downloads": -1, "filename": "RouterOS-api-0.6.tar.gz", "has_sig": false, "md5_digest": "8ea212cae96faf73f0ff21d57fa9a773", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8698, "upload_time": "2014-09-23T13:30:17", "url": "https://files.pythonhosted.org/packages/9d/8f/735e11ea55591c0517dcfec92f516e24347ae27c19e97d9efe4a51526722/RouterOS-api-0.6.tar.gz" } ], "0.7": [ { "comment_text": "", "digests": { "md5": "73384fc4cef0df6271f655ec4b5392d3", "sha256": "e4e358ccc69cbb10db0bc7b1486c162d1a49d99bee931596bab181289c22fb29" }, "downloads": -1, "filename": "RouterOS-api-0.7.tar.gz", "has_sig": false, "md5_digest": "73384fc4cef0df6271f655ec4b5392d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8876, "upload_time": "2014-10-07T15:08:23", "url": "https://files.pythonhosted.org/packages/11/68/b3352d536b3d5a430f6c781b6c6c903ec0a7ebccae7fd9fe091c25a169a1/RouterOS-api-0.7.tar.gz" } ], "0.8": [ { "comment_text": "", "digests": { "md5": "0c85f88d9ea7459b5644d055409ec2aa", "sha256": "3f674125b1d7fc4348e0613139b466894db3e412fb2e2456e2f80c9064d0d07a" }, "downloads": -1, "filename": "RouterOS-api-0.8.tar.gz", "has_sig": false, "md5_digest": "0c85f88d9ea7459b5644d055409ec2aa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9119, "upload_time": "2014-10-27T09:37:54", "url": "https://files.pythonhosted.org/packages/fb/f0/52e4d9fb5419fa8f9c236336440f06e55173995b5dcd731ba8bc9c5dbea9/RouterOS-api-0.8.tar.gz" } ], "0.9": [ { "comment_text": "", "digests": { "md5": "be201292016a04b271623bb8ff7591f3", "sha256": "70ce017cc993697d7c3a433821831b8339035bf0082f6ea1d943feb3b54eed42" }, "downloads": -1, "filename": "RouterOS-api-0.9.tar.gz", "has_sig": false, "md5_digest": "be201292016a04b271623bb8ff7591f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9124, "upload_time": "2014-11-04T08:50:54", "url": "https://files.pythonhosted.org/packages/f2/23/c2e794ff55fa0a81f8716ad2a8a68eb63804040895cf63ff49dd2eacd319/RouterOS-api-0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fe35e82ddbb1de9e3c63f8d454aa3d93", "sha256": "bf38da94a570875eaa87ff537558f765a4697dbce1a9753070194b687f441bf0" }, "downloads": -1, "filename": "RouterOS_api-0.17.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fe35e82ddbb1de9e3c63f8d454aa3d93", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20745, "upload_time": "2019-09-24T16:12:21", "url": "https://files.pythonhosted.org/packages/80/fb/e48a4d8316fda97e4e961f5c8476b8aac443825fbacafaa100bbbc8db359/RouterOS_api-0.17.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4e85d0258d6876991969f72ed52ee1bf", "sha256": "1b9898460ecc4667b54e477d495b74c2f24ae0aac4c90dd0e62f23ec7eae8252" }, "downloads": -1, "filename": "RouterOS-api-0.17.0.tar.gz", "has_sig": false, "md5_digest": "4e85d0258d6876991969f72ed52ee1bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12126, "upload_time": "2019-09-24T16:12:23", "url": "https://files.pythonhosted.org/packages/8f/ba/82083e74a915aa5e891be14359ec03bb4e5cf30251c3ca79fb93152b87c5/RouterOS-api-0.17.0.tar.gz" } ] }