.. _ipv6_route:

ipv6 route
==========

Establish static routes


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

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

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

	 **Element Name**                      route

	 **Element URI**                       /axapi/v3/ipv6/route

	 **Element Attributes**                route_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


route_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2202_route_attributes:

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

    **rib-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/route/rib/{ipv6-address} <ipv6_route_rib>`

    **source**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ipv6/route/source <ipv6_route_source>`

    **static**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ipv6/route/static <ipv6_route_static>`

.. _2202_rib-list:

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

	 **Block object keys**             

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

    **ipv6-address**

        **Description** IPV6 address

        **Type:** string

        **Format:** ipv6-address-plen

    **ipv6-nexthop-ipv6**

        **Type:** List

    **ipv6-nexthop-tunnel**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2202_rib-list_ipv6-nexthop-tunnel:

rib-list_ipv6-nexthop-tunnel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **description**

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

    **ipv6-nexthop-tunnel-addr**

        **Description** Forwarding router's address

        **Type:** string

        **Format:** ipv6-address

    **tunnel**

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

        **Type:** number

        **Range:** 1-128

.. _2202_rib-list_ipv6-nexthop-ipv6:

rib-list_ipv6-nexthop-ipv6
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **description**

        **Description** Description for static route

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **distance**

        **Description** Distance value for this route

        **Type:** number

        **Range:** 1-255

        **Default:** 1

    **ethernet**

        **Description** Ethernet interface (Ethernet interface number)

        **Type:** number

        **Format:** interface

    **ipv6-nexthop**

        **Description** Forwarding router's address

        **Type:** string

        **Format:** ipv6-address

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Format:** interface

    **ve**

        **Description** Virtual Ethernet interface (Virtual Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _2202_source:

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

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

    **ve-list**

        **Type:** List

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

.. _2202_source_ve-list:

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

	 **Block object keys**             

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

    **nexthop-ip**

        **Description** Nexthop IPv6 address

        **Type:** string

        **Format:** ipv6-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

.. _2202_static:

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

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

    **bfd**

        **Description:** bfd is a **JSON Block**.  Please see below for :ref:`2202_static_bfd` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd <ipv6_route_static_bfd>`

.. _2202_static_bfd:

static_bfd
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bfd-ipv6-list**

        **Type:** List

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

    **ethernet-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd/ethernet/{eth-num}+{nexthop-ipv6-ll} <ipv6_route_static_bfd_ethernet>`

    **trunk-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd/trunk/{trunk-num}+{nexthop-ipv6-ll} <ipv6_route_static_bfd_trunk>`

    **ve-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd/ve/{ve-num}+{nexthop-ipv6-ll} <ipv6_route_static_bfd_ve>`

.. _2202_static_bfd_bfd-ipv6-list:

static_bfd_bfd-ipv6-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

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

        **Type:** string

        **Supported Values:** down

    **local-ipv6**

        **Description** Local IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **nexthop-ipv6**

        **Description** Nexthop IPv6 address

        **Type:** string

        **Format:** ipv6-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

.. _2202_static_bfd_ethernet-list:

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

	 **Block object keys**             

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

    **action**

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

        **Type:** string

        **Supported Values:** down

    **eth-num**

        **Description** Ethernet (not a member of vlan or trunk)

        **Type:** number

        **Range:** 0-2147483647

    **nexthop-ipv6-ll**

        **Description** Nexthop IPv6 address (Link-local)

        **Type:** string

        **Format:** ipv6-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

.. _2202_static_bfd_trunk-list:

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

	 **Block object keys**             

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

    **action**

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

        **Type:** string

        **Supported Values:** down

    **nexthop-ipv6-ll**

        **Description** Nexthop IPv6 address (Link-local)

        **Type:** string

        **Format:** ipv6-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

    **trunk-num**

        **Description** Trunk interface

        **Type:** number

        **Range:** 1-4096

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2202_static_bfd_ve-list:

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

	 **Block object keys**             

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

    **action**

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

        **Type:** string

        **Supported Values:** down

    **nexthop-ipv6-ll**

        **Description** Nexthop IPv6 address (Link-local)

        **Type:** string

        **Format:** ipv6-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

    **ve-num**

        **Description** Virtual ethernet interface

        **Type:** number

        **Range:** 2-4094