.. _clicmd_src_plugins_hs_apps:

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

clear http connect proxy client stats
-------------------------------------------------------------------------

.. code-block:: console

    clear http connect proxy client stats


Declaration: ``hcpc_clear_stats_command`` `src/plugins/hs_apps/http_connect_proxy_client.c line 2420 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_connect_proxy_client.c#L2420>`_

Implementation: ``hcpc_clear_stats_fn``


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

.. code-block:: console

    [appns <app-ns> secret <appns-secret>] uri http[s]://<ip-addr>/<target> [no-output] [http3]


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

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>] [http1-only] [http3-enabled]


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

Implementation: ``hcs_create_command_fn``


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

.. code-block:: console

    [post|put] 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>] [max-body-size <nM|G>] [http1|http2|http3] [redirect] [max-redirects <n> (default 10)]


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

Implementation: ``hc_command_fn``


http connect proxy client enable
-------------------------------------------------------------------------

.. code-block:: console

    http connect proxy client enable server-uri <http[s]://ip:port>
    interface <intfc> listener <tcp|udp://ip:port> [udp-idle-timeout <n>]
    [fifo-size <nM|G>] [private-segment-size <nM|G>] [prealloc-fifos <n>]
    [cert <cert> key <key>] [http3] [masque-draft-03]


Declaration: ``hcpc_create_command`` `src/plugins/hs_apps/http_connect_proxy_client.c line 2189 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_connect_proxy_client.c#L2189>`_

Implementation: ``hcpc_create_command_fn``


http connect proxy client listener
-------------------------------------------------------------------------

.. code-block:: console

    http connect proxy client listener [add|del] <tcp|udp://ip:port>


Declaration: ``hcpc_add_del_listener_command`` `src/plugins/hs_apps/http_connect_proxy_client.c line 2271 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_connect_proxy_client.c#L2271>`_

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

Implementation: ``hts_create_command_fn``


proxy-lite
-------------------------------------------------------------------------

.. code-block:: console

    proxy-lite server-uri <tcp://ip:port|udp://ip:port> client-uri <tcp://ip:port|udp://ip:port> [fifo-size <n>[k|m]] [segment-size <n>[k|m]] [hsi-offload] [hsi-offload-stall]


Declaration: ``proxy_lite_command`` `src/plugins/hs_apps/proxy_lite.c line 788 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/proxy_lite.c#L788>`_

Implementation: ``proxy_lite_command_fn``


show http connect proxy client
-------------------------------------------------------------------------

.. code-block:: console

    show http connect proxy [listeners] [sessions] [stats]


Declaration: ``hcpc_show_command`` `src/plugins/hs_apps/http_connect_proxy_client.c line 2390 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/http_connect_proxy_client.c#L2390>`_

Implementation: ``hcpc_show_command_fn``


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

.. code-block:: console

    http tps [listeners]


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

Implementation: ``hts_show_command_fn``


show proxy-lite
-------------------------------------------------------------------------

.. code-block:: console

    show proxy-lite


Declaration: ``proxy_lite_show_command`` `src/plugins/hs_apps/proxy_lite.c line 813 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/proxy_lite.c#L813>`_

Implementation: ``proxy_lite_show_command_fn``


show test tls server
-------------------------------------------------------------------------

.. code-block:: console

    show test tls server


Declaration: ``show_tls_server`` `src/plugins/hs_apps/tls_server.c line 352 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/tls_server.c#L352>`_

Implementation: ``show_tls_server_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>] [http3] [enable-masque-draft-03]


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

Implementation: ``proxy_server_create_command_fn``


test tls client
-------------------------------------------------------------------------

.. code-block:: console

    test tls client [uri <tls://ip/port>] [tls-engine %d] [profile-index %d] [verify <mode>] [ca-cert <ca-cert-file>] [crl <crl-file>]


Declaration: ``tls_client_run_command`` `src/plugins/hs_apps/tls_client.c line 480 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/tls_client.c#L480>`_

Implementation: ``tls_client_run_command_fn``


test tls server
-------------------------------------------------------------------------

.. code-block:: console

    test tls server uri <tls://ip/port> [tls-engine %d] [profile-index %d] [cert <cert-file> key <key-file>]


Declaration: ``tls_server_create_command`` `src/plugins/hs_apps/tls_server.c line 332 <https://github.com/FDio/vpp/blob/master//src/plugins/hs_apps/tls_server.c#L332>`_

Implementation: ``tls_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``