.. _interface_ve_ip_ospf:

interface ve ip ospf
====================

Open Shortest Path First for IPv4 (OSPF)


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

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

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

	 **Element Name**                      ospf

	 **Element URI**                       /axapi/v3/interface/ve/{ifnum}/ip/ospf

	 **Element Attributes**                ospf_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ospf schema <interface-ve-ip-ospf/interface-ve-ip-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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/interface/ve/{ifnum}/ip/ospf



.. raw:: html

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


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_ve_ip_ospf_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2027_ospf_attributes:

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

    **ospf-global**

        **Description:** ospf-global is a **JSON Block**.  Please see below for :ref:`2027_ospf-global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/interface/ve/{ifnum}/ip/ospf/ospf-global <interface_ve>`

    **ospf-ip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/interface/ve/{ifnum}/ip/ospf/ospf-ip/{ip-addr} <interface_ve>`

.. _2027_ospf-ip-list:

ospf-ip-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **authentication**

        **Description** Enable authentication

        **Type:** boolean

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

        **Default:** 0

    **authentication-key**

        **Description** Authentication password (key) (The OSPF password (key))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 8 characters

        **Maximum Length:** 1 characters

    **cost**

        **Description** Interface cost

        **Type:** number

        **Range:** 1-65535

    **database-filter**

        **Description** 'all': Filter all LSA; 

        **Type:** string

        **Supported Values:** all

    **dead-interval**

        **Description** Interval after which a neighbor is declared dead (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 40

    **hello-interval**

        **Description** Time between HELLO packets (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 10

    **ip-addr**

        **Description** Address of interface

        **Type:** string

        **Format:** ipv4-address

    **message-digest-cfg**

        **Type:** List

    **mtu-ignore**

        **Description** Ignores the MTU in DBD packets

        **Type:** boolean

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

        **Default:** 0

    **out**

        **Description** Outgoing LSA

        **Type:** boolean

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

        **Default:** 0

    **priority**

        **Description** Router priority

        **Type:** number

        **Range:** 0-255

        **Default:** 1

    **retransmit-interval**

        **Description** Time between retransmitting lost link state advertisements (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 5

    **transmit-delay**

        **Description** Link state transmit delay (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** 'message-digest': Use message-digest authentication; 'null': Use no authentication; 

        **Type:** string

        **Supported Values:** message-digest, null

.. _2027_ospf-ip-list_message-digest-cfg:

ospf-ip-list_message-digest-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **md5-value**

        **Description** The OSPF password (1-16)

        **Type:** string

        **Format:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **message-digest-key**

        **Description** Message digest authentication password (key) (Key id)

        **Type:** number

        **Range:** 1-255

.. _2027_ospf-global:

ospf-global
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **authentication-cfg**

        **Description:** authentication-cfg is a **JSON Block**.  Please see below for :ref:`2027_ospf-global_authentication-cfg` 

        **Type:** Object

    **authentication-key**

        **Description** Authentication password (key) (The OSPF password (key))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 8 characters

        **Maximum Length:** 1 characters

    **bfd-cfg**

        **Description:** bfd-cfg is a **JSON Block**.  Please see below for :ref:`2027_ospf-global_bfd-cfg` 

        **Type:** Object

    **cost**

        **Description** Interface cost

        **Type:** number

        **Range:** 1-65535

    **database-filter-cfg**

        **Description:** database-filter-cfg is a **JSON Block**.  Please see below for :ref:`2027_ospf-global_database-filter-cfg` 

        **Type:** Object

    **dead-interval**

        **Description** Interval after which a neighbor is declared dead (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 40

    **disable**

        **Description** 'all': All functionality; 

        **Type:** string

        **Supported Values:** all

    **hello-interval**

        **Description** Time between HELLO packets (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 10

    **message-digest-cfg**

        **Type:** List

    **mtu**

        **Description** OSPF interface MTU (MTU size)

        **Type:** number

        **Range:** 576-65535

    **mtu-ignore**

        **Description** Ignores the MTU in DBD packets

        **Type:** boolean

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

        **Default:** 0

    **network**

        **Description:** network is a **JSON Block**.  Please see below for :ref:`2027_ospf-global_network` 

        **Type:** Object

    **priority**

        **Description** Router priority

        **Type:** number

        **Range:** 0-255

        **Default:** 1

    **retransmit-interval**

        **Description** Time between retransmitting lost link state advertisements (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 5

    **transmit-delay**

        **Description** Link state transmit delay (Seconds)

        **Type:** number

        **Range:** 1-65535

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2027_ospf-global_network:

ospf-global_network
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **broadcast**

        **Description** Specify OSPF broadcast multi-access network

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** broadcast,non-broadcast,  point-to-point, and point-to-multipoint are mutually exclusive

    **non-broadcast**

        **Description** Specify OSPF NBMA network

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** non-broadcast,broadcast,  point-to-point, and point-to-multipoint are mutually exclusive

    **p2mp-nbma**

        **Description** Specify non-broadcast point-to-multipoint network

        **Type:** boolean

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

        **Default:** 0

    **point-to-multipoint**

        **Description** Specify OSPF point-to-multipoint network

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** point-to-multipoint,broadcast,  non-broadcast, and point-to-point are mutually exclusive

    **point-to-point**

        **Description** Specify OSPF point-to-point network

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** point-to-point,broadcast,  non-broadcast, and point-to-multipoint are mutually exclusive

.. _2027_ospf-global_authentication-cfg:

ospf-global_authentication-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **authentication**

        **Description** Enable authentication

        **Type:** boolean

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

        **Default:** 0

    **value**

        **Description** 'message-digest': Use message-digest authentication; 'null': Use no authentication; 

        **Type:** string

        **Supported Values:** message-digest, null

.. _2027_ospf-global_database-filter-cfg:

ospf-global_database-filter-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **database-filter**

        **Description** 'all': Filter all LSA; 

        **Type:** string

        **Supported Values:** all

    **out**

        **Description** Outgoing LSA

        **Type:** boolean

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

        **Default:** 0

.. _2027_ospf-global_bfd-cfg:

ospf-global_bfd-cfg
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bfd**

        **Description** Bidirectional Forwarding Detection (BFD)

        **Type:** boolean

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

        **Default:** 0

    **disable**

        **Description** Disable BFD

        **Type:** boolean

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

        **Default:** 0

.. _2027_ospf-global_message-digest-cfg:

ospf-global_message-digest-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **md5**

        **Description:** md5 is a **JSON Block**.  Please see below for :ref:`2027_ospf-global_message-digest-cfg_md5` 

        **Type:** Object

    **message-digest-key**

        **Description** Message digest authentication password (key) (Key id)

        **Type:** number

        **Range:** 1-255

.. _2027_ospf-global_message-digest-cfg_md5:

ospf-global_message-digest-cfg_md5
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **md5-value**

        **Description** The OSPF password (1-16)

        **Type:** string

        **Format:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters