Skip to content
This repository has been archived by the owner on Oct 25, 2020. It is now read-only.

Collect information about RouterOS's ARP table and emit data and events to Redis.

Notifications You must be signed in to change notification settings

lewiseason/casa-collector-routeros

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

casa-collector-routeros connects to a RouterOS router (using the RouterOS API) and queries its arp table. A list of mac addresses is then stored in the specified Redis instance (as a list, using the key mac-addresses).

If an address appears or disappears in between checks, an event will be emitted on a redis topic (mac-address-online and mac-address-offline respectively). The body of this message will be the MAC address.

Throughout, MAC addresses are represented in the usual xx:xx:xx:xx:xx:xx format.

Installation

pip install casa-collector-routeros

Invocation

Run casa-collector-routeros and the collector will start in the foreground.

Configuration

Is done entirely through environment variables.

Environment variable Description Notes
REDIS_URL The URL of the Redis instance Example: redis://localhost:6379
ROUTER_HOST, ROUTER_USER, ROUTER_PASS The host and credentials of the RouterOS device (which must have its API correctly configured) Using a read-only user is recommended
INTERVAL How frequently (in seconds) the router should be queried Default: 60
LOGLEVEL Log level. Messages are logged to stdout Must be a valid Python log level

About

Collect information about RouterOS's ARP table and emit data and events to Redis.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages