.. _interface_ethernet_ipv6_router_ospf:

interface ethernet ipv6 router ospf
===================================

Open Shortest Path First for IPv6 (OSPFv3)


ospf Specification
------------------

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

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

	 **Element Name**                      ospf

	 **Element URI**                       /axapi/v3/interface/ethernet/{ifnum}/ipv6/router/ospf

	 **Element Attributes**                ospf_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ospf schema <interface-ethernet-ipv6-router-ospf/interface-ethernet-ipv6-router-ospf.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/ethernet/{ifnum}/ipv6/router/ospf



.. raw:: html

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


:ref:`1918_ospf_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/interface_ethernet_ipv6_router_ospf_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/interface/ethernet/{ifnum}/ipv6/router/ospf



.. raw:: html

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


:ref:`1918_ospf_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/interface_ethernet_ipv6_router_ospf_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/interface/ethernet/{ifnum}/ipv6/router/ospf



.. raw:: html

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


:ref:`1918_ospf_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/ethernet/{ifnum}/ipv6/router/ospf



.. raw:: html

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


:ref:`1918_ospf_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/interface_ethernet_ipv6_router_ospf_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/interface/ethernet/{ifnum}/ipv6/router/ospf



.. raw:: html

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


:ref:`1918_ospf_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/interface_ethernet_ipv6_router_ospf_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1918_ospf_attributes:

ospf attributes
---------------

    **area-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1918_area-list:

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

	 **Block object keys**             

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

    **area-id-addr**

        **Description** OSPF area ID in IP address format

        **Type:** string

        **Format:** ipv4-address

    **area-id-num**

        **Description** OSPF area ID as a decimal value

        **Type:** number

        **Range:** 0-4294967295

    **instance-id**

        **Description** Set the interface instance ID

        **Type:** number

        **Range:** 0-255

        **Default:** 0

    **tag**

        **Description** Set the OSPFv3 process tag

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters