HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

/system/vrfs/{name}/bgp_routers/{asn}/bgp_neighbors

post
https://switch-ip/rest/v10.08/system/vrfs//bgp_routers//bgp_neighbors
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

string
required

Reference Resource: BGP_Router
BGP routers keyed by ASN value.

Body Params
route_reflector_client
object

Specifies whether the neighbor is a route reflector client.

boolean

Identifies specific BGP neighbor or BGP peer group 'true': Entry is part of a peer-group and holds common configuration 'false': Entry is a neighbor

next_hop_self
object

Specifies whether the next hop attribute should be changed to router's own IP address.

ORF_prefix_list
object

Reference Resource: Prefix_List
ORF prefix list configuration for this neighbor.

boolean

Enables BFD session to the specific neighbor.

string
length ≤ 128

Password to be used with the neighbor.

string
required

Reference Resource: BGP_Neighbor
BGP neighbors keyed by IP/IFNAME or neighbor groups keyed by any string name.

boolean

Identifies if 'open' messages should be sent to a neighbor 'true': Do not send 'open' messages 'false': Do send 'open' messages

default_originate_route_map
object

Reference Resource: Route_Map
Route-map that specifies the criteria for default origination.

boolean

Specifies whether private AS should be removed.

add_paths_adv_best_n
object

Configure the number of BGP paths to advertise to a BGP Peer.

allow_as_in
object

Number of times instance of local AS is allowed to be in the AS_PATH. If not configured, packets with AS_PATH containing local AS will be rejected.

string

Reference Resource: Port
Loopback interface to be used as the source of the connection

int64
1 to 4294967295

ASN to be used as a local ASN for this neighbor.

inbound_soft_reconfiguration
object

Allow inbound soft reconfiguration.

aspath_filters
object

Reference Resource: BGP_ASPath_Filter
AS Path filters for the session.

max_prefix_options
object

Control maximum number of prefixes on the BGP session and behavior when the limit is approached

integer
0 to 65535

Local TCP port to be used for the BGP session.

string

Reference Resource: BGP_Neighbor
Reference to the peer group of this neighbor. Only applicable if 'is_peer_group' is 'false'

activate
object

Specifies whether the neighbor is activated in the address families.

default_originate
object

Originate default route to the neighbor.

integer
1 to 254

Maximum allowed hops to a neighbor. This, when configured, takes precedence over 'ebgp_hop_count'.

next_hop_unchanged
object

Specifies whether the next hop attribute should be preserved when forwarding routes to eBGP peer.

gshut
object

Specified parameters of the graceful shutdown to be applied on the neighbor.

string
length ≤ 80

Free form description of the neighbor.

add_paths
object

Configure BGP neighbor to advertise and receive additional paths : 'send': only ADD-PATH send capability will be advertised 'recv': only ADD-PATH receive capability will be advertised 'both': both ADD-PATH send and receive capabilities will be advertised 'disable': no ADD-PATH capability will be advertised

string
length ≤ 80

Source IP address for the neighbor session.

string
enum
Allowed:
integer
1 to 255

Maximum Hop Count for the EBGP Session. If 'ttl_security_hops' is configured, then 'ebgp_hop_count' is ignored.

boolean

Fall-over the BGP session when route to this peer fails.

advertisement_interval
object

Minimum interval between sending BGP routing updates. EBGP: default is 30 seconds. IBGP: default is 5 seconds.

ORF_capability
object

BGP ORF capability related configuration.

route_maps
object

Reference Resource: Route_Map
Route maps for the session.

timers
object

Neighbor specific timers

string
enum

'no-prepend-replace-as-dual-as: The session can be established using either primary-as or alternate local-as. Selected-as is not prepended to the inbound AS_PATH list, but prepended to outbound AS_PATH list. 'no-prepend': The session is established via alternate local-as. Both the alternate-as and primary-as are not prepended to the inbound AS_PATH list, but prepended to the outbound AS_PATH list. 'none': The session is established via alternate local-as. Both the alternate-as and primary-as are prepended to both the inbound and the outbound AS_PATH list.

Allowed:
send_community
object

Community strings to be advertised along with the routes to the peer: 'both': both Standard community and Extended community 'extended': only Extended community 'standard': only Standard community 'none': no community will be advertised

boolean

Shuts down neighbor session without removing configuration

integer
0 to 65535

This is the weight for routes from this neighbor.

prefix_lists
object

Reference Resource: Prefix_List
Prefix lists for the session.

int64
1 to 4294967295

Peer ASN. EBGP: must be different from the local ASN or BGP router ASN. IBGP: must be identical to either the local ASN or BGP router ASN.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Updated over 4 years ago

Language
LoadingLoading…

Updated over 4 years ago