Get OSPF neighbor information

Get OSPF neighbor 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/neighbors

Request Headers:

n/a

Query Parameters:

OspfNeighborStatusRequestParameters+

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 neighbors.	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
neighbor_address	OSPF neighbor ip address OSPF neighbor ip address.	IPAddress
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/neighbors

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

OspfNeighborsStatusListResult+

OspfNeighborsStatusListResult (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 OspfNeighbor
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": 1605794187118, "results": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0", "neighbors": [ { "neighbor_address": "90.90.90.10", "neighbor_status_info": [ { "interface_name": "uplink-270:90.90.90.2", "source_address": "90.90.90.10", "priority": 1, "state": "Full", "last_state_change": "2d12h37m", "dead_time": "39.895s", "retransmit_counter": 0, "request_counter": 0, "database_summary_counter": 0 } ] }, { "neighbor_address": "40.40.40.2", "neighbor_status_info": [ { "interface_name": "uplink-269:40.40.40.1", "source_address": "40.40.40.2", "priority": 0, "state": "2-Way", "last_state_change": "2d12h37m", "dead_time": "35.264s", "retransmit_counter": 0, "request_counter": 0, "database_summary_counter": 0 }, { "interface_name": "uplink-270:90.90.90.2", "source_address": "90.90.90.1", "priority": 0, "state": "2-Way", "last_state_change": "2d12h37m", "dead_time": "35.262s", "retransmit_counter": 0, "request_counter": 0, "database_summary_counter": 0 } ] }, { "neighbor_address": "40.40.40.10", "neighbor_status_info": [ { "interface_name": "uplink-269:40.40.40.1", "source_address": "40.40.40.10", "priority": 1, "state": "ExStart", "last_state_change": "5.072s", "dead_time": "39.942s", "retransmit_counter": 0, "request_counter": 0, "database_summary_counter": 0 } ] } ] }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1", "neighbors": [ { "neighbor_address": "40.40.40.1", "neighbor_status_info": [ { "interface_name": "uplink-283:90.90.90.1", "source_address": "90.90.90.2", "priority": 0, "state": "2-Way/DROther", "last_state_change": "2d12h51m", "dead_time": "34.780s", "retransmit_counter": 0, "request_counter": 0, "database_summary_counter": 0 }, { "interface_name": "uplink-276:40.40.40.2", "source_address": "40.40.40.1", "priority": 0, "state": "2-Way/DROther", "last_state_change": "2d12h51m", "dead_time": "34.782s", "retransmit_counter": 0, "request_counter": 0, "database_summary_counter": 0 } ] }, { "neighbor_address": "90.90.90.10", "neighbor_status_info": [ { "interface_name": "uplink-283:90.90.90.1", "source_address": "90.90.90.10", "priority": 1, "state": "Full/DR", "last_state_change": "2d12h51m", "dead_time": "39.753s", "retransmit_counter": 0, "request_counter": 0, "database_summary_counter": 0 } ] }, { "neighbor_address": "40.40.40.10", "neighbor_status_info": [ { "interface_name": "uplink-276:40.40.40.2", "source_address": "40.40.40.10", "priority": 1, "state": "Full/DR", "last_state_change": "0.250s", "dead_time": "39.801s", "retransmit_counter": 1, "request_counter": 0, "database_summary_counter": 0 } ] } ] } ], "result_count": 2, "sort_by": "display_name", "sort_ascending": true }

Get OSPF neighbor information

Request:

OspfNeighborStatusRequestParameters (schema)

Example Request:

Successful Response:

OspfNeighborsStatusListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: