Skip to content

Reference#

Exhaustive detail for looking things up. Everything in this section is generated from the product itself — the same command tree the CLI serves, the same configuration registry the web UI and REST API use, and the same OpenAPI document the appliance publishes. If a command or setting exists in the software, it is here; if it is here, it exists.

Generated — do not edit

These pages, and the MIB module below, are produced by bng-controlplane --emit-docs, --emit-openapi, and --emit-mib. Hand edits are overwritten on the next build, and CI fails if the committed output does not match what the current source produces.

Reference Contents Generated from
CLI commands Every operational and configuration-mode command, its arguments and accepted values The live CommandNode tree
Configuration Every configurable field, its CLI path, type and accepted values The configuration mapping registry
REST API Every /api/v1 endpoint, request and response schema, and authentication scheme The OpenAPI document
SNMP MIB The enterprise MIB module (NETAVO-BNG-MIB), importable into any standard SNMP tool MibCatalog, the same object descriptions BngMibProvider serves from

What is deliberately absent#

  • Hidden commands. The command tree marks some nodes as internal or unsupported; they are excluded from this manual rather than documented as product surface.
  • Runtime-specific completions. Values such as VRF names, alarm identifiers and rollback versions are offered by the CLI from live state. They appear here as placeholders, never as a fixed list.
  • Secret values. Fields that hold secrets are marked as such. The appliance redacts them in show configuration and | display set, and this manual never renders one.

Not yet generated#

A human-readable, prose SNMP OID reference page and the alarm catalogue are planned but not built — the raw MIB module above is generated and complete (compiles clean with smilint), but reading it still means reading SMI syntax rather than a table. The enterprise OID (1.3.6.1.4.1.66418) is IANA-assigned to Netavo Global Data Services Ltd.