.. _clicmd_src_plugins_hs_apps:

===============================================================
Hs_apps cli reference
===============================================================

http cli client
-------------------------------------------------------------------------

.. code-block:: console

    [appns <app-ns> secret <appns-secret>] uri http://<ip-addr> query <query-string> [no-output]


Declaration: ``hcc_command`` `src/plugins/hs_apps/http_client_cli.c line 631 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_client_cli.c#L631>`_

Implementation: ``hcc_command_fn``


http cli server
-------------------------------------------------------------------------

.. code-block:: console

    http cli server [uri <uri>] [fifo-size <nbytes>] [private-segment-size <nMG>] [prealloc-fifos <n>] [listener <add|del>] [appns <app-ns> secret <appns-secret>]


Declaration: ``hcs_create_command`` `src/plugins/hs_apps/http_cli.c line 860 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_cli.c#L860>`_

Implementation: ``hcs_create_command_fn``


http client
-------------------------------------------------------------------------

.. code-block:: console

    [post] uri http://<ip-addr>/<origin-form> [data <form-urlencoded> | file <file-path>] [use-ptr] [save-to <filename>] [header <Key:Value>] [verbose] [timeout <seconds> (default = 10)] [repeat <count> | duration <seconds>] [sessions <# of sessions>] [appns <app-ns> secret <appns-secret>] [fifo-size <nM|G>] [private-segment-size <nM|G>] [prealloc-fifos <n>]


Declaration: ``hc_command`` `src/plugins/hs_apps/http_client.c line 1026 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_client.c#L1026>`_

Implementation: ``hc_command_fn``


http tps
-------------------------------------------------------------------------

.. code-block:: console

    http tps [uri <uri>] [fifo-size <nbytes>] [segment-size <nMG>] [prealloc-fifos <n>] [debug] [no-zc] [del]


Declaration: ``http_tps_command`` `src/plugins/hs_apps/http_tps.c line 859 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_tps.c#L859>`_

Implementation: ``hts_create_command_fn``


show http tps
-------------------------------------------------------------------------

.. code-block:: console

    http tps [listeners]


Declaration: ``show_http_tps_command`` `src/plugins/hs_apps/http_tps.c line 935 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_tps.c#L935>`_

Implementation: ``hts_show_command_fn``


test alpn client
-------------------------------------------------------------------------

.. code-block:: console

    test alpn client [uri <tls://ip/port>] [tls-engine %d]


Declaration: ``alpn_client_run_command`` `src/plugins/hs_apps/alpn_client.c line 341 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/alpn_client.c#L341>`_

Implementation: ``alpn_client_run_command_fn``


test alpn server
-------------------------------------------------------------------------

.. code-block:: console

    test alpn server uri <tls://ip/port> [tls-engine %d]


Declaration: ``alpn_server_create_command`` `src/plugins/hs_apps/alpn_server.c line 247 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/alpn_server.c#L247>`_

Implementation: ``alpn_server_create_command_fn``


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

.. code-block:: console

    test echo clients [nclients %d][bytes <bytes>[m|g]][test-timeout <time>][run-time <time>][syn-timeout <time>][echo-bytes][fifo-size <size>][private-segment-count <count>][private-segment-size <bytes>[m|g]][preallocate-fifos][preallocate-sessions][client-batch <batch-size>][throughput <bytes>[m|g]][uri <tcp://ip/port>][test-bytes][verbose]


Declaration: ``ec_command`` `src/plugins/hs_apps/echo_client.c line 1429 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/echo_client.c#L1429>`_

Implementation: ``ec_command_fn``


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

.. code-block:: console

    test echo server proto <proto> [fifo-size <mbytes>][rcv-buf-size <bytes>][prealloc-fifos <count>][private-segment-count <count>][private-segment-size <bytes[m|g]>][uri <tcp://ip/port>]


Declaration: ``echo_server_create_command`` `src/plugins/hs_apps/echo_server.c line 774 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/echo_server.c#L774>`_

Implementation: ``echo_server_create_command_fn``


test proxy server
-------------------------------------------------------------------------

.. code-block:: console

    test proxy server [server-uri <proto://ip/port>][client-uri <tcp://ip/port>][fifo-size <nn>[k|m]][max-fifo-size <nn>[k|m]][high-watermark <nn>][low-watermark <nn>][rcv-buf-size <nn>][prealloc-fifos <nn>][private-segment-size <mem>][private-segment-count <nn>][idle-timeout <nn>]


Declaration: ``proxy_create_command`` `src/plugins/hs_apps/proxy.c line 1467 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/proxy.c#L1467>`_

Implementation: ``proxy_server_create_command_fn``


test-url-handler enable
-------------------------------------------------------------------------

.. code-block:: console

    test-url-handler enable


Declaration: ``test_builtins_enable_command`` `src/plugins/hs_apps/test_builtins.c line 199 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/test_builtins.c#L199>`_

Implementation: ``test_builtins_enable_command_fn``