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
externalNetworkId
Required

externalNetworkId

string
externalNetworkId
Required

externalNetworkId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderGatewayBgpConfig of type(s) application/json;version=39.0 
{
    "enabled": false,
    "ecmp": false,
    "localASNumber": "65546, 1.10",
    "gracefulRestart": {
        "modeValue": "string"
    },
    "version": {
        "version": 0
    }
}
boolean
enabled
Optional

A flag indicating whether BGP configuration is enabled or not. If set to null, will use the default value.

boolean
ecmp
Optional

A flag indicating whether ECMP is enabled or not. If set to null, will use the default value.

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'.

ProviderGatewayBgpGracefulRestartConfig
gracefulRestart
Optional

Describes current graceful restart configuration mode and timer for BGP configuration on a Provider Gateway.

ObjectVersion
version
Required

This property describes the current version of the entity. To prevent clients from overwriting each other's changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.


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