Day 2 Operations: Using MeshOptixIQ

How to interact with the Network Reasoner once deployed.

1. Overview

Day 2 Operations refers to everything you do with MeshOptixIQ after the initial deployment: ingesting network configurations, running topology queries, tracking endpoint location, simulating failure blast radius, reviewing firewall policy, and exporting data for external tools. MeshOptixIQ exposes three interaction surfaces for these workflows — the REST API, the meshq CLI, and the built-in React web interface — all backed by the same live network graph.

2. Configuration

MeshOptixIQ is configured via environment variables and YAML files.

Environment Variables

Variable Default Description
NEO4J_URI bolt://localhost:7687 Neo4j connection string
NEO4J_PASSWORD (empty) Database password
GRAPH_BACKEND neo4j neo4j or postgres
API_KEY (unset) API key for query endpoints — if unset the server starts but logs a warning and rejects all authenticated requests. Set ALLOW_OPEN_ACCESS=true for local dev without a key.
MESHOPTIXIQ_LICENSE_KEY (unset) License key — required by the API server only; CLI and MCP inherit the plan from the API
MESHOPTIXIQ_API_URL http://localhost:8000 Local API server URL used by the CLI and MCP server for license plan resolution

Inventory Configuration (inventory.yaml)

Define static devices to collect from:

devices:
  - hostname: core-sw-01
    host: 192.168.1.1
    vendor: cisco_ios
    username: admin
    password_env: DEVICE_PASSWORD  # references env var
    
  - hostname: edge-rtr-01
    host: 10.0.0.1
    vendor: juniper_junos
    username: netops
    key_file: /root/.ssh/id_rsa    # SSH key auth

Discovery Configuration (discovery.yaml)

Enable active scanning of IP ranges:

discovery:
  cidrs:
    - 10.0.0.0/24
    - 192.168.1.0/24
  scan_ports: [22]
  exclude:
    - 10.0.0.1
  credentials:
    username: admin
    password_env: DEVICE_PASSWORD

3. Data Model

The reasoning engine normalizes all vendor data into a standard graph schema (v1).

Device

Physical or virtual network appliance (Router, Switch, Firewall).

Interface

Physical port or logical interface (VLAN, Loopback).

IPAddress

IPv4 or IPv6 address assigned to an interface.

Subnet

Layer-3 network derived from IP/Mask (e.g., 192.168.1.0/24).

Endpoint

Connected host identified by MAC + IP pair.

Key Relationships

4. Running the Pipeline

# Run ingestion with discovery enabled
docker run --env-file .env \
  -v $(pwd)/configs:/app/configs \
  meshoptixiq/meshoptixiq:latest

Interacting with the API

The primary interface for automation and tools is the REST API.

Listing Available Queries

GET /queries

Returns a list of all registered queries, their descriptions, and required parameters.

Executing a Query

POST /queries/{query_name}/execute
Content-Type: application/json

{
  "parameters": {
    "device_name": "switch-01",
    "cidr": "10.0.0.0/24"
  }
}

Using the CLI (`meshq`)

For ad-hoc troubleshooting, use the bundled CLI tool (available in the Docker container or as a standalone binary).

# Find a device by MAC
meshq endpoints locate --mac "00:50:56:AB:CD:EF"
# OR via Docker
docker run meshoptixiq/meshoptixiq meshq endpoints locate ...

# Locate an endpoint by IP address
meshq endpoints locate <ip>

# Find blast radius of a device
meshq blast-radius <hostname>

# Analyze blast radius of a subnet
meshq blast-radius subnet --cidr "192.168.10.0/24"

# Start the MCP server
meshq mcp  # or: meshq-mcp

Web UI

MeshOptixIQ ships a built-in React web interface served at http://<host>:8000. No separate deployment is required. After connecting with your API key you have access to:

Authenticating to the Web UI

On first visit, the UI prompts for an API key. Enter the value of API_KEY set on the server (or demo in demo mode). The key is stored in sessionStorage and cleared when you close the browser tab. To switch keys, click your user identity menu (top-right) and select Sign Out.

App Shell

  • Top Bar — backend health indicator, SSE live badge, demo-mode pill, notifications bell, user identity menu
  • Command Palette — press Cmd+K / Ctrl+K from any page; smart routing by IP, MAC, hostname, or page name
  • Inspector Drawer — right-side panel that opens when you click a device row or topology node; shows 6 tabs (Summary, Interfaces, Neighbors, Endpoints, Firewall, History)
  • Grouped sidebar navigation — seven sections: Overview, Observe, Assets, Security, Operations, Workbench, System

Key Pages

Route Page What it does
/topologyTopologyForce-directed graph; focus mode for 200+ device networks; blast radius and path overlays
/devicesDevice InventoryVirtualized table, vendor filters, Inspector Drawer integration, JSON export
/endpointsEndpoint SearchLocate hosts by IP or MAC; inventory table mode; orphaned endpoints hygiene
/subnetsSubnets & IPAMBrowse IPs by CIDR or by device; VRF filter; orphaned IPs hygiene
/firewallFirewall PoliciesSearch rules by device or zone pair; deny-rules summary
/path-analysisPath AnalysisTrace traffic through firewall chains; overlay matched path on topology
/blast-radiusBlast RadiusSimulate device / VLAN / subnet failure; overlay impacted nodes on topology
/historyChange CenterTrend charts, snapshot diff, what-if simulation (Pro+)
/automationAutomationDownload Ansible dynamic inventory (JSON / INI); NetBox dry-run sync
/adminAdminRuntime config, RBAC editor, snapshots, support bundle copy
/flowsFlow AnalysisNetFlow/sFlow top-talkers, conversations, interface heatmap (Enterprise)
/gpu-clusterGPU & InfiniBandIB fabric topology, GPU DCGM health metrics, NCCL job overlay (Enterprise)
/complianceComplianceFramework scan (PCI DSS, NIST CSF, CIS), control results, CSV export (Enterprise)
/alertsAlertsAlert rule management, live alert stream, acknowledgment (Pro+)
/vulnerabilityVulnerabilityCVE correlation with discovered devices (Enterprise)
/chatAI AssistantAI query interface, natural language graph questions (Enterprise)
/configsConfig HistoryConfig snapshot viewer, drift detection (Pro+)
/collectionCollection Management4-tab: Devices, Networks, Runs, Schedule (Pro+)
/routingRouting IntelligenceBGP peer table, BGP topology graph (Pro+)

See Chapter 7 of the User Guide for the full Web Interface reference including the Command Palette, Inspector Drawer, topology overlays, and all page-level details.