Get all OSPF Discovered Neighbors (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/ospfconfigs/:ospf_config_id/ospfdiscoveredneighbors

Lists all the OSPF discovered neighbors.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

ospf_config_id stringrequired

The OSPF config ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items OspfDiscoveredNeighbor[]
Array [
discovered_neighbors_count integer
The number of OSPF discovered neighbors.
id string
The OSPF discovered neighbor ID.
interfaces InterfaceConfig[]
The interfaces name.
Array [
area_id integer
Identifier for the area in x.x.x.x format.
discovered_neighbors DiscoveredNeighbor[]
Info on the discovered neighbors.
Array [
neighbor_id string
The discovered neighbor ID.
status string
Status of the configuration.
]
interface_id string
Associated area interface ID.
]
ospf_config_id string
The OSPF config ID.
vrf_context_id string
The attached VRF (Virtual Routing and Forwarding) ID.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "discovered_neighbors_count": 0,
      "id": "string",
      "interfaces": [
        {
          "area_id": 0,
          "discovered_neighbors": [
            {
              "neighbor_id": "string",
              "status": "string"
            }
          ],
          "interface_id": "string"
        }
      ],
      "ospf_config_id": "string",
      "vrf_context_id": "string"
    }
  ]
}

Loading...