.. _ip_route_rib:

ip route rib
============

Establish static routes


rib Specification
-----------------

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

	===================================== ==============================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *ip-dest-addr, ip-mask*

	 **Collection Name**                   :ref:`2135_rib_list`

	 **Collection URI**                    /axapi/v3/ip/route/rib

	                                       

	 **Element Name**                      rib

	 **Element URI**                       /axapi/v3/ip/route/rib/{ip-dest-addr}+{ip-mask}

	 **Element Attributes**                rib_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2135_rib_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/ip_route_rib_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ip/route/rib



.. raw:: html

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


:ref:`2135_rib_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/ip/route/rib/{ip-dest-addr}+{ip-mask}



.. raw:: html

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


:ref:`2135_rib_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/ip_route_rib_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ip/route/rib



.. raw:: html

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


:ref:`2135_rib_list`



.. 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/ip/route/rib/{ip-dest-addr}+{ip-mask}



.. raw:: html

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


:ref:`2135_rib_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/ip/route/rib/{ip-dest-addr}+{ip-mask}



.. raw:: html

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


:ref:`2135_rib_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/ip_route_rib_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/ip/route/rib



.. raw:: html

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


:ref:`2135_rib_list`



.. 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/ip/route/rib/{ip-dest-addr}+{ip-mask}



.. raw:: html

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


:ref:`2135_rib_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/ip_route_rib_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2135_rib_list:

rib-list
--------


    rib-list is **JSON List** of :ref:`2135_rib_attributes` 

        rib-list : [

             { :ref:`2135_rib_attributes` },

             { :ref:`2135_rib_attributes` },

             ...

         ]

.. _2135_rib_attributes:

rib attributes
--------------

    **ip-dest-addr**

        **Description** Destination prefix

        **Type:** string

        **Format:** ipv4-address

    **ip-mask**

        **Description** Destination prefix mask

        **Type:** string

        **Format:** ipv4-netmask-brief

    **ip-nexthop-ipv4**

        **Type:** List

    **ip-nexthop-lif**

        **Type:** List

    **ip-nexthop-partition**

        **Type:** List

    **ip-nexthop-tunnel**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2135_ip-nexthop-lif:

ip-nexthop-lif
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **description-nexthop-lif**

        **Description** Description for static route

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **lif**

        **Description** LIF Interface (Logical tunnel interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

.. _2135_ip-nexthop-ipv4:

ip-nexthop-ipv4
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **description-nexthop-ip**

        **Description** Description for static route

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **distance-nexthop-ip**

        **Description** Distance value for this route

        **Type:** number

        **Range:** 1-255

        **Default:** 1

    **ip-next-hop**

        **Description** Forwarding router's address

        **Type:** string

        **Format:** ipv4-address

.. _2135_ip-nexthop-tunnel:

ip-nexthop-tunnel
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **description-nexthop-tunnel**

        **Description** Description for static route

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **distance-nexthop-tunnel**

        **Description** Distance value for this route

        **Type:** number

        **Range:** 1-255

        **Default:** 1

    **ip-next-hop-tunnel**

        **Description** Forwarding router's address

        **Type:** string

        **Format:** ipv4-address

    **tunnel**

        **Description** Tunnel interface (Tunnel interface number)

        **Type:** number

        **Range:** 1-128

.. _2135_ip-nexthop-partition:

ip-nexthop-partition
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **description-nexthop-partition**

        **Description** Description for static route

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **description-partition-vrid**

        **Description** Description for static route

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **partition-name**

        **Description** Name of network partition

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

    **vrid-num-in-partition**

        **Description** Specify ha VRRP-A vrid

        **Type:** number

        **Range:** 0-31