.. _ip_route:

ip route
========

Establish static routes


route Specification
-------------------

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

	===================================== =================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      route

	 **Element URI**                       /axapi/v3/ip/route

	 **Element Attributes**                route_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ip/route



.. raw:: html

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


route_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2140_route_attributes:

route attributes
----------------

    **rib-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/route/rib/{ip-dest-addr}+{ip-mask} <ip_route_rib>`

    **source**

        **Description:** source is a **JSON Block**.  Please see below for :ref:`2140_source` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/route/source <ip_route_source>`

    **static**

        **Description:** static is a **JSON Block**.  Please see below for :ref:`2140_static` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ip/route/static <ip_route_static>`

.. _2140_rib-list:

rib-list
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **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

.. _2140_rib-list_ip-nexthop-lif:

rib-list_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

.. _2140_rib-list_ip-nexthop-ipv4:

rib-list_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

.. _2140_rib-list_ip-nexthop-tunnel:

rib-list_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

.. _2140_rib-list_ip-nexthop-partition:

rib-list_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

.. _2140_source:

source
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ve-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/route/source/ve/{ve-num}+{nexthop-ip} <ip_route_source_ve>`

.. _2140_source_ve-list:

source_ve-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **nexthop-ip**

        **Description** Nexthop IP address

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-num**

        **Description** 

        **Type:** number

        **Range:** 1-4094

.. _2140_static:

static
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bfd-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ip/route/static/bfd/{local-ip}+{nexthop-ip} <ip_route_static_bfd>`

.. _2140_static_bfd-list:

static_bfd-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'down': BFD down;  (BFD state)

        **Type:** string

        **Supported Values:** down

    **local-ip**

        **Description** Local IP address

        **Type:** string

        **Format:** ipv4-address

    **nexthop-ip**

        **Description** Nexthop IP address

        **Type:** string

        **Format:** ipv4-address

    **template**

        **Description** Configure tracking template (bind tracking template name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **threshold**

        **Description** action triggering threshold

        **Type:** number

        **Range:** 1-255

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters