FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
VLIB application library

clear

Summary/usage

Clear commands.

Declaration and implementation

Declaration: vlib_cli_clear_command (src/vlib/cli.c line 66)

clear errors

Summary/usage

Clear error counters.

Declaration and implementation

Declaration: cli_clear_error_counters (src/vlib/error.c line 377)

Implementation: clear_error_counters.

clear logging

Summary/usage

clear logging.

Declaration and implementation

Declaration: cli_clear_log (src/vlib/log.c line 509)

Implementation: clear_log.

clear node counters

Summary/usage

Clear node counters.

Declaration and implementation

Declaration: cli_clear_node_counters (src/vlib/error.c line 385)

Implementation: clear_error_counters.

clear runtime

Summary/usage

Clear packet processing runtime statistics.

Declaration and implementation

Declaration: clear_node_runtime_command (src/vlib/node_cli.c line 703)

Implementation: clear_node_runtime.

clear trace

Summary/usage

Clear trace buffer and free memory.

Declaration and implementation

Declaration: clear_trace_cli (src/vlib/trace.c line 602)

Implementation: cli_clear_trace_buffer.

event-logger clear

Summary/usage

Clear the event log.

Declaration and implementation

Declaration: elog_clear_cli (src/vlib/main.c line 702)

Implementation: vlib_cli_elog_clear.

event-logger resize

Summary/usage

event-logger resize <nnn>.

Declaration and implementation

Declaration: elog_resize_cli (src/vlib/main.c line 827)

Implementation: elog_resize_command_fn.

event-logger restart

Summary/usage

Restart the event-logger.

Declaration and implementation

Declaration: elog_restart_cli (src/vlib/main.c line 797)

Implementation: elog_restart.

event-logger save

Summary/usage

event-logger save <filename> (saves log in /tmp/<filename>).

Declaration and implementation

Declaration: elog_save_cli (src/vlib/main.c line 757)

Implementation: elog_save_buffer.

event-logger stop

Summary/usage

Stop the event-logger.

Declaration and implementation

Declaration: elog_stop_cli (src/vlib/main.c line 777)

Implementation: elog_stop.

event-logger trace

Summary/usage

event-logger trace [api][cli][barrier][dispatch]

[circuit-node <name> e.g. ethernet-input][disable].

Description

Control event logging of api, cli, and thread barrier events With no arguments, displays the current trace status. Name the event groups you wish to trace or stop tracing.

Example usage
event-logger trace api cli barrier
event-logger trace api cli barrier disable
event-logger trace dispatch
event-logger trace circuit-node ethernet-input
vpp# event-logger trace [api][cli][barrier][disable]

Declaration and implementation

Declaration: event_logger_trace_command (src/vlib/cli.c line 1601)

Implementation: event_logger_trace_command_fn.

memory-trace

Summary/usage

memory-trace on|off [api-segment][stats-segment][main-heap]
               [numa-heap &lt;numa-id&gt;]

Declaration and implementation

Declaration: enable_disable_memory_trace_command (src/vlib/cli.c line 1077)

Implementation: enable_disable_memory_trace.

restart

Summary/usage

restart process.

Declaration and implementation

Declaration: restart_cmd (src/vlib/cli.c line 1112)

Implementation: restart_cmd_fn.

set

Summary/usage

Set commands.

Declaration and implementation

Declaration: vlib_cli_set_command (src/vlib/cli.c line 74)

set logging class

Summary/usage

set logging class &lt;class&gt; [rate-limit &lt;int&gt;] [level &lt;level&gt;] [syslog-level &lt;level&gt;].

Declaration and implementation

Declaration: cli_set_log (src/vlib/log.c line 643)

Implementation: set_log_class.

set logging size

Summary/usage

set logging size &lt;int&gt;.

Declaration and implementation

Declaration: cli_set_log_size (src/vlib/log.c line 713)

Implementation: set_log_size.

set logging unthrottle-time

Summary/usage

set logging unthrottle-time &lt;int&gt;.

Declaration and implementation

Declaration: cli_set_log_params (src/vlib/log.c line 677)

Implementation: set_log_unth_time.

set node function

Summary/usage

set node function &lt;node-name&gt; &lt;variant-name&gt;.

Declaration and implementation

Declaration: set_node_fn_command (src/vlib/node_cli.c line 926)

Implementation: set_node_fn.

