.. _debug_ospf:

debug ospf
==========

Debug Open Shortest Path First (OSPF)


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

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

	===================================== ===================================================
	 **Type**                              *operational*

	 **Element Name**                      ospf

	 **Element URI**                       /axapi/v3/debug/ospf

	 **Element Attributes**                ospf_attributes

	 **Partition Visibility**              None

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


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/debug/ospf



.. raw:: html

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


:ref:`561_ospf_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _561_ospf_attributes:

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

    **all**

        **Description:** all is a **JSON Block**.  Please see below for :ref:`561_all` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/all <debug_ospf_all>`

    **bfd**

        **Description:** bfd is a **JSON Block**.  Please see below for :ref:`561_bfd` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/bfd <debug_ospf_bfd>`

    **events**

        **Description:** events is a **JSON Block**.  Please see below for :ref:`561_events` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/events <debug_ospf_events>`

    **ifsm**

        **Description:** ifsm is a **JSON Block**.  Please see below for :ref:`561_ifsm` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/ifsm <debug_ospf_ifsm>`

    **lsa-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/lsa/{flooding} <debug_ospf_lsa>`

    **nfsm-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/nfsm/{events} <debug_ospf_nfsm>`

    **nsm-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/nsm/{interface} <debug_ospf_nsm>`

    **packet-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/packet/{dd} <debug_ospf_packet>`

    **route-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/debug/ospf/route/{ase} <debug_ospf_route>`

.. _561_lsa-list:

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

	 **Block object keys**             

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

    **flooding**

        **Description** LSA Flooding

        **Type:** boolean

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

        **Default:** 0

    **gererate**

        **Description** LSA Generation

        **Type:** boolean

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

        **Default:** 0

    **install**

        **Description** LSA Installation

        **Type:** boolean

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

        **Default:** 0

    **maxage**

        **Description** LSA MaxAge processing

        **Type:** boolean

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

        **Default:** 0

    **refresh**

        **Description** LSA Refreshment

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

.. _561_all:

all
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _561_ifsm:

ifsm
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **events**

        **Description** IFSM Event Information

        **Type:** boolean

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

        **Default:** 0

    **status**

        **Description** IFSM Status Information

        **Type:** boolean

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

        **Default:** 0

    **timers**

        **Description** IFSM Timer Information

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

.. _561_bfd:

bfd
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _561_nsm-list:

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

	 **Block object keys**             

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

    **interface**

        **Description** NSM interface

        **Type:** boolean

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

        **Default:** 0

    **redistribute**

        **Description** NSM redistribute

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

.. _561_route-list:

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

	 **Block object keys**             

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

    **ase**

        **Description** External route calculation information

        **Type:** boolean

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

        **Default:** 0

    **ia**

        **Description** Inter-Area route calculation information

        **Type:** boolean

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

        **Default:** 0

    **install**

        **Description** Route installation information

        **Type:** boolean

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

        **Default:** 0

    **spf**

        **Description** SPF calculation information

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

.. _561_nfsm-list:

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

	 **Block object keys**             

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

    **events**

        **Description** NFSM Event Information

        **Type:** boolean

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

        **Default:** 0

    **status**

        **Description** NFSM Status Information

        **Type:** boolean

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

        **Default:** 0

    **timers**

        **Description** NFSM Timer Information

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

.. _561_packet-list:

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

	 **Block object keys**             

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

    **dd**

        **Description** OSPFv3 Database Description

        **Type:** boolean

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

        **Default:** 0

    **detail**

        **Description** Detail information

        **Type:** boolean

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

        **Default:** 0

    **hello**

        **Description** OSPFv3 Hello

        **Type:** boolean

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

        **Default:** 0

    **ls-ack**

        **Description** OSPFv3 Link State Acknowledgment

        **Type:** boolean

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

        **Default:** 0

    **ls-request**

        **Description** OSPFv3 Link State Request

        **Type:** boolean

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

        **Default:** 0

    **ls-update**

        **Description** OSPFv3 Link State Update

        **Type:** boolean

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

        **Default:** 0

    **recv**

        **Description** Packet received

        **Type:** boolean

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

        **Default:** 0

    **send**

        **Description** Packet sent

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

.. _561_events:

events
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **abr**

        **Description** OSPF ABR events

        **Type:** boolean

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

        **Default:** 0

    **asbr**

        **Description** OSPF ASBR events

        **Type:** boolean

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

        **Default:** 0

    **os**

        **Description** OS events

        **Type:** boolean

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

        **Default:** 0

    **router**

        **Description** Other router events

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

    **vlink**

        **Description** Virtual-Link event

        **Type:** boolean

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

        **Default:** 0