.. _interface_trunk_bfd:

interface trunk bfd
===================

Configure BFD (Bidirectional Forwarding Detection)


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

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

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

	 **Element Name**                      bfd

	 **Element URI**                       /axapi/v3/interface/trunk/{ifnum}/bfd

	 **Element Attributes**                bfd_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`bfd schema <interface-trunk-bfd/interface-trunk-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/interface/trunk/{ifnum}/bfd



.. raw:: html

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


:ref:`1980_bfd_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/interface_trunk_bfd_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/interface/trunk/{ifnum}/bfd



.. raw:: html

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


:ref:`1980_bfd_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/interface_trunk_bfd_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/interface/trunk/{ifnum}/bfd



.. raw:: html

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


:ref:`1980_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/interface/trunk/{ifnum}/bfd



.. raw:: html

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


:ref:`1980_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/interface/trunk/{ifnum}/bfd



.. raw:: html

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


:ref:`1980_bfd_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1980_bfd_attributes:

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

    **authentication**

        **Description:** authentication is a **JSON Block**.  Please see below for :ref:`1980_authentication` 

        **Type:** Object

    **demand**

        **Description** Demand mode

        **Type:** boolean

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

        **Default:** 0

    **echo**

        **Description** Enable BFD Echo

        **Type:** boolean

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

        **Default:** 0

    **interval-cfg**

        **Description:** interval-cfg is a **JSON Block**.  Please see below for :ref:`1980_interval-cfg` 

        **Type:** Object

    **per-member-port**

        **Description:** per-member-port is a **JSON Block**.  Please see below for :ref:`1980_per-member-port` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/interface/trunk/{ifnum}/bfd/per-member-port <interface_trunk>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1980_per-member-port:

per-member-port
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv6-local**

        **Description** IPv6 local-address

        **Type:** string

        **Format:** ipv6-address

    **ipv6-nbr**

        **Description** IPv6 neighbor-address

        **Type:** string

        **Format:** ipv6-address

    **local-address**

        **Description** IPv4 local-address

        **Type:** string

        **Format:** ipv4-address

    **neighbor-address**

        **Description** IPv4 neighbor address

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1980_interval-cfg:

interval-cfg
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **interval**

        **Description** Transmit interval between BFD packets (Milliseconds)

        **Type:** number

        **Range:** 48-1000

    **min-rx**

        **Description** Minimum receive interval capability (Milliseconds)

        **Type:** number

        **Range:** 48-1000

    **multiplier**

        **Description** Multiplier value used to compute holddown (value used to multiply the interval)

        **Type:** number

        **Range:** 3-50

.. _1980_authentication:

authentication
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **key-id**

        **Description** Key ID

        **Type:** number

        **Range:** 0-255

    **method**

        **Description** 'md5': Keyed MD5; 'meticulous-md5': Meticulous Keyed MD5; 'meticulous-sha1': Meticulous Keyed SHA1; 'sha1': Keyed SHA1; 'simple': Simple Password; 

        **Type:** string

        **Supported Values:** md5, meticulous-md5, meticulous-sha1, sha1, simple

    **password**

        **Description** Key String

        **Type:** string

        **Format:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters