Skip to main content

Update BGP Peer Config (v2.5)

PUT 
/v2.5/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/bgppeers/:bgp_peer_id

Update the BGP peer configuration.

Request​

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

    site_id stringrequired

    The ID of the site.

    element_id stringrequired

    The ID of the element.

    bgp_peer_id stringrequired

    The ID of the BGP peer.

Body

Details of the BGP peer config to be created

    advertise_default_route boolean

    Advertised default route. True or False.

    allow_v4_prefixes booleanrequired

    Allow v4 prefixes.

    allow_v6_prefixes booleanrequired

    Allow v6 prefixes.

    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_ip_v6 string

    The peer IPv6 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 ID of the Route.

    scope string

    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 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.

    update_source_v6 string

    The Update Source IPv6 address.

    vrf_context_id string

    The VRF (Virtual Routing and Forwarding) ID.

Responses​

Successful Operation

Schema
    advertise_default_route boolean

    Advertised default route. True or False.

    allow_v4_prefixes booleanrequired

    Allow v4 prefixes.

    allow_v6_prefixes booleanrequired

    Allow v6 prefixes.

    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_ip_v6 string

    The peer IPv6 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 ID of the Route.

    scope string

    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 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.

    update_source_v6 string

    The Update Source IPv6 address.

    vrf_context_id string

    The VRF (Virtual Routing and Forwarding) ID.

Loading...