Router

Media Type
[application/vnd.org.midonet.Router-v3+json]
Collection Media Type
[application/vnd.org.midonet.collection.Router-v3+json]
GET     /routers
GET     /routers?tenant_id=:tenantId
GET     /routers/:routerId
POST    /routers
PUT     /routers/:routerId
DELETE  /routers/:routerId

Router is an entity that represents a virtual router device in MidoNet. It contains the following fields:

Field NameTypePOST/PUTRequiredDescription

uri

URI

  

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

bgpNetworks

URI

  

A GET against this URI returns the BGP networks advertised by this router.

bgpPeers

URI

  

A GET against this URI returns the BGP neighbors for this router.

inboundFilter

URI

  

A GET against this URI returns the inbound filter chain.

loadBalancer

URI

  

A GET against this URI returns the load balancer for this router.

outboundFilter

URI

  

A GET against this URI returns the outbound filter chain.

peerPorts

URI

  

A GET against this URI returns the interior ports attached to this router.

ports

URI

  

A GET against this URI returns the list of ports for this router.

routes

URI

  

A GET against this URI returns the routes for this router.

id

UUID

POST

No

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

adminStateUp

Boolean

POST/PUT

No

The administrative state of the router. If false (down), the router replies with a Communication administratively prohibited ICMP response and stops forwarding packets. The default is true (up).

asNumber

Integer

POST/PUT

No

The Autonomous System Number (ASN) used for BGP routing.

inboundFilterId

UUID

POST/PUT

No

The identifier of the filter chain to be applied to ingress packets before routing.

inboundMirrorIds

Array of UUID

POST/PUT

No

The list of IDs for the mirrors applied to ingress packets.

loadBalancerId

UUID

POST/PUT

No

The layer 4 load balancer for this router.

name

String

POST/PUT

No

The name of the router. The maximum length is 255 characters.

outboundFilterId

UUID

POST/PUT

No

The identifier of the filter chain to be applied to egress packets after routing.

outboundMirrorIds

Array of UUID

POST/PUT

No

The list of IDs for the mirrors applied to egress packets.

tenantId

String

POST/PUT

No

The identifier of the tenant that owns the router.

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