Frequently Asked Questions

Quick answers about installation, discovery, features, licensing, and troubleshooting.

Getting Started

What operating systems does Osprey support?
Osprey runs on Linux (amd64). Debian packages are available for Debian 12 (Bookworm), Debian 13 (Trixie), and Ubuntu 24.04 LTS.
What are the minimum system requirements?
2 GB RAM minimum (4 GB recommended), a Linux server with amd64 architecture, and network access to your routers via GRE tunnels or SNMP. PostgreSQL 15+ is required and installed automatically by the package.
How do I install Osprey?
Add the APT repository at deb.wijnberg.net, then run sudo apt install osprey. The package automatically configures PostgreSQL, NATS, nginx, TLS certificates, and all Osprey services. See the download page for step-by-step instructions.
What are the default login credentials?
Username admin, password admin. On first login, you are required to change the default password before accessing any other feature.
Does the installer configure everything automatically?
Yes. The Debian package installs all dependencies (PostgreSQL, nginx, message bus), creates the database, generates TLS certificates and secrets, runs migrations, and starts all services. You can log in immediately after installation.

Topology Discovery

What is the difference between GRE and SNMP discovery?
GRE tunnel discovery forms a real IGP adjacency (OSPF or IS-IS) — Osprey receives the full LSDB or LSP database and sees changes in real time as they happen. SNMP discovery polls routers at intervals to walk the OSPF-MIB, OSPFv3-MIB, or ISIS-MIB tables. GRE gives instant updates; SNMP requires no tunnel configuration on the router side.
Does Osprey inject routes into my network?
No. Osprey is strictly passive. Even with GRE tunnels, OSPF cost is set high (default 1000) and priority is set to zero, so Osprey never becomes a designated router. IS-IS GRE tunnels use the maximum wide metric (16777215) to prevent transit use. BGP visibility is purely receive-only via BMP (RFC 7854).
Can I use both GRE and SNMP on the same area?
Yes. An area can have both a GRE collector and an SNMP collector running simultaneously. This is useful for combining real-time GRE updates with SNMP-based traffic statistics.
Can Osprey discover my entire network from a single router?
With SNMP discovery, yes — enable the "Crawl ABRs" option on a seed device and Osprey will automatically discover OSPF neighbors across your network. With GRE, you need one tunnel per area.
Which routing protocols are supported?
OSPFv2 (IPv4), OSPFv3 (IPv6, including RFC 5838 IPv4 address family extensions), IS-IS (ISO 10589, both L1 and L2), and BGP (via BMP, RFC 7854). A single device that runs both OSPF and IS-IS is automatically correlated across protocols. When multiple protocols share a physical link, edges merge on the canvas with a per-protocol tab view.
Does Osprey support IS-IS?
Yes. IS-IS discovery works via GRE (real adjacency using NET addressing) or SNMP (ISIS-MIB, RFC 4444, with Cisco ISIS-MIB fallback for older IOS). Level 1, Level 2, and L1/L2 routers are fully supported, with wide metrics (up to 16,777,215) by default. SR-MPLS label stack extraction is available for IS-IS IPv4/IPv6 paths via TLV 242.
Does Osprey monitor BGP?
Yes, passively via BMP (BGP Monitoring Protocol, RFC 7854). Your routers push peer state and RIB updates to Osprey's BMP server on TCP port 11019 — no polling. Osprey supports loc_rib (router's best paths), adj_rib_in_post (all received routes post-policy), and peer-monitoring-only modes. BGP routes can be searched with exact, longest-match, or covered prefix modes, and ECMP analysis is built in.
Does Osprey discover Layer 2?
Yes. LLDP and CDP neighbors are auto-discovered via SNMP walks. Osprey correlates L2 neighbors against the L3 topology using a 5-tier identity cascade (chassis ID, mgmt IP, router ID, interface IP, hostname). A toggleable L2 overlay shows switches and Layer 2 links on the canvas alongside the IGP topology. Switch crawling uses BFS with platform-based filtering to exclude APs, phones, and fabric interconnects.
Which SNMP versions are supported?
SNMPv2c and SNMPv3. For v3, all security levels are supported: noAuthNoPriv, authNoPriv, and authPriv with MD5/SHA authentication and DES/AES encryption.

Features

