.. _ddos_network_object_oper:

ddos network-object oper
========================

Operational Status for the object network-object


network-object Specification
----------------------------

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

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

	 **Collection Name**                   :ref:`1099_network-object_list`

	 **Collection URI**                    /axapi/v3/ddos/network-object/{object-name}

	                                       

	 **Element Name**                      network-object

	 **Element URI**                       /axapi/v3/ddos/network-object/{object-name}/oper

	 **Element Attributes**                network-object_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`1099_network-object_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/network-object/{object-name}



.. raw:: html

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


:ref:`1099_network-object_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/network-object/{object-name}/oper



.. raw:: html

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


:ref:`1099_network-object_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/network-object/{object-name}



.. raw:: html

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


:ref:`1099_network-object_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/network-object/{object-name}/oper



.. raw:: html

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


:ref:`1099_network-object_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/network-object/{object-name}/oper



.. raw:: html

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


:ref:`1099_network-object_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/network-object/{object-name}



.. raw:: html

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


:ref:`1099_network-object_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/network-object/{object-name}/oper



.. raw:: html

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


:ref:`1099_network-object_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1099_network-object_list:

network-object-list
-------------------


    network-object-list is **JSON List** of :ref:`1099_network-object_attributes` 

        network-object-list : [

             { :ref:`1099_network-object_attributes` },

             { :ref:`1099_network-object_attributes` },

             ...

         ]

.. _1099_network-object_attributes:

network-object attributes
-------------------------

    **object-name**

        **Description** 

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

        **Type:** Object

.. _1099_oper:

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

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

    **anomaly-ip-list**

        **Description** 

        **Type:** boolean

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

    **details**

        **Description** 

        **Type:** boolean

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

    **discovered-ip-list**

        **Description** 

        **Type:** boolean

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

    **discovered-list**

        **Description** 

        **Type:** boolean

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

    **entry-count**

        **Description** 

        **Type:** number

    **entry-list**

        **Type:** List

    **ipv4**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **port-end**

        **Description** 

        **Type:** number

    **port-start**

        **Description** 

        **Type:** number

    **protocol**

        **Description** 

        **Type:** number

    **single-layer-discovered-list**

        **Description** 

        **Type:** boolean

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

    **subnet-ip-addr**

        **Description** 

        **Type:** string

        **Format:** ipv4-cidr

    **subnet-ipv6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address-plen

    **victim-list**

        **Description** 

        **Type:** boolean

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

.. _1099_oper_entry-list:

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

	 **Block object keys**             

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

    **address**

        **Description** 

        **Type:** string

    **children-count**

        **Description** 

        **Type:** number

    **de-es-timestamp**

        **Description** 

        **Type:** string

    **es-timestamp**

        **Description** 

        **Type:** string

    **indicators**

        **Type:** List

    **is-anomaly**

        **Description** 

        **Type:** number

    **is-histogram-learning-done**

        **Description** 

        **Type:** number

    **is-learning-done**

        **Description** 

        **Type:** number

    **operational-mode**

        **Description** 

        **Type:** number

    **port**

        **Description** 

        **Type:** number

    **port-range-end**

        **Description** 

        **Type:** number

    **port-range-start**

        **Description** 

        **Type:** number

    **service-protocol**

        **Description** 

        **Type:** string

.. _1099_oper_entry-list_indicators:

oper_entry-list_indicators
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **indicator-index**

        **Description** 

        **Type:** number

    **indicator-name**

        **Description** 

        **Type:** string

    **is-anomaly**

        **Description** 

        **Type:** number

    **value**

        **Type:** List

.. _1099_oper_entry-list_indicators_value:

oper_entry-list_indicators_value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **current**

        **Description** 

        **Type:** string

    **threshold**

        **Description** 

        **Type:** string