NSX-T Data Center REST API

Get OSPF database information

Get OSPF database 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/database

Request Headers:

n/a

Query Parameters:

OspfDatabaseRequestParameters+

OspfDatabaseRequestParameters (schema)

Name	Description	Type	Notes
area_id	OSPF area identifier OSPF area identifier either in decimal or dotted format.	string
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
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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyOspfDatabaseListResult+

PolicyOspfDatabaseListResult (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
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 OSPF database data	array of OspfDatabaseStatus	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly
tier0_path	Policy path for Tier0 gateway	string	Required Readonly

Example Response:

{ "tier0_path": "/infra/tier-0s/tier0", "last_update_timestamp": 1605794310949, "results": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0", "area_id": "0.0.0.0", "router_link_states": [ { "link_state_id": "40.40.40.1", "advertised_router": "40.40.40.1", "up_time": 298, "sequence_number": "80000cb9", "router_links": 2, "checksum": "5d78" }, { "link_state_id": "40.40.40.2", "advertised_router": "40.40.40.2", "up_time": 5, "sequence_number": "8000ab44", "router_links": 2, "checksum": "320b" }, { "link_state_id": "40.40.40.10", "advertised_router": "40.40.40.10", "up_time": 11, "sequence_number": "8000b426", "router_links": 1, "checksum": "5286" }, { "link_state_id": "90.90.90.10", "advertised_router": "90.90.90.10", "up_time": 1036, "sequence_number": "800002a2", "router_links": 1, "checksum": "f830" } ], "net_link_states": [ { "link_state_id": "90.90.90.10", "advertised_router": "90.90.90.10", "up_time": 1779, "sequence_number": "80000282", "checksum": "d66" } ], "summary_link_states": [], "nssa_external_link_states": [], "external_link_states": [ { "link_state_id": "2.1.4.0", "advertised_router": "40.40.40.10", "up_time": 1619, "sequence_number": "8000027b", "metric_type": "E2", "checksum": "9aff", "tag": 0, "route": "E2" }, { "link_state_id": "2.1.5.0", "advertised_router": "90.90.90.10", "up_time": 792, "sequence_number": "8000027a", "metric_type": "E2", "checksum": "dc27", "tag": 0, "route": "E2" }, { "link_state_id": "10.172.148.0", "advertised_router": "40.40.40.10", "up_time": 1619, "sequence_number": "8000027b", "metric_type": "E2", "checksum": "e078", "tag": 0, "route": "E2" }, { "link_state_id": "10.172.148.0", "advertised_router": "90.90.90.10", "up_time": 792, "sequence_number": "8000027a", "metric_type": "E2", "checksum": "2e95", "tag": 0, "route": "E2" }, { "link_state_id": "40.50.60.0", "advertised_router": "40.40.40.10", "up_time": 1619, "sequence_number": "8000027b", "metric_type": "E2", "checksum": "f119", "tag": 0, "route": "E2" }, { "link_state_id": "40.50.60.0", "advertised_router": "90.90.90.10", "up_time": 792, "sequence_number": "8000027a", "metric_type": "E2", "checksum": "3f36", "tag": 0, "route": "E2" } ], "asbr_summary_link_states": [] }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1", "area_id": "0.0.0.0", "router_link_states": [ { "link_state_id": "40.40.40.1", "advertised_router": "40.40.40.1", "up_time": 301, "sequence_number": "80000cb9", "router_links": 2, "checksum": "5d78" }, { "link_state_id": "40.40.40.2", "advertised_router": "40.40.40.2", "up_time": 3, "sequence_number": "8000ab44", "router_links": 2, "checksum": "320b" }, { "link_state_id": "40.40.40.10", "advertised_router": "40.40.40.10", "up_time": 9, "sequence_number": "8000b426", "router_links": 1, "checksum": "5286" }, { "link_state_id": "90.90.90.10", "advertised_router": "90.90.90.10", "up_time": 1036, "sequence_number": "800002a2", "router_links": 1, "checksum": "f830" } ], "net_link_states": [ { "link_state_id": "90.90.90.10", "advertised_router": "90.90.90.10", "up_time": 1779, "sequence_number": "80000282", "checksum": "d66" } ], "summary_link_states": [], "nssa_external_link_states": [], "external_link_states": [ { "link_state_id": "2.1.4.0", "advertised_router": "40.40.40.10", "up_time": 1617, "sequence_number": "8000027b", "metric_type": "E2", "checksum": "9aff", "tag": 0, "route": "E2" }, { "link_state_id": "2.1.5.0", "advertised_router": "90.90.90.10", "up_time": 793, "sequence_number": "8000027a", "metric_type": "E2", "checksum": "dc27", "tag": 0, "route": "E2" }, { "link_state_id": "10.172.148.0", "advertised_router": "40.40.40.10", "up_time": 1617, "sequence_number": "8000027b", "metric_type": "E2", "checksum": "e078", "tag": 0, "route": "E2" }, { "link_state_id": "10.172.148.0", "advertised_router": "90.90.90.10", "up_time": 793, "sequence_number": "8000027a", "metric_type": "E2", "checksum": "2e95", "tag": 0, "route": "E2" }, { "link_state_id": "40.50.60.0", "advertised_router": "40.40.40.10", "up_time": 1617, "sequence_number": "8000027b", "metric_type": "E2", "checksum": "f119", "tag": 0, "route": "E2" }, { "link_state_id": "40.50.60.0", "advertised_router": "90.90.90.10", "up_time": 793, "sequence_number": "8000027a", "metric_type": "E2", "checksum": "3f36", "tag": 0, "route": "E2" } ], "asbr_summary_link_states": [] } ], "result_count": 2, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_ospf

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable