Get Bgp Config

Get Bgp Config

Retrieves the general BGP configuration for an edge gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
gatewayId
Required

gatewayId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeBgpConfig of type(s) application/json;version=37.1 
{
    "enabled": false,
    "ecmp": false,
    "localASNumber": "65546",
    "gracefulRestart": {
        "mode": "string",
        "restartTimer": 0,
        "staleRouteTimer": 0
    },
    "version": {
        "version": 0
    }
}
boolean
enabled
Optional

A flag indicating whether BGP configuration is enabled or not.

boolean
ecmp
Optional

A flag indicating whether ECMP is enabled or not.

string
localASNumber
Optional

BGP AS number to advertise to BGP peers. BGP AS number can be specified in either ASPLAIN or ASDOT formats, like ASPLAIN format :- '65546', ASDOT format :- '1.10'. Read only if using a VRF-Lite backed external network.

EdgeBgpGracefulRestartConfig
gracefulRestart
Optional

gracefulRestart

ObjectVersion
version
Required

version


Availability
Added in 34.0
On This Page
Edge Gateway Bgp Operations
GET
Get Bgp Config
PUT
Update Bgp Config