NSX-T Data Center REST API

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+
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+

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 }

Required Permissions:

read

Feature:

policy_ospf

Additional Errors: