.. _interface_tunnel_oper:

interface tunnel oper
=====================

Operational Status for the object tunnel


tunnel Specification
--------------------

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

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

	 **Collection Name**                   :ref:`2020_tunnel_list`

	 **Collection URI**                    /axapi/v3/interface/tunnel/{ifnum}

	                                       

	 **Element Name**                      tunnel

	 **Element URI**                       /axapi/v3/interface/tunnel/{ifnum}/oper

	 **Element Attributes**                tunnel_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`tunnel schema <interface-tunnel-oper/interface-tunnel-oper.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/tunnel/{ifnum}



.. raw:: html

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


:ref:`2020_tunnel_attributes`



.. raw:: html

   </td><td></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/interface/tunnel/{ifnum}



.. raw:: html

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


:ref:`2020_tunnel_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/interface/tunnel/{ifnum}/oper



.. raw:: html

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


:ref:`2020_tunnel_attributes`



.. raw:: html

   </td><td></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/interface/tunnel/{ifnum}



.. raw:: html

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


:ref:`2020_tunnel_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/interface/tunnel/{ifnum}/oper



.. raw:: html

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


:ref:`2020_tunnel_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/tunnel/{ifnum}/oper



.. raw:: html

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


:ref:`2020_tunnel_attributes`



.. raw:: html

   </td><td></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/interface/tunnel/{ifnum}



.. raw:: html

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


:ref:`2020_tunnel_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/interface/tunnel/{ifnum}/oper



.. raw:: html

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


:ref:`2020_tunnel_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2020_tunnel_list:

tunnel-list
-----------


    tunnel-list is **JSON List** of :ref:`2020_tunnel_attributes` 

        tunnel-list : [

             { :ref:`2020_tunnel_attributes` },

             { :ref:`2020_tunnel_attributes` },

             ...

         ]

.. _2020_tunnel_attributes:

tunnel attributes
-----------------

    **ifnum**

        **Description** Tunnel interface number

        **Type:** number

        **Range:** 1-128

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2020_oper` 

        **Type:** Object

.. _2020_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **config-speed**

        **Description** 

        **Type:** number

        **Range:** 1-200

    **ipv4-address**

        **Description** IPv4 address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-netmask**

        **Description** IPv4 subnet mask

        **Type:** string

        **Format:** ipv4-netmask

    **ipv4_addr_count**

        **Description** 

        **Type:** number

    **ipv4_list**

        **Type:** List

    **ipv6-link-local**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **ipv6-link-local-prefix**

        **Description** 

        **Type:** string

    **ipv6-link-local-scope**

        **Description** 

        **Type:** string

    **ipv6-link-local-type**

        **Description** 

        **Type:** string

    **ipv6_addr_count**

        **Description** 

        **Type:** number

    **ipv6_list**

        **Type:** List

    **line-protocol**

        **Description** 

        **Type:** string

        **Supported Values:** up, down

    **link-type**

        **Description** 

        **Type:** string

    **mac**

        **Description** 

        **Type:** string

        **Format:** mac-address

        **Maximum Length:** 17 characters

        **Maximum Length:** 11 characters

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** up, disabled, down

.. _2020_oper_ipv6_list:

oper_ipv6_list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv6-address

    **is_anycast**

        **Description** 

        **Type:** number

    **prefix**

        **Description** IP subnet mask

        **Type:** string

.. _2020_oper_ipv4_list:

oper_ipv4_list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **mask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask