Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

OSPF

API calls for real-time monitoring of OSPF information:

Database

List the entries in the OSPF Link-State Advertisement (LSA) database (on vEdge routers only).

CLI Equivalent: show ospf database

URL: https://vmanage-ip-address/dataservice/device/ospf/database?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Database Summary

List how many of each type of LSA is present in the OSPF database, along with the total number of LSAs in the database (on vEdge routers only).

CLI Equivalent: show ospf database-summary

URL: https://vmanage-ip-address/dataservice/device/ospf/databasesummary?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

External Database

List the entries in the OSPF Link-State Advertisement (LSA) database (on vEdge routers only).

CLI Equivalentshow ospf database external

URL: https://vmanage-ip-address/dataservice/device/ospf/databaseexternal?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Interface

Display information about interfaces that are running OSPF (on vEdge routers only).

CLI Equivalentshow ospf interface

URL: https://vmanage-ip-address/dataservice/device/ospf/interface?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Neighbor

List information about OSPF neighbors (on vEdge routers only).

CLI Equivalent: show ospf neighbor

URL: https://vmanage-ip-address/dataservice/device/ospf/neighbor?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Process

Show information about each OSPF routing process running on the vEdge router (on vEdge routers only).

CLI Equivalent: show ospf process

URL: https://vmanage-ip-address/dataservice/device/ospf/process?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Routes

Display the entries that the route table has learned from OSPF (on vEdge routers only).

CLI Equivalent: show ospf routes

URL: https://vmanage-ip-address/dataservice/device/ospf/routes?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Response Object for Real-Time Monitoring API Calls

Real-time monitoring API call responses have the following format:

{
  "header": {
    "generatedOn": timestamp, milliseconds (UNIX time format),                            
      "viewKeys": {
        "uniqueKey": ["key"]                       
      },
      "fields": [
        properties and types
      ],
   },
   "data": [
     array of objects
   ]
}

Additional Information

Using the vManage REST API

  • Was this article helpful?