What Ferrule watches¶
What Ferrule can read today, and how to ask for more.
Today¶
| What | How Ferrule reads it | Setup guide |
|---|---|---|
| UniFi Network: gateways, switches, access points, cable modems | The console's API key and a local read-only admin | UniFi Network |
| UniFi Protect: the recorder, its disks, cameras | The same, on the console or UNVR running Protect | UniFi Protect |
| Proxmox VE, with Ceph | A read-only API token | Proxmox VE |
| Proxmox Backup Server | A read-only API token | PBS |
| VMware vCenter, and the ESXi hosts it manages | A read-only user | vCenter |
| Synology DSM | A user in the administrators group with no app or folder access | Synology |
| QNAP | SNMPv3 | QNAP |
| TrueNAS | A read-only API key | TrueNAS |
| Up-checks: anything with an address, from any maker | Ping, HTTP or a TCP port. Ferrule says when it goes down, and how quickly it answers | Up-checks |
| Managed switches from any maker (Cisco, Juniper, Aruba, HPE, MikroTik, Netgear and others): ports, speed, duplex and errors, temperatures and fans where reported, LLDP neighbours | SNMPv2c or SNMPv3, read-only | SNMP switches |
| UPSes with a network card that answers UPS-MIB: battery, runtime, load, on battery or mains | SNMPv2c or SNMPv3, read-only | UPS |
| Servers with a management controller (Dell iDRAC, HPE iLO, Supermicro, Lenovo XCC and others): overall health, temperatures, fans, power supplies, drives and power drawn | Redfish, with a read-only BMC account | Servers (Redfish) |
| Rack PDUs from APC, Raritan and Eaton: draw against the rating, banks, and each outlet's state and draw (next release) | SNMPv2c or SNMPv3, read-only, over each maker's own MIB | PDUs |
| IPAM and DCIM: phpIPAM's subnets, and NetBox's prefixes, racks and PDU outlets (next release) | A read-only API token | IPAM and DCIM |
Switches, UPSes and servers are read through open standards, so one piece of Ferrule covers gear from many makers. They're free in every edition. PDUs have no open standard, so each maker's own table is read: APC, Raritan and Eaton for now. They're free in every edition too; phpIPAM and NetBox are read on every edition, and used by capacity planning's add-host check, which is paid.
Something else?¶
If your gear isn't listed, please ask for it on GitHub. If someone has already asked, add a 👍 to their request instead: requests decide what's built next. Offering to share a capture from your device, or to test a build, moves it up the list.
Gear Ferrule doesn't read is simply not watched. It never stops Ferrule reading everything else.