.. _clicmd_src_plugins_hs_apps_builtin_echo:

===============================================================
Builtin_echo cli reference
===============================================================

test echo clients
-------------------------------------------------------------------------

.. code-block:: console

    test echo clients [nclients <n>] [bytes <bytes>[k|m|g] | run-time <seconds>]
    [test-timeout <seconds>] [syn-timeout <seconds>] [echo-bytes]
    [fifo-size <bytes>[k|m|g]] [appns <id>] [http1|http2|http3] [tls-engine <id>]
    [private-segment-size <bytes>[k|m|g]] [preallocate-fifos] [preallocate-sessions]
    [client-batch <n>] [max-tx-chunk <bytes>[k|m]] [nstreams <n>]
    [throughput <bytes>[k|m|g]] [report-interval[-total] [<seconds>]] [report-jitter]
    [uri <proto://ip:port>] [test-bytes] [verbose] [all-scope|local-scope|global-scope]



Client for performing network throughput measurements.
It can test TCP, UDP, TLS or QUIC throughput.
To perform test you must establish both a server and a client.

Example of how to measure upload speed, test duration 10 seconds and measurement interval 1
second (zero copy):


.. code-block:: console

    test echo client uri tcp://6.0.1.2:1234



Declaration: ``ec_command`` `src/plugins/hs_apps/builtin_echo/echo_cli.c line 351 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/builtin_echo/echo_cli.c#L351>`_

Implementation: ``ec_command_fn``


test echo server
-------------------------------------------------------------------------

.. code-block:: console

    test echo server [uri <proto://ip:port>] [fifo-size <bytes>[k|m|g]]
    [private-segment-count <n>] [private-segment-size <bytes>[k|m|g]]
    [all-scope|local-scope|global-scope] [secret <n>] [stop] [tls-engine <id>]
    [prealloc-fifos <n>] [appns <id>] [report-interval [<seconds>]]



Server for performing network throughput measurements.
It can test TCP, UDP, TLS or QUIC throughput.
To perform test you must establish both a server and a client.

Example of how to start server:


.. code-block:: console

    test echo server uri tcp://6.0.1.2:1234



Declaration: ``echo_server_create_command`` `src/plugins/hs_apps/builtin_echo/echo_cli.c line 152 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/builtin_echo/echo_cli.c#L152>`_

Implementation: ``echo_server_create_command_fn``