The console

You reach it at https://<box-ip>:8443. First-run brings you to the setup wizard (see the Quick Start). After that, you land on Dashboard.

The left nav is grouped into four sections:

Group Purpose
OPERATIONS What's happening right now — live counters, sessions, health, audit trail
CONFIGURE The knobs — pools, plans, subscribers, portal, dataplane
PLATFORM About page, hardware inventory
SIMULATOR CPESIM (only visible if the CPESIM plugin is installed)

Header pills are the always-on status snapshot. Green = OK, amber = warning, red = action needed:

  • VPP — dataplane up? If ? for more than 10s, the controller can't reach vpp-bridge (see Troubleshooting).
  • AAA · Local · gated (or open) — provider health + mode. Local · unreachable means the local AAA store isn't loading.
  • Sessions: N — current onboarded subscriber count.
  • N warnings (amber shield) — click to see open events (unread events also show as a badge next to Dashboard in the nav).

Dashboard

The operator's home screen. Six top-line KPIs plus two live throughput charts and three panels.

Dashboard

KPIs (top row, left to right):

KPI What it means When to look
Provisioned Subscribers currently CONNECTED (have an IP, on their plan) Baseline health
Captive Subscribers redirected to portal (unprovisioned or awaiting login) Rising during business hours = provisioning workflow lag
In-flight Sessions mid-DORA (OFFERING or REQUESTING) > 10 for more than 30s = reply-path stall
Session Table VPP-side session-slot occupancy Approaches 1000 = at Community Edition cap
AAA (Local) Local AAA provider health DOWN = users can't authenticate (see AAA (Local))
VPP Dataplane status + bound-session count UP N bound sessions — should match Provisioned KPI

Subscriber Throughput — two stacked-area charts, upstream and downstream. Each shows the 3-color QoS breakdown: green = within CIR (in-contract), yellow = between CIR and PIR (burst), red = dropped by the policer. Time-range picker top-right (5M / 15M / 1H / 6H / 24H).

QoS bands — same three colors as the throughput chart but as a rolling-average bar per direction. Use the throughput chart to see when a spike happened; use the bands to see the current split.

DHCP pools — per-pool utilization bar. Tints amber at warn threshold, red at full. Click Manage to jump to Pools & DNS.

Ingress drops — a counter of packets dropped on the ingress path (bng-input, dpdk-*, ethernet-input). A rising count with no legitimate churn typically means unauthorized traffic or subscriber-side DDoS.

System Health — one-liner status of each subsystem. Click Details for the full Health page.

Topology

Live map of every element in the packet path — from CPEs on the left to the core router on the right.

Topology

Green dots = healthy. Amber = warning (e.g., access interface down because no cable). Red = broken. Hovers on each element give you IP, MAC, driver, throughput.

Two tabs: Topology — network connectivity + per-element status (the view above) — and Network — bandwidth measurements at key points in the system (edge, uplink, per-interface throughput).

Sessions

Every current subscriber session. Filter by state (Connected / Captive / Offering / All), search by IP / MAC / plan / giaddr.

Sessions

The "Subscribers over time" chart at the top shows connected + captive + in-flight over your chosen range. Persistent in-flight (red) with low connected typically means the DHCP reply path is stalled — see the Health page's reply-path check.

Click any session row to open the Session Drawer (right-side panel): live per-session traffic sparkline, session events (DORA, plan changes, disconnects), operator actions (disconnect, re-rate, move to captive).

Health

Subsystem-by-subsystem diagnostic page. Every check has a green/amber/red pill, a description of what the check verifies, and a "why this matters" note.

Health

Checks include: TLS cert expiry, controller ↔ vpp-bridge connection, punt socket health, reply-path stall detector (see the memory note about tx_pps < rx_pps × 0.5 under load), snapshot store size, audit shipper backlog, AAA provider reachability.