show

Summary/usage

Show commands.

Declaration and implementation

Declaration: vlib_cli_show_command (src/vlib/cli.c line 58)

show buffers

Summary/usage

Show packet buffer allocation.

Declaration and implementation

Declaration: show_buffers_command (src/vlib/buffer.c line 636)

Implementation: show_buffers.

show cli

Summary/usage

show cli [mp-safe][not-mp-safe][hit][clear-hit].

Description

Displays debug cli command information

Example usage
vpp# show cli [mp-safe][not-mp-safe][hit][clear-hit]

&#34;show cli&#34; displays the entire debug cli:

abf attach
abf policy
adjacency counters
api trace
app ns
bfd key del
... and so on ...

&#34;show cli mp-safe&#34; displays mp-safe debug CLI commands:

abf policy
binary-api
create vhost-user
exec
ip container
ip mroute
ip probe-neighbor
ip route
ip scan-neighbor
ip table
ip6 table

&#34;show cli not-mp-safe&#34; displays debug CLI commands
which cause worker thread barrier synchronization

&#34;show cli hit&#34; displays commands which have been executed. Qualify
as desired with &#34;mp-safe&#34; or &#34;not-mp-safe&#34;.

&#34;show cli clear-hit&#34; clears the per-command hit counters.

Declaration and implementation

Declaration: show_cli_command (src/vlib/cli.c line 1818)

Implementation: show_cli_command_fn.

show clock

Summary/usage

show clock.

Declaration and implementation

Declaration: f_command (src/vlib/threads.c line 1697)

Implementation: show_clock_command_fn.

show cpu

Summary/usage

Show cpu information.

Description

Displays various information about the CPU.

Example usage
vpp# show cpu
Model name:               Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
Microarchitecture:        Broadwell (Broadwell-EP/EX)
Flags:                    sse3 ssse3 sse41 sse42 avx avx2 aes
Base Frequency:           3.20 GHz

Declaration and implementation

Declaration: show_cpu_command (src/vlib/cli.c line 963)

Implementation: show_cpu.

show errors

Summary/usage

Show error counts.

Declaration and implementation

Declaration: vlib_cli_show_errors (src/vlib/error.c line 344)

Implementation: show_errors.

show event-logger

Summary/usage

Show event logger info.

Declaration and implementation

Declaration: elog_show_cli (src/vlib/main.c line 886)

Implementation: elog_show_buffer.

show frame-queue

Summary/usage

show frame-queue trace.

Declaration and implementation

Declaration: cmd_show_frame_queue_trace (src/vlib/threads_cli.c line 366)

Implementation: show_frame_queue_trace.

show frame-queue histogram

Summary/usage

show frame-queue histogram.

Declaration and implementation

Declaration: cmd_show_frame_queue_histogram (src/vlib/threads_cli.c line 374)

Implementation: show_frame_queue_histogram.

show logging

Summary/usage

show logging.

Declaration and implementation

Declaration: cli_show_log (src/vlib/log.c line 430)

Implementation: show_log.

show logging configuration

Summary/usage

show logging configuration.

Declaration and implementation

Declaration: cli_show_log_config (src/vlib/log.c line 478)

Implementation: show_log_config.

show memory

Summary/usage

show memory [api-segment][stats-segment][verbose]
        [numa-heaps][map].

Declaration and implementation

Declaration: show_memory_usage_command (src/vlib/cli.c line 929)

Implementation: show_memory_usage.

show node

Summary/usage

show node [index] &lt;node-name | node-index&gt;.

Declaration and implementation

Declaration: show_node_command (src/vlib/node_cli.c line 873)

Implementation: show_node.

show node counters

Summary/usage

Show node counters.

Declaration and implementation

Declaration: cli_show_node_counters (src/vlib/error.c line 352)

Implementation: show_errors.

show physmem

Summary/usage

show physmem [verbose | detail | map].

Declaration and implementation

Declaration: show_physmem_command (src/vlib/physmem.c line 164)

Implementation: show_physmem.

show punt client

Summary/usage

show client[s] registered with the punt infra.

Declaration and implementation

Declaration: punt_client_show_command (src/vlib/punt.c line 610)

Implementation: punt_client_show.

show punt db

Summary/usage

show the punt DB.

Declaration and implementation

Declaration: punt_db_show_command (src/vlib/punt.c line 676)

