Introduction & Architecture
New to MeshOptixIQ? Three commands get you from zero to a live topology graph: docker pull meshoptixiq/meshoptixiq:latest → configure Neo4j → open http://localhost:8000. Jump to Chapter 3 — Installation to get running in under 10 minutes.
1.1 Product Overview
MeshOptixIQ is a vendor-agnostic network intelligence platform that automatically collects live operational state from your network devices, normalises it into a canonical graph model, and exposes the result for query, visualisation, and AI-assisted reasoning — all without agents, proprietary protocols, or months of integration work.
Most network teams spend hours correlating data across CLI sessions, spreadsheets, and NMS dashboards just to answer a single question: "If this device goes down, what breaks?" MeshOptixIQ answers that question in seconds. It builds a persistent, queryable graph of your entire network — topology edges, endpoint locations, IP addressing, firewall policies, BGP peering, and flow telemetry — and makes it accessible through a REST API, a React web UI, and a natural-language MCP interface for AI assistants like Claude.
The result is a single source of truth that reduces mean time to understand (MTTU) for incidents, eliminates manual pre-maintenance research, and gives security teams point-and-click policy analysis across every firewall in the estate.
Who Should Read This Guide
This guide is written for network engineers, systems administrators, and DevOps teams deploying MeshOptixIQ in production environments. Familiarity with Linux system administration, SSH, and basic IP networking concepts is assumed. For a quick command-line reference, see Appendix B — CLI Reference.
1.2 Key Capabilities
Topology Graph
- Automatic neighbour discovery via CDP/LLDP data
- Interface-level connection mapping
- Interactive Cytoscape.js topology viewer
- Full-text device and interface search
Endpoint Intelligence
- Locate hosts by IP or MAC address
- Trace physical path to upstream switch port
- ARP/MAC table correlation across vendors
Blast Radius Analysis
- Impact scope for device, interface, VLAN, or subnet outage
- Endpoint count and list per scenario
- Pre-maintenance change impact report
Firewall Policy Intelligence
- Collect security policies from PAN-OS, JunOS, FortiOS, ASA
- Zone-pair rule analysis
- Source-to-destination path analysis with permit/deny verdict
1.3 System Architecture
MeshOptixIQ is composed of four logical layers:
- Collection layer —
meshq collectconnects to devices over SSH using Netmiko, retrieves CLI output, and writes raw text to a local cache directory. - Normalisation layer —
meshq parsereads the raw cache and produces vendor-agnostic Pydantic models (devices, interfaces, IPs, MACs, VLANs, endpoints, firewall rules, address objects, service objects). - Graph layer —
meshq ingestwrites the normalised models into Neo4j or PostgreSQL. The graph schema represents devices as nodes, connections as relationships, and all other facts as node properties or related nodes. - Query layer — A FastAPI service exposes 42 named queries via
/queries/. The same queries are available via the MCP server (meshq-mcp) for AI-assistant integration. A React/Vite single-page application provides the web interface.
1.3.1 Graph Model
The normalised data is stored as a property graph with the following node types and key relationships:
1.4 License Plans
| Feature | Community | Starter | Pro | Enterprise |
|---|---|---|---|---|
| Installations | 1 | 1 | 5 | Unlimited |
| Network devices scanned | 1 | 100 | 750 | Unlimited |
| Query API & Web UI | — | Web UI only | ✓ | ✓ |
| POST /queries/*/execute | 403 | 403 | ✓ | ✓ |
MCP Server (meshq-mcp) | — | — | ✓ | ✓ |
| Firewall queries | — | — | ✓ | ✓ |
| What-if simulation | — | — | ✓ | ✓ |
| NetBox sync | — | — | ✓ | ✓ |
| Redis clustering | — | — | ✓ | ✓ |
| RBAC access control | — | — | ✓ | ✓ |
| PostgreSQL backend | — | — | ✓ | ✓ |
| Data export (CSV / Ansible) | — | — | ✓ | ✓ |
| Audit logging | — | — | ✓ | ✓ |
| OIDC/SSO | — | — | — | ✓ |
| SOAR webhooks | — | — | — | ✓ |
| Custom parsers | — | — | — | ✓ |
| Support | Community | Community | Dedicated |
403 Forbidden on POST /queries/{name}/execute. Only Pro and Enterprise plans may execute queries. Use the demo mode (MESHOPTIXIQ_DEMO_MODE=true) for evaluation without a license.