POST a single neighbor with specific segment.

post

http://localhost:3001/rest/json/bgp/config/vrfs/{vrfId}/neighbor/{IP}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

vrfId

string

required

segment id, could be [0,1,2...]

string

required

IP address of the neighbor

Body Params

A neighbors JSON object belongs to a segment

bfd_desired

boolean

flag to enable/disable BFD session for this peer

enable

boolean

flag to enable/disable neighbor bgp session

gms_marked

boolean

For internal use. Flag to determine if this rule was created by Orchestrator

hold

integer

required

Time in seconds - specifies how long the device will wait for a KEEP ALIVE or UPDATE message from a neighbor before concluding that the neighbor is dead

integer

required

Time in seconds - specifies how frequently the device will send KEEP ALIVE messages to its BGP neighbors

lcl_interface

string

required

Local interface name

next_hop_self

boolean

flag to send own ip as nexthop when advertising route

as_override

boolean

AS-override is turned on the local appliance will replace instances of the peer ASN with the local ASN in advertisable routes whose AS-PATH contains the neighbor's ASN. This will cause the neighbor to accept the route

store_received_routes

boolean

Flag to enable / disable soft-reconfiguration. Enabling this flag will stores received routes from peers to local bgp table.

password

string

required

MD5 Password of the neighbor

remote_as

integer

required

Remote Autonomous System Number of the neighbor

rtmap_inbound

string

required

Name of inbound route redistribution map

rtmap_outbound

string

required

Name of outbound route redistribution map

self

string

required

Ip address of the neighbor

type

string

required

Peer Type of the neighbor. Possible values are 'Branch' or 'PE-router'

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200No response