NSX-T Data Center REST API

Get forwarding table from TGW

Get forwarding table from TGW.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/forwarding-table

Request Headers:

n/a

Query Parameters:

PolicyVpcRoutesRequestParameters+

PolicyVpcRoutesRequestParameters (schema)

Name	Description	Type	Notes
component_type	Define the DR routes. Component type define to take the route from CCP.	string	Enum: DR_ROUTES
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_id	UUID of edge node UUID of edge node. Edge should be member of enforcement point.	string
edge_path	Policy path of edge node Policy path of edge node. Edge should be member of enforcement point.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
host_id	UUID of host node UUID of host node. Host node should be member of enforcement point.	string
host_path	Policy path of host node Policy path of host node. Host node should be member of 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	Network address filter parameter IPAddress or CIDR network address to filter entries in the table.	IPAddressOrCIDRBlock
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
route_source	Filter routes based on the source from which route is learned Filter routes based on the source from which route is learned.	string	Enum: BGP, STATIC, CONNECTED, OSPF
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:

RoutingTableListResult+

RoutingTableListResult (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
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of Routes per transport node ID Paged Collection of Routes per transport node ID.	array of RoutingTable
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "route_entries": [ { "next_hop": "169.254.0.1", "route_type": "ns ", "admin_distance": 3, "network": "25.1.0.0/16" }, { "next_hop": "45.1.1.1", "route_type": "c ", "admin_distance": 0, "network": "45.1.1.0/24" }, { "next_hop": "169.254.0.1", "route_type": "ns ", "admin_distance": 3, "network": "100.96.0.0/30" }, { "next_hop": "169.254.0.2", "route_type": "c ", "admin_distance": 0, "network": "169.254.0.0/28" } ], "count": 4, } ] }

Required Permissions:

read

Feature:

policy_transit_gateway

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