.. _router_ipv6_ospf_area:

router ipv6 ospf area
=====================

OSPF area parameters


area Specification
------------------

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

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

	 **Object Key(s)**                     *area-ipv4, area-num*

	 **Collection Name**                   :ref:`2515_area_list`

	 **Collection URI**                    /axapi/v3/router/ipv6/ospf/{process-id}/area

	                                       

	 **Element Name**                      area

	 **Element URI**                       /axapi/v3/router/ipv6/ospf/{process-id}/area/{area-ipv4}+{area-num}

	 **Element Attributes**                area_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`area schema <router-ipv6-ospf-area/router-ipv6-ospf-area.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/router/ipv6/ospf/{process-id}/area



.. raw:: html

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


:ref:`2515_area_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/router/ipv6/ospf/{process-id}/area



.. raw:: html

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


:ref:`2515_area_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/router/ipv6/ospf/{process-id}/area/{area-ipv4}+{area-num}



.. raw:: html

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


:ref:`2515_area_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/router/ipv6/ospf/{process-id}/area



.. raw:: html

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


:ref:`2515_area_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/router/ipv6/ospf/{process-id}/area/{area-ipv4}+{area-num}



.. raw:: html

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


:ref:`2515_area_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/router/ipv6/ospf/{process-id}/area/{area-ipv4}+{area-num}



.. raw:: html

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


:ref:`2515_area_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/router/ipv6/ospf/{process-id}/area



.. raw:: html

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


:ref:`2515_area_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/router/ipv6/ospf/{process-id}/area/{area-ipv4}+{area-num}



.. raw:: html

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


:ref:`2515_area_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2515_area_list:

area-list
---------


    area-list is **JSON List** of :ref:`2515_area_attributes` 

        area-list : [

             { :ref:`2515_area_attributes` },

             { :ref:`2515_area_attributes` },

             ...

         ]

.. _2515_area_attributes:

area attributes
---------------

    **area-ipv4**

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

        **Type:** string

        **Format:** ipv4-address

    **area-num**

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

        **Type:** number

        **Range:** 0-4294967295

    **default-cost**

        **Description** Set the summary-default cost of a NSSA or stub area (Stub's advertised default summary cost)

        **Type:** number

        **Range:** 0-16777215

        **Default:** 1

    **no-summary**

        **Description** Do not inject inter-area routes into area

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **range-list**

        **Type:** List

    **stub**

        **Description** Configure OSPFv3 area as stub

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **virtual-link-list**

        **Type:** List

.. _2515_virtual-link-list:

virtual-link-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **bfd**

        **Description** Bidirectional Forwarding Detection (BFD)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **dead-interval**

        **Description** Dead router detection time (Seconds)

        **Type:** number

        **Range:** 1-65535

    **hello-interval**

        **Description** Hello packet interval (Seconds)

        **Type:** number

        **Range:** 1-65535

    **instance-id**

        **Description** OSPFv3 instance ID

        **Type:** number

        **Range:** 0-255

        **Default:** 0

    **retransmit-interval**

        **Description** LSA retransmit interval (Seconds)

        **Type:** number

        **Range:** 1-3600

    **transmit-delay**

        **Description** LSA transmission delay (Seconds)

        **Type:** number

        **Range:** 1-3600

        **Default:** 1

    **value**

        **Description** ID (IP addr) associated with virtual link neighbor

        **Type:** string

        **Format:** ipv4-address

.. _2515_range-list:

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

	 **Block object keys**             

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

    **option**

        **Description** 'advertise': Advertise this range (default); 'not-advertise': DoNotAdvertise this range; 

        **Type:** string

        **Supported Values:** advertise, not-advertise

    **value**

        **Description** Area range for IPv6 prefix

        **Type:** string

        **Format:** ipv6-address-plen