.. _rule_set_oper:

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

Operational Status for the object rule-set


rule-set Specification
----------------------

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

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

	 **Collection Name**                   :ref:`2573_rule-set_list`

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

	                                       

	 **Element Name**                      rule-set

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

	 **Element Attributes**                rule-set_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`2573_rule-set_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}



.. raw:: html

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


:ref:`2573_rule-set_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}/oper



.. raw:: html

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


:ref:`2573_rule-set_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}



.. raw:: html

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


:ref:`2573_rule-set_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}/oper



.. raw:: html

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


:ref:`2573_rule-set_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}/oper



.. raw:: html

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


:ref:`2573_rule-set_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}



.. raw:: html

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


:ref:`2573_rule-set_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}/oper



.. raw:: html

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


:ref:`2573_rule-set_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2573_rule-set_list:

rule-set-list
-------------


    rule-set-list is **JSON List** of :ref:`2573_rule-set_attributes` 

        rule-set-list : [

             { :ref:`2573_rule-set_attributes` },

             { :ref:`2573_rule-set_attributes` },

             ...

         ]

.. _2573_rule-set_attributes:

rule-set attributes
-------------------

    **application**

        **Description:** application is a **JSON Block**.  Please see below for :ref:`2573_application` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/rule-set/{name}/rules-by-zone/application <rule_set>`

    **name**

        **Description** Rule set 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:`2573_oper` 

        **Type:** Object

    **rule-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/rule-set/{name}/rule/{name} <rule_set>`

    **rules-by-zone**

        **Description:** rules-by-zone is a **JSON Block**.  Please see below for :ref:`2573_rules-by-zone` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/rule-set/{name}/rules-by-zone <rule_set>`

    **track-app-rule-list**

        **Description:** track-app-rule-list is a **JSON Block**.  Please see below for :ref:`2573_track-app-rule-list` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/rule-set/{name}/rules-by-zone/application/track-app-rule-list <rule_set>`

.. _2573_oper:

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

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

    **policy-deny**

        **Description** 

        **Type:** number

    **policy-permit**

        **Description** 

        **Type:** number

    **policy-reset**

        **Description** 

        **Type:** number

    **policy-rule-count**

        **Description** 

        **Type:** number

    **policy-status**

        **Description** 

        **Type:** string

    **policy-unmatched-drop**

        **Description** 

        **Type:** number

    **rule-stats**

        **Type:** List

    **show-total-stats**

        **Description** 

        **Type:** string

    **topn-rules**

        **Description** 

        **Type:** string

    **total-active-icmp**

        **Description** 

        **Type:** number

    **total-active-others**

        **Description** 

        **Type:** number

    **total-active-tcp**

        **Description** 

        **Type:** number

    **total-active-udp**

        **Description** 

        **Type:** number

    **total-bytes**

        **Description** 

        **Type:** number

    **total-deny-bytes**

        **Description** 

        **Type:** number

    **total-deny-packets**

        **Description** 

        **Type:** number

    **total-hit**

        **Description** 

        **Type:** number

    **total-packets**

        **Description** 

        **Type:** number

    **total-permit-bytes**

        **Description** 

        **Type:** number

    **total-permit-packets**

        **Description** 

        **Type:** number

    **total-reset-bytes**

        **Description** 

        **Type:** number

    **total-reset-packets**

        **Description** 

        **Type:** number

.. _2573_oper_rule-stats:

oper_rule-stats
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **rule-action**

        **Description** 

        **Type:** string

    **rule-hitcount**

        **Description** 

        **Type:** number

    **rule-name**

        **Description** 

        **Type:** string

    **rule-status**

        **Description** 

        **Type:** string

.. _2573_track-app-rule-list:

track-app-rule-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2573_track-app-rule-list_oper` 

        **Type:** Object

.. _2573_track-app-rule-list_oper:

track-app-rule-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **rule-list**

        **Type:** List

.. _2573_track-app-rule-list_oper_rule-list:

track-app-rule-list_oper_rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **name**

        **Description** 

        **Type:** string

.. _2573_rule-list:

rule-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **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:`2573_rule-list_oper` 

        **Type:** Object

.. _2573_rule-list_oper:

rule-list_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

.. _2573_application:

application
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2573_application_oper` 

        **Type:** Object

.. _2573_application_oper:

application_oper
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **app-stat**

        **Description** 

        **Type:** string

    **category-stat**

        **Description** 

        **Type:** string

    **protocol**

        **Description** 

        **Type:** number

    **rule**

        **Description** 

        **Type:** string

    **rule-list**

        **Type:** List

    **rule-set-only**

        **Description** 

        **Type:** number

.. _2573_application_oper_rule-list:

application_oper_rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **name**

        **Description** 

        **Type:** string

    **stat-list**

        **Type:** List

.. _2573_application_oper_rule-list_stat-list:

application_oper_rule-list_stat-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **bytes**

        **Description** 

        **Type:** number

    **category**

        **Description** 

        **Type:** string

    **conns**

        **Description** 

        **Type:** number

    **name**

        **Description** 

        **Type:** string

    **type**

        **Description** 

        **Type:** string

.. _2573_rules-by-zone:

rules-by-zone
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2573_rules-by-zone_oper` 

        **Type:** Object

.. _2573_rules-by-zone_oper:

rules-by-zone_oper
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **group-list**

        **Type:** List

.. _2573_rules-by-zone_oper_group-list:

rules-by-zone_oper_group-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **from**

        **Description** 

        **Type:** string

    **rule-list**

        **Type:** List

    **to**

        **Description** 

        **Type:** string

.. _2573_rules-by-zone_oper_group-list_rule-list:

rules-by-zone_oper_group-list_rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 

        **Type:** string

    **dest-list**

        **Type:** List

    **dscp-list**

        **Type:** List

    **name**

        **Description** 

        **Type:** string

    **service-list**

        **Type:** List

    **source-list**

        **Type:** List

.. _2573_rules-by-zone_oper_group-list_rule-list_dscp-list:

rules-by-zone_oper_group-list_rule-list_dscp-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dscp**

        **Description** 

        **Type:** string

.. _2573_rules-by-zone_oper_group-list_rule-list_dest-list:

rules-by-zone_oper_group-list_rule-list_dest-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dest**

        **Description** 

        **Type:** string

.. _2573_rules-by-zone_oper_group-list_rule-list_source-list:

rules-by-zone_oper_group-list_rule-list_source-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **source**

        **Description** 

        **Type:** string

.. _2573_rules-by-zone_oper_group-list_rule-list_service-list:

rules-by-zone_oper_group-list_rule-list_service-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **service**

        **Description** 

        **Type:** string