.. _fail_safe:

fail-safe
=========

Fail Safe Global Commands


fail-safe Specification
-----------------------

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

	 **Element Name**                      fail-safe

	 **Element URI**                       /axapi/v3/fail-safe

	 **Element Attributes**                fail-safe_attributes

	 **Operational Data URI**              /axapi/v3/fail-safe/oper

	 **Schema**                             :download:`fail-safe schema <fail-safe/fail-safe.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/fail-safe



.. raw:: html

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


:ref:`932_fail-safe_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/fail_safe_POST.txt
   :literal:




.. raw:: html

   </div></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/fail-safe



.. raw:: html

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


:ref:`932_fail-safe_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/fail_safe_GET.txt
   :literal:




.. raw:: html

   </div></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/fail-safe



.. raw:: html

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


:ref:`932_fail-safe_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/fail-safe



.. raw:: html

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


:ref:`932_fail-safe_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/fail_safe_PUT.txt
   :literal:




.. raw:: html

   </div></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/fail-safe



.. raw:: html

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


:ref:`932_fail-safe_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/fail_safe_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _932_fail-safe_attributes:

fail-safe attributes
--------------------

    **config**

        **Description:** config is a **JSON Block**.  Please see below for :ref:`932_config` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/fail-safe/config <fail_safe_config>`

    **fpga-buff-recovery-threshold**

        **Description** FPGA buffers recovery threshold (Units of 256 buffers (default 2))

        **Type:** number

        **Range:** 1-10

        **Default:** 2

    **hw-error-monitor**

        **Description** 'hw-error-monitor-disable': Disable fail-safe hardware error monitor; 'hw-error-monitor-enable': Enable fail-safe hardware error monitor; 

        **Type:** string

        **Supported Values:** hw-error-monitor-disable, hw-error-monitor-enable

        **Default:** hw-error-monitor-enable

    **hw-error-recovery-timeout**

        **Description** Hardware error recovery timeout (minutes) (waiting time of recovery from hardware errors (default 0))

        **Type:** number

        **Range:** 1-1440

    **kill**

        **Description** Stop the traffic and log the event

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** kill and log are mutually exclusive

    **log**

        **Description** Log the event

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** log and kill are mutually exclusive

    **sw-error-monitor-enable**

        **Description** Enable fail-safe software error monitor

        **Type:** boolean

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

        **Default:** 0

    **sw-error-recovery-timeout**

        **Description** Software error recovery timeout (minutes) (waiting time of recovery from software errors (default 3))

        **Type:** number

        **Range:** 1-1440

        **Default:** 3

    **total-memory-size-check**

        **Description** Check total memory size of current system (Size of memory (GB))

        **Type:** number

        **Range:** 1-256

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _932_config:

config
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _932_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - total_system_memory
      - number
      - total_system_memory

   *  - 
      - total_free_fpga_buff
      - number
      - total_free_fpga_buff

   *  - 
      - total_fpga_buffers
      - number
      - total_fpga_buffers

   *  - 
      - free_fpga_buffers
      - number
      - free_fpga_buffers

   *  - 
      - free_session_memory
      - number
      - free_session_memory

   *  - 
      - avail_fpga_buff_domain1
      - number
      - avail_fpga_buff_domain1

   *  - 
      - avail_fpga_buff_domain2
      - number
      - avail_fpga_buff_domain2

   *  - 
      - total_session_memory
      - number
      - total_session_memory

   *  - 
      - fpga_buff_recovery_threshold
      - number
      - fpga_buff_recovery_threshold

   *  - 
      - sess_mem_recovery_threshold
      - number
      - sess_mem_recovery_threshold