.. _clicmd_src_plugins_wireguard:

===============================================================
Wireguard cli reference
===============================================================

set wireguard async mode
-------------------------------------------------------------------------

.. code-block:: console

    set wireguard async mode on|off


Declaration: ``wg_set_async_mode_command`` `src/plugins/wireguard/wireguard_cli.c line 393 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L393>`_

Implementation: ``wg_set_async_mode_command_fn``


show wireguard interface
-------------------------------------------------------------------------

.. code-block:: console

    show wireguard


Declaration: ``wg_show_itfs_command`` `src/plugins/wireguard/wireguard_cli.c line 359 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L359>`_

Implementation: ``wg_show_if_command_fn``


show wireguard mode
-------------------------------------------------------------------------

.. code-block:: console

    show wireguard mode


Declaration: ``wg_show_modemode_command`` `src/plugins/wireguard/wireguard_cli.c line 414 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L414>`_

Implementation: ``wg_show_mode_command_fn``


show wireguard peer
-------------------------------------------------------------------------

.. code-block:: console

    show wireguard peer


Declaration: ``wg_show_peers_command`` `src/plugins/wireguard/wireguard_cli.c line 329 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L329>`_

Implementation: ``wg_show_peer_command_fn``


wireguard create
-------------------------------------------------------------------------

.. code-block:: console

    wireguard create listen-port <port> private-key <key> src <IP> [generate-key]



Create a Wireguard interface.

Declaration: ``wg_if_create_command`` `src/plugins/wireguard/wireguard_cli.c line 98 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L98>`_

Implementation: ``wg_if_create_cli``


wireguard delete
-------------------------------------------------------------------------

.. code-block:: console

    wireguard delete <interface>



Delete a Wireguard interface.

Declaration: ``wg_if_delete_command`` `src/plugins/wireguard/wireguard_cli.c line 147 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L147>`_

Implementation: ``wg_if_delete_cli``


wireguard peer add
-------------------------------------------------------------------------

.. code-block:: console

    wireguard peer add <wg_int> public-key <pub_key_other> endpoint <ip4_dst> allowed-ip <prefix> dst-port [port_dst] persistent-keepalive [keepalive_interval]


Declaration: ``wg_peer_add_command`` `src/plugins/wireguard/wireguard_cli.c line 255 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L255>`_

Implementation: ``wg_peer_add_command_fn``


wireguard peer remove
-------------------------------------------------------------------------

.. code-block:: console

    wireguard peer remove <index>


Declaration: ``wg_peer_remove_command`` `src/plugins/wireguard/wireguard_cli.c line 303 <https://github.com/FDio/vpp/blob/master//src/plugins/wireguard/wireguard_cli.c#L303>`_

Implementation: ``wg_peer_remove_command_fn``