Request commands#
Perform operational actions
Summary#
| Command | Description |
|---|---|
request |
Perform operational actions |
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 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 username |
Disconnect by username |
request system |
System operations |
request system cache-refresh |
Refresh the subscriber cache from the auth database |
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 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 captures start session#
Start capture for session
Accepts an optional positional argument <id> — session ID
| Parameter | Type | Required | Accepted values | Description |
|---|---|---|---|---|
destination |
IpAddress | yes | — | Collector IP the GRE mirror is sent to |
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 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 username#
Disconnect by username
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 system cache-refresh#
Refresh the subscriber cache from the auth database
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 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