Implementation: punt_db_show.

show punt reasons

Summary/usage

show all punt reasons.

Declaration and implementation

Declaration: punt_reason_show_command (src/vlib/punt.c line 633)

Implementation: punt_reason_show.

show punt stats

Summary/usage

show the punt stats.

Declaration and implementation

Declaration: punt_stats_show_command (src/vlib/punt.c line 703)

Implementation: punt_stats_show.

show runtime

Summary/usage

Show packet processing runtime.

Declaration and implementation

Declaration: show_node_runtime_command (src/vlib/node_cli.c line 650)

Implementation: show_node_runtime.

show threads

Summary/usage

Show threads.

Declaration and implementation

Declaration: show_threads_command (src/vlib/threads_cli.c line 88)

Implementation: show_threads_fn.

show trace

Summary/usage

Show trace buffer [max COUNT].

Declaration and implementation

Declaration: show_trace_cli (src/vlib/trace.c line 361)

Implementation: cli_show_trace_buffer.

show vlib frame-allocation

Summary/usage

Show node dispatch frame statistics.

Declaration and implementation

Declaration: show_frame_stats_cli (src/vlib/main.c line 292)

Implementation: show_frame_stats.

show vlib graph

Summary/usage

Show packet processing node graph.

Declaration and implementation

Declaration: show_node_graph_command (src/vlib/node_cli.c line 88)

Implementation: show_node_graph.

show vlib graphviz

Summary/usage

Dump packet processing node graph as a graphviz dotfile.

Description

Dump dot files data to draw a graph of all the nodes. If the argument &#39;filter&#39; is provided, only the active nodes (since the last &#34;clear run&#34; comand) are selected and they are scaled and colored according to their utilization. You can choose to filter nodes that are called, nodes that receive vectors or both (default). The &#39;file&#39; option allows to save data in a temp file.

Example usage
show vlib graphviz
show vlib graphviz filter file tmpfile
show vlib graphviz filter calls file tmpfile
vpp# show vlib graphviz [filter][calls][vectors][file <filename>]

Declaration and implementation

Declaration: show_node_graphviz_command (src/vlib/node_cli.c line 327)

Implementation: show_node_graphviz.

suspend

Summary/usage

suspend debug CLI for 30ms.

Declaration and implementation

Declaration: suspend_command (src/vlib/cli.c line 1619)

Implementation: suspend_command_fn.

test

Summary/usage

Test commands.

Declaration and implementation

Declaration: vlib_cli_test_command (src/vlib/cli.c line 82)

test frame-queue nelts

Summary/usage

test frame-queue nelts (4,8,16,32).

Declaration and implementation

Declaration: cmd_test_frame_queue_nelts (src/vlib/threads_cli.c line 449)

Implementation: test_frame_queue_nelts.

test frame-queue threshold

Summary/usage

test frame-queue threshold N (0=no limit).

Declaration and implementation

Declaration: cmd_test_frame_queue_threshold (src/vlib/threads_cli.c line 528)

Implementation: test_frame_queue_threshold.

test log

Summary/usage

test log &lt;level&gt; &lt;class&gt; &lt;subclass&gt; &lt;message&gt;.

Declaration and implementation

Declaration: cli_test_log (src/vlib/log.c line 792)

Implementation: test_log_class_subclass.

test sleep

Summary/usage

Sleep for 10 seconds.

Declaration and implementation

Declaration: ping_command (src/vlib/cli.c line 1144)

Implementation: sleep_ten_seconds.

trace

Summary/usage

Packet tracer commands.

Declaration and implementation

Declaration: trace_cli_command (src/vlib/trace.c line 177)

trace add

Summary/usage

trace add &lt;input-graph-node&gt; &lt;add&#39;l-pkts-for-node-&gt; [filter] [verbose].

Declaration and implementation

Declaration: add_trace_cli (src/vlib/trace.c line 482)

Implementation: cli_add_trace_buffer.

trace filter

Summary/usage

trace filter none | [include|exclude] NODE COUNT.

Declaration and implementation

Declaration: filter_trace_cli (src/vlib/trace.c line 586)

Implementation: cli_filter_trace.

trace frame-queue

Summary/usage

trace frame-queue (on|off).

Declaration and implementation

Declaration: cmd_trace_frame_queue (src/vlib/threads_cli.c line 184)

Implementation: trace_frame_queue.