.. _clicmd_src_plugins_cnat:

===============================================================
Cnat cli reference
===============================================================

cnat client add
-------------------------------------------------------------------------

.. code-block:: console

    cnat client add <prefix> [fib <fib-index>] [fwd-fib <fib-index>] [return] [snat] [exclusive] [no-client]


Declaration: ``cnat_client_add_cmd`` `src/plugins/cnat/cnat_client.c line 350 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_client.c#L350>`_

Implementation: ``cnat_client_add_cli``


cnat log
-------------------------------------------------------------------------

.. code-block:: console

    cnat log [enable|disable] [ip <ip>]


Declaration: ``cnat_log_enable_disable_cmd`` `src/plugins/cnat/cnat_log.c line 145 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_log.c#L145>`_

Implementation: ``cnat_log_enable_disable_cli``


cnat translation
-------------------------------------------------------------------------

.. code-block:: console

    cnat translation [add|del] proto [TCP|UDP] [vip|real] [ip|sw_if_index [v6]] [port] [to [ip|sw_if_index [v6]] [port]->[ip|sw_if_index [v6]] [port]]


Declaration: ``cnat_translation_cli_add_del_command`` `src/plugins/cnat/cnat_translation.c line 597 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_translation.c#L597>`_

Implementation: ``cnat_translation_cli_add_del``


set cnat snat-policy
-------------------------------------------------------------------------

.. code-block:: console

    set cnat snat-policy [none|if-pfx|k8s|dnat] [fib <id>]


Declaration: ``cnat_snat_policy_set_cmd`` `src/plugins/cnat/cnat_snat_policy.c line 895 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_snat_policy.c#L895>`_

Implementation: ``cnat_snat_policy_set_cmd_fn``


set cnat snat-policy addr
-------------------------------------------------------------------------

.. code-block:: console

    set cnat snat-policy addr [<ip4-address>][<ip6-address>][sw_if_index]


Declaration: ``cnat_set_snat_command`` `src/plugins/cnat/cnat_snat_policy.c line 725 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_snat_policy.c#L725>`_

Implementation: ``cnat_set_snat_cli``


set cnat snat-policy if
-------------------------------------------------------------------------

.. code-block:: console

    set cnat snat-policy if [del][table [include-v4 include-v6 k8s]] [interface]


Declaration: ``cnat_snat_policy_add_del_if_command`` `src/plugins/cnat/cnat_snat_policy.c line 212 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_snat_policy.c#L212>`_

Implementation: ``cnat_snat_policy_add_del_if_command_fn``


set cnat snat-policy prefix
-------------------------------------------------------------------------

.. code-block:: console

    set cnat snat-policy prefix [del] prefix [fib <id>] [dst-rw <addr>]


Declaration: ``cnat_snat_policy_add_del_pfx_command`` `src/plugins/cnat/cnat_snat_policy.c line 779 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_snat_policy.c#L779>`_

Implementation: ``cnat_snat_policy_add_del_pfx_command_fn``


show cnat client
-------------------------------------------------------------------------

.. code-block:: console

    show cnat client


Declaration: ``cnat_client_show_cmd_node`` `src/plugins/cnat/cnat_client.c line 389 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_client.c#L389>`_

Implementation: ``cnat_client_show``


show cnat session
-------------------------------------------------------------------------

.. code-block:: console

    show cnat session [verbose] [return] [ip <ip>] [port <port>] [proto <proto>] [ref <ref>] [max <max>]


Declaration: ``cnat_session_show_cmd_node`` `src/plugins/cnat/cnat_session.c line 267 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_session.c#L267>`_

Implementation: ``cnat_session_show``


show cnat snat-policy
-------------------------------------------------------------------------

.. code-block:: console

    show cnat snat-policy


Declaration: ``cnat_show_snat_command`` `src/plugins/cnat/cnat_snat_policy.c line 814 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_snat_policy.c#L814>`_

Implementation: ``cnat_show_snat``


show cnat timestamp
-------------------------------------------------------------------------

.. code-block:: console

    show cnat timestamp [verbose]


Declaration: ``cnat_timestamp_show_cmd`` `src/plugins/cnat/cnat_session.c line 562 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_session.c#L562>`_

Implementation: ``cnat_timestamp_show``


show cnat translation
-------------------------------------------------------------------------

.. code-block:: console

    show cnat translation <VIP>


Declaration: ``cnat_translation_show_cmd_node`` `src/plugins/cnat/cnat_translation.c line 478 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_translation.c#L478>`_

Implementation: ``cnat_translation_show``


test cnat maglev
-------------------------------------------------------------------------

.. code-block:: console

    test cnat maglev tests [n_tests] backends [num_backends] len [maglev_len]


Declaration: ``cnat_translation_test_init_maglev_cmd`` `src/plugins/cnat/cnat_maglev.c line 374 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_maglev.c#L374>`_

Implementation: ``cnat_translation_test_init_maglev``


test cnat scanner
-------------------------------------------------------------------------

.. code-block:: console

    test cnat scanner


Declaration: ``cnat_scanner_cmd_node`` `src/plugins/cnat/cnat_scanner.c line 81 <https://github.com/FDio/vpp/blob/master//src/plugins/cnat/cnat_scanner.c#L81>`_

Implementation: ``cnat_scanner_cmd``