Get OSPF route information

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

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+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Policy path of edge Policy path of edge to retrieve routes.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point.	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
network_prefix	CIDR network address CIDR network address.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

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+

OspfRoutesListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
gateway_path	Policy path to Tier0 gateway Policy path to Tier0 gateway.	string	Required
last_update_timestamp	Timestamp indicating last update time of data Timestamp when the data was last updated, unset if data source has never updated the data.	EpochMsTimestamp	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of OspfRoutes
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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 }

Get OSPF route information

Request:

OspfRoutesRequestParameters (schema)

Example Request:

Successful Response:

OspfRoutesListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: