zephyr/doc/reference/networking/capture.rst
Jukka Rissanen 103fc5e43a net: doc: Add net_capture API documentation
The net_capture API documentation was not referenced by
network documentation so the API reference documentation
was not generated for it. This commit adds links to the
net_capture API.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2021-04-07 12:12:30 -04:00

30 lines
631 B
ReStructuredText

.. _net_capture_interface:
Network Packet Capture
######################
.. contents::
:local:
:depth: 2
Overview
********
The ``net_capture`` API allows user to monitor the network
traffic in one of the Zephyr network interfaces and send that traffic to
external system for analysis. The monitoring can be setup either manually
using ``net-shell`` or automatically by using the ``net_capture`` API.
Sample usage
************
See :ref:`Network capture sample application <net-capture-sample>` and
:ref:`network_monitoring` for details.
API Reference
*************
.. doxygengroup:: net_capture
:project: Zephyr