Two sub-tabs: Health (checks) and Workers (VPP worker CPU utilization + per-worker packet counts — helpful to see if your corelist-workers sizing matches your traffic load).

Audit

Every operator action and every controller-observed event, correlated across QT audit
log, controller API log and systemd journal — plus, optionally, decoded RADIUS
exchanges.

Audit

The timeline defaults to "live tail" — click Return to live if you scroll back. Each row includes:

  • Timestamp + source (QT / Controller / Journal)
  • Actor (username, API key ID, or system)
  • Event kind + one-line description
  • Rev-ID chip (linkable back to the source log line)

Use the date+time filters top-right to scope. Click Verbose journal to include noisy
systemd events (default off).

RADIUS exchanges (optional, off by default). Enabling the radius-exchanges source
captures RADIUS traffic the box sees, decodes and lints it, and shows the exchanges on
this timeline beside everything else — so a failing subscriber authentication can be read
here instead of with tcpdump. Shared secrets are read for verification and never
written to the log.

Two things worth knowing before you turn it on. It is off by default and publishes
nothing when off, so an empty RADIUS lane means "not capturing", not "nothing happened".
And because it records subscriber identifiers, read
"What the RADIUS exchange timeline records about your subscribers" first — it sets
out exactly which identifiers are written, where the file goes, and what does and does
not leave the box.

Hardware / Compute

Hardware inventory (NICs, CPU, mem, disk) plus VPP CPU/worker mapping.

Compute

Use this page to sanity-check your box config before opening a support ticket: it shows exactly what VPP thinks it has (corelist-workers, hugepages, buffer allocations, per-worker queue placements) alongside what the kernel thinks it has (isolcpus, NUMA topology, IOMMU groups).

Subscribers

