.. _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 584 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_client_cli.c#L584>`_

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>]


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

Implementation: ``hcs_create_command_fn``


http post
-------------------------------------------------------------------------

.. code-block:: console

    uri http://<ip-addr> target <origin-form> [data <form-urlencoded> | file <file-path>] [use-ptr]


Declaration: ``hsp_command`` `src/plugins/hs_apps/http_simple_post.c line 563 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_simple_post.c#L563>`_

Implementation: ``hsp_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 861 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_tps.c#L861>`_

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 937 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_tps.c#L937>`_

Implementation: ``hts_show_command_fn``


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

.. code-block:: console

    test echo clients [nclients %d][[m|g]bytes <bytes>][test-timeout <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>][uri <tcp://ip/port>][test-bytes][verbose]


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

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 771 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/echo_server.c#L771>`_

Implementation: ``echo_server_create_command_fn``


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

.. code-block:: console

    test proxy server [server-uri <tcp://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>]


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

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 175 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/test_builtins.c#L175>`_

Implementation: ``test_builtins_enable_command_fn``