.. _bgp:

bgp
===

Border Gateway Protocol (BGP)


bgp Specification
-----------------

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

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

	 **Element Name**                      bgp

	 **Element URI**                       /axapi/v3/bgp

	 **Element Attributes**                bgp_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`225_bgp_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/bgp_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/bgp



.. raw:: html

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


:ref:`225_bgp_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/bgp_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/bgp



.. raw:: html

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


:ref:`225_bgp_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/bgp



.. raw:: html

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


:ref:`225_bgp_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/bgp_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/bgp



.. raw:: html

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


:ref:`225_bgp_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/bgp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _225_bgp_attributes:

bgp attributes
--------------

    **asdot**

        **Description** Enable ASDot notation

        **Type:** boolean

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

        **Default:** 0

    **asdot-plus**

        **Description** Enable ASDot+ notation

        **Type:** boolean

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

        **Default:** 0

    **disable-advertisement**

        **Description:** disable-advertisement is a **JSON Block**.  Please see below for :ref:`225_disable-advertisement` 

        **Type:** Object

    **extended-asn-cap**

        **Description** Enable the router to send 4-octet ASN capabilities

        **Type:** boolean

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

        **Default:** 0

    **nexthop-trigger**

        **Description:** nexthop-trigger is a **JSON Block**.  Please see below for :ref:`225_nexthop-trigger` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _225_disable-advertisement:

disable-advertisement
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **on-boot**

        **Description** Upon boot-up

        **Type:** boolean

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

        **Default:** 0

.. _225_nexthop-trigger:

nexthop-trigger
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delay**

        **Description** Configure nexthop trigger delay time interval (Nexthop Trigger Delay time interval between 1 and 100)

        **Type:** number

        **Range:** 1-100

    **enable**

        **Description** Enable the nexthop tracking functionality

        **Type:** boolean

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

        **Default:** 0