BLOG | Aug 18, 2025

Unlock Deeper Network Insights with Custom Commands

Off the shelf queries only go so far, sometimes you need custom tailored data straight from your network devices. Forward Networks enables this by powering user defined commands to extract unique, real time insights. Accelerate troubleshooting, refine automation, and bring precision to your network monitoring.

Request a demo Read the Blog

Arica Beckstead
Customer Success Engineer

Who should read this post?

Forward Networks users seeking personalized network visibility
Teams responsible for live network state and config awareness
Networking and security professionals building automation frameworks

What is covered in this content?

How to extract data using custom CLI commands via NQE
Sample syntax and structured mapping of custom outputs
Use cases for automation, monitoring, and reporting

Why Custom Commands Matter

Standard query patterns often miss specialized device data like QoS stats, feature-specific configurations, or vendor-specific health metrics. Custom commands allow you to fill those gaps—delivering targeted insights without sifting through raw CLI logs or spreadsheets.

Business Value

Operational Precision: Get the exact metrics you need, from QoS queues to session tables
Automation Enabler: Feed specialized data directly into workflows or ticketing systems
Faster Troubleshooting: Pinpoint configuration anomalies or performance issues with tailored commands
Smart Reporting: Centralize unique metrics for auditor-ready dashboards or custom alert thresholds

How It Works: Custom Command Extraction

Define your custom CLI command (e.g., show qos interface)
Configure NQE to run it via device profile or script
Parse the output using regex or structured annotations
Map it into NQE’s query result with field names and data types
Export the structured results through API, UI, or scheduler

Technical Example

ap_config =```
{name:string} {group:string} {type:string} {ip:ipv4Address} {status: ("Up" string | "Down")} {flag:string} {ipSwitch:ipv4Address} {ipStandby:ipv4Address}
```;

status(stat) = 
if isPresent(stat) then "Up" else "Down"
;

foreach device in network.devices
foreach command in device.outputs.commands
where command.commandText == "show ap database"
let parsed_response = parseConfigBlocks(OS.ARUBA_WIFI, command.response)
let my_data = blockMatches(parsed_response, ap_config)

foreach ap in my_data
select { 
  name: ap.data.name,
  group: ap.data.group,
  type: ap.data.type,
  ip: ap.data.ip,
  status: status(ap.data.status.left),
  uptime: ap.data.status.left,
  flags: ap.data.flag,
  switch_ip: ap.data.ipSwitch,
  standby_ip: ap.data.ipStandby,
  controller: device.name
}

Getting Started

Pick a custom data point (e.g., QoS class defaults, ARP statistics)
Test your command in CLI for consistent output
Define your pattern in NQE with named groups or regex
Run and evaluate results through UI or API
Embed in automation flows like ServiceNow alerts or dashboards

Explore the Community Guide

For a complete walkthrough with device-specific examples, parsing tips, and CI/CD integration ideas, check out the original post:
A Basic Guide to Extracting Data from Custom Commands

Winner of over 20 industry awards, Forward Enterprise is the best-in-class network modeling software that customers trust

Visit our press room Hear from Gartner

From Fortune 50 institutions to top level federal agencies, users agree that Forward Enterprise is unlike any other network modeling software

Evaluate the reviews Chat with an expert