.. _traffic_control_rule_set_oper:

traffic-control rule-set oper
=============================

Operational Status for the object rule-set


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

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

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

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

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

	                                       

	 **Element Name**                      rule-set

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

	 **Element Attributes**                rule-set_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`3512_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/traffic-control/rule-set/{name}



.. raw:: html

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


:ref:`3512_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/traffic-control/rule-set/{name}/oper



.. raw:: html

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


:ref:`3512_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/traffic-control/rule-set/{name}



.. raw:: html

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


:ref:`3512_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/traffic-control/rule-set/{name}/oper



.. raw:: html

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


:ref:`3512_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/traffic-control/rule-set/{name}/oper



.. raw:: html

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


:ref:`3512_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/traffic-control/rule-set/{name}



.. raw:: html

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


:ref:`3512_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/traffic-control/rule-set/{name}/oper



.. raw:: html

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


:ref:`3512_rule-set_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3512_rule-set_list:

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


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

        rule-set-list : [

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

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

             ...

         ]

.. _3512_rule-set_attributes:

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

    **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:`3512_oper` 

        **Type:** Object

    **rule-list**

        **Type:** List

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

.. _3512_oper:

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

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

    **policy-rule-count**

        **Description** 

        **Type:** number

    **policy-status**

        **Description** 

        **Type:** string

    **rule-stats**

        **Type:** List

.. _3512_oper_rule-stats:

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

	 **Block object keys**             

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

    **rule-hitcount**

        **Description** 

        **Type:** number

    **rule-name**

        **Description** 

        **Type:** string

    **rule-status**

        **Description** 

        **Type:** string

.. _3512_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:`3512_rule-list_oper` 

        **Type:** Object

.. _3512_rule-list_oper:

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

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

    **hitcount**

        **Description** 

        **Type:** number

    **status**

        **Description** 

        **Type:** string