.. _rule_set_rule_oper:

rule-set rule oper
==================

Operational Status for the object rule


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

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

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

	 **Collection Name**                   :ref:`2576_rule_list`

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

	                                       

	 **Element Name**                      rule

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

	 **Element Attributes**                rule_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`rule schema <rule-set-rule-oper/rule-set-rule-oper.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:`2576_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:`2576_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}/oper



.. raw:: html

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


:ref:`2576_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:`2576_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}/oper



.. raw:: html

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


:ref:`2576_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}/oper



.. raw:: html

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


:ref:`2576_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:`2576_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}/oper



.. raw:: html

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


:ref:`2576_rule_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2576_rule_list:

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


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

        rule-list : [

             { :ref:`2576_rule_attributes` },

             { :ref:`2576_rule_attributes` },

             ...

         ]

.. _2576_rule_attributes:

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

    **name**

        **Description** Rule name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2576_oper` 

        **Type:** Object

.. _2576_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 

        **Type:** string

    **activesessionicmp**

        **Description** 

        **Type:** number

    **activesessionother**

        **Description** 

        **Type:** number

    **activesessionsctp**

        **Description** 

        **Type:** number

    **activesessiontcp**

        **Description** 

        **Type:** number

    **activesessiontotal**

        **Description** 

        **Type:** number

    **activesessionudp**

        **Description** 

        **Type:** number

    **denybytes**

        **Description** 

        **Type:** number

    **denypackets**

        **Description** 

        **Type:** number

    **hitcount**

        **Description** 

        **Type:** number

    **last-hitcount-time**

        **Description** 

        **Type:** string

    **permitbytes**

        **Description** 

        **Type:** number

    **permitpackets**

        **Description** 

        **Type:** number

    **ratelimitdrops**

        **Description** 

        **Type:** number

    **resetbytes**

        **Description** 

        **Type:** number

    **resetpackets**

        **Description** 

        **Type:** number

    **sessionicmp**

        **Description** 

        **Type:** number

    **sessionother**

        **Description** 

        **Type:** number

    **sessionsctp**

        **Description** 

        **Type:** number

    **sessiontcp**

        **Description** 

        **Type:** number

    **sessiontotal**

        **Description** 

        **Type:** number

    **sessionudp**

        **Description** 

        **Type:** number

    **status**

        **Description** 

        **Type:** string

    **totalbytes**

        **Description** 

        **Type:** number

    **totalpackets**

        **Description** 

        **Type:** number