.. _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> {ip4-fib-id <id> ip6-fib-id <id> | if <interface>}
Declaration: ``app_ns_command`` `src/vnet/session/application_namespace.c line 502 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application_namespace.c#L502>`_
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 875 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L875>`_
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 93 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_debug.c#L93>`_
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 1077 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L1077>`_
Implementation: ``clear_session_stats_fn``
session
-------------------------------------------------------------------------
.. code-block:: console
session { enable [ rt-backend sdl | rule-table ] } | { disable }
Declaration: ``session_enable_disable_command`` `src/vnet/session/session_cli.c line 1019 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L1019>`_
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 193 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_debug.c#L193>`_
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 968 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L968>`_
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 1735 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_lookup.c#L1735>`_
Implementation: ``session_rule_command_fn``
session sdl
-------------------------------------------------------------------------
.. code-block:: console
session sdl <add|del> [appns <ns_id>] <rmt-ip/plen> action <action> [tag <tag>]
Declaration: ``session_sdl_command`` `src/vnet/session/session_sdl.c line 595 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_sdl.c#L595>`_
Implementation: ``session_sdl_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 2170 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application.c#L2170>`_
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 2177 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application.c#L2177>`_
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 654 <https://github.com/FDio/vpp/blob/master//src/vnet/session/application_namespace.c#L654>`_
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 1156 <https://github.com/FDio/vpp/blob/master//src/vnet/session/segment_manager.c#L1156>`_
Implementation: ``segment_manager_show_fn``
show session
-------------------------------------------------------------------------
.. code-block:: console
show session [protos][states][rt-backend][verbose [n]] [transport][events][listeners <proto>] [<session-id>][thread <n> [[proto <p>] index <n>]][elog] [thread <n>][proto <proto>][state <state>][range <min> [<max>]] [lcl|rmt|ep <ip>[:<port>]][force-print]
Declaration: ``vlib_cli_show_session_command`` `src/vnet/session/session_cli.c line 803 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L803>`_
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 55 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_debug.c#L55>`_
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 923 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L923>`_
Implementation: ``show_session_fifo_trace_command_fn``
show session lookup
-------------------------------------------------------------------------
.. code-block:: console
show session lookup [table <fib-index>]
Declaration: ``show_session_lookup_command`` `src/vnet/session/session_lookup.c line 1980 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_lookup.c#L1980>`_
Implementation: ``show_session_lookup_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 1899 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_lookup.c#L1899>`_
Implementation: ``show_session_rules_command_fn``
show session sdl
-------------------------------------------------------------------------
.. code-block:: console
show session sdl [appns <id> <rmt-ip>]
Declaration: ``show_session_sdl_command`` `src/vnet/session/session_sdl.c line 793 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_sdl.c#L793>`_
Implementation: ``show_session_sdl_command_fn``
show session stats
-------------------------------------------------------------------------
.. code-block:: console
show session stats
Declaration: ``show_session_stats_command`` `src/vnet/session/session_cli.c line 1051 <https://github.com/FDio/vpp/blob/master//src/vnet/session/session_cli.c#L1051>`_
Implementation: ``show_session_stats_fn``