Update VRF's switch-level BGP configuration

put

https://example.com/api/vrfs/{vrf_uuid}/bgp/{switch_uuid}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

vrf_uuid

string

required

length between 32 and 36

UUID of VRF for which to update BGP config

switch_uuid

string

required

length between 32 and 36

UUID of switch for which BGP config is being updated

Body Params

BGP Switch Configuration

switch_uuid

string

length between 32 and 36

Switch UUID

name

string

description

string

networks

array of objects

required

Networks to be advertised by this switch

networks*

redistribute_static

boolean

True if static routes should be redistributed; false otherwise.

redistribute_ospf

boolean

True if OSPF routes should be redistributed; false otherwise.

redistribute_connected

boolean

True if local routes should be redistributed; false otherwise.

redistribute_loopback

boolean

True if local loopback should be redistributed; false otherwise.

enable

boolean

Defaults to true

Enable individual BGP switch.

bestpath

boolean

Defaults to true

Consider routes with different AS-path but same length as ECMP for best-path selection.

fast_external_fallover

boolean

Defaults to true

Immediately reset BGP session if link to a directly connected external peer becomes inactive.

trap_enable

boolean

Defaults to false

BGP trap enable.

log_neighbor_changes

boolean

Defaults to true

Log BGP neighbors session state changes.

deterministic_med

boolean

Defaults to true

Pick the best-MED path among paths advertised from the neighboring AS.

always_compare_med

boolean

Defaults to true

Compare MED attribute for BGP best-path selection across neighbors in different AS.

router_id

string | null

required

Router ID to be used for BGP configuration, empty if using Fabric IP Network.

keepalive_timer

integer

0 to 65535

Keepalive timer in seconds.Default value will be used if zero is specified.

holddown_timer

integer

0 to 65535

Holddown timer in seconds.Default value will be used if zero is specified.

neighbors

array of objects

required

BGP Neighbors configured on this switch

BGP Neighbors*

as_number

string | null

Switch's BGP AS Number

maximum_paths

integer

1 to 8

Maximum paths for this router instance

redistribute_connected_route_map

string

length ≤ 32

Route map name to redistribute connected routes of ipv4 addr

redistribute_ospf_route_map

string

length ≤ 32

Route map name to redistribute ospf routes of ipv4 addr

redistribute_local_route_map

string

length ≤ 32

Route map name to redistribute local routes of ipv4 addr

redistribute_static_route_map

string

length ≤ 32

Route map name to redistribute static routes of ipv4 addr

redistribute_ospf_process_route_map

array of objects

Process ID-Routemap name pair of redistribute ospf route map

redistribute_ospf_process_route_map

Responses

Language

Credentials

Header

Loading…

Response

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

application/json; version=1.0

200Success

401Error: Unauthorized