.. _debug_traffic_capture:

debug-traffic-capture
=====================

Debug Traffic Capture Configuration


debug-traffic-capture Specification
-----------------------------------

	===================================== ==============================================================
	 **Parameter**                         **Value** 

	===================================== ==============================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      debug-traffic-capture

	 **Element URI**                       /axapi/v3/debug-traffic-capture

	 **Element Attributes**                debug-traffic-capture_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/debug-traffic-capture/oper

	 **Schema**                             :download:`debug-traffic-capture schema <debug-traffic-capture/debug-traffic-capture.txt>`
	===================================== ==============================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/debug-traffic-capture



.. raw:: html

   </td><td valign = 'top'>


:ref:`1387_debug-traffic-capture_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/debug_traffic_capture_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/debug-traffic-capture



.. raw:: html

   </td><td valign = 'top'>


:ref:`1387_debug-traffic-capture_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/debug-traffic-capture



.. raw:: html

   </td><td valign = 'top'>


:ref:`1387_debug-traffic-capture_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/debug-traffic-capture



.. raw:: html

   </td><td valign = 'top'>


:ref:`1387_debug-traffic-capture_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/debug-traffic-capture



.. raw:: html

   </td><td valign = 'top'>


:ref:`1387_debug-traffic-capture_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1387_debug-traffic-capture_attributes:

debug-traffic-capture attributes
--------------------------------

    **enable**

        **Description** Enable Debug Traffic Capture

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **maximum-file-size**

        **Description** Specify pcapng filesize in MB (default 100)

        **Type:** number

        **Range:** 1-150

    **maximum-history-recordings**

        **Description** Number of crashed samples (default 5)

        **Type:** number

        **Range:** 1-10

    **record-direction-type**

        **Description** 'ingress-only': Record all ingress traffic; 'all-direction': Record all ingress and egress traffic; 

        **Type:** string

        **Supported Values:** ingress-only, all-direction

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters