Request commands#
Perform operational actions
Summary#
| Command | Description |
|---|---|
request |
Perform operational actions |
request address-pools |
Address-pool operations |
request address-pools clear-reservations |
Release IPv6 blocks held for IPoE lines whose session has ended: clear-reservations <pool> [owner <key> | prefix <prefix>] | all |
request address-pools clear-reservations all |
Release every reservation in every pool |
request captures |
Packet capture operations |
request captures start |
Start a packet capture |
request captures start session |
Start capture for session |
request captures stop |
Stop a packet capture |
request captures stop session |
Stop capture for session |
request cgn |
CG-NAT operations |
request cgn reclaim-blocks |
Give back a CGN binding's unused port blocks: the empty blocks at the top, never the first, to quarantine. The data plane judges each block empty under the binding's locks; translations in the blocks kept are untouched |
request cgn reclaim-blocks all |
Every binding that holds more than one block (one at a time; translation goes on between them) |
request cgn reclaim-blocks group |
Every binding of one CGN IP group that holds more than one block (one at a time; translation goes on between them) |
request dataplane |
Data-plane operational diagnostics |
request dataplane urpf-sample |
Arm header sampling on uRPF drops (defaults: count 64, seconds 30) |
request dataplane urpf-sample all |
Sample all sessions, bounded to 100 samples/second across workers |
request dataplane urpf-sample session |
Sample only one subscriber session |
request diagnostics |
Data-plane diagnostics |
request diagnostics inject |
Trace a synthetic packet through the forwarding pipeline |
request licensing |
Licensing management (activate, renew, offline) |
request licensing activate |
Activate this box with a one-time token |
request licensing load-offline |
Install an offline licence file |
request licensing renew-now |
Force an immediate licence renewal |
request subscribers |
Subscriber operations |
request subscribers disconnect |
Disconnect a subscriber session |
request subscribers disconnect id |
Disconnect by session ID |
request subscribers disconnect reference |
Disconnect by subscriber reference, as the session list shows it; add 'all' when several sessions share it |
request subscribers disconnect reference all |
Disconnect every session that has the reference |
request subscribers disconnect username |
Disconnect by username (the session's true username, not a subscriber reference) |
request subscribers reapply |
Re-apply the CGN limits (port cap, setup rate, binding timeout) of the CGN IP group to live sessions, in place: same public address and port blocks, translations kept. CGN limits only; for rates and shaping use 'request subscribers refresh' or a CoA |
request subscribers reapply all |
Re-apply the CGN limits of every live session |
request subscribers reapply all vrf |
Only the sessions of one inside VRF |
request subscribers reapply id |
Re-apply one session's CGN limits |
request subscribers refresh |
Load the subscriber source now, apply it to the live sessions, and report what was done |
request subscribers source |
Subscriber source operations |
request subscribers source accept |
Accept the subscriber load that was read and not believed (empty, or most rows gone or turned off) and apply exactly that load |
request system |
System operations |
request system cache-refresh |
Refresh the subscriber cache from the subscriber source now (same as 'request subscribers refresh') |
request system configuration |
Configuration backup |
request system configuration export |
Export a backup of the active configuration |
request system configuration export encrypted |
Print a restorable backup, encrypted under a passphrase you are asked for |
request system configuration export encrypted file |
Write the encrypted backup to a file on the appliance |
request system configuration export redacted |
Print a backup with every secret replaced by a placeholder |
request system configuration export redacted file |
Write the redacted backup to a file on the appliance |
request system drain |
Stop admitting new subscribers (maintenance drain) |
request system restart |
Restart the control plane and data plane so pending config changes take effect |
request system restart control-plane |
Restart only the control plane: the data plane keeps forwarding, IPoE sessions are kept, L2TP sessions are adopted where restart adoption allows or redial |
request system restart data-plane |
Restart only the data plane: the control plane replays every session into it; forwarding pauses while the ports come up |
request system undrain |
Resume admitting new subscribers |
request system upgrade |
Stage a package for reviewed upgrade (path or HTTPS URL) |
request system upgrade apply |
Apply a staged upgrade ID with automatic rollback |
request system upgrade drain-apply |
Apply a staged upgrade ID with automatic rollback |
request system upgrade status |
Show persistent upgrade transactions |
request web-ui |
Web UI operations |
request web-ui auth |
Web UI authentication operations |
request web-ui auth test-oidc |
Test OIDC discovery and JWKS reachability |
request web-ui auth test-tacacs |
Test TACACS+ server reachability |
request webui |
Web UI account rescue operations |
request webui reset-password |
Reset a user's password (prints a generated one) |
request webui unlock |
Clear lockout and TOTP enrolment for a user |
Commands#
request address-pools clear-reservations#
Release IPv6 blocks held for IPoE lines whose session has ended: clear-reservations <pool> [owner <key> | prefix <prefix>] | all
Accepts an optional positional argument <pool> — the pool whose reservations to release
| Parameter | Type | Required | Accepted values | Description |
|---|---|---|---|---|
owner |
String | no | — | Only the reservation held for this owner (as shown by show address-pools reservations) |
prefix |
String | no | — | Only the reservation of this block |
request address-pools clear-reservations all#
Release every reservation in every pool
request captures start session#
Start capture for session
Accepts an optional positional argument <id> — session ID
| Parameter | Type | Required | Accepted values | Description |
|---|---|---|---|---|
destination |
IpAddress | no | — | Collector IPv4 address the GRE mirror is sent to (default: capture default-destination-ip) |
Example
user@bng> request captures start session 40214 destination 10.20.2.50
Capture started for session 40214; mirroring to 10.20.2.50.
request captures stop session#
Stop capture for session
Accepts an optional positional argument <id> — session ID
Example
request cgn reclaim-blocks#
Give back a CGN binding's unused port blocks: the empty blocks at the top, never the first, to quarantine. The data plane judges each block empty under the binding's locks; translations in the blocks kept are untouched
Accepts an optional positional argument <inside-ip> — the subscriber's inside IPv4 address
| Parameter | Type | Required | Accepted values | Description |
|---|---|---|---|---|
vrf |
String | no | — | Inside VRF, when the address is used in more than one ('default' = the global table) |
request cgn reclaim-blocks all#
Every binding that holds more than one block (one at a time; translation goes on between them)
request cgn reclaim-blocks group#
Every binding of one CGN IP group that holds more than one block (one at a time; translation goes on between them)
Accepts an optional positional argument <group> — the name of a CGN IP group, as in show cgn groups
request dataplane urpf-sample all#
Sample all sessions, bounded to 100 samples/second across workers
| Parameter | Type | Required | Accepted values | Description |
|---|---|---|---|---|
count |
UInt32 | no | — | Maximum samples across workers (1..4096, default 64) |
seconds |
UInt32 | no | — | Arm duration (1..300 seconds, default 30) |
request dataplane urpf-sample session#
Sample only one subscriber session
Accepts an optional positional argument <id> — subscriber session ID
| Parameter | Type | Required | Accepted values | Description |
|---|---|---|---|---|
count |
UInt32 | no | — | Maximum samples per worker (1..4096, default 64) |
seconds |
UInt32 | no | — | Arm duration (1..300 seconds, default 30) |
request diagnostics inject#
Trace a synthetic packet through the forwarding pipeline
Accepts an optional positional argument <port> — ingress port index to pretend the frame arrived on
| Parameter | Type | Required | Accepted values | Description |
|---|---|---|---|---|
source |
IpAddress | yes | — | Source address — what a source-VRF rule matches on |
destination |
IpAddress | yes | — | Destination address |
s-vlan |
UInt32 | no | — | Outer S-VLAN (omit for none) |
c-vlan |
UInt32 | no | — | Inner C-VLAN (omit for none) |
mpls-label |
UInt32 | no | — | L3VPN label to arrive under (omit for none) |
protocol |
UInt32 | no | — | IP protocol: 1 ICMP, 6 TCP, 17 UDP (default 17) |
source-port |
UInt32 | no | — | L4 source port (default 5000) |
destination-port |
UInt32 | no | — | L4 destination port (default 53) |
size |
UInt32 | no | — | Payload bytes after the L4 header (default 32) |
emit |
Boolean | no | — | Actually transmit instead of tracing and dropping |
request licensing activate#
Activate this box with a one-time token
Accepts an optional positional argument <token> — the one-time activation token from the portal
request licensing load-offline#
Install an offline licence file
Accepts an optional positional argument <path> — path to the offline licence file to install
request licensing renew-now#
Force an immediate licence renewal
request subscribers disconnect id#
Disconnect by session ID
Accepts an optional positional argument <id> — session ID to disconnect
Example
request subscribers disconnect reference#
Disconnect by subscriber reference, as the session list shows it; add 'all' when several sessions share it
Accepts an optional positional argument <reference> — subscriber reference to disconnect
request subscribers disconnect reference all#
Disconnect every session that has the reference
request subscribers disconnect username#
Disconnect by username (the session's true username, not a subscriber reference)
Accepts an optional positional argument <username> — username to disconnect
Example
user@bng> request subscribers disconnect username bob@example.net
Session 40214 (bob@example.net) disconnected
request subscribers reapply all#
Re-apply the CGN limits of every live session
request subscribers reapply all vrf#
Only the sessions of one inside VRF
Accepts an optional positional argument <vrf> — inside VRF name ("default" for the global table)
request subscribers reapply id#
Re-apply one session's CGN limits
Accepts an optional positional argument <id> — session ID
request subscribers refresh#
Load the subscriber source now, apply it to the live sessions, and report what was done
request subscribers source accept#
Accept the subscriber load that was read and not believed (empty, or most rows gone or turned off) and apply exactly that load
request system cache-refresh#
Refresh the subscriber cache from the subscriber source now (same as 'request subscribers refresh')
request system configuration export encrypted#
Print a restorable backup, encrypted under a passphrase you are asked for
request system configuration export encrypted file#
Write the encrypted backup to a file on the appliance
Accepts an optional positional argument <name> — file name in the backups directory (letters, digits, '.', '_', '-')
request system configuration export redacted#
Print a backup with every secret replaced by a placeholder
request system configuration export redacted file#
Write the redacted backup to a file on the appliance
Accepts an optional positional argument <name> — file name in the backups directory (letters, digits, '.', '_', '-')
request system drain#
Stop admitting new subscribers (maintenance drain)
Example
user@bng> request system drain
Draining. New subscribers are refused; 4 established session(s) continue until they end naturally.
request system restart#
Restart the control plane and data plane so pending config changes take effect
request system restart control-plane#
Restart only the control plane: the data plane keeps forwarding, IPoE sessions are kept, L2TP sessions are adopted where restart adoption allows or redial
request system restart data-plane#
Restart only the data plane: the control plane replays every session into it; forwarding pauses while the ports come up
request system undrain#
Resume admitting new subscribers
Example
request system upgrade#
Stage a package for reviewed upgrade (path or HTTPS URL)
Accepts an optional positional argument <source> — local package path or HTTPS URL
request system upgrade apply#
Apply a staged upgrade ID with automatic rollback
Accepts an optional positional argument <id> — staged upgrade ID
request system upgrade drain-apply#
Apply a staged upgrade ID with automatic rollback
Accepts an optional positional argument <id> — staged upgrade ID
request system upgrade status#
Show persistent upgrade transactions
request web-ui auth test-oidc#
Test OIDC discovery and JWKS reachability
Accepts an optional positional argument <name> — oIDC provider name
request web-ui auth test-tacacs#
Test TACACS+ server reachability
request webui reset-password#
Reset a user's password (prints a generated one)
Accepts an optional positional argument <username> — user whose password to reset
request webui unlock#
Clear lockout and TOTP enrolment for a user
Accepts an optional positional argument <username> — user to unlock