NSX-T Data Center REST API

Create node network route

Add a route to the node routing table. For static routes, the
route_type, interface_id, netmask, and destination are required parameters.
For default routes, the route_type, gateway address, and interface_id
are required. For blackhole routes, the route_type and destination are
required. All other parameters are optional. When you add a static route,
the scope and route_id are created automatically. When you add a default or
blackhole route, the route_id is created automatically. The route_id is
read-only, meaning that it cannot be modified. All other properties can be
modified by deleting and readding the route.

Request:

Method:

POST

URI Path(s):

/api/v1/cluster/<cluster-node-id>/node/network/routes
/api/v1/transport-nodes/<transport-node-id>/node/network/routes
/api/v1/node/network/routes

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

NodeRouteProperties+

NodeRouteProperties (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
destination	Destination covered by route	string
from_address	From address	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
gateway	Address of next hop	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
interface_id	Network interface id of route	string
metric	Metric value of route	string
netmask	Netmask of destination covered by route	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
proto	Routing protocol identifier of route	string	Enum: unspec, redirect, kernel, boot, static, gated, ra, mrt, zebra, bird, dnrouted, xorp, ntk, dhcp Default: "boot"
route_id	Unique identifier for the route	string	Readonly
route_type	Route type	string	Required Enum: default, static, blackhole, prohibit, throw, unreachable
scope	Scope of destinations covered by route	string
src	Source address to prefer when sending to destinations of route	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"

Example Request:

POST https://<nsx-mgr>/api/v1/node/network/routes { "route_type": "static", "interface_id": "eth0", "netmask": "255.255.255.0", "destination": "10.33.85.0" }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

NodeRouteProperties+

NodeRouteProperties (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
destination	Destination covered by route	string
from_address	From address	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
gateway	Address of next hop	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
interface_id	Network interface id of route	string
metric	Metric value of route	string
netmask	Netmask of destination covered by route	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
proto	Routing protocol identifier of route	string	Enum: unspec, redirect, kernel, boot, static, gated, ra, mrt, zebra, bird, dnrouted, xorp, ntk, dhcp Default: "boot"
route_id	Unique identifier for the route	string	Readonly
route_type	Route type	string	Required Enum: default, static, blackhole, prohibit, throw, unreachable
scope	Scope of destinations covered by route	string
src	Source address to prefer when sending to destinations of route	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"

Example Response:

{ "destination": "10.33.85.0" "interface_id": "eth0", "netmask": "255.255.255.0", "route_id": "static-10.33.85.0-eth0-0", "route_type": "static", "scope": "link", }

Required Permissions:

crud

Feature:

system_administration

Additional Errors:

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