opnsense_route_gateway_status
Get live gateway monitor status including online/offline state, RTT, packet loss, stddev, monitor IP, and monitor disabled flag. Read-only for routing diagnostics.
Instructions
Get live gateway monitor status: per-gateway online/offline state, RTT (delay), packet loss, stddev, monitor IP, and monitor_disable flag. Read-only — complements opnsense_route_gateway_list (which only returns config).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/routing.ts:251-254 (handler)Handler for the opnsense_route_gateway_status tool. Executes a GET request to /routes/gateway/status on the OPNsense API and returns the live gateway monitor status as formatted JSON.
case "opnsense_route_gateway_status": { const result = await client.get("/routes/gateway/status"); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } - src/tools/routing.ts:148-151 (schema)Tool definition (schema) for opnsense_route_gateway_status. Declares the tool name, description, and an empty input schema (no parameters required).
name: "opnsense_route_gateway_status", description: "Get live gateway monitor status: per-gateway online/offline state, RTT (delay), packet loss, stddev, monitor IP, and monitor_disable flag. Read-only — complements opnsense_route_gateway_list (which only returns config).", inputSchema: { type: "object" as const, properties: {} }, }, - src/index.ts:67-67 (registration)Registration: maps every routing tool definition (including opnsense_route_gateway_status) to the handleRoutingTool handler function in the global toolHandlers map.
for (const def of routingToolDefinitions) toolHandlers.set(def.name, handleRoutingTool);