.. _ddos_src_based_policy_oper:

ddos src-based-policy oper
==========================

Operational Status for the object src-based-policy


src-based-policy Specification
------------------------------

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

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

	 **Collection Name**                   :ref:`1205_src-based-policy_list`

	 **Collection URI**                    /axapi/v3/ddos/src-based-policy/{name}

	                                       

	 **Element Name**                      src-based-policy

	 **Element URI**                       /axapi/v3/ddos/src-based-policy/{name}/oper

	 **Element Attributes**                src-based-policy_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`src-based-policy schema <ddos-src-based-policy-oper/ddos-src-based-policy-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/ddos/src-based-policy/{name}



.. raw:: html

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


:ref:`1205_src-based-policy_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/src-based-policy/{name}



.. raw:: html

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


:ref:`1205_src-based-policy_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/src-based-policy/{name}/oper



.. raw:: html

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


:ref:`1205_src-based-policy_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/src-based-policy/{name}



.. raw:: html

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


:ref:`1205_src-based-policy_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/src-based-policy/{name}/oper



.. raw:: html

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


:ref:`1205_src-based-policy_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/src-based-policy/{name}/oper



.. raw:: html

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


:ref:`1205_src-based-policy_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/src-based-policy/{name}



.. raw:: html

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


:ref:`1205_src-based-policy_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/src-based-policy/{name}/oper



.. raw:: html

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


:ref:`1205_src-based-policy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1205_src-based-policy_list:

src-based-policy-list
---------------------


    src-based-policy-list is **JSON List** of :ref:`1205_src-based-policy_attributes` 

        src-based-policy-list : [

             { :ref:`1205_src-based-policy_attributes` },

             { :ref:`1205_src-based-policy_attributes` },

             ...

         ]

.. _1205_src-based-policy_attributes:

src-based-policy attributes
---------------------------

    **name**

        **Description** Specify name of the policy

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

        **Type:** Object

.. _1205_oper:

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

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

    **all-entries**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **class-list-entries**

        **Type:** List

    **geoloc-ipv4-total-single-ip**

        **Description** 

        **Type:** number

    **geoloc-ipv4-total-subnet**

        **Description** 

        **Type:** number

    **geoloc-ipv6-total-single-ip**

        **Description** 

        **Type:** number

    **geoloc-ipv6-total-subnet**

        **Description** 

        **Type:** number

    **ipv4-total-single-ip**

        **Description** 

        **Type:** number

    **ipv4-total-subnet**

        **Description** 

        **Type:** number

    **ipv6-total-single-ip**

        **Description** 

        **Type:** number

    **ipv6-total-subnet**

        **Description** 

        **Type:** number

    **resource-usage**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

    **src-based-policy-name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

.. _1205_oper_class-list-entries:

oper_class-list-entries
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **address**

        **Description** 

        **Type:** string

    **class-list-name**

        **Description** 

        **Type:** string

    **geo-location-name**

        **Description** 

        **Type:** string