Binary API CLI

api trace

Summary/usage

api trace [on|off][dump|save|replay <file>][status][free][post-mortem-on].

Description

Display, replay, or save a binary API trace

Declaration and implementation

Declaration: api_trace_command (src/vlibmemory/memory_vlib.c line 2457)

Implementation: api_trace_command_fn.

clear api histogram

Summary/usage

clear api histogram.

Description

Clear the binary api sleep-time histogram

Declaration and implementation

Declaration: cli_clear_api_histogram_command (src/vlibmemory/memory_vlib.c line 1175)

Implementation: vl_api_clear_histogram_command.

[on][on_tx][on_rx][off][free][debug_on][debug_off] set api-trace [on][on tx][on rx][off][free][debug on][debug off]

Summary/usage

API trace.

Description

Control the binary API trace mechanism

Declaration and implementation

Declaration: trace (src/vlibmemory/memory_vlib.c line 1679)

Implementation: vl_api_trace_command.

show api

Summary/usage

Show API information.

Declaration and implementation

Declaration: cli_show_api_command (src/vlibmemory/memory_vlib.c line 1515)

show api clients

Summary/usage

Client information.

Description

Display current api client connections

Declaration and implementation

Declaration: cli_show_api_clients_command (src/vlibmemory/memory_vlib.c line 1538)

Implementation: vl_api_client_command.

show api dump

Summary/usage

show api dump file <filename> [numeric | compare-current].

Description

Displays a serialized API message decode table, sorted by message name

Example usage

vpp# show api dump file <filename>

                                               Message name    MsgID        CRC
accept_session                                                    407   8e2a127e
accept_session_reply                                              408   67d8c22a
add_node_next                                                     549   e4202993
add_node_next_reply                                               550   e89d6eed
etc.

Compares a serialized API message decode table with the current image

Example usage

vpp# show api dump file <filename> compare

ip_add_del_route                                             definition changed
ip_table_add_del                                             definition changed
l2_macs_event                                                only in image
vnet_ip4_fib_counters                                        only in file
vnet_ip4_nbr_counters                                        only in file

Display a serialized API message decode table, compare a saved decode table with the current image, to establish API differences.

Declaration and implementation

Declaration: dump_api_table_file (src/vlibmemory/memory_vlib.c line 2791)

Implementation: dump_api_table_file_command_fn.

show api histogram

Summary/usage

show api histogram.

Description

Display the binary api sleep-time histogram

Declaration and implementation

Declaration: cli_show_api_histogram_command (src/vlibmemory/memory_vlib.c line 1151)

Implementation: vl_api_show_histogram_command.

show api message-table

Summary/usage

Message Table.

Description

Display the current api message decode tables

Declaration and implementation

Declaration: cli_show_api_message_table_command (src/vlibmemory/memory_vlib.c line 1601)

Implementation: vl_api_message_table_command.

show api plugin

Summary/usage

show api plugin.

Description

Display the plugin binary API message range table

Declaration and implementation

Declaration: cli_show_api_plugin_command (src/vlibmemory/memory_vlib.c line 1783)

Implementation: vl_api_show_plugin_command.

show api ring-stats

Summary/usage

Message ring statistics.

Description

Display binary api message allocation ring statistics

Declaration and implementation

Declaration: cli_show_api_ring_command (src/vlibmemory/memory_vlib.c line 1526)

Implementation: vl_api_ring_command.

show api trace-status

Summary/usage

Display API trace status.

Description

Display the current api message tracing status

Declaration and implementation

Declaration: cli_show_api_status_command (src/vlibmemory/memory_vlib.c line 1550)

Implementation: vl_api_status_command.