mirror of
https://github.com/KevinMidboe/mktxp-no-cli.git
synced 2025-10-29 17:50:23 +00:00
61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Description
|
|
Prometheus Exporter for Mikrotik RouterOS.
|
|
MKTXP enables gathering metrics across multiple RouterOS devices, all easily configurable via built-in CLI interface.
|
|
Comes with a dedicated [Grafana dashboard](https://grafana.com/grafana/dashboards/13679)
|
|
|
|
<img src="http://www.akpdev.com/images/mktxp_b_t.png" width="530" height="620">
|
|
|
|
|
|
#### Requirements:
|
|
- [Python 3.6.x](https://www.python.org/downloads/release/python-360/) or later
|
|
|
|
|
|
- OSs:
|
|
* Linux
|
|
* Mac OSX
|
|
* Windows: TBD / maybe
|
|
|
|
#### Install:
|
|
- from [PyPI](https://pypi.org/project/mktxp/): `$ pip install mktxp`
|
|
- latest from source repository: `$ pip install git+https://github.com/akpw/mktxp`
|
|
|
|
|
|
## Getting started
|
|
Usage: $ mktxp [-h]
|
|
{info, version, show, add, edit, delete, start}
|
|
Commands:
|
|
{info, version, show, add, edit, delete, start}
|
|
|
|
$ mktxp {command} -h #run this for detailed help on individual commands
|
|
|
|
|
|
## Full description of CLI Commands
|
|
### mktxp
|
|
. action commands:
|
|
.. export Starts collecting metrics for all enabled RouterOS configuration entries
|
|
.. print Displays seleted metrics on the command line
|
|
.. info Shows base MKTXP info
|
|
.. edit Open MKTXP configuration file in your editor of choice
|
|
.. add Adds MKTXP RouterOS configuration entry from the command line
|
|
.. show Shows MKTXP configuration entries on the command line
|
|
.. delete Deletes a MKTXP RouterOS configuration entry from the command line
|
|
|
|
|
|
## Installing Development version
|
|
- Clone the repo, then run: `$ python setup.py develop`
|
|
|
|
|
|
**Running Tests**
|
|
- TDB
|
|
- Run via: `$ python setup.py test`
|
|
|
|
|
|
|