Querying an OSPFv2 Instance

Querying an OSPFv2 Instance

GET http://<IP_Address>/api/node/mo/sys/ospf/inst-my_ospf.json?rsp-subtree=full

{
  "totalCount": "1",
  "imdata": [
    {
      "ospfInst": {
        "attributes": {
          "adminSt": "enabled",
          "childAction": "",
          "ctrl": "",
          "dn": "sys/ospf/inst-my_ospf",
          "memAlert": "normal",
          "modTs": "2016-12-13T02:57:36.789+00:00",
          "monPolDn": "uni/fabric/monfab-default",
          "name": "my_ospf",
          "operErr": "",
          "persistentOnReload": "true",
          "status": "",
          "uid": "0"
        },
        "children": [
          {
            "ospfDom": {
              "attributes": {
                "adjChangeLogLevel": "none",
                "adminSt": "enabled",
                "bwRef": "40000",
                "bwRefUnit": "mbps",
                "childAction": "",
                "ctrl": "",
                "defMetric": "unspecified",
                "discardRoute": "ext,int",
                "dist": "110",
                "downbitIgnore": "no",
                "maxEcmp": "8",
                "modTs": "2016-12-13T02:57:36.789+00:00",
                "monPolDn": "uni/fabric/monfab-default",
                "name": "default",
                "operRtrId": "0.0.0.0",
                "operSt": "down",
                "persistentOnReload": "true",
                "rfc1583Compat": "no",
                "rn": "dom-default",
                "rtrId": "0.0.0.0",
                "status": "",
                "uid": "0"
              },
              "children": [
                {
                  "ospfGr": {
                    "attributes": {
                      "childAction": "",
                      "ctrl": "complete",
                      "gracePeriod": "60",
                      "helper": "yes",
                      "modTs": "2016-12-13T02:57:36.789+00:00",
                      "persistentOnReload": "true",
                      "restartAge": "0",
                      "restartExitReason": "none",
                      "restartStatus": "not-restarting",
                      "rn": "gr",
                      "status": "",
                      "uid": "0"
                    }
                  }
                },
                {
                  "ospfArea": {
                    "attributes": {
                      "asbrCnt": "0",
                      "authType": "unspecified",
                      "brCnt": "0",
                      "childAction": "",
                      "cost": "1",
                      "ctrl": "",
                      "id": "0.0.0.10",
                      "lsaCksumSum": "0",
                      "modTs": "2016-12-14T22:38:25.014+00:00",
                      "monPolDn": "uni/fabric/monfab-default",
                      "nssaTransRole": "candidate",
                      "nssaTransSt": "elected",
                      "nssaTransStabIntvl": "40",
                      "persistentOnReload": "true",
                      "rn": "area-0.0.0.10",
                      "status": "",
                      "type": "regular",
                      "uid": "0"
                    },
                    "children": [
                      {
                        "ospfVLink": {
                          "attributes": {
                            "childAction": "",
                            "deadIntvl": "unspecified",
                            "helloIntvl": "10",
                            "modTs": "2016-12-14T22:38:25.014+00:00",
                            "monPolDn": "uni/fabric/monfab-default",
                            "nbrRtrId": "10.1.2.3",
                            "persistentOnReload": "true",
                            "rexmitIntvl": "5",
                            "rn": "vlink-10.1.2.3",
                            "status": "",
                            "uid": "0",
                            "xmitDelay": "1"
}}}]}}]}}]}}]}

Displays OSPF information.

CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

show ip ospf my_ospf

Note: The property information for this example was added in Release 9.3(3).

ospfInst Properties

The following table contains information about the ospfInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

ospfDom Properties

The following table contains information about the ospfDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

ospfGr Properties

The following table contains information about the ospfGr properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

ospfArea Properties

The following table contains information about the ospfArea properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

ospfVLink Properties

The following table contains information about the ospfVLink properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html