Skip to main content

Get BGP Config from NB (v2.3)

GET 
/v2.3/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/bgpconfigs/:bgp_config_id

List a specific BGP configuration from NB.

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_config_id stringrequired

    The ID of the BGP config.

Responses​

Successful Operation

Schema
    admin_distance int32

    The BGP config admin distance. The device sets the default Admin Distance of all learned prefixes to 20. The admin value should be in the range 1-255.

    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.

    graceful_restart boolean

    By default, graceful restart is Off. Change the default setting to On.

    hold_time int32

    The BGP config hold time. The hold time should be between 3 - 600 seconds.

    id string

    The BGP configuration ID.

    ipv6_prefixes_to_adv_to_wan string[]

    List of IPv6 prefixes advertised to WAN.

    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. If the number entered is an A.B format, the web interface displays the corresponding 32-bit conversion below the entered value. If the number entered is a 32-bit format, the web interface displays the corresponding A.B value below the entered value. The Local AS Number is mandatory.

    maximum_paths int32

    The BGP config maximum paths. The max path value should be between 1 - 255. The default is 1.

    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.

    prefix_adv_type string

    The type of prefix advertisement; Default, Unaggregated or Auto-aggregated.

    prefix_adv_type_to_lan string

    The prefix advertises to LAN.

    prefixes_to_adv_to_wan string[]

    The prefix advertises to WAN.

    router_id string

    The IP address of the ION device. Max size = 256.

    stalepath_time int32

    The stale path time for the BGP config. The stalepath time should be between 1 - 3600 seconds. The default is 120 seconds.

Loading...