Get BGP Peer Configs (v2.5)
GET/sdwan/v2.5/api/sites/:site_id/elements/:element_id/bgppeers
List all the BGP peer configurations.
Request
Path Parameters
The ID of the site.
The ID of the element.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The actual count.
The ID.
items BGPPeerConfigV2N5[]
Advertised default route. True or False.
Allow v4 prefixes.
Allow v6 prefixes.
bgp_config BGPConfig
The details of the BGP config.
The advertisement interval of the BGP config. The advertisement interval should be between 0 - 300 seconds and the default is 1 second.
The BGP config hold time. The hold time should be between 3 - 600 seconds.
The keep-alive time of the BGP config. The keep-alive time should be between 3 - 200 seconds.
The Local AS Number should be between 1 and 4294967295 or as A.B, where A and B are both numbers between 1 and 4294967295.
The MD5 Secret should be between 1 and 32 characters. The default value is 0.
The BGP config multi hop limit. The multi-hop limit should be between 1 - 255 hops. The default is 1 hop.
Possible values: [md5
, none
]
The authentication type of the BGP peer.
The peer retry time should be between 0 - 65535 seconds. The default is 120 seconds.
The description of the BGP peer config. Max size = 1024.
The ID of the BGP peer config.
The name of the BGP peer config. Max size = 128.
The peer IP address.
The peer IPv6 address.
The peer type = Classic. The Peer Type option is available only for data center ION devices.
The remote AS number.
The ID of the Route Map In to filter incoming routes.
The ID of the Route Map Out to filter outgoing routes.
The ID of the Route.
Possible values: [GLOBAL
, LOCAL
]
The scope of the static route = Local or Global. If scope is local, the device does not advertise the route to other sites and if scope is global, the device advertises the route to other sites.
Shutdown
A information field that can be added to identify the BGP peer. Maximum 10 unique tags of length 1024 each are allowed.
The Update Source IP address.
The Update Source IPv6 address.
The VRF (Virtual Routing and Forwarding) ID.
{
"count": 0,
"id": "string",
"items": [
{
"advertise_default_route": true,
"allow_v4_prefixes": true,
"allow_v6_prefixes": true,
"bgp_config": {
"adv_interval": 0,
"hold_time": 0,
"keepalive_time": 0,
"local_as_num": "string",
"md5_secret": "string",
"multi_hop_limit": 0,
"peer_auth_type": "md5",
"peer_retry_time": 0
},
"id": "string",
"name": "string",
"peer_ip": "string",
"peer_ip_v6": "string",
"peer_type": "string",
"remote_as_num": "string",
"route_map_in_id": "string",
"route_map_out_id": "string",
"router_id": "string",
"scope": "GLOBAL",
"shutdown": true,
"tags": [
"string"
],
"update_source": "string",
"update_source_v6": "string",
"vrf_context_id": "string"
}
]
}