Skip to main content

Network Devices

See and manage routers, switches and access points over SNMP and router APIs.

NetworkingSourceAPIChangelog
  • Works with any SNMP device, MikroTik RouterOS, OPNsense, OpenWrt, UniFi, pfSense and Cisco IOS
  • Ports with link state, speed, traffic rates, errors and PoE
  • Clients from DHCP, ARP, Wi-Fi and switch MAC tables
  • Neighbors from LLDP and MikroTik discovery
  • Alerts when a device or a watched port goes down
  • Save device configurations on a schedule, compare versions and get an alert when one changes
  • Reboot a device, turn a port off or on, and power cycle PoE

Network Devices lets you see and manage routers, switches and access points from Termix. It reads them on a timer, shows their ports and clients, and tells you when one goes down.

Supported devices​

TypeHow Termix talks to itWhat it can do
SNMP deviceSNMP v1, v2c or v3Ports, traffic, VLANs, PoE, MAC table, ARP, LLDP. Turn ports off or on, cycle PoE
MikroTik RouterOSThe v7 REST APIPorts, PoE, DHCP leases, ARP, Wi-Fi clients, neighbors. Turn ports off or on, restart
OPNsenseThe API with a key and secretInterfaces, ARP, DHCP leases. Restart
OpenWrtubus over the web interfaceInterfaces, DHCP leases, Wi-Fi clients. Restart
UniFi NetworkThe controller's APIPorts of every adopted switch, PoE, wired and Wi-Fi clients, LLDP. Cycle PoE
pfSenseThe REST API package (v2)Interfaces, ARP, DHCP leases. Restart
Cisco IOSSSH, show commandsInterfaces, MAC table, ARP, CDP neighbors. Turn ports off or on

All but SNMP can also save the device's configuration, see Configuration backups.

Termix reaches the device from the server, so the server must be able to connect to it. Turning on a feature on the device is up to you: SNMP, the REST API and so on.

Add a device​

  1. Open the Network tab from the sidebar and press Add device.
  2. Pick the type, give it a name and enter its address.
  3. Enter the keys (see below) and press Test.
  4. Save. Termix reads the device right away and then every minute, or whatever you set.

Keys are stored encrypted on the server and are never shown again. To replace them, edit the device and fill in the fields. Leave them empty to keep the saved ones.

Keys for each type​

  • SNMP v1 and v2c: the read community. Add a write community only if you want to turn ports off or cycle PoE.
  • SNMP v3: the user name, and the authentication and privacy protocols and keys the device is set up with.
  • RouterOS: a user with the REST API allowed. A read only group is enough to watch. Changing a port or restarting needs a group that can write. Turn on the www-ssl service, or www and pick http.
  • OPNsense: an API key and secret made under System, Access, Users.
  • OpenWrt: a user that can log in to LuCI, with rpcd and, for Wi-Fi clients, rpcd-mod-iwinfo installed.
  • UniFi: a local admin of the UniFi Network application (not a UI.com cloud login), or an API key on UniFi OS. Works with a UDM, Cloud Key or UniFi OS Server on port 443, and a self-hosted controller on port 8443. Set Site when it is not default.
  • pfSense: install the REST API package (pfSense-pkg-RESTAPI) and use an API key, or a user and password. Saving the configuration uses pfSense's own XML-RPC, which needs a user and password with the XML-RPC privilege.
  • Cisco IOS and IOS-XE: an SSH login. Add the enable password when the login does not get privilege 15. To check the device's host key, paste its SHA256 fingerprint (ssh-keygen -lf prints it). Without one, any key is accepted.

Devices on a private network are fine. If the web page uses a certificate from your own CA, paste the CA (or the device certificate) in the device form, and Termix will trust it for that device only.

Find devices​

On the Network tab, press Find devices. Enter a range like 192.168.1.0/24 (up to 256 addresses) and a community. Devices that answer are listed, and Add fills in the form for you.

Ports, clients and neighbors​

Open a device to see:

  • Ports with link state, speed, VLAN, traffic in and out, errors and PoE. Traffic needs two readings to show.
  • Clients with their IP, MAC and where they are. This comes from DHCP, ARP, Wi-Fi and the switch MAC table, depending on the type.
  • Neighbors the device sees over LLDP, or MikroTik discovery.

PoE on SNMP devices is matched to ports by number, which is how most switches number them. If a switch numbers PoE differently, the PoE column may not line up.

Alerts​

Termix alerts the person who added the device when it stops answering (after two failed reads) and when it comes back. Use the bell on a port to get an alert when that port's link goes up or down. Alerts go through the Alerts plugin like any other.

Configuration backups​

For RouterOS, OPNsense, OpenWrt, UniFi, pfSense and Cisco, Termix can keep the device's configuration:

  • RouterOS: /export, with passwords hidden as RouterOS does by default.
  • OPNsense: the whole config.xml, like System, Configuration, Backups.
  • OpenWrt: every UCI config the login may read, as JSON.
  • UniFi: the site's settings, networks, Wi-Fi, port profiles, port forwards, firewall rules and routes, as JSON.
  • pfSense: the main parts of config.xml.
  • Cisco: show running-config.

In the device form, set Save the configuration to every day or every week, and how many versions to keep. Open the device and pick Configs to see the saved versions, press Save now, or open one to read it, compare it with another and download it. A new version is only kept when the configuration changed, and you can get an alert when it does. Saved configurations are stored encrypted and need the Manage network devices permission.

Changing things​

Turning a port off, cycling PoE and restarting a device need the Manage network devices permission, which admins have by default. Each one asks you to confirm. They are also available as actions, so rules, the CLI, the assistant and Operations Center can run them.

Limits​

  • Termix only reads and changes ports, PoE and restarts. It does not edit VLANs, DHCP or firewall rules.
  • OPNsense, OpenWrt, UniFi and pfSense were written from their API docs and have not been tried on real hardware yet. Cisco was tested against a simulated IOS shell.
  • Termix does not restore a configuration. Download it and load it on the device yourself.