Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF

Get OSPF route information

Get OSPF route information.
This API is only available when using VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/routes
Request Headers:
n/a
Query Parameters:
OspfRoutesRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s//locale-services//ospf/routes

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
OspfRoutesListResult+

Example Response:

{ "gateway_path": "/infra/tier-0s/tier0", "last_update_timestamp": 1605794223205, "results": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0", "route_details": [ { "route_prefix": "40.50.60.0/24", "route_type": "N E2", "cost": 10, "type_to_cost": 20, "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-270", "directly_attached": false } ] }, { "route_prefix": "10.172.148.0/22", "route_type": "N E2", "cost": 10, "type_to_cost": 20, "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-270", "directly_attached": false } ] }, { "route_prefix": "40.40.40.0/24", "route_type": "N", "cost": 10, "type_to_cost": 0, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "0.0.0.0", "interface_name": "uplink-269", "directly_attached": true } ] }, { "route_prefix": "90.90.90.0/24", "route_type": "N", "cost": 10, "type_to_cost": 0, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "0.0.0.0", "interface_name": "uplink-270", "directly_attached": true } ] }, { "route_prefix": "2.1.5.0/24", "route_type": "N E2", "cost": 10, "type_to_cost": 20, "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-270", "directly_attached": false } ] }, { "route_prefix": "90.90.90.10", "route_type": "R ", "router_type": "asbr", "cost": 10, "type_to_cost": 0, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-270", "directly_attached": false } ] } ] }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1", "route_details": [ { "route_prefix": "40.50.60.0/24", "route_type": "N E2", "router_type": "", "cost": 65534, "type_to_cost": 20, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-283", "directly_attached": false } ] }, { "route_prefix": "10.172.148.0/22", "route_type": "N E2", "router_type": "", "cost": 65534, "type_to_cost": 20, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-283", "directly_attached": false } ] }, { "route_prefix": "40.40.40.0/24", "route_type": "N", "router_type": "", "cost": 65534, "type_to_cost": 0, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "0.0.0.0", "interface_name": "uplink-276", "directly_attached": true } ] }, { "route_prefix": "90.90.90.0/24", "route_type": "N", "router_type": "", "cost": 65534, "type_to_cost": 0, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "0.0.0.0", "interface_name": "uplink-283", "directly_attached": true } ] }, { "route_prefix": "2.1.5.0/24", "route_type": "N E2", "router_type": "", "cost": 65534, "type_to_cost": 20, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-283", "directly_attached": false } ] }, { "route_prefix": "90.90.90.10", "route_type": "R ", "router_type": "asbr", "cost": 65534, "type_to_cost": 0, "area": "0.0.0.0", "next_hops": [ { "neighbor_address": "90.90.90.10", "interface_name": "uplink-283", "directly_attached": false } ] } ] } ], "result_count": 2, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_ospf

Additional Errors: