CLI command reference¶
This reference describes command families registered by current master. Availability depends on privilege, mode and build flags. Use ? in the running CLI for the exact command tree.
Session and mode commands¶
| Command | Purpose |
|---|---|
enable / disable |
enter or leave privileged mode |
configure terminal |
enter schema-aware configuration mode |
exit |
leave the current mode or close the session |
end |
return from configuration mode |
quit |
close the CLI session |
where |
print the current configuration path |
Show, save and execute¶
| Command | Purpose |
|---|---|
show status |
basic runtime state |
show config full |
complete configuration |
show config policy |
policy configuration |
show config objects |
reusable configuration objects |
show event list |
event ring summary |
show event detail <id> |
full event record |
save config |
persist the running configuration |
execute reload |
reload supported runtime configuration |
execute events clear |
clear event ring |
execute pcap rollover |
roll the aggregate capture file |
execute shutdown |
stop the process |
Configuration mutations¶
| Command | Purpose |
|---|---|
edit <path> |
enter a configuration section or object |
set <field> <value> |
replace a scalar/current value |
toggle <field> <value> |
add/remove a value in a list-like field |
add <section> <name> |
create a supported entry |
remove <entry> |
remove an entry after dependency checks |
move <entry> before|after|top|bottom ... |
reorder list entries such as policies |
Proxy diagnostics¶
diag proxy policy list
diag proxy session list [verbosity] [active] [tls] [io|io-all] [ips] [nonames]
diag proxy session active
diag proxy session tls-info
diag proxy io list
diag proxy session clear is registered but currently reports that implementation is pending; do not build automation around it.
TLS diagnostics¶
diag tls cache stats|list|print|clear
diag tls whitelist list|stats|insert_fingerprint|insert_l4|clear
diag tls crl list|stats
diag tls verify list|stats|clear
diag tls ticket list|stats|clear
diag tls ca reload
Whitelist insertions weaken validation. Record their owner, reason and expiry outside Smithproxy.
Runtime diagnostics¶
diag workers proxy list
diag workers pool list
diag mem buffers stats
diag mem udp stats
diag mem trace list|mark
diag dns cache list|stats|clear
diag dns domain list|clear
diag sig list
diag writer stats
diag api info
Memory tracing and some debug commands are compiled only in selected builds.
Neighbor and webhook diagnostics¶
diag neighbor list|stats|clear
diag neighbor tag <hostname> <tag-update>
diag neighbor webhook-update <hostname>
diag neighbor webhook-update-all
diag neighbor webhook-update-ping
test webhook
Test commands may be absent from release builds. Avoid running bulk webhook updates against a receiver that has not been capacity-tested.
Debug commands¶
debug show displays active settings. Additional debug <topic> commands are generated for registered logging facilities. High verbosity and payload dumping can expose sensitive data and materially affect performance.