BGP Peer

Media Type
[application/vnd.org.midonet.BgpPeer-v1+json]
Collection Media Type
[application/vnd.org.midonet.collection.BgpPeer-v1+json]
GET     /routers/:routerId/bgp_peers
GET     /bgp_peers/:bgpPeerId
POST    /routers/:routerId/bgp_peers
PUT     /bgp_peers/:bgpPeerId
DELETE  /bgp_peers/:bgpPeerId

BGP Peer is an entity that represents a the BGP endpoint of a neighboring autonomous system. 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 to which the BGP network belongs.

id

UUID

POST

No

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

address

String

POST/PUT

Yes

The IPv4 address of the BGP peer to which the local router will connect.

asNumber

Integer

POST/PUT

Yes

The autonomous system number (ASN) assigned to the BGP neighbor. The value must be greater than zero.

connectRetry

Integer

POST/PUT

No

The connection retry timer in seconds for the BGP session. The value must belong to the interval [5, 3600], and if present it will override the value specified in the MidoNet Agent configuration.

holdTime

Integer

POST/PUT

No

The hold timer in seconds for the BGP session. The value must belong to the interval [5, 7200], and if present it will override the value specified in the MidoNet Agent configuration.

keepAlive

Integer

POST/PUT

No

The keep alive timer in seconds for the BGP session. The value must belong to the interval [5, 3600], and if present it will override the value specified in the MidoNet Agent configuration.

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