System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing

List node network routes

Returns detailed information about each route in the node routing table.
Routes can be of any type i.e. IPv4 or IPv6 or both. Route information
includes the route ipv6 flag (True or False), route type (default, static,
and so on), a unique route identifier, the route metric, the protocol from
which the route was learned, the route source (which is the preferred egress
interface), the route destination, and the route scope. If ipv6 flag is True
then route information is for IPv6 route else for IPv4 route. The route scope
refers to the distance to the destination network: The "host" scope leads to
a destination address on the node, such as a loopback address; the "link" scope
leads to a destination on the local network; and the "global" scope leads to
addresses that are more than one hop away.

Request:

Method:
GET
URI Path(s):
/api/v1/transport-nodes/{transport-node-id}/node/network/routes
/api/v1/cluster/{cluster-node-id}/node/network/routes
/api/v1/node/network/routes
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/node/network/routes

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeRoutePropertiesListResult+

Example Response:

{ "result_count": 2, "results": [ { "gateway": "10.186.111.254", "interface_id": "eth0", "ipv6": false, "route_id": "default-10.186.111.254-eth0-0", "route_type": "default" }, { "destination": "10.186.93.0", "interface_id": "eth0", "ipv6": false, "metric": "1024", "netmask": "255.255.255.240", "proto": "kernel", "route_id": "static-10.186.93.0-eth0-1024", "route_type": "static", "scope": "site" }, { "destination": "2620:124:6020:c309::", "interface_id": "eth0", "ipv6": true, "metric": "512", "netmask": "64", "proto": "kernel", "route_id": "static-2620:124:6020:c309::-eth0-512", "route_type": "static" }, { "gateway": "fe80::202:ff:fe02:2", "interface_id": "eth0", "ipv6": true, "metric": "1024", "proto": "ra", "route_id": "default-fe80::202:ff:fe02:2-eth0-1024", "route_type": "default" } ] }

Required Permissions:

read

Feature:

system_administration

Additional Errors: