.. _report:

report
======

Report configurations


report Specification
--------------------

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

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

	 **Element Name**                      report

	 **Element URI**                       /axapi/v3/report

	 **Element Attributes**                report_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`report schema <report/report.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/report



.. raw:: html

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


:ref:`2472_report_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/report_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/report



.. raw:: html

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


:ref:`2472_report_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/report_GET.txt
   :literal:




.. raw:: html

   </div></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/report



.. raw:: html

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


:ref:`2472_report_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/report



.. raw:: html

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


:ref:`2472_report_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/report



.. raw:: html

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


:ref:`2472_report_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2472_report_attributes:

report attributes
-----------------

    **debug**

        **Description:** debug is a **JSON Block**.  Please see below for :ref:`2472_debug` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/report/debug <report_debug>`

.. _2472_debug:

debug
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **log**

        **Description** Enable Report module's normal logs

        **Type:** boolean

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

        **Default:** 0

    **sflow**

        **Description:** sflow is a **JSON Block**.  Please see below for :ref:`2472_debug_sflow` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/report/debug/sflow <report_debug_sflow>`

.. _2472_debug_sflow:

debug_sflow
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **parser**

        **Description** Enable logs by parser

        **Type:** boolean

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

        **Default:** 0

    **stats-oid**

        **Description** Specify stats-oid to dump raw packets, 0 to disable

        **Type:** number

        **Range:** 0-9999