.. _ddos_detection_agent_stats:

ddos detection agent stats
==========================

Statistics for the object agent


agent Specification
-------------------

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

	===================================== ================================================================================
	 **Type**                              *Collection*

	 **Collection Name**                   :ref:`666_agent_list`

	 **Collection URI**                    /axapi/v3/ddos/detection/agent/{agent-name}

	                                       

	 **Element Name**                      agent

	 **Element URI**                       /axapi/v3/ddos/detection/agent/{agent-name}/stats

	 **Element Attributes**                agent_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`agent schema <ddos-detection-agent-stats/ddos-detection-agent-stats.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/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`666_agent_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`666_agent_attributes`



.. raw:: html

   </td><td></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/ddos/detection/agent/{agent-name}/stats



.. raw:: html

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


:ref:`666_agent_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`666_agent_list`



.. 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/ddos/detection/agent/{agent-name}/stats



.. raw:: html

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


:ref:`666_agent_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/ddos/detection/agent/{agent-name}/stats



.. raw:: html

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


:ref:`666_agent_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`666_agent_list`



.. 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/ddos/detection/agent/{agent-name}/stats



.. raw:: html

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


:ref:`666_agent_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _666_agent_list:

agent-list
----------


    agent-list is **JSON List** of :ref:`666_agent_attributes` 

        agent-list : [

             { :ref:`666_agent_attributes` },

             { :ref:`666_agent_attributes` },

             ...

         ]

.. _666_agent_attributes:

agent attributes
----------------

    **agent-name**

        **Description** Specify name for the agent

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`666_stats` 

        **Type:** Object

.. _666_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **flow-detection-msgq-full**

        **Description** Detection Message Enqueue Failures

        **Type:** number

        **Format:** counter

    **flow-dst-entry-miss**

        **Description** DDoS Destination Entry Lookup Failures

        **Type:** number

        **Format:** counter

    **flow-ip-proto-or-port-miss**

        **Description** DDoS Destination Service Lookup Failures

        **Type:** number

        **Format:** counter

    **flow-network-entry-miss**

        **Description** DDoS Destination Network-object Entry Lookup Failures

        **Type:** number

        **Format:** counter

    **netflow-disabled**

        **Description** Netflow Flow Samples Processing Disabled

        **Type:** number

        **Format:** counter

    **netflow-icmp-sample-received**

        **Description** Netflow ICMP Samples Received

        **Type:** number

        **Format:** counter

    **netflow-other-sample-received**

        **Description** Netflow OTHER Samples Received

        **Type:** number

        **Format:** counter

    **netflow-record-copy-oom-error**

        **Description** Netflow Data Record Copy Fail, Local MEM size error

        **Type:** number

        **Format:** counter

    **netflow-record-rse-invalid**

        **Description** Netflow Data Record Reduced Size Invalid

        **Type:** number

        **Format:** counter

    **netflow-sample-flow-dur-error**

        **Description** Netflow Sample Flow Duration Error

        **Type:** number

        **Format:** counter

    **netflow-tcp-sample-received**

        **Description** Netflow TCP Samples Received

        **Type:** number

        **Format:** counter

    **netflow-udp-sample-received**

        **Description** Netflow UDP Samples received

        **Type:** number

        **Format:** counter

    **netflow-v10-max-records-exceed**

        **Description** Netflow v10 Sample Max records Error

        **Type:** number

        **Format:** counter

    **netflow-v10-packets-received**

        **Description** Netflow v10 Packets Received

        **Type:** number

        **Format:** counter

    **netflow-v10-sample-records-bad-len**

        **Description** Netflow v10 Sample Records Bad Length

        **Type:** number

        **Format:** counter

    **netflow-v10-samples-received**

        **Description** Netflow v10 Samples Received

        **Type:** number

        **Format:** counter

    **netflow-v10-samples-sent-for-detection**

        **Description** Netflow v10 Samples Procssed For Detection

        **Type:** number

        **Format:** counter

    **netflow-v5-max-records-exceed**

        **Description** Netflow v5 Sample Max Records Error

        **Type:** number

        **Format:** counter

    **netflow-v5-packets-received**

        **Description** Netflow v5 Packets Received

        **Type:** number

        **Format:** counter

    **netflow-v5-sample-records-bad-len**

        **Description** Netflow v5 Sample Records Bad Length

        **Type:** number

        **Format:** counter

    **netflow-v5-samples-received**

        **Description** Netflow v5 Samples Received

        **Type:** number

        **Format:** counter

    **netflow-v5-samples-sent-for-detection**

        **Description** Netflow v5 Samples Processed For Detection

        **Type:** number

        **Format:** counter

    **netflow-v9-max-records-exceed**

        **Description** Netflow v9 Sample Max Records Error

        **Type:** number

        **Format:** counter

    **netflow-v9-packets-received**

        **Description** Netflow v9 Packets Received

        **Type:** number

        **Format:** counter

    **netflow-v9-sample-flowset-bad-padding**

        **Description** Netflow v9 Sample Flowset Bad Padding

        **Type:** number

        **Format:** counter

    **netflow-v9-sample-records-bad-len**

        **Description** Netflow v9 Sample Records Bad Length

        **Type:** number

        **Format:** counter

    **netflow-v9-samples-received**

        **Description** Netflow v9 Samples Received

        **Type:** number

        **Format:** counter

    **netflow-v9-samples-sent-for-detection**

        **Description** Netflow v9 Samples Processed For Detection

        **Type:** number

        **Format:** counter

    **netflow-v9-template-not-found**

        **Description** Netflow v9 Template Not Found

        **Type:** number

        **Format:** counter

    **sflow-disabled**

        **Description** sFlow Packet Samples Processing Disabled

        **Type:** number

        **Format:** counter

    **sflow-packets-received**

        **Description** sFlow Packets Received

        **Type:** number

        **Format:** counter

    **sflow-sample-ipv6-hdr-parse-fail**

        **Description** sFlow Sample IPv6 Record Header Parse Failures

        **Type:** number

        **Format:** counter

    **sflow-sample-record-bad-len**

        **Description** sFlow Sample Records Bad Length

        **Type:** number

        **Format:** counter

    **sflow-sample-record-invalid-layer2**

        **Description** sFlow Sample Records Unknown Layer-2

        **Type:** number

        **Format:** counter

    **sflow-samples-bad-len**

        **Description** sFlow Samples Bad Length

        **Type:** number

        **Format:** counter

    **sflow-samples-non-std**

        **Description** sFlow Samples Non-standard

        **Type:** number

        **Format:** counter

    **sflow-samples-received**

        **Description** sFlow Samples Received

        **Type:** number

        **Format:** counter

    **sflow-samples-sent-for-detection**

        **Description** sFlow Samples Processed For Detection

        **Type:** number

        **Format:** counter

    **sflow-samples-skipped**

        **Description** sFlow Samples Skipped

        **Type:** number

        **Format:** counter