.. _system_bfd:

system bfd
==========

BFD Statistics


bfd Specification
-----------------

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

	 **Element Name**                      bfd

	 **Element URI**                       /axapi/v3/system/bfd

	 **Element Attributes**                bfd_attributes

	 **Statistics Data URI**               /axapi/v3/system/bfd/stats

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



.. raw:: html

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


:ref:`1986_bfd_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/system/bfd



.. raw:: html

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


:ref:`1986_bfd_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/system/bfd



.. raw:: html

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


:ref:`1986_bfd_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/system/bfd



.. raw:: html

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


:ref:`1986_bfd_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/system/bfd



.. raw:: html

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


:ref:`1986_bfd_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1986_bfd_attributes:

bfd attributes
--------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1986_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'ip_checksum_error': IP packet checksum errors; 'udp_checksum_error': UDP packet checksum errors; 'session_not_found': Session not found; 'multihop_mismatch': Multihop session or packet mismatch; 'version_mismatch': BFD version mismatch; 'length_too_small': Packets too small; 'data_is_short': Packet data length too short; 'invalid_detect_mult': Invalid detect multiplier; 'invalid_multipoint': Invalid multipoint setting; 'invalid_my_disc': Invalid my descriptor; 'invalid_ttl': Invalid TTL; 'auth_length_invalid': Invalid authentication length; 'auth_mismatch': Authentication mismatch; 'auth_type_mismatch': Authentication type mismatch; 'auth_key_id_mismatch': Authentication key-id mismatch; 'auth_key_mismatch': Authentication key mismatch; 'auth_seqnum_invalid': Invalid authentication sequence number; 'auth_failed': Authentication failures; 'local_state_admin_down': Local admin down session state; 'dest_unreachable': Destination unreachable; 'no_ipv6_enable': No IPv6 enable; 'other_error': Other errors; 

        **Type:** string

        **Supported Values:** all, ip_checksum_error, udp_checksum_error, session_not_found, multihop_mismatch, version_mismatch, length_too_small, data_is_short, invalid_detect_mult, invalid_multipoint, invalid_my_disc, invalid_ttl, auth_length_invalid, auth_mismatch, auth_type_mismatch, auth_key_id_mismatch, auth_key_mismatch, auth_seqnum_invalid, auth_failed, local_state_admin_down, dest_unreachable, no_ipv6_enable, other_error

.. _1986_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - no_ipv6_enable
      - 2
      - No IPv6 enable

   *  - 
      - auth_length_invalid
      - 2
      - Invalid authentication length

   *  - 
      - auth_key_mismatch
      - 2
      - Authentication key mismatch

   *  - 
      - length_too_small
      - 2
      - Packets too small

   *  - 
      - auth_mismatch
      - 2
      - Authentication mismatch

   *  - 
      - invalid_ttl
      - 2
      - Invalid TTL

   *  - 
      - auth_key_id_mismatch
      - 2
      - Authentication key-id mismatch

   *  - 
      - dest_unreachable
      - 2
      - Destination unreachable

   *  - 
      - udp_checksum_error
      - 2
      - UDP packet checksum errors

   *  - 
      - other_error
      - 2
      - Other errors

   *  - 
      - invalid_my_disc
      - 2
      - Invalid my descriptor

   *  - 
      - auth_failed
      - 2
      - Authentication failures

   *  - 
      - invalid_detect_mult
      - 2
      - Invalid detect multiplier

   *  - 
      - invalid_multipoint
      - 2
      - Invalid multipoint setting

   *  - 
      - session_not_found
      - 2
      - Session not found

   *  - 
      - local_state_admin_down
      - 2
      - Local admin down session state

   *  - 
      - ip_checksum_error
      - 2
      - IP packet checksum errors

   *  - 
      - version_mismatch
      - 2
      - BFD version mismatch

   *  - 
      - multihop_mismatch
      - 2
      - Multihop session or packet mismatch

   *  - 
      - auth_type_mismatch
      - 2
      - Authentication type mismatch

   *  - 
      - data_is_short
      - 2
      - Packet data length too short

   *  - 
      - auth_seqnum_invalid
      - 2
      - Invalid authentication sequence number