Get Logical Router Routing Table

Returns the route table(RIB) for the logical router on a node of the given transport-node-id. Query parameter "transport_node_id= " is required. To filter the result by network address, parameter "network_prefix=<a.b.c.d/mask>" needs to be specified. To filter the result by route source, parameter "route_source= " needs to be specified where source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT. It is also possible to filter the RIB table using both network address and route source filter together. The query parameter "source=cached" is not supported.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/logical-routers/{logical-router-id}/routing/routing-table

COPY

Path Parameters

string

logical-router-id

Required

logical-router-id

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

network_prefix

Optional

IPv4 CIDR Block

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

route_source

Optional

To filter the RIB table based on the source from which route is learned.

Possible values are : BGP, STATIC, CONNECTED,

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

source

Optional

Data source type.

Possible values are : realtime, cached,

string

transport_node_id

Required

TransportNode Id

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LogicalRouterRouteTable of type(s) application/json

This response body class contains all of the following: ListResult , InlineLogicalRouterRouteTable1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "logical_router_name": "string",
    "last_update_timestamp": 0,
    "logical_router_id": "string",
    "results": [
        {
            "lr_component_id": "string",
            "next_hop": "string",
            "lr_component_type": "string",
            "network": "string",
            "route_type": "string",
            "logical_router_port_id": "string",
            "admin_distance": 0
        }
    ]
}

400

Returns BadRequest of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403

Returns Forbidden of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500

Returns InternalServerError of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503

Returns ServiceUnavailable of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Logical Routing And Services Operations

POST

Add Bgp Neighbor