The provisioned-subscriber list (AAA source of truth). This is the roster of who's allowed to onboard; it's not the same as the Sessions list (which is who's currently online).

Subscribers

Columns: line identity (DHCP Option 82 circuit-id in hex), plan, status (active / suspended / terminated), lease-time overrides.

Add subscriber button top-right → single-form editor. For bulk import, use the Upload button and a CSV.

AAA (Local)

The local-AAA provider config. Two modes:

  • Open — every DHCP DISCOVER is accepted, default plan assigned. Fine for lab / demo / small deployments where every connected device is trusted.
  • Gated — only provisioned lines (see Subscribers) are accepted at plan. Unlisted lines get the unknown disposition (currently captive → portal, or reject → NAK).

AAA

Change with care — flipping from Open to Gated on a running system silently kicks unprovisioned CPEs to captive.

Pools & DNS

The DHCP pools. Each pool has a name, a CIDR range, a lease time, and one or more DNS resolvers.

Pools & DNS

Default pool must exist — the setup wizard creates it. Add more pools if you need per-plan or per-geography allocation.

Pool utilization is shown as a horizontal bar with color-coded thresholds (amber at 80%, red at 95%). Alloc-failure counter shows how many DISCOVERs got NAK'd because the pool was exhausted.

Subscriber Plans

Rate plans — each defines up_cir_kbps, up_pir_kbps, dn_cir_kbps, dn_pir_kbps plus optional session/idle/interim timers.

Subscriber Plans

CIR = Committed Information Rate (guaranteed minimum, packets colored green). PIR = Peak Information Rate (burst ceiling, packets between CIR and PIR colored yellow). Packets above PIR are dropped (red).

*_bps fields in the API are BYTES per second. Multiply by 8 for bits/s (the webui shows Mbps).

Changes to a plan take effect on the next subscriber onboard OR when you click Re-rate active sessions to push the change immediately.

Portal Config

Captive portal setup — the portal_ip that the BNG hands to unprovisioned subscribers, the portal page's branding, and the vouchers page (if you use voucher-based auth instead of pure username/password).

Portal

If portal_ip is unset, unprovisioned DHCP DISCOVERs get silently dropped in gated mode. You'll see this in the controller log as captive required but no captive portal IP configured, dropping.

Dataplane

VPP-level knobs — interface state, RX/TX queue counts, RSS, worker placement, hugepage size, IOMMU groups.

Dataplane

Most operators never touch this page — the wizard's defaults are correct for most
single-NIC boxes. Edit if you're doing custom NUMA pinning, split-NIC access/uplink
topologies, or dpdk driver overrides (e.g. vlan-strip).

Assign your dataplane ports here during commissioning, before the box
carries subscribers.
The port assignment is what tells the console which
NICs belong to VPP. Two things follow from it: the NICs are shown as
VPP-owned rather than as unassigned DPDK ports, and the bind / unbind /
reset-to-kernel controls will then refuse an operation on a port VPP is
using.

If the ports were never assigned — a hand-written startup.conf, or a
commissioning run that stopped before this page — the NICs still work and
still forward, but they read as unassigned and that refusal is not armed.
On a box already in service, do not use bind / unbind / reset-to-kernel to
correct the display.
The operation will be allowed, it rebinds the NIC and
re-renders /etc/vpp/startup.conf, and forwarding stops. Assign the ports in
your next planned maintenance window instead. Tracked as #49.

DSCP marking policy. New in 1.3.0: the per-subscriber policer can DSCP-mark
metered traffic so downstream devices can tell in-contract from out-of-contract packets.
In-contract ("green") traffic is marked AF11 (10) and out-of-contract ("yellow")
AF12 (12) by default, so downstream WRED sheds yellow first. Red is still dropped.

Marking is configured per direction and is off by default in both. Each direction
takes its own enable flag and its own green and yellow codepoints, each settable to any
DSCP value 0–63. Before 1.3.0 yellow was counted but forwarded byte-identical to green,
which is still what you get with marking left disabled. The Dashboard's QoS panel
captions whichever state is active.

Edge Routers

For deployments where the BNG faces multiple edge routers (e.g., separate business/residential upstream), list them here with their public IPs and next-hop configs. The topology page uses this list to draw the WAN-side of the map.

Edge Routers

Licensing

Shows the session capacity in force, and the activation flow for raising it.

The free tier needs nothing. It is included with every install, requires no
licence and no TPM, and caps concurrent sessions at 1,000. It is the
default state of a new install, and for operators who stay inside 1,000
concurrent sessions this page is informational.

New in 1.4.0: this page operates activation. It reads licence status, shows
the machine fingerprint, and activates a licence you paste or upload, stating the
capacity in force and where that figure comes from. Three defects that blocked
this in the alpha are fixed: the licence routes were missing their /v1 prefix
and returned 404 on every call; a trailing newline — the kind any text editor
adds — invalidated an otherwise valid licence; and activation from the console
failed because it requires the admin_only role while the shipped CLI carries
the service key.

The command-line flow below remains supported and is still the better route for
scripted or air-gapped provisioning.

Raising the cap — four steps, run on the box itself for the first two:

  1. Capture the fingerprint, which identifies this specific machine:

    quantum-license-fingerprint
    # sha256:276486e444e3569cbdc3d03bea7441dfc57eb12d6e561a52bb69106a66703dea

    Add --json if your vendor contact also wants the SMBIOS UUID. The value is a
    hash of the TPM endorsement key and carries no secrets, so email is fine.

  2. Send it to Bluedot (info@bluedot-insight.com) with the capacity you need and
    your customer identifier. You receive a .lic file signed to that fingerprint —
    it will not install on any other machine.

  3. Install it:

    quantum-license-install /tmp/your-licence.lic
  4. Verify:

    quantum-license-status

    The dashboard's capacity indicator picks up the new limit immediately — no
    restart.

Capacity activation requires a TPM 2.0 device at /dev/tpmrm0.

Licensing gates capacity only, never function. A licence that expires or fails
verification reverts the box to the free-tier cap; it does not stop forwarding
traffic.

Usage Records

Usage Records

Per-subscriber usage records held on the box for billing — the local-AAA analogue of
RADIUS accounting. Each row carries the accounting type (start / interim / stop),
session and circuit IDs, MAC, framed IP and plan.

This is different from the live counters on the Dashboard and Sessions pages: those are
gauges showing what is happening now, and they reset. These persist so they can be
exported and reconciled later.

New in 1.4.0: these records come from live subscriber traffic. In the alpha they
were a preview — held, downloadable and prunable, but not produced from real traffic,
and drained only while someone had a page open. The console now runs a background
drain that claims the controller's accounting spool every 30 seconds and commits it to
a durable local ledger, acknowledging upstream only after that commit lands. The
ledger holds immutable CDRs for completed sessions, a live row per open session, and
per-subscriber daily rollups. You can build against this.

On a large ledger this page is slow to appear. It reads the whole stored ledger in
one request, so on a box that has been carrying subscribers for a while the Stored
CDRs
and Live sessions figures show as — and the table stays empty until that
read completes. On a lab box holding 609,000 records it took around 45 seconds, and it
scales with how many records you hold. Nothing is wrong with the data while this is
happening — the figures and the records arrive in full once the read finishes.

Narrow the read and it returns promptly at any size: the Since / Until and
Subscriber ID filters are applied by the server, not in the browser, so filtering to
the period or the subscriber you are actually reconciling is both faster and usually
what you wanted. Export CSV and Export JSON are server-side for the same reason
and are unaffected. If a very large ledger makes the page unresponsive rather than
merely slow, prefer the exports. Tracked as #57.

Acknowledging deletes. The page's action is Acknowledge & prune: it marks records
consumed and permanently removes them. There is no undo and no second copy. Use
Download CSV first, every time — the CSV is the only thing that survives the
acknowledgement.

Acknowledge only through the records you have actually stored. The control acknowledges
through the highest sequence shown on the page rather than the whole spool, so a spool
larger than one page is consumed a page at a time rather than in one sweep — which is the
behaviour you want, because the alternative silently discards everything between the page
you read and the end of the spool.

About + Toybox

Version info + the Toybox plugin registry. Toybox is where operators install
optional add-on modules. Two ship with this release: CPESIM, the built-in
subscriber simulator, and the Grafana dashboard pack. Both are free; neither
requires a licence.

About

Each plugin row shows: install status, installed version, install/remove button.
Install from URL lets you install a beta/hotfix build without waiting for a full BNG
release.

The Grafana dashboard pack is a curated set of BNG dashboards you can preview
before wiring anything up, with multi-select download. Pair it with a metrics-only
API key (see API Keys) so the Grafana instance gets a key scoped to
reads rather than broad access.

New in 1.4.0: add-on lifecycle. Add-ons now check for updates — and stay quiet
when there is nothing to report — and can be installed from an uploaded tarball on a
box with no outbound internet. The catalogue URL can be pointed at a mirror you own,
and one previous artifact is retained so a failed update rolls back without needing
a download.

API Keys

The webui's key store. Mint per-operator keys (recommended over sharing the bootstrap admin key), scope them to roles (read_only, read_write, admin_only, metrics_scraper), set expiry.

API Keys

The metrics_scraper role is scoped to /metrics only and is what Prometheus uses. Rotate with sudo /opt/bng-deploy/bin/qt-scrape-token-rotate.

CPESIM

The subscriber simulator plugin's control page. Only visible if you installed CPESIM via Toybox.

CPESIM

Start — spawn N simulated subscribers doing real DHCP + AAA + HTTP video traffic through your BNG. Stop — clean teardown. Reset simulator (admin-only) — recovery button that clears wedged state and restarts the whole CPESIM engine.

Configuration: subscribers count, captive fraction, duration. Sensible defaults are baked in — click Start and go.