.. _clicmd_src_vnet_session:

===============================================================
Session cli reference
===============================================================

app ns
-------------------------------------------------------------------------

.. code-block:: console

    app ns [add|del] id <namespace-id> secret <secret> sw_if_index <sw_if_index> if <interface>


Declaration: ``app_ns_command`` `src/vnet/session/application_namespace.c line 343 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application_namespace.c#L343>`_

Implementation: ``app_ns_fn``


clear session
-------------------------------------------------------------------------

.. code-block:: console

    clear session thread <thread> session <index>


Declaration: ``clear_session_command`` `src/vnet/session/session_cli.c line 734 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L734>`_

Implementation: ``clear_session_command_fn``


clear session dbg clock_cycles
-------------------------------------------------------------------------

.. code-block:: console

    clear session dbg clock_cycles


Declaration: ``clear_session_clock_cycles_command`` `src/vnet/session/session_debug.c line 96 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_debug.c#L96>`_

Implementation: ``clear_session_dbg_clock_cycles_fn``


clear session stats
-------------------------------------------------------------------------

.. code-block:: console

    clear session stats


Declaration: ``clear_session_stats_command`` `src/vnet/session/session_cli.c line 921 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L921>`_

Implementation: ``clear_session_stats_fn``


session
-------------------------------------------------------------------------

.. code-block:: console

    session [enable|disable]


Declaration: ``session_enable_disable_command`` `src/vnet/session/session_cli.c line 863 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L863>`_

Implementation: ``session_enable_disable_fn``


session debug
-------------------------------------------------------------------------

.. code-block:: console

    session debug {show | debug group <list> level <n>}


Declaration: ``session_debug_command`` `src/vnet/session/session_debug.c line 197 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_debug.c#L197>`_

Implementation: ``session_debug_fn``


session replay fifo
-------------------------------------------------------------------------

.. code-block:: console

    session replay fifo <session>


Declaration: ``session_replay_fifo_trace_command`` `src/vnet/session/session_cli.c line 831 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L831>`_

Implementation: ``session_replay_fifo_command_fn``


session rule
-------------------------------------------------------------------------

.. code-block:: console

    session rule [add|del] appns <ns_id> proto <proto> <lcl-ip/plen> <lcl-port> <rmt-ip/plen> <rmt-port> action <action>


Declaration: ``session_rule_command`` `src/vnet/session/session_lookup.c line 1573 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_lookup.c#L1573>`_

Implementation: ``session_rule_command_fn``


show app
-------------------------------------------------------------------------

.. code-block:: console

    show app [index] [server|client] [mq] [verbose] [transports]


Declaration: ``show_app_command`` `src/vnet/session/application.c line 2114 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application.c#L2114>`_

Implementation: ``show_app_command_fn``


show app certificate
-------------------------------------------------------------------------

.. code-block:: console

    list app certs and keys present in store


Declaration: ``show_certificate_command`` `src/vnet/session/application.c line 2121 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application.c#L2121>`_

Implementation: ``show_certificate_command_fn``


show app ns
-------------------------------------------------------------------------

.. code-block:: console

    show app ns [id <id> [api-clients]]


Declaration: ``show_app_ns_command`` `src/vnet/session/application_namespace.c line 498 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application_namespace.c#L498>`_

Implementation: ``show_app_ns_fn``


show segment-manager
-------------------------------------------------------------------------

.. code-block:: console

    show segment-manager [segments][verbose][index <nn>]


Declaration: ``segment_manager_show_command`` `src/vnet/session/segment_manager.c line 1129 <https://github.com/FDio/vpp/blob/master//src/vnet/session/segment_manager.c#L1129>`_

Implementation: ``segment_manager_show_fn``


show session
-------------------------------------------------------------------------

.. code-block:: console

    show session [verbose [n]] [listeners <proto>] [<session-id> [elog]] [thread <n> [index <n>] [proto <proto>] [state <state>] [range <min> [<max>]] [protos] [states] 


Declaration: ``vlib_cli_show_session_command`` `src/vnet/session/session_cli.c line 659 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L659>`_

Implementation: ``show_session_command_fn``


show session dbg clock_cycles
-------------------------------------------------------------------------

.. code-block:: console

    show session dbg clock_cycles


Declaration: ``show_session_dbg_clock_cycles_command`` `src/vnet/session/session_debug.c line 56 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_debug.c#L56>`_

Implementation: ``show_session_dbg_clock_cycles_fn``


show session fifo trace
-------------------------------------------------------------------------

.. code-block:: console

    show session fifo trace <session>


Declaration: ``show_session_fifo_trace_command`` `src/vnet/session/session_cli.c line 784 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L784>`_

Implementation: ``show_session_fifo_trace_command_fn``


show session rules
-------------------------------------------------------------------------

.. code-block:: console

    show session rules [<proto> appns <id> <lcl-ip/plen> <lcl-port> <rmt-ip/plen> <rmt-port> scope <scope>]


Declaration: ``show_session_rules_command`` `src/vnet/session/session_lookup.c line 1704 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_lookup.c#L1704>`_

Implementation: ``show_session_rules_command_fn``


show session stats
-------------------------------------------------------------------------

.. code-block:: console

    show session stats


Declaration: ``show_session_stats_command`` `src/vnet/session/session_cli.c line 896 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L896>`_

Implementation: ``show_session_stats_fn``