.. _rule_set_rule_stats:

rule-set rule stats
===================

Statistics for the object rule


rule Specification
------------------

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

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

	 **Collection Name**                   :ref:`1804_rule_list`

	 **Collection URI**                    /axapi/v3/rule-set/{name}/rule/{name}

	                                       

	 **Element Name**                      rule

	 **Element URI**                       /axapi/v3/rule-set/{name}/rule/{name}/stats

	 **Element Attributes**                rule_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`rule schema <rule-set-rule-stats/rule-set-rule-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/rule-set/{name}/rule/{name}



.. raw:: html

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


:ref:`1804_rule_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/rule-set/{name}/rule/{name}



.. raw:: html

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


:ref:`1804_rule_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/rule-set/{name}/rule/{name}/stats



.. raw:: html

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


:ref:`1804_rule_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/rule-set/{name}/rule/{name}



.. raw:: html

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


:ref:`1804_rule_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/rule-set/{name}/rule/{name}/stats



.. raw:: html

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


:ref:`1804_rule_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/rule-set/{name}/rule/{name}/stats



.. raw:: html

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


:ref:`1804_rule_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/rule-set/{name}/rule/{name}



.. raw:: html

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


:ref:`1804_rule_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/rule-set/{name}/rule/{name}/stats



.. raw:: html

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


:ref:`1804_rule_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1804_rule_list:

rule-list
---------


    rule-list is **JSON List** of :ref:`1804_rule_attributes` 

        rule-list : [

             { :ref:`1804_rule_attributes` },

             { :ref:`1804_rule_attributes` },

             ...

         ]

.. _1804_rule_attributes:

rule attributes
---------------

    **name**

        **Description** Rule name

        **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:`1804_stats` 

        **Type:** Object

.. _1804_stats:

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

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

    **active-session-icmp**

        **Description** Active ICMP session counter

        **Type:** number

        **Format:** counter

    **active-session-other**

        **Description** Active other protocol session counter

        **Type:** number

        **Format:** counter

    **active-session-sctp**

        **Description** Active SCTP session counter

        **Type:** number

        **Format:** counter

    **active-session-tcp**

        **Description** Active TCP session counter

        **Type:** number

        **Format:** counter

    **active-session-udp**

        **Description** Active UDP session counter

        **Type:** number

        **Format:** counter

    **deny-bytes**

        **Description** Denied bytes counter

        **Type:** number

        **Format:** counter

    **deny-packets**

        **Description** Denied packets counter

        **Type:** number

        **Format:** counter

    **hit-count**

        **Description** Hit counts

        **Type:** number

        **Format:** counter

    **hitcount-timestamp**

        **Description** Last hit counts timestamp

        **Type:** number

        **Format:** counter

    **permit-bytes**

        **Description** Permitted bytes counter

        **Type:** number

        **Format:** counter

    **permit-packets**

        **Description** Permitted packets counter

        **Type:** number

        **Format:** counter

    **rate-limit-drops**

        **Description** Rate Limit Drops

        **Type:** number

        **Format:** counter

    **reset-bytes**

        **Description** Reset bytes counter

        **Type:** number

        **Format:** counter

    **reset-packets**

        **Description** Reset packets counter

        **Type:** number

        **Format:** counter

    **session-icmp**

        **Description** ICMP session counter

        **Type:** number

        **Format:** counter

    **session-other**

        **Description** Other protocol session counter

        **Type:** number

        **Format:** counter

    **session-sctp**

        **Description** SCTP session counter

        **Type:** number

        **Format:** counter

    **session-tcp**

        **Description** TCP session counter

        **Type:** number

        **Format:** counter

    **session-udp**

        **Description** UDP session counter

        **Type:** number

        **Format:** counter