Get BGP Peer Configs from NB (v2.3)

GET 
/sdwan/v2.3/api/sites/:site_id/elements/:element_id/bgppeers

List all the BGP peer configurations from NB.

Request

Path Parameters

site_id stringrequired

The ID of the site.

element_id stringrequired

The ID of the element.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

items BGPPeerConfigV2N3[]
Array [
bgp_config BGPConfig
The details of the BGP config.
adv_interval int32
The advertisement interval of the BGP config. The advertisement interval should be between 0 - 300 seconds and the default is 1 second.
hold_time int32
The BGP config hold time. The hold time should be between 3 - 600 seconds.
keepalive_time int32
The keep-alive time of the BGP config. The keep-alive time should be between 3 - 200 seconds.
local_as_num string
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.
md5_secret string
The MD5 Secret should be between 1 and 32 characters. The default value is 0.
multi_hop_limit int32
The BGP config multi hop limit. The multi-hop limit should be between 1 - 255 hops. The default is 1 hop.
peer_auth_type string
Possible values: [md5, none]
The authentication type of the BGP peer.
peer_retry_time int32
The peer retry time should be between 0 - 65535 seconds. The default is 120 seconds.
description
The description of the BGP peer config. Max size = 1024.
id string
The ID of the BGP peer config.
name stringrequired
The name of the BGP peer config. Max size = 128.
peer_ip string
The peer IP address.
peer_type string
The peer type = Classic. The Peer Type option is available only for data center ION devices.
remote_as_num stringrequired
The remote AS number.
route_map_in_id string
The ID of the Route Map In to filter incoming routes.
route_map_out_id string
The ID of the Route Map Out to filter outgoing routes.
router_id string
The IP address of the ION device.
scope string
Possible values: [GLOBAL, LOCAL]
shutdown boolean
Shutdown
tags string[]
A information field that can be added to identify the BGP peer. Maximum 10 unique tags of length 1024 each are allowed.
update_source string
The Update Source IP address.
vrf_context_id string
The VRF (Virtual Routing and Forwarding) ID.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "items": [
    {
      "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_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",
      "vrf_context_id": "string"
    }
  ]
}

Loading...