.. _ddos_sync_oper:

ddos sync oper
==============

Operational Status for the object sync


sync Specification
------------------

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

	===================================== =======================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      sync

	 **Element URI**                       /axapi/v3/ddos/sync/oper

	 **Element Attributes**                sync_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`sync schema <ddos-sync-oper/ddos-sync-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/sync/oper



.. raw:: html

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


:ref:`1175_sync_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/sync/oper



.. raw:: html

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


:ref:`1175_sync_attributes`



.. 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/sync/oper



.. raw:: html

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


:ref:`1175_sync_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/sync/oper



.. raw:: html

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


:ref:`1175_sync_attributes`



.. 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/sync/oper



.. raw:: html

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


:ref:`1175_sync_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1175_sync_attributes:

sync attributes
---------------

    **oper**

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

        **Type:** Object

.. _1175_oper:

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

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

    **error-str**

        **Description** 

        **Type:** string

    **if-show-error-num**

        **Description** 

        **Type:** number

    **local-ip**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **peer-list**

        **Type:** List

    **status**

        **Description** DDOS sync status

        **Type:** string

        **Supported Values:** ENABLED, DISABLED

    **total-message-received**

        **Description** Total number of messages received on this device

        **Type:** number

    **total-message-sent**

        **Description** Total number of messages sent from this device

        **Type:** number

.. _1175_oper_peer-list:

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

	 **Block object keys**             

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

    **peer-heartbeat-missing**

        **Description** Number of heartbeat messages expected from the peer that did not arrive

        **Type:** number

    **peer-ip**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **peer-message-received**

        **Description** Number of messages received from this peer

        **Type:** number

    **peer-message-sent**

        **Description** Number messages sent to this peer

        **Type:** number

    **peer-status**

        **Description** Status of the connection with the peer

        **Type:** string

        **Supported Values:** UP, DOWN