Route

Media Type: [application/vnd.org.midonet.Route-v1+json]

GET     /routers/:routerId/routes
GET     /routes/:routeId
POST    /routers/:routerId/routes
DELETE  /routes/:routeId

Route is an entity that represents a route on a virtual router in MidoNet. It contains the following fields:

Field NameTypePOST/PUTRequiredDescription

uri

URI

  

A GET against this URI refreshes the representation of this resource.

router

URI

  

A GET against this URI returns the router resource.

id

UUID

  

A unique identifier of the resource. If this field is omitted in the POST request, a random UUID is generated.

dstNetworkAddr

String

POST

Yes

The destination IP network address.

dstNetworkLength

Integer

POST

Yes

The destination IP network prefix length. The value must belong to the interval [0, 32].

nextHopGateway

String

POST

Yes

The IP address of the gateway router to which the traffic is forwarded. This field must be present only for Normal routes.

nextHopPort

UUID

POST

Yes

The identifier of the next hop port. This field must be present only for Normal routes.

srcNetworkAddr

String

POST

Yes

The source IP network address.

srcNetworkLength

Integer

POST

Yes

The source IP network prefix length. The value must belong to the interval [0, 32].

type

String

POST

Yes

The route type. It can be one of the following: Normal, BlackHole, Reject, Local.

weight

Integer

POST

Yes

The priority weight of the route. Lower weights take precedence over higher weights. The value must be greater or equal to zero.

learned

Boolean

  

Indicates whether the route was learned dynamically using a routing protocol.

routerId

UUID

  

The identifier of the router to which the route belongs.

Questions? Discuss on Mailing Lists or Chat.
Found an error? Report a bug.