CLI command reference#
Every command the appliance accepts, with the same help text the CLI prints for ?. Commands are grouped by mode: operational (the prompt you land on) and configuration (after configure).
Operational mode#
| Command | Description |
|---|---|
clear |
Clear operational state |
clear alarms |
Clear (dismiss) an active alarm: clear alarms <id> [<instance>] |
clear web-ui |
Clear Web UI state |
clear web-ui auth |
Clear Web UI authentication state |
clear web-ui auth lockout |
Clear Web UI auth lockout for a user |
clear web-ui auth session |
Revoke a Web UI session |
configure |
Enter configuration mode |
ping |
Send ICMP echo requests from the data plane |
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 |
show |
Show system information |
show address-pools |
Show dynamic address pools: show address-pools [<name>] |
show alarms |
Show active alarms |
show captures |
Show active packet captures |
show cgn |
Show CG-NAT (NAT44) information |
show cgn bindings |
Show CG-NAT bindings: show cgn bindings [<inside-ip>] |
show cgn groups |
Show CG-NAT IP groups and pool utilisation |
show cgn summary |
Show CG-NAT status and counters |
show circuits |
Show CPE GRE/BGP circuits with tunnel and BGP session state |
show circuits vrf |
Show circuits in one customer VRF |
show configuration |
Show running configuration |
show licensing |
Show licensing status |
show licensing telemetry |
Show the exact telemetry payload the box will send |
show protocols |
Show protocol information |
show protocols bgp |
Show BGP information |
show protocols bgp neighbor |
Show BGP neighbor detail |
show protocols bgp summary |
Show BGP peer summary |
show protocols isis |
Show IS-IS information |
show protocols isis adjacencies |
Show IS-IS adjacencies |
show protocols l2tp |
Show L2TP information |
show protocols l2tp tunnels |
Show L2TP tunnels |
show protocols ospf |
Show OSPF information |
show protocols ospf adjacencies |
Show OSPF adjacencies (OSPFv2 and OSPFv3) |
show protocols pppoe |
Show PPPoE information |
show protocols pppoe statistics |
Show PPPoE statistics |
show radius |
Show RADIUS information |
show radius servers |
Show RADIUS server status |
show route |
Show the IPv4 routing table (default VRF) |
show route vrf |
Show the IPv4 routing table for a VRF |
show source-vrf |
Show source-VRF classification information |
show source-vrf rules |
Show programmed source-VRF classification rules |
show subscribers |
Show subscriber information |
show subscribers local |
Show locally-defined subscribers (no external auth server) |
show subscribers sessions |
Show subscriber sessions |
show subscribers summary |
Show subscriber summary |
show system |
Show system information |
show system hardware |
Show hardware inventory |
show system interfaces |
Show network interfaces |
show system status |
Show system status |
show system uptime |
Show system uptime |
show system version |
Show system version |
show vrfs |
Show configured VRFs and live session counts |
show web-ui |
Show Web UI information |
show web-ui auth |
Show Web UI authentication configuration |
show web-ui auth sessions |
Show active Web UI sessions |
Configuration mode#
In addition to every operational show command listed above:
| Command | Description |
|---|---|
commit |
Commit configuration changes |
commit and-quit |
Commit and exit configuration mode |
commit check |
Validate configuration without applying |
commit comment |
Commit with a comment |
commit confirm |
Commit with automatic rollback timer |
compare |
Show changes between candidate and active |
delete |
Delete configuration parameter |
exit |
Exit configuration mode |
quit |
Exit configuration mode |
rollback |
Roll back to previous configuration |
set |
Set configuration parameter |
top |
Return to top of configuration hierarchy |
up |
Move up one level in configuration hierarchy |
85 operational and 13 configuration-mode commands; 26 of 62 commands that can carry one have recorded example output.