What is time-travel?
Time-travel lets you scrub back through topology history using a timeline slider. You can see exactly what your network looked like at any point — which devices were up, which links were active, and what the OSPF metrics were. Useful for post-incident analysis.
What diagnostics does Osprey provide?
Topology Health, IP Conflicts (duplicate router IDs / IPs / prefixes / external conflicts), Single Points of Failure (articulation points and bridge links), Routing Stability (flapping links and unstable devices), Congestion Trend, Timer Consistency (OSPF and IS-IS), MTU Mismatch, OSPF Best Practices, and Dependency Impact (Peer AS, Critical Pairs, SRLG failure impact). All reports are searchable, sortable, and exportable to CSV.
What is Engineering Mode?
Engineering Mode is Osprey's what-if simulation. You can fail links and nodes, change IGP metrics, add hypothetical routers and links, and model SRLG failure groups — all without touching your production network. SPF is recomputed server-side using RFC 2328-correct multi-area Dijkstra (OSPF) or ISO 10589-correct multi-level Dijkstra (IS-IS). Batch assessment iterates every link or node to find your most critical failure points. Scenarios can be saved and reloaded, and the mode combines with time travel to replay past outages with proposed fixes applied.
Can I export the topology?
Yes. Osprey exports to Visio (.vsdx), SVG, and PNG formats. You can also upload custom icon packs to use vendor-specific device icons in your exports.
How does alerting work?
Osprey generates alerts for topology changes (device up/down, link changes, metric changes) and correlates related events into incidents. For example, if a router goes down and takes five links with it, you see one incident instead of six separate alerts.
Can I SSH into devices from Osprey?
Yes. Osprey includes a browser-based SSH and telnet terminal. Right-click any device on the canvas to open a terminal session directly.
Does Osprey monitor traffic and bandwidth?
Yes, via SNMP polling. Osprey collects interface statistics (traffic, errors, utilization) and displays them on the topology canvas. Links can be color-coded by utilization level.

Licensing

Is there a free version?
Yes. The free evaluation license supports up to 32 devices with all features enabled and no time limit. No credit card required.
How is Osprey licensed for production use?
Beyond the free evaluation, production deployments use a paid license sized to your network. Email sales@wijnberg.net for licensing options and terms.
What counts as a "device"?
A device is any router that appears in your topology — discovered via OSPF, IS-IS, BGP, or SNMP. Each unique router (identified by router ID or IS-IS system ID) counts as one device. Layer 2-only switches discovered via LLDP/CDP do not count against the license.
What happens when the free tier limit is exceeded?
Osprey continues to discover and display your topology, but devices beyond the 32-device limit are shown with a license warning. All features remain functional during evaluation.
Is there an Enterprise option?
Yes. Enterprise licensing offers custom terms, multi-tenant support, and volume licensing. Email sales@wijnberg.net for details.

Deployment & Architecture

What services does Osprey run?
Five systemd services: the engine (topology processing, SPF, event correlation), the API server (REST API, WebSocket, SSH proxy), the collector manager (GRE tunnels and IGP adjacencies), the SNMP poller (discovery, traffic counters, L2 crawling), and the BMP server (BGP peers and RIBs on TCP 11019). Inter-service messaging is via NATS. All services are managed as a single group via osprey.target.
Where is data stored?
All data is stored in PostgreSQL on your server. Osprey is entirely self-hosted — no data leaves your infrastructure.
How do I back up Osprey?
Osprey provides a full database backup and restore feature under Administration. You can also export a portable configuration backup that includes all hierarchy definitions, users, and settings.
Does Osprey work with any vendor's routers?
Yes. Osprey is vendor-agnostic — it works with any device that speaks OSPF, IS-IS, BGP (BMP), LLDP, or CDP. This includes Cisco, Juniper, Arista, Nokia, Mikrotik, and effectively any modern networking platform.
How do I update Osprey?
If installed via APT, simply run sudo apt update && sudo apt upgrade osprey. The package handles database migrations and service restarts automatically.

Troubleshooting

I can't log in — what should I check?
Verify you're using HTTPS (not HTTP), that cookies are enabled in your browser, and that you've accepted the self-signed certificate. If your account is locked due to failed attempts, wait for the lockout duration (default 15 minutes) or have another admin unlock it.
I don't see any topology data after adding a collector.
Check that the collector shows a green status in the sidebar. For GRE: verify IP connectivity and matching OSPF hello/dead intervals on both sides. For SNMP: test reachability with snmpwalk and check firewall rules for UDP 161. Check the collector manager logs with journalctl -u osprey-collector-manager -f.
A service shows as "Down" in the health panel.
Check if the service is running with systemctl status osprey-engine (or the relevant service name). Review logs with journalctl -u osprey-engine -n 50. Most commonly, a dependency (PostgreSQL or the message bus) has stopped — restart it and the Osprey service will recover within 15 seconds.
Stale devices won't disappear from the canvas.
Unreachable devices remain visible for the configured retention period (default 7 days). Reduce this under Admin > System Settings > Topology > Stale Device Retention. You can also right-click a stale device and delete it manually.
How do I check the version I'm running?
Run osprey version on the command line, or check the footer of the Osprey web UI.

Still have questions?

Check the full User Guide for detailed documentation, or reach out via the